Template:TemplateDataHeader: Difference between revisions
(Created page with "<noinclude> <onlyinclude>{{#switch: |= <div class="templatedata-header"><!-- -->{{#if:{{yesno|{{{editlinks|}}}}}<!-- -->|{{#ifexpr:<!-- -->{{#if:{{{docpage|}}}<!-- -->|{{#ifeq:{{FULLPAGENAME}}|{{transclude|{{{docpage}}}}}|0|1}}<!-- -->|not{{IsDocSubpage|false=0}}<!-- -->}}<!-- -->|{{Navbar|{{{docpage|{{BASEPAGENAME}}/doc}}}|plain=1|brackets=1|style=float:{{dir|{{PAGELANGUAGE}}|left|right}};}}<!-- -->}}<!-- -->}} {{#if:{{{noheader|}}}||This is the Special:...") |
No edit summary |
||
| Line 17: | Line 17: | ||
</div><includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|<!-- | </div><includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|<!-- | ||
-->|{{#if:{{IsDocSubpage|false=}}<!-- | -->|{{#if:{{IsDocSubpage|false=}}<!-- | ||
-->|[[Category:TemplateData documentation | -->|[[Category:TemplateData documentation]]<!-- | ||
-->|[[Category:Templates using TemplateData | -->|[[Category:Templates using TemplateData]]<!-- | ||
-->}}<!-- | -->}}<!-- | ||
-->}}</includeonly> | -->}}</includeonly> | ||
| #default= | | #default= | ||
}}</onlyinclude> | }}</onlyinclude> | ||
{{Documentation|content= | {{Documentation|content= | ||
Inserts a brief header for the template data section. Adds the /doc subpage to [[:Category:TemplateData documentation | Inserts a brief header for the template data section. Adds the /doc subpage to [[:Category:TemplateData documentation]] and the template page to [[:Category:Templates using TemplateData]]. | ||
== Usage == | == Usage == | ||
Latest revision as of 03:33, 29 June 2022
This is the TemplateData documentation for this template used by VisualEditor and other tools.
TemplateDataHeader
Inserts a brief header for the template data section. Adds the /doc subpage to Category:TemplateData documentation and the template 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}}.
Use {{TemplateData header|noheader=1}} to omit the first sentence of the header text.
Parameters
Inserts a brief header for the template data section.
| 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
| Boolean | optional |
| Doc Page | docpage | The name of the current page, used for {{Navbar}} edit links
| Template | suggested |
The above documentation is transcluded from Template:TemplateDataHeader/doc. (edit | history)