Template:Namespace detect showall/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
meta>Psneog
No edit summary
m (24 revisions imported)
 
(6 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{documentation subpage}}
{{Documentation subpage}}
{{high-use| 30,000+ }}
<!--Categories where indicated at the bottom of this page, please; interwikis at Wikidata (see [[Wikipedia:Wikidata]])-->
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->


This is the {{tl|namespace detect showall}} meta-template.
This is the {{tl|Namespace detect showall}} meta-template.


It helps other templates detect what type of page they are on. It is an extended version of {{tl|namespace detect}}.
It helps other templates detect what type of page they are on. It is an extended version of {{tl|Namespace detect}}.


This template detects and groups all the different [[Wikipedia:Namespace#Enumeration|namespaces]] used on Wikipedia into several types:
This template 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:", "File talk:" and so on.
: '''talk''' = Any talk space, such as page names that start with "Talk:", "User talk:", "File talk:" and so on.
:'''user, wikipedia, file, mediawiki, template, help, category''', '''portal''' and '''book''' = The other namespaces except the talk pages.
: '''user, wikipedia, file, mediawiki, template, help, category''', '''portal''' and '''book''' = The other namespaces except the talk pages.
:'''other''' = Any namespaces that were 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 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'' : ''In many cases, one of the simpler namespace-detection templates is likely to suffice (and will be less prone to errors made in its use). For links to these alternatives, see the navigation template at the end of this documentation ({{tl|Namespace and pagename-detecting templates}}).''
 
=== Usage ===


== Usage ==
<!-- This template takes one or more numbered parameters that takes the data that should be returned. It also takes one or more parameters named after the different page types as listed above. The named parameters specifies which data should be returned on what type of page. Like this: -->
<!-- This template takes one or more numbered parameters that takes the data that should be returned. It also takes one or more parameters named after the different page types as listed above. The named parameters specifies which data should be returned on what type of page. Like this: -->
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:
Line 113: Line 111:
}}
}}


=== Showall ===
== Showall ==
 
This template also understands a special value called '''showall'''. Like this:
This template also understands a special value called '''showall'''. Like this:


Line 150: Line 147:
The purpose of the '''showall''' parameter is to automatically demonstrate all variations of a message when it is shown on other pages than the pages it normally is used on.
The purpose of the '''showall''' parameter is to automatically demonstrate all variations of a message when it is shown on other pages than the pages it normally is used on.


=== Demospace and page ===
== 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'''.  


Line 242: Line 238:
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 then the template will detect page types as usual.


=== Parameters ===
== Parameters ==
 
List of all parameters:
List of all parameters:


Line 263: Line 258:
Note: Empty values to the "main" ... "book" parameters do have special meaning.
Note: Empty values to the "main" ... "book" parameters do have special meaning.


=== Technical details ===
== Technical details ==
 
Namespace "Image" was renamed to "File" on 11 December 2008. This template has been updated to understand both names, thus it still works fine. For backwards compatibility it still understands "image" both as a parameter name, such as "image = 1", and as a value "demospace = image". But using "image" is now deprecated.
Namespace "Image" was renamed to "File" on 11 December 2008. This template has been updated to understand both names, thus it still works fine. For backwards compatibility it still understands "image" both as a parameter name, such as "image = 1", and as a value "demospace = image". But using "image" is now deprecated.


Line 273: Line 267:
[[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]] 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.


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 such as about "copying to other projects" and "CSS based namespace detection", see {{tl|main talk other}} and its talk page.


=== See also ===


{{namespace detect see also}}
{{Namespace and pagename-detecting templates}}


<includeonly>
<includeonly>{{Sandbox other|
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
| <!--Categories below this line, please; interwikis at Wikidata-->
[[Category:Namespace manipulation templates]]
[[Category:Namespace manipulation templates]]
 
}}</includeonly>
[[as:Template:Namespace detect showall]]
[[sl:Predloga:Namespace detect showall]]
</includeonly>

Latest revision as of 04:48, 3 September 2020

This is the {{Namespace detect showall}} meta-template.

It helps other templates detect what type of page they are on. It is an extended version of {{Namespace detect}}.

This template 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:", "File talk:" and so on.
user, wikipedia, file, mediawiki, template, help, category, portal and book = The other namespaces except the talk pages.
other = Any namespaces that were not specified as a parameter to the template. See explanation below.
Note
In many cases, one of the simpler namespace-detection templates is likely to suffice (and will be less prone to errors made in its use). For links to these alternatives, see the navigation template at the end of this documentation ({{Namespace and pagename-detecting templates}}).

Usage

This template takes one or more parameters named after the different page types as listed above. Like this:

{{namespace detect showall
| 1 = Article text.
| 2 = Talk page text.
| 3 = Other pages text.
| main  = 1
| talk  = 2
| other = 3
}}

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.

Since we feed the data to the numbered parameters we can reuse the same data on several types of pages. Like this:

{{namespace detect showall
| 1 = Article text.
| 2 = File (image) and category text.
| 3 = Other pages text.
| main     = 1
| file     = 2
| category = 2
| other    = 3
}}

By using an empty parameter you can make it so the template doesn't render anything for some specific page type, instead of returning what was fed to the other parameter. (Notice that the main parameter doesn't get any data in the example below.) Like this:

{{namespace detect showall
| 1 = File (image) page text.
| 2 = Other pages text.
| main  = 
| file  = 1
| other = 2
}}

The code above will render nothing when on mainspace (article) pages.

The same goes for the other type, if it is omitted or fed no data then the template will not return any data for the page types that were not explicitly specified. Like this:

{{namespace detect showall
| 1 = File page text.
| 2 = Talk page text.
| file  = 1
| talk  = 2
| other = 
}}

Showall

This template also understands a special value called showall. Like this:

{{namespace detect showall
| 1 = Article text.
| 2 = Talk page text.
| main  = 1
| talk  = 2
| other = showall
}}

If the template is on a main (article) page, it will as usual return this:

Article text.

If the template is on any other page than an article or a talk page it will show all the data that was fed to the numbered parameters, like this:

Article text.Talk page text.

The purpose of the showall parameter is to automatically demonstrate all variations of a message when it is shown on other pages than the pages it normally is used on.

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 showall
| 1 = Article text.
| 2 = Talk page text.
| main  = 1
| talk  = 2
| other = 
| demospace = main
}}

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

Article text.

The demospace parameter also understands the showall value. Like this:

{{namespace detect showall
| 1 = Article text.
| 2 = Talk page text.
| main  = 1
| talk  = 2
| other = 
| demospace = showall
}}

Then no matter on what kind of page the code above is used it will show all the data that was fed to the numbered parameters, like this:

Article text.Talk page text.

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:

{{namespace detect showall
| 1 = Article text.
| 2 = Talk page text.
| main  = 1
| talk  = 2
| other = 
| page  = User talk:Example
}}

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

Talk 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 showall}} template. Then do like this:

{{namespace detect showall
| 1 = Article text.
| 2 = Talk page text.
| main  = 1
| talk  = 2
| other = 
| demospace = {{{demospace|}}}
| page  = {{{page|}}}
}}

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

Parameters

List of all parameters:

{{namespace detect showall
| 1 = Text one.
...
| 6 = Text six.
| main  = 1 / 2 / 3 / 4 / 5 / 6 / showall
...
| other = 1 / 2 / 3 / 4 / 5 / 6 / showall
| demospace = {{{demospace|}}} / showall /
              main / talk / user / wikipedia / file / mediawiki / 
              template / help / category / portal / book / other
| page  = {{{page|}}} / User:Example
}}

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

Technical details

Namespace "Image" was renamed to "File" on 11 December 2008. This template has been updated to understand both names, thus it still works fine. For backwards compatibility it still understands "image" both as a parameter name, such as "image = 1", and as a value "demospace = image". But using "image" is now deprecated.

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.

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

Templates do have a problem to handle 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 such as about "copying to other projects" and "CSS based namespace detection", see {{main talk other}} and its talk page.