Module:Check for unknown parameters/doc: Difference between revisions
m (1 revision imported) |
en>PrimeHunter (→See also: add Template:Checks for unknown parameters – adds documentation to templates using this module) |
||
| Line 1: | Line 1: | ||
{{used in system|in [[MediaWiki:Abusefilter-warning-DS]]}} | |||
{{module rating|p}} | |||
{{Lua|Module:If preview|noprotcat=yes}} | |||
This module may be appended to a template to check for uses of unknown parameters. | This module may be appended to a template to check for uses of unknown parameters. | ||
| Line 28: | Line 32: | ||
=== Lua patterns === | === Lua patterns === | ||
This module supports [[Extension:Scribunto/Lua reference manual#Patterns|Lua patterns]] which are useful when there are many known parameters which use a systematic pattern. For example, [[ | This module supports [[:mw:Extension:Scribunto/Lua reference manual#Patterns|Lua patterns]] (similar to [[regular expression]]s), which are useful when there are many known parameters which use a systematic pattern. For example, [[template:infobox3cols]] uses | ||
<pre> | <pre> | ||
| regexp1 = header[%d][%d]* | | regexp1 = header[%d][%d]* | ||
| Line 63: | Line 67: | ||
}} | }} | ||
</pre> | </pre> | ||
==See also== | |||
* {{clc|Unknown parameters}} (category page can have header {{tl|Unknown parameters category}}) | |||
* [[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 09:11, 2 September 2022
 | This Lua module is used in MediaWiki:Abusefilter-warning-DS, and on approximately 21,000,000 pages, or roughly 85686% 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. |
 | This module depends on the following other modules: |
This module may be appended to a template to check for uses of unknown parameters.
Usage
Basic usage
{{#invoke:check for unknown parameters|check
|unknown=[[Category:Some tracking category]]
|arg1|arg2|arg3|argN}}
or to sort the entries in the tracking category by parameter with a preview error message
{{#invoke:check for unknown parameters|check
|unknown=[[Category:Some tracking category|_VALUE_]]
|preview=unknown parameter "_VALUE_"
|arg1|arg2|...|argN}}
or for an explicit red error message
{{#invoke:check for unknown parameters|check
|unknown=<span class="error">Sorry, I don't recognize _VALUE_</span>
|arg1|arg2|...|argN}}
Here, arg1, arg2, ..., argN, are the known parameters. Unnamed (positional) parameters can be added too: |1|2|argname1|argname2|.... Any parameter which is used, but not on this list, will cause the module to return whatever is passed with the unknown parameter. 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.
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.
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.
Lua patterns
This module supports Lua patterns (similar to regular expressions), which are useful when there are many known parameters which use a systematic pattern. For example, template:infobox3cols uses
| regexp1 = header[%d][%d]* | regexp2 = label[%d][%d]* | regexp3 = data[%d][%d]*[abc]? | regexp4 = class[%d][%d]*[abc]? | regexp5 = rowclass[%d][%d]* | regexp6 = rowstyle[%d][%d]* | regexp7 = rowcellstyle[%d][%d]*
to match all parameters of the form headerNUM, labelNUM, dataNUM, dataNUMa, dataNUMb, dataNUMc, ..., rowcellstyleNUM, where NUM is a string of digits.
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_"
| name
| height | weight
| website
}}
See also
- Category:Unknown parameters (0) (category page can have header {{Unknown parameters category}})
- 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
