Template:Namespace detect/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
meta>Davidgothberg
Starting out this documentation. More will be added soon.
 
meta>Davidgothberg
Added a bunch of usage examples. Intermediate save.
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.
:'''other''' = Any other namespaces that was not specified as a parameter to the template. See explanation below.
:'''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|see also]] section below.) Since this template is more prone to human errors such as spelling mistakes of the parameter names.  


=== Usage ===
=== Usage ===
This template takes one or more parameters named after the different namespaces as listed above. Like this:
<pre>
{{namespace detect
| main  = Article text
| talk  = Talk page text
| other = Other pages text
}}
</pre>
If the template is on a main (article) page, it will return this:
:{{namespace detect| demospace=main
| main  = Article text
| talk  = Talk page text
| other = Other pages text
}}
If the template is on any other page than an article or a talk page it will return this:
:{{namespace detect
| main  = Article text
| talk  = Talk page text
| other = Other pages text
}}
The example above made the template return something for all namespaces. But if we don't use the '''other''' parameter then it will not return anything for the other namespaces. Like this:
<pre>
{{namespace detect
| image    = Image page text
| category = Category page text
}}
</pre>
On any pages other than image and category pages the code above will render nothing.
:{{namespace detect
| image    = Image page text
| category = Category page text
}}
By using an empty parameter you can make it so the template doesn't render anything for some specific namespaces. Like this:
<pre>
{{namespace detect
| main =
| other = Other pages text
}}
</pre>
The code above will render nothing when on article pages, but will return this when on other pages:
:{{namespace detect
| main =
| other = Other pages text
}}


=== See also ===
=== See also ===


* {{tl|main other}} – Simple one for article templates.
Easy to use namespace-detection templates:
* {{tl|talk other}} – Simple one for talk page templates.
 
* {{tl|image other}} – Simple one for image templates.
* {{tl|main other}} – For article templates.
* {{tl|category other}} – Simple one for category templates.
* {{tl|talk other}} – For talk page templates.
* {{tl|image other}} – For image templates.
* {{tl|category other}} – For category templates.


* {{tl|main talk other}} – Separates some namespaces.
* {{tl|main talk other}} – Separates some namespaces.
* {{tl|main talk category other}} – Separates some more namespaces.
* {{tl|main talk category other}} – Separates some more namespaces.
Technical stuff:


* [[Wikipedia:Namespace]] – Lists all the namespaces.
* [[Wikipedia:Namespace]] – Lists all the namespaces.

Revision as of 03:38, 15 May 2008

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 namespaces 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 namespaces. But if we don't use the other parameter then it will not return anything for the other namespaces. 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 namespaces. Like this:

{{namespace detect
| main = 
| other = Other pages text
}}

The code above will render nothing when on article pages, but will return this when on other pages:

Other pages text


See also

Easy to use namespace-detection templates:

Technical stuff: