Template:TemplateData header: Difference between revisions
(Replace {{Template error report}} with {{Template parameter usage}} – per edit request) |
Richardpruen (talk | contribs) m (1 revision imported) |
(No difference)
| |
Revision as of 18:38, 10 December 2020
TemplateData for TemplateData header
The {{TemplateData header}} template inserts a brief header for the template data section, and adds the page to Category:Templates using TemplateData.
Usage
==TemplateData==
{{TemplateData header}}
<templatedata>{
...
}</templatedata>
Note: Section headers of ==Parameters== or ==Usage== may also be used.
Use {{TemplateData header|Template name}} to display a name for the template other than the default, which is {{BASEPAGENAME}}. Do not add namespace Template:
- This is the TemplateData documentation for this template used by VisualEditor and other tools; click here to see a monthly parameter usage report for this template.
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; click here to see a monthly parameter usage report for this template.
TemplateData for TemplateData header
Use {{TemplateData header|noheader=1}} to omit the first sentence of the header text.
- Click here to see a monthly parameter usage report for this template.
TemplateData for TemplateData header
Parameters
TemplateData for TemplateData header
Inserts a brief header for the template data section. 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 |
Example
- Using a collapse box for
[[Template:User]]:
{{collapse top|title=TemplateData}}
{{TemplateData header|User}}
<templatedata>
{
"description": "This template is used to create a link to a user's user page (unless using {{Useranon}}), talk page, and contributions, and generates a special notification (aka 'ping').",
"params": {
"1": {
"label": "User name",
"type": "string",
"required": true,
"description": "The user name that you want to create links to and notify.",
"aliases":["user"]
},
"project": {
"label": "Sister project",
"type": "string",
"description": "Used to link to a sister project instead of the English Wikipedia. Use the standard interwiki prefix."
},
"lang": {
"label": "Other language project",
"type": "string",
"description": "Used to link to another language project. If used with the \"sister project\" parameter, links to another language of a sister project. Otherwise links to another language Wikipedia. Use the standard language code."
},
"separator": {
"label": "Separator",
"description": "Used to change the separator between the links. If unused, defaults to a dot."
}
}
}
</templatedata>
{{collapse bottom}}
TemplateData
| |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
This is the TemplateData documentation for this template used by VisualEditor and other tools; click here to see a monthly parameter usage report for this template.
TemplateData for User This template is used to create a link to a user's user page (unless using {{Useranon}}), talk page, and contributions, and generates a special notification (aka 'ping').
| |||||||||||||||||||||||||