Template:Nutshell/doc: Difference between revisions
Randombell (talk | contribs) Created page with "{{Documentation subpage}} <!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see Wikipedia:Wikidata) --> {{Nosubst}} 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 invi..." |
(No difference)
|
Latest revision as of 09:42, 20 August 2025
![]() | This is a documentation subpage for Template:Nutshell. It contains usage information, categories and other content that is not part of the original template page. |
![]() | 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:
File:Walnut.svg | This page in a nutshell: text |
{{nutshell|First bullet point.|Second bullet point.|Third bullet point.}}
yields:
File:Walnut.svg | This page in a nutshell: Template:Unordered list |
{{Nutshell|title=That's me|Concise summary of this page.}}
yields:
File:Walnut.svg | That's me in a nutshell: Concise summary of this page. |
{{Nutshell|title=That's me|Concise summary of this page.|shortcut=me}}
yields:
File:Walnut.svg | That's me in a nutshell: Concise summary of this page. | Template:Ombox/shortcut |
{{Nutshell|title=That's me|Concise summary of this page.|shortcut=me|shortcut2=you|shortcut3=them|shortcut4=us|shortcut5=everyone}}
yields:
File:Walnut.svg | That's me in a nutshell: Concise summary of this page. | Template:Ombox/shortcut |
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.
Template data
Template that allows for a concise explanation of a page's content
Parameter | Description | Type | Status | |
---|---|---|---|---|
Nutshell text | 1 | Brief summary that make page more inviting to new users | String | required |
Bullet point #2 | 2 | no description | String | optional |
Bullet point #3 | 3 | no description | String | optional |
Bullet point #4 | 4 | no description | String | optional |
Title | title | Text that replaces "This page" with other chosen text
| String | optional |
Shortcut #1 | shortcut shortcut1 | The first shortcut that leads to the page | Unknown | optional |
Shortcut #2 | shortcut2 | The second shortcut that leads to the page | Unknown | optional |
Shortcut #3 | shortcut3 | The third shortcut that leads to the page | Unknown | optional |
Shortcut #4 | shortcut4 | The fourth shortcut that leads to the page | Unknown | optional |
Shortcut #5 | shortcut5 | The fifth shortcut that leads to the page | Unknown | optional |