This is the documentation page for Module:Check for unknown parameters
Template:Used in system Template:Module rating Template:Cascade-protected template
 | This module depends on the following other modules: |
Module:Check for unknown parameters is used to check for uses of unknown parameters in a template or module. It may be appended to a template at the end or called directly from a module.
Usage
From a template
To sort entries into a tracking category by parameter, use:
To sort the entries into a tracking category by parameter with a preview error message, use:
For an explicit red error message, use:
To use Lua patterns, use:
From a module
To call from a module, use:
local checkForUnknownParameters = require("Module:Check for unknown parameters")
local result = checkForUnknownParameters._check(validArgs, args)
Where the first set of args are the module args below and the second set of args are the parameters that are checked.
Parameters
arg1,arg2, ...,argN, are the known parameters.- Unnamed (positional) parameters can be added too:
|1|2|arg1|arg2|.... - Lua patterns (similar to regular expressions) usage with parameters is also supported (such as:
|regexp1=header[%d]+,|regexp2=date[1-9],|regexp3=data[%d]+[abc]?). This is useful when there are many known parameters which use a systematic pattern. |unknown=– what happens when an uknown parameter is used. Typically use either a tracking category to place pages that use unknown parameters, or an error.|preview=– the text to be displayed when in preview mode and an unknown parameter is used.- 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. |ignoreblank=1– by default, the module makes no distinction between a defined-but-blank parameter and a non-blank parameter. That is, both unlisted|foo=xand|foo=are reported. To only track non-blank parameters use|ignoreblank=1.|showblankpositional=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.
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_" | height | name | website | weight
}}
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.
See also
- Category:Unknown parameters (0) (category page can have header {{Unknown parameters category}})
- Module:Params – for complex operations involving parameters
- 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