Template:Nutshell

Template documentation[view] [edit] [history] [purge]

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, "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:

{{nutshell|First bullet point.|Second bullet point.|Third bullet point.}}

yields:

{{Nutshell|title=That's me|Concise summary of this page.}}

yields:

{{Nutshell|title=That's me|Concise summary of this page.|shortcut=me}}

yields:

{{Nutshell|title=That's me|Concise summary of this page.|shortcut=me|shortcut2=you|shortcut3=them|shortcut4=us|shortcut5=everyone}}

yields:

See also

• Wikipedia's essay on being concise.
• Wikipedia's Essays in a nutshell (indexes or lists of essays)
• BattleTechWiki:Template index/BattleTechWiki namespace for a listing of BattleTechWiki namespace banners.

List of parameters for this template

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Nutshell text	2	Brief summary that make page more inviting to new users	String	required
Bullet point #2	3	no description	Unknown	optional
Bullet point #3	4	no description	Unknown	optional
Bullet point #4	5	no description	Unknown	optional
Title	title 1	Text that replace "This page" into the text you inserted Example That's me	String	optional
Shortcut	shortcut shortcut1	no description	Unknown	optional
Shortcut2	shortcut2	no description	Unknown	optional
Shortcut3	shortcut3	no description	Unknown	optional
Shortcut4	shortcut4	no description	Unknown	optional
Shortcut5	shortcut5	no description	Unknown	optional

The above documentation is transcluded from Template:Nutshell/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.