Template:Main other/doc

2012-01-01T15:10:32Z

31.15.196.29: sl:Predloga:Main other

{{documentation subpage}}
{{high-risk| 1,000,000+ }}


This is the {{tl|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:

<pre>
{{main other | Article text | Other pages text }}
</pre>

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

:{{main other | demospace=main | Article text | Other pages text }}

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

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

<pre>
{{main other | [[Category:Some article maintenance category]] }}
</pre>

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

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

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

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

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

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.

=== See also ===

{{namespace detect see also}}

<includeonly>

[[Category:Namespace manipulation templates]]

[[da:Skabelon:Artikel eller andet]]
[[id:Templat:Main other]]
[[mk:Шаблон:Main other]]
[[mn:Загвар:Main other]]
[[ja:Template:Main other]]
[[ro:Format:Main other]]
[[sl:Predloga:Main other]]
[[uk:Шаблон:Main other]]
[[ur:سانچہ:Main other]]
[[zh:Template:Main other]]
</includeonly>

Template:Template sandbox notice/doc

2011-12-27T14:10:34Z

31.15.196.29: sl:Predloga:Obvestilo o peskovniku predloge

{{Documentation subpage}}

{{Sandbox not}}

This is the {{tl|template sandbox notice}} template.

It can be placed on template /sandbox pages. It also detects when it is not on a /sandbox page and then shows nothing, thus it can be left in the code when copied and pasted to the main template. (Although most users remove the sandbox notice when they copy the code from the /sandbox to the main template. But beware, if the '''notice-not-sandbox''' parameter has been used then the sandbox notice must be copied with the rest of the template code. See more below.)

To learn more about how to use template /sandbox and /testcases subpages see [[Wikipedia:Template test cases]].

=== Simple example ===
<pre>
<noinclude>

{{template sandbox notice}}
</noinclude>
</pre>

'''Note!''' The template code must start directly before and physically touch the <code><noinclude></code> tag. Any blank space or newlines between the template code and the <code><noinclude></code> tag can cause the template to render unwanted spaces or newlines when used.

=== Non-standard "/sandbox" and "/testcases" names ===

This template uses case-insensitive matching, so will match "/Sandbox", "/SandBox", "/sAnDbOx" etc. without any special help.

If the /sandbox page has another name, for instance "/sandbag", then you need to tell the sandbox notice the name of the page, so that it knows when to show and when not to show itself. Like this:

<pre>
<noinclude>

{{template sandbox notice | subpage-name=sandbag }}
</noinclude>
</pre>

If the testcases page has another name, this may be specified using the testcases-name parameter:
<pre>
<noinclude>

{{template sandbox notice | testcases-name=testbox}}
</noinclude>
</pre>

Provided there is only one sandbox or testcases page in use for the particular main page, another option is to move the sandbox page to the standard "/sandbox" name, or testcases to "/testcases". That may be preferable since other templates and tools also assume that the sandbox uses that name, such as {{tl|documentation}}.

=== Showing and hiding other things ===

The sandbox notice can also help showing and hiding other things depending on if it detects it is on the /sandbox page or not. Like this:

<pre>
<noinclude>

{{template sandbox notice
| notice-for-sandbox = Text that shows on the /sandbox page.
| notice-not-sandbox = Text that will show on other pages.
}}

</noinclude>
</pre>

=== Protection template example ===

The '''notice-not-sandbox''' parameter can for instance be used so a protection template can be placed already in the /sandbox version of the code. (See also [[Wikipedia:Protection policy]].) Like this:

<pre>
<noinclude>

{{template sandbox notice
| notice-not-sandbox = {{pp-semi-template|small=yes}}
}}
</noinclude>
</pre>

=== Documentation example ===

Some templates have their documentation on a separate /doc page, and then show that documentation in a green doc box below the template code by using the {{tl|documentation}} template. (See also [[Wikipedia:Template documentation]].) Then place the sandbox notice like this:

<pre>
<noinclude>

{{template sandbox notice}}
{{documentation}}

</noinclude></pre>

=== Super deluxe example ===

This example handles both a protection template and a green doc box from a /doc page at the same time. (See also [[Wikipedia:Protection policy]] and [[Wikipedia:Template documentation]].) Like this:

<pre>
<noinclude>

{{template sandbox notice
| notice-for-sandbox = Text that shows on the /sandbox page.
| notice-not-sandbox = {{pp-semi-template|small=yes}}
}}
{{documentation}}

</noinclude>
</pre>

=== Copy, paste & delete ===

The following "complete" example can be used to copy and paste into your template, then delete the parts you don't need:

<pre>
<noinclude>

{{template sandbox notice
| notice-for-sandbox =
| notice-not-sandbox =

{{pp-dispute}}
{{pp-office}}
{{pp-move}}
{{pp-protected}}
{{pp-template}}
{{pp-usertalk}}
{{pp-vandalism}}
{{pp-semi-protected}}
{{pp-semi-sock}}
{{pp-semi-spambot}}
{{pp-semi-template}}
{{pp-semi-usertalk}}
{{pp-semi-vandalism}}

{{pp-dispute|small=yes}}
{{pp-office|small=yes}}
{{pp-move|small=yes}}
{{pp-protected|small=yes}}
{{pp-template|small=yes}}
{{pp-usertalk|small=yes}}
{{pp-vandalism|small=yes}}
{{pp-semi-protected|small=yes}}
{{pp-semi-sock|small=yes}}
{{pp-semi-spambot|small=yes}}
{{pp-semi-template|small=yes}}
{{pp-semi-usertalk|small=yes}}
{{pp-semi-vandalism|small=yes}}

}}

{{documentation}}

</noinclude>
</pre>

=== Technical details ===

If there is an accompanying "/testcases" page this template will detect that and show a link to the /testcases page.

This template categorises /sandbox pages into [[:Category:Template sandboxes]]. If you don't want a page to be categorised then use the template like this:
:<code><nowiki>{{template sandbox notice|category=}}</nowiki></code>

If you want to demonstrate the template on say [[Wikipedia:Template messages/Template namespace]] then you need to feed the '''subpage-name''' to make it show and feed an empty '''category''' parameter so it doesn't categorise the page. Like this:
:<code><nowiki>{{template sandbox notice|subpage-name=Template namespace|category=}}</nowiki></code>

=== See also ===

* {{tl|Template test cases notice}} – To put on top of /testcases pages.
* [[Wikipedia:Template messages/Template namespace]] – Lists and shows most template related message boxes.

<includeonly>
[[Category:Sandbox templates]]
[[Category:Template namespace templates|{{PAGENAME}}]]

[[ar:قالب:Template sandbox notice]]
[[ja:Template:Template sandbox notice]]
[[pt:Predefinição:Notícia de Teste de Predefinição]]
[[ru:Шаблон:Песочница шаблона]]
[[sl:Predloga:Obvestilo o peskovniku predloge]]
[[ur:سانچہ:Template sandbox notice]]
</includeonly>

Female Submission Wrestling Encyclopedia - User contributions [en]

Template:Main other/doc

Template:Template sandbox notice/doc