विभाग:Check for unknown parameters
![](http://upload.wikimedia.org/wikipedia/commons/thumb/4/43/Test_Template_Info-Icon_-_Version_%282%29.svg/50px-Test_Template_Info-Icon_-_Version_%282%29.svg.png)
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|...|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}}
Templates invoking this module
The following is a list of some of the templates which invoke this module, with the associated category for each.
List of templates which invoke "Module:Check for unknown parameters" | |
---|---|
Template | Tracking/maintenance category |
साचा:Ti | वर्ग:Pages using authority control with parameters |
साचा:Ti | वर्ग:Pages using aviation accidents and incidents with unknown parameters |
साचा:Ti | वर्ग:Pages using country topics with unknown parameters |
Template:Infobox3cols | Category:Pages using infobox3cols with undocumented parameters |
Template:Infobox academic division | Category:Pages using infobox academic division with unknown parameters |
Template:Infobox amateur wrestler | Category:Pages using infobox amateur wrestler with unknown parameters |
Template:Infobox anatomy | Category:Medicine infobox template using unsupported parameters |
Template:Infobox artery | Category:Medicine infobox template using unsupported parameters |
Template:Infobox astronaut | Category:Pages using infobox astronaut with unknown parameters |
Template:Infobox award | Category:Pages using infobox award with unknown parameters |
Template:Infobox bone | Category:Medicine infobox template using unsupported parameters |
Template:Infobox brain | Category:Medicine infobox template using unsupported parameters |
Template:Infobox broadcast | Category:Pages using infobox broadcast with unknown parameters |
Template:Infobox city Japan | Category:Pages using infobox city Japan with unknown parameters |
Template:Infobox Daytona 500 | Category:Pages using infobox Daytona 500 with unknown parameters |
Template:Infobox embryology | Category:Medicine infobox template using unsupported parameters |
Template:Infobox event | Category:Pages using infobox event with unknown parameters |
Template:Infobox Grand Prix race report | Category:Pages using infobox Grand Prix race report with unknown parameters |
Template:Infobox Hindu temple | Category:Pages using infobox Hindu temple with deprecated parameters |
Template:Infobox horseraces | Category:Pages using infobox horseraces with unknown parameters |
Template:Infobox language | Category:Language articles with unsupported infobox fields |
Template:Infobox language family | Category:Language articles with unsupported infobox fields |
Template:Infobox ligament | Category:Medicine infobox template using unsupported parameters |
Template:Infobox lymph | Category:Medicine infobox template using unsupported parameters |
Template:Infobox military installation | Category:Pages using infobox military installation with deprecated syntax |
Template:Infobox Minor League Baseball | Category:Pages using infobox Minor League Baseball with unknown parameters |
Template:Infobox muscle | Category:Medicine infobox template using unsupported parameters |
Template:Infobox musical artist | Category:Pages using Template:Infobox musical artist with unknown parameters |
Template:Infobox NASCAR race report | Category:Pages using infobox NASCAR race report with unknown parameters |
Template:Infobox nerve | Category:Medicine infobox template using unsupported parameters |
Template:Infobox neuron | Category:Medicine infobox template using unsupported parameters |
Template:Infobox political party | Category:Political party articles using deprecated parameters |
Template:Infobox public transit | Category:Public transit articles with unsupported infobox fields |
Template:Infobox restaurant | Category:Pages using infobox restaurant with unsupported parameters |
Template:Infobox school district | Category:Pages using infobox school district with unsupported parameters |
Template:Infobox settlement | Category:Settlement articles requiring maintenance |
Template:Infobox speedway rider | Category:Pages using Infobox Speedway rider with unknown parameters |
Template:Infobox sports rivalry | Category:Pages using infobox sports rivalry with unknown parameters |
Template:Infobox vein | Category:Medicine infobox template using unsupported parameters |
Template:Multiple issues | Category:Pages using multiple issues with incorrect parameters |
Template:WikiProject Africa | Category:Africa articles with invalid parameters |
Template:WikiProject Central America | Category:Central America articles with invalid parameters |
Template:WikiProject United States | Category:United States articles with invalid parameters |
Template:Year box | Category:Pages using year box with unknown parameters |
For a more up-to-date list, search for the "check for unknown parameters" within the template namespace.
See also
- वर्ग:अनोळखी प्राचले (१) (category page can have {{Unknown params category}})
- module:TemplatePar (originally from dewiki)
- साचा:प्राचले and विभाग:Parameters – generates a list of parameter names for a given template
- he:Module:ParamValidator - parameter validation system on hewiki, relies on TemplateData. module doc in English. checks the following:
- use of undeclared parameters
- use of parameters marked in templatedata "deprecated"
- mistyped (mainly, params declared in templatedata as "number" receiving non-numerical value)
- missing parameters marked in TemplateData as "required"
- understands aliases, and warns when more than one alias of a parameter is used
-- 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 trim(s) ~= ''endfunction p.check (frame)local args = frame.argslocal pargs = frame:getParent().argslocal 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 stringfor 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 .. '$')endendif 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 thenpreview = unknownend-- 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 thenlocal knownflag = falsefor i, regexp in ipairs(regexps) doif mw.ustring.match(k, regexp) thenknownflag = truebreakendendif not knownflag and ( not ignoreblank or isnotempty(v) ) thenk = mw.ustring.gsub(k, '[^%w\-_ ]', '?')table.insert(values, k)endelseif type(k) == 'number' and knownargs[tostring(k)] == nil and( showblankpos or isnotempty(v) )thenlocal 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 ''))endend-- add resuls to the output tablesif #values > 0 thenif frame:preprocess( "{{REVISIONID}}" ) == "" thenunknown = previewendfor k, v in pairs(values) doif v == '' then-- Fix odd bug for | = which gets stripped to the empty string and-- breaks category linksv = ' 'endlocal r = unknown:gsub('_VALUE_', v)table.insert(res, r)endendreturn table.concat(res)endreturn p