Template:Testcases notice/doc: Difference between revisions

Corrections.
(Replaced broken templates with hard-coded text.)
(Corrections.)
Line 3: Line 3:
{{tl|{{BASEPAGENAME}}}} is meant to be placed at the top of a /testcases page, i.e. a page where a test version (a "sandbox" version) of (usually) a template and its parameters is tested and (usually) compared with the version currently in use (the "main" version). For further information about template sandboxes and testcase pages, see [[Wikipedia:Template sandbox and test cases]].
{{tl|{{BASEPAGENAME}}}} is meant to be placed at the top of a /testcases page, i.e. a page where a test version (a "sandbox" version) of (usually) a template and its parameters is tested and (usually) compared with the version currently in use (the "main" version). For further information about template sandboxes and testcase pages, see [[Wikipedia:Template sandbox and test cases]].
===Usage===
===Usage===
{{tc|{{BASEPAGENAME}}}}, i.e. the template without any parameters, produces the notice as formatted above.
{{tld|{{BASEPAGENAME}}}}, i.e. the template without any parameters, produces the notice as formatted above.
====Purge box / link====
====Purge box / link====
To replace the "purge box" beside the notice's text with a purge link in the text, include the parameter {{para<!--|plain-->|purgelink|inline}}.<br/>
To replace the "purge box" beside the notice's text with a purge link in the text, include the parameter {{para<!--|plain-->|purgelink|inline}}.<br/>
{{tc|{{BASEPAGENAME}}&nbsp;|purgelink&#61;inline}}, for instance, produces:
{{tld|{{BASEPAGENAME}}&nbsp;|purgelink&#61;inline}}, for instance, produces:
{{{{BASEPAGENAME}} |purgelink=inline}}
{{{{BASEPAGENAME}} |purgelink=inline}}
====Table of Contents====
====Table of Contents====
To include a Table of Contents (ToC), set the parameter <code>toc</code> (e.g. {{para<!--|plain-->|toc|on}}). If a limit to the ToC's depth is desired, <code>toc</code> can be set as that limit (usually a number between 1 and 4 or 5, e.g. {{para<!--|plain-->|toc|3}}) or, alternatively, set <code>toclimit</code> as the limit (e.g. {{para<!--|plain-->|toclimit|2}}) and omit <code>toc</code>.<br/>
To include a Table of Contents (ToC), set the parameter <code>toc</code> (e.g. {{para<!--|plain-->|toc|on}}). If a limit to the ToC's depth is desired, <code>toc</code> can be set as that limit (usually a number between 1 and 4 or 5, e.g. {{para<!--|plain-->|toc|3}}) or, alternatively, set <code>toclimit</code> as the limit (e.g. {{para<!--|plain-->|toclimit|2}}) and omit <code>toc</code>.<br/>
{{tc|{{BASEPAGENAME}}&nbsp;|toc&#61;on}}, for instance, produces:
{{tld|{{BASEPAGENAME}}&nbsp;|toc&#61;on}}, for instance, produces:
{{{{BASEPAGENAME}} |toc=on}}
{{{{BASEPAGENAME}} |toc=on}}
To prevent it pushing the start of a page's content (testcases) further downwards, the ToC is set to float over or beyond <br />the (empty) righthand end of the notice box.
To prevent it pushing the start of a page's content (testcases) further downwards, the ToC is set to float over or beyond <br />the (empty) righthand end of the notice box.
3,860

edits