Template:Documentation subpage

This subpage contains documentation, categories, or other content that is not part of the template.
To view the template page itself, see Template:Documentation subpage.

---

Template documentation[ view · edit · history · purge ]

This documentation is transcluded from Template:Documentation subpage/doc.

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:

• Category:Template documentation – Documentation subpages in the Template and other namespace.
• Category:Module documentation – Documentation subpages in the Module namespace.
• Category:User documentation – Documentation subpages in the User namespace.

Usage

{{Documentation subpage}}

Template parameters

 Parameter text is empty

<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 TemplateData • Commons-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.

Parameter		Description	Type	Status
override	1	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 override Auto value override	Line	optional
Category	category	The category to add the documentation subpage to. Default Depends on the namespace: Template or other namespace [[Category:Template documentation]] Module namespace [[Category:Module documentation]] User namespace [[Category:User documentation]]	Line	optional
page	page	Full page name of the described template. Use only if the documentation page is not a subpage of the described template. Default {{NAMESPACE}}:{{BASEPAGENAME}}	Page name	optional

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

• m:Template:Documentation, en:Wikipedia:Template documentation (for how this template is used)
• {{Doc-inline}}, {{doc-end}}

Localization

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.