Difference between revisions of "Template:Documentation/doc"
Jump to navigation
Jump to search
m (→Use: Also "see also".) |
m (→Usage: fix.) |
||
| Line 14: | Line 14: | ||
;Including the template. | ;Including the template. | ||
:<pre><noinclude>{{documentation}}</noinclude></pre> | :<pre><noinclude>{{documentation}}</noinclude></pre> | ||
<dl><dt>Sectioning its documentation | |||
<pre>===Use=== | <dd><pre>===Use=== | ||
===Usage=== | ===Usage=== | ||
===Example===</pre> | ===Example=== | ||
===See also===</pre></dl> | |||
Revision as of 18:55, 11 April 2008
Use
Add this to any template to provide a documentation for it. It will provide you with a link where you can write the documentation. A documentation could have the following sections, in this order, apply where applicable:
- Use
- Describe the use of this template.
- Usage
- Describe how to use it.
- Example
- Give an example of its use.
- See also
- For similar templates.
Usage
- Including the template.
<noinclude>{{documentation}}</noinclude>
- Sectioning its documentation
===Use=== ===Usage=== ===Example=== ===See also===