Difference between revisions of "Template:Documentation"

From Underrail Wiki
Jump to navigation Jump to search
m (Undo revision 1155 by Wargo (talk))
Line 6: Line 6:
 
|-
 
|-
 
| Visit [[Template:{{PAGENAMEE}}/doc]] to edit this documentation. ([[Template:Documentation|How does this work?]])
 
| Visit [[Template:{{PAGENAMEE}}/doc]] to edit this documentation. ([[Template:Documentation|How does this work?]])
|}
+
|-
<div style="margin:0 1em;">
+
|<div style="margin:0 1em;">
 
{{tocright}}
 
{{tocright}}
{{{{PAGENAME}}/doc}}</div></includeonly><noinclude>{{documentation}}[[Category:Template documentation| ]]</noinclude>
+
{{{{PAGENAME}}/doc}}</div>
 +
|}</includeonly><noinclude>{{documentation}}[[Category:Template documentation| ]]</noinclude>

Revision as of 08:42, 22 October 2014

Template documentation follows
Note: the template above may sometimes be partially or fully invisible.
Visit Template:Documentation/doc to edit this documentation. (How does this work?)

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.