en>Jonesey95 (→Example: alphabetize parameters for sanity, as the script does) |
m (1 revision imported) |
(No difference)
|
Latest revision as of 15:41, 6 July 2024
Template:Used in system Template:Module rating Template:Lua
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: <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: Template:Para, Template:Para, Template:Para). This is useful when there are many known parameters which use a systematic pattern.
- Template: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: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: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
<syntaxhighlight lang="wikitext"> Script error: No such module "Check for unknown parameters". </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 Template:Tl)
- 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