Template:Pagetype

From MediaWiki.org
Jump to navigation Jump to search

template

Template documentation

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[edit]

Basic code
{{pagetype}}
Full code
{{pagetype
| page              = 
| defaultns         = 
| main              = 
| user              = 
| wikipedia         = 
| project           = 
| wp                = 
| file              = 
| image             = 
| mediawiki         = 
| template          = 
| help              = 
| category          = 
| portal            = 
| book              = 
| education program = 
| timedtext         = 
| module            = 
| special           = 
| media             = 
| talk              = 
| redirect          = 
| dab               = 
| na                = 
| other             = 
}}

Basic usage[edit]

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
Book namespace book
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[edit]

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=Wikipedia:Namespace}} redirect
{{pagetype|page=TimedText:Imagine.ogg.en.srt}} article

Adding and removing namespaces[edit]

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
| wikipedia         = yes
| project           = yes
| wp                = yes
| mediawiki         = yes
| help              = yes
| portal            = yes
| education program = 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
Wikipedia namespace project page
MediaWiki namespace interface page
Help namespace help page
Portal namespace portal
Education program namespace education program page
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
| 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
{{pagetype|page=Wikipedia:Namespace}} redirect
{{pagetype|page=Wikipedia:Namespace|wikipedia=yes}} redirect
{{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[edit]

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 Yes Yes Yes article
User N Yes Yes N user page
Wikipedia N Yes Yes N project page
File N Yes Yes Yes file
MediaWiki N Yes Yes N interface page
Template N Yes Yes Yes template
Help N Yes Yes N help page
Category N Yes Yes Yes category
Portal N Yes Yes N portal
Book N Yes Yes Yes book
Education Program N N Yes N education program page
TimedText N N Yes N Timed Text page
Module N Yes Yes Yes module
All talk namespaces N N Yes N talk page
Special N N Yes N special page
Media N N Yes 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=Wikipedia:Namespace}} redirect
{{pagetype|page=Wikipedia:Namespace|defaultns=extended}} redirect
{{pagetype|page=TimedText:Imagine.ogg.en.srt|defaultns=extended}} article
{{pagetype|page=TimedText:Imagine.ogg.en.srt|defaultns=all}} article

Custom namespace values[edit]

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

{{pagetype
| 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
| education program = custom text
| timedtext         = custom text
| module            = custom text
| special           = custom text
| media             = custom text
}}
Examples
Code Result
{{pagetype|page=Wikipedia:Namespace}} redirect
{{pagetype|page=Wikipedia:Namespace|wikipedia=custom text}} redirect
{{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[edit]

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 Wikipedia 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=Wikipedia talk:Namespace}} article
{{pagetype|page=Wikipedia talk:Namespace|wikipedia=yes}} article
{{pagetype|page=Wikipedia talk:Namespace|talk=yes}} article
{{pagetype|page=Wikipedia talk:Namespace|wikipedia=yes|talk=yes}} article
{{pagetype|page=Wikipedia talk:Namespace|talk=custom text}} article
{{pagetype|page=Wikipedia talk:Namespace|wikipedia=yes|talk=custom text}} article

Main namespace classes[edit]

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[edit]

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[edit]

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[edit]

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=Wikipedia:Namespace}} redirect
{{pagetype|page=Wikipedia:Namespace|other=custom text}} redirect
{{pagetype|page=Wikipedia:Namespace|other=custom text|wikipedia=wikipedia-space text}} redirect

TemplateData[edit]