View source for Template:Testcases notice/doc

{{Documentation subpage}}
<!---PLEASE PLACE CATEGORIES WHRE INDICATED AT THE BOTTOM OF THIS PAGE--->
{{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===
{{tld|{{BASEPAGENAME}}}}, i.e. the template without any parameters, produces the notice as formatted above.
====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/>
{{tld|{{BASEPAGENAME}}&nbsp;|purgelink&#61;inline}}, for instance, produces:
{{{{BASEPAGENAME}} |purgelink=inline}}
====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/>
{{tld|{{BASEPAGENAME}}&nbsp;|toc&#61;on}}, for instance, produces:
{{{{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.
====Other parameters====
<!----REVISED TO HERE---->
You may specify the link to the associated sandbox page using the parameter ''sandboxlink'':
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} |sandboxlink=../[alternate sandbox name here]<nowiki>}}</nowiki></code>
You may also specify that some other text is substituted for the word "sandbox" shown in the template using the parameter ''sandboxname'':
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} |sandboxlink=../[alternate sandbox name here] |sandboxname=[alternate to "sandbox" here]<nowiki>}}</nowiki></code>
 <nowiki>{{</nowiki>{{BASEPAGENAME}}
 | [template name]
 | purgelink =
 | sandboxlink =
 | sandboxname =
 | category =
 | style =
 <nowiki>}}</nowiki>
; <nowiki>{{{1}}}</nowiki> &nbsp;(i.e. first unnamed parameter)
: Full name of the template being tested on the page, including the "Template:" prefix. If omitted, the default is the base page of the test cases page. Be careful not to use any leading or trailing spaces with this parameter, as they will affect the display of the template link.
; ''sandboxlink'' &nbsp;(or ''sandbox link'')
: The page that the sandbox link in the message targets. Can be an absolute page name, or relative to the test cases page. The default is "../sandbox".
; ''sandboxname'' &nbsp;(or ''sandbox name'')
: The text shown for the sandbox link. The default is "sandbox".
; ''category''
: Category and sort key to use for the test cases page instead of the default of <code><nowiki>[[Category:Template test cases|{{PAGENAME}}]]</nowiki></code>. When using this parameter, the double square brackets and "Category:" prefix are required. To suppress the category, use {{para|category}} (i.e. ''category'' without any value).
; ''style''
: Use if/when there is a need to override the margin/padding-top:0 settings applied to the message box carrying the notice (or to apply other CSS styling to it).
; <s>''subpage-name''</s>
: '''(deprecated)'''&nbsp; Sets the ''sandboxlink'' and ''sandboxname'' parameters at the same time. The value is prefixed with "../" for the sandbox link, so must be a page name relative to the base page. For example, <code>subpage-name=sandbox3</code> implies <code>sandboxlink=../sandbox3 |sandboxname=sandbox3</code>.
===See also===
* {{tl|Documentation}}, for use at the bottom of templates and their /sandbox pages.
* {{tl|Template sandbox notice}}, for use at the bottom of /sandbox pages if <nowiki>{{</nowiki>Documentation<nowiki>}}</nowiki> is not used.
<includeonly>
{{#ifeq:{{SUBPAGENAME}}|sandbox | |
[[Category:Template test cases| ]]
[[Category:Template namespace templates]]
[[Category:Message box templates]]
}}</includeonly>