Module:Check for unknown parameters: Difference between revisions
From All Skies Encyclopaedia
imported>Frietjes (include non-blank positional in the default, but excluded blank positional in the default) |
imported>Frietjes (reduce REVISIONID checks per thread at https://en.wikipedia.org/w/index.php?title=Wikipedia:Village_pump_%28technical%29&oldid=725747331#Preview-only_template_warnings_using_REVISIONID_magic_word) |
||
Line 21: | Line 21: | ||
local preview = frame.args['preview'] |
local preview = frame.args['preview'] |
||
⚫ | |||
local res = {} |
local res = {} |
||
local regexps = {} |
local regexps = {} |
||
⚫ | |||
local commentstr = '' |
|||
⚫ | |||
-- create the list of known args, regular expressions, and the return string |
-- create the list of known args, regular expressions, and the return string |
||
Line 41: | Line 38: | ||
elseif preview == nil then |
elseif preview == nil then |
||
preview = unknown |
preview = unknown |
||
⚫ | |||
⚫ | |||
⚫ | |||
ignoreblank = false |
|||
⚫ | |||
⚫ | |||
local function addresult(k) |
|||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
table.insert(comments, '"' .. k .. '"') |
|||
end |
end |
||
Line 71: | Line 52: | ||
if not knownflag and ( not ignoreblank or isnotempty(v) ) then |
if not knownflag and ( not ignoreblank or isnotempty(v) ) then |
||
k = mw.ustring.gsub(k, '[^%w\-_ ]', '?') |
k = mw.ustring.gsub(k, '[^%w\-_ ]', '?') |
||
table.insert(values, k) |
|||
end |
end |
||
elseif type(k) == 'number' and |
elseif type(k) == 'number' and |
||
Line 77: | Line 58: | ||
( showblankpos or isnotempty(v) ) |
( showblankpos or isnotempty(v) ) |
||
then |
then |
||
table.insert(values, k) |
|||
end |
end |
||
end |
end |
||
⚫ | |||
if #comments > 0 then |
|||
⚫ | |||
commentstr = '<!-- Module:Check for unknown parameters results: ' .. |
|||
⚫ | |||
table.concat(comments, ', ') .. '-->' |
|||
⚫ | |||
⚫ | |||
for k, v in pairs(values) do |
|||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
end |
end |
||
return table.concat(res) |
return table.concat(res) |
||
end |
end |
||
Revision as of 16:55, 17 June 2016
Documentation for this module may be created at Module:Check for unknown parameters/doc
-- This module may be used to compare the arguments passed to the parent
-- with a list of arguments, returning a specified result if an argument is
-- not on the list
local p = {}
local function trim(s)
return s:match('^%s*(.-)%s*$')
end
local function isnotempty(s)
return s and trim(s) ~= ''
end
function p.check (frame)
local args = frame.args
local pargs = frame:getParent().args
local ignoreblank = isnotempty(frame.args['ignoreblank'])
local showblankpos = isnotempty(frame.args['showblankpositional'])
local knownargs = {}
local unknown = frame.args['unknown'] or 'Found _VALUE_, '
local preview = frame.args['preview']
local values = {}
local res = {}
local regexps = {}
-- create the list of known args, regular expressions, and the return string
for k, v in pairs(args) do
if type(k) == 'number' then
v = trim(v)
knownargs[v] = 1
elseif k:find('^regexp[1-9][0-9]*$') then
table.insert(regexps, '^' .. v .. '$')
end
end
if isnotempty(preview) then
preview = '<div class="hatnote" style="color:red"><strong>Warning:</strong> ' .. preview .. ' (this message is shown only in preview).</div>'
elseif preview == nil then
preview = unknown
end
-- loop over the parent args, and make sure they are on the list
for k, v in pairs(pargs) do
if type(k) == 'string' and knownargs[k] == nil then
local knownflag = false
for i, regexp in ipairs(regexps) do
if mw.ustring.match(k, regexp) then
knownflag = true
break
end
end
if not knownflag and ( not ignoreblank or isnotempty(v) ) then
k = mw.ustring.gsub(k, '[^%w\-_ ]', '?')
table.insert(values, k)
end
elseif type(k) == 'number' and
knownargs[tostring(k)] == nil and
( showblankpos or isnotempty(v) )
then
table.insert(values, k)
end
end
-- add resuls to the output tables
if #values > 0 then
if frame:preprocess( "{{REVISIONID}}" ) == "" then
unknown = preview
end
for k, v in pairs(values) do
if v == '' then
-- Fix odd bug for | = which gets stripped to the empty string and
-- breaks category links
v = ' '
end
local r = unknown:gsub('_VALUE_', v)
table.insert(res, r)
end
end
return table.concat(res)
end
return p