Template:TemplateDataHeader/doc: Difference between revisions
From The Kodiak Republic Wiki
Content deleted Content added
Created page with "<div class="templatedata-header">{{#if:{{{noheader|}}}|<!-- noheader: -->{{Template parameter usage|based=y}}|<!-- +header: -->This is the {{#if:{{{nolink|}}}|<!-- +header, nolink TD -->TemplateData|<!-- +header, +link TD; DEFAULT: -->TemplateData}}<!-- e.o. #if:nolink; DEFAULT: --> for this template used by TemplateWizard, VisualEditor and other tools. {{Template parame..." |
No edit summary |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} |
|||
<div class="templatedata-header">{{#if:{{{noheader|}}}|<!-- |
|||
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata --> |
|||
noheader: |
|||
{{Lua|Module:Check for unknown parameters}} |
|||
-->{{Template parameter usage|based=y}}|<!-- |
|||
+header: |
|||
-->This is the {{#if:{{{nolink|}}}|<!-- |
|||
+header, nolink TD |
|||
-->TemplateData|<!-- |
|||
+header, +link [[TD]]; DEFAULT: |
|||
-->[[Wikipedia:TemplateData|TemplateData]]}}<!-- |
|||
e.o. #if:nolink; DEFAULT: |
|||
--> for this template used by [[mw:Extension:TemplateWizard|TemplateWizard]], [[Wikipedia:VisualEditor|VisualEditor]] and other tools. {{Template parameter usage|based=y}}<!-- |
|||
e.o. #if:noheader |
|||
-->}} |
|||
The {{tlx|TemplateData header}} template inserts a brief header for the template data section, and adds the page to [[:Category:Templates using TemplateData]]. |
|||
'''TemplateData for {{{1|{{BASEPAGENAME}}}}}''' |
|||
</div><includeonly><!-- |
|||
== Usage == |
|||
check parameters |
|||
<pre style="overflow:auto;"> |
|||
-->{{#invoke:Check for unknown parameters|check |
|||
==TemplateData== |
|||
|unknown={{template other|1=[[Category:Pages using TemplateData header with unknown parameters|_VALUE_]]}} |
|||
{{TemplateData header}} |
|||
<templatedata>{ |
|||
|1 |nolink |noheader |
|||
... |
|||
|preview=<div class="error" style="font-weight:normal">Unknown parameter '_VALUE_' in [[Template:TemplateData header]].</div> |
|||
}</templatedata> |
|||
}}<!-- |
|||
-->{{template other|{{sandbox other|| |
|||
[[Category:Templates using TemplateData]] |
|||
Note: Section headers of ==Parameters== or ==Usage== may also be used. |
|||
}}}}</includeonly><!-- |
|||
</pre> |
|||
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>]]. Do ''not'' add namespace <code>Template:</code> |
|||
--><noinclude>{{Documentation}}</noinclude> |
|||
:{| |
|||
|{{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}} |
|||
|} |
|||
==Example== |
|||
:Using a collapse box for {{elc|Template:User}}: |
|||
{{nowiki template demo|code=<nowiki> |
|||
{{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}}</nowiki>}} |
|||
==Parameters== |
|||
{{TemplateData header}} |
|||
<templatedata>{ |
|||
"description": "Inserts a brief header for the TemplateData section. Adds the page to [[:Category:Templates using TemplateData]]", |
|||
"params": { |
|||
"1": { |
|||
"label": "Template name", |
|||
"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", |
|||
"required": false |
|||
} |
|||
} |
|||
}</templatedata> |
|||
==Tracking category== |
|||
* {{clc|Category:Pages using TemplateData header with unknown parameters}} |
|||
==See also== |
|||
* {{clc|Category:Templates using TemplateData}} |
|||
* {{tl|Crude TemplateData}} |
|||
* {{tl|Template parameter usage}} |
|||
<includeonly>{{sandbox other|| |
|||
<!-- Categories below this line; interwikis at Wikidata --> |
|||
{{DEFAULTSORT:Templatedata Header}} |
|||
[[Category:TemplateData|Header]] |
|||
[[Category:Documentation header templates]] |
|||
}}</includeonly> |
|||
