Module:Pagetype/doc#Main namespace classes

{{high use}}

{{module rating|protected}}

{{cascade-protected template|page=module}}

{{Lua|Module:Arguments|Module:Disambiguation|Module:Namespace detect|Module:Pagetype/config|Module:Yesno}}

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 {{tl|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 =

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

{{#invoke:pagetype|main}}

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

class="wikitable"

! Page type / namespace !! Output

Redirects (in any namespace)redirect
Main namespacearticle
File namespacefile
Template namespacetemplate
Category namespacecategory
Module namespacemodule
Other namespacespage

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

; Example

class="wikitable"
CodeResult
{{#invoke:pagetype|main}}{{#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

class="wikitable"
CodeResult
{{#invoke:pagetype|main|page=United Kingdom}}{{#invoke:pagetype|main|page=United Kingdom}}
{{#invoke:pagetype|main|page=UK}}{{#invoke:pagetype|main|page=UK}}
{{#invoke:pagetype|main|page=Talk:United Kingdom}}{{#invoke:pagetype|main|page=Talk:United Kingdom}}
{{#invoke:pagetype|main|page=File:Example.svg}}{{#invoke:pagetype|main|page=File:Example.svg}}
{{#invoke:pagetype|main|page=Wikipedia:Namespace}}{{#invoke:pagetype|main|page=Wikipedia:Namespace}}
{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt}}{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).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 {{para|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

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

class="wikitable"

! Page type / namespace !! Output

User namespaceuser page
Wikipedia namespaceproject page
MediaWiki namespaceinterface page
Help namespacehelp page
Portal namespaceportal
Draft namespacedraft
Timed Text namespaceTimed Text page
Topic namespacetopic
Special namespacespecial page
Media namespacefile

You can use a similar process to remove any of the default namespace values as well. For example, if you use the code {{para|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

}}

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

class="wikitable"
CodeResult
{{#invoke:pagetype|main|page=Wikipedia:Namespace}}{{#invoke:pagetype|main|page=Wikipedia:Namespace}}
{{#invoke:pagetype|main|page=Wikipedia:Namespace|wikipedia=yes}}{{#invoke:pagetype|main|page=Wikipedia:Namespace|wikipedia=yes}}
{{#invoke:pagetype|main|page=Talk:United Kingdom}}{{#invoke:pagetype|main|page=Talk:United Kingdom}}
{{#invoke:pagetype|main|page=Talk:United Kingdom|talk=y}}{{#invoke:pagetype|main|page=Talk:United Kingdom|talk=y}}
{{#invoke:pagetype|main|page=United Kingdom}}{{#invoke:pagetype|main|page=United Kingdom}}
{{#invoke:pagetype|main|page=United Kingdom|main=no}}{{#invoke:pagetype|main|page=United Kingdom|main=no}}
{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt}}{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt}}
{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt|timedtext=Yes}}{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).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 {{para|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:

class="wikitable"
rowspan="2" | Namespace

! colspan="4" | Value of {{para|defaultns}}

! rowspan="2" | Output

style="width: 75px; text-align: center;" | none

| style="width: 75px; text-align: center;" | extended

| style="width: 75px; text-align: center;" | all

| style="width: 75px; text-align: center;" | Other values

Main

| style="text-align: center;" | {{cross}}

| style="text-align: center;" | {{tick}}

| style="text-align: center;" | {{tick}}

| style="text-align: center;" | {{tick}}

| article

User

| style="text-align: center;" | {{cross}}

| style="text-align: center;" | {{tick}}

| style="text-align: center;" | {{tick}}

| style="text-align: center;" | {{cross}}

| user page

Wikipedia

| style="text-align: center;" | {{cross}}

| style="text-align: center;" | {{tick}}

| style="text-align: center;" | {{tick}}

| style="text-align: center;" | {{cross}}

| project page

File

| style="text-align: center;" | {{cross}}

| style="text-align: center;" | {{tick}}

| style="text-align: center;" | {{tick}}

| style="text-align: center;" | {{tick}}

| file

MediaWiki

| style="text-align: center;" | {{cross}}

| style="text-align: center;" | {{tick}}

| style="text-align: center;" | {{tick}}

| style="text-align: center;" | {{cross}}

| interface page

Template

| style="text-align: center;" | {{cross}}

| style="text-align: center;" | {{tick}}

| style="text-align: center;" | {{tick}}

| style="text-align: center;" | {{tick}}

| template

Help

| style="text-align: center;" | {{cross}}

| style="text-align: center;" | {{tick}}

| style="text-align: center;" | {{tick}}

| style="text-align: center;" | {{cross}}

| help page

Category

| style="text-align: center;" | {{cross}}

| style="text-align: center;" | {{tick}}

| style="text-align: center;" | {{tick}}

| style="text-align: center;" | {{tick}}

| category

Portal

| style="text-align: center;" | {{cross}}

| style="text-align: center;" | {{tick}}

| style="text-align: center;" | {{tick}}

| style="text-align: center;" | {{cross}}

| portal

Draft

| style="text-align: center;" | {{cross}}

| style="text-align: center;" | {{tick}}

| style="text-align: center;" | {{tick}}

| style="text-align: center;" | {{cross}}

| draft

TimedText

| style="text-align: center;" | {{cross}}

| style="text-align: center;" | {{cross}}

| style="text-align: center;" | {{tick}}

| style="text-align: center;" | {{cross}}

| Timed Text page

Module

| style="text-align: center;" | {{cross}}

| style="text-align: center;" | {{tick}}

| style="text-align: center;" | {{tick}}

| style="text-align: center;" | {{tick}}

| module

Topic (Flow boards)

| style="text-align: center;" | {{cross}}

| style="text-align: center;" | {{cross}}

| style="text-align: center;" | {{tick}}

| style="text-align: center;" | {{cross}}

| topic

All talk namespaces

| style="text-align: center;" | {{cross}}

| style="text-align: center;" | {{cross}}

| style="text-align: center;" | {{tick}}

| style="text-align: center;" | {{cross}}

| talk page

Special

| style="text-align: center;" | {{cross}}

| style="text-align: center;" | {{cross}}

| style="text-align: center;" | {{tick}}

| style="text-align: center;" | {{cross}}

| special page

Media

| style="text-align: center;" | {{cross}}

| style="text-align: center;" | {{cross}}

| style="text-align: center;" | {{tick}}

| style="text-align: center;" | {{cross}}

| file

; Examples

class="wikitable"
CodeResult
{{#invoke:pagetype|main|page=United Kingdom}}{{#invoke:pagetype|main|page=United Kingdom}}
{{#invoke:pagetype|main|page=United Kingdom|defaultns=none}}{{#invoke:pagetype|main|page=United Kingdom|defaultns=none}}
{{#invoke:pagetype|main|page=Talk:United Kingdom}}{{#invoke:pagetype|main|page=Talk:United Kingdom}}
{{#invoke:pagetype|main|page=Talk:United Kingdom|defaultns=all}}{{#invoke:pagetype|main|page=Talk:United Kingdom|defaultns=all}}
{{#invoke:pagetype|main|page=File:Example.svg}}{{#invoke:pagetype|main|page=File:Example.svg}}
{{#invoke:pagetype|main|page=File:Example.svg|defaultns=none}}{{#invoke:pagetype|main|page=File:Example.svg|defaultns=none}}
{{#invoke:pagetype|main|page=Wikipedia:Namespace}}{{#invoke:pagetype|main|page=Wikipedia:Namespace}}
{{#invoke:pagetype|main|page=Wikipedia:Namespace|defaultns=extended}}{{#invoke:pagetype|main|page=Wikipedia:Namespace|defaultns=extended}}
{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt|defaultns=extended}}{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt|defaultns=extended}}
{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt|defaultns=all}}{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).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

| draft = custom text

| timedtext = custom text

| module = custom text

| topic = custom text

| special = custom text

| media = custom text

}}

; Examples

class="wikitable"
CodeResult
{{#invoke:pagetype|main|page=Wikipedia:Namespace}}{{#invoke:pagetype|main|page=Wikipedia:Namespace}}
{{#invoke:pagetype|main|page=Wikipedia:Namespace|wikipedia=custom text}}{{#invoke:pagetype|main|page=Wikipedia:Namespace|wikipedia=custom text}}
{{#invoke:pagetype|main|page=Talk:United Kingdom}}{{#invoke:pagetype|main|page=Talk:United Kingdom}}
{{#invoke:pagetype|main|page=Talk:United Kingdom|talk=custom text}}{{#invoke:pagetype|main|page=Talk:United Kingdom|talk=custom text}}
{{#invoke:pagetype|main|page=United Kingdom}}{{#invoke:pagetype|main|page=United Kingdom}}
{{#invoke:pagetype|main|page=United Kingdom|main=custom text}}{{#invoke:pagetype|main|page=United Kingdom|main=custom text}}
{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt}}{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt}}
{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt|timedtext=custom text}}{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).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

class="wikitable"
CodeResult
{{#invoke:pagetype|main|page=Wikipedia talk:Namespace}}{{#invoke:pagetype|main|page=Wikipedia talk:Namespace}}
{{#invoke:pagetype|main|page=Wikipedia talk:Namespace|wikipedia=yes}}{{#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|talk=yes}}
{{#invoke:pagetype|main|page=Wikipedia talk:Namespace|wikipedia=yes|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|talk=custom text}}
{{#invoke:pagetype|main|page=Wikipedia talk:Namespace|wikipedia=yes|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="wikitable"
ClassClass valuesOutput
No applicable classna, n/apage

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|na=yes}}

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

; Examples

class="wikitable"
CodeResult
{{#invoke:pagetype|main|page=United Kingdom}}{{#invoke:pagetype|main|page=United Kingdom}}
{{#invoke:pagetype|main|page=United Kingdom|na}}{{#invoke:pagetype|main|page=United Kingdom|na}}
{{#invoke:pagetype|main|page=United Kingdom|na|na=custom text}}{{#invoke:pagetype|main|page=United Kingdom|na|na=custom text}}

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

class="wikitable"
CodeResult
{{#invoke:pagetype|main|page=UK}}{{#invoke:pagetype|main|page=UK}}
{{#invoke:pagetype|main|page=UK|redirect=no}}{{#invoke:pagetype|main|page=UK|redirect=no}}
{{#invoke:pagetype|main|page=UK|redirect=custom text}}{{#invoke:pagetype|main|page=UK|redirect=custom text}}

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.

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

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

; Examples

class="wikitable"
CodeResult
{{#invoke:pagetype|main|page=Mercury}}{{#invoke:pagetype|main|page=Mercury}}
{{#invoke:pagetype|main|page=Mercury|dab=no}}{{#invoke:pagetype|main|page=Mercury|dab=no}}
{{#invoke:pagetype|main|page=Mercury|dab=custom text}}{{#invoke:pagetype|main|page=Mercury|dab=custom text}}

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 {{para|other}} parameter:

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

; Examples

class="wikitable"
CodeResult
{{#invoke:pagetype|main|page=Wikipedia:Namespace}}{{#invoke:pagetype|main|page=Wikipedia:Namespace}}
{{#invoke:pagetype|main|page=Wikipedia:Namespace|other=custom text}}{{#invoke:pagetype|main|page=Wikipedia:Namespace|other=custom text}}
{{#invoke:pagetype|main|page=Wikipedia:Namespace|other=custom text|wikipedia=wikipedia-space 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 {{para|plural|y}} returns the plural form.

class="wikitable"
CodeResult
{{#invoke:pagetype|main|page=United Kingdom}}{{#invoke:pagetype|main|page=United Kingdom}}
{{#invoke:pagetype|main|page=United Kingdom|plural=y}}{{#invoke:pagetype|main|page=United Kingdom|plural=y}}
{{#invoke:pagetype|main|page=Category:Books}}{{#invoke:pagetype|main|page=Category:Books}}
{{#invoke:pagetype|main|page=Category:Books|plural=y}}{{#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 {{para|caps|y}} returns a version with a capital letter at the start.

class="wikitable"
CodeResult
{{#invoke:pagetype|main|page=United Kingdom}}{{#invoke:pagetype|main|page=United Kingdom}}
{{#invoke:pagetype|main|page=United Kingdom|caps=y}}{{#invoke:pagetype|main|page=United Kingdom|caps=y}}
{{#invoke:pagetype|main|page=United Kingdom|plural=y|caps=y}}{{#invoke:pagetype|main|page=United Kingdom|plural=y|caps=y}}