Module:Check for unknown parameters/doc - Revision history

Skritzer: 1 revision imported

2024-01-19T00:45:31Z

1 revision imported

w;>Jonesey95: Reverted 1 edit by 2404:160:8075:59AF:1786:59EB:15CB:7CC0 (talk) to last revision by Grufo

2023-09-19T20:06:15Z

Reverted 1 edit by 2404:160:8075:59AF:1786:59EB:15CB:7CC0 (talk) to last revision by Grufo

Skritzer: 1 revision imported

2020-12-15T20:39:17Z

1 revision imported

wikipedia>Ahecht: /* See also / User:Bamyers99/TemplateParametersTool - A tool for checking usage of template parameters

2020-12-11T18:58:42Z

See also: * User:Bamyers99/TemplateParametersTool - A tool for checking usage of template parameters

Skritzer: 1 revision imported

2020-03-14T15:56:09Z

1 revision imported

wikipedia>Betseg at 09:00, 26 February 2020

2020-02-26T09:00:55Z

Skritzer: 1 revision imported

2019-12-19T19:08:00Z

1 revision imported

50.53.21.2: /* See also */

2019-10-06T14:57:16Z

See also

New page

{{High-risk|8200000+}}
{{module rating|p}}


This module may be appended to a template to check for uses of unknown parameters.

== Usage ==
=== Basic usage ===
<pre>
{{#invoke:check for unknown parameters|check
|unknown=[[Category:Some tracking category]]
|arg1|arg2|...|argN}}
</pre>
or to sort the entries in the tracking category by parameter with a preview error message
<pre>
{{#invoke:check for unknown parameters|check
|unknown=[[Category:Some tracking category|_VALUE_]]
|preview=unknown parameter "_VALUE_"
|arg1|arg2|...|argN}}
</pre>
or for an explicit red error message
<pre>
{{#invoke:check for unknown parameters|check
|unknown=<span class="error">Sorry, I don't recognize _VALUE_</span>
|arg1|arg2|...|argN}}
</pre>
Here, <code>arg1</code>, <code>arg2</code>, ..., <code>argN</code>, are the known parameters. Unnamed (positional) parameters can be added too: <code><nowiki>|1|2|argname1|argname2|...</nowiki></code>. Any parameter which is used, but not on this list, will cause the module to return whatever is passed with the <code>unknown</code> parameter. 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.

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}}.

By default, the module ignores blank positional parameters. That is, an unlisted {{para|2}} is ignored. To ''include'' blank positional parameters in the tracking use {{para|showblankpositional|1}}.

=== Lua patterns ===
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>
| 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]*
</pre>
to match all parameters of the form <code>headerNUM</code>, <code>labelNUM</code>, <code>dataNUM</code>, <code>dataNUMa</code>, <code>dataNUMb</code>, <code>dataNUMc</code>, ..., <code>rowcellstyleNUM</code>, where NUM is a string of digits.

== Example ==
<pre>
{{Infobox
| above = {{{name|}}}

| label1 = Height
| data1 = {{{height|}}}

| label2 = Weight
| data2 = {{{weight|}}}

| label3 = Website
| data3 = {{{website|}}}
}}{{#invoke:Check for unknown parameters|check
| unknown = {{main other|[[Category:Some tracking category|_VALUE_]]}}
| preview = unknown parameter "_VALUE_"
| name
| height | weight
| website
}}
</pre>

==See also==
* {{clc|Unknown parameters}} (category page can have header {{tl|Unknown parameters category}})
* [[Module:Check for deprecated parameters]] – similar module that checks for deprecated 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
** [[:he:Module:ParamValidator]] – parameter validation system on hewiki, relies on TemplateData. module doc in English. checks the following:
***use of undeclared parameters
*** use of parameters marked in templatedata "deprecated"
*** mistyped (mainly, parameters declared in templatedata as "number" receiving non-numerical value)
***missing parameters marked in TemplateData as "required"
***understands aliases, and warns when more than one alias of a parameter is used
** [[:cs:Module:CheckParameters]] – another parameter check system on cswiki that relies on TemplateData
* [[s:cs:Module:MonitorTemplateArguments]] – a template parameter monitoring system based on tracking categories

<includeonly>{{sandbox other||


}}</includeonly>

@@ Line 1: / Line 1: @@
-{{High-risk|9500000|all-pages=yes}}
+{{Used in system|in [[MediaWiki:Abusefilter-warning-DS]]}}
-{{used in system|in [[MediaWiki:Abusefilter-warning-DS]]}}
+{{Module rating|p}}
-{{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. Unlike many other modules, this module is ''not'' implemented by a template.
 == Usage ==
 === Basic usage ===
-<pre>
+<syntaxhighlight lang="wikitext">
-{{#invoke:check for unknown parameters|check
+{{#invoke:Check for unknown parameters|check
 |unknown=[[Category:Some tracking category]]
 |arg1|arg2|arg3|argN}}
-</pre>
+</syntaxhighlight>
 or to sort the entries in the tracking category by parameter with a preview error message
-<pre>
+<syntaxhighlight lang="wikitext">
-{{#invoke:check for unknown parameters|check
+{{#invoke:Check for unknown parameters|check
 |unknown=[[Category:Some tracking category|_VALUE_]]
 |preview=unknown parameter "_VALUE_"
 |arg1|arg2|...|argN}}
-</pre>
+</syntaxhighlight>
 or for an explicit red error message
-<pre>
+<syntaxhighlight lang="wikitext">
-{{#invoke:check for unknown parameters|check
+{{#invoke:Check for unknown parameters|check
 |unknown=<span class="error">Sorry, I don't recognize _VALUE_</span>
 |arg1|arg2|...|argN}}
-</pre>
+</syntaxhighlight>
 Here, <code>arg1</code>, <code>arg2</code>, ..., <code>argN</code>, are the known parameters. Unnamed (positional) parameters can be added too: <code><nowiki>|1|2|argname1|argname2|...</nowiki></code>. Any parameter which is used, but not on this list, will cause the module to return whatever is passed with the <code>unknown</code> parameter.  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.
-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}}.
+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}}.
-By default, the module ignores blank positional parameters. That is, an unlisted {{para|2}} is ignored. To ''include'' blank positional parameters in the tracking use {{para|showblankpositional|1}}.
+By default, the module ignores blank positional parameters. That is, an unlisted {{Para|2}} is ignored. To ''include'' blank positional parameters in the tracking use {{Para|showblankpositional|1}}.
 === Lua patterns ===
-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
+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, <code>[[Module:Infobox3cols|Infobox3cols]]</code> uses
-<pre>
+<syntaxhighlight lang="lua">
-| regexp1 = header[%d][%d]*
+		regexp1 = "header[%d]+",
-| regexp2 = label[%d][%d]*
+		regexp2 = "label[%d]+",
-| regexp3 = data[%d][%d]*[abc]?
+		regexp3 = "data[%d]+[abc]?",
-| regexp4 = class[%d][%d]*[abc]?
+		regexp4 = "class[%d]+[abc]?",
-| regexp5 = rowclass[%d][%d]*
+		regexp5 = "rowclass[%d]+",
-| regexp6 = rowstyle[%d][%d]*
+		regexp6 = "rowstyle[%d]+",
-| regexp7 = rowcellstyle[%d][%d]*
+		regexp7 = "rowcellstyle[%d]+",
-</pre>
+</syntaxhighlight>
 to match all parameters of the form <code>headerNUM</code>, <code>labelNUM</code>, <code>dataNUM</code>, <code>dataNUMa</code>, <code>dataNUMb</code>, <code>dataNUMc</code>, ..., <code>rowcellstyleNUM</code>, where NUM is a string of digits.
 == Example ==
-<pre>
+<syntaxhighlight lang="wikitext">
 {{Infobox
 | above = {{{name|}}}
@@ Line 61: / Line 60: @@
    end infobox, start tracking
 -->{{#invoke:Check for unknown parameters|check
-| unknown = {{main other|[[Category:Some tracking category|_VALUE_]]}}
+| unknown = {{Main other|[[Category:Some tracking category|_VALUE_]]}}
 | preview = unknown parameter "_VALUE_"
 | name
@@ Line 67: / Line 66: @@
 | website
 }}
-</pre>
+</syntaxhighlight>
 ==See also==
-* {{clc|Unknown parameters}} (category page can have header {{tl|Unknown parameters category}})
+* {{Clc|Unknown parameters}} (category page can have header {{tl|Unknown parameters category}})
-* [[:Module:Check for deprecated parameters]] – similar module that checks for deprecated parameters
+* [[Module:Params]] – for complex operations involving parameters
-* [[:Module:Check for clobbered parameters]] – module that checks for conflicting parameters
+* [[Template:Checks for unknown parameters]] – adds documentation to templates using this module
 * [[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
-** [[:he:Module:ParamValidator]] – parameter validation system on hewiki, relies on TemplateData. module doc in English. checks the following:
+* [[Module:Parameter validation]] checks a lot more
 * [[User:Bamyers99/TemplateParametersTool]] - A tool for checking usage of template parameters
-<includeonly>{{sandbox other||
+<includeonly>{{Sandbox other||
 <!-- Categories go here and interwikis go in Wikidata. -->
 }}</includeonly>

← Older revision	Revision as of 19:08, 19 December 2019
(No difference)

Module:Check for unknown parameters/doc - Revision history

Skritzer: 1 revision imported

w;>Jonesey95: Reverted 1 edit by 2404:160:8075:59AF:1786:59EB:15CB:7CC0 (talk) to last revision by Grufo

Skritzer: 1 revision imported

wikipedia>Ahecht: /* See also */ * User:Bamyers99/TemplateParametersTool - A tool for checking usage of template parameters

Skritzer: 1 revision imported

wikipedia>Betseg at 09:00, 26 February 2020

Skritzer: 1 revision imported

50.53.21.2: /* See also */

wikipedia>Ahecht: /* See also / User:Bamyers99/TemplateParametersTool - A tool for checking usage of template parameters