Jump to content

Template:User other/doc: Difference between revisions

From Wikipedia, the free encyclopedia
Content deleted Content added
m -
m syntaxhighlight lang="wikitext"
 
(6 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
{{Template shortcut|ns2}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{High-use|150,000+}}

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


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

=== Usage ===


===Usage===
This template usually takes two parameters, like this:
This template usually takes two parameters, like this:


<syntaxhighlight lang="wikitext">
<pre>
{{user other | User page text | Other pages text }}
{{user other|User-page text|Other-pages text}}
</syntaxhighlight>
</pre>


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


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


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


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


A typical usage case could be to make it so that a template only adds a category when on user pages. Thus not adding other pages that just show the template. Like this:
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:


<syntaxhighlight lang="wikitext">
<pre>
{{user other | [[Category:Some user category]] }}
{{user other|[[Category:Some user category]]}}
</syntaxhighlight>
</pre>


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


<syntaxhighlight lang="wikitext">
<pre>
{{user other | | This template should only be used on user pages. }}
{{user other||This template should only be used on user pages.}}
</syntaxhighlight>
</pre>


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


=== Demospace ===
===Demospace===


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


* If it has the value '''user''' it returns the user page text.
* If demospace has the value '''user''', it returns the user-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.
* 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 the parameter is empty or undefined, the actual page type determines the result.
* If demospace is empty or undefined, the actual page type determines the result.


Like this:
Like this:


<syntaxhighlight lang="wikitext">
<pre>
{{user other
{{user other
| User page text
| User-page text
| Other pages text
| Other-pages text
| demospace = user
| demospace=user
}}
}}
</syntaxhighlight>
</pre>


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


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


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


<syntaxhighlight lang="wikitext">
<pre>
{{user other
{{user other
| User page text
| User-page text
| Other pages text
| Other-pages text
| demospace = {{{demospace|}}}
| demospace={{{demospace|}}}
}}
}}
</syntaxhighlight>
</pre>

=== Technical details ===


===Technical details===
This template detects "User talk:" pages as type '''other'''.
This template detects "User talk:" pages as type '''other'''.


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


{{Namespace and pagename-detecting templates}}
=== See also ===


<includeonly>{{Sandbox other||
{{namespace detect see also}}
[[Category:User namespace templates]]

<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Exclude in print]]
[[Category:Namespace manipulation templates]]
[[Category:Namespace manipulation templates]]
}}</includeonly>
[[Category:User namespace templates]]

</includeonly>

Latest revision as of 15:55, 21 May 2023

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

[edit]

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

[edit]

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

[edit]

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.