Template:IP-user other/doc

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

This template helps other templates detect if they are on an IP-user page or some "other" type of page.

It detects both the subject page and talk page of an IP-user as "IP-user". It also detects the subpages and subsubpages of an IP-user, for instance it considers "User talk:12.34.56.78/subpage" as "IP-user".

It also detects IPv6 user pages, for instance it considers "User:2001:470:FD:3:0:0:0:80" as "IP-user".

It can also differentiate between IPv4 and IPv6 user pages if that is needed.

Usage

This template can be used in several different ways.

It can be used with unnamed parameters, like this:

{{IP-user other | IP-user text | Other pages text }}

If this template is on an IP-user page, it will return this:

IP-user text

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

Other pages text

It can also be used with named parameters, like this:

{{IP-user other 
| IP = IP-user text 
| other = Other pages text 
}}

If this template is on an IP-user page, it will return this:

IP-user text

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

Other pages text

If you need to differentiate between IPv4 and IPv6 user pages, then do like this:

{{IP-user other 
| IPv4 = IPv4 text
| IPv6 = IPv6 text
| other = Other pages text 
}}

If this template is on an IPv4 user page, for instance User talk:12.34.56.78/subpage, it will return this:

IPv4 text

If this template is on an IPv6 user page, for instance User:2001:470:FD:3:0:0:0:80, it will return this:

IPv6 text

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

Other pages text

The "page" parameter

This template can take a parameter named page. Like this:

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

Or perhaps clearer with the named parameters:

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

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

IP-user text

The page parameter makes this template behave exactly as if on that page. The pagename doesn't have to be an existing page.

If the parameter is empty or undefined, the name of the current page determines the result.

You can make it so your template also understands the page parameter. That means you can demonstrate the different appearances of your template in the documentation for your template. Then do like this:

{{IP-user other
| IP = IP-user text 
| other = Other pages text
| page = {{{page|}}}
}}

Technical details

Templates have a problem to handle parameter data that contains equal signs "=". But that is easily solved by using numbered parameters. Like this:

{{IP-user other
| 1 = IP-user text: "A = B"
| 2 = Other pages text: "C = D"
| page = {{{page|}}}
}}

Since this template also has named parameters, this is probably clearer:

{{IP-user other
| IP = IP-user text: "A = B"
| other = Other pages text: "C = D"
| page = {{{page|}}}
}}

If your template is using tables, then you need to know this:

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

This template calls Module:IPAddress which does most of the work for {{IP-user other}}, while {{IP-user other}} itself does parameter preprocessing.

For more technical details, see the talk page.