View source for Template:Nutshell/doc

{{Documentation subpage}}
{{Nosubst}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

This template presents a concise summary at the top of administration andor information 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, "[[w:The Elements of Style|make every word tell]]".
* [[Help:Wikilinks|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">{{nutshell|text}}</syntaxhighlight>
Renders like this:
{{nutshell|text}}

<syntaxhighlight lang="wikitext">{{nutshell|First bullet point.|Second bullet point.|Third bullet point.}}</syntaxhighlight>
yields:
{{nutshell|First bullet point.|Second bullet point.|Third bullet point.}}

<syntaxhighlight lang="wikitext">{{Nutshell|title=That's me|Concise summary of this page.}}</syntaxhighlight>
yields:
{{nutshell|title=That's me|Concise summary of this page.}}

<syntaxhighlight lang="wikitext">{{Nutshell|title=That's me|Concise summary of this page.|shortcut=me}}</syntaxhighlight>
yields:
{{nutshell|title=That's me|Concise summary of this page.|shortcut=me}}

<syntaxhighlight lang="wikitext">{{Nutshell|title=That's me|Concise summary of this page.|shortcut=me|shortcut2=you|shortcut3=them|shortcut4=us|shortcut5=everyone}}</syntaxhighlight>
yields:
{{Nutshell|title=That's me|Concise summary of this page.|shortcut=me|shortcut2=you|shortcut3=them|shortcut4=us|shortcut5=everyone}}

== See also ==
* [[w:Wikipedia:Too long; didn't read|Wikipedia's essay on being concise.]]
* [[w:Wikipedia:Essays in a nutshell|Wikipedia's Essays in a nutshell]] (indexes or lists of essays)
* [[ShadowrunWiki:Template index/ShadowrunWiki namespace]] for a listing of ShadowrunWiki namespace banners.

<includeonly>{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Header templates]]
}}</includeonly>
<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>