Module:Pagetype

Module documentation

This Lua module is used on many pages.

To avoid large-scale disruption and unnecessary server load, any changes to this module should first be tested in its /sandbox or /testcases subpages. The tested changes can then be added to this page in one single edit.

Please consider discussing any 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. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing.

Uses Lua:

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}}`	page
`{{#invoke:pagetype\|main\|page=UK}}`	page
`{{#invoke:pagetype\|main\|page=Talk:United Kingdom}}`	page
`{{#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}}`	page
`{{#invoke:pagetype\|main\|page=Talk:United Kingdom}}`	page
`{{#invoke:pagetype\|main\|page=Talk:United Kingdom\|talk=y}}`	page
`{{#invoke:pagetype\|main\|page=United Kingdom}}`	page
`{{#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}}`	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
Namespace	`none`	`extended`	`all`	Other values	Output
Main	N				article
User	N			N	user page
Wikipedia	N			N	project page
File	N				file
MediaWiki	N			N	interface page
Template	N				template
Help	N			N	help page
Category	N				category
Portal	N			N	portal
Draft	N			N	draft
TimedText	N	N		N	Timed Text page
Module	N				module
Topic (Flow boards)	N	N		N	topic
All talk namespaces	N	N		N	talk page
Special	N	N		N	special page
Media	N	N		N	file

Examples

Code	Result
`{{#invoke:pagetype\|main\|page=United Kingdom}}`	page
`{{#invoke:pagetype\|main\|page=United Kingdom\|defaultns=none}}`	page
`{{#invoke:pagetype\|main\|page=Talk:United Kingdom}}`	page
`{{#invoke:pagetype\|main\|page=Talk:United Kingdom\|defaultns=all}}`	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}}`	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}}`	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}}`	page
`{{#invoke:pagetype\|main\|page=Talk:United Kingdom}}`	page
`{{#invoke:pagetype\|main\|page=Talk:United Kingdom\|talk=custom text}}`	page
`{{#invoke:pagetype\|main\|page=United Kingdom}}`	page
`{{#invoke:pagetype\|main\|page=United Kingdom\|main=custom text}}`	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=custom text}}`	page

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}}`	page
`{{#invoke:pagetype\|main\|page=Wikipedia talk:Namespace\|talk=yes}}`	page
`{{#invoke:pagetype\|main\|page=Wikipedia talk:Namespace\|wikipedia=yes\|talk=yes}}`	page
`{{#invoke:pagetype\|main\|page=Wikipedia talk:Namespace\|talk=custom text}}`	page
`{{#invoke:pagetype\|main\|page=Wikipedia talk:Namespace\|wikipedia=yes\|talk=custom text}}`	page

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}}`	page
`{{#invoke:pagetype\|main\|page=United Kingdom\|na}}`	page
`{{#invoke:pagetype\|main\|page=United Kingdom\|na\|na=custom text}}`	page

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}}`	page
`{{#invoke:pagetype\|main\|page=UK\|redirect=no}}`	page
`{{#invoke:pagetype\|main\|page=UK\|redirect=custom text}}`	page

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}}`	page
`{{#invoke:pagetype\|main\|page=Mercury\|dab=custom text}}`	page

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}}`	page
`{{#invoke:pagetype\|main\|page=Wikipedia:Namespace\|other=custom text\|wikipedia=wikipedia-space text}}`	page

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}}`	page
`{{#invoke:pagetype\|main\|page=United Kingdom\|plural=y}}`	pages
`{{#invoke:pagetype\|main\|page=Category:Books}}`	page
`{{#invoke:pagetype\|main\|page=Category:Books\|plural=y}}`	pages

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}}`	page
`{{#invoke:pagetype\|main\|page=United Kingdom\|caps=y}}`	Page
`{{#invoke:pagetype\|main\|page=United Kingdom\|plural=y\|caps=y}}`	Pages

--------------------------------------------------------------------------------
--                                                                            --
--      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 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)
	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)
	if title.isTalkPage then
		return lookUpNamespaceArg(args, cfg.talk)
	end
	for _, key in ipairs(getNamespaceArgKeys(title)) 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)
	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)
	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)
	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

-- Find pages which do not exist
local function nonExistent(title, args)
	local arg = lookUpNamespaceArg(args, cfg.ne)
	if arg == false then
		return nil
	end
	local exists = false
	if title.exists then -- not an article if it does not exist
		exists = true
	elseif title.namespace==8 and mw.message.new(title.text):exists() then
		exists = true
	elseif title.namespace==6 and title.fileExists then
		exists = true
	end
	if not exists then
		if type(arg) == 'string' then
			return arg
		else
			return cfg.naDefault
		end
	end
end

-- Get page types for mainspaces pages with an explicit class specified
local function getMainNamespaceClassPageType(title, args)
	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
	local arg = lookUpNamespaceArg(args, cfg.na)
	if arg == false then -- don't check for this class if it is specifically disallowed
		return nil
	end
	if cfg.naAliases[class] then
		if type(arg) == 'string' then
			return arg
		else
			return cfg.naDefault
		end
	else
		return nil
	end
end

-- Get page type specified by an explicit namespace argument.
local function getNamespaceArgPageType(title, args)
	local namespaceArg = getNamespaceArg(title, args)
	if namespaceArg == true then
		-- Namespace has been explicitly enabled, so return the default for
		-- this namespace
		return getExplicitPageType(title)
	elseif namespaceArg == false then
		-- Namespace has been explicitly disabled
		return getDefaultPageType(args)
	elseif namespaceArg then
		-- This namespaces uses custom text
		return namespaceArg
	else
		return nil
	end
end


-- Get page type not specified or detected by other means
local function getOtherPageType(title, args)
-- Whether the title is in the set of default active namespaces which are looked up in cfg.pagetypes.
	local isInDefaultActiveNamespace = false
	local defaultNamespacesKey = args[cfg.defaultns]
	if defaultNamespacesKey == cfg.defaultnsAll then
		isInDefaultActiveNamespace = true
	else
		local defaultNamespaces
		if defaultNamespacesKey == cfg.defaultnsExtended then
			defaultNamespaces = cfg.extendedNamespaces
		elseif defaultNamespacesKey == cfg.defaultnsNone then
			defaultNamespaces = {}
		else
			defaultNamespaces = cfg.defaultNamespaces
		end
		isInDefaultActiveNamespace = defaultNamespaces[title.namespace]
	end
	if isInDefaultActiveNamespace then
		return getExplicitPageType(title)
	else
		return getDefaultPageType(args)
	end
end

function p._main(args)
	local title
	if args.page then
		title = mw.title.new(args.page)
	else
		title = mw.title.getCurrentTitle()
	end
	if title and not yesno(args.talk, true) and args[cfg.defaultns] ~= cfg.defaultnsAll then
		title = title.subjectPageTitle
	end
	local pageType = detectRedirects(title, args)
		or nonExistent(title, args)
		or parseContent(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 == 0 and getMainNamespaceClassPageType(title, args))
		or getNamespaceArgPageType(title, args)
		or getOtherPageType(title, args)
	if yesno(args.plural, false) then
		pageType = pluralize(pageType)
	end
	if yesno(args.caps, false) then
		pageType = capitalize(pageType)
	end
	return pageType
end

function p.main(frame)
	local args = require('Module:Arguments').getArgs(frame)
	return p._main(args)
end

return p