Template:Documentation/doc

From Anthem Wiki
Jump to: navigation, search

Description

This template is used to insert informative overviews on template pages.

Usage

Add {{documentation}} at the end of a given template page.

Examples

On a template page

This is the normal format when used:

TEMPLATE CODE<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
{{documentation}}</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 a template/doc page

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

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

== Usage ==
Type {{tlx|templatename}} somewhere.

== Examples ==
{{tlx|templatename|input}}

results in...

{{templatename|input}}

<includeonly>Any categories for the template itself</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>

Use any or all of the above summary/usage/example output sections. You may also want to add "see also" or other additional sections.