Module:Namespace detect/data: Difference between revisions

From Laserwiki
Jump to navigation Jump to search
(avoid using local variables to save table lookups per Jackmcbarn's suggestion, and because this will be cached with mw.loadData so performance of this function is not such a worry)
m (22 revisions imported)
 
(12 intermediate revisions by 8 users not shown)
Line 4: Line 4:
-- page, rather than per #invoke, for performance reasons.                    --
-- page, rather than per #invoke, for performance reasons.                    --
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
 
local cfg = require('Module:Namespace detect/config')
local cfg = require('Module:Namespace detect/config')
 
local function addKey(t, key, defaultKey)
local function addKey(t, key, defaultKey)
if key ~= defaultKey then
if key ~= defaultKey then
Line 12: Line 12:
end
end
end
end
 
-- Get a table of parameters to query for each default parameter name.
-- Get a table of parameters to query for each default parameter name.
-- This allows wikis to customise parameter names in the cfg table while
-- This allows wikis to customise parameter names in the cfg table while
-- ensuring that default parameter names will always work. The cfg table
-- ensuring that default parameter names will always work. The cfg table
-- values can be added as a string, or as an array of strings.
-- values can be added as a string, or as an array of strings.
 
local argKeys = {
local defaultKeys = {
main = {'main'},
'main',
talk = {'talk'},
'talk',
other = {'other'},
'other',
subjectns = {'subjectns'},
'subjectns',
demospace = {'demospace'},
'demospace',
page = {'page'}
'demopage'
}
}
 
local argKeys = {}
for i, defaultKey in ipairs(defaultKeys) do
argKeys[defaultKey] = {defaultKey}
end
for defaultKey, t in pairs(argKeys) do
for defaultKey, t in pairs(argKeys) do
local cfgValue = cfg[defaultKey]
local cfgValue = cfg[defaultKey]
Line 39: Line 44:
cfg[defaultKey] = nil -- Free the cfg value as we don't need it any more.
cfg[defaultKey] = nil -- Free the cfg value as we don't need it any more.
end
end
 
local function getParamMappings()
local function getParamMappings()
--[[
--[[
Line 59: Line 64:
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 = ns.name
local nsname = mw.ustring.lower(ns.name)
local canonicalName = ns.canonicalName
local canonicalName = mw.ustring.lower(ns.canonicalName)
mappings[nsname] = {mw.ustring.lower(nsname)}
mappings[nsname] = {nsname}
if canonicalName ~= nsname then
if canonicalName ~= nsname then
table.insert(mappings[nsname], mw.ustring.lower(canonicalName))
table.insert(mappings[nsname], canonicalName)
end
end
for _, alias in ipairs(ns.aliases) do
for _, alias in ipairs(ns.aliases) do
Line 72: Line 77:
return mappings
return mappings
end
end
 
return {
return {
argKeys = argKeys,
argKeys = argKeys,

Latest revision as of 18:25, 17 September 2020

Documentation for this module may be created at Module:Namespace detect/data/doc

--------------------------------------------------------------------------------
--                          Namespace detect data                             --
-- This module holds data for [[Module:Namespace detect]] to be loaded per    --
-- page, rather than per #invoke, for performance reasons.                    --
--------------------------------------------------------------------------------
 
local cfg = require('Module:Namespace detect/config')
 
local function addKey(t, key, defaultKey)
	if key ~= defaultKey then
		t[#t + 1] = key
	end
end
 
-- Get a table of parameters to query for each default parameter name.
-- This allows wikis to customise parameter names in the cfg table while
-- ensuring that default parameter names will always work. The cfg table
-- values can be added as a string, or as an array of strings.
 
local defaultKeys = {
	'main',
	'talk',
	'other',
	'subjectns',
	'demospace',
	'demopage'
}
 
local argKeys = {}
for i, defaultKey in ipairs(defaultKeys) do
	argKeys[defaultKey] = {defaultKey}
end
 
for defaultKey, t in pairs(argKeys) do
	local cfgValue = cfg[defaultKey]
	local cfgValueType = type(cfgValue)
	if cfgValueType == 'string' then
		addKey(t, cfgValue, defaultKey)
	elseif cfgValueType == 'table' then
		for i, key in ipairs(cfgValue) do
			addKey(t, key, defaultKey)
		end
	end
	cfg[defaultKey] = nil -- Free the cfg value as we don't need it any more.
end
 
local function 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 = {}
	local mainNsName = mw.site.subjectNamespaces[0].name
	mainNsName = mw.ustring.lower(mainNsName)
	mappings[mainNsName] = mw.clone(argKeys.main)
	mappings['talk'] = mw.clone(argKeys.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
 
return {
	argKeys = argKeys,
	cfg = cfg,
	mappings = getParamMappings()
}