Template:Category other: Difference between revisions
meta>Davidgothberg (Removing the "return 'category'/'other' when no parameter" function, since not used, not needed and causes problems in some situations.) |
meta>Davidgothberg (Changing "Category" to "{{ns:Category}}". Thus slightly easier to port to other projects.) |
||
| Line 1: | Line 1: | ||
{{#switch: | {{#switch: | ||
<!--If no or empty "demospace" parameter then detect namespace--> | <!--If no or empty "demospace" parameter then detect namespace--> | ||
{{#if:{{{demospace|}}} | {{#if:{{{demospace|}}} | ||
| {{lc: {{{demospace}}} }} <!--Use lower case "demospace"--> | | {{lc: {{{demospace}}} }} <!--Use lower case "demospace"--> | ||
| {{#ifeq:{{NAMESPACE}}|Category | | {{#ifeq:{{NAMESPACE}}|{{ns:Category}} | ||
| category | | category | ||
| other | | other | ||
}} | }} | ||
}} | }} | ||
| category = {{{1|}}} | | category = {{{1|}}} | ||
| Line 13: | Line 13: | ||
}}<!--End switch--><noinclude> | }}<!--End switch--><noinclude> | ||
{{pp-template | {{pp-template}} | ||
{{ | {{documentation}} | ||
<!-- Add categories and interwikis to the /doc subpage, not here! --> | <!-- Add categories and interwikis to the /doc subpage, not here! --> | ||
</noinclude> | </noinclude> | ||
Revision as of 02:57, 13 March 2009
 | This template is used on 759,000+ pages, or roughly 11514% of all 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 is the {{category other}} meta-template.
This template helps other templates detect if they are on a "Category:" page or some "other" type of page.
Usage
This template usually takes two parameters, like this:
{{category other | Category page text | Other pages text }}
If the template is on a "Category:" page, it will return this:
- Category page text
If the template is on any other page, it will return this:
- Other pages text
A typical usage case could be to make it so that a template only adds a category when on category pages. Thus not adding other pages that just show the template. Like this:
{{category other | [[Category:Some category maintenance category]] }}
Or to warn that a template should not be used on other pages:
{{category other | | This template should only be used on category pages. }}
Note that in the first case above the "other" parameter was not used, and in the second example the "category" parameter was left empty.
Demospace
For testing and demonstration purposes this template can take a parameter named demospace.
- If it has the value category it returns the category page text.
- It if has the value other or any other value such as the name of some other namespace it returns the other pages text.
- If the parameter is empty or undefined, the actual page type determines the result.
Like this:
{{category other
| Category page text
| Other pages text
| demospace = category
}}
No matter on what kind of page the code above is used it will return this:
- Category page text
You can make it so your template also understands the demospace parameter. That means you can demonstrate the different appearances of your template in the documentation for your template. Then do like this:
{{category other
| Category page text
| Other pages text
| demospace = {{{demospace|}}}
}}
Technical details
This template detects "Category talk:" pages as type other.
This template works like {{main talk other}}, for more examples and technical details see full documentation there.
