Template:Main talk other/doc

From IAB Wiki
(Difference between revisions)
Jump to: navigation, search
(Numbered parameters and HTML tables)
 
Line 12: Line 12:
 
This page is also the documentation for some other templates:
 
This page is also the documentation for some other templates:
  
* {{tl|main talk other flex}} – It works exactly the same, but it has some minor internal differences. Read more about that [[#Technical details|below]].
 
  
 
* {{tl|main talk category other}} – It works exactly the same, apart from that it uses the type '''category''' for pages that start with "Category:", but it still uses the type '''talk''' for "Category talk:" pages.
 
* {{tl|main talk category other}} – It works exactly the same, apart from that it uses the type '''category''' for pages that start with "Category:", but it still uses the type '''talk''' for "Category talk:" pages.
Line 139: Line 138:
  
 
===== Comparison =====
 
===== Comparison =====
 
{{tl|main talk other}} and {{tl|main talk other flex}} behaves exactly the same but internally uses different code:
 
  
 
* {{tld|main talk other}} will still correctly detect all talk pages even if new namespaces are added to Wikipedia. The talk page and main space detection functions are also shorter and thus nicer if you want to copy them to use them elsewhere:  
 
* {{tld|main talk other}} will still correctly detect all talk pages even if new namespaces are added to Wikipedia. The talk page and main space detection functions are also shorter and thus nicer if you want to copy them to use them elsewhere:  

Latest revision as of 16:23, 21 February 2013


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

This template is used inside other templates that need to behave differently (usually look differently) depending on what type of page they are on. It detects and groups all the different namespaces used on Wikipedia into three types:

main = Main/article space, as in normal Wikipedia articles.
talk = Any talk space, such as page names that start with "Talk:", "User talk:", "File talk:" and so on.
other = All other spaces, such as page names that start with "User:", "File:", "Wikipedia:" and so on.

This page is also the documentation for some other templates:


  • {{main talk category other}} – It works exactly the same, apart from that it uses the type category for pages that start with "Category:", but it still uses the type talk for "Category talk:" pages.

Contents

Basic usage

This template usually takes three parameters, and returns one of them depending on which type a page belongs to. Like this:

{{main talk other|Article text|Talk page text|Other pages text}}

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

Article text

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

Talk page text

If the template is on any other page (such as this template page and its doc page), it will return this:

Other pages text

If you only feed a parameter for one or two of the types then this template returns an empty string for the rest of the types. That is, if it for instance is used in one of these ways:

{{main talk other||Talk text}}
{{main talk other||Talk text|}}

Then it doesn't render anything in mainspace and other space.

If this template is used without any parameters or only fed empty parameters (empty strings), then it returns an empty string. That is, then it renders nothing.

The extended {{main talk category other}} template instead takes four parameters, also in the same order as the words in its name. Like this:

{{main talk category other|Article text|Talk text|Category text|Other text}}

which renders like this:

Other text

For testing and demonstration purposes these templates can take a parameter named demospace: if it has any of the values main, talk or other it makes the template behave as if it is on a page of that type; if the parameter is empty or undefined, the actual page type determines the result.

Usage example

This example creates a message box, but these templates can of course be used for many other things than message boxes. This example uses numbered parameters and HTML tables, for the reasons why see the technical details section below.

{{main talk other
| 1 = ''This messagebox should not be used in articles.''
| 2 = {{tmbox|text=Talk page notice}}
| 3 = {{ombox|text=Other pages notice}}
}}

Which renders like this:

Let's see how it looks on talk pages. So we change the first line in the code to this:

{{main talk other|demospace=talk

This is how it will render on any talk page:

And now let's test it for article pages:

{{main talk other|demospace=main

This is how it will render in an article:

This messagebox should not be used in articles.

Additional code

Too make this example complete, here is the rest of the code that is needed to make it a fully equipped template:

{{main talk other
| demospace = {{{demospace|}}}
| 1 = 
| 2 = 
| 3 = 
}}<noinclude>

{{documentation}}
<!-- Add categories and interwikis to the /doc subpage, not here! -->
</noinclude>

The line "| demospace = {{{demospace|}}}" means that your template also will understand the demospace parameter. That means you can demonstrate the different appearances of your template in the documentation for your template.

The "{{documentation}}" template creates a green documentation box, like the one you are reading in right now.

Technical details

Numbered parameters and HTML tables

Templates have a problem to handle parameter data that contains equal signs "=". But that is easily solved by using numbered parameters, such as "1=First parameter" and "2=Second parameter".

Templates also do have a problem to handle parameter data that contains pipes "|", unless the pipe is inside another template {{name|param1}} or inside a piped link [[Help:Template|help]]. Thus templates can not handle wikitables as input unless you escape them by using the {{!}} template. This makes it hard to use wikitables as parameters to templates. Instead the usual solution is to use "HTML wikimarkup" for the table code, which is more robust.

The simplest way to include tables that use wikimarkup is to transclude them as a subtemplate.

Comparison
  • {{main talk other}} will still correctly detect all talk pages even if new namespaces are added to Wikipedia. The talk page and main space detection functions are also shorter and thus nicer if you want to copy them to use them elsewhere:
{{#ifeq:{{NAMESPACE}}|{{TALKSPACE}}| talk | not talk }}
{{#ifeq:{{NAMESPACE}}|{{ns:0}}| main | not main }}
  • {{main talk other flex}} is more flexible in that its code is much easier to modify to detect any combination of namespaces as one wishes. But please copy the code to a new template before you do such modifications.
  • If a new namespace is added to Wikipedia then {{main talk other flex}} needs to be manually updated, otherwise it will detect the new talk space as type "other". Fortunately new namespaces is a very rare event.

So if you just need to detect main, talk and other then use {{main talk other}}. But if you want to detect other combinations then copy the code from {{main talk other flex}}.

{{main talk category other}} also will correctly detect all talk pages even if new namespaces are added to Wikipedia.

Copying to other projects?

If you copy these templates to another language Wikipedia or other Wikimedia project, then {{main talk other}} should work as is, but you probably want to update the template's name and its parameter names to your local namespace naming. But you must update the code of {{main talk category other}} and {{main talk other flex}} to your local naming and add any extra namespaces that are local to your wiki, otherwise they will malfunction.

CSS namespace detection

CSS code can be used instead of these templates to detect namespaces. This can be used for those things that can be coded as CSS, such as colours and borders. See example on the talk page.

See also

Easy to use namespace-detection templates:

More complex namespace-detection templates:

Pagename-handling and detection templates:

  • {{basepage subpage}} – For detecting if on a basepage, subpage or subsubpage.
  • {{pgn}} – Can take apart and put together pagenames in several ways.
  • {{if pagename}} – For pattern matching on the pagename.
  • {{if pagename multi}} – For pattern matching on the pagename, has input reuse.
  • {{IP-user other}} – For detecting IP-user pages.
  • {{IP-talk}} - Return: 1) IP user talk page 2) registered user talk page 3) not user talk page.

Technical stuff:


Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox