Jump to content

Editing Module:Pagetype

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--                                                                            --
--                                                                            --
--                                PAGETYPE                                    --
--      This meta-module which automatically detects namespaces, and allows   --
--                                                                            --
--      for a great deal of customisation. It can easily be ported to other   --
--      This is a meta-module intended to replace {{pagetype}} and similar    --
--      templates. It 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]].      --
--      wikis by changing the values in the [[Module:Pagetype/config]].      --
--                                                                            --
--                                                                            --
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
-- Load config.
-- Load config.
local cfg = mw.loadData('Module:Pagetype/config')
local cfg = mw.loadData('Module:Pagetype/config')


-- Load required modules.
-- Load required modules.
local getArgs = require('Module:Arguments').getArgs
local yesno = require('Module:Yesno')
local yesno = require('Module:Yesno')
local nsDetectModule = require('Module:Namespace detect')
local p = {}
local nsDetect = nsDetectModule._main
local getParamMappings = nsDetectModule.getParamMappings
local getPageObject = nsDetectModule.getPageObject


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


local function shallowCopy(t)
-- Append multiple values to an array
-- Makes a shallow copy of a table.
local function appendMultiple(target, source)
local ret = {}
for _, value in ipairs(source) do
for k, v in pairs(t) do
table.insert(target, value)
ret[k] = v
end
end
return ret
end
end


local function checkPagetypeInput(namespace, val)
-- Get argument keys for a title's namespace
-- Checks to see whether we need the default value for the given namespace,
local function getNamespaceArgKeys(title)
-- and if so gets it from the pagetypes table.
local nsInfo = mw.site.namespaces[title.namespace]
-- The yesno function returns true/false for "yes", "no", etc., and returns
local customAliases = cfg.customNamespaceAliases[title.namespace] or {}
-- val for other input.
local keys = {}
local ret = yesno(val, val)
if nsInfo.name ~= '' then
if ret and type(ret) ~= 'string' then
table.insert(keys, nsInfo.name)
ret = cfg.pagetypes[namespace]
end
end
return ret
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
end


local function getPagetypeFromClass(class, param, aliasTable, default)
-- Get the argument for a title's namespace, if it was specified in the args table.
-- Gets the pagetype from a class specified from the first positional
local function getNamespaceArg(title, args)
-- parameter.
if title.isTalkPage then
param = yesno(param, param)
return lookUpNamespaceArg(args, cfg.talk)
if param ~= false then -- No check if specifically disallowed.
end
for _, alias in ipairs(aliasTable) do
for _, key in ipairs(getNamespaceArgKeys(title)) do
if class == alias then
local arg = lookUpNamespaceArg(args, mw.ustring.lower(key))
if type(param) == 'string' then
if arg ~= nil then
return param
return arg
else
return default
end
end
end
end
end
end
return nil
end
end


local function getNsDetectValue(args)
-- Look up a page type specific to the title's namespace
-- Builds the arguments to pass to [[Module:Namespace detect]] and returns
local function getExplicitPageType(title)
-- the result.
if title.isTalkPage then
return cfg.talkDefault
else
return cfg.pagetypes[title.namespace]
end
end


-- Get the default values.
-- Get a default page type that is not specific to the title's namespace
local ndArgs = {}
local function getDefaultPageType(args)
local defaultns = args[cfg.defaultns]
local other = lookUpNamespaceArg(args, cfg.other)
if defaultns == cfg.defaultnsAll then
if type(other) == 'string' then
ndArgs = shallowCopy(cfg.pagetypes)
return other
else
else
local defaultnsArray
return cfg.otherDefault
if defaultns == cfg.defaultnsExtended then
end
defaultnsArray = cfg.extendedNamespaces
end
elseif defaultns == cfg.defaultnsNone then
 
defaultnsArray = {}
local function detectRedirects(title, args)
else
local redirect = lookUpNamespaceArg(args, cfg.redirect)
defaultnsArray = cfg.defaultNamespaces
if redirect == false then
end
-- Don't detect redirects if they have been specifically disallowed.
for _, namespace in ipairs(defaultnsArray) do
return nil
ndArgs[namespace] = cfg.pagetypes[namespace]
end
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
end


--[[
local function parseContent(title, args, optionsList)
-- Add custom values passed in from the arguments. These overwrite the
if title.namespace==828 and title.subpageText~='doc' -- don't detect modules
-- defaults. The possible argument names are fetched from
or not title.exists -- can't check unless page exists
-- Module:Namespace detect automatically in case new namespaces are
then
-- added. Although we accept namespace aliases as parameters, we only pass
return nil
-- the local namespace name as a parameter to Module:Namespace detect.
end
-- This means that the "image" parameter can overwrite defaults for the
local content = title:getContent()
-- File: namespace, which wouldn't work if we passed the parameters through
if content == nil then
-- separately.
return nil
--]]
end
local mappings = getParamMappings()
local templates -- lazily evaluated
for ns, paramAliases in pairs(mappings) do
for _, options in next, optionsList do
-- Copy the aliases table, as # doesn't work with tables returned from
local list, parameter, default, articleOnly = unpack(options, 1, 4)
-- mw.loadData.
if not articleOnly or title.namespace==0 then -- only check for templates if we should...
paramAliases = shallowCopy(paramAliases)
local out = lookUpNamespaceArg(args, parameter)
local paramName = paramAliases[1]
if type(out) == "string" or (out ~= false and default) then -- ...and if we actually have anything to say about them
-- Iterate backwards along the array so that any values for the local
if not templates then
-- namespace names overwrite those for namespace aliases.
templates = {} -- do our delayed evaluation now that we are required to
for i = #paramAliases, 1, -1 do
content = require('Module:Wikitext Parsing').PrepareText(content) -- disregard templates which do not have any affect
local paramAlias = paramAliases[i]
for template in string.gmatch(content, "{{%s*([^|}]-)%s*[|}]") do
local ndArg = checkPagetypeInput(paramAlias, args[paramAlias])
templates[#templates+1] = capitalize(template)
if ndArg == false then
end
-- If any arguments are false, convert them to nil to protect
end
-- against breakage by future changes to
local wantedTemplates = mw.loadData('Module:Pagetype/' .. list)
-- [[Module:Namespace detect]].
local templateFound = false
ndArgs[paramName] = nil
for _, template in next, templates do
elseif ndArg then
if wantedTemplates[template] then
ndArgs[paramName] = ndArg
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
end
end
-- Check for disambiguation-class and N/A-class pages in mainspace.
end
if ndArgs.main then
 
local class = args[1]
-- Find pages which do not exist
if type(class) == 'string' then
local function nonExistent(title, args)
-- Put in lower case so e.g. "Dab" and "dab" will both match.
local arg = lookUpNamespaceArg(args, cfg.ne)
class = mw.ustring.lower(class)
if arg == false then
end
return nil
local dab = getPagetypeFromClass(
end
class,
local exists = false
args[cfg.dab],
if title.exists then -- not an article if it does not exist
cfg.dabAliases,
exists = true
cfg.dabDefault
elseif title.namespace==8 and mw.message.new(title.text):exists() then
)
exists = true
if dab then
elseif title.namespace==6 and title.fileExists then
ndArgs.main = dab
exists = true
end
if not exists then
if type(arg) == 'string' then
return arg
else
else
local na = getPagetypeFromClass(
return cfg.naDefault
class,
args[cfg.na],
cfg.naAliases,
cfg.naDefault
)
if na then
ndArgs.main = na
end
end
end
end
end
-- If there is no talk value specified, use the corresponding subject
end
-- namespace for talk pages.
 
if not ndArgs.talk then
-- Get page types for mainspaces pages with an explicit class specified
ndArgs.subjectns = true
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
end
-- Add the fallback value. This can also be customised, but it cannot be
if cfg.naAliases[class] then
-- disabled.
if type(arg) == 'string' then
local other = args[cfg.other]
return arg
-- We will ignore true/false/nil results from yesno here, but using it
else
-- anyway for consistency.
return cfg.naDefault
other = yesno(other, other)
end
if type(other) == 'string' then
ndArgs.other = other
else
else
ndArgs.other = cfg.otherDefault
return nil
end
end
-- Allow custom page values.
ndArgs.page = args.page
return nsDetect(ndArgs)
end
end


local function detectRedirects(args)
-- Get page type specified by an explicit namespace argument.
local redirect = args[cfg.redirect]
local function getNamespaceArgPageType(title, args)
-- The yesno function returns true/false for "yes", "no", etc., and returns
local namespaceArg = getNamespaceArg(title, args)
-- redirect for other input.
if namespaceArg == true then
redirect = yesno(redirect, redirect)
-- Namespace has been explicitly enabled, so return the default for
if redirect == false then
-- this namespace
-- Detect redirects unless they have been explicitly disallowed with
return getExplicitPageType(title)
-- "redirect=no" or similar.
elseif namespaceArg == false then
return
-- Namespace has been explicitly disabled
return getDefaultPageType(args)
elseif namespaceArg then
-- This namespaces uses custom text
return namespaceArg
else
return nil
end
end
local pageObject = getPageObject(args.page)
end
-- If we are using subject namespaces elsewhere, do so here as well.
 
if pageObject
 
and not yesno(args.talk, true)
-- Get page type not specified or detected by other means
and args[cfg.defaultns] ~= cfg.defaultnsAll
local function getOtherPageType(title, args)
then
-- Whether the title is in the set of default active namespaces which are looked up in cfg.pagetypes.
pageObject = getPageObject(
local isInDefaultActiveNamespace = false
pageObject.subjectNsText .. ':' .. pageObject.text
local defaultNamespacesKey = args[cfg.defaultns]
)
if defaultNamespacesKey == cfg.defaultnsAll then
end
isInDefaultActiveNamespace = true
-- Allow custom values for redirects.
else
if pageObject and pageObject.isRedirect then
local defaultNamespaces
if type(redirect) == 'string' then
if defaultNamespacesKey == cfg.defaultnsExtended then
return redirect
defaultNamespaces = cfg.extendedNamespaces
elseif defaultNamespacesKey == cfg.defaultnsNone then
defaultNamespaces = {}
else
else
return cfg.redirectDefault
defaultNamespaces = cfg.defaultNamespaces
end
end
isInDefaultActiveNamespace = defaultNamespaces[title.namespace]
end
if isInDefaultActiveNamespace then
return getExplicitPageType(title)
else
return getDefaultPageType(args)
end
end
end
end


function p._main(args)
function p._main(args)
local redirect = detectRedirects(args)
local title
if redirect then
if args.page then
return redirect
title = mw.title.new(args.page)
else
else
return getNsDetectValue(args)
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
end
return pageType
end
end


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


return p
return p
Please note that all contributions to Micro Pedia may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see Micro Pedia:Copyrights for details). Do not submit copyrighted work without permission!
Cancel Editing help (opens in new window)

Template used on this page:

Retrieved from "https://micropedia.skywiki.org/wiki/Module:Pagetype"