Module:Namespace detect: Difference between revisions

From Sarkarverse
Jump to navigation Jump to search
m (1 revision)
 
m (1 revision)
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
----------------------------------------------------------------------------------------------------
--[[
--                                                                                               --
--------------------------------------------------------------------------------
--                                           NAMESPACE DETECT                                     --
--                                                                           --
--                                                                                               --
--                           NAMESPACE DETECT                               --
--     This module implements the {{namespace detect}} template in Lua, with a few              --
--                                                                           --
--     improvements: all namespaces and all namespace aliases are supported, and namespace      --
-- This module implements the {{namespace detect}} template in Lua, with a   --
--     names are detected automatically for the local wiki. Function names can be configured     --
-- few improvements: all namespaces and all namespace aliases are supported, --
--     for different wikis by altering the values in the "cfg" table.                            --
-- 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 in                              --
-- Module:Namespace detect/config.                                            --
--                                                                           --
--------------------------------------------------------------------------------
--]]


----------------------------------------------------------------------------------------------------
local data = mw.loadData('Module:Namespace detect/data')
--                                          Configuration data                                   --
local argKeys = data.argKeys
--      Language-specific parameter names can be set here.                                       --
local cfg = data.cfg
----------------------------------------------------------------------------------------------------
local mappings = data.mappings


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


-- The name for the parameter to display content for the main namespace:
local p = {}
cfg.main = 'main'


-- The name for the parameter to display content in talk namespaces:
local function fetchValue(t1, t2)
cfg.talk = 'talk'
-- 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


-- The name for the parameter to display content for "other" namespaces (namespaces for which
local function equalsArrayValue(t, value)
-- parameters have not been specified, or for when cfg.demospace is set to cfg.other):
-- Returns true if value equals a value in the array t. Otherwise
cfg.other = 'other'
-- returns false.
 
for i, arrayValue in ipairs(t) do
-- The name for the parameter to set a demonstration namespace:
if value == arrayValue then
cfg.demospace = 'demospace'
return true
 
end
-- The name for the parameter to set a specific page to compare:
end
cfg.page = 'page'
return false
 
end
-- 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                                  --
----------------------------------------------------------------------------------------------------
 
-- Declare the table of functions to return.
local p = {}


-- Get the page object. This will return the page object for the page specified, or nil if there are
-- errors in the title or if the expensive function count has been exceeded.
function p.getPageObject(page)
function p.getPageObject(page)
    if page then
-- 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
-- errors, e.g. being over the expensive function count limit.
-- function count limit.
if page then
        local noError, pageObject = pcall(mw.title.new, page)
local success, pageObject = pcall(mw.title.new, page)
        if not noError then
if success then
            return nil
return pageObject
        else
else
            return pageObject
return nil
        end
end
    else
else
        return mw.title.getCurrentTitle()
return mw.title.getCurrentTitle()
    end  
end
end
end


--[[ Returns a table of how parameter names map to namespace names. The keys are the actual namespace
-- Provided for backward compatibility with other modules
  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'}
    }
]]
function p.getParamMappings()
function p.getParamMappings()
    local mappings = {}
return 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
 
--[[ 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.
]]
function p.table(frame)
-- Find whether to use the talk link or not.
    local useTalk = type(frame) == 'table' and type(frame.args) == 'table' and frame.args.talk == 'yes'
 
    -- Get the parameter mappings.
    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| <code>' .. cfg.main .. '</code>'
        .. '\n|'
 
    if useTalk then
        ret = ret .. '\n|-'
            .. '\n| <code>' .. cfg.talk .. '</code>'
            .. '\n|'
    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
   
    -- 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
end


-- Gets the namespace name to compare to the arguments. The returned value is lower-case.
local function getNamespace(args)
local function getNamespace(page, demospace)
-- This function gets the namespace name from the page object.
    local ret
local page = fetchValue(args, argKeys.demopage)
    if demospace then
if page == '' then
        -- Handle "demospace = main" properly.
page = nil
        if mw.ustring.lower(demospace) == cfg.main then
end
            ret = mw.site.namespaces[0].name
local demospace = fetchValue(args, argKeys.demospace)
        else
if demospace == '' then
            ret = demospace
demospace = nil
        end
end
    else
local subjectns = fetchValue(args, argKeys.subjectns)
        local pageObject = p.getPageObject(page)
local ret
        if pageObject then
if demospace then
            if pageObject.isTalkPage then
-- Handle "demospace = main" properly.
                -- {{namespace detect}} uses the same value for all talk namespaces, so that's what
if equalsArrayValue(argKeys.main, ustringLower(demospace)) then
-- the module should do too.
ret = mw.site.namespaces[0].name
                ret = cfg.talk
else
            else
ret = demospace
                ret = pageObject.nsText
end
            end
else
        else
local pageObject = p.getPageObject(page)
            return nil -- return nil if the page object doesn't exist.
if pageObject then
        end
if pageObject.isTalkPage then
    end
-- Get the subject namespace if the option is set,
    return mw.ustring.lower(ret)
-- otherwise use "talk".
if yesno(subjectns) then
ret = mw.site.namespaces[pageObject.namespace].subject.name
else
ret = 'talk'
end
else
ret = pageObject.nsText
end
else
return nil -- return nil if the page object doesn't exist.
end
end
ret = ret:gsub('_', ' ')
return ustringLower(ret)
end
end


-- Compare the namespace found with the parameters that have been specified, and return content of
-- the appropriate parameter.
function p._main(args)
function p._main(args)
    -- Get the namespace to compare the parameters to, and the parameter mapping table.
-- Check the parameters stored in the mappings table for any matches.
    local namespace = getNamespace(args[cfg.page], args[cfg.demospace])
local namespace = getNamespace(args) or 'other' -- "other" avoids nil table keys
    local mappings = p.getParamMappings()
local params = mappings[namespace] or {}
   
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] 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] then
--]]
        return args[cfg.other]
if ret == nil then
    end
ret = fetchValue(args, argKeys.other)
end
return ret
end
end


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


return p
return p

Latest revision as of 14:35, 7 April 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 in -- -- Module:Namespace detect/config. -- -- --

--]]

local data = mw.loadData('Module:Namespace detect/data') local argKeys = data.argKeys local cfg = data.cfg local mappings = data.mappings

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 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) -- Get the page object, passing the function through pcall in case of -- errors, e.g. being over the expensive function count limit. if page then local success, pageObject = pcall(mw.title.new, page) if success then return pageObject else return nil end else return mw.title.getCurrentTitle() end end

-- Provided for backward compatibility with other modules function p.getParamMappings() return mappings end

local function getNamespace(args) -- This function gets the namespace name from the page object. local page = fetchValue(args, argKeys.demopage) if page == then page = nil end local demospace = fetchValue(args, argKeys.demospace) if demospace == then demospace = nil end local subjectns = fetchValue(args, argKeys.subjectns) local ret if demospace then -- Handle "demospace = main" properly. if equalsArrayValue(argKeys.main, ustringLower(demospace)) then ret = mw.site.namespaces[0].name else ret = demospace end else local pageObject = p.getPageObject(page) if pageObject then if pageObject.isTalkPage then -- Get the subject namespace if the option is set, -- otherwise use "talk". if yesno(subjectns) then ret = mw.site.namespaces[pageObject.namespace].subject.name else ret = 'talk' end else ret = pageObject.nsText end else return nil -- return nil if the page object doesn't exist. end end ret = ret:gsub('_', ' ') return ustringLower(ret) end

function p._main(args) -- Check the parameters stored in the mappings table for any matches. local namespace = getNamespace(args) or 'other' -- "other" avoids nil table keys local params = mappings[namespace] or {} local ret = fetchValue(args, params) --[[ -- 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 ret == nil then ret = fetchValue(args, argKeys.other) end return ret end

function p.main(frame) mArguments = require('Module:Arguments') local args = mArguments.getArgs(frame, {removeBlanks = false}) local ret = p._main(args) return ret or 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. --]]

-- 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 local nsHeader = checkValue(cfg.wikitableNamespaceHeader, 'Namespace') local aliasesHeader = checkValue(cfg.wikitableAliasesHeader, 'Aliases')

-- Put the namespaces in order. local mappingsOrdered = {} for nsname, params in pairs(mappings) do if useTalk or nsname ~= 'talk' then local nsid = namespaces[nsname].id -- Add 1, as the array must start with 1; nsid 0 would be lost otherwise. nsid = nsid + 1 mappingsOrdered[nsid] = params end end mappingsOrdered = mTableTools.compressSparseArray(mappingsOrdered)

-- Build the table. local ret = '{| class="wikitable"' .. '\n|-' .. '\n! ' .. nsHeader .. '\n! ' .. aliasesHeader for i, params in ipairs(mappingsOrdered) do for j, param in ipairs(params) do if j == 1 then ret = ret .. '\n|-' .. '\n| ' .. param .. '' .. '\n| ' elseif j == 2 then ret = ret .. '' .. param .. '' else ret = ret .. ', ' .. param .. '' end end end ret = ret .. '\n|-' .. '\n|}' return ret end

return p

Retrieved from "https://sarkarverse.org/index.php?title=Module:Namespace_detect&oldid=22065"