Template:Doc/doc

This template displays a documentation of a template.

Usage
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  on a newline after the end of the template. /doc pages will automatically be added to category:documentation templates. This template is then used by entering:

Parameters

 * unnamed parameter (optional)
 * If your main template page has floating content and you would like to stop it going over the documentation, put instead of doc/start on your documentation page.

This is also useful for templates not using &lt;includeonly&gt;, as it will put some space between the template and the documentation box.


 *  (optional)
 * If a template has no documentation and you don't know how to use it, put doc/start (or if the template needs clear as well, ) instead of doc/start on your documentation page.
 * The documentation's background will become red to make it more noticeable, and the page will be added to category:templates with no documentation.


 *  (optional)
 * 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.
 * The documentation's background will become yellow to make it more noticeable, and the page will be added to category:templates with bad documentation.

If both nodoc and baddoc are specified, baddoc will be ignored.