Difference between revisions of "Documentation"
From Unofficial Stationeers Wiki
(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)) |
(The module doesn't apply the class to the whole template, just part of it and I know nothing about Lua to add it there.) |
||
| Line 1: | Line 1: | ||
| − | {{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}<noinclude> | + | <span class="template-documentation">{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}</span><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 21:41, 2 July 2014
Template documentationDescription
This template is used to insert descriptions on template pages.
Syntax
Add <noinclude>{{Documentation}}</noinclude> at the end of the template page.
Add <noinclude>{{Documentation|documentation page}}</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>{{Documentation}}</code> somewhere.
==Samples==
<code><nowiki>{{Documentation|input}}</nowiki></code>
results in...
{{Documentation|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.
| 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. |