Module:Check for unknown parameters


This module may be appended to a template to check for uses of unknown parameters.

Usage

{{#invoke:check for unknown parameters|check|unknown=[[Category:Some tracking category]]|arg1|arg2|...|argN}}

or to sort the entries in the tracking category by parameter

{{#invoke:check for unknown parameters|check|unknown=[[Category:Some tracking category|_VALUE_]]|arg1|arg2|...|argN}}

or for an explicit red error message

{{#invoke:check for unknown parameters|check|unknown=<span class=error>Sorry, I don't recognize _VALUE_</span>|arg1|arg2|...|argN}}

or to use hidden error messages which can be viewed in the HTML source

{{#invoke:check for unknown parameters|check|unknown=<span style="display:none">HIDDEN ERROR: Usage of "_VALUE_" is not recognized</span>|arg1|arg2|...|argN}}

Here, arg1, arg2, ..., argN, are the known parameters. Any parameter which is used, but not on this list, will cause the module to return whatever is passed with the unknown parameter. The _VALUE_ keyword, if used, will be changed to the name of the parameter. This is useful for either sorting the entries in a tracking category, or for provide more explicit information.

By default, the module makes no distinction between a defined-but-blank parameter and a non-blank parameter. To only track non-blank parameters use |ignoreblank=1.

Example

{{Infobox| above = {{{name|}}}| label1 = Height| data1 = {{{height|}}}| label2 = Weight| data2 = {{{weight|}}}| label3 = Website| data3 = {{{website|}}}}}<!--   end infobox, start tracking-->{{#invoke:Check for unknown parameters|check| unknown = [[Category:Some tracking category|_VALUE_]]| name| height | weight| website}}


See also


-- 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 listlocal p = {}local function isnotempty(s)return s and s:match( '^%s*(.-)%s*$' ) ~= ''endfunction p.check (frame)local args = frame.argslocal pargs = frame:getParent().argslocal ignoreblank = isnotempty(frame.args['ignoreblank'])local checkpos = isnotempty(frame.args['checkpositional'])local knownargs = {}local unknown = 'Found _VALUE_, 'local res = {}local comments = {}local commentstr = ''-- create the list of known args, and the return stringfor k, v in pairs(args) doif type(k) == 'number' thenv = mw.ustring.gsub(v, '^%s*(.-)%s*$', '%1')knownargs[v] = 1elseif (k == 'unknown' and type(v) == 'string') thenunknown = vendendend-- loop over the parent args, and make sure they are on the listfor k,v in pairs(pargs) doif (type(k) == 'string' and knownargs[k] == nil) thenif( (not ignoreblank) or (ignoreblank and isnotempty(v)) ) thenk = mw.ustring.gsub(k, '[^%w\-_ ]', '?')local r = mw.ustring.gsub(unknown, '_VALUE_', k)table.insert(res, r)table.insert(comments, '"' .. k .. '"')endelseif(checkpos and type(k) == 'number' and knownargs[tostring(k)] == nil) thenif( (not ignoreblank) or (ignoreblank and isnotempty(v)) ) thenlocal r = mw.ustring.gsub(unknown, '_VALUE_', k)table.insert(res, r)table.insert(comments, '"' .. k .. '"')endendendif(#comments > 0) thencommentstr = '<!-- Module:Check for unknown parameters results: ' ..table.concat(comments, ', ') .. '-->'endreturn table.concat(res) .. commentstrendreturn p