Module:Pagetype
This Lua module is used on approximately 16,500,000 pages, or roughly 1515152% of all pages. 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. |
This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
Lua error in Module:Lua_banner at line 113: attempt to index field 'edit' (a nil value).
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 = | 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
|
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}} |
article |
{{#invoke:pagetype|main|page=Talk:United Kingdom}} |
article |
{{#invoke:pagetype|main|page=File:Example.svg}} |
file |
{{#invoke:pagetype|main|page=Wikipedia:Namespace}} |
article |
{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).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 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}} |
article |
{{#invoke:pagetype|main|page=Wikipedia:Namespace|wikipedia=yes}} |
article |
{{#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}} |
article |
{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).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 | article | ||||
User | user page | ||||
Wikipedia | project page | ||||
File | file | ||||
MediaWiki | interface page | ||||
Template | template | ||||
Help | help page | ||||
Category | category | ||||
Portal | portal | ||||
Draft | draft | ||||
TimedText | Timed Text page | ||||
Module | module | ||||
Topic (Flow boards) | topic | ||||
All talk namespaces | talk page | ||||
Special | special page | ||||
Media | 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}} |
article |
{{#invoke:pagetype|main|page=Wikipedia:Namespace|defaultns=extended}} |
article |
{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt|defaultns=extended}} |
article |
{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt|defaultns=all}} |
article |
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}} |
article |
{{#invoke:pagetype|main|page=Wikipedia:Namespace|wikipedia=custom text}} |
article |
{{#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}} |
article |
{{#invoke:pagetype|main|page=TimedText:Imagine (John Lennon song - sample).ogg.en.srt|timedtext=custom text}} |
article |
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}} |
article |
{{#invoke:pagetype|main|page=Wikipedia talk:Namespace|wikipedia=yes}} |
article |
{{#invoke:pagetype|main|page=Wikipedia talk:Namespace|talk=yes}} |
article |
{{#invoke:pagetype|main|page=Wikipedia talk:Namespace|wikipedia=yes|talk=yes}} |
article |
{{#invoke:pagetype|main|page=Wikipedia talk:Namespace|talk=custom text}} |
article |
{{#invoke:pagetype|main|page=Wikipedia talk:Namespace|wikipedia=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:
{{#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}} |
article |
{{#invoke:pagetype|main|page=UK|redirect=no}} |
article |
{{#invoke:pagetype|main|page=UK|redirect=custom text}} |
article |
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}} |
article |
{{#invoke:pagetype|main|page=Mercury|dab=no}} |
article |
{{#invoke:pagetype|main|page=Mercury|dab=custom text}} |
article |
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}} |
article |
{{#invoke:pagetype|main|page=Wikipedia:Namespace|other=custom text}} |
article |
{{#invoke:pagetype|main|page=Wikipedia:Namespace|other=custom text|wikipedia=wikipedia-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 |
---|---|
{{#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 |
-------------------------------------------------------------------------------- -- -- -- 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. local cfg = mw.loadData('Module:Pagetype/config') -- Load required modules. local getArgs = require('Module:Arguments').getArgs local yesno = require('Module:Yesno') local p = {} -- Look up a namespace argument in the args table. local function lookUpNamespaceArg(args, key) local arg = args[key] -- Convert "yes", "1" etc. to true, "no", "0" etc. to false, and leave -- other values the same. return yesno(arg, arg) end -- Append multiple values to an array local function appendMultiple(target, source) for _, value in ipairs(source) do table.insert(target, value) end end -- Get argument keys for a title's namespace local function getNamespaceArgKeys(title, cfg) local nsInfo = mw.site.namespaces[title.namespace] local customAliases = cfg.customNamespaceAliases[title.namespace] or {} local keys = {} if nsInfo.name ~= '' then table.insert(keys, nsInfo.name) end if nsInfo.canonicalName ~= nsInfo.name and nsInfo.canonicalName ~= '' then table.insert(keys, nsInfo.canonicalName) end appendMultiple(keys, nsInfo.aliases) appendMultiple(keys, customAliases) return keys end -- Get the argument for a title's namespace, if it was specified in the args table. local function getNamespaceArg(title, args, cfg) if title.isTalkPage then return lookUpNamespaceArg(args, cfg.talk) end for _, key in ipairs(getNamespaceArgKeys(title, cfg)) do local arg = lookUpNamespaceArg(args, mw.ustring.lower(key)) if arg ~= nil then return arg end end return nil end -- Look up a page type specific to the title's namespace local function getExplicitPageType(title, cfg) if title.isTalkPage then return cfg.talkDefault else return cfg.pagetypes[title.namespace] end end -- Get a default page type that is not specific to the title's namespace local function getDefaultPageType(args, cfg) local other = lookUpNamespaceArg(args, cfg.other) if type(other) == 'string' then return other else return cfg.otherDefault end end local function detectRedirects(title, args) local redirect = lookUpNamespaceArg(args, cfg.redirect) if redirect == false then -- Don't detect redirects if they have been specifically disallowed. return nil end -- Allow custom values for redirects. if not title.isRedirect then return nil elseif type(redirect) == 'string' then return redirect else return cfg.redirectDefault end end local function capitalize(pageType) local first = mw.ustring.sub(pageType, 1, 1) local rest = mw.ustring.sub(pageType, 2) return mw.ustring.upper(first) .. rest end local function pluralize(pageType, cfg) if cfg.irregularPlurals[pageType] then return cfg.irregularPlurals[pageType] else return pageType .. cfg.plural -- often 's' end end local function parseContent(title, args, optionsList) if title.namespace==828 and title.subpageText~='doc' -- don't detect modules or not title.exists -- can't check unless page exists then return nil end local content = title:getContent() if content == nil then return nil end local templates -- lazily evaluated for _, options in next, optionsList do local list, parameter, default, articleOnly = unpack(options, 1, 4) if not articleOnly or title.namespace==0 then -- only check for templates if we should... local out = lookUpNamespaceArg(args, parameter) if type(out) == "string" or (out ~= false and default) then -- ...and if we actually have anything to say about them if not templates then 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 for template in string.gmatch(content, "{{%s*([^|}]-)%s*[|}]") do templates[#templates+1] = capitalize(template) end end local wantedTemplates = mw.loadData('Module:Pagetype/' .. list) local templateFound = false for _, template in next, templates do if wantedTemplates[template] then templateFound = true break end end if templateFound then if type(out)=='string' then return out elseif out ~= false and default then return default end end end end end end -- Gets the pagetype from a class specified from the first positional parameter. local function getPageTypeFromClass(args, class, key, aliasTable, default) local arg = lookUpNamespaceArg(args, key) if arg == false then -- Don't check for this class if it is specifically disallowed. return nil end if aliasTable[class] then if type(arg) == 'string' then return arg else return default end end return nil end -- Get page types for mainspaces pages with an explicit class specified local function getMainNamespaceClassPageType(title, args, cfg) if title.namespace ~= 0 then return nil end local class = args[1] if type(class) == 'string' then -- Put in lower case so e.g. "na" and "NA" will both match. class = mw.ustring.lower(class) end return getPageTypeFromClass( args, class, cfg.na, cfg.naAliases, cfg.naDefault ) end -- Get page type specified by an explicit namespace argument. local function getNamespaceArgPageType(title, args, cfg) local namespaceArg = getNamespaceArg(title, args, cfg) if namespaceArg == true then -- Namespace has been explicitly enabled, so return the default for -- this namespace return getExplicitPageType(title, cfg) elseif namespaceArg == false then -- Namespace has been explicitly disabled return getDefaultPageType(args, cfg) elseif namespaceArg then -- This namespaces uses custom text return namespaceArg else return nil end end -- Whether the title is in the set of default active namespaces which are looked up in cfg.pagetypes. local function isInDefaultActiveNamespace(title, args, cfg) local defaultNamespacesKey = args[cfg.defaultns] if defaultNamespacesKey == cfg.defaultnsAll then return true end local defaultNamespaces if defaultNamespacesKey == cfg.defaultnsExtended then defaultNamespaces = cfg.extendedNamespaces elseif defaultNamespacesKey == cfg.defaultnsNone then defaultNamespaces = {} else defaultNamespaces = cfg.defaultNamespaces end return defaultNamespaces[title.namespace] or false end -- Get page type not specified or detected by other means local function getOtherPageType(title, args, cfg) if isInDefaultActiveNamespace(title, args, cfg) then return getExplicitPageType(title, cfg) else return getDefaultPageType(args, cfg) end end local function getPageType(title, args, cfg) return ( detectRedirects(title, args, cfg) or parseContent(title, args, { {'softredirect', cfg.softRedirect, cfg.softRedirectDefault}, {'setindex', cfg.sia, cfg.siaDefault, true}, {'disambiguation', cfg.dab, cfg.dabDefault, true}, }) or getMainNamespaceClassPageType(title, args, cfg) or getNamespaceArgPageType(title, args, cfg) or getOtherPageType(title, args, cfg) ) end local function shouldUseSubjectTitle(args, cfg) return not yesno(args.talk, true) and args[cfg.defaultns] ~= cfg.defaultnsAll end -- Get the Scribunto title object to fetch the page type of local function getTitle(args, cfg) local title if args.page then title = mw.title.new(args.page) if not title then return nil end else title = mw.title.getCurrentTitle() end if shouldUseSubjectTitle(args, cfg) then return title.subjectPageTitle else return title end end function p._main(args) local title = getTitle(args, cfg) local pageType = getPageType(title, args, cfg) if yesno(args.plural, false) then pageType = pluralize(pageType, cfg) end if yesno(args.caps, false) then pageType = capitalize(pageType) end return pageType end function p.main(frame) local args = getArgs(frame) return p._main(args) end return p