UnderMine Wiki
Advertisement
Documentation[ view | edit | history | purge ]

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 <noinclude>{{doc}}</noinclude> on a newline after the end of the template. /doc pages will automatically be added to Category:Template documentation.

Optional parameters[]

clear[]

If your main template page has floating content and you would like to stop it going over the documentation, put {{doc/start|clear}} instead of {{doc/start}} on your documentation page.
This is also useful for templates not using <includeonly>, as it will put some space between the template and the documentation box.

baddoc=1[]

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.


Advertisement