Template:TemplateData header/doc: Difference between revisions
meta>Zyxw (update to match renaming of template in May 2015) |
meta>Zyxw (document other parameters, add category, add wrapper to prevent /sandbox from being added to categories) |
||
| Line 13: | Line 13: | ||
</pre> | </pre> | ||
Use <code><nowiki>{{TemplateData header|Template name}}</nowiki></code> | Use <code><nowiki>{{TemplateData header|Template name}}</nowiki></code> to display a name for the template other than the default, which is [[Help:Magic_words#Variables|<nowiki>{{BASEPAGENAME}}</nowiki>]]. | ||
:{| | |||
{{TemplateData header|Template name}} | |||
|} | |||
Use <code><nowiki>{{TemplateData header|nolink=1}}</nowiki></code> to omit the [[Help:Link#Wikilinks|wikilink]] from the word "TemplateData" in the header text, for instances where it is already linked outside this template. | |||
:{| | |||
{{TemplateData header|nolink=1}} | |||
|} | |||
Use <code><nowiki>{{TemplateData header|noheader=1}}</nowiki></code> to omit the first sentence of the header text. | |||
:{| | |||
{{TemplateData header|noheader=1}} | |||
|} | |||
==Parameters== | ==Parameters== | ||
| Line 22: | Line 35: | ||
"1": { | "1": { | ||
"label": "Template name", | "label": "Template name", | ||
"description": " | "description": "Used to display a name for the template other than the default, which is {{BASEPAGENAME}}.", | ||
"type": "string", | |||
"required": false | |||
}, | |||
"nolink": { | |||
"label": "No link", | |||
"description": "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.", | |||
"type": "string", | |||
"required": false | |||
}, | |||
"noheader": { | |||
"label": "No header", | |||
"description": "Assigning any value to this parameter will cause the template to omit the first sentence of the header text.", | |||
"type": "string", | "type": "string", | ||
"required": false | "required": false | ||
| Line 29: | Line 54: | ||
}</templatedata> | }</templatedata> | ||
<includeonly>{{sandbox other|| | |||
<includeonly> | |||
<!-- Categories go here, and interwikis go in Wikidata --> | <!-- Categories go here, and interwikis go in Wikidata --> | ||
[[Category:TemplateData documentation| ]] | |||
</includeonly> | }}</includeonly> | ||
Revision as of 10:07, 27 November 2016
 | This is a documentation subpage for Template:TemplateData header. It may contain usage information, categories and other content that is not part of the original template page. |
Inserts a brief header for the template data section. Adds the page to Category:TemplateData documentation.
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}}.
- This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for this template in articles based on this TemplateData.
TemplateData for Template name
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.
- This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for this template in articles based on this TemplateData.
TemplateData for TemplateData header
Use {{TemplateData header|noheader=1}} to omit the first sentence of the header text.
- See a monthly parameter usage report for this template in articles based on this TemplateData.
TemplateData for TemplateData header
Parameters
TemplateData for TemplateData header
Inserts a brief header for the template data section. Adds the page to [[Category:TemplateData documentation]]
| 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 |
