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.

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:

Where the first set of args are the module args below and the second set of args are the parameters that are checked.

Parameters

 * ,, ...,  , are the known parameters.
 * Unnamed (positional) parameters can be added too:.
 * Lua patterns (similar to regular expressions) usage with parameters is also supported (such as: header[%d]+, date[1-9], 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  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.
 * 1 – by default, the module makes no distinction between a defined-but-blank parameter and a non-blank parameter. That is, both unlisted x and foo are reported. To only track non-blank parameters use 1.
 * 1 – by default, the module ignores blank positional parameters. That is, an unlisted 2 is ignored. To blank positional parameters in the tracking use 1.

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.