Documentation
| | {{#ifexist: Documentation/doc | [view] [edit] [history] [refresh] | [create] }}
}}| {{{content}}} | {{#ifexist: Documentation/doc | Template:Tocright==Description== This template is used to insert descriptions on template pages.
Syntax
Add <noinclude>Template:T</noinclude>
at the end of the template page.
Add <noinclude>Template:T</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. | :This template doesn't have any documentation yet! Help out by writing some. {{#ifeq: | Template | There may also be documentation on Wikia Templates which can be copied. }}{{#ifeq: Documentation | Template:Documentation/preload | | }} }}
}} | Edit this page to change the above text. (What is this?)
| {{#ifexist:
Documentation/doc
| The above text is transcluded from Documentation/doc; you can change it or view its history. (How does this work?)
| This template currently doesn't have any documentation; you can create it if you know how the template is used. (What is this?)
}}
}}
If you're done making changes, please refresh the text. (Why?)
You can experiment in this template's {{#ifexist:
Documentation/sandbox
| sandbox (edit | diff)
| sandbox (create | mirror)
}} and {{#ifexist:
Documentation/testcases
| testcases (edit)
| testcases (create)
}} pages.
{{#if:
| | Please add categories and interwikis to {{#ifexist: Documentation/doc | Documentation/doc | Documentation/doc }}.
}} (View all subpages of this page.)