Module:Check for unknown parameters/doc

{{#if:{{#ifeq:doc|sandbox|1}}{{#ifeq:doc|doc|1}}||{{#switch:|sysop|templateeditor|interfaceadmin=|#default=}}}}

{{#ifeq:doc|doc|{{#if:|Template:Pp}}|{{#switch:

 {{#if:
 |     
 | {{#ifeq:Module|Module
   | module
   | other
   }}
 }}

| module =

| other | #default = Template:Error }}}}

This module may be appended to a template to check for uses of unknown parameters. Unlike many other modules, this module is not implemented by a template.

Usage

Basic usage

<syntaxhighlight lang="wikitext">

</syntaxhighlight> or to sort the entries in the tracking category by parameter with a preview error message <syntaxhighlight lang="wikitext">

</syntaxhighlight> or for an explicit red error message <syntaxhighlight lang="wikitext">

</syntaxhighlight> 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 |{{SAFESUBST:#if:foo|foo=}}x and |{{SAFESUBST:#if:foo|foo=}} are reported. To only track non-blank parameters use |{{SAFESUBST:#if:ignoreblank|ignoreblank=}}1.

By default, the module ignores blank positional parameters. That is, an unlisted |{{SAFESUBST:#if:2|2=}} is ignored. To include blank positional parameters in the tracking use |{{SAFESUBST:#if:showblankpositional|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, Infobox3cols uses <syntaxhighlight lang="lua"> regexp1 = "header[%d]+", regexp2 = "label[%d]+", regexp3 = "data[%d]+[abc]?", regexp4 = "class[%d]+[abc]?", regexp5 = "rowclass[%d]+", regexp6 = "rowstyle[%d]+", regexp7 = "rowcellstyle[%d]+", </syntaxhighlight> to match all parameters of the form headerNUM, labelNUM, dataNUM, dataNUMa, dataNUMb, dataNUMc, ..., rowcellstyleNUM, where NUM is a string of digits.

Example

<syntaxhighlight lang="wikitext"> {{#switch:

 {{#if:
 | {{{demospace}}}    
 | {{#ifeq:Module|Template
   | template
   | other
   }}
 }}

| template = {{#ifeq:Check for unknown parameters/doc|Infobox||{{#ifeq:docdocd|Infobox|[[Category:Infobox templates|]]}}}} | other | #default = }} </syntaxhighlight>

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

• {{#if:|{{{name}}}|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