Template:TemplateDataHeader

This is the TemplateData documentation for this template used by VisualEditor and other tools.

TemplateDataHeader

Template Documentation

[purge]

Inserts a brief header for the template data section. Adds the /doc subpage to [[:Category:TemplateData documentation{{#translation:}}]] and the template page to [[:Category:Templates using TemplateData{{#translation:}}]].

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}}.

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

Parameters

Documentation

[purge]

Inserts a brief header for the template data section.

Template parameters

This template prefers inline formatting of 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 header	noheader	Assigning any value to this parameter will cause the template to omit the first sentence of the header text.	String	optional
Edit Links?	editlinks	Whether to show {{Navbar}} editlinks on pages that transclude the TemplateData Default 0 Auto value 1	Boolean	optional
Doc Page	docpage	The name of the current page, used for {{Navbar}} edit links Default {{BASEPAGENAME}}/doc Auto value {{subst:PAGENAME}}	Template	suggested

The above documentation is transcluded from Template:TemplateDataHeader/doc. (edit | history)