Module:Namespace detect: Difference between revisions

From Sarkarverse
Jump to navigation Jump to search
m (1 revision)
 
m (1 revision)
(One intermediate revision by the same user not shown)
Line 5: Line 5:
--      This module implements the {{namespace detect}} template in Lua, with a few              --
--      This module implements the {{namespace detect}} template in Lua, with a few              --
--      improvements: all namespaces and all namespace aliases are supported, and namespace      --
--      improvements: all namespaces and all namespace aliases are supported, and namespace      --
--      names are detected automatically for the local wiki. Function names can be configured    --
--      names are detected automatically for the local wiki. The module can also use the          --
--      for different wikis by altering the values in the "cfg" table.                           --
--      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.         --
--                                                                                                --
--                                                                                                --
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
Line 17: Line 18:
local cfg = {}
local cfg = {}


-- The name for the parameter to display content for the main namespace:
-- This parameter displays content for the main namespace:
cfg.main = 'main'
cfg.main = 'main'


-- The name for the parameter to display content in talk namespaces:
-- This parameter displays in talk namespaces:
cfg.talk = 'talk'
cfg.talk = 'talk'


-- The name for the parameter to display content for "other" namespaces (namespaces for which
-- 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):
-- parameters have not been specified, or for when cfg.demospace is set to cfg.other):
cfg.other = 'other'
cfg.other = 'other'


-- The name for the parameter to set a demonstration namespace:
-- 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'
cfg.demospace = 'demospace'


-- The name for the parameter to set a specific page to compare:
-- This parameter sets a specific page to compare:
cfg.page = 'page'
cfg.page = 'page'


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


Line 44: Line 49:
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------


-- Declare the table of functions to return.
local yesno = require('Module:Yesno')
 
local p = {}
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 we are over the expensive function count limit.
        -- Get the page object, passing the function through pcall in case we are over the expensive
if page then
-- function count limit.
local noError, pageObject = pcall(mw.title.new, page)
        local noError, pageObject = pcall(mw.title.new, page)
if not noError then
        if not noError then
return nil
            return nil
else
        else
return pageObject
            return pageObject
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
  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 = {}
--[[ Returns a table of how parameter names map to namespace names. The keys are the actual namespace
    mappings[mw.ustring.lower(mw.site.namespaces[0].name)] = {cfg.main}
  names, in lower case, and the values are the possible parameter names for that namespace, also in
    mappings[cfg.talk] = {cfg.talk}
  lower case. The table entries are structured like this:
    for nsid, ns in pairs(mw.site.subjectNamespaces) do
[''] = {
        if nsid ~= 0 then -- Exclude main namespace.
{'main'},
            local nsname = mw.ustring.lower(ns.name)
},
            local canonicalName = mw.ustring.lower(ns.canonicalName)
['wikipedia'] = {
            mappings[nsname] = {nsname}
{'wikipedia', 'project', 'wp'}
            if canonicalName ~= nsname then
}
                table.insert(mappings[nsname], canonicalName)
]]
            end
local mappings = {}
            for _, alias in ipairs(ns.aliases) do
mappings[mw.ustring.lower(mw.site.namespaces[0].name)] = {cfg.main}
                table.insert(mappings[nsname], mw.ustring.lower(alias))
mappings[cfg.talk] = {cfg.talk}
            end
for nsid, ns in pairs(mw.site.subjectNamespaces) do
        end
if nsid ~= 0 then -- Exclude main namespace.
    end
local nsname = mw.ustring.lower(ns.name)
    return mappings
local canonicalName = mw.ustring.lower(ns.canonicalName)
end
mappings[nsname] = {nsname}
 
if canonicalName ~= nsname then
--[[ Create a wikitable of all subject namespace parameters, for documentation purposes. The talk
table.insert(mappings[nsname], canonicalName)
  parameter is optional, in case it needs to be excluded in the documentation.
end
]]
for _, alias in ipairs(ns.aliases) do
function p.table(frame)
table.insert(mappings[nsname], mw.ustring.lower(alias))
-- Find whether to use the talk link or not.
end
    local useTalk = type(frame) == 'table' and type(frame.args) == 'table' and frame.args.talk == 'yes'
end
 
end
    -- Get the parameter mappings.
return 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)
-- Gets the namespace name from the page object.
    local ret
local page = args[cfg.page]
    if demospace then
local demospace = args[cfg.demospace]
        -- Handle "demospace = main" properly.
local subjectns = args[cfg.subjectns]
        if mw.ustring.lower(demospace) == cfg.main then
local ret
            ret = mw.site.namespaces[0].name
if demospace then
        else
-- Handle "demospace = main" properly.
            ret = demospace
if mw.ustring.lower(demospace) == cfg.main then
        end
ret = mw.site.namespaces[0].name
    else
else
        local pageObject = p.getPageObject(page)
ret = demospace
        if pageObject then
end
            if pageObject.isTalkPage then
else
                -- {{namespace detect}} uses the same value for all talk namespaces, so that's what
local pageObject = p.getPageObject(page)
-- the module should do too.
if pageObject then
                ret = cfg.talk
if pageObject.isTalkPage then
            else
-- If cfg.subjectns is set, get the subject namespace, otherwise use cfg.talk.
                ret = pageObject.nsText
if yesno(subjectns) then
            end
ret = mw.site.namespaces[pageObject.namespace].subject.name
        else
else
            return nil -- return nil if the page object doesn't exist.
ret = cfg.talk
        end
end
    end
else
    return mw.ustring.lower(ret)
ret = pageObject.nsText
end
else
return nil -- return nil if the page object doesn't exist.
end
end
return mw.ustring.lower(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.
-- Get the namespace to compare the parameters to, and the parameter mapping table.
    local namespace = getNamespace(args[cfg.page], args[cfg.demospace])
local namespace = getNamespace(args)
    local mappings = p.getParamMappings()
local mappings = p.getParamMappings()
   
-- Check for any matches in the namespace arguments. The order we check them doesn't matter,
    -- Check for any matches in the namespace arguments. The order we check them doesn't matter,
-- as there can only be one match.
-- as there can only be one match.
    for ns, params in pairs(mappings) do
for ns, params in pairs(mappings) do
        if ns == namespace then
if ns == namespace then
            -- Check all aliases for matches. The default local namespace is checked first, as
-- Check all aliases for matches. The default local namespace is checked first, as
-- {{namespace detect}} checked these before alias names.
-- {{namespace detect}} checked these before alias names.
            for _, param in ipairs(params) do
for _, param in ipairs(params) do
                if args[param] then
if args[param] then
                    return args[param]
return args[param]
                end
end
            end
end
        end
end
    end
end
   
-- If there were no matches, return parameters for other namespaces. This happens if there
    -- 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
-- 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
-- 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
if args[cfg.other] then
        return args[cfg.other]
return args[cfg.other]
    end
end
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
-- 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.
-- passed to #invoke if any exist. Otherwise assume args are being passed directly in.
    local origArgs
local origArgs
    if frame == mw.getCurrentFrame() then
if frame == mw.getCurrentFrame() then
        origArgs = frame:getParent().args
origArgs = frame:getParent().args
        for k, v in pairs(frame.args) do
for k, v in pairs(frame.args) do
            origArgs = frame.args
origArgs = frame.args
            break
break
        end
end
    else
else
        origArgs = frame
origArgs = frame
    end
end
   
-- Trim whitespace and remove blank arguments for demospace and page parameters.
    -- Trim whitespace and remove blank arguments for demospace and page parameters.
local args = {}
    local args = {}
for k, v in pairs(origArgs) do
    for k, v in pairs(origArgs) do
if type(v) == 'string' then
        if type(v) == 'string' then
v = mw.text.trim(v) -- Trim whitespace.
            v = mw.text.trim(v) -- Trim whitespace.
end
        end
if k == cfg.demospace or k == cfg.page then
        if k == cfg.demospace or k == cfg.page then
if v ~= '' then
            if v ~= '' then
args[k] = v
                args[k] = v
end
            end
else
        else
args[k] = v
            args[k] = v
end
        end
end
    end
return p._main(args)
   
end
    return p._main(args)
 
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| <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


return p
return p

Revision as of 12:01, 24 October 2013

-- -- -- 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 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] 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] 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

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