Template:Pagetype

template

Template documentation[view] [edit] [history] [purge]

This template 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-template to create other page-type-detection templates.

Syntax

Basic code

{{pagetype}}

Full code

{{pagetype
| page              = 
| defaultns         = 
| main              = 
| user              = 
| ShadowrunWiki         = 
| project           = 
| wp                = 
| file              = 
| image             = 
| mediawiki         = 
| template          = 
| help              = 
| category          = 
| portal            = 
| timedtext         = 
| module            = 
| 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:

{{pagetype}}

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 template is used on a talk page, it will detect the page type for the corresponding subject page.

Example

Code	Result
{{pagetype}}	template

Page parameter

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

{{pagetype|page=page name}}

Examples

Code	Result
{{pagetype|page=United Kingdom}}	article
{{pagetype|page=UK}}	article
{{pagetype|page=Talk:United Kingdom}}	article
{{pagetype|page=File:Example.svg}}	file
{{pagetype|page=ShadowrunWiki:Namespace}}	article
{{pagetype|page=TimedText:Imagine.ogg.en.srt}}	article

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 template 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 template 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:

{{pagetype
| user              = yes
| ShadowrunWiki         = yes
| project           = yes
| wp                = yes
| mediawiki         = yes
| help              = yes
| portal            = yes
| timedtext         = 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
ShadowrunWiki namespace	project page
MediaWiki namespace	interface page
Help namespace	help page
Portal namespace	portal
Timed Text namespace	Timed Text page
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 template will display "page" when used on a template page, rather than the default "template".

{{pagetype
| main     = no
| file     = no
| template = no
| category = no
| module   = 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
{{pagetype|page=ShadowrunWiki:Namespace}}	article
{{pagetype|page=ShadowrunWiki:Namespace|ShadowrunWiki=yes}}	article
{{pagetype|page=Talk:United Kingdom}}	article
{{pagetype|page=Talk:United Kingdom|talk=y}}	talk page
{{pagetype|page=United Kingdom}}	article
{{pagetype|page=United Kingdom|main=no}}	page
{{pagetype|page=TimedText:Imagine.ogg.en.srt}}	article
{{pagetype|page=TimedText:Imagine.ogg.en.srt|timedtext=Yes}}	article

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	N	Y	Y	Y	article
User	N	Y	Y	N	user page
ShadowrunWiki	N	Y	Y	N	project page
File	N	Y	Y	Y	file
MediaWiki	N	Y	Y	N	interface page
Template	N	Y	Y	Y	template
Help	N	Y	Y	N	help page
Category	N	Y	Y	Y	category
Portal	N	Y	Y	N	portal
TimedText	N	N	Y	N	Timed Text page
Module	N	Y	Y	Y	module
All talk namespaces	N	N	Y	N	talk page
Special	N	N	Y	N	special page
Media	N	N	Y	N	file

Examples

Code	Result
{{pagetype|page=United Kingdom}}	article
{{pagetype|page=United Kingdom|defaultns=none}}	page
{{pagetype|page=Talk:United Kingdom}}	article
{{pagetype|page=Talk:United Kingdom|defaultns=all}}	talk page
{{pagetype|page=File:Example.svg}}	file
{{pagetype|page=File:Example.svg|defaultns=none}}	page
{{pagetype|page=ShadowrunWiki:Namespace}}	article
{{pagetype|page=ShadowrunWiki:Namespace|defaultns=extended}}	article
{{pagetype|page=TimedText:Imagine.ogg.en.srt|defaultns=extended}}	article
{{pagetype|page=TimedText:Imagine.ogg.en.srt|defaultns=all}}	article

Custom namespace values

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

{{pagetype
| main              = custom text
| user              = custom text
| ShadowrunWiki         = 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
| timedtext         = custom text
| module            = custom text
| special           = custom text
| media             = custom text
}}

Examples

Code	Result
{{pagetype|page=ShadowrunWiki:Namespace}}	article
{{pagetype|page=ShadowrunWiki:Namespace|ShadowrunWiki=custom text}}	article
{{pagetype|page=Talk:United Kingdom}}	article
{{pagetype|page=Talk:United Kingdom|talk=custom text}}	custom text
{{pagetype|page=United Kingdom}}	article
{{pagetype|page=United Kingdom|main=custom text}}	custom text
{{pagetype|page=TimedText:Imagine.ogg.en.srt}}	article
{{pagetype|page=TimedText:Imagine.ogg.en.srt|timedtext=custom text}}	article

Talk parameter

Normally, the template will treat talk pages as if they were in the corresponding subject namespace. However, if the talk parameter is set, the template 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 ShadowrunWiki talk: namespace, and so on.

{{pagetype|talk=yes}}

{{pagetype|talk=custom text}}

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

Examples

Code	Result
{{pagetype|page=ShadowrunWiki talk:Namespace}}	article
{{pagetype|page=ShadowrunWiki talk:Namespace|ShadowrunWiki=yes}}	article
{{pagetype|page=ShadowrunWiki talk:Namespace|talk=yes}}	article
{{pagetype|page=ShadowrunWiki talk:Namespace|ShadowrunWiki=yes|talk=yes}}	article
{{pagetype|page=ShadowrunWiki talk:Namespace|talk=custom text}}	article
{{pagetype|page=ShadowrunWiki talk:Namespace|ShadowrunWiki=yes|talk=custom text}}	article

Main namespace classes

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

{{pagetype|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:

{{pagetype|class|dab=yes|na=yes}}

{{pagetype|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
{{pagetype|page=United Kingdom}}	article
{{pagetype|page=United Kingdom|dab}}	page
{{pagetype|page=United Kingdom|dab|dab=custom text}}	custom text
{{pagetype|page=United Kingdom|na}}	page
{{pagetype|page=United Kingdom|na|na=custom text}}	custom text

Redirects

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

{{pagetype|redirect=no}}

{{pagetype|redirect=custom text}}

Examples

Code	Result
{{pagetype|page=UK}}	article
{{pagetype|page=UK|redirect=no}}	article
{{pagetype|page=UK|redirect=custom text}}	article

Other namespaces

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

{{pagetype|other=custom text}}

Examples

Code	Result
{{pagetype|page=ShadowrunWiki:Namespace}}	article
{{pagetype|page=ShadowrunWiki:Namespace|other=custom text}}	article
{{pagetype|page=ShadowrunWiki:Namespace|other=custom text|ShadowrunWiki=ShadowrunWiki-space text}}	article

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
{{pagetype|page=United Kingdom}}	article
{{pagetype|page=United Kingdom|plural=y}}	articles
{{pagetype|page=Category:Books}}	category
{{pagetype|page=Category:Books|plural=y}}	categories

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
{{pagetype|page=United Kingdom}}	article
{{pagetype|page=United Kingdom|caps=y}}	Article
{{pagetype|page=United Kingdom|plural=y|caps=y}}	Articles

TemplateData

This template Identifies the type of a given page. It is highly customisable. By default it detects redirects, articles, files, templates, categories, and modules, and other types of page are displayed as "page".

Template parameters

Parameter		Description	Type	Status
Class	1	Class is used to distinguish between different non-article pages in mainspace. 'disambig', 'disamb', 'dab', 'na' and 'n/a' give "page". The values can be customised with the "dab" and "na" parameters.	String	optional
Page name	page	The name of the page to detect the type of. Defaults to the current subject page, or to the current page if the "talk" parameter is activated.	Page name	optional
Main namespace	main	Adjust output for the main namespace. Use "yes" to enable with the output "article", "no" to disable, and other text to enable with custom output. Enabled by default.	String	optional
User namespace	user	Adjust output for the User namespace. Use "yes" to enable with the output "user page", "no" to disable, and other text to enable with custom output. Disabled by default.	String	optional
ShadowrunWiki namespace	ShadowrunWiki project wp	Adjust output for the ShadowrunWiki namespace. Use "yes" to enable with the output "project page", "no" to disable, and other text to enable with custom output. Disabled by default.	String	optional
File namespace	file image	Adjust output for the File namespace. Use "yes" to enable with the output "file", "no" to disable, and other text to enable with custom output. Enabled by default.	String	optional
MediaWiki namespace	mediawiki	Adjust output for the MediaWiki namespace. Use "yes" to enable with the output "interface page", "no" to disable, and other text to enable with custom output. Disabled by default.	String	optional
Template namespace	template	Adjust output for the Template namespace. Use "yes" to enable with the output "template", "no" to disable, and other text to enable with custom output. Enabled by default.	String	optional
Help namespace	help	Adjust output for the Help namespace. Use "yes" to enable with the output "help page", "no" to disable, and other text to enable with custom output. Disabled by default.	String	optional
Category namespace	category	Adjust output for the Category namespace. Use "yes" to enable with the output "category", "no" to disable, and other text to enable with custom output. Enabled by default.	String	optional
Portal namespace	portal	Adjust output for the Portal namespace. Use "yes" to enable with the output "portal", "no" to disable, and other text to enable with custom output. Disabled by default.	String	optional
TimedText namespace	timedtext	Adjust output for the TimedText namespace. Use "yes" to enable with the output "Timed Text page", "no" to disable, and other text to enable with custom output. Disabled by default.	String	optional
Module namespace	module	Adjust output for the Module namespace. Use "yes" to enable with the output "module", "no" to disable, and other text to enable with custom output. Enabled by default.	String	optional
Special namespace	special	Adjust output for the Special namespace. Use "yes" to enable with the output "special page", "no" to disable, and other text to enable with custom output. Disabled by default.	String	optional
Media namespace	media	Adjust output for the Media namespace. Use "yes" to enable with the output "file", "no" to disable, and other text to enable with custom output. Disabled by default.	String	optional
All talk namespaces	talk	Adjust output for all talk namespaces. Normally this template uses the subject page of the specified page to determine the pagetype, but if this parameter is enabled talk pages will be used as well. Use "yes" to enable with the output "talk page", "no" to disable, and other text to enable with custom output. Disabled by default.	String	optional
Disambiguation page value	dab	Adjust output for pages in mainspace when the "Class" parameter has been set to "disambiguation", "disamb", or "dab". Use "yes" to enable with the output "disambiguation page", "no" to disable, and other text to enable with custom output. Disabled by default.	String	optional
N/A page value	na	Adjust output for pages in mainspace when the "Class" parameter has been set to "disambiguation", "disamb", or "dab". Use "yes" to enable with the output "page", "no" to disable, and other text to enable with custom output. Disabled by default.	String	optional
Other namespaces	other	By default the template outputs the text "page" if the page is in a namespace that has not been specified. This value can be changed by using this parameter.	String	optional
Set of default namespaces	defaultns	This parameter is used to specify the set of namespaces used by default. By default the template detects page types in the main, File, Template, Category, and Module namespaces. If this parameter is set to "none", the template doesn't detect page types in any namespaces. If it is set to "extended", the template detects page types in the main, User, ShadowrunWiki, File, MediaWiki, Template, Help, Category, Portal, and Module namespaces. If it is set to "all", the template detects page types in all namespaces, including talk pages. The namespaces set by this parameter can be overridden by the parameters for individual namespaces.	Line	optional
Pluralise output?	plural	Setting this value to "true", "yes", "y" or similar will result in the output from the template being in plural form (e.g. "articles" instead of "article").	Boolean	optional
Capitalise output?	caps	Setting this value to "true", "yes", "y" or similar will result in the output from the template beginning with a capital letter (e.g. "Article" instead of "article").	Boolean	optional

The above documentation is transcluded from Template:Pagetype/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.