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

{{#invoke:pagetype|main}}

All parameters

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

Basic usage

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

{{#invoke:pagetype|main}}

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
Book namespace	book
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
{{#invoke:pagetype|main}}

Page parameter

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

{{#invoke:pagetype|main|page=page name}}

Examples

Code	Result
{{#invoke:pagetype|main|page=United Kingdom}}	redirect
{{#invoke:pagetype|main|page=UK}}	redirect
{{#invoke:pagetype|main|page=Talk:United Kingdom}}	redirect
{{#invoke:pagetype|main|page=File:Example.svg}}
{{#invoke:pagetype|main|page=Wikipedia:Namespace}}
{{#invoke:pagetype|main|page=TimedText:Imagine.ogg.en.srt}}

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

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

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 Module:Yesno.)

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
Education program namespace	education program page
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 |template=no, then the module will display "page" when used on a template page, rather than the default "template".

{{#invoke:pagetype|main
| main     = no
| file     = no
| template = no
| category = no
| module   = no
| book     = no
}}

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
{{#invoke:pagetype|main|page=Wikipedia:Namespace}}
{{#invoke:pagetype|main|page=Wikipedia:Namespace|wikipedia=yes}}
{{#invoke:pagetype|main|page=Talk:United Kingdom}}	redirect
{{#invoke:pagetype|main|page=Talk:United Kingdom|talk=y}}
{{#invoke:pagetype|main|page=United Kingdom}}	redirect
{{#invoke:pagetype|main|page=United Kingdom|main=no}}	redirect
{{#invoke:pagetype|main|page=TimedText:Imagine.ogg.en.srt}}
{{#invoke:pagetype|main|page=TimedText:Imagine.ogg.en.srt|timedtext=Yes}}

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: 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 |defaultns=				Output
	none	extended	all	Other values
Main	Template:Cross	Y	Y	Y	article
User	Template:Cross	Y	Y	Template:Cross	user page
Wikipedia	Template:Cross	Y	Y	Template:Cross	project page
File	Template:Cross	Y	Y	Y	file
MediaWiki	Template:Cross	Y	Y	Template:Cross	interface page
Template	Template:Cross	Y	Y	Y	template
Help	Template:Cross	Y	Y	Template:Cross	help page
Category	Template:Cross	Y	Y	Y	category
Portal	Template:Cross	Y	Y	Template:Cross	portal
Book	Template:Cross	Y	Y	Y	book
Draft	Template:Cross	Y	Y	Template:Cross	draft
Education Program	Template:Cross	Template:Cross	Y	Template:Cross	education program page
TimedText	Template:Cross	Template:Cross	Y	Template:Cross	Timed Text page
Module	Template:Cross	Y	Y	Y	module
Topic (Flow boards)	Template:Cross	Template:Cross	Y	Template:Cross	topic
All talk namespaces	Template:Cross	Template:Cross	Y	Template:Cross	talk page
Special	Template:Cross	Template:Cross	Y	Template:Cross	special page
Media	Template:Cross	Template:Cross	Y	Template:Cross	file

Examples

Code	Result
{{#invoke:pagetype|main|page=United Kingdom}}	redirect
{{#invoke:pagetype|main|page=United Kingdom|defaultns=none}}	redirect
{{#invoke:pagetype|main|page=Talk:United Kingdom}}	redirect
{{#invoke:pagetype|main|page=Talk:United Kingdom|defaultns=all}}
{{#invoke:pagetype|main|page=File:Example.svg}}
{{#invoke:pagetype|main|page=File:Example.svg|defaultns=none}}
{{#invoke:pagetype|main|page=Wikipedia:Namespace}}
{{#invoke:pagetype|main|page=Wikipedia:Namespace|defaultns=extended}}
{{#invoke:pagetype|main|page=TimedText:Imagine.ogg.en.srt|defaultns=extended}}
{{#invoke:pagetype|main|page=TimedText:Imagine.ogg.en.srt|defaultns=all}}

Custom namespace values

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

{{#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
| book              = custom text
| draft             = custom text
| education program = custom text
| timedtext         = custom text
| module            = custom text
| topic             = custom text
| special           = custom text
| media             = custom text
}}

Examples

Code	Result
{{#invoke:pagetype|main|page=Wikipedia:Namespace}}
{{#invoke:pagetype|main|page=Wikipedia:Namespace|wikipedia=custom text}}
{{#invoke:pagetype|main|page=Talk:United Kingdom}}	redirect
{{#invoke:pagetype|main|page=Talk:United Kingdom|talk=custom text}}
{{#invoke:pagetype|main|page=United Kingdom}}	redirect
{{#invoke:pagetype|main|page=United Kingdom|main=custom text}}	redirect
{{#invoke:pagetype|main|page=TimedText:Imagine.ogg.en.srt}}
{{#invoke:pagetype|main|page=TimedText:Imagine.ogg.en.srt|timedtext=custom text}}

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.

{{#invoke:pagetype|main|talk=yes}}

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

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

Examples

Code	Result
{{#invoke:pagetype|main|page=Wikipedia talk:Namespace}}
{{#invoke:pagetype|main|page=Wikipedia talk:Namespace|wikipedia=yes}}
{{#invoke:pagetype|main|page=Wikipedia talk:Namespace|talk=yes}}
{{#invoke:pagetype|main|page=Wikipedia talk:Namespace|wikipedia=yes|talk=yes}}
{{#invoke:pagetype|main|page=Wikipedia talk:Namespace|talk=custom text}}
{{#invoke:pagetype|main|page=Wikipedia talk:Namespace|wikipedia=yes|talk=custom text}}

Main namespace classes

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

{{#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 article.

Class	Class values	Output
Disambiguation page	disambiguation, disambig, disamb, dab	page
No applicable class	na, n/a	page

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:

{{#invoke:pagetype|main|class|dab=yes|na=yes}}

{{#invoke:pagetype|main|class|dab=custom text|na=custom text}}

This works the same way that it does for the custom namespace page types. Possible parameters are:

• dab: a custom value for disambiguation-class pages. If set to "yes", "y", "true" or "1", this produces "disambiguation page". If set to "no", "n", "false" or "0", no custom value is produced. If set to any other value it produces that text.
• 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
{{#invoke:pagetype|main|page=United Kingdom}}	redirect
{{#invoke:pagetype|main|page=United Kingdom|dab}}	redirect
{{#invoke:pagetype|main|page=United Kingdom|dab|dab=custom text}}	redirect
{{#invoke:pagetype|main|page=United Kingdom|na}}	redirect
{{#invoke:pagetype|main|page=United Kingdom|na|na=custom text}}	redirect

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.

{{#invoke:pagetype|main|redirect=no}}

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

Examples

Code	Result
{{#invoke:pagetype|main|page=UK}}	redirect
{{#invoke:pagetype|main|page=UK|redirect=no}}
{{#invoke:pagetype|main|page=UK|redirect=custom text}}	custom text

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

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

Examples

Code	Result
{{#invoke:pagetype|main|page=Wikipedia:Namespace}}
{{#invoke:pagetype|main|page=Wikipedia:Namespace|other=custom text}}
{{#invoke:pagetype|main|page=Wikipedia:Namespace|other=custom text|wikipedia=wikipedia-space text}}

Plurals

By default the module returns the name of the namespace in the singular. Adding the parameter |plural=y returns the plural form.

Code	Result
{{#invoke:pagetype|main|page=United Kingdom}}	redirect
{{#invoke:pagetype|main|page=United Kingdom|plural=y}}	redirects
{{#invoke:pagetype|main|page=Category:Books}}
{{#invoke:pagetype|main|page=Category:Books|plural=y}}

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 |caps=y returns a version with a capital letter at the start.

Code	Result
{{#invoke:pagetype|main|page=United Kingdom}}	redirect
{{#invoke:pagetype|main|page=United Kingdom|caps=y}}	Redirect
{{#invoke:pagetype|main|page=United Kingdom|plural=y|caps=y}}	Redirects