Difference between revisions of "Template:Documentation/doc"

Revision as of 10:01, 16 April 2016

This template was copied from Template:Documentation on Wikia Templates. That wiki should periodically be checked for a new version of this template.

Description

This template is used to insert documentation on template pages.

Syntax

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

General usage

On the Template page

<noinclude>{{Underconstruction}}
</noinclude><!-- Template code --><noinclude>
{{documentation}}
</noinclude>

On the Template/doc page

Preloading Not needed when using the preload functionality provided by the create link when using the {{Documentation}} template.

{{SPW|name={{subst:Template:BASEPAGENAME}}}}
==Description==
:This template is used to do something.
==Dependencies==
:* Uses (some CSS, JS, file, or other template).
==Syntax==
:Type <code>{{t|templatename}}</code> somewhere.
==Sample output==
:<code><nowiki>{{templatename|foo}}</nowiki></code> gives...
:{{templatename|foo}}

<includeonly>Any categories for the template itself
</includeonly><noinclude>
[[Category:Template documentation]]
</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.

Note that the above example also uses {{T}}.

Dependencies

• Template:Documentation/preload
• Template:Documentation/preload-sandbox
• Template:Documentation/preload-testcases
• Site-wide CSS:

.template-documentation .color1,
#bodyContent .template-documentation .color1 a,
#bodyContent .template-documentation .color1 a.external
{
    background-color:#36C;
    color:white;
}

• Template:T + Template:T/doc
• Template:Tocright + Template:Tocright/doc
• Template:SPW + Template:SPW/doc