Template:Nutshell/doc

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:

TL;DR: text

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

yields:

TL;DR:

First bullet point.
Second bullet point.
Third bullet point.

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

yields:

That's me: Concise summary of this page.

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

yields:

That's me: Concise summary of this page.

Shortcut

Me

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

yields:

That's me: Concise summary of this page.

Shortcuts

Template:Nutshell/doc

Usage

See also