Module:Pagetype/doc

This module is used to detect the page type of a given page. It detects redirect pages automatically and is highly customisable. It can be used on its own or as a meta-module to create other page-type-detection templates. This module can also be accessed using pagetype.

Syntax

 * Basic usage


 * All parameters

Basic usage
For simple detection of the page type of the current page, use the default settings:

&#123;{#invoke:pagetype|main}}

That will produce the following results, depending on the page type or the namespace:

If the module is used on a talk page, it will detect the page type for the corresponding subject page.


 * Example

Page parameter
You can use the  parameter to make the module act as though it was called from that page.

&#123;{#invoke:pagetype|main|page=page name}}


 * Examples

Adding and removing namespaces
It is possible to specify different behaviour for each namespace than that described in the basic usage section. For example, you might want the module to display "user page" for pages in the user namespace, instead of the default "page". To do this, you can use the code yes. This looks up the typical name used for pages in the user namespace, in this case "user page", and uses that text when the module is used with a page in the user namespace. To use this with other namespaces, use the namespace name in lower case as a parameter:

&#123;{#invoke:pagetype|main | user             = yes | wikipedia        = yes | project          = yes | wp               = yes | mediawiki        = yes | help             = yes | portal           = yes | draft            = yes | timedtext        = yes | topic            = yes | special          = yes | media            = yes }}

You can use any of the following to specify the namespace: " ", " ", " " or " ". They can be used in any combination of upper and lower case. (These values are defined by Module:Yesno.)

The default text for these namespaces is as follows:

You can use a similar process to remove any of the default namespace values as well. For example, if you use the code no, then the module will display "page" when used on a template page, rather than the default "template".

&#123;{#invoke:pagetype|main | main    = no | file    = no | template = no | category = no | module  = no }}

The following values will all work to remove namespace values: " ", " ", " " or " ". They can be used in any combination of upper and lower case.


 * Examples

Default namespace sets
As well as adding and removing individual namespaces, it is possible to specify different sets of namespaces by using the defaultns. There are four different sets available:,  ,   and the default set. These sets allow you to specify many namespaces at once, without having to use all of the individual namespace parameters. Namespaces are set according to the following table:


 * Examples

Custom namespace values
It is possible to specify a custom value for any namespace:

&#123;{#invoke:pagetype|main | main             = custom text | user             = custom text | wikipedia        = custom text | project          = custom text | wp               = custom text | file             = custom text | image            = custom text | mediawiki        = custom text | template         = custom text | help             = custom text | category         = custom text | portal           = custom text | draft            = custom text | timedtext        = custom text | module           = custom text | topic            = custom text | special          = custom text | media            = custom text }}


 * Examples

Talk parameter
Normally, the module will treat talk pages as if they were in the corresponding subject namespace. However, if the  parameter is set, the module will treat talk pages separately from subject pages. The  parameter sets values for all talk pages, i.e. pages in the Talk: namespace, pages in the User talk: namespace, pages in the Wikipedia talk: namespace, and so on.

&#123;{#invoke:pagetype|main|talk=yes}}

&#123;{#invoke:pagetype|main|talk=custom text}}

The default value for " " is "talk page".


 * Examples

Main namespace classes
For pages in the main namespace, it is possible to add a class value in the first positional parameter:

&#123;{#invoke:pagetype|main|class}}

If the class value matches one of the values in the table below, it will produce an alternative to the default output of.

You can input the class value in any combination of upper and lower case.

Custom main namespace classes
It is also possible to specify a custom value for the main namespace classes:

&#123;{#invoke:pagetype|main|class|na=yes}}

&#123;{#invoke:pagetype|main|class|na=custom text}}

This works the same way that it does for the custom namespace page types. Possible parameters are:
 * na: a custom value for NA-class pages. It works in the same way as the  parameter. The default value for " " etc. is "page".


 * Examples

Redirects
By default, the module automatically detects redirects in all namespace. It is not possible to specify redirect behaviour by namespace, but you can turn redirect detection off, or use a custom value for redirect pages.

&#123;{#invoke:pagetype|main|redirect=no}}

&#123;{#invoke:pagetype|main|redirect=custom text}}


 * Examples

Disambiguation pages
By default, the module uses Module:Disambiguation to detect disambiguation pages in the main namespace. If you want, you can turn this detection off, or use a custom value for disambiguation pages.

&#123;{#invoke:pagetype|main|dab=no}}

&#123;{#invoke:pagetype|main|dab=custom text}}


 * Examples

Set index articles
Documentation pending.

Soft redirects
Documentation pending.

Non-existent pages
Documentation pending.

Other namespaces
By default, the module produces " " if used from a namespace that hasn't been specified. This value can be changed with the other parameter:

&#123;{#invoke:pagetype|main|other=custom text}}


 * Examples

Plurals
By default the module returns the name of the namespace in the singular. Adding the parameter y returns the plural form. The rules for pluralisation can be customised in Module:Pagetype/config to allow localisation.

Capitalisation
By default the module returns the page type in lowercase. Adding the parameter y returns a version with a capital letter at the start.