Difference between revisions of "Module:Namespace detect"

From Wikitia
Jump to navigation Jump to search
(make some of the functions public for use in Module:Category handler, redo compare() code, use local variables instead of globals where possible)
(allow access to the p._main() function from other modules, add an option to use the cfg.talk parameter in p.table(), and whitespace tweaks)
Line 1: Line 1:
----------------------------------------------------------------------
+
----------------------------------------------------------------------------------------------------
--                                                                 --
+
--                                                                                               --
--                       NAMESPACE DETECT                         --
+
--                                           NAMESPACE DETECT                                     --
--                                                                 --
+
--                                                                                               --
--      This module implements the {{namespace detect}} template   --
+
--      This module implements the {{namespace detect}} template in Lua, with a few              --
--      in Lua, with a few improvements: all namespaces and all     --
+
--      improvements: all namespaces and all namespace aliases are supported, and namespace       --
--      namespace aliases are supported, and namespace names are    --
+
--      names are detected automatically for the local wiki. Function names can be configured    --
--      detected automatically for the local wiki. Function names   --
+
--      for different wikis by altering the values in the "cfg" table.                           --
--      can be configured for different wikis by altering the       --
+
--                                                                                               --
--      values in the "cfg" table.                                 --
+
----------------------------------------------------------------------------------------------------
--                                                                 --
 
----------------------------------------------------------------------
 
  
----------------------------------------------------------------------
+
----------------------------------------------------------------------------------------------------
--                     Configuration data                         --
+
--                                         Configuration data                                   --
--      Language-specific parameter names can be set here.         --
+
--      Language-specific parameter names can be set here.                                       --
----------------------------------------------------------------------
+
----------------------------------------------------------------------------------------------------
  
 
local cfg = {}
 
local cfg = {}
Line 25: Line 23:
 
cfg.talk = 'talk'
 
cfg.talk = 'talk'
  
-- The name for the parameter to display content for "other" namespaces
+
-- The name for the parameter to display content for "other" namespaces (namespaces for which
-- (namespaces for which parameters have not been specified, or for when
+
-- parameters have not been specified, or for when cfg.demospace is set to cfg.other):
-- cfg.demospace is set to cfg.other):
 
 
cfg.other = 'other'
 
cfg.other = 'other'
  
Line 36: Line 33:
 
cfg.page = 'page'
 
cfg.page = 'page'
  
-- The header for the namespace column in the wikitable containing the  
+
-- The header for the namespace column in the wikitable containing the list of possible
-- list of possible subject-space parameters.
+
-- subject-space parameters.
 
cfg.wikitableNamespaceHeader = 'Namespace'
 
cfg.wikitableNamespaceHeader = 'Namespace'
  
-- The header for the wikitable containing the list of possible
+
-- The header for the wikitable containing the list of possible subject-space parameters.
-- subject-space parameters.
 
 
cfg.wikitableAliasesHeader = 'Aliases'
 
cfg.wikitableAliasesHeader = 'Aliases'
  
----------------------------------------------------------------------
+
----------------------------------------------------------------------------------------------------
--                    End configuration data                      --
+
--                                       End configuration data                                  --
----------------------------------------------------------------------
+
----------------------------------------------------------------------------------------------------
 
 
----------------------------------------------------------------------
 
--                        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.
 
-- Declare the table of functions to return.
 
local p = {}
 
local p = {}
  
-- 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
-- specified, or nil if there are errors in the title or if the
+
-- errors in the title or if the expensive function count has been exceeded.
-- expensive function count has been exceeded.
+
function p.getPageObject(page)
function p.getPageObject( page )
 
    -- Get the title object for args.page if it is specified. Otherwise
 
    -- get the title object for the current page.
 
 
     if page then
 
     if 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
        -- in case we are over the expensive function count limit.
+
-- 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
Line 78: Line 64:
 
end
 
end
  
--[[ Returns a table of how parameter names map to namespace names.
+
--[[ Returns a table of how parameter names map to namespace names. The keys are the actual namespace  
The keys are the actual namespace names, in lower case, and the  
+
  names, in lower case, and the values are the possible parameter names for that namespace, also in
values are the possible parameter names for that namespace, also
+
  lower case. The table entries are structured like this:
in lower case. The table entries are structured like this:
 
 
     [''] = {
 
     [''] = {
 
         {'main'},
 
         {'main'},
 
     },
 
     },
 
     ['wikipedia'] = {
 
     ['wikipedia'] = {
         {'wikipedia', 'project', 'wp' }
+
         {'wikipedia', 'project', 'wp'}
 
     }
 
     }
 
]]  
 
]]  
 
function p.getParamMappings()
 
function p.getParamMappings()
 
     local mappings = {}
 
     local mappings = {}
     mappings[mw.ustring.lower( mw.site.namespaces[0].name )] = { cfg.main }
+
     mappings[mw.ustring.lower(mw.site.namespaces[0].name)] = {cfg.main}
     mappings[cfg.talk] = { cfg.talk }
+
     mappings[cfg.talk] = {cfg.talk}
     for nsid, ns in pairs( mw.site.subjectNamespaces ) do
+
     for nsid, ns in pairs(mw.site.subjectNamespaces) do
 
         if nsid ~= 0 then -- Exclude main namespace.
 
         if nsid ~= 0 then -- Exclude main namespace.
             local nsname = mw.ustring.lower( ns.name )
+
             local nsname = mw.ustring.lower(ns.name)
             local canonicalName = mw.ustring.lower( ns.canonicalName )
+
             local canonicalName = mw.ustring.lower(ns.canonicalName)
             mappings[nsname] = { nsname }
+
             mappings[nsname] = {nsname}
 
             if canonicalName ~= nsname then
 
             if canonicalName ~= nsname then
                 table.insert( mappings[nsname], canonicalName )
+
                 table.insert(mappings[nsname], canonicalName)
 
             end
 
             end
             for _, alias in ipairs( ns.aliases ) do
+
             for _, alias in ipairs(ns.aliases) do
                 table.insert( mappings[nsname], mw.ustring.lower( alias ) )
+
                 table.insert(mappings[nsname], mw.ustring.lower(alias))
 
             end
 
             end
 
         end
 
         end
Line 109: Line 94:
 
end
 
end
  
--[[ Create a wikitable of all subject namespace parameters, for documentation
+
--[[ Create a wikitable of all subject namespace parameters, for documentation purposes. The talk
   purposes. Talk is excluded, as it should usually be treated separately in
+
   parameter is optional, in case it needs to be excluded in the documentation.
  the documentation.
 
 
]]
 
]]
function p.table()
+
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.
 
     -- Get the parameter mappings.
 
     local mappings = p.getParamMappings()
 
     local mappings = p.getParamMappings()
Line 128: Line 115:
 
         .. '\n| <code>' .. cfg.main .. '</code>'
 
         .. '\n| <code>' .. cfg.main .. '</code>'
 
         .. '\n|'
 
         .. '\n|'
 +
 +
    if useTalk then
 +
        ret = ret .. '\n|-'
 +
            .. '\n| <code>' .. cfg.talk .. '</code>'
 +
            .. '\n|'
 +
    end
 
          
 
          
 
     -- Enclose all parameter names in <code> tags.
 
     -- Enclose all parameter names in <code> tags.
     for ns, params in pairs( mappings ) do
+
     for ns, params in pairs(mappings) do
 
         if ns ~= mw.site.namespaces[0].name then
 
         if ns ~= mw.site.namespaces[0].name then
             for i, param in ipairs( params ) do
+
             for i, param in ipairs(params) do
 
                 mappings[ns][i] = '<code>' .. param .. '</code>'
 
                 mappings[ns][i] = '<code>' .. param .. '</code>'
 
             end
 
             end
Line 139: Line 132:
 
      
 
      
 
     -- Generate the other wikitable rows.
 
     -- Generate the other wikitable rows.
     for ns, params in pairs( mappings ) do
+
     for ns, params in pairs(mappings) do
 
         if ns ~= mw.site.namespaces[0].name then -- Ignore the main namespace.
 
         if ns ~= mw.site.namespaces[0].name then -- Ignore the main namespace.
 
             ret = ret .. '\n|-'
 
             ret = ret .. '\n|-'
 
                 .. '\n| ' .. params[1]
 
                 .. '\n| ' .. params[1]
                 .. '\n| ' .. table.concat( params, ', ', 2 )
+
                 .. '\n| ' .. table.concat(params, ', ', 2)
 
         end
 
         end
 
     end
 
     end
Line 154: Line 147:
 
end
 
end
  
----------------------------------------------------------------------
+
-- Gets the namespace name to compare to the arguments. The returned value is lower-case.
--                        Local functions                          --
+
local function getNamespace(page, demospace)
--      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
 
-- is lower-case.
 
local function getNamespace( page, demospace )
 
 
     local ret
 
     local ret
 
     if demospace then
 
     if demospace then
 
         -- Handle "demospace = main" properly.
 
         -- Handle "demospace = main" properly.
         if mw.ustring.lower( demospace ) == cfg.main then
+
         if mw.ustring.lower(demospace) == cfg.main then
 
             ret = mw.site.namespaces[0].name
 
             ret = mw.site.namespaces[0].name
 
         else
 
         else
Line 172: Line 158:
 
         end
 
         end
 
     else
 
     else
         local pageObject = p.getPageObject( page )
+
         local pageObject = p.getPageObject(page)
 
         if pageObject then
 
         if pageObject then
 
             if pageObject.isTalkPage then
 
             if pageObject.isTalkPage then
                 -- {{namespace detect}} uses the same value for all talk
+
                 -- {{namespace detect}} uses the same value for all talk namespaces, so that's what
                -- namespaces, so that's what the module should do too.
+
-- the module should do too.
 
                 ret = cfg.talk
 
                 ret = cfg.talk
 
             else
 
             else
Line 188: Line 174:
 
end
 
end
  
-- 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
-- specified, and return content of the appropriate parameter.
+
-- the appropriate parameter.
local function compare( args )
+
function p._main(args)
     -- Get the namespace to compare the parameters to, and the parameter
+
     -- Get the namespace to compare the parameters to, and the parameter mapping table.
    -- mapping table.
+
     local namespace = getNamespace(args[cfg.page], args[cfg.demospace])
     local namespace = getNamespace( args[cfg.page], args[cfg.demospace] )
 
 
     local mappings = p.getParamMappings()
 
     local mappings = p.getParamMappings()
 
      
 
      
     -- Check for any matches in the namespace arguments. The order we check
+
     -- Check for any matches in the namespace arguments. The order we check them doesn't matter,
    -- 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
+
             -- Check all aliases for matches. The default local namespace is checked first, as
            -- checked first, as {{namespace detect}} checked these before
+
-- {{namespace detect}} checked these before alias names.
            -- 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]
Line 211: Line 195:
 
     end
 
     end
 
      
 
      
     -- If there were no matches, return parameters for other namespaces.  
+
     -- If there were no matches, return parameters for other namespaces. This happens if there
    -- This happens if there was no text specified for the namespace that
+
-- was no text specified for the namespace that was detected or if the demospace parameter
    -- was detected or if the demospace parameter is not a valid namespace.
+
-- is not a valid namespace. Note that the parameter for the detected namespace must be
    -- Note that the parameter for the detected namespace must be completely
+
-- 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
 
         return args[cfg.other]
 
         return args[cfg.other]
 
     end
 
     end
 
end
 
end
 
----------------------------------------------------------------------
 
--                            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 template, or the args
    -- template, or the args passed to #invoke if any exist. Otherwise
+
-- passed to #invoke if any exist. Otherwise assume args are being passed directly in.
    -- 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
Line 244: Line 218:
 
     end
 
     end
 
      
 
      
     -- Trim whitespace and remove blank arguments for demospace and  
+
     -- Trim whitespace and remove blank arguments for demospace and page parameters.
    -- page parameters.
 
 
     local args = {}
 
     local args = {}
 
     for k, v in pairs(origArgs) do
 
     for k, v in pairs(origArgs) do
         v = mw.text.trim(v) -- Trim whitespace.
+
         if type(v) == 'string' then
 +
            v = mw.text.trim(v) -- Trim whitespace.
 +
        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
Line 258: Line 233:
 
     end
 
     end
 
      
 
      
     return compare(args)
+
     return p._main(args)
 
end
 
end
  
 
return p
 
return p

Revision as of 10:34, 20 October 2013

Lua error in package.lua at line 80: module 'Module:Transclusion_count/data/N' not found.

This module allows you to output different text depending on the namespace that a given page is in. It is a Lua implementation of the {{namespace detect}} template, with a few improvements: all namespaces and all namespace aliases are supported, and namespace names are detected automatically for the local wiki.

Usage

{{#invoke: Namespace detect | main
| page              = <!-- page to detect namespace for, if not the current page -->
| main              = <!-- text to return for the main namespace -->
| talk              = <!-- text to return for talk namespaces -->

<!-- text to return for specific subject namespaces -->
| portal            = 
| category          = 
| user 	            = 
| wikipedia         = 
| education program = 
| mediawiki         = 
| book              = 
| timedtext         = 
| template          = 
| special           = 
| media             = 
| file              = 
| image             = 
| help 	            = 
| module            = 

| other             = <!-- text to return for unspecified namespaces -->
| demospace         = <!-- namespace to display text for -->

| subjectns         = <!-- set to "yes" to treat talk pages as the corresponding subject page -->
}}

Parameters

  • main - text to return if the page is in the main namespace.
  • talk - text to return if the page is in a talk namespace. This can be any talk namespace - it will match any of "Talk:", "Wikipedia talk:", "User talk:", etc.
  • Subject namespace parameters, e.g. wikipedia, user, file... - the text to return if the page is in the corresponding namespace. This module accepts all subject namespaces as parameters, including namespace aliases and virtual namespaces. See below for a list of supported values.
  • other - text to return if no parameters for the page's namespace were specified. This text is also returned if |demospace= is set to an invalid namespace value.
  • subjectns - if on a talk page, use the corresponding subject page. Can be set with values of "yes", "y", "true" or "1".
  • demopage - specifies a page to detect the namespace of. If not specified, and if the |demospace= parameter is not set, then the module uses the current page.
  • demospace - force the module to behave as if the page was in the specified namespace. Often used for demonstrations.

Namespace parameters

Possible values for subject namespace parameters are as follows:

Namespace Aliases
main
template
user
special
module
gadget definition
talk
media
help
category
wikitia project
file image
mediawiki
gadget

Table function

Use the following to display a table with the different possible namespace parameters:

{{#invoke:Namespace detect|table|talk=yes}}

To include the parameter for talk namespaces, use |talk=yes.

Porting to different wikis

This module is designed to be portable. To use it on a different wiki, all you need to do is to change the values in Module:Namespace detect/config. Instructions are available on that page.

Technical details

The module uses a data page at Module:Namespace detect/data. This page is loaded with mw.loadData, which means it is processed once per page rather than once per #invoke. This was done for performance reasons.


----------------------------------------------------------------------------------------------------
--                                                                                                --
--                                           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       --
--      names are detected automatically for the local wiki. Function 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 = {}

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

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

-- The name for the parameter to display 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'

-- The name for the parameter to set a demonstration namespace:
cfg.demospace = 'demospace'

-- The name for the parameter to set 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                                   --
----------------------------------------------------------------------------------------------------

-- 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)
    if page then
        -- Get the page object, passing the function through pcall in case we are over the expensive
		-- function count limit.
        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

--[[ 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()
    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. 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

-- Gets the namespace name to compare to the arguments. The returned value is lower-case.
local function getNamespace(page, demospace)
    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
                -- {{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
            return nil -- return nil if the page object doesn't exist.
        end
    end
    return mw.ustring.lower(ret)
end

-- Compare the namespace found with the parameters that have been specified, and return content of
-- the appropriate parameter.
function p._main(args)
    -- Get the namespace to compare the parameters to, and the parameter mapping table.
    local namespace = getNamespace(args[cfg.page], args[cfg.demospace])
    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
			-- {{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.
    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

return p