Template:Documentation: Difference between revisions
(It is extremely annoying to have to scroll all the way through 10 screens of temp docs for every "show preview". However, I do not wish to disturb others if they need to have the template documentation on screen all the time without tab switching.) |
(Undid revision 615363175 by Technical 13 (talk): The module already gives it class="template-documentation" (and if there is something else you want to change, do it in the module)) |
||
| Line 1: | Line 1: | ||
{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}<noinclude> |
|||
<!-- Categories go on the /doc subpage, and interwikis go on Wikidata. --> |
<!-- Categories go on the /doc subpage, and interwikis go on Wikidata. --> |
||
</noinclude> |
</noinclude> |
||
Revision as of 00:31, 3 July 2014
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.
| The above documentation is transcluded from Template:Documentation/doc. (edit | history) Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages. Please add categories to the /doc subpage. Subpages of this template. |
