Difference between revisions of "Template:Main other/doc"

From blackwiki
Jump to navigation Jump to search
imported>Vegaswikian
(Categorization in templates is not advised)
imported>Sardanaphalus
(redirect3, sandbox non-categorization, some formatting)
Line 1: Line 1:
{{documentation subpage}}
+
{{Documentation subpage}}
{{high-risk| 2,000,000+ }}
+
{{High-risk| 2,000,000+ }}
{{template shortcut|ns0}}
+
{{Template shortcut |ns0}}
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
 +
{{redirect3|noquotes|[[Template:When in article]]}}
  
 
This is the {{tl|main other}} meta-template.
 
This is the {{tl|main other}} meta-template.
Line 8: Line 9:
 
This template helps other templates detect if they are on a main space (article) page or some "other" type of page.
 
This template helps other templates detect if they are on a main space (article) page or some "other" type of page.
  
=== Basic usage ===
+
===Basic usage===
 
 
 
This template usually takes two parameters, like this:
 
This template usually takes two parameters, like this:
 
+
: {{tc|main other&#32;|''result if in mainspace''&#32;|''result if elsewhere''}}</pre>
<pre>
 
{{main other | Article text | Other pages text }}
 
</pre>
 
  
 
If the template is on a main space (article) page, it will return this:
 
If the template is on a main space (article) page, it will return this:
 
+
: {{main other |demospace=main |''result if in mainspace'' |''result if elsewhere''}}
:{{main other | demospace=main | Article text | Other pages text }}
 
  
 
If the template is on any other page, it will return this:
 
If the template is on any other page, it will return this:
 
+
: {{main other |''result if in mainspace'' |''result if elsewhere''}}
:{{main other | Article text | 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:
 
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:
 
+
: {{tcpl|main other&#32;|<nowiki>[[Category:Some article maintenance category]]</nowiki>}}
<pre>
 
{{main other | [[Category:Some article maintenance category]] }}
 
</pre>
 
 
Note that guidelines do not support categorization in templates.
 
Note that guidelines do not support categorization in templates.
  
 
Or to warn that a template should not be used on other pages:
 
Or to warn that a template should not be used on other pages:
 
+
: {{tcpl|main other&#32;|&#32;|This template should only be used in articles.}}
<pre>
 
{{main other | | This template should only be used in articles. }}
 
</pre>
 
  
 
Note that in the first case above the "other" parameter was not used, and in the second example the "main" parameter was left empty.
 
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 ===
+
===Demospace===
For testing and demonstration purposes this template can take a parameter named '''demospace'''.  
+
For testing and demonstration purposes, this template can take a parameter named '''demospace'''.  
 
 
 
* If it has the value '''main''' it returns the article text.
 
* If it has the value '''main''' it returns the article 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 if has the value '''other''' or any other value such as the name of some other namespace it returns the other pages text.
Line 47: Line 35:
  
 
Like this:
 
Like this:
 +
: {{tcpl|main other&#32;|''result if in mainspace''&#32;|''result if elsewhere''&#32;|demospace{{=}}main}}
  
<pre>
+
No matter on what kind of page the code above is used, it will return: {{main other |''result if in mainspace'' |''result if elsewhere'' |demospace=main}}
{{main other  
 
| Article text
 
| Other pages text
 
| demospace = main
 
}}
 
</pre>
 
  
No matter on what kind of page the code above is used it will return 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:
 
+
: {{tcpl|main other&#32;|''result if in mainspace''&#32;|''result if elsewhere''&#32;|<nowiki>demospace={{{demospace|}}}</nowiki>&#32;}}
:{{main other
 
| Article text
 
| Other pages text
 
| demospace = main
 
}}
 
 
 
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:
 
 
 
<pre>
 
{{main other  
 
| Article text
 
| Other pages text
 
| demospace = {{{demospace|}}}
 
}}
 
</pre>
 
 
 
=== Technical details ===
 
  
 +
===Technical details===
 
This template detects article "Talk:" pages as type '''other'''.
 
This template detects article "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 the documentation there.
  
=== See also ===
+
===See also===
 +
{{Namespace detect see also}}
  
{{namespace detect see also}}
+
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
 
+
| <!-- CATEGORIES BELOW THIS LINE, PLEASE: -->
<includeonly>
 
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 
 
[[Category:Namespace manipulation templates]]
 
[[Category:Namespace manipulation templates]]
  
</includeonly>
 
 
<includeonly>
 
 
[[az:Şablon:Main other]]
 
[[az:Şablon:Main other]]
 
[[mk:Шаблон:Main other]]
 
[[mk:Шаблон:Main other]]
 
[[mn:Загвар:Main other]]
 
[[mn:Загвар:Main other]]
</includeonly>
+
}}</includeonly>

Revision as of 09:15, 14 September 2014

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

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

Basic usage

This template usually takes two parameters, like this:

{{main other |result if in mainspace |result if elsewhere}}

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

result if in mainspace

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

result if elsewhere

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:

Template:Tcpl

Note that guidelines do not support categorization in templates.

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

Template:Tcpl

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

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

  • If it has the value main it returns the article 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:

Template:Tcpl

No matter on what kind of page the code above is used, it will return: result if in mainspace

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:

Template:Tcpl

Technical details

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

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

See also

Template:Namespace detect see also