3,860
edits
Template:Testcases notice/doc: Difference between revisions
Jump to navigation
Jump to search
Replaced broken templates with hard-coded text.
(Created doc subpage for Template:Testcases notice by copy-pasting from English Wikipedia.) |
(Replaced broken templates with hard-coded text.) |
||
| Line 9: | Line 9: | ||
{{{{BASEPAGENAME}} |purgelink=inline}} | {{{{BASEPAGENAME}} |purgelink=inline}} | ||
====Table of Contents==== | ====Table of Contents==== | ||
To include a Table of Contents (ToC), set the parameter | 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}} |toc=on}}, for instance, produces: | {{tc|{{BASEPAGENAME}} |toc=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 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. | ||
====Other parameters==== | ====Other parameters==== | ||
<!----REVISED TO HERE----> | <!----REVISED TO HERE----> | ||
You may specify the link to the associated sandbox page using the parameter ''sandboxlink'': | You may specify the link to the associated sandbox page using the parameter ''sandboxlink'': | ||
: <code>{{ | : <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'': | You may also specify that some other text is substituted for the word "sandbox" shown in the template using the parameter ''sandboxname'': | ||
: <code>{{ | : <code><nowiki>{{</nowiki>{{BASEPAGENAME}} |sandboxlink=../[alternate sandbox name here] |sandboxname=[alternate to "sandbox" here]<nowiki>}}</nowiki></code> | ||
{{ | <nowiki>{{</nowiki>{{BASEPAGENAME}} | ||
| [template name] | | [template name] | ||
| purgelink = | | purgelink = | ||
| Line 26: | Line 26: | ||
| category = | | category = | ||
| style = | | style = | ||
<nowiki>}}</nowiki> | |||
; <nowiki>{{{1}}}</nowiki> | ; <nowiki>{{{1}}}</nowiki> (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. | : 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'' | ; ''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". | : 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'' | ; ''sandboxname'' (or ''sandbox name'') | ||
: The text shown for the sandbox link. The default is "sandbox". | : The text shown for the sandbox link. The default is "sandbox". | ||
; ''category'' | ; ''category'' | ||
| Line 41: | Line 41: | ||
===See also=== | ===See also=== | ||
* {{tl|Documentation}}, for use at the bottom of templates and their /sandbox pages. | * {{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 {{ | * {{tl|Template sandbox notice}}, for use at the bottom of /sandbox pages if <nowiki>{{</nowiki>Documentation<nowiki>}}</nowiki> is not used. | ||
<includeonly> | <includeonly> | ||
{{#ifeq:{{SUBPAGENAME}}|sandbox | | | {{#ifeq:{{SUBPAGENAME}}|sandbox | | | ||