Usage
- Minimal
{{doc}}- Complete
{{doc|clear|nodoc=yes|baddoc=yes}}
To use?
- Create a sub-page from the template called doc
- Put
{{doc/start}}at the start of your documentation, and{{doc/end}}at the end. - Go back to your main template page and put this template between
<noinclude> </noinclude>on a newline after the end of the template.- /doc pages will automatically be added to category:documentation templates.
Description
Displays a documentation of a template.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Clear | 1 | Use it if your main template page has floating content and you would like to stop it going over the documentation. This is also useful for templates not using <includeonly>, as it will put some space between the template and the documentation box.
| String | optional |
| No doc | nodoc | Use it if a template has no documentation and you don't know how to use it. Overrides "'baddoc".
| Boolean | optional |
| Bad doc | baddoc | Similar to nodoc, this is used to mark templates that '''do''' have documentation, but it isn't very good. This can mean it doesn't have enough examples, doesn't explain all the functions properly, or doesn't explain the point of the template properly. Overriden by "baddoc".
| Boolean | optional |
The above documentation is transcluded from Template:Doc/doc. (edit | history)