Module:Pagetype

Module documentation[create] [purge]

You might want to create a documentation page for this Scribunto module.
Editors can experiment in this module's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this module.

----------------------------------------------------------------------------------------------------
--                                                                                                --
--                                           PAGETYPE                                             --
--                                                                                                --
--      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 configuration        --
--      table.
--                                                                                                --
----------------------------------------------------------------------------------------------------

local cfg = {}

----------------------------------------------------------------------------------------------------
--                                          Configuration data                                    --
--      Language-specific parameter names can be set here.                                        --
----------------------------------------------------------------------------------------------------

-- This table holds the values to use for "main=true", "user=true", etc. Keys to this table should
-- be namespace parameters that can be used with [[Module:Namespace detect]]. 
cfg.pagetypes = {
	['main']              = 'article',
	['user']              = 'user page',
	['project']           = 'project page',
	['wikipedia']         = 'project page',
	['file']              = 'file',
	['mediawiki']         = 'interface page',
	['template']          = 'template',
	['help']              = 'help page',
	['category']          = 'category',
	['portal']            = 'portal',
	['book']              = 'book',
	['education program'] = 'education program page',
	['timedtext']         = 'Timed Text page',
	['module']            = 'module',
	['talk']              = 'talk page',
	['special']           = 'special page',
	['media']             = 'file'
}

-- This table holds the names of the namespaces to be looked up from cfg.pagetypes by default.
cfg.defaultNamespaces = {'main', 'file', 'template', 'category', 'module', 'book'}

-- The value used if the module matches a namespace that has not been specified.
cfg.fallback = 'page'

----------------------------------------------------------------------------------------------------
--                                       End configuration data                                   --
----------------------------------------------------------------------------------------------------

-- Load required modules.
local yesno = require('Module:Yesno')
local nsDetectModule = require('Module:Namespace detect')
local nsDetect = nsDetectModule._main
local getPageObject = nsDetectModule.getPageObject

-- Move some of the cfg tables to local variables.
local pagetypes = cfg.pagetypes
local defaultNamespaces = cfg.defaultNamespaces

local p = {}

local function getNamespacePagetype(namespace, v)
	local ret = yesno(v, v) -- Returns true/false for "yes", "no", etc., and returns v for other input.
	if ret and type(ret) ~= 'string' then
		ret = pagetypes[namespace]
	end
	return ret
end

local function getNsDetectValue(args)
	local ndArgs = {}
	-- Get the default values.
	for _, namespace in ipairs(defaultNamespaces) do
		ndArgs[namespace] = pagetypes[namespace]
	end
	-- Add custom values passed in from the arguments. These overwrite the defaults.
	for namespace in pairs(pagetypes) do
		local ndArg = getNamespacePagetype(namespace, args[namespace])
		if ndArg == false then
			-- If any arguments are false, convert them to nil to protect against breakage by future changes
			-- to [[Module:Namespace detect]].
			ndArgs[namespace] = nil
		elseif ndArg then
			ndArgs[namespace] = ndArg
		end
	end
	-- If there is no talk value specified, use the corresponding subject namespace for talk pages.
	if not ndArgs.talk then
		ndArgs.subjectns = true
	end
	-- Add the fallback value.
	ndArgs.other = cfg.fallback
	-- Allow custom page values.
	ndArgs.page = args.page
	return nsDetect(ndArgs)
end

local function detectRedirects(args)
	local redirect = args.redirect
	redirect = yesno(redirect, redirect) -- Returns true/false for "yes", "no", etc., and returns redirect for other input.
	if redirect == false then return end
	local pageObject = getPageObject(args.page)
	-- If we are using subject namespaces elsewhere, do so here as well.
	if pageObject and not yesno(args.talk, true) then
		pageObject = getPageObject(pageObject.subjectNsText .. ':' .. pageObject.text)
	end
	-- Allow custom values for redirects.
	if pageObject and pageObject.isRedirect then
		if type(redirect) == 'string' then
			return redirect
		else
			return 'redirect'
		end
	end
end

function p._main(args)
	local redirect = detectRedirects(args)
	if redirect then
		return redirect
	else
		return getNsDetectValue(args)
	end
end

function p.main(frame)
	-- If called via #invoke, use the args passed into the invoking template, or the args passed to #invoke if any exist.
	-- Otherwise assume args are being passed directly in from the debug console or from another Lua module.
	local origArgs
	if frame == mw.getCurrentFrame() then
		origArgs = frame:getParent().args
		for k, v in pairs(frame.args) do
			origArgs = frame.args
			break
		end
	else
		origArgs = frame
	end
	-- Trim whitespace and remove blank arguments.
	local args = {}
	for k, v in pairs(origArgs) do
		if type(v) == 'string' then
			v = mw.text.trim(v)
		end
		if v ~= '' then
			args[k] = v
		end
	end
	return p._main(args)
end

return p