Template:Talkspace detect/doc

This is the {{talkspace detect}} meta-template.

It helps other templates detect what type of page they are on. It detects and groups all the different talkspaces used on Wikipedia into several types:

main = Defines the output if the template is located on main/article talkspace; aka Talk:.

user, wikipedia, file, mediawiki, template, help, category, portal, draft and module = Defines the output if the template is located on the specified talkspaces; aka User talk:, Wikipedia talk:, File talk:, etc.

default = Defines the output if the template is located on any talkspaces that were not defined as a parameter to this meta-template.

other = Defines the output if the template is located on any subject space (not the associated talkspace).

Usage

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

<syntaxhighlight lang="wikitext"> Text for all subject spaces </syntaxhighlight>

By using an empty parameter you can make it so this template doesn't render anything for some specific page type. Like this:

<syntaxhighlight lang="wikitext">

</syntaxhighlight>

The "page" parameter

For testing and demonstration purposes this template can take a parameter named page. Like this:

<syntaxhighlight lang="wikitext"> User talk text. </syntaxhighlight>

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

User talk text.

The page parameter makes this template behave exactly as if on that page. The pagename doesn't have to be an existing page.

If the page parameter is empty or undefined, the name of the current page determines the result.

You can make it so your template also understands the page parameter. That means you can demonstrate the different appearances of your template in the documentation for your template. Then do like this:

<syntaxhighlight lang="wikitext">

</syntaxhighlight>