Changes
Jump to navigation
Jump to search
m
update /doc
{{Documentation subpage}}
<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). -->
{{not a sandbox}}
{{high-use| 2325 }}
{{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===
{{tlc|{{BASEPAGENAME}}}}, i.e. the template without any parameters, produces the notice as formatted above.
====Parameters====
<!----REVISED TO HERE---->
You may specify the link to the associated sandbox page using the parameter ''sandboxlink'':
: <code>{{((}}{{BASEPAGENAME}} |sandboxlink=../[alternate sandbox name here]{{))}}</code>
You may also specify that some other text is substituted for the word "sandbox" shown in the template using the parameter ''sandboxname'':
: <code>{{((}}{{BASEPAGENAME}} |sandboxlink=../[alternate sandbox name here] |sandboxname=[alternate to "sandbox" here]{{))}}</code>
{{((}}{{BASEPAGENAME}}
| [template name]
| purgelink =
| sandboxlink =
| sandboxname =
| category =
| style =
{{))}}
; <nowiki>{{{1}}}</nowiki> {{nobold|(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'' {{nobold|(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'' {{nobold|(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).
; <s>''subpage-name''</s>
: '''(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, <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 {{braces|Documentation}} is not used.
<includeonly>{{Sandbox other||
<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->
[[Category:Template test cases| ]]
[[Category:Template namespace templates]]
}}</includeonly>
<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). -->
{{not a sandbox}}
{{high-use| 2325 }}
{{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===
{{tlc|{{BASEPAGENAME}}}}, i.e. the template without any parameters, produces the notice as formatted above.
====Parameters====
<!----REVISED TO HERE---->
You may specify the link to the associated sandbox page using the parameter ''sandboxlink'':
: <code>{{((}}{{BASEPAGENAME}} |sandboxlink=../[alternate sandbox name here]{{))}}</code>
You may also specify that some other text is substituted for the word "sandbox" shown in the template using the parameter ''sandboxname'':
: <code>{{((}}{{BASEPAGENAME}} |sandboxlink=../[alternate sandbox name here] |sandboxname=[alternate to "sandbox" here]{{))}}</code>
{{((}}{{BASEPAGENAME}}
| [template name]
| purgelink =
| sandboxlink =
| sandboxname =
| category =
| style =
{{))}}
; <nowiki>{{{1}}}</nowiki> {{nobold|(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'' {{nobold|(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'' {{nobold|(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).
; <s>''subpage-name''</s>
: '''(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, <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 {{braces|Documentation}} is not used.
<includeonly>{{Sandbox other||
<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->
[[Category:Template test cases| ]]
[[Category:Template namespace templates]]
}}</includeonly>
