Template:TemplateData header: Difference between revisions
templates>SUM1 Added "based" parameter to other transclusion |
navbox>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 13: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
==TemplateData== or ==Parameters== or ==Usage==
{{TemplateData header}}
[[:Template:^(]]templatedata[[:Template:)^]]{
...
}[[:Template:^(]]/templatedata[[:Template:)^]]
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
 | This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
 | This template uses Lua: |
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:
- [[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
Example
- Using a collapse box for
[[Template:User]]:
Parameters
This is the TemplateData documentation for this template used by VisualEditor and other tools.
TemplateData header
Inserts a brief header for the TemplateData 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 |
Tracking categories
- Category:Pages using TemplateData header with unknown parameters (3)
- Category:Templates using TemplateData (14)
See also
- {{Crude TemplateData}}
- {{Format TemplateData}}
- {{Template parameter usage}}
- {{TemplateData}}