Difference between revisions of "Template:Documentation"
Line 5: | Line 5: | ||
</span> | </span> | ||
<span style="font-weight:bold;font-size:125%"> | <span style="font-weight:bold;font-size:125%"> | ||
− | [[File:Template-info.png | + | [[File:Template-info.png|link=|alt=Documentation icon]] |
Template documentation | Template documentation | ||
</span> | </span> |
Latest revision as of 01:24, 16 April 2012
This is the {{documentation}} template.
This template displays a green doc box like you are seeing now, and automatically loads the content from a /doc subpage.
Usage
This template is used without any parameters, placed at the bottom of the template or page being documented, within <noinclude>
:
<!--Last line of your template code--><noinclude> {{documentation}} <!-- Add categories to the /doc subpage, not here! --> </noinclude>
Then this template automatically loads the content from the /doc subpage of the template it is used on.
Best practice
The code should be added at the bottom of the template code, with no space before <noinclude>
(which would cause extra space on pages where the template is used).
Categories and interwiki links that apply to the template itself should be added to the bottom of the /doc subpage, inside <includeonly>...</includeonly>
tags.
If the documentation page contains <includeonly>
or <noinclude>
tags as part of the visible documentation text, replace the "<
" with "<
".
Documentation pages
Documentation pages should end with the category links for both the documentation page and the template itself, in the following way:
<includeonly>[[Category:CATEGORY TO WHICH THE TEMPLATE BELONGS]]</includeonly> <noinclude>[[Category:Template documentation]]</noinclude>