Template:TemplateData header/doc: Difference between revisions
Jump to navigation
Jump to search
Hoof Hearted (talk | contribs) m (Protected "Template:TemplateData header/doc": High importance template ([Edit=Registered only] (indefinite) [Move=Allow only administrators] (indefinite))) |
Hoof Hearted (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
<!--Categories go at the bottom of this page--> | <!--Categories go at the bottom of this page--> | ||
Inserts a brief header for the template data section. Automatically adds the page to [[:category:Templates using TemplateData]]. | Inserts a brief header for the template data section. Automatically adds the page to [[:category: Templates using TemplateData]]. | ||
==Usage== | ==Usage== | ||
| Line 9: | Line 9: | ||
<templatedata>{ | <templatedata>{ | ||
... | ... | ||
}</templatedata> | }</templatedata></pre> | ||
</pre> | |||
*Use <code><nowiki>{{TemplateData header|Template name}}</nowiki></code> to display a name for the template <u>other than the default</u>, which is | *Use <code><nowiki>{{TemplateData header|Template name}}</nowiki></code> to display a name for the template <u>other than the default</u>, which is {{Wp|Help:Magic words#Variables|<nowiki>{{BASEPAGENAME}}</nowiki>}}. | ||
::{| | ::{| | ||
|{{TemplateData header|Template name}} | |{{TemplateData header|Template name}} | ||
|} | |} | ||
*Use <code><nowiki>{{TemplateData header|nolink=1}}</nowiki></code> to omit the [[ | *Use <code><nowiki>{{TemplateData header|nolink=1}}</nowiki></code> to omit the [[wikilink]] from the word 'TemplateData' in the header text, for instances where it is already linked outside this template. | ||
::{| | ::{| | ||
|{{TemplateData header|nolink=1}} | |{{TemplateData header|nolink=1}} | ||
| Line 30: | Line 29: | ||
{{TemplateData header}} | {{TemplateData header}} | ||
<templatedata>{ | <templatedata>{ | ||
"description": "Inserts a brief header for the template data section. Automatically adds the page to [[:category:Templates using TemplateData]]", | "description": "Inserts a brief header for the template data section. Automatically adds the page to [[:category: Templates using TemplateData]]", | ||
"params": { | "params": { | ||
"1": { | "1": { | ||
Latest revision as of 14:08, 4 September 2021
Template:Mbox Inserts a brief header for the template data section. Automatically 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}}.
- This is the TemplateData documentation for this template used by VisualEditor and other tools.
- 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 documentation for this template used by VisualEditor and other tools.
- TemplateData for TemplateData header
Parameters
This is the TemplateData documentation for this template used by VisualEditor and other tools.
- TemplateData for TemplateData header
Inserts a brief header for the template data section. Automatically adds the page to [[:category: Templates using TemplateData]]
| 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 |