Template:Namespace detect showall

From Wikibooks, open books for an open world
Jump to: navigation, search
Template documentation[edit] [history] [purge]

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 Wikibooks into several types:

main = Main/book space, as in normal Wikibooks pages.
talk = Any talk space, such as page names that start with "Talk:", "User talk:", "File talk:" and so on.
user, wikibooks, subject, file, mediawiki, template, help, category, wikijunior, and cookbook = 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 most 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 misspelling the parameter names.

Usage

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

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

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

Book text.

If the template is on any other page than a book 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 = Book 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 (book) 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 = Book text.
| 2 = Talk page text.
| main  = 1
| talk  = 2
| other = showall
}}

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

Book text.

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

Book 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 = Book 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:

Book text.

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

{{namespace detect showall
| 1 = Book 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:

Book 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 = Book 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 = Book 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 / wikibooks/ file / mediawiki / subject
              template / help / category / wikijunior / cookbook / other
| page  = {{{page|}}} / User:Example
}}

Note: Empty values to the "main" ... "cookbook" 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.

If you intend to feed tables as content to the numbered parameters of this template, then 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:Templates|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.

See also

Easy to use namespace-detection templates:

More complex namespace-detection templates:

  • {{namespace detect}} – The very versatile one.
  • {{namespace detect showall}} – The extremely versatile one; has input reuse.
  • {{talkspace detect}} - For detecting talk pages on various namespaces.
  • {{main talk other}} – Separates some namespaces.

Pagename-handling and detection templates: