Module:Pagetype
- Afrikaans
- Аԥсшәа
- العربية
- Asturianu
- Авар
- تۆرکجه
- Basa Bali
- বাংলা
- 閩南語 / Bân-lâm-gí
- Башҡортса
- Беларуская
- Беларуская (тарашкевіца)
- भोजपुरी
- Bikol Central
- Български
- བོད་ཡིག
- Bosanski
- Català
- Cebuano
- Chavacano de Zamboanga
- ChiTumbuka
- Corsu
- Dansk
- الدارجة
- Ελληνικά
- Eʋegbe
- فارسی
- Fiji Hindi
- Gaelg
- Galego
- Gĩkũyũ
- ગુજરાતી
- गोंयची कोंकणी / Gõychi Konknni
- 한국어
- Հայերեն
- हिन्दी
- Hrvatski
- Ilokano
- বিষ্ণুপ্রিয়া মণিপুরী
- Bahasa Indonesia
- Jawa
- ಕನ್ನಡ
- ქართული
- Қазақша
- Ikirundi
- Kiswahili
- Kurdî
- Ladin
- ລາວ
- Latviešu
- Македонски
- Malagasy
- മലയാളം
- Malti
- مصرى
- ဘာသာမန်
- Bahasa Melayu
- Мокшень
- Монгол
- မြန်မာဘာသာ
- Na Vosa Vakaviti
- Nedersaksies
- नेपाली
- 日本語
- Нохчийн
- ଓଡ଼ିଆ
- Oromoo
- Oʻzbekcha / ўзбекча
- ပအိုဝ်ႏဘာႏသာႏ
- Português
- Qaraqalpaqsha
- Română
- Русский
- Gagana Samoa
- ᱥᱟᱱᱛᱟᱲᱤ
- Scots
- Setswana
- Shqip
- සිංහල
- Simple English
- سنڌي
- Slovenščina
- کوردی
- Српски / srpski
- Tagalog
- தமிழ்
- Taclḥit
- Taqbaylit
- တႆး
- తెలుగు
- ไทย
- ትግርኛ
- Türkmençe
- Українська
- اردو
- Tiếng Việt
- Winaray
- 吴语
- 粵語
- Zazaki
- 中文
- Batak Toba
To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.
See the protection policy and protection log for more details. Please discuss any changes on the talk page; you may submit an edit request to ask an administrator to make an edit if it is uncontroversial or supported by consensus. You may also request that this page be unprotected.
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 = | 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:
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 |
---|---|
{{#invoke:pagetype|main}} |
module |
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}} |
article |
{{#invoke:pagetype|main|page=UK}} |
redirect |
{{#invoke:pagetype|main|page=Talk:United Kingdom}} |
article |
{{#invoke:pagetype|main|page=File:Example.svg}} |
file |
{{#invoke:pagetype|main|page=Wikipedia:Namespace}} |
page |
{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt}} |
page |
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 | 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
|
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 }}
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}} |
page |
{{#invoke:pagetype|main|page=Wikipedia:Namespace|wikipedia=yes}} |
project page |
{{#invoke:pagetype|main|page=Talk:United Kingdom}} |
article |
{{#invoke:pagetype|main|page=Talk:United Kingdom|talk=y}} |
talk page |
{{#invoke:pagetype|main|page=United Kingdom}} |
article |
{{#invoke:pagetype|main|page=United Kingdom|main=no}} |
page |
{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt}} |
page |
{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt|timedtext=Yes}} |
Timed Text page |
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 | checkY | checkY | checkY | article |
User | ☒N | checkY | checkY | ☒N | user page |
Wikipedia | ☒N | checkY | checkY | ☒N | project page |
File | ☒N | checkY | checkY | checkY | file |
MediaWiki | ☒N | checkY | checkY | ☒N | interface page |
Template | ☒N | checkY | checkY | checkY | template |
Help | ☒N | checkY | checkY | ☒N | help page |
Category | ☒N | checkY | checkY | checkY | category |
Portal | ☒N | checkY | checkY | ☒N | portal |
Draft | ☒N | checkY | checkY | ☒N | draft |
TimedText | ☒N | ☒N | checkY | ☒N | Timed Text page |
Module | ☒N | checkY | checkY | checkY | module |
Topic (Flow boards) | ☒N | ☒N | checkY | ☒N | topic |
All talk namespaces | ☒N | ☒N | checkY | ☒N | talk page |
Special | ☒N | ☒N | checkY | ☒N | special page |
Media | ☒N | ☒N | checkY | ☒N | file |
- Examples
Code | Result |
---|---|
{{#invoke:pagetype|main|page=United Kingdom}} |
article |
{{#invoke:pagetype|main|page=United Kingdom|defaultns=none}} |
page |
{{#invoke:pagetype|main|page=Talk:United Kingdom}} |
article |
{{#invoke:pagetype|main|page=Talk:United Kingdom|defaultns=all}} |
talk page |
{{#invoke:pagetype|main|page=File:Example.svg}} |
file |
{{#invoke:pagetype|main|page=File:Example.svg|defaultns=none}} |
page |
{{#invoke:pagetype|main|page=Wikipedia:Namespace}} |
page |
{{#invoke:pagetype|main|page=Wikipedia:Namespace|defaultns=extended}} |
project page |
{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt|defaultns=extended}} |
page |
{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt|defaultns=all}} |
Timed Text page |
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
Code | Result |
---|---|
{{#invoke:pagetype|main|page=Wikipedia:Namespace}} |
page |
{{#invoke:pagetype|main|page=Wikipedia:Namespace|wikipedia=custom text}} |
custom text |
{{#invoke:pagetype|main|page=Talk:United Kingdom}} |
article |
{{#invoke:pagetype|main|page=Talk:United Kingdom|talk=custom text}} |
custom text |
{{#invoke:pagetype|main|page=United Kingdom}} |
article |
{{#invoke:pagetype|main|page=United Kingdom|main=custom text}} |
custom text |
{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt}} |
page |
{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt|timedtext=custom text}} |
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}} |
page |
{{#invoke:pagetype|main|page=Wikipedia talk:Namespace|wikipedia=yes}} |
project page |
{{#invoke:pagetype|main|page=Wikipedia talk:Namespace|talk=yes}} |
talk page |
{{#invoke:pagetype|main|page=Wikipedia talk:Namespace|wikipedia=yes|talk=yes}} |
talk page |
{{#invoke:pagetype|main|page=Wikipedia talk:Namespace|talk=custom text}} |
custom text |
{{#invoke:pagetype|main|page=Wikipedia talk:Namespace|wikipedia=yes|talk=custom text}} |
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 |
---|---|---|
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|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
Code | Result |
---|---|
{{#invoke:pagetype|main|page=United Kingdom}} |
article |
{{#invoke:pagetype|main|page=United Kingdom|na}} |
page |
{{#invoke:pagetype|main|page=United Kingdom|na|na=custom text}} |
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
Code | Result |
---|---|
{{#invoke:pagetype|main|page=UK}} |
redirect |
{{#invoke:pagetype|main|page=UK|redirect=no}} |
article |
{{#invoke:pagetype|main|page=UK|redirect=custom text}} |
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
Code | Result |
---|---|
{{#invoke:pagetype|main|page=Mercury}} |
page |
{{#invoke:pagetype|main|page=Mercury|dab=no}} |
article |
{{#invoke:pagetype|main|page=Mercury|dab=custom text}} |
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 |other=
parameter:
{{#invoke:pagetype|main|other=custom text}}
- Examples
Code | Result |
---|---|
{{#invoke:pagetype|main|page=Wikipedia:Namespace}} |
page |
{{#invoke:pagetype|main|page=Wikipedia:Namespace|other=custom text}} |
custom text |
{{#invoke:pagetype|main|page=Wikipedia:Namespace|other=custom text|wikipedia=wikipedia-space text}} |
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}} |
article |
{{#invoke:pagetype|main|page=United Kingdom|plural=y}} |
articles |
{{#invoke:pagetype|main|page=Category:Books}} |
category |
{{#invoke:pagetype|main|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 |
---|---|
{{#invoke:pagetype|main|page=United Kingdom}} |
article |
{{#invoke:pagetype|main|page=United Kingdom|caps=y}} |
Article |
{{#invoke:pagetype|main|page=United Kingdom|plural=y|caps=y}} |
Articles |
Editors can experiment in this module's sandbox (edit | diff) and testcases (edit | run) pages.
Subpages of this module.
-------------------------------------------------------------------------------- -- -- -- This meta-module which automatically detects namespaces, and allows -- -- for a great deal of customisation. It can easily be ported to other -- -- wikis by changing the values in the [[Module:Pagetype/config]]. -- -- -- -------------------------------------------------------------------------------- -- Load config. localcfg=mw.loadData('Module:Pagetype/config') -- Load required modules. localyesno=require('Module:Yesno') localp={} -- Look up a namespace argument in the args table. localfunctionlookUpNamespaceArg(args,key) localarg=args[key] -- Convert "yes", "1" etc. to true, "no", "0" etc. to false, and leave -- other values the same. returnyesno(arg,arg) end -- Append multiple values to an array localfunctionappendMultiple(target,source) for_,valueinipairs(source)do table.insert(target,value) end end -- Get argument keys for a title's namespace localfunctiongetNamespaceArgKeys(title) localnsInfo=mw.site.namespaces[title.namespace] localcustomAliases=cfg.customNamespaceAliases[title.namespace]or{} localkeys={} ifnsInfo.name~=''then table.insert(keys,nsInfo.name) end ifnsInfo.canonicalName~=nsInfo.nameandnsInfo.canonicalName~=''then table.insert(keys,nsInfo.canonicalName) end appendMultiple(keys,nsInfo.aliases) appendMultiple(keys,customAliases) returnkeys end -- Get the argument for a title's namespace, if it was specified in the args table. localfunctiongetNamespaceArg(title,args) iftitle.isTalkPagethen returnlookUpNamespaceArg(args,cfg.talk) end for_,keyinipairs(getNamespaceArgKeys(title))do localarg=lookUpNamespaceArg(args,mw.ustring.lower(key)) ifarg~=nilthen returnarg end end returnnil end -- Look up a page type specific to the title's namespace localfunctiongetExplicitPageType(title) iftitle.isTalkPagethen returncfg.talkDefault else returncfg.pagetypes[title.namespace] end end -- Get a default page type that is not specific to the title's namespace localfunctiongetDefaultPageType(args) localother=lookUpNamespaceArg(args,cfg.other) iftype(other)=='string'then returnother else returncfg.otherDefault end end localfunctiondetectRedirects(title,args) localredirect=lookUpNamespaceArg(args,cfg.redirect) ifredirect==falsethen -- Don't detect redirects if they have been specifically disallowed. returnnil end -- Allow custom values for redirects. ifnottitle.isRedirectthen returnnil elseiftype(redirect)=='string'then returnredirect else returncfg.redirectDefault end end localfunctioncapitalize(pageType) localfirst=mw.ustring.sub(pageType,1,1) localrest=mw.ustring.sub(pageType,2) returnmw.ustring.upper(first)..rest end localfunctionpluralize(pageType) ifcfg.irregularPlurals[pageType]then returncfg.irregularPlurals[pageType] else returnpageType..cfg.plural-- often 's' end end localfunctionparseContent(title,args,optionsList) iftitle.namespace==828andtitle.subpageText~='doc'-- don't detect modules ornottitle.exists-- can't check unless page exists then returnnil end localcontent=title:getContent() ifcontent==nilthen returnnil end localtemplates-- lazily evaluated for_,optionsinnext,optionsListdo locallist,parameter,default,articleOnly=unpack(options,1,4) ifnotarticleOnlyortitle.namespace==0then-- only check for templates if we should... localout=lookUpNamespaceArg(args,parameter) iftype(out)=="string"or(out~=falseanddefault)then-- ...and if we actually have anything to say about them ifnottemplatesthen templates={}-- do our delayed evaluation now that we are required to content=require('Module:Wikitext Parsing').PrepareText(content)-- disregard templates which do not have any affect fortemplateinstring.gmatch(content,"{{%s*([^|}]-)%s*[|}]")do templates[#templates+1]=capitalize(template) end end localwantedTemplates=mw.loadData('Module:Pagetype/'..list) localtemplateFound=false for_,templateinnext,templatesdo ifwantedTemplates[template]then templateFound=true break end end iftemplateFoundthen iftype(out)=='string'then returnout elseifout~=falseanddefaultthen returndefault end end end end end end -- Find pages which do not exist localfunctionnonExistent(title,args) localarg=lookUpNamespaceArg(args,cfg.ne) ifarg==falsethen returnnil end localexists=false iftitle.existsthen-- not an article if it does not exist exists=true elseiftitle.namespace==8andmw.message.new(title.text):exists()then exists=true elseiftitle.namespace==6andtitle.fileExiststhen exists=true end ifnotexiststhen iftype(arg)=='string'then returnarg else returncfg.naDefault end end end -- Get page types for mainspaces pages with an explicit class specified localfunctiongetMainNamespaceClassPageType(title,args) localclass=args[1] iftype(class)=='string'then-- Put in lower case so e.g. "na" and "NA" will both match class=mw.ustring.lower(class) end localarg=lookUpNamespaceArg(args,cfg.na) ifarg==falsethen-- don't check for this class if it is specifically disallowed returnnil end ifcfg.naAliases[class]then iftype(arg)=='string'then returnarg else returncfg.naDefault end else returnnil end end -- Get page type specified by an explicit namespace argument. localfunctiongetNamespaceArgPageType(title,args) localnamespaceArg=getNamespaceArg(title,args) ifnamespaceArg==truethen -- Namespace has been explicitly enabled, so return the default for -- this namespace returngetExplicitPageType(title) elseifnamespaceArg==falsethen -- Namespace has been explicitly disabled returngetDefaultPageType(args) elseifnamespaceArgthen -- This namespaces uses custom text returnnamespaceArg else returnnil end end -- Get page type not specified or detected by other means localfunctiongetOtherPageType(title,args) -- Whether the title is in the set of default active namespaces which are looked up in cfg.pagetypes. localisInDefaultActiveNamespace=false localdefaultNamespacesKey=args[cfg.defaultns] ifdefaultNamespacesKey==cfg.defaultnsAllthen isInDefaultActiveNamespace=true else localdefaultNamespaces ifdefaultNamespacesKey==cfg.defaultnsExtendedthen defaultNamespaces=cfg.extendedNamespaces elseifdefaultNamespacesKey==cfg.defaultnsNonethen defaultNamespaces={} else defaultNamespaces=cfg.defaultNamespaces end isInDefaultActiveNamespace=defaultNamespaces[title.namespace] end ifisInDefaultActiveNamespacethen returngetExplicitPageType(title) else returngetDefaultPageType(args) end end functionp._main(args) localtitle ifargs.pagethen title=mw.title.new(args.page) else title=mw.title.getCurrentTitle() end iftitleandnotyesno(args.talk,true)andargs[cfg.defaultns]~=cfg.defaultnsAllthen title=title.subjectPageTitle end localpageType=detectRedirects(title,args) ornonExistent(title,args) orparseContent(title,args,{ {'softredirect',cfg.softRedirect,cfg.softRedirectDefault}, {'setindex',cfg.sia,cfg.siaDefault,true}, {'disambiguation',cfg.dab,cfg.dabDefault,true}, {'rfd',cfg.rfd,cfg.rfdDefault}, }) or(title.namespace==0andgetMainNamespaceClassPageType(title,args)) orgetNamespaceArgPageType(title,args) orgetOtherPageType(title,args) ifyesno(args.plural,false)then pageType=pluralize(pageType) end ifyesno(args.caps,false)then pageType=capitalize(pageType) end returnpageType end functionp.main(frame) localargs=require('Module:Arguments').getArgs(frame) returnp._main(args) end returnp