Template:Namespace detect/doc: Difference between revisions
meta>Davidgothberg Added a bunch of usage examples. Intermediate save. |
meta>Davidgothberg More documentation, about the "demospace" parameter. |
||
Line 8: | Line 8: | ||
It detects and groups all the different [[Wikipedia:Namespace#Enumeration|namespaces]] used on Wikipedia into several types: | It detects and groups all the different [[Wikipedia:Namespace#Enumeration|namespaces]] used on Wikipedia into several types: | ||
:'''main''' = Main / article space, as in normal Wikipedia articles. | :'''main''' = Main/article space, as in normal Wikipedia articles. | ||
:'''talk''' = Any talk space, such as page names that start with "Talk:", "User talk:", "Image talk:" and so on. | :'''talk''' = Any talk space, such as page names that start with "Talk:", "User talk:", "Image talk:" and so on. | ||
:'''user, wikipedia, image, mediawiki, template, help, category''' and '''portal''' = The other namespaces except the talk pages. | :'''user, wikipedia, image, mediawiki, template, help, category''' and '''portal''' = The other namespaces except the talk pages. | ||
Line 17: | Line 17: | ||
=== Usage === | === Usage === | ||
This template takes one or more parameters named after the different | This template takes one or more parameters named after the different page types as listed above. Like this: | ||
<pre> | <pre> | ||
Line 43: | Line 43: | ||
}} | }} | ||
The example above made the template return something for all | The example above made the template return something for all page types. But if we don't use the '''other''' parameter then it will not return anything for the other page types. Like this: | ||
<pre> | <pre> | ||
Line 58: | Line 58: | ||
}} | }} | ||
By using an empty parameter you can make it so the template doesn't render anything for some specific | By using an empty parameter you can make it so the template doesn't render anything for some specific page types. Like this: | ||
<pre> | <pre> | ||
Line 67: | Line 67: | ||
</pre> | </pre> | ||
The code above will render nothing when on article pages, but will return this when on other pages: | The code above will render nothing when on mainspace (article) pages, but will return this when on other pages: | ||
:{{namespace detect | :{{namespace detect | ||
Line 74: | Line 74: | ||
}} | }} | ||
==== Demospace ==== | |||
For testing and demonstration purposes this template can take a parameter named '''demospace'''. Demospace understands any of the page type names used by this template, including the '''other''' type. It tells the template to behave like it is on some specific type of page. Like this: | |||
<pre> | |||
{{namespace detect | demospace = main | |||
| main = Article text | |||
| other = Other pages text | |||
}} | |||
</pre> | |||
No matter on what kind of page the code above is used it will return this: | |||
:{{namespace detect | demospace = main | |||
| main = Article text | |||
| other = Other pages text | |||
}} | |||
You might want to test and demonstrate the different appearances of your template in its documentation. Then it is convenient to make it so your template can take the demospace parameter and send it on to the {{tl|namespace detect}} template. Then do like this: | |||
<pre> | |||
{{namespace detect | |||
| demospace = {{{demospace|}}} | |||
| main = Article text | |||
| other = Other pages text | |||
}} | |||
</pre> | |||
If the '''demospace''' parameter is empty or undefined then the template will detect page types as usual. | |||
=== See also === | === See also === |
Revision as of 04:10, 15 May 2008
This is a documentation subpage for Template:Namespace detect. It may contain usage information, categories and other content that is not part of the original template page. |
This is the {{namespace detect}} meta-template.
It helps other templates detect what type of page they are on.
It detects and groups all the different namespaces used on Wikipedia into several types:
- main = Main/article space, as in normal Wikipedia articles.
- talk = Any talk space, such as page names that start with "Talk:", "User talk:", "Image talk:" and so on.
- user, wikipedia, image, mediawiki, template, help, category and portal = The other namespaces except the talk pages.
- other = Any namespaces that were not specified as a parameter to the template. See explanation below.
Note! For must usage cases it might be better to use the simpler namespace detection templates. (See the see also section below.) Since this template is more prone to human errors such as spelling mistakes of the parameter names.
Usage
This template takes one or more parameters named after the different page types as listed above. Like this:
{{namespace detect | main = Article text | talk = Talk page text | other = Other pages text }}
If the template is on a main (article) page, it will return this:
- Article text
If the template is on any other page than an article or a talk page it will return this:
- Other pages text
The example above made the template return something for all page types. But if we don't use the other parameter then it will not return anything for the other page types. Like this:
{{namespace detect | image = Image page text | category = Category page text }}
On any pages other than image and category pages the code above will render nothing.
By using an empty parameter you can make it so the template doesn't render anything for some specific page types. Like this:
{{namespace detect | main = | other = Other pages text }}
The code above will render nothing when on mainspace (article) pages, but will return this when on other pages:
- Other pages text
Demospace
For testing and demonstration purposes this template can take a parameter named demospace. Demospace understands any of the page type names used by this template, including the other type. It tells the template to behave like it is on some specific type of page. Like this:
{{namespace detect | demospace = main | main = Article text | other = Other pages text }}
No matter on what kind of page the code above is used it will return this:
- Article text
You might want to test and demonstrate the different appearances of your template in its documentation. Then it is convenient to make it so your template can take the demospace parameter and send it on to the {{namespace detect}} template. Then do like this:
{{namespace detect | demospace = {{{demospace|}}} | main = Article text | other = Other pages text }}
If the demospace parameter is empty or undefined then the template will detect page types as usual.
See also
Easy to use namespace-detection templates:
- {{main other}} – For article templates.
- {{talk other}} – For talk page templates.
- {{image other}} – For image templates.
- {{category other}} – For category templates.
- {{main talk other}} – Separates some namespaces.
- {{main talk category other}} – Separates some more namespaces.
Technical stuff:
- Wikipedia:Namespace – Lists all the namespaces.
- Help:Magic words – About
{{NAMESPACE}}
etc. - meta:Help:ParserFunctions – About
{{#ifeq:|||}}
etc.