Difference between revisions of "Template:Doc/doc"

From TerraFirmaCraft Wiki
Jump to: navigation, search
(Created page with ";Description :This template is used to insert descriptions on template pages. ;Syntax :Type <code><nowiki><noinclude>{{Doc}}</noinclude></nowiki></code> at the end of the temp...")
(No difference)

Revision as of 21:30, 16 May 2014

Description
This template is used to insert descriptions on template pages.
Syntax
Type <noinclude>{{Doc}}</noinclude> at the end of the template page.

General usage

On the Template page

<includeonly>Template code and Any categories to be inserted into articles by the template</includeonly><noinclude>
{{doc}}</noinclude>


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

On the Template/doc page

;Description
:This template is used to do something.
;Syntax
:Type <code></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|{{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.