Module:Check for unknown parameters: Difference between revisions

Jump to navigation Jump to search

Module:Check for unknown parameters (view source)

Revision as of 11:01, 17 October 2025

2,161 bytes added ,  17 October 2025
document missing mapframe parameter aliases
(Created page with "-- 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...")
 
(document missing mapframe parameter aliases)
Line 2: Line 2:
-- with a list of arguments, returning a specified result if an argument is
-- with a list of arguments, returning a specified result if an argument is
-- not on the list
-- not on the list
require ('strict');
local p = {}
local p = {}
local mapframe_params = {
'coord',
'coordinates',
'id',
'qid',
'mapframe',
'mapframe-area_km2',
'mapframe-area_mi2',
'mapframe-caption',
'mapframe-coord',
'mapframe-coordinates',
'mapframe-custom',
'mapframe-frame-coord',
'mapframe-frame-coordinates',
'mapframe-frame-height',
'mapframe-frame-width',
'mapframe-geomask',
'mapframe-geomask-fill',
'mapframe-geomask-fill-opacity',
'mapframe-geomask-stroke-color',
'mapframe-geomask-stroke-colour',
'mapframe-geomask-stroke-width',
'mapframe-height',
'mapframe-id',
'mapframe-length_km',
'mapframe-length_mi',
'mapframe-line',
'mapframe-line-stroke-color',
'mapframe-line-stroke-colour',
'mapframe-marker',
'mapframe-marker-color',
'mapframe-marker-colour',
'mapframe-point',
'mapframe-population',
'mapframe-shape',
'mapframe-shape-fill',
'mapframe-shape-fill-opacity',
'mapframe-shape-stroke-color',
'mapframe-shape-stroke-colour',
'mapframe-stroke-color',
'mapframe-stroke-colour',
'mapframe-stroke-width',
'mapframe-switcher',
'mapframe-type',
'mapframe-width',
'mapframe-wikidata',
'mapframe-zoom'
}


local function trim(s)
local function trim(s)
Line 9: Line 61:


local function isnotempty(s)
local function isnotempty(s)
return s and trim(s) ~= ''
return s and s:match('%S')
end
end


function p.check (frame)
local function clean(text)
local args = frame.args
-- Return text cleaned for display and truncated if too long.
local pargs = frame:getParent().args
-- Strip markers are replaced with dummy text representing the original wikitext.
local ignoreblank = isnotempty(frame.args['ignoreblank'])
local pos, truncated
local showblankpos = isnotempty(frame.args['showblankpositional'])
local function truncate(text)
local knownargs = {}
if truncated then
local unknown = frame.args['unknown'] or 'Found _VALUE_, '
return ''
local preview = frame.args['preview']
end
if mw.ustring.len(text) > 25 then
truncated = true
text = mw.ustring.sub(text, 1, 25) .. '...'
end
return mw.text.nowiki(text)
end
local parts = {}
for before, tag, remainder in text:gmatch('([^\127]*)\127[^\127]*%-(%l+)%-[^\127]*\127()') do
pos = remainder
table.insert(parts, truncate(before) .. '<' .. tag .. '>...</' .. tag .. '>')
end
table.insert(parts, truncate(text:sub(pos or 1)))
return table.concat(parts)
end


local values = {}
function p._check(args, pargs)
local res = {}
if type(args) ~= "table" or type(pargs) ~= "table" then
local regexps = {}
-- TODO: error handling
return
end


-- create the list of known args, regular expressions, and the return string
-- create the list of known args, regular expressions, and the return string
local knownargs = {}
if isnotempty(args['mapframe_args']) then
for _, v in ipairs(mapframe_params) do
    knownargs[v] = 1
end
end
local regexps = {}
for k, v in pairs(args) do
for k, v in pairs(args) do
if type(k) == 'number' then
if type(k) == 'number' then
Line 34: Line 111:
end
end
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
-- loop over the parent args, and make sure they are on the list
local ignoreblank = isnotempty(args['ignoreblank'])
local showblankpos = isnotempty(args['showblankpositional'])
local values = {}
for k, v in pairs(pargs) do
for k, v in pairs(pargs) do
if type(k) == 'string' and knownargs[k] == nil then
if type(k) == 'string' and knownargs[k] == nil then
local knownflag = false
local knownflag = false
for i, regexp in ipairs(regexps) do
for _, regexp in ipairs(regexps) do
if mw.ustring.match(k, regexp) then
if mw.ustring.match(k, regexp) then
knownflag = true
knownflag = true
Line 51: Line 126:
end
end
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\-_ ]', '?')
table.insert(values, clean(k))
table.insert(values, k)
end
elseif type(k) == 'number' and knownargs[tostring(k)] == nil then
local knownflag = false
for _, regexp in ipairs(regexps) do
if mw.ustring.match(tostring(k), regexp) then
knownflag = true
break
end
end
if not knownflag and ( showblankpos or isnotempty(v) ) then
table.insert(values, k .. ' = ' .. clean(v))
end
end
elseif type(k) == 'number' and
knownargs[tostring(k)] == nil and
( showblankpos or isnotempty(v) )
then
local vlen = mw.ustring.len(v)
v = mw.ustring.sub(v, 1, (vlen < 25) and vlen or 25)
v = mw.ustring.gsub(v, '[^%w\-_ ]', '?')
table.insert(values, k .. ' = ' .. v .. ((vlen >= 25) and ' ...' or ''))
end
end
end
end


-- add resuls to the output tables
-- add results to the output tables
local res = {}
if #values > 0 then
if #values > 0 then
if frame:preprocess( "{{REVISIONID}}" ) == "" then
local unknown_text = args['unknown'] or 'Found _VALUE_, '
unknown = preview
 
if mw.getCurrentFrame():preprocess( "{{REVISIONID}}" ) == "" then
local preview_text = args['preview']
if isnotempty(preview_text) then
preview_text = require('Module:If preview')._warning({preview_text})
elseif preview_text == nil then
preview_text = unknown_text
end
unknown_text = preview_text
end
end
for k, v in pairs(values) do
for _, v in pairs(values) do
if v == '' then
-- Fix odd bug for | = which gets stripped to the empty string and
-- Fix odd bug for | = which gets stripped to the empty string and
-- breaks category links
-- breaks category links
v = ' '
if v == '' then v = ' ' end
end
 
local r = unknown:gsub('_VALUE_', v)
-- avoid error with v = 'example%2' ("invalid capture index")
local r = unknown_text:gsub('_VALUE_', {_VALUE_ = v})
table.insert(res, r)
table.insert(res, r)
end
end
Line 82: Line 168:


return table.concat(res)
return table.concat(res)
end
function p.check(frame)
local args = frame.args
local pargs = frame:getParent().args
return p._check(args, pargs)
end
end


return p
return p
Anonymous user
Retrieved from "https://linguifex.com/wiki/Special:MobileDiff/477389"

Navigation menu