Template:Documentation

From K6ka's Wiki
This is the current revision of this page, as edited by K6ka (talk | contribs) at 16:34, 23 February 2019 (Undid revision 2829 by K6ka (talk)). The present address (URL) is a permanent link to this version.
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Template documentation (View · Edit · History · Purge)

Description[edit source]

This template is used to insert descriptions on template pages.

Syntax[edit source]

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

Usage[edit source]

On the Template page[edit source]

This is the normal format when used:

TEMPLATE CODE<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
{{documentation}}
Any categories for the template itself</noinclude>

If your template is not a completed div or table, you may need to close the tags just before {{documentation}} is inserted (within the noinclude tags).

A line break right before {{documentation}} can also be useful as it helps prevent the documentation template "running into" previous code.

On the Template/doc page[edit source]

Normally, you will want to write something like the following on the documentation page:


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

==Syntax==
Type <code>{{t|templatename}}</code> somewhere.

==Samples==
<code><nowiki>{{templatename|input}}</nowiki></code> 

results in...

{{templatename|input}}

<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 other sections.

Note that the above example also uses the Template:T and Template:T/piece templates.


Nuvola apps important.svg Important
When beginning a /doc page with a heading, remember to add a line break between the start of the page and the first heading. Failing to do otherwise may break the heading, resulting in the raw wikitext of the heading being displayed.

Credits[edit source]

This template's code was taken from Template:Documentation on K6ka's Wiki on Wikia.


Visit Template:Documentation/doc to edit this text! (How does this work?) (Refresh this text - why?)
Template documentation (View · Edit · History · Purge)

Description[edit source]

This template is used to insert descriptions on template pages.

Syntax[edit source]

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

Usage[edit source]

On the Template page[edit source]

This is the normal format when used:

TEMPLATE CODE<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
{{documentation}}
Any categories for the template itself</noinclude>

If your template is not a completed div or table, you may need to close the tags just before {{documentation}} is inserted (within the noinclude tags).

A line break right before {{documentation}} can also be useful as it helps prevent the documentation template "running into" previous code.

On the Template/doc page[edit source]

Normally, you will want to write something like the following on the documentation page:


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

==Syntax==
Type <code>{{t|templatename}}</code> somewhere.

==Samples==
<code><nowiki>{{templatename|input}}</nowiki></code> 

results in...

{{templatename|input}}

<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 other sections.

Note that the above example also uses the Template:T and Template:T/piece templates.


Nuvola apps important.svg Important
When beginning a /doc page with a heading, remember to add a line break between the start of the page and the first heading. Failing to do otherwise may break the heading, resulting in the raw wikitext of the heading being displayed.

Credits[edit source]

This template's code was taken from Template:Documentation on K6ka's Wiki on Wikia.


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