RogueScholar: Create template documentation page

2022-09-13T18:17:36Z

Create template documentation page

New page

{{Documentation subpage}}
{{Notice|It contains usage information, categories and other content that is not part of the original template page.|''NOTICE:'' This is a documentation subpage for [[:{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}<br />

The <kbd style="font-size: 1.15em; font-weight: 800;"><nowiki>{{</nowiki>[[Template:TemplateData header|TemplateData header]]<nowiki>}}</nowiki></kbd> template inserts a brief header for the TemplateData section, and adds the page to [[:Category:Templates using TemplateData]].

== Usage ==
<div class="nowrap" style="background-color: #f8f9fa; border: 2px solid #a2a9b1; color: #000; display: block; font: 500 0.92rem/1.4 monospace; margin: 1em 1em 1em 2.5em; max-width: 50vmax; overflow-x: hidden; padding: 0 1em 1.2em; white-space: pre;"><nowiki>
== TemplateData ==
{{TemplateData header}}
<templatedata>{
…
}</templatedata>

</nowiki></div>

Use {{Tlx|TemplateData header|<var>Template name</var>}} to display a name for the template other than the default, which is [[mw:Help:Magic words#Page names|<nowiki>{{BASEPAGENAME}}</nowiki>]]. Do ''not'' add namespace <code>Template:</code>.
:{|
| {{TemplateData header|Template name}}
|}

Use {{Tlx|TemplateData header|2=nolink=1}} 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}}
|}

Use {{Tlx|TemplateData header|2=noheader=1}} to omit the first sentence of the header text.
:{|
| {{TemplateData header|noheader=1}}
|}

== Example ==
:Using a collapse box for &lsqbr;&lsqbr;Template:User&rsqbr;&rsqbr;:
<div style="background-color: #f8f9fa; border: 2px solid #a2a9b1; color: #000; display: block; font: 500 0.85rem/1.3 monospace; margin: 1em 1em 1em 2.5em; max-width: 80vmax; overflow-x: auto; padding: 0 1em 1.2em; white-space: pre-wrap;"><nowiki>
{{Collapse top|title=TemplateData}}
{{TemplateData header|User}}
<templatedata>{
"description": "This template is used to create a link to a user's user page, 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"
]
},
"separator": {
"label": "Separator",
"description": "Used to change the separator between the links. If unused, defaults to a dot."
}
}
}</templatedata>
{{Collapse bottom}}</nowiki></div>

== Parameters ==
{{TemplateData header}}
<templatedata>{
"description": "Inserts a brief header for the template data 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>

== See also ==
* [[:Category:Templates using TemplateData]]<includeonly>


</includeonly><noinclude>

[[Category:Template documentation pages]]</noinclude>

Template:TemplateData header/doc - Revision history

RogueScholar: Create template documentation page