Difference between revisions of "Template:Documentation"

From RimWorld Wiki
Jump to navigation Jump to search
m (1 revision: Full import of Wikia (that might sting a bit))
 
(Needed to use Infobox)
Line 1: Line 1:
<includeonly>{| class="article-table" style="width:100%;"
+
<!--
|- style="font-size:18px;"
+
  Automatically add {{template sandbox notice}} when on a /sandbox page.
! Template documentation follows
+
-->{{#ifeq: {{SUBPAGENAME}} | sandbox
|-
+
| <div style="clear: both;"></div>{{template sandbox notice|{{{livepage|}}}}}
| ''Note: the template above may sometimes be partially or fully invisible.''
+
}}<!--
|-
+
  Automatically add {{pp-template}} to protected templates.
| Visit [[Template:{{PAGENAMEE}}/doc]] to edit this documentation. ([[Template:Documentation|How does this work?]])
+
-->{{template other
|}
+
| {{#ifeq: {{PROTECTIONLEVEL:move}} | sysop
<div style="margin:0 1em;">
+
  | {{pp-template|docusage=yes}}
{{tocright}}
+
  | {{#if: {{PROTECTIONLEVEL:edit}}
{{{{PAGENAME}}/doc}}</div></includeonly><noinclude>{{documentation}}[[Category:Template documentation| ]]</noinclude>
+
    | {{pp-template|docusage=yes}}
 +
    | <!--Not protected, or only semi-move-protected-->
 +
    }}
 +
  }}
 +
}}<!--
 +
  Start of green doc box.
 +
-->{{documentation/start box2
 +
| preload = {{{preload|}}}  <!--Allow custom preloads-->
 +
| heading = {{{heading|¬}}}  <!--Empty but defined means no header-->
 +
| heading-style = {{{heading-style|}}}
 +
| content = {{{content|}}}
 +
 
 +
<!--Some namespaces must have the /doc, /sandbox and /testcases
 +
    in talk space-->
 +
| docspace = {{documentation/docspace}}
 +
 
 +
| 1 = {{{1|}}}  <!--Other docname, if fed-->
 +
 
 +
<!--The namespace is added in /start box2-->
 +
| template page = {{documentation/template page}}
 +
 
 +
}}<!-- Start content --><!--
 +
  Start load the /doc content:
 +
  Note: The line breaks between this comment and the next line are necessary
 +
  so  "=== Headings ===" at the start and end of docs are interpreted.
 +
-->
 +
{{#switch: {{#if:{{{content|}}}|1|0}}{{#if:{{{1|}}}|1|0}}{{#ifexist:{{{1|}}}|1|0}}{{#ifexist:{{documentation/docspace}}:{{documentation/template page}}/doc|1|0}}
 +
| 1000 | 1001 | 1010 | 1011 | 1100 | 1101 | 1110
 +
| 1111 = {{{content|}}}
 +
| 0110 | 0111 = {{ {{{1}}} }}
 +
| 0001 | 0011 = {{ {{documentation/docspace}}:{{documentation/template page}}/doc }}
 +
| 0000 | 0100 | 0010 | 0101 =
 +
}}
 +
<!--
 +
  End load the /doc content:
 +
  Note: The line breaks between this comment and the previous line are necessary
 +
  so  "=== Headings ===" at the start and end of docs are interpreted.
 +
-->{{documentation/end box2
 +
| preload = {{{preload|}}}   <!--Allow custom preloads-->
 +
| content = {{{content|}}}
 +
| link box = {{{link box|}}}   <!--So "link box=off" works-->
 +
 
 +
<!--Some namespaces must have the /doc, /sandbox and /testcases
 +
    in talk space-->
 +
| docspace = {{documentation/docspace}}
 +
 
 +
| 1 = {{{1|}}}  <!--Other docname, if fed-->
 +
 
 +
<!--The namespace is added in /end box2-->
 +
| template page = {{documentation/template page}}
 +
 
 +
}}<!--
 +
  End of green doc box
 +
--><noinclude>
 +
 
 +
<!-- Add categories and interwikis to the /doc subpage, not here! -->
 +
</noinclude>

Revision as of 13:21, 12 October 2013

Documentation icon Template documentation[view] [edit] [history] [purge]

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.

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

== Samples ==
<code><nowiki>{{templatename|input}}</nowiki></code> 

results in...

{{templatename|input}}

== 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.