Sarkarverse

Module:Namespace detect: Difference between revisions

Module Discussion

Module:Namespace detect (view source)

Revision as of 06:02, 14 October 2013

2,111 bytes removed ,  14 October 2013
++
m (1 revision)
 
(++)
Line 48: Line 48:
----------------------------------------------------------------------
----------------------------------------------------------------------


----------------------------------------------------------------------
-- Specify variables available to the whole module
--                        Global functions                          --
--      The following functions are global, because we want them    --
--      to be accessible from other Lua modules called using        --
--      require().                                                  --
----------------------------------------------------------------------
 
-- Declare the table of functions to return.
local p = {}
local p = {}
local args = {}


-- Get the page object. This will return the page object for the page
-- 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
-- specified, or nil if there are errors in the title or if the
-- expensive function count has been exceeded.
-- expensive function count has been exceeded.
function p.getPageObject( page )
local function getPageObject()
     -- Get the title object for args.page if it is specified. Otherwise
     -- Get the title object for args.page if it is specified. Otherwise
     -- get the title object for the current page.
     -- get the title object for the current page.
     if page then
     if args[cfg.page] then
         -- Get the page object, passing the function through pcall  
         -- Get the page object, passing the function through pcall  
         -- in case we are over the expensive function count limit.
         -- in case we are over the expensive function count limit.
         local noError, pageObject = pcall(mw.title.new, page)
         local noError, pageObject = pcall(mw.title.new, args[cfg.page])
         if not noError then
         if not noError then
             return nil
             return nil
Line 78: Line 72:
end
end


--[[ Returns a table of how parameter names map to namespace names.
-- Detects the namespace for a page object.
The keys are the actual namespace names, in lower case, and the
local function detectNamespace(pageObject)
values are the possible parameter names for that namespace, also
     if pageObject.isTalkPage then
in lower case. The table entries are structured like this:
         -- Returns the value of cfg.talk or the local "Talk" namespace name.  
    [''] = {
         return cfg.talk or mw.site.namespaces[1].name
        {'main'},
     else
    },
         return pageObject.nsText
    ['wikipedia'] = {
        {'wikipedia', 'project', 'wp' }
    }
]]
function p.getParamMappings()
     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
 
--[[ Create a wikitable of all subject namespace parameters, for documentation
  purposes. Talk is excluded, as it should usually be treated separately in
  the documentation.
]]
function p.table()
    -- 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|'
       
    -- 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
   
    -- End the wikitable.
    ret = ret .. '\n|-'
        .. '\n|}'
   
    return ret
end
end
----------------------------------------------------------------------
--                        Local functions                          --
--      The following are internal functions, which we do not want  --
--      to be accessible from other modules.                        --
----------------------------------------------------------------------


-- Gets the namespace name to compare to the arguments. The returned value
-- Gets the namespace name to compare to the arguments. The returned value
-- is lower-case.
-- is lower-case.
local function getNamespace( page, demospace )
local function getNamespace()
     local ret
     local ret
     if demospace then
     if args[cfg.demospace] then
         -- Handle "demospace = main" properly.
         -- Handle "demospace = main" properly.
         if mw.ustring.lower( demospace ) == cfg.main then
         if mw.ustring.lower( args[cfg.demospace] ) == cfg.main then
             ret = mw.site.namespaces[0].name
             ret = mw.site.namespaces[0].name
         else
         else
             ret = demospace
             ret = args[cfg.demospace]
         end
         end
     else
     else
         local pageObject = p.getPageObject( page )
         local pageObject = getPageObject()
         if pageObject then
         if pageObject then
             if pageObject.isTalkPage then
             ret = detectNamespace( getPageObject() )
                -- {{namespace detect}} uses the same value for all talk
                -- namespaces, so that's what the module should do too.
                ret = cfg.talk
            else
                ret = pageObject.nsText
            end
         else
         else
             return nil -- return nil if the page object doesn't exist.
             return nil -- return nil if the page object doesn't exist.
Line 190: Line 106:
-- Compare the namespace found with the parameters that have been
-- Compare the namespace found with the parameters that have been
-- specified, and return content of the appropriate parameter.
-- specified, and return content of the appropriate parameter.
local function compare( args )
local function compare()
     -- Get the namespace to compare the parameters to, and the parameter
     local namespace = getNamespace()
     -- mapping table.
   
     local namespace = getNamespace( args[cfg.page], args[cfg.demospace] )
     -- First, compare mainspace parameters.
     local mappings = p.getParamMappings()
     if namespace == mw.site.namespaces[0].name and args[cfg.main] then
        return args[cfg.main]
     end
      
      
     -- Check for any matches in the namespace arguments. The order we check
     -- Next, compare parameters for non-main namespaces.
    -- them doesn't matter, as there can only be one match.
     for nsid, ns in pairs( mw.site.namespaces ) do
     for ns, params in pairs( mappings ) do
        local nsname = mw.ustring.lower( ns.name )
         if ns == namespace then
        local canonicalName = mw.ustring.lower( ns.canonicalName )
             -- Check all aliases for matches. The default local namespace is
        -- Check the namespace, and ignore main namespace values.
             -- checked first, as {{namespace detect}} checked these before
         if nsid ~= 0 and nsname == namespace then
             -- alias names.
             -- Check local namespace name.
            for _, param in ipairs( params ) do
            if args[nsname] then
                if args[param] then
                return args[nsname]
                     return args[param]
             -- Check canonical namespace name.
             elseif args[canonicalName] then
                return args[canonicalName]
            else
                -- Check alias names.
                for _, alias in ipairs( ns.aliases ) do
                    local aliasArg = args[ mw.ustring.lower( alias ) ]
                    if aliasArg then
                        return aliasArg
                     end
                 end
                 end
             end
             end
Line 211: Line 138:
     end
     end
      
      
     -- If there were no matches, return parameters for other namespaces.  
     -- Finally, return parameters for other namespaces. This happens if
     -- This happens if there was no text specified for the namespace that
     -- there was no text specified for the namespace that was detected
     -- was detected or if the demospace parameter is not a valid namespace.
     -- or if the demospace parameter is not a valid namespace. Note that
     -- Note that the parameter for the detected namespace must be completely
     -- the parameter for the detected namespace must be completely
     -- absent for this to happen, not merely blank.
     -- absent for this to happen, not merely blank.
     if args[cfg.other] then
     if args[cfg.other] then
Line 221: Line 148:
end
end


----------------------------------------------------------------------
-- Process the arguments.
--                            Main function                        --
--      This is the function that will be most used. It processes  --
--      the arguments and calls the compare() function. It is      --
--      global, but is put down here as it depends on the other    --
--      local in order for it to work.                             --
----------------------------------------------------------------------
 
function p.main(frame)
function p.main(frame)
     -- If called via #invoke, use the args passed into the invoking
     -- If called via #invoke, use the args passed into the invoking
Line 246: Line 166:
     -- Trim whitespace and remove blank arguments for demospace and  
     -- Trim whitespace and remove blank arguments for demospace and  
     -- page parameters.
     -- page parameters.
    local args = {}
     for k, v in pairs(origArgs) do
     for k, v in pairs(origArgs) do
         v = mw.text.trim(v) -- Trim whitespace.
         v = mw.text.trim(v) -- Trim whitespace.
Line 258: Line 177:
     end
     end
      
      
     return compare(args)
     return compare()
end
 
-- Create a wikitable of all possible namespace parameters.
function p.table()
    -- Start the wikitable.
    local ret = '{| class="wikitable"'
        .. '\n|-'
        .. '\n! ' .. cfg.wikitableNamespaceHeader
        .. '\n! ' .. cfg.wikitableAliasesHeader
   
    -- Generate the row for the main namespace.
    ret = ret .. '\n|-'
        .. '\n| ' .. cfg.main
        .. '\n|'
   
    -- Generate the other wikitable rows.
    for nsid, ns in pairs( mw.site.subjectNamespaces ) do
        if nsid ~= 0 then -- Ignore the main namespace, as it is set in cfg.
            local name = '<code>' .. mw.ustring.lower( ns.name ) .. '</code>'
            local aliases = {}
            if ns.canonicalName ~= ns.name then
                table.insert( aliases, '<code>' .. mw.ustring.lower( ns.canonicalName ) .. '</code>' )
            end
            for _, v in ipairs( ns.aliases ) do
                table.insert( aliases, '<code>' .. mw.ustring.lower(v) .. '</code>' )
            end
            ret = ret .. '\n|-'
                .. '\n| ' .. name
                .. '\n| ' .. table.concat( aliases, ', ' )
        end
    end
   
    -- End the wikitable.
    ret = ret .. '\n|-'
        .. '\n|}'
   
    return ret
end
end


return p
return p
T12
Administrators
14,061

edits

Retrieved from "https://sarkarverse.org/wiki/Special:MobileDiff/2853"