Template:Documentation
| Template Documentation: |
|---|
| Note: the template above may sometimes be partially or fully invisible. |
| Documentation controls: [purge] [edit] [view] (Help with documentation) |
Description
This template is used to insert descriptions on template pages.
Syntax
Add <noinclude>{{Documentation}}</noinclude> at the end of the template page.
Usage
On the Template page
This is the normal format when used:
TEMPLATE CODE<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.
New Documentation
When the documentation template is used, but no documentation is found, the template page will show a "create" link. Clicking this link will generate the documentation with a preload. Create the documentation and publish.
You may use any or all of the sections provided by the preload. You may also want to add "see also" or other sections as well. Please note that the preload example also uses the Template:T and Template:T/piece templates.
Existing Documentation
When documentation is found, the template page will display three different links, instead of the "Create" link:
- Purge - Reloads the page and forces the wiki to rebuild everything on it. This is useful sometimes if changes to your template or documentation aren't appearing.
- Edit - Edit the documentation, not the template.
- View - View the documentation on its own stand-alone page, without the template.
