Template:Documentation/doc

From Awesomenauts Wiki
Jump to: navigation, search
Description
This template is used to insert descriptions on template pages.
Syntax
Type <noinclude>{{documentation}}</noinclude> at the end of the template page.

General usage[edit source]

On the Template page[edit source]

Template code<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
{{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 source]

;Description
:This template is used to do something.
;Syntax
:Type {{tl|templatename}}</code> somewhere.
;Sample output
:<nowiki>{{templatename|foo}}</nowiki> gives...
:{{templatename|foo}}

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