Module:Namespace detect: Difference between revisions

From Sarkarverse
Jump to navigation Jump to search
m (1 revision)
 
No edit summary
Line 1: Line 1:
--[[
----------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--                                                                                               --
--                                                                           --
--                                           NAMESPACE DETECT                                     --
--                           NAMESPACE DETECT                               --
--                                                                                               --
--                                                                           --
--     This module implements the {{namespace detect}} template in Lua, with a few              --
-- This module implements the {{namespace detect}} template in Lua, with a   --
--     improvements: all namespaces and all namespace aliases are supported, and namespace      --
-- few improvements: all namespaces and all namespace aliases are supported, --
--     names are detected automatically for the local wiki. The module can also use the          --
-- and namespace names are detected automatically for the local wiki. The     --
--     corresponding subject namespace value if it is used on a talk page. Parameter names       --
-- module can also use the corresponding subject namespace value if it is     --
--      can be configured for different wikis by altering the values in the "cfg" table.          --
-- used on a talk page. Parameter names can be configured for different wikis --
--                                                                                               --
-- by altering the values in the "cfg" table in                              --
----------------------------------------------------------------------------------------------------
-- Module:Namespace detect/config.                                            --
--                                                                           --
--------------------------------------------------------------------------------
--]]


local data = mw.loadData('Module:Namespace detect/data')
----------------------------------------------------------------------------------------------------
local argKeys = data.argKeys
--                                          Configuration data                                    --
local cfg = data.cfg
--      Language-specific parameter names can be set here.                                        --
local mappings = data.mappings
----------------------------------------------------------------------------------------------------
 
local cfg = {}
 
-- This parameter displays content for the main namespace:
cfg.main = 'main'
 
-- This parameter displays in talk namespaces:
cfg.talk = 'talk'
 
-- This parameter displays content for "other" namespaces (namespaces for which
-- parameters have not been specified, or for when cfg.demospace is set to cfg.other):
cfg.other = 'other'
 
-- This parameter makes talk pages behave as though they are the corresponding subject namespace.
-- Note that this parameter is used with [[Module:Yesno]]. Edit that module to change
-- the default values of "yes", "no", etc.
cfg.subjectns = 'subjectns'
 
-- This parameter sets a demonstration namespace:
cfg.demospace = 'demospace'
 
-- This parameter sets a specific page to compare:
cfg.page = 'page'
 
-- The header for the namespace column in the wikitable containing the list of possible subject-space parameters.
cfg.wikitableNamespaceHeader = 'Namespace'
 
-- The header for the wikitable containing the list of possible subject-space parameters.
cfg.wikitableAliasesHeader = 'Aliases'
 
----------------------------------------------------------------------------------------------------
--                                      End configuration data                                   --
----------------------------------------------------------------------------------------------------


local yesno = require('Module:Yesno')
local yesno = require('Module:Yesno')
local mArguments -- Lazily initialise Module:Arguments
local mTableTools -- Lazily initilalise Module:TableTools
local ustringLower = mw.ustring.lower


local p = {}
local p = {}
local function fetchValue(t1, t2)
-- Fetches a value from the table t1 for the first key in array t2 where
-- a non-nil value of t1 exists.
for i, key in ipairs(t2) do
local value = t1[key]
if value ~= nil then
return value
end
end
return nil
end
local function equalsArrayValue(t, value)
-- Returns true if value equals a value in the array t. Otherwise
-- returns false.
for i, arrayValue in ipairs(t) do
if value == arrayValue then
return true
end
end
return false
end


function p.getPageObject(page)
function p.getPageObject(page)
-- Get the page object, passing the function through pcall in case of
-- Get the page object, passing the function through pcall in case we are over the expensive function count limit.
-- errors, e.g. being over the expensive function count limit.
if page then
if page then
local success, pageObject = pcall(mw.title.new, page)
local noError, pageObject = pcall(mw.title.new, page)
if success then
if not noError then
return nil
else
return pageObject
return pageObject
else
return nil
end
end
else
else
Line 65: Line 67:
end
end


-- Provided for backward compatibility with other modules
function p.getParamMappings()
function p.getParamMappings()
--[[ Returns a table of how parameter names map to namespace names. The keys are the actual namespace
  names, in lower case, and the values are the possible parameter names for that namespace, also in
  lower case. The table entries are structured like this:
{
[''] = {'main'},
['wikipedia'] = {'wikipedia', 'project', 'wp'},
...
}
]]
local mappings = {}
mappings[mw.ustring.lower(mw.site.namespaces[0].name)] = {cfg.main}
mappings[cfg.talk] = {cfg.talk}
for nsid, ns in pairs(mw.site.subjectNamespaces) do
if nsid ~= 0 then -- Exclude main namespace.
local nsname = mw.ustring.lower(ns.name)
local canonicalName = mw.ustring.lower(ns.canonicalName)
mappings[nsname] = {nsname}
if canonicalName ~= nsname then
table.insert(mappings[nsname], canonicalName)
end
for _, alias in ipairs(ns.aliases) do
table.insert(mappings[nsname], mw.ustring.lower(alias))
end
end
end
return mappings
return mappings
end
end


local function getNamespace(args)
local function getNamespace(args)
-- This function gets the namespace name from the page object.
-- Gets the namespace name from the page object.
local page = fetchValue(args, argKeys.page)
local page = args[cfg.page]
if page == '' then
local demospace = args[cfg.demospace]
page = nil
local subjectns = args[cfg.subjectns]
end
local demospace = fetchValue(args, argKeys.demospace)
if demospace == '' then
demospace = nil
end
local subjectns = fetchValue(args, argKeys.subjectns)
local ret
local ret
if demospace then
if demospace then
-- Handle "demospace = main" properly.
-- Handle "demospace = main" properly.
if equalsArrayValue(argKeys.main, ustringLower(demospace)) then
if mw.ustring.lower(demospace) == cfg.main then
ret = mw.site.namespaces[0].name
ret = mw.site.namespaces[0].name
else
else
Line 93: Line 113:
if pageObject then
if pageObject then
if pageObject.isTalkPage then
if pageObject.isTalkPage then
-- Get the subject namespace if the option is set,
-- If cfg.subjectns is set, get the subject namespace, otherwise use cfg.talk.
-- otherwise use "talk".
if yesno(subjectns) then
if yesno(subjectns) then
ret = mw.site.namespaces[pageObject.namespace].subject.name
ret = mw.site.namespaces[pageObject.namespace].subject.name
else
else
ret = 'talk'
ret = cfg.talk
end
end
else
else
Line 107: Line 126:
end
end
end
end
ret = ret:gsub('_', ' ')
ret = mw.ustring.gsub(ret, '_', ' ')
return ustringLower(ret)
return mw.ustring.lower(ret)
end
end


function p._main(args)
function p._main(args)
-- Check the parameters stored in the mappings table for any matches.
-- Get the namespace to compare the parameters to, and the parameter mapping table.
local namespace = getNamespace(args) or 'other' -- "other" avoids nil table keys
local namespace = getNamespace(args)
local params = mappings[namespace] or {}
local mappings = p.getParamMappings()
local ret = fetchValue(args, params)
-- Check for any matches in the namespace arguments. The order we check them doesn't matter,
--[[
-- as there can only be one match.
-- If there were no matches, return parameters for other namespaces.
for ns, params in pairs(mappings) do
-- This happens if there was no text specified for the namespace that
if ns == namespace then
-- was detected or if the demospace parameter is not a valid
-- Check all aliases for matches. The default local namespace is checked first, as
-- namespace. Note that the parameter for the detected namespace must be
-- {{namespace detect}} checked these before alias names.
for _, param in ipairs(params) do
if args[param] ~= nil then
return args[param]
end
end
end
end
-- If there were no matches, return parameters for other namespaces. This happens if there
-- was no text specified for the namespace that was detected or if the demospace parameter
-- is not a valid namespace. Note that the parameter for the detected namespace must be
-- completely absent for this to happen, not merely blank.
-- completely absent for this to happen, not merely blank.
--]]
if args[cfg.other] ~= nil then
if ret == nil then
return args[cfg.other]
ret = fetchValue(args, argKeys.other)
end
end
return ret
end
end


function p.main(frame)
function p.main(frame)
mArguments = require('Module:Arguments')
-- If called via #invoke, use the args passed into the invoking template, or the args
local args = mArguments.getArgs(frame, {removeBlanks = false})
-- passed to #invoke if any exist. Otherwise assume args are being passed directly in.
local ret = p._main(args)
local origArgs
return ret or ''
if frame == mw.getCurrentFrame() then
end
origArgs = frame:getParent().args
 
for k, v in pairs(frame.args) do
function p.table(frame)
origArgs = frame.args
--[[
break
-- Create a wikitable of all subject namespace parameters, for
-- documentation purposes. The talk parameter is optional, in case it
-- needs to be excluded in the documentation.
--]]
-- Load modules and initialise variables.
mTableTools = require('Module:TableTools')
local namespaces = mw.site.namespaces
local cfg = data.cfg
local useTalk = type(frame) == 'table'
and type(frame.args) == 'table'
and yesno(frame.args.talk) -- Whether to use the talk parameter.
-- Get the header names.
local function checkValue(value, default)
if type(value) == 'string' then
return value
else
return default
end
end
else
origArgs = frame
end
end
local nsHeader = checkValue(cfg.wikitableNamespaceHeader, 'Namespace')
-- Trim whitespace and remove blank arguments for demospace and page parameters.
local aliasesHeader = checkValue(cfg.wikitableAliasesHeader, 'Aliases')
local args = {}
 
for k, v in pairs(origArgs) do
-- Put the namespaces in order.
if type(v) == 'string' then
local mappingsOrdered = {}
v = mw.text.trim(v) -- Trim whitespace.
for nsname, params in pairs(mappings) do
end
if useTalk or nsname ~= 'talk' then
if k == cfg.demospace or k == cfg.page then
local nsid = namespaces[nsname].id
if v ~= '' then
-- Add 1, as the array must start with 1; nsid 0 would be lost otherwise.
args[k] = v
nsid = nsid + 1
end
mappingsOrdered[nsid] = params
else
args[k] = v
end
end
end
end
mappingsOrdered = mTableTools.compressSparseArray(mappingsOrdered)
return p._main(args)
end


-- Build the table.
function p.table(frame)
--[[ Create a wikitable of all subject namespace parameters, for documentation purposes. The talk
  parameter is optional, in case it needs to be excluded in the documentation.
]]
local useTalk = type(frame) == 'table' and type(frame.args) == 'table' and frame.args.talk == 'yes' -- Whether to use the talk parameter.
local mappings = p.getParamMappings()
-- Start the wikitable.
local ret = '{| class="wikitable"'
local ret = '{| class="wikitable"'
.. '\n|-'
.. '\n|-'
.. '\n! ' .. nsHeader
.. '\n! ' .. cfg.wikitableNamespaceHeader
.. '\n! ' .. aliasesHeader
.. '\n! ' .. cfg.wikitableAliasesHeader
for i, params in ipairs(mappingsOrdered) do
for j, param in ipairs(params) do
-- Generate the row for the main namespace, as we want this to be first in the list.
if j == 1 then
ret = ret .. '\n|-'
ret = ret .. '\n|-'
.. '\n| <code>' .. cfg.main .. '</code>'
.. '\n| <code>' .. param .. '</code>'
.. '\n|'
.. '\n| '
if useTalk then
elseif j == 2 then
ret = ret .. '\n|-'
ret = ret .. '<code>' .. param .. '</code>'
.. '\n| <code>' .. cfg.talk .. '</code>'
else
.. '\n|'
ret = ret .. ', <code>' .. param .. '</code>'
end
-- Enclose all parameter names in <code> tags.
for ns, params in pairs(mappings) do
if ns ~= mw.site.namespaces[0].name then
for i, param in ipairs(params) do
mappings[ns][i] = '<code>' .. param .. '</code>'
end
end
end
end
end
end
-- Generate the other wikitable rows.
for ns, params in pairs(mappings) do
if ns ~= mw.site.namespaces[0].name then -- Ignore the main namespace.
ret = ret .. '\n|-'
.. '\n| ' .. params[1]
.. '\n| ' .. table.concat(params, ', ', 2)
end
end
-- End the wikitable.
ret = ret .. '\n|-'
ret = ret .. '\n|-'
.. '\n|}'
.. '\n|}'

Revision as of 16:09, 25 March 2014


-- -- -- NAMESPACE DETECT -- -- -- -- This module implements the template in Lua, with a few -- -- improvements: all namespaces and all namespace aliases are supported, and namespace -- -- names are detected automatically for the local wiki. The module can also use the -- -- corresponding subject namespace value if it is used on a talk page. Parameter names -- -- can be configured for different wikis by altering the values in the "cfg" table. -- -- --



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


local cfg = {}

-- This parameter displays content for the main namespace: cfg.main = 'main'

-- This parameter displays in talk namespaces: cfg.talk = 'talk'

-- This parameter displays content for "other" namespaces (namespaces for which -- parameters have not been specified, or for when cfg.demospace is set to cfg.other): cfg.other = 'other'

-- This parameter makes talk pages behave as though they are the corresponding subject namespace. -- Note that this parameter is used with Module:Yesno. Edit that module to change -- the default values of "yes", "no", etc. cfg.subjectns = 'subjectns'

-- This parameter sets a demonstration namespace: cfg.demospace = 'demospace'

-- This parameter sets a specific page to compare: cfg.page = 'page'

-- The header for the namespace column in the wikitable containing the list of possible subject-space parameters. cfg.wikitableNamespaceHeader = 'Namespace'

-- The header for the wikitable containing the list of possible subject-space parameters. cfg.wikitableAliasesHeader = 'Aliases'


-- End configuration data --


local yesno = require('Module:Yesno')

local p = {}

function p.getPageObject(page) -- Get the page object, passing the function through pcall in case we are over the expensive function count limit. if page then local noError, pageObject = pcall(mw.title.new, page) if not noError then return nil else return pageObject end else return mw.title.getCurrentTitle() end end

function p.getParamMappings() --[[ Returns a table of how parameter names map to namespace names. The keys are the actual namespace names, in lower case, and the values are the possible parameter names for that namespace, also in lower case. The table entries are structured like this: { [] = {'main'}, ['wikipedia'] = {'wikipedia', 'project', 'wp'}, ... } ]] local mappings = {} mappings[mw.ustring.lower(mw.site.namespaces[0].name)] = {cfg.main} mappings[cfg.talk] = {cfg.talk} for nsid, ns in pairs(mw.site.subjectNamespaces) do if nsid ~= 0 then -- Exclude main namespace. local nsname = mw.ustring.lower(ns.name) local canonicalName = mw.ustring.lower(ns.canonicalName) mappings[nsname] = {nsname} if canonicalName ~= nsname then table.insert(mappings[nsname], canonicalName) end for _, alias in ipairs(ns.aliases) do table.insert(mappings[nsname], mw.ustring.lower(alias)) end end end return mappings end

local function getNamespace(args) -- Gets the namespace name from the page object. local page = args[cfg.page] local demospace = args[cfg.demospace] local subjectns = args[cfg.subjectns] local ret if demospace then -- Handle "demospace = main" properly. if mw.ustring.lower(demospace) == cfg.main then ret = mw.site.namespaces[0].name else ret = demospace end else local pageObject = p.getPageObject(page) if pageObject then if pageObject.isTalkPage then -- If cfg.subjectns is set, get the subject namespace, otherwise use cfg.talk. if yesno(subjectns) then ret = mw.site.namespaces[pageObject.namespace].subject.name else ret = cfg.talk end else ret = pageObject.nsText end else return nil -- return nil if the page object doesn't exist. end end ret = mw.ustring.gsub(ret, '_', ' ') return mw.ustring.lower(ret) end

function p._main(args) -- Get the namespace to compare the parameters to, and the parameter mapping table. local namespace = getNamespace(args) local mappings = p.getParamMappings() -- Check for any matches in the namespace arguments. The order we check them doesn't matter, -- as there can only be one match. for ns, params in pairs(mappings) do if ns == namespace then -- Check all aliases for matches. The default local namespace is checked first, as -- checked these before alias names. for _, param in ipairs(params) do if args[param] ~= nil then return args[param] end end end end -- If there were no matches, return parameters for other namespaces. This happens if there -- was no text specified for the namespace that was detected or if the demospace parameter -- is not a valid namespace. Note that the parameter for the detected namespace must be -- completely absent for this to happen, not merely blank. if args[cfg.other] ~= nil then return args[cfg.other] 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. 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 for demospace and page parameters. local args = {} for k, v in pairs(origArgs) do if type(v) == 'string' then v = mw.text.trim(v) -- Trim whitespace. end if k == cfg.demospace or k == cfg.page then if v ~= then args[k] = v end else args[k] = v end end return p._main(args) end

function p.table(frame) --[[ Create a wikitable of all subject namespace parameters, for documentation purposes. The talk parameter is optional, in case it needs to be excluded in the documentation. ]] local useTalk = type(frame) == 'table' and type(frame.args) == 'table' and frame.args.talk == 'yes' -- Whether to use the talk parameter. local mappings = p.getParamMappings() -- Start the wikitable. local ret = '{| class="wikitable"' .. '\n|-' .. '\n! ' .. cfg.wikitableNamespaceHeader .. '\n! ' .. cfg.wikitableAliasesHeader

-- Generate the row for the main namespace, as we want this to be first in the list. ret = ret .. '\n|-' .. '\n| ' .. cfg.main .. '' .. '\n|' if useTalk then ret = ret .. '\n|-' .. '\n| ' .. cfg.talk .. '' .. '\n|' end -- Enclose all parameter names in tags. for ns, params in pairs(mappings) do if ns ~= mw.site.namespaces[0].name then for i, param in ipairs(params) do mappings[ns][i] = '' .. param .. '' end end end -- Generate the other wikitable rows. for ns, params in pairs(mappings) do if ns ~= mw.site.namespaces[0].name then -- Ignore the main namespace. ret = ret .. '\n|-' .. '\n| ' .. params[1] .. '\n| ' .. table.concat(params, ', ', 2) end end -- End the wikitable. ret = ret .. '\n|-' .. '\n|}' return ret end

return p