Template:Documentation

From The Obey Me Wiki

Description[edit]

This template is used to insert descriptions on template pages.

Syntax[edit]

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

Add <noinclude>{{documentation|documentation page}}</noinclude> to transclude an alternative page from the /doc subpage.

Usage[edit]

On the Template page[edit]

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 the documentation page[edit]

The documentation page is usually located on the /doc subpage for a template, but a different page can be specified with the first parameter of the template.

Cookies help us deliver our services. By using our services, you agree to our use of cookies.