Template:Documentation/doc: Difference between revisions
Appearance
Forgottenman (talk | contribs) m fix tag |
Forgottenman (talk | contribs) m fix example |
||
| Line 8: | Line 8: | ||
**A few examples | **A few examples | ||
*Add an [[:Category:Mises Wiki templates|appropriate category]]. When doing so, surround the category in <code><nowiki><includeonly></nowiki></code> tags; for example: | *Add an [[:Category:Mises Wiki templates|appropriate category]]. When doing so, surround the category in <code><nowiki><includeonly></nowiki></code> tags; for example: | ||
*:<code><nowiki><includeonly>[[Category:Example]]</ | *:<code><nowiki><includeonly>[[Category:Example]]</includeonly></nowiki></code> | ||
That's it! | That's it! | ||
<includeonly>[[Category:Mises Wiki templates]]</includeonly> | <includeonly>[[Category:Mises Wiki templates]]</includeonly> | ||
Revision as of 20:08, 23 December 2010
This template should be used on each template page to describe the function of the template. To use it, follow these steps:
- Add
{{documentation}}to any template page. - This will generate a red link to a subpage of the template: if your template is Template:Example, the documentation link will be Template:Example/doc. Click this link.
- Enter key information about Template:Example. You might include:
- What the template does
- What parameters the template requires, if any
- What parameters the template allows, if any
- A few examples
- Add an appropriate category. When doing so, surround the category in
<includeonly>tags; for example:<includeonly>[[Category:Example]]</includeonly>
That's it!