Template:Namespace detect/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
meta>Sasajid
No edit summary
Ookami (talk | contribs)
m 77 revisions imported
 
(34 intermediate revisions by 32 users not shown)
Line 1: Line 1:
{{documentation subpage}}
{{Documentation subpage}}
{{high-risk| 1,000,000+ }}
{{High-risk| approximately 140000 }}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{Lua|Module:Namespace detect}}
<!--Categories where indicated at the bottom of this page, please; interwikis at Wikidata (see [[Wikipedia:Wikidata]])-->


This is the {{tl|namespace detect}} meta-template.
This is the {{tl|Namespace detect}} meta-template. It helps other templates detect what type of page they are on.
 
It helps other templates detect what type of page they are on.


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 (i.e. article) space, where normal Wikipedia articles are kept.
:'''talk''' = Any talk space, such as page names that start with "Talk:", "User talk:", "File talk:" and so on.
; talk : Any talk space, including page names that start with "Talk:", "User talk:", "File talk:", etc.
:'''user, wikipedia, file, mediawiki, template, help, category''', '''portal''' and '''book''' = The other namespaces except the talk pages.
'''{{hlist|user|wikipedia|file|mediawiki|template|help|category|portal|book}}'''
:'''other''' = Any namespaces that were not specified as a parameter to the template. See explanation below.
: The remaining namespaces.
; other : Any namespaces that were not specified as a parameter to the template (see explanation below).


For backwards compatibility this template also understands the old name '''image''' for '''file'''. But using '''image''' is now deprecated.
For backwards compatibility, this template handles '''image''' as if '''file'''. '''image''' (<nowiki>[[Image:...]]</nowiki>) is now deprecated.


'''Note!''' For most 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 misspelling the parameter names.  
'''Note:''' For most cases it may be better to use the simpler namespace detection templates (see the [[#See also|see also]] section below). This template is more prone to human errors such as misspelling parameter names.


=== Usage ===
== Usage ==


This template takes one or more parameters named after the different page types as listed above. Like this:
This template takes one or more parameters named after the different page types as listed above. Like this:
<pre>
<pre>
{{namespace detect
{{Namespace detect
| main  = Article text
| main  = Article text
| talk  = Talk page text
| talk  = Talk page text
| other = Other pages text
| other = Other pages text
}}
}}
</pre>
</pre>


If the template is on a main (article) page, it will return this:
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
  }}


:{{namespace detect| demospace=main
If the template is on any other page than an article or a talk page, it will return this:
| main  = Article text
: {{Namespace detect
| talk  = Talk page text
  | main  = Article text
| other = Other pages 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 page types. But if we don't use the '''other''' parameter or leave it empty then it will not return anything for the other page types. Like this:


The example above made the template return something for all page types. But if we don't use the '''other''' parameter or leave it empty, it will not return anything for the other page types. Like this:
<pre>
<pre>
{{namespace detect
{{Namespace detect
| file    = File page text
| file    = File page text
| category = Category page text
| category = Category page text
| other    =
| other    =
}}
}}
</pre>
</pre>
Line 58: Line 54:
On any pages other than file and category pages the code above will render nothing.
On any pages other than file and category pages the code above will render nothing.
<!-- Do not remove this one. It is supposed to render nothing, but we have it here for testing purposes. -->
<!-- Do not remove this one. It is supposed to render nothing, but we have it here for testing purposes. -->
:{{namespace detect
: {{Namespace detect
| file    = File page text
  | file    = File page text
| category = Category page text
  | category = Category page text
| other    =
  | other    =
}}
  }}
 
By using an empty parameter you can make it so the template doesn't render anything for some specific page type. Like this:


By using an empty parameter, you can make it so the template doesn't render anything for some specific page type. Like this:
<pre>
<pre>
{{namespace detect
{{Namespace detect
| main  =  
| main  =  
| other = Other pages text
| other = Other pages text
}}
}}
</pre>
</pre>


The code above will render nothing when on mainspace (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
  | main  =
  | other = Other pages text
  }}


:{{namespace detect
== Demospace and page ==
| main  =  
| other = Other pages text
}}


=== Demospace and page ===
For testing and demonstration purposes, this template can take two parameters named '''demospace''' and '''page'''.
 
For testing and demonstration purposes this template can take two parameters named '''demospace''' and '''page'''.  
 
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:


'''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>
<pre>
{{namespace detect  
{{Namespace detect
| main  = Article text
| main  = Article text
| other = Other pages text
| other = Other pages text
| demospace = main
| demospace = main
}}
}}
</pre>
</pre>


No matter on what kind of page the code above is used it will return this:
No matter on what kind of page the code above is used, it will return this:
 
: {{Namespace detect
:{{namespace detect  
  | main  = Article text
| main  = Article text
  | other = Other pages text
| other = Other pages text
  | demospace = main
| demospace = main
  }}
}}
 
The '''page''' parameter instead takes a normal pagename. It makes this template behave exactly as if on that page. The pagename doesn't have to be an existing page. Like this:


The '''page''' parameter instead takes a normal pagename, making this template behave exactly as if on that page. The pagename doesn't have to be an existing page. Like this:
<pre>
<pre>
{{namespace detect  
{{Namespace detect
| user  = User page text
| user  = User page text
| other = Other pages text
| other = Other pages text
| page = User:Example
| page = User:Example
}}
}}
</pre>
</pre>


No matter on what kind of page the code above is used it will return this:
No matter on what kind of page the code above is used, it will return this:
 
: {{Namespace detect
:{{namespace detect  
  | user  = User page text
| user  = User page text
  | other = Other pages text
| other = Other pages text
  | page = User:Example
| page = User:Example
  }}
}}
 
It can be convenient to let your template understand the demospace and/or page parameter and send it on to the {{tl|namespace detect}} template. Then do like this:


It can be convenient to let your template understand the '''demospace''' and/or '''page''' parameter and send it on to the {{tl|Namespace detect}} template. Like this:
<pre>
<pre>
{{namespace detect  
{{Namespace detect
| main  = Article text
| main  = Article text
| other = Other pages text
| other = Other pages text
| demospace = {{{demospace|}}}
| demospace = {{{demospace|}}}
| page  = {{{page|}}}
| page  = {{{page|}}}
}}
}}
</pre>
</pre>


If both the '''demospace''' and '''page''' parameters are empty or undefined then the template will detect page types as usual.
If both the '''demospace''' and '''page''' parameters are empty or undefined, the template will detect page types as usual.


=== Parameters ===
== Parameters ==


List of all parameters:
List of all parameters:
<pre>
<pre>
{{namespace detect
{{Namespace detect
| main  =  
| main  =  
...
...
| other =
| other =
| demospace = {{{demospace|}}} / main / talk / user /  
| demospace = {{{demospace|}}} / main / talk / user /
               wikipedia / file / mediawiki / template /  
               wikipedia / file / mediawiki / template /
               help / category / portal / book / other
               help / category / portal / book / other
| page  = {{{page|}}} / User:Example
| page  = {{{page|}}} / User:Example
Line 151: Line 139:
Note: Empty values to the "main" ... "book" parameters have special meaning.
Note: Empty values to the "main" ... "book" parameters have special meaning.


=== Technical details ===
== Technical details ==


Namespace "Image" was renamed to "File" on 11 December 2008. This template was updated to understand both names well before that, thus it still works fine. For backwards compatibility it still understands "image" both as a parameter name, such as "image = File page text", and as a value "demospace = image".
Namespace "Image" was renamed to "File" on 11 December 2008. This template was updated to understand both names well before that, thus it still works fine. For backwards compatibility it still understands "image" both as a parameter name, such as "image&nbsp;= File page text", and as a value "demospace&nbsp;= image".


Namespace "Book" was added to the English Wikipedia on 28 December 2009. This template has been updated so it detects the "Book:" namespace as type '''book''', and it already automatically detected "Book talk:" as type '''talk'''.
Namespace "Book" was added to the English Wikipedia on 28 December 2009. This template has been updated so it detects the "Book:" namespace as type '''book'''. It already automatically detected "Book talk:" as type '''talk'''.


If you intend to feed tables as content to the numbered parameters of this template, then you need to know this:
If you intend to feed tables as content to the numbered parameters of this template, you need to know this:


[[Help:Template|Templates]] do have a problem to handle parameter data that contains pipes "<code>|</code>", unless the pipe is inside another template <code><nowiki>{{name|param1}}</nowiki></code> or inside a piped link <code><nowiki>[[Help:Template|help]]</nowiki></code>. Thus templates can not handle [[Help:Table|wikitables]] as input unless you escape them by using the {{tn|!}} template. This makes it hard to use wikitables as parameters to templates. Instead the usual solution is to use "[[Help:HTML in wikitext|HTML wikimarkup]]" for the table code, which is more robust.
[[Help:Template|Templates]] have a problem handling parameter data that contains pipes "<code>|</code>" unless the pipe is inside another template <code><nowiki>{{name|param1}}</nowiki></code> or inside a piped link <code><nowiki>[[Help:Template|help]]</nowiki></code>. Thus templates can not handle [[Help:Table|wikitables]] as input unless you escape them by using the {{tn|!}} template. This makes it hard to use wikitables as parameters to templates. Instead, the usual solution is to use "[[Help:HTML in wikitext|HTML wikimarkup]]" for the table code, which is more robust.


For more technical details such as about "copying to other projects" and "CSS based namespace detection" see {{tl|main talk other}} and its talk page.
For more technical details, e.g. about copying this template to other projects and CSS-based namespace detection, see {{tl|Main talk other}} and its talk page.


=== See also ===
== See also ==
{{Namespace and pagename-detecting templates}}


{{namespace detect see also}}
<includeonly>{{Sandbox other|
 
| <!--Categories below this line, please; interwikis at Wikidata-->
<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Namespace manipulation templates]]
[[Category:Namespace manipulation templates]]
 
}}</includeonly>
[[ar:قالب:Namespace detect]]
[[be-x-old:Шаблён:Вызначэньне прасторы назваў]]
[[ca:Plantilla:Detecta espai de noms]]
[[cy:Nodyn:Namespace detect]]
[[hsb:Předłoha:Namespace detect]]
[[ja:Template:Namespace detect]]
[[mn:Загвар:Namespace detect]]
[[pt:Predefinição:Namespace detect]]
[[sr:Шаблон:Namespace detect]]
[[uk:Шаблон:Namespace detect]]
[[ur:سانچہ:Namespace detect]]
[[zh:Template:Namespace detect]]
</includeonly>

Latest revision as of 22:48, 3 September 2020

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 (i.e. article) space, where normal Wikipedia articles are kept.
talk
Any talk space, including page names that start with "Talk:", "User talk:", "File talk:", etc.

  • user
  • wikipedia
  • file
  • mediawiki
  • template
  • help
  • category
  • portal
  • book
The remaining namespaces.
other
Any namespaces that were not specified as a parameter to the template (see explanation below).

For backwards compatibility, this template handles image as if file. image ([[Image:...]]) is now deprecated.

Note: For most cases it may be better to use the simpler namespace detection templates (see the see also section below). This template is more prone to human errors such as misspelling 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 or leave it empty, it will not return anything for the other page types. Like this:

{{Namespace detect
 | file     = File page text
 | category = Category page text
 | other    =
}}

On any pages other than file 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 type. 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 and page

For testing and demonstration purposes, this template can take two parameters named demospace and page.

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
 | main  = Article text
 | other = Other pages text
 | demospace = main
}}

No matter on what kind of page the code above is used, it will return this:

Article text

The page parameter instead takes a normal pagename, making this template behave exactly as if on that page. The pagename doesn't have to be an existing page. Like this:

{{Namespace detect
 | user  = User page text
 | other = Other pages text
 | page  = User:Example
}}

No matter on what kind of page the code above is used, it will return this:

User page text

It can be convenient to let your template understand the demospace and/or page parameter and send it on to the {{Namespace detect}} template. Like this:

{{Namespace detect
 | main  = Article text
 | other = Other pages text
 | demospace = {{{demospace|}}}
 | page  = {{{page|}}}
}}

If both the demospace and page parameters are empty or undefined, the template will detect page types as usual.

Parameters

List of all parameters:

{{Namespace detect
| main  = 
...
| other =
| demospace = {{{demospace|}}} / main / talk / user /
              wikipedia / file / mediawiki / template /
              help / category / portal / book / other
| page  = {{{page|}}} / User:Example
}}

Note: Empty values to the "main" ... "book" parameters have special meaning.

Technical details

Namespace "Image" was renamed to "File" on 11 December 2008. This template was updated to understand both names well before that, thus it still works fine. For backwards compatibility it still understands "image" both as a parameter name, such as "image = File page text", and as a value "demospace = image".

Namespace "Book" was added to the English Wikipedia on 28 December 2009. This template has been updated so it detects the "Book:" namespace as type book. It already automatically detected "Book talk:" as type talk.

If you intend to feed tables as content to the numbered parameters of this template, you need to know this:

Templates have a problem handling parameter data that contains pipes "|" unless the pipe is inside another template {{name|param1}} or inside a piped link [[Help:Template|help]]. Thus templates can not handle wikitables as input unless you escape them by using the {{!}} template. This makes it hard to use wikitables as parameters to templates. Instead, the usual solution is to use "HTML wikimarkup" for the table code, which is more robust.

For more technical details, e.g. about copying this template to other projects and CSS-based namespace detection, see {{Main talk other}} and its talk page.

See also