Module:Wp/wal/Check for unknown parameters/doc

This is the documentation page for Module:Wp/wal/Check for unknown parameters

TemplateStyles' src attribute must not be empty.

This Lua module is used in system messages.
Changes to it can cause immediate changes to the Wikipedia user interface.
To avoid major disruption, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them.

Template:Sandbox other

Error: {{Wp/wal/Module rating}} must be placed in the Module namespace. Template:Wp/wal/cascade-protected template Lua error in package.lua at line 80: module 'Module:List' not found.

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:Wp/wal/mlx

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

Template:Wp/wal/mlx

For an explicit red error message, use:

Template:Wp/wal/mlx

To use Lua patterns, use:

Template:Wp/wal/mlx

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: Template:Wp/wal/para, Template:Para, Template:Para). This is useful when there are many known parameters which use a systematic pattern.
Template:Wp/wal/para – what happens when an uknown parameter is used. Typically use either a tracking category to place pages that use unknown parameters, or an error.
Template:Wp/wal/para – 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.
Template:Wp/wal/para – by default, the module makes no distinction between a defined-but-blank parameter and a non-blank parameter. That is, both unlisted Template:Para and Template:Para are reported. To only track non-blank parameters use Template:Para.
Template:Para – by default, the module ignores blank positional parameters. That is, an unlisted Template:Para is ignored. To Template:Em blank positional parameters in the tracking use Template:Para.

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.