Thank you for visiting SotAwiki, a Shroud of the Avatar Wiki Encyclopedia. If you see any information that is outdated, please take the time to update it, or if you prefer, leave a message for other editors. This community wiki is for the benefit of all Avatars!

Template:Documentation: Difference between revisions

From SotA Wiki
Jump to navigation Jump to search
Gordias (talk | contribs)
m it seems "display:none" is not necessary
Gordias (talk | contribs)
m +sotawikitable
Line 1: Line 1:
<includeonly><div style="border:1px solid black; margin:1em;"><div style="background:#ddd; color:#111; padding:1em; margin:0em;">'''Template documentation''' <span style="font-size:85%;">(for the above template, sometimes hidden or invisible)</span></div><div style="padding:1em; padding-bottom:0em; margin:0em;">{{tocright}}
<includeonly>{| class="sotawikitable" style="margin:1em;"
|+ 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;" | {{tocright}}
{{{{PAGENAME}}/doc}}
{{{{PAGENAME}}/doc}}
</div><br style="clear:both;"/><div style="background:#ddd; color:#111; padding:0.5em; margin:0em; font-size:85%; text-align:right;">Visit [[Template:{{PAGENAME}}/doc]] to edit this text! ([[Template:Documentation|How does this work]]?)</div></div></includeonly><noinclude>
|-
! style="padding:0.5em; margin:0em; font-size:85%; text-align:right;" | Visit [[Template:{{PAGENAME}}/doc]] to edit this text! ([[Template:Documentation|How does this work]]?)
|}</includeonly><noinclude>
{{documentation}}[[Category:Template Documentation| ]]</noinclude>
{{documentation}}[[Category:Template Documentation| ]]</noinclude>

Revision as of 20:34, 8 March 2014

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

Purpose

This template is used to insert descriptions on template pages.

Usage

On the Template page

<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

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

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

== Parameters ==
{| class="sotawikitable"
! 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

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


Example

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


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