This page is protected against editing.

Template:Documentation subpage

From Wikimedia Commons, the free media repository
Jump to navigation Jump to search
Template documentationview · edit · history · purge ]

Place this template at the top of all template documentation subpages. It does not need to be in <noinclude> tags because it will only show up on “/doc” subpages.

The template automatically sets the following categories:


{{Documentation subpage}}

Template parameters

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

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.

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

Place this template at the top of all template documentation subpages. It does not need to be in <noinclude> tags because it will only show up on “/doc” subpages.

Template parameters[Edit template data]

This template prefers inline formatting of parameters.


If set to “override”, allows to force the display of this template. Use only if the documentation page does not end in “/doc”.

Suggested values
Auto value

The category to add the documentation subpage to.

Depends on the namespace:
Template or other namespace
[[Category:Template documentation]]
Module namespace
[[Category:Module documentation]]
User namespace
[[Category:User documentation]]

Full page name of the described template. Use only if the documentation page is not a subpage of the described template.

Page nameoptional

Additional information

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

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

Placement: At the top of the page

See also


العربية  asturianu  Boarisch  беларуская (тарашкевіца)  български  বাংলা  català  čeština  dansk  Deutsch  Zazaki  Ελληνικά  English  Esperanto  español  eesti  euskara  فارسی  suomi  français  galego  עברית  हिन्दी  hrvatski  magyar  Bahasa Indonesia  italiano  日本語  ქართული  한국어  Lëtzebuergesch  македонски  മലയാളം  ဘာသာ မန်  Bahasa Melayu  Mirandés  မြန်မာဘာသာ  norsk bokmål  Plattdüütsch  Nederlands  norsk  polski  português  português do Brasil  русский  sicilianu  Scots  slovenščina  српски / srpski  svenska  ไทย  Türkçe  українська  اردو  oʻzbekcha  Tiếng Việt  简体中文  繁體中文  +/−

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

To add your language to the list of languages supported by this template, please copy the code of Template:Documentation subpage/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.