Template:Main other/doc

This is the {{main other}} meta-template.

This template helps other templates detect if they are on a main space (book) page or some "other" type of page.

Basic usage

edit

This template usually takes two parameters, like this:

{{main other | Book page text | Other pages text }}

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

Book page text

If the template is on any other page, it will return this:

Other pages text

A typical usage case could be to make it so that a template only adds a category when on an article. Thus not adding other pages that just show the template. Like this:

{{main other | [[Category:Some book maintenance category]] }}

Or to warn that a template should not be used on other pages:

{{main other | | This template should only be used in books. }}

Note that in the first case above the "other" parameter was not used, and in the second example the "main" parameter was left empty.

Demospace

edit

For testing and demonstration purposes this template can take a parameter named demospace.

  • If it has the value main it returns the book page text.
  • It if has the value other or any other value such as the name of some other namespace it returns the other pages text.
  • If the parameter is empty or undefined, the actual page type determines the result.

Like this:

{{main other 
| Book page text 
| Other pages text 
| demospace = main
}}

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

Book page text

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

{{main other 
| Book page text 
| Other pages text 
| demospace = {{{demospace|}}}
}}

Technical details

edit

This template detects article "Talk:" pages as type other.

This template works like {{main talk other}}; for more examples and technical details see full documentation there.

See also

edit

Easy to use namespace-detection templates:

More complex namespace-detection templates:

Pagename-handling and detection templates: