Template:Doc/doc - Revision history

76561198021843184: 3 revisions imported

2025-10-21T23:46:04Z

3 revisions imported

← Older revision		Revision as of 23:46, 21 October 2025
(No difference)

wgg>CadsBot: /* baddoc=1 */ cat

2025-10-11T13:50:45Z

baddoc=1: cat

← Older revision		Revision as of 13:50, 11 October 2025
Line 16:		Line 16:
	The documentation's background will become yellow to make it more noticeable, and the page will be added to [[:Category:Templates with bad documentation]].		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.		If both nodoc and baddoc are specified, baddoc will be ignored.<noinclude>[[Category:Template documentation]]</noinclude>

wgg>CadsBot: removed redundant start/end

2025-10-11T13:30:18Z

removed redundant start/end

← Older revision		Revision as of 13:30, 11 October 2025
Line 1:		Line 1:
	~~{{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}} at the start of your documentation, and {{tlx\|doc/end}} at the end.

Line 18:		Line 17:

	If both nodoc and baddoc are specified, baddoc will be ignored.		If both nodoc and baddoc are specified, baddoc will be ignored.
	~~{{doc/end}}~~

wgg>Cadaei: Created page with "{{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. 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. == Optional parameters == === clear === If your main template page has floating content and y..."

2023-06-22T18:39:49Z

Created page with "{{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. 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. == Optional parameters == === clear === If your main template page has floating content and y..."

New page

{{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.

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]].

== Optional parameters ==
=== clear ===
If your main template page has floating content and you would like to stop it going over the documentation, put {{tlx|doc/start|clear}} instead of {{tlx|doc/start}} on your documentation page.<br/>
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 {{tlx|doc/start|nodoc{{=}}1}} (or if the template needs clear as well, {{tlx|doc/start|clear|nodoc{{=}}1}}) instead of {{tlx|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]].

=== 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.<br/>
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.
{{doc/end}}