Module:Check for unknown parameters/doc

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:

• Template:Mlx

To sort the entries into a tracking category by parameter with a preview error message, use:

• Template:Mlx

For an explicit red error message, use:

• Template:Mlx

To use Lua patterns, use:

• Template:Mlx

From a module

To call from a module, use: <syntaxhighlight lang="lua"> local checkForUnknownParameters = require("Module:Check for unknown parameters") local result = checkForUnknownParameters._check(validArgs, args) </syntaxhighlight>

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: |{{SAFESUBST:#if:regexp1|regexp1=}}header[%d]+, |{{SAFESUBST:#if:regexp2|regexp2=}}date[1-9], |{{SAFESUBST:#if:regexp3|regexp3=}}data[%d]+[abc]?). This is useful when there are many known parameters which use a systematic pattern.
• |{{SAFESUBST:#if:unknown|unknown=}} – what happens when an unknown parameter is used. Typically use either a tracking category to place pages that use unknown parameters, or an error.
• |{{SAFESUBST:#if:preview|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.
• |{{SAFESUBST:#if:ignoreblank|ignoreblank=}}1 – 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.
• |{{SAFESUBST:#if:showblankpositional|showblankpositional=}}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.

Example

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

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

| template = {{#ifeq:Check for unknown parameters/doc|Infobox||{{#ifeq:Template:Str left|Infobox|[[Category:Infobox templates|Template:Remove first word]]}}}} | 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

• Template:Clc (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