Difference between revisions of "Template:Documentation/doc"
Jump to navigation
Jump to search
m (→Usage: noinclude! :|) |
|||
| (3 intermediate revisions by the same user not shown) | |||
| Line 8: | Line 8: | ||
;Example | ;Example | ||
:Give an example of its use. | :Give an example of its use. | ||
;See also | |||
:For similar templates. | |||
===Usage=== | ===Usage=== | ||
;Including the template. | ;Including the template. | ||
:<pre><noinclude>{{documentation}}</noinclude></pre> | :<pre><noinclude>{{documentation}}</noinclude></pre> | ||
;Sectioning its documentation | ;Include the template in an article or page, which require documentation that is not itself. This first parameter is of course optional. | ||
<pre>===Use=== | :<pre>{{documentation|template-name}}</pre> | ||
<dl><dt>Sectioning its documentation | |||
<dd><pre>===Use=== | |||
===Usage=== | ===Usage=== | ||
===Example===</pre> | ===Example=== | ||
===See also===</pre></dl> | |||
Latest revision as of 21:30, 17 March 2009
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>- Include the template in an article or page, which require documentation that is not itself. This first parameter is of course optional.
{{documentation|template-name}}
- Sectioning its documentation
===Use=== ===Usage=== ===Example=== ===See also===