From RimWorld Wiki
< Template:Documentation
Revision as of 14:33, 1 August 2019 by Pangaea (talk | contribs) (re-cat)
Jump to navigation Jump to search


This template is used to insert descriptions on template pages.


Add <noinclude>{{documentation}}</noinclude> at the end of the template page.


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>

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:

This template is used to do something.

Type <code>{{t|templatename}}</code> somewhere.

A more indepth description of when, how this template is used.


results in...


==See Also==
A list of all related links.

<includeonly>Any categories for the template itself</includeonly>
<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>

Use any or all of the above header sections. You may also add other header sections as required.

Note that the above example also uses the Template:T and Template:T/piece templates.