Module:Pagetype/doc explained

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 .

Syntax

Basic usage

{{#invoke:pagetype|main}}

All parameters

{{#invoke:pagetype|main
| page              = 
| defaultns         = 
| main              = 
| user              = 
| wikipedia         = 
| project           = 
| wp                = 
| file              = 
| image             = 
| mediawiki         = 
| template          = 
| help              = 
| category          = 
| portal            = 
| draft             = 
| timedtext         = 
| module            = 
| topic             = 
| special           = 
| media             = 
| talk              = 
| redirect          =
| soft_redirect     = 
| dab               = 
| na                = 
| other             = 
| sia               =
| nonexistent       =
| plural            = 
}}

Basic usage

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

{}

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

Page type / namespace	Output
Redirects (in any namespace)	redirect
Main namespace	article
File namespace	file
Template namespace	template
Category namespace	category
Module namespace	module
Other namespaces	page

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

Example

Code	Result
<nowiki>{{#invoke:pagetype|main}}</nowiki> || |} Page parameter You can use the page parameter to make the module act as though it was called from that page. {} Examples
<nowiki>{{#invoke:pagetype|main|page=UK}}</nowiki> || |-| <nowiki>{{#invoke:pagetype|main|page=Talk:United Kingdom}}</nowiki>
<nowiki>{{#invoke:pagetype|main|page=File:Example.svg}}</nowiki> || |-| <nowiki>{{#invoke:pagetype|main|page=Wikipedia:Namespace}}</nowiki>
<nowiki>{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt}}</nowiki> || |} 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 . 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: {} You can use any of the following to specify the namespace: "yes", "y", "true" or "1". They can be used in any combination of upper and lower case. (These values are defined by .) The default text for these namespaces is as follows: Page type / namespace Output User namespace user page Wikipedia namespace project page MediaWiki namespace interface page Help namespace help page Portal namespace portal Draft namespace draft Timed Text namespace Timed Text page Topic namespace topic Special namespace special page Media namespace file You can use a similar process to remove any of the default namespace values as well. For example, if you use the code, then the module will display "page" when used on a template page, rather than the default "template". {} The following values will all work to remove namespace values: "no", "n", "false" or "0". They can be used in any combination of upper and lower case. Examples Code Result <nowiki>{{#invoke:pagetype|main|page=Wikipedia:Namespace}}</nowiki> <nowiki>{{#invoke:pagetype|main|page=Wikipedia:Namespace|wikipedia=yes}}</nowiki> <nowiki>{{#invoke:pagetype|main|page=Talk:United Kingdom}}</nowiki> <nowiki>{{#invoke:pagetype|main|page=Talk:United Kingdom|talk=y}}</nowiki> || |-| <nowiki>{{#invoke:pagetype|main|page=United Kingdom}}</nowiki> || |-| <nowiki>{{#invoke:pagetype|main|page=United Kingdom|main=no}}</nowiki> || |-| <nowiki>{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt}}</nowiki> || |-| <nowiki>{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt|timedtext=Yes}}</nowiki> || |} Default namespace sets As well as adding and removing individual namespaces, it is possible to specify different sets of namespaces by using the . There are four different sets available: all, extended, none 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: Namespace Value of Output none extended all Other values Main article User user page Wikipedia project page File file MediaWiki interface page Template template Help help page Category category Portal portal Draft draft TimedText Timed Text page Module module Topic (Flow boards) topic All talk namespaces talk page Special special page Media file Examples
<nowiki>{{#invoke:pagetype|main|page=United Kingdom|defaultns=none}}</nowiki>
<nowiki>{{#invoke:pagetype|main|page=Talk:United Kingdom}}</nowiki>
<nowiki>{{#invoke:pagetype|main|page=Talk:United Kingdom|defaultns=all}}</nowiki>
<nowiki>{{#invoke:pagetype|main|page=File:Example.svg}}</nowiki> || |-| <nowiki>{{#invoke:pagetype|main|page=File:Example.svg|defaultns=none}}</nowiki>
<nowiki>{{#invoke:pagetype|main|page=Wikipedia:Namespace}}</nowiki>
<nowiki>{{#invoke:pagetype|main|page=Wikipedia:Namespace|defaultns=extended}}</nowiki> || |-| <nowiki>{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt|defaultns=extended}}</nowiki>
<nowiki>{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt|defaultns=all}}</nowiki> || |} Custom namespace values It is possible to specify a custom value for any namespace: {} Examples Code Result <nowiki>{{#invoke:pagetype|main|page=Wikipedia:Namespace}}</nowiki> <nowiki>{{#invoke:pagetype|main|page=Wikipedia:Namespace|wikipedia=custom text}}</nowiki> <nowiki>{{#invoke:pagetype|main|page=Talk:United Kingdom}}</nowiki> <nowiki>{{#invoke:pagetype|main|page=Talk:United Kingdom|talk=custom text}}</nowiki> || |-| <nowiki>{{#invoke:pagetype|main|page=United Kingdom}}</nowiki> || |-| <nowiki>{{#invoke:pagetype|main|page=United Kingdom|main=custom text}}</nowiki> <nowiki>{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt}}</nowiki> || |-| <nowiki>{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt|timedtext=custom text}}</nowiki> || |} Talk parameter Normally, the module will treat talk pages as if they were in the corresponding subject namespace. However, if the talk parameter is set, the module will treat talk pages separately from subject pages. The talk 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. {} {} The default value for "talk=''yes''" is "talk page". Examples
<nowiki>{{#invoke:pagetype|main|page=Wikipedia talk:Namespace|wikipedia=yes}}</nowiki> || |-| <nowiki>{{#invoke:pagetype|main|page=Wikipedia talk:Namespace|talk=yes}}</nowiki>
<nowiki>{{#invoke:pagetype|main|page=Wikipedia talk:Namespace|wikipedia=yes|talk=yes}}</nowiki>
<nowiki>{{#invoke:pagetype|main|page=Wikipedia talk:Namespace|talk=custom text}}</nowiki>
<nowiki>{{#invoke:pagetype|main|page=Wikipedia talk:Namespace|wikipedia=yes|talk=custom text}}</nowiki>

Main namespace classes

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

{}

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

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:

{}

{}

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 dab parameter. The default value for "yes" etc. is "page".

Examples

Code	Result
<nowiki>{{#invoke:pagetype|main|page=United Kingdom}}</nowiki> || |-| <nowiki>{{#invoke:pagetype|main|page=United Kingdom|na}}</nowiki>
<nowiki>{{#invoke:pagetype|main|page=United Kingdom|na|na=custom text}}</nowiki> || |} 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. {} {} Examples
<nowiki>{{#invoke:pagetype|main|page=UK|redirect=no}}</nowiki> || |-| <nowiki>{{#invoke:pagetype|main|page=UK|redirect=custom text}}</nowiki>

Disambiguation pages

By default, the module uses 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.

{}

{}

Examples

Code	Result
<nowiki>{{#invoke:pagetype|main|page=Mercury}}</nowiki>
<nowiki>{{#invoke:pagetype|main|page=Mercury|dab=no}}</nowiki> || |-| <nowiki>{{#invoke:pagetype|main|page=Mercury|dab=custom text}}</nowiki>

Set index articles

Documentation pending.

Soft redirects

Documentation pending.

Non-existent pages

Documentation pending.

Other namespaces

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

{}

Examples

Code	Result
<nowiki>{{#invoke:pagetype|main|page=Wikipedia:Namespace}}</nowiki>
<nowiki>{{#invoke:pagetype|main|page=Wikipedia:Namespace|other=custom text}}</nowiki>
<nowiki>{{#invoke:pagetype|main|page=Wikipedia:Namespace|other=custom text|wikipedia=wikipedia-space text}}</nowiki> || |} Plurals By default the module returns the name of the namespace in the singular. Adding the parameter returns the plural form.
<nowiki>{{#invoke:pagetype|main|page=United Kingdom|plural=y}}</nowiki>
<nowiki>{{#invoke:pagetype|main|page=Category:Books}}</nowiki> || |-| <nowiki>{{#invoke:pagetype|main|page=Category:Books|plural=y}}</nowiki>

The rules for pluralisation can be customised in to allow localisation.

Capitalisation

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

Code	Result
<nowiki>{{#invoke:pagetype|main|page=United Kingdom}}</nowiki> || |-| <nowiki>{{#invoke:pagetype|main|page=United Kingdom|caps=y}}</nowiki>
<nowiki>{{#invoke:pagetype|main|page=United Kingdom|plural=y|caps=y}}</nowiki> || |}}