Difference between revisions of "Template:Documentation"

From UnderWiki
Jump to navigation Jump to search
m (1 revision imported: Template import)
 
Line 1: Line 1:
<includeonly>{| class="sotawikitable" style="width:100%;"
+
<includeonly>{| class="wikitable" style="width:100%;"
 
|+ style="text-align:left; padding:0.5em;" | '''Template documentation''' <span style="font-size:85%;">(for the above template, sometimes hidden or invisible)</span>
 
|+ style="text-align:left; padding:0.5em;" | '''Template documentation''' <span style="font-size:85%;">(for the above template, sometimes hidden or invisible)</span>
 
| style="padding:1em; padding-bottom:0em; margin:0em; background:none;" | {{tocright}}
 
| style="padding:1em; padding-bottom:0em; margin:0em; background:none;" | {{tocright}}

Latest revision as of 08:04, 2 February 2015

Template documentation (for the above template, sometimes hidden or invisible)

Purpose[edit]

This template is used to insert descriptions on template pages.

Usage[edit]

On the Template page[edit]

<includeonly> Template code... Any categories to be inserted into articles by the template..</includeonly><noinclude> Template's categories.. {{documentation}}
</noinclude>

Note that, depending on the template, you may need to add a clear or complete a table/div just before {{documentation}} is inserted (within the noinclude tags).

The line break is also useful as it helps prevent the documentation template "running into" previous code.

On the Template/doc page[edit]

== Purpose ==
This template is used to do something.

== Usage ==
<pre>{{templatename|template parameters}}</pr e>

== Parameters ==
{| class="wikitable"
! Parameter
! Explanation
|-
| firstparameter
| Description of the first parameter
|-
| ...
| ...
...
|}

== Example ==
<pre>{{templatename|template parameters}}</pr e>
{{templatename|template parameters}}

<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 further usage information sections.


Parameters[edit]

Parameter Explanation
1 (optional) The name of template whose documentation will be displayed.


Example[edit]

{{documentation}}
{{documentation|Infobox Location}}


Visit Template:Documentation/doc to edit this text! (How does this work?)