Template:Informative template: Difference between revisions
Jump to navigation
Jump to search
m (Moving the category outside the template in the copy-pastable example to reflect the common usage) |
(+ When applicable, use Known issues section) |
||
| Line 37: | Line 37: | ||
* Usage | * Usage | ||
And, when applicable: | And, when applicable: | ||
* Default values | |||
* Examples | * Examples | ||
* | * Known issues | ||
* Related templates | * Related templates | ||
}} | }} | ||
Revision as of 02:18, 10 November 2013
The following template description is not displayed when the template is inserted in an article.
{{{1}}}
The following template description is not displayed when the template is inserted in an article.
Goal
This template can be used to documentate a wiki template and to distinguish the documentation from the actual template.
Usage
The template is used with one variable en must be put between <noinclude></noinclude> tags. Please put the <noinclude> tag right behind the intended contents of the template, as an empty line or extra spaces will alter the way the template is rendered.
<noinclude>
{{Informative template|1=
__NOTOC__
== Goal ==
The intended use of the template.
== Usage ==
An overview of the available template options.
== Examples ==
Examples using different options.
== Related templates ==
* {{tl|example}}
}}
[[Category:Templates]]
</noinclude>
Please use at least the following sections:
- Goal
- Usage
And, when applicable:
- Default values
- Examples
- Known issues
- Related templates