Template:Namespace detect/doc

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


 * main = Main/article space, as in normal Belfast Wiki articles.
 * talk = Any talk space, such as page names that start with "Talk:", "User talk:", "File talk:" and so on.
 * user, belfast wiki, 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.

For backwards compatibility this template also understands the old name image for file. But using image is now deprecated.

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:

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



If the template is on any other page than an article or a talk page it will return 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 then it will not return anything for the other page types. Like this:

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:

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



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:

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



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:

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



It can be convenient to let your template understand the demospace and/or page parameter and send it on to the namespace detect template. Then do like this:

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:

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".

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  or inside a piped link. 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.