Template:Documentation
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>
Example
Example
Coat of Arms
Example
Territory
Example
National Information
Full Name
Example
National Anthem
File:Example.ogg
Name in Towny
Example
Motto
Example
Population
Example
Chunks
Example
Capital City
Example
Largest City
Example
Oldest City
Example
Established
Example
Disbanded
Example
Discord
Example
Government Information
Leader
Example
Chancellors
Example
Prime Minister
Example
Ministers
Example
Political System
Example
Economic System
Example
Official Language
Example
Official Religion
Example
Army Size
Example
Dominions
Example
Part of
Example
Historical Information
Past Leaders
Example
Past Capitals
Example
</noinclude> at the end of the template page.
Add <noinclude>
Example
Example
Coat of Arms
Example
Territory
Example
National Information
Full Name
Example
National Anthem
File:Example.ogg
Name in Towny
Example
Motto
Example
Population
Example
Chunks
Example
Capital City
Example
Largest City
Example
Oldest City
Example
Established
Example
Disbanded
Example
Discord
Example
Government Information
Leader
Example
Chancellors
Example
Prime Minister
Example
Ministers
Example
Political System
Example
Economic System
Example
Official Language
Example
Official Religion
Example
Army Size
Example
Dominions
Example
Part of
Example
Historical Information
Past Leaders
Example
Past Capitals
Example
</noinclude> to transclude an alternative page from the /doc subpage.
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 documentation page
The documentation page is usually located on the /doc subpage for a template, but a different page can be specified with the first parameter of the template (see Syntax).
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]]</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 template.