Template:Sandbox other/doc: Difference between revisions
From Zoophilia Wiki
Jump to navigationJump to search
meta>Paine Ellsworth (create /doc page) |
m (36 revisions imported) |
||
| (35 intermediate revisions by 13 users not shown) | |||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) --> | <!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) --> | ||
{{sandbox other||{{not a sandbox}}}} | |||
{{High-use}} | |||
{{Lua|Module:String}} | |||
This template allows to differentiate between regular <code>Template:...</code> and <code>Template:.../sandbox</code> pages. It is typically used to ''prevent'' a /sandbox page being categorised with their main page. | |||
;Also: when numbered /sandbox1 | |||
Any subpage <code>/sandbox''ANYTEXT''</code> is considered a <code>/sandbox</code>. So this includes <code>/sandbox''1''</code>, <code>/sandbox_2</code>. | |||
;Also: /doc | |||
A <code>/doc</code> subpage is also considered a <code>/sandbox</code>. | |||
== Usage == | == Usage == | ||
This template can be used on template documentation pages to ensure that any given template sandbox does not populate its main template's category(ies) | This template can be used on template documentation pages to ensure that any given template sandbox or template documentation does not populate its main template's category(ies). | ||
This template has two unnamed parameters, {{para|1}} and {{para|2}}. Near the bottom of a /doc page where the categories are usually placed, install this template as follows: | This template has two unnamed parameters, {{para|1}} and {{para|2}}. Near the bottom of a /doc page where the categories are usually placed, install this template as follows: | ||
<pre> | <pre> | ||
{{Documentation subpage}} | |||
<!-- all /documentation code goes here --> | |||
<includeonly>{{sandbox other|| | <includeonly>{{sandbox other|| | ||
<!-- | <!-- categories the main template should be in, but not the /sandbox: --> | ||
[[Category:(first category)]] | [[Category:(first category)]] | ||
[[Category:(second category)]] | [[Category:(second category)]] | ||
}}</includeonly> | }}</includeonly> | ||
</pre> | </pre> | ||
* Note that the closing template braces ({{code|<nowiki>}}</nowiki>}}) are placed just before the </includeonly> tag. This is the same as {{para|2|(category comment and categories)}}. | * Usage of an empty first parameter (two pipes together, {{code|<nowiki>||</nowiki>}}, at the end of the first line of code above) essentially means {{para|1|(do nothing)}} and will not allow the sandbox page to populate the listed categories. | ||
* Note that the closing template braces ({{code|<nowiki>}}</nowiki>}}) are placed just before the </includeonly> tag. This is the same as {{para|2|(category comment and categories)}}. In "long hand" it may appear as follows: | |||
<pre> | |||
<includeonly>{{sandbox other|1=<!-- keep sandbox out of categories -->|2= | |||
<!-- Categories go below this line; interwikis go to Wikidata --> | |||
[[Category:(first category)]] | |||
[[Category:(second category)]] | |||
(more categories if needed) | |||
}}</includeonly> | |||
< | |||
</pre> | </pre> | ||
== See also == | |||
{{Foo other see also}} | |||
{{Namespace and pagename-detecting templates}} | |||
<includeonly>{{sandbox other|| | <includeonly>{{sandbox other|| | ||
<!-- Categories below this line, please; interwikis at Wikidata --> | <!-- Categories below this line, please; interwikis at Wikidata --> | ||
[[Category:Pagename manipulation templates]] | |||
[[Category:Template namespace templates]] | |||
}}</includeonly> | }}</includeonly> | ||
Latest revision as of 05:02, 3 September 2020
 | This is a documentation subpage for Template:Sandbox other. It may contain usage information, categories and other content that is not part of the original template page. |
 | This template is used on approximately 107,000 pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
 | This template uses Lua: |
This template allows to differentiate between regular Template:... and Template:.../sandbox pages. It is typically used to prevent a /sandbox page being categorised with their main page.
- Also
- when numbered /sandbox1
Any subpage /sandboxANYTEXT is considered a /sandbox. So this includes /sandbox1, /sandbox_2.
- Also
- /doc
A /doc subpage is also considered a /sandbox.
Usage
This template can be used on template documentation pages to ensure that any given template sandbox or template documentation does not populate its main template's category(ies).
This template has two unnamed parameters, |1= and |2=. Near the bottom of a /doc page where the categories are usually placed, install this template as follows:
{{Documentation subpage}}
<!-- all /documentation code goes here -->
<includeonly>{{sandbox other||
<!-- categories the main template should be in, but not the /sandbox: -->
[[Category:(first category)]]
[[Category:(second category)]]
}}</includeonly>
- Usage of an empty first parameter (two pipes together, <syntaxhighlight lang="text" class="" id="" style="" inline="1">||</syntaxhighlight>, at the end of the first line of code above) essentially means
|1=(do nothing)and will not allow the sandbox page to populate the listed categories. - Note that the closing template braces (<syntaxhighlight lang="text" class="" id="" style="" inline="1">}}</syntaxhighlight>) are placed just before the </includeonly> tag. This is the same as
|2=(category comment and categories). In "long hand" it may appear as follows:
<includeonly>{{sandbox other|1=<!-- keep sandbox out of categories -->|2=
<!-- Categories go below this line; interwikis go to Wikidata -->
[[Category:(first category)]]
[[Category:(second category)]]
(more categories if needed)
}}</includeonly>
See also
- {{Sandbox other}} — Distinguishes between the /sandbox subpages and the root template page and other subpages.
- {{Testcases other}} — Distinguishes between the /testcases subpages and the root template page and other subpages.
- {{Template other}} — Distinguishes between pages in the template namespace and other namespaces.
- {{When on basepage}} — Distinguishes between the root template page and subpages, without special consideration in the mainspace.
- {{Subpage other}} — Distinguisheds between the root page and subpages (any subpage), classifying pagenames in the mainspace with a slash as being the root page.
