Difference between revisions of "Template:TemplateData header"
import>SUM1 (Added "based" parameter to other transclusion) |
import>Kaganer (PAGELANGUAGE) |
||
| Line 1: | Line 1: | ||
| − | <div class="templatedata-header">{{#if:{{{ | + | <noinclude> |
| − | + | <languages/> | |
| − | -->{{ | + | <onlyinclude>{{#switch:<translate></translate> |
| − | + | |= | |
| − | --> | + | <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|}}}||<translate><!--T:1--> This is the [[<tvar name=1>Special:MyLanguage/Help:TemplateData</tvar>|TemplateData]] documentation for this template used by [[<tvar name=2>Special:MyLanguage/VisualEditor</tvar>|VisualEditor]] and other tools.</translate>}} | ||
| − | ''' | + | '''{{{1|{{BASEPAGENAME}}}}}''' |
| − | </div><includeonly><!-- | + | </div><includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|<!-- |
| + | -->|{{#if:{{IsDocSubpage|false=}}<!-- | ||
| + | -->|[[Category:TemplateData documentation{{#translation:}}]]<!-- | ||
| + | -->|[[Category:Templates using TemplateData{{#translation:}}]]<!-- | ||
| + | -->}}<!-- | ||
| + | -->}}</includeonly> | ||
| + | | #default= | ||
| + | {{#invoke:Template translation|renderTranslatedTemplate|template=Template:TemplateData header|noshift=1|uselang={{#if:{{pagelang}}|{{pagelang}}|{{int:lang}}}}}} | ||
| + | }}</onlyinclude> | ||
| + | {{Documentation|content= | ||
| − | + | 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:}}]]. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | [[Category:Templates using TemplateData]] | ||
| − | }}}} | + | == Usage == |
| + | {{#tag:syntaxhighlight| | ||
| + | ==TemplateData== or ==Parameters== or ==Usage== | ||
| + | {{((}}TemplateData header{{))}} | ||
| + | {{^(}}templatedata{{)^}}{ | ||
| + | ... | ||
| + | }{{^(}}/templatedata{{)^}} | ||
| + | |lang=html | ||
| + | }} | ||
| − | + | 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>]]. | |
| + | <dl><dd> | ||
| + | {{TemplateData header|Template name}} | ||
| + | </dd></dl> | ||
| + | |||
| + | Use <code><nowiki>{{TemplateData header|noheader=1}}</nowiki></code> to omit the first sentence of the header text. | ||
| + | <dl><dd> | ||
| + | {{TemplateData header|noheader=1}} | ||
| + | </dd></dl> | ||
| + | |||
| + | ==Parameters== | ||
| + | {{TemplateData header/doc}} | ||
| + | |||
| + | }} | ||
| + | </noinclude> | ||
Revision as of 10:48, 30 January 2022
<languages/>
This is the TemplateData documentation for this template used by VisualEditor and other tools.
TemplateData header
[[Category:Templates using TemplateData{{#translation:}}]]
Template documentationInserts 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
<syntaxhighlight lang="html">
TemplateData== or ==Parameters== or ==Usage
{{TemplateData header}} Template:^(templatedataTemplate:)^{ ... }Template:^(/templatedataTemplate:)^ </syntaxhighlight>
Use {{TemplateData header|Template name}} to display a name for the template other than the default, which is {{BASEPAGENAME}}.
-
[[Category:Templates using TemplateData{{#translation:}}]]
This is the TemplateData documentation for this template used by VisualEditor and other tools.
Template name
Use {{TemplateData header|noheader=1}} to omit the first sentence of the header text.
-
[[Category:Templates using TemplateData{{#translation:}}]]
TemplateData header
Parameters
Inserts a brief header for the template data section. 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}}.
- [[Category:Templates using TemplateData{{#translation:}}]]
This is the TemplateData documentation for this template used by VisualEditor and other tools.
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.
- [[Category:Templates using TemplateData{{#translation:}}]]
This is the TemplateData documentation for this template used by VisualEditor and other tools.
TemplateData header
Use {{TemplateData header|noheader=1}} to omit the first sentence of the header text.
- [[Category:Templates using TemplateData{{#translation:}}]]
TemplateData header
Parameters
This is the TemplateData documentation for this template used by VisualEditor and other tools.
TemplateData header
<templatedata>{
"description": "Inserts a brief header for the template data section. Adds the page to",
"params": {
"1": {
"label": "Template name",
"description": "Used to display a name for the template other than the default, which is TemplateData header.",
"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",
"required": false
}
}
}</templatedata>