mediawiki>Pppery No edit summary |
→Example: alphabetize parameters for sanity, as the script does |
||
Line 1: | Line 1: | ||
{{Used in system}} | |||
{{Module rating|p}} | |||
{{Lua|Module:If preview|noprotcat=yes}} | |||
'''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 == | == Usage == | ||
=== | === From a template === | ||
To sort entries into a tracking category by parameter, use: | |||
{{ | * {{mlx|Check for unknown parameters|check|unknown{{=}}<nowiki>[</nowiki>[Category:Some tracking category|_VALUE_]]|arg1|arg2|arg3|argN}} | ||
|unknown=[[Category:Some tracking category]] | |||
|arg1|arg2|arg3|argN}} | To sort the entries into a tracking category by parameter with a preview error message, use: | ||
* {{mlx|Check for unknown parameters|check|unknown{{=}}<nowiki>[</nowiki>[Category:Some tracking category|_VALUE_]]|preview{{=}}unknown parameter "_VALUE_"|arg1|arg2|...|argN}} | |||
For an explicit red error message, use: | |||
{{ | * {{mlx|Check for unknown parameters|check|unknown{{=}}<span class{{=}}"error">Sorry, I don't recognize _VALUE_</span>|arg1|arg2|...|argN}} | ||
|unknown=[[Category:Some tracking category|_VALUE_]] | |||
|preview=unknown parameter "_VALUE_" | To use Lua patterns, use: | ||
|arg1|arg2|...|argN}} | * {{mlx|Check for unknown parameters|check|unknown{{=}}<nowiki>[</nowiki>[Category:Some tracking category|_VALUE_]]|preview{{=}}unknown parameter "_VALUE_"|arg1|arg2|...|argN|regexp1{{=}}header[%d]+|regexp2{{=}}date[1-9]}} | ||
{{ | |||
|unknown= | |||
|arg1|arg2|...|argN}} | |||
===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 == | ||
* <code>arg1</code>, <code>arg2</code>, ..., <code>argN</code>, are the known parameters. | |||
* Unnamed (positional) parameters can be added too: <code>|1|2|arg1|arg2|...</code>. | |||
| regexp1 | * [[:mw:Extension:Scribunto/Lua reference manual#Patterns|Lua patterns]] (similar to [[regular expression]]s) usage with parameters is also supported (such as: {{para|regexp1|header[%d]+}}, {{para|regexp2|date[1-9]}}, {{para|regexp3|data[%d]+[abc]?}}). This is useful when there are many known parameters which use a systematic pattern. | ||
| regexp2 | * {{para|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. | ||
| regexp3 | * {{para|preview}} – the text to be displayed when in preview mode and an unknown parameter is used. | ||
| | * The <code>_VALUE_</code> 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. | ||
* {{para|ignoreblank|1}} – by default, the module makes no distinction between a defined-but-blank parameter and a non-blank parameter. That is, both unlisted {{Para|foo|x}} and {{Para|foo}} are reported. To only track non-blank parameters use {{para|ignoreblank|1}}. | |||
| | * {{para|showblankpositional|1}} – by default, the module ignores blank positional parameters. That is, an unlisted {{para|2}} is ignored. To {{em|include}} blank positional parameters in the tracking use {{para|showblankpositional|1}}. | ||
== Example == | == Example == | ||
< | <syntaxhighlight lang="wikitext"> | ||
{{Infobox | {{Infobox | ||
| above = {{{name|}}} | | above = {{{name|}}} | ||
Line 56: | Line 54: | ||
end infobox, start tracking | end infobox, start tracking | ||
-->{{#invoke:Check for unknown parameters|check | -->{{#invoke:Check for unknown parameters|check | ||
| unknown = {{ | | unknown = {{Main other|[[Category:Some tracking category|_VALUE_]]}} | ||
| preview = unknown parameter "_VALUE_" | | preview = unknown parameter "_VALUE_" | height | name | website | weight | ||
| name | |||
| | |||
}} | }} | ||
</ | </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== | |||
* {{Clc|Unknown parameters}} (category page can have header {{tl|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 | |||
<includeonly>{{Sandbox other|| | |||
<!-- Categories go here and interwikis go in Wikidata. --> | |||
[[Category:Modules that add a tracking category]] | |||
}}</includeonly> |
Revision as of 19:52, 26 June 2024
Warning | This Lua module is used in system messages, and on approximately 20,900,000 pages, or roughly 2964539% of all pages. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid major disruption and server load, 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. |
File:Lua-Logo.svg | This module depends on the following other modules: |
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:
{{#invoke:Check for unknown parameters|check|unknown=[[Category:Some tracking category|_VALUE_]]|arg1|arg2|arg3|argN}}
To sort the entries into a tracking category by parameter with a preview error message, use:
{{#invoke:Check for unknown parameters|check|unknown=[[Category:Some tracking category|_VALUE_]]|preview=unknown parameter "_VALUE_"|arg1|arg2|...|argN}}
For an explicit red error message, use:
{{#invoke:Check for unknown parameters|check|unknown=<span class="error">Sorry, I don't recognize _VALUE_</span>|arg1|arg2|...|argN}}
To use Lua patterns, use:
{{#invoke:Check for unknown parameters|check|unknown=[[Category:Some tracking category|_VALUE_]]|preview=unknown parameter "_VALUE_"|arg1|arg2|...|argN|regexp1=header[%d]+|regexp2=date[1-9]}}
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:
|regexp1=header[%d]+
,|regexp2=date[1-9]
,|regexp3=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
_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. |ignoreblank=1
– by default, the module makes no distinction between a defined-but-blank parameter and a non-blank parameter. That is, both unlisted|foo=x
and|foo=
are reported. To only track non-blank parameters use|ignoreblank=1
.|showblankpositional=1
– by default, the module ignores blank positional parameters. That is, an unlisted|2=
is ignored. To include blank positional parameters in the tracking use|showblankpositional=1
.
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.
See also
- 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