TEPwiki

Module:Namespace detect: Difference between revisions

Module Discussion

Module:Namespace detect (view source)

Revision as of 12:01, 5 April 2014

2,311 bytes removed ,  10 years ago
use demopage instead of page as the main "page" parameter
nswiki>Afforess
(Created page with "---------------------------------------------------------------------------------------------------- -- ...")
 
(use demopage instead of page as the main "page" parameter)
Line 1:
--[[
----------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------
-- --
-- NAMESPACE DETECT --
-- NAMESPACE DETECT --
-- This module implements the {{namespace detect}} template in Lua, with a few --
-- This module implements the {{namespace detect}} template in Lua, with a --
-- improvements: all namespaces and all namespace aliases are supported, and namespace --
-- few improvements: all namespaces and all namespace aliases are supported, --
-- names are detected automatically for the local wiki. The module can also use the --
-- corresponding subjectand namespace valuenames ifare itdetected isautomatically usedfor onthe alocal talk pagewiki. Parameter names The --
-- module can be configured for different wikis by altering the valuesalso inuse the "cfg"corresponding table.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
-- Configuration data --
local cfg = data.cfg
-- Language-specific parameter names can be set here. --
local mappings = data.mappings
----------------------------------------------------------------------------------------------------
 
local cfgyesno = {}require('Module:Yesno')
local mArguments -- Lazily initialise Module:Arguments
local mTableTools -- Lazily initilalise Module:TableTools
local ustringLower = mw.ustring.lower
 
local p = {}
-- This parameter displays content for the main namespace:
cfg.main = 'main'
 
local function fetchValue(t1, t2)
-- This parameter displays in talk namespaces:
-- Fetches a value from the table t1 for the first key in array t2 where
cfg.talk = 'talk'
-- 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)
-- This parameter displays content for "other" namespaces (namespaces for which
-- Returns true if value equals a value in the array t. Otherwise
-- parameters have not been specified, or for when cfg.demospace is set to cfg.other):
-- returns false.
cfg.other = 'other'
for i, arrayValue in ipairs(t) do
 
if value == arrayValue then
-- This parameter makes talk pages behave as though they are the corresponding subject namespace.
return true
-- Note that this parameter is used with [[Module:Yesno]]. Edit that module to change
end
-- the default values of "yes", "no", etc.
end
cfg.subjectns = 'subjectns'
return false
 
end
-- 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.of
-- errors, e.g. being over the expensive function count limit.
if page then
local noErrorsuccess, pageObject = pcall(mw.title.new, page)
if not noErrorsuccess then
return pageObject
else
return nil
else
return pageObject
end
else
Line 67 ⟶ 65:
end
 
-- Provided for backward compatibility with other modules
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)
-- GetsThis function gets the namespace name from the page object.
local page = fetchValue(args[cfg, argKeys.page]demopage)
if page == '' then
local demospace = args[cfg.demospace]
page = nil
local subjectns = args[cfg.subjectns]
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 mwequalsArrayValue(argKeys.ustring.lowermain, ustringLower(demospace) == cfg.main) then
ret = mw.site.namespaces[0].name
else
Line 113 ⟶ 93:
if pageObject then
if pageObject.isTalkPage then
-- Get the subject namespace if the option is set,
-- If cfg.subjectns is set, get the subject namespace, otherwise use cfg.talk.
-- otherwise use "talk".
if yesno(subjectns) then
ret = mw.site.namespaces[pageObject.namespace].subject.name
else
ret = cfg.'talk'
end
else
Line 126 ⟶ 107:
end
end
ret = mw.ustring.ret:gsub(ret, '_', ' ')
return mw.ustring.lowerustringLower(ret)
end
 
function p._main(args)
-- GetCheck the namespaceparameters tostored comparein the parametersmappings to,table andfor theany parameter mapping tablematches.
local namespace = getNamespace(args) or 'other' -- "other" avoids nil table keys
local mappingsparams = p.getParamMappings()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 nsthere was no text specified for ==the namespace thenthat
-- 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. detect}}Note checkedthat thesethe beforeparameter aliasfor names.the detected namespace must be
for _, param in ipairs(params) do
if args[param] ~= nil 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] ~= nil then
if ret == nil then
return args[cfg.other]
ret = fetchValue(args, argKeys.other)
end
return ret
end
 
function p.main(frame)
mArguments = require('Module:Arguments')
-- If called via #invoke, use the args passed into the invoking template, or the args
local args = mArguments.getArgs(frame, {removeBlanks = false})
-- passed to #invoke if any exist. Otherwise assume args are being passed directly in.
local origArgsret = p._main(args)
return ret or ''
if frame == mw.getCurrentFrame() then
end
origArgs = frame:getParent().args
 
for k, v in pairs(frame.args) do
function p.table(frame)
origArgs = frame.args
--[[
break
-- 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
else
origArgs = frame
end
local nsHeader = checkValue(cfg.wikitableNamespaceHeader, 'Namespace')
-- Trim whitespace and remove blank arguments for demospace and page parameters.
local aliasesHeader = checkValue(cfg.wikitableAliasesHeader, 'Aliases')
local args = {}
 
for k, v in pairs(origArgs) do
-- Put the namespaces in order.
if type(v) == 'string' then
local mappingsOrdered = {}
v = mw.text.trim(v) -- Trim whitespace.
for nsname, params in pairs(mappings) do
end
if k == cfg.demospaceuseTalk or knsname =~= cfg.page'talk' then
local nsid = namespaces[nsname].id
if v ~= '' then
-- Add 1, as the array must start with 1; nsid 0 would be lost otherwise.
args[k] = v
nsid = nsid + 1
end
mappingsOrdered[nsid] = params
else
args[k] = v
end
end
mappingsOrdered = mTableTools.compressSparseArray(mappingsOrdered)
return p._main(args)
end
 
function -- Build the 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.wikitableNamespaceHeadernsHeader
.. '\n! ' .. cfg.wikitableAliasesHeaderaliasesHeader
for i, params in ipairs(mappingsOrdered) do
for j, param in ipairs(params) do
-- Generate the row for the main namespace, as we want this to be first in the list.
if j == 1 then
ret = ret .. '\n|-'
ret = ret .. '\n|-'
.. '\n| <code>' .. cfg.main .. '</code>'
.. '\n| <code>' .. param .. '</code>'
.. '\n| '
if useTalk then
ret elseif =j ret== ..2 '\n|-'then
ret = ret .. '\n| <code>' .. cfg.talkparam .. '</code>'
.. '\n|'else
ret = ret .. ', <code>' .. param .. '</code>'
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|}'
Anonymous user
Retrieved from "https://tep.wiki/wiki/Special:MobileDiff/8426"