Template:TemplateData header/doc

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

---

Inserts a brief header for the template data section. Adds the page to Category:Templates using TemplateData.

Usage

==TemplateData== or ==Parameters== or ==Usage==
{{TemplateData header}}
<templatedata>{
...
}</templatedata>

Use {{TemplateData header|Template name}} to display a name for the template other than the default, which is {{BASEPAGENAME}}.

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. Wikipedia's help about TemplateData • Commons-specific information

Use {{TemplateData header|nolink=1}} to omit the wikilink from the word "TemplateData" in the header text, for instances where it is already linked outside this template.

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. Wikipedia's help about TemplateData • Commons-specific information

Use {{TemplateData header|noheader=1}} to omit the first sentence of the header text.

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. Wikipedia's help about TemplateData • Commons-specific information

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.

---

Wikipedia's help about TemplateData • Commons-specific information

Inserts a brief header for the template data section. Adds the page to [[Category:Templates using TemplateData]]

Template parameters

Parameter		Description	Type	Status
Template name	1	Used to display a name for the template other than the default, which is {{BASEPAGENAME}}.	String	optional
No link	nolink	Assigning any value to this parameter will omit cause the template to omit the wikilink from the word "TemplateData" in the header text, for instances where it is already linked outside this template.	String	optional
No header	noheader	Assigning any value to this parameter will cause the template to omit the first sentence of the header text.	String	optional