Template:Documentation: Difference between revisions
Template page
More actions
No edit summary |
m 1 revision |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
<includeonly>{| class="article-table" style="width:100%;" | <includeonly>{| class="article-table" style="width:100%;" role="complementary" | ||
|- style="font-size:18px;" | |- style="font-size:18px;" | ||
! Template documentation | ! style="padding:0px;" | <div style="width:100%; padding:3px 0px; text-align:center;" class="color1">Template documentation</div> | ||
|- | |- | ||
| ''Note: the template | | ''Note: portions of the template sample may not be visible without values provided.'' | ||
|- | |- | ||
| | | View or edit [[{{{1|Template:{{PAGENAMEE}}/doc}}}|this documentation]]. ([[Template:Documentation|About template documentation]]) | ||
|- | |||
| Editors can experiment in this template's [{{fullurl:{{FULLPAGENAMEE}}/Draft|action=edit}} sandbox] and [{{fullurl:{{FULLPAGENAMEE}}/testcases}} test case] pages. | |||
|} | |} | ||
<div style="margin:0 1em;"> | <div style="margin:0 1em;"> | ||
{{{{PAGENAME}}/doc}}</div></includeonly><noinclude>{{ | {{{{{1|{{PAGENAME}}/doc}}}}}</div></includeonly><noinclude>{{Documentation}}[[Category:Template documentation| ]]</noinclude> | ||
Latest revision as of 02:03, 23 June 2020
Template documentation
|
|---|
| Note: portions of the template sample may not be visible without values provided. |
| View or edit this documentation. (About template documentation) |
| Editors can experiment in this template's sandbox and test case pages. |
Description
This template is used to insert descriptions on template pages.
Syntax
Add <noinclude>{{documentation}}</noinclude> at the end of the template page.
Usage
On the Template page
This is the normal format when used:
TEMPLATE CODE<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
{{documentation}}</noinclude>
If your template is not a completed div or table, you may need to close the tags just before {{documentation}} is inserted (within the noinclude tags).
A line break right before {{documentation}} can also be useful as it helps prevent the documentation template "running into" previous code.
On the Template/doc page
Normally, you will want to write something like the following on the documentation page:
==Description==
This template is used to do something.
==Syntax==
Type <code>{{t|templatename}}</code> somewhere.
==Samples==
<code><nowiki>{{templatename|input}}</nowiki></code>
results in...
{{templatename|input}}
<includeonly>Any categories for the template itself</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or other sections.
Note that the above example also uses the Template:T and Template:T/piece templates.