Template:Documentation: Difference between revisions
switch Doc and Documentation Tag: Removed redirect |
added note for short forms |
||
| Line 1: | Line 1: | ||
<noinclude>{{doc/start}} | <noinclude>{{doc/start}} | ||
To use, create a sub-page from the template called '''doc''', put {{tlx|doc/start}} at the start of your documentation, and {{tlx|doc/end}} at the end. | To use, create a sub-page from the template called '''doc''', put {{tlx|doc/start}}<ref group="note", name="shortForm>{{tlx|doc}}, {{tlx|doc/start}} and {{tlx|doc/end}} are available short forms for {{tlx|Documentation}}, {{tlx|Documentation/start}} and {{tlx|Documentation/end}}</ref> at the start of your documentation, and {{tlx|doc/end}}<ref group="note", name="shortForm"/> at the end. | ||
Go back to your main template page and put <noinclude>{{tlx|doc}}</noinclude> on a newline after the end of the template. /doc pages will automatically be added to [[:Category:Template documentation]]. | Go back to your main template page and put <noinclude>{{tlx|doc}}</noinclude><ref group="note", name="shortForm"/> on a newline after the end of the template. /doc pages will automatically be added to [[:Category:Template documentation]]. | ||
=== Notes === | |||
<references group="note"/> | |||
== Optional parameters == | == Optional parameters == | ||
Latest revision as of 12:34, 4 April 2025
To use, create a sub-page from the template called doc, put {{doc/start}}[note 1] at the start of your documentation, and {{doc/end}}[note 1] at the end.
Go back to your main template page and put <noinclude>{{doc}}</noinclude>[note 1] on a newline after the end of the template. /doc pages will automatically be added to Category:Template documentation.
Notes
- ↑ 1.0 1.1 1.2
{{doc}},{{doc/start}}and{{doc/end}}are available short forms for{{Documentation}},{{Documentation/start}}and{{Documentation/end}}
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.
nodoc=1
If a template has no documentation and you don't know how to use it, put {{doc/start|nodoc=1}} (or if the template needs clear as well, {{doc/start|clear|nodoc=1}}) 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.
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.