1,964
edits
Changes
Jump to navigation
Jump to search
Template:Template test cases notice/doc (view source)
Revision as of 10:09, 27 July 2012
, 10:09, 27 July 2012Documentation for Template_test_cases
{{documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
This is the {{tl|Template test cases notice}} template.
It can be placed at the top of template /testcases pages.
To learn more about how to use template /sandbox and /testcases subpages see [[Wikipedia:Template test cases]].
=== Usage ===
In the simplest case, this template needs no parameters.
<pre>
{{template test cases notice}}
</pre>
You may specify the link to the associated sandbox page using the parameter ''sandbox link'':
<pre>
{{template test cases notice|sandbox link=../AlternateSandboxName}}
</pre>
You may also specify that some other text is substituted for the word 'sandbox' shown in the template using the parameter ''sandbox name'':
<pre>
{{template test cases notice|sandbox link=../sandbox2|sandbox name=second sandbox}}
</pre>
=== All parameters ===
<pre>
{{template test cases notice|template name|category =
| sandbox link =
| sandbox name =
| subpage-name =
}}
</pre>
* '''1 (unnamed 1st 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.
* '''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 <code>category=</code> without any value following it.
* '''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''.
* '''sandbox name''': The text shown for the sandbox link. The default is ''sandbox''.
* '''subpage-name''': ''Deprecated.'' Sets the ''sandbox link'' and ''sandbox name'' 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> is equivalent to <code>sandbox link=../sandbox3 | sandbox name=sandbox3</code>.
=== See also ===
* {{tl|documentation}} - To put at the bottom of templates and their /sandbox pages.
* {{tl|template sandbox notice}} – To put at the bottom of /sandbox pages if {{tlf|documentation}} is not used.
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
This is the {{tl|Template test cases notice}} template.
It can be placed at the top of template /testcases pages.
To learn more about how to use template /sandbox and /testcases subpages see [[Wikipedia:Template test cases]].
=== Usage ===
In the simplest case, this template needs no parameters.
<pre>
{{template test cases notice}}
</pre>
You may specify the link to the associated sandbox page using the parameter ''sandbox link'':
<pre>
{{template test cases notice|sandbox link=../AlternateSandboxName}}
</pre>
You may also specify that some other text is substituted for the word 'sandbox' shown in the template using the parameter ''sandbox name'':
<pre>
{{template test cases notice|sandbox link=../sandbox2|sandbox name=second sandbox}}
</pre>
=== All parameters ===
<pre>
{{template test cases notice|template name|category =
| sandbox link =
| sandbox name =
| subpage-name =
}}
</pre>
* '''1 (unnamed 1st 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.
* '''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 <code>category=</code> without any value following it.
* '''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''.
* '''sandbox name''': The text shown for the sandbox link. The default is ''sandbox''.
* '''subpage-name''': ''Deprecated.'' Sets the ''sandbox link'' and ''sandbox name'' 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> is equivalent to <code>sandbox link=../sandbox3 | sandbox name=sandbox3</code>.
=== See also ===
* {{tl|documentation}} - To put at the bottom of templates and their /sandbox pages.
* {{tl|template sandbox notice}} – To put at the bottom of /sandbox pages if {{tlf|documentation}} is not used.
