Template:Nutshell
 | This page in a nutshell: {{{1}}} |
Template documentation | This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
 | This template should not be substituted. |
This template presents a concise summary at the top of administration pages. It is placed below the title and other infoboxes and above the first paragraph of the main body.
- Use the nutshell summary to make Wikipedia more inviting to new users.
- Nutshell entries must be brief overviews, with a very high meaning to number of words ratio.
- Make sure each word in the nutshell carries significant weight, "make every word tell".
- Wikilink to other pages to create a "nut trail" of pages with nutshells.
This template can also be used on other pages, for instance on how-to guides. But it should not be used in articles.
Usage
{{nutshell|text}}Renders like this:
| This page in a nutshell: text |
{{nutshell|First bullet point.|Second bullet point.|Third bullet point.}}yields:
| This page in a nutshell:
|
{{Nutshell|title=That's me|Concise summary of this page.}}yields:
| That's me in a nutshell: Concise summary of this page. |
{{Nutshell|title=That's me|Concise summary of this page.|shortcut=me}}yields:
| That's me in a nutshell: Concise summary of this page. |
{{Nutshell|title=That's me|Concise summary of this page.|shortcut=me|shortcut2=you|shortcut3=them|shortcut4=us|shortcut5=everyone}}yields:
| That's me in a nutshell: Concise summary of this page. |
See also
- Wikipedia:Too long; didn't read
- Wikipedia:Essays in a nutshell (editable lists of essays)
- Wikipedia:Template messages/Wikipedia namespace for a listing of Wikipedia namespace banners.
<templatedata> { "params": { "2": { "label": "Nutshell text", "description": "Brief summary that make page more inviting to new users", "type": "string", "required": true }, "3": { "label": "Bullet point #2" }, "4": { "label": "Bullet point #3" }, "5": { "label": "Bullet point #4" }, "title": { "aliases": [ "1" ], "label": "Title", "description": "Text that replace \"This page\" into the text you inserted", "example": "That's me", "type": "string" }, "shortcut": { "aliases": [ "shortcut1" ] }, "shortcut2": {}, "shortcut3": {}, "shortcut4": {}, "shortcut5": {} }, "description": "List of parameters for this template", "format": "inline" } </templatedata>