ਮੌਡਿਊਲ:Check for unknown parameters

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

Usage

Basic usage

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

or to sort the entries in the tracking category by parameter with a preview error message

{{#invoke:check for unknown parameters|check|unknown=[[Category:Some tracking category|_VALUE_]]|preview=unknown parameter "_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}}

Here, arg1, arg2, ..., argN, are the known parameters. Unnamed (positional) parameters can be added too: |1|2|argname1|argname2|.... 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. That is, both unlisted |foo=x and |foo= are reported. To only track non-blank parameters use |ignoreblank=1.

By default, the module ignores blank positional parameters. That is, an unlisted |2= is ignored. To include blank positional parameters in the tracking use |showblankpositional=1.

Lua patterns

This module supports Lua patterns (similar to regular expressions), which are useful when there are many known parameters which use a systematic pattern. For example, template:infobox3cols uses

| regexp1 = header[%d][%d]*| regexp2 = label[%d][%d]*| regexp3 = data[%d][%d]*[abc]?| regexp4 = class[%d][%d]*[abc]?| regexp5 = rowclass[%d][%d]*| regexp6 = rowstyle[%d][%d]*| regexp7 = rowcellstyle[%d][%d]*

to match all parameters of the form headerNUM, labelNUM, dataNUM, dataNUMa, dataNUMb, dataNUMc, ..., rowcellstyleNUM, where NUM is a string of digits.

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 = {{main other|[[Category:Some tracking category|_VALUE_]]}}| preview = unknown parameter "_VALUE_"| name| height | weight| website}}

Call from within Lua code

See the end of Module:Rugby box for a simple example or Module:Infobox3cols or Module:Flag for more complicated examples.

Category:Unknown parameters (1) (category page can have header {{Unknown parameters category}})
Template:Checks for unknown parameters – adds documentation to templates using this module
Module:Check for deprecated parameters – similar module that checks for deprecated parameters
Module:Check for clobbered parameters – module that checks for conflicting parameters
Module:TemplatePar – similar function (originally from dewiki)
Template:Parameters and Module:Parameters – generates a list of parameter names for a given template
Project:TemplateData based template parameter validation
Module:Parameter validation checks a lot more
User:Bamyers99/TemplateParametersTool - A tool for checking usage of template parameters

-- 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 trim(s)return s:match('^%s*(.-)%s*$')endlocal function isnotempty(s)return s and s:match('%S')endlocal function clean(text)-- Return text cleaned for display and truncated if too long.-- Strip markers are replaced with dummy text representing the original wikitext.local pos, truncatedlocal function truncate(text)if truncated thenreturn ''endif mw.ustring.len(text) > 25 thentruncated = truetext = mw.ustring.sub(text, 1, 25) .. '...'endreturn mw.text.nowiki(text)endlocal parts = {}for before, tag, remainder in text:gmatch('([^\127]*)\127[^\127]*%-(%l+)%-[^\127]*\127()') dopos = remaindertable.insert(parts, truncate(before) .. '&lt;' .. tag .. '&gt;...&lt;/' .. tag .. '&gt;')endtable.insert(parts, truncate(text:sub(pos or 1)))return table.concat(parts)endfunction p._check(args, pargs)if type(args) ~= "table" or type(pargs) ~= "table" then-- TODO: error handlingreturnend-- create the list of known args, regular expressions, and the return stringlocal knownargs = {}local regexps = {}for k, v in pairs(args) doif type(k) == 'number' thenv = trim(v)knownargs[v] = 1elseif k:find('^regexp[1-9][0-9]*$') thentable.insert(regexps, '^' .. v .. '$')endend-- loop over the parent args, and make sure they are on the listlocal ignoreblank = isnotempty(args['ignoreblank'])local showblankpos = isnotempty(args['showblankpositional'])local values = {}for k, v in pairs(pargs) doif type(k) == 'string' and knownargs[k] == nil thenlocal knownflag = falsefor _, regexp in ipairs(regexps) doif mw.ustring.match(k, regexp) thenknownflag = truebreakendendif not knownflag and ( not ignoreblank or isnotempty(v) )  thentable.insert(values, clean(k))endelseif type(k) == 'number' and knownargs[tostring(k)] == nil thenlocal knownflag = falsefor _, regexp in ipairs(regexps) doif mw.ustring.match(tostring(k), regexp) thenknownflag = truebreakendendif not knownflag and ( showblankpos or isnotempty(v) ) thentable.insert(values, k .. ' = ' .. clean(v))endendend-- add results to the output tableslocal res = {}if #values > 0 thenlocal unknown_text = args['unknown'] or 'Found _VALUE_, 'if mw.getCurrentFrame():preprocess( "{{REVISIONID}}" ) == "" thenlocal preview_text = args['preview']if isnotempty(preview_text) thenpreview_text = require('Module:If preview')._warning({preview_text})elseif preview == nil thenpreview_text = unknown_textendunknown_text = preview_textendfor _, v in pairs(values) do-- Fix odd bug for | = which gets stripped to the empty string and-- breaks category linksif v == '' then v = ' ' end-- avoid error with v = 'example%2' ("invalid capture index")local r = unknown_text:gsub('_VALUE_', {_VALUE_ = v})table.insert(res, r)endendreturn table.concat(res)endfunction p.check(frame)local args = frame.argslocal pargs = frame:getParent().argsreturn p._check(args, pargs)endreturn p

Search