Template:Nutshell

From Wikimedia Commons, the free media repository
Jump to navigation Jump to search
Documentationviewedithistorypurge
This documentation is transcluded from Template:Nutshell/doc.

This template presents a concise summary at the top of policy and guideline 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 Commons more inviting to new users.
  • Nutshell entries must be brief overviews, focusing on the most important facts.
  • Make sure each word in the nutshell carries significant weight, "make every word tell".
  • You may wikilink key words to other policy and guideline pages to create a "nut trail".

Usage

{{Nutshell |1= }}

Template parameters

<templatedata>JSON</templatedata> ./. {{TemplateBox}}
TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.


Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either useTemplateData=1 or useTemplateData=only on the /doc subpage and transcluding it with {{Documentation}} into the template. <nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw <templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.


Wikipedia's help about TemplateDataCommons-specific information

This template presents a concise summary at the top of policy and guideline pages. It is placed below the title and other infoboxes and above the first paragraph of the main body.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
text / first bullet point1

The page summary, or the first bullet point if the second bullet point is given

Contentrequired
second bullet point2

Contentoptional
third bullet point3

Contentoptional
languagelang

Code of the language the template should be displayed in (“en”, “fr” etc.). Useful on translated policies/guidelines so that the template’s language depends on the page language, not the user interface language.

Default
{{int:lang}} (user interface language)
Lineoptional
page titletitle

The title of the page summarized

Default
This page (localized)
Lineoptional

Additional information

The template is intended to be used in the following namespaces: all namespaces

The template is intended to be used by the following user groups: all users

Placement: At the top of the page

Localization

العربية | Беларуская (тарашкевіца)‎ | Brezhoneg | Català | Čeština | Deutsch | English | Esperanto | Español | فارسی | Suomi | Français | Galego | Magyar | Bahasa Indonesia | Italiano | 日本語 | 한국어 | Македонски | മലയാളം | Nederlands | Polski | Português | Русский | Svenska | Українська | 中文(简体)‎ | 中文(台灣)‎ |

This template is localized through {{Autotranslate}}. The layout of the template can be found under Template:Nutshell/layout.

To add your language to the list of languages supported by this template, please copy the code of Template:Nutshell/en (or any other language version you prefer to translate) and replace the text strings in there (the form below can be used to create a translation, the English version is preloaded in the edit box). Please change the parameter lang from en (or whatever language you are translating) to the language code of your language.



Examples

{{nutshell|text}}

Renders like this:

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

Renders like this:

{{Nutshell|title=A nutshell|text}}

Renders like this: