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
<syntaxhighlight lang="wikitext">
This page in a nutshell: text
</syntaxhighlight>
Renders like this:
This page in a nutshell: text
<syntaxhighlight lang="wikitext">
This page in a nutshell:
First bullet point.
Second bullet point.
Third bullet point.
</syntaxhighlight>
yields:
This page in a nutshell:
First bullet point.
Second bullet point.
Third bullet point.
<syntaxhighlight lang="wikitext">
That's me in a nutshell: Concise summary of this page.
</syntaxhighlight>
yields:
That's me in a nutshell: Concise summary of this page.
<syntaxhighlight lang="wikitext">
That's me in a nutshell: Concise summary of this page.
<templatedata>
{
"params": {
"1": {
"label": "Nutshell text",
"description": "Brief summary that make page more inviting to new users",
"type": "string",
"required": true
},
"2": {
"label": "Bullet point #2",
"type": "string"
},
"3": {
"label": "Bullet point #3",
"type": "string"
},
"4": {
"label": "Bullet point #4",
"type": "string"
},
"title": {
"label": "Title",
"description": "Text that replaces \"This page\" with other chosen text",
"example": "That's me",
"type": "string",
"suggestedvalues": [
"This talk page",
"This user page",
"This user talk page",
"This essay",
"This template",
"This policy"
],
"default": "This page"
},
"shortcut": {
"aliases": [
"shortcut1"
],
"label": "Shortcut #1",
"description": "The first shortcut that leads to the page"
},
"shortcut2": {
"label": "Shortcut #2",
"description": "The second shortcut that leads to the page"
},
"shortcut3": {
"label": "Shortcut #3",
"description": "The third shortcut that leads to the page"
},
"shortcut4": {
"label": "Shortcut #4",
"description": "The fourth shortcut that leads to the page"
},
"shortcut5": {
"label": "Shortcut #5",
"description": "The fifth shortcut that leads to the page"
}
},
"description": "Template that allows for a concise explanation of a page's content",
"format": "inline"
}
</templatedata>
