Template:Testcases notice/doc

This is a documentation subpage for Template:Testcases notice.
It may contain usage information, categories and other content that is not part of the original template page.

This page is not a sandbox.

It should not be used for test editing. To experiment, please use the Wikipedia sandbox or your user sandbox.

This template is used on approximately 2,800 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

{{Testcases notice}} 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

{{Testcases notice}}, i.e. the template without any parameters, produces the notice as formatted above.

Parameters

You may specify the link to the associated sandbox page using the parameter sandboxlink:

{{Testcases notice |sandboxlink=../[alternate sandbox name here]}}

You may also specify that some other text is substituted for the word "sandbox" shown in the template using the parameter sandboxname:

{{Testcases notice |sandboxlink=../[alternate sandbox name here] |sandboxname=[alternate to "sandbox" here]}}

{{Testcases notice
 | [template name]
 | purgelink = 
 | sandboxlink = 
 | sandboxname = 
 | category = 
 | style = 
}}

{{{1}}} (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 (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 (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 [[Category:Template test cases|{{PAGENAME}}]]. When using this parameter, the double square brackets and "Category:" prefix are required. To suppress the category, use |category= (i.e. category without any value).

~~subpage-name~~: (deprecated) 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, subpage-name=sandbox3 implies sandboxlink=../sandbox3 |sandboxname=sandbox3.

Related pages

{{Documentation}}, for use at the bottom of templates and their /sandbox pages.
{{Template sandbox notice}}, for use at the bottom of /sandbox pages if {{Documentation}} is not used.