Template:/doc: Difference between revisions
Mastergalen (talk | contribs) (Created page with "{{doc/start}} To use, create a sub-page from the template called '''doc''', put {{tl|doc/start}} at the start of your documentation, and {{tl|doc/end}} at the end. Go back to...") |
|||
| Line 12: | Line 12: | ||
If a template has no documentation and you don't know how to use it, put {{tl|doc/start|nodoc{{=}}1}} (or if the template needs clear as well, {{tl|doc/start|clear|nodoc{{=}}1}}) instead of {{tl|doc/start}} on your documentation page.<br /> | If a template has no documentation and you don't know how to use it, put {{tl|doc/start|nodoc{{=}}1}} (or if the template needs clear as well, {{tl|doc/start|clear|nodoc{{=}}1}}) instead of {{tl|doc/start}} on your documentation page.<br /> | ||
The documentation's background will become red to make it more noticeable, and the page will be added to [[:Category:Templates with no documentation]]. | The documentation's background will become red to make it more noticeable, and the page will be added to [[:Category:Templates with no documentation]]. | ||
Revision as of 18:10, 3 April 2012
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:Documentation templates.
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}} 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.
nodoc=1
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, {{doc/start}}) 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.
