Template:Nutshell/doc

From TSP Encyclopedia
Jump to navigation Jump to search

Template: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 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


List of parameters for this template

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Nutshell text2

Brief summary that make page more inviting to new users

Stringrequired
Titletitle 1

Text that replace "This page" into the text you inserted

Example
That's me
Stringoptional
shortcutshortcut

no description

Unknownoptional
shortcut2shortcut2

no description

Unknownoptional
shortcut3shortcut3

no description

Unknownoptional
shortcut4shortcut4

no description

Unknownoptional
shortcut5shortcut5

no description

Unknownoptional