Template:User other/doc

From "PTTLink Wiki"
Jump to navigation Jump to search

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

This template helps other templates detect whether they are on a "User:" page or some "other" type of page.

Usage

This template usually takes two parameters, like this:

{{user other|User-page text|Other-pages text}}

If the template is on a "User:" page, it will return this:

User-page text

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

Other-pages text

Using this meta-template can make a template that adds a category when it is invoked on User pages, but not when it is invoked on non-User pages. Like this:

{{user other|[[Category:Some user category]]}}

This meta-template can warn that a template should not be used on non-User pages:

{{user other||This template should only be used on user pages.}}

In the first case above, the "other" parameter was not used. In the second example, the "user" parameter was left empty.

Demospace

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

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

Like this:

{{user other
| User-page text
| Other-pages text
| demospace=user
}}

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

User-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:

{{user other
| User-page text
| Other-pages text
| demospace={{{demospace|}}}
}}

Technical details

This template detects "User talk:" pages as type other.

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