မော်ဂျူး:Pagetype

Permanently protected မော်ဂျူး
ဝီကီပီးဒီးယား မှ
Documentation icon မော်ဂျူးမှတ်တမ်းလက်စွဲ[ကြည့်ရှု] [တည်းဖြတ်] [ရာဇဝင်] [ရှင်းသန့်]

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

အခြေခံအသုံး
{{#invoke:pagetype|main}}
ပါရာမီတာများအားလုံး
{{#invoke:pagetype|main
| page              = 
| defaultns         = 
| main              = 
| user              = 
| wikipedia         = 
| project           = 
| wp                = 
| file              = 
| image             = 
| mediawiki         = 
| template          = 
| help              = 
| category          = 
| portal            = 
| book              = 
| draft             = 
| education program = 
| timedtext         = 
| module            = 
| topic             = 
| special           = 
| media             = 
| talk              = 
| redirect          = 
| dab               = 
| na                = 
| other             = 
}}

အခြေခံ အသုံးပြုပုံ

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:

စာမျက်နှာအမျိုးအစား / အမည်ညွှန်း ရလဒ်
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 module is used on a talk page, it will detect the page type for the corresponding subject page.

နမူနာ
Code Result
{{#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}}
နမူနာများ
ကုဒ် ရလဒ်
{{#invoke:pagetype|main|page=မြန်မာနိုင်ငံ}} ဆောင်းပါး
{{#invoke:pagetype|main|page=Talk:မြန်မာနိုင်ငံ}} ဆောင်းပါး
{{#invoke:pagetype|main|page=File:Example.svg}} ဖိုင်
{{#invoke:pagetype|main|page=Wikipedia:Namespace}} စာမျက်နှာ
{{#invoke:pagetype|main|page=TimedText:Imagine.ogg.en.srt}} စာမျက်နှာ

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 YesY YesY YesY article
User N YesY YesY N user page
Wikipedia N YesY YesY N project page
File N YesY YesY YesY file
MediaWiki N YesY YesY N interface page
Template N YesY YesY YesY template
Help N YesY YesY N help page
Category N YesY YesY YesY category
Portal N YesY YesY N portal
Book N YesY YesY YesY book
Draft N YesY YesY N draft
Education Program N N YesY N education program page
TimedText N N YesY N Timed Text page
Module N YesY YesY YesY module
Topic (Flow boards) N N YesY N topic
All talk namespaces N N YesY N talk page
Special N N YesY N special page
Media N N YesY N file
Examples
Code Result
{{#invoke:pagetype|main|page=မြန်မာနိုင်ငံ}} ဆောင်းပါး
{{#invoke:pagetype|main|page=မြန်မာနိုင်ငံ|defaultns=none}} စာမျက်နှာ
{{#invoke:pagetype|main|page=Talk:မြန်မာနိုင်ငံ}} ဆောင်းပါး
{{#invoke:pagetype|main|page=Talk:မြန်မာနိုင်ငံ|defaultns=all}} ဆွေးနွေးချက် စာမျက်နှာ
{{#invoke:pagetype|main|page=File:Example.svg}} ဖိုင်
{{#invoke:pagetype|main|page=File:Example.svg|defaultns=none}} စာမျက်နှာ
{{#invoke:pagetype|main|page=Wikipedia:About}} ပြန်ညွှန်း
{{#invoke:pagetype|main|page=Wikipedia:About|defaultns=extended}} ပရောဂျက် စာမျက်နှာ
{{#invoke:pagetype|main|page=TimedText:Imagine.ogg.en.srt|defaultns=extended}} စာမျက်နှာ
{{#invoke:pagetype|main|page=TimedText:Imagine.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
| book              = custom text
| draft             = custom text
| education program = 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:About}} ပြန်ညွှန်း
{{#invoke:pagetype|main|page=Wikipedia:About|wikipedia=custom text}} ပြန်ညွှန်း
{{#invoke:pagetype|main|page=Talk:မြန်မာနိုင်ငံ}} ဆောင်းပါး
{{#invoke:pagetype|main|page=Talk:မြန်မာနိုင်ငံ|talk=custom text}} စာမျက်နှာ
{{#invoke:pagetype|main|page=မြန်မာနိုင်ငံ}} ဆောင်းပါး
{{#invoke:pagetype|main|page=မြန်မာနိုင်ငံ|main=custom text}} custom text
{{#invoke:pagetype|main|page=TimedText:Imagine.ogg.en.srt}} စာမျက်နှာ
{{#invoke:pagetype|main|page=TimedText:Imagine.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}} စာမျက်နှာ
{{#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|wikipedia=yes|talk=yes}} စာမျက်နှာ
{{#invoke:pagetype|main|page=Wikipedia talk:Namespace|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 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

It is also possible to specify a custom value for the main namespace classes:

{{#invoke:pagetype|main|class|dab=yes|na=yes}}
{{#invoke:pagetype|main|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
{{#invoke:pagetype|main|page=မြန်မာ}} ပြန်ညွှန်း
{{#invoke:pagetype|main|page=မြန်မာ|dab}} ပြန်ညွှန်း
{{#invoke:pagetype|main|page=မြန်မာ|dab|dab=custom text}} ပြန်ညွှန်း
{{#invoke:pagetype|main|page=မြန်မာ|na}} ပြန်ညွှန်း
{{#invoke:pagetype|main|page=မြန်မာ|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
Code Result
{{#invoke:pagetype|main|page=UK}} ဆောင်းပါး
{{#invoke:pagetype|main|page=UK|redirect=no}} ဆောင်းပါး
{{#invoke:pagetype|main|page=UK|redirect=custom text}} ဆောင်းပါး

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}} စာမျက်နှာ
{{#invoke:pagetype|main|page=Wikipedia:Namespace|other=custom text}} စာမျက်နှာ
{{#invoke:pagetype|main|page=Wikipedia:Namespace|other=custom text|wikipedia=wikipedia-space text}} wikipedia-space text

--------------------------------------------------------------------------------
--                                                                            --
--      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, list, parameter, default, articleOnly)
	if articleOnly and title.namespace~=0 -- only detect in mainspace
		or 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 templates = mw.loadData('Module:Pagetype/' .. list)
	local content = title:getContent()
	if content == nil then
		return nil
	end
	content = require('Module:Wikitext Parsing').PrepareText(content) -- disregard templates which do not have any affect 
	local templateNames = {}
	local templateFound = false
	for template in string.gmatch(content, "{{%s*([^|}]-)%s*[|}]") do
		if templates[capitalize(template)] then
			templateFound = true
			break
		end
	end
	local out = lookUpNamespaceArg(args, parameter)
	if not templateFound then
		return nil
	elseif type(out)=='string' then
		return out
	else
		return default
	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)
		or parseContent(title, args, 'setindex', cfg.sia, cfg.siaDefault, true)
		or parseContent(title, args, '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