Editing Module:Check for unknown parameters/doc

{{High-risk|8200000+}}
{{module rating|p}}
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->

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|}}}
}}<!-- 
  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
}}
</pre>

==Templates invoking this module==

The following is a list of some of the templates which invoke this module, with the associated category for each.

{| class="wikitable sortable collapsible collapsed" style="font-size:88%"
!  colspan="2" class="unsortable" style="background-color:#ddd" | List of templates which invoke "Module:Check for unknown parameters"
|-
! Template !! Tracking/maintenance category
|-
| {{ti|Authority control}} || {{cl|Pages using authority control with parameters|count=yes}}
|-
| {{ti|Aviation accidents and incidents}} || {{cl|Pages using aviation accidents and incidents with unknown parameters|count=yes}}
|-
| {{ti|Country topics}} || {{cl|Pages using country topics with unknown parameters|count=yes}}
|-
| [[Template:Infobox3cols]] || [[:Category:Pages using infobox3cols with undocumented parameters]]
|-
| [[Template:Infobox academic division]] || [[:Category:Pages using infobox academic division with unknown parameters]]
|-
| [[Template:Infobox amateur wrestler]] || [[:Category:Pages using infobox amateur wrestler with unknown parameters]]
|-
| [[Template:Infobox anatomy]] || [[:Category:Anatomy infobox template using unsupported parameters]]
|-
| [[Template:Infobox artery]] || [[:Category:Anatomy infobox template using unsupported parameters]]
|-
| [[Template:Infobox astronaut]] || [[:Category:Pages using infobox astronaut with unknown parameters]]
|-
| [[Template:Infobox award]] || [[:Category:Pages using infobox award with unknown parameters]]
|-
| [[Template:Infobox bone]] || [[:Category:Anatomy infobox template using unsupported parameters]]
|-
| [[Template:Infobox brain]] || [[:Category:Anatomy infobox template using unsupported parameters]]
|-
| [[Template:Infobox broadcast]] || [[:Category:Pages using infobox broadcast with unknown parameters]]
|-
| [[Template:Infobox city Japan]] || [[:Category:Pages using infobox city Japan with unknown parameters]]
|-
| [[Template:Infobox Daytona 500]] || [[:Category:Pages using infobox Daytona 500 with unknown parameters]]
|-
| [[Template:Infobox embryology]] || [[:Category:Anatomy infobox template using unsupported parameters]]
|-
| [[Template:Infobox event]] || [[:Category:Pages using infobox event with unknown parameters]]
|-
| [[Template:Infobox Grand Prix race report]] || [[:Category:Pages using infobox Grand Prix race report with unknown parameters]]
|-
| [[Template:Infobox horseraces]] || [[:Category:Pages using infobox horseraces with unknown parameters]]
|-
| [[Template:Infobox language]] || [[:Category:Language articles with unsupported infobox fields]]
|-
| [[Template:Infobox language family]] || [[:Category:Language articles with unsupported infobox fields]]
|-
| [[Template:Infobox ligament]] || [[:Category:Anatomy infobox template using unsupported parameters]] 
|-
| [[Template:Infobox lymph]] || [[:Category:Anatomy infobox template using unsupported parameters]] 
|-
| [[Template:Infobox Minor League Baseball]] || [[:Category:Pages using infobox Minor League Baseball with unknown parameters]]
|-
| [[Template:Infobox muscle]] || [[:Category:Anatomy infobox template using unsupported parameters]] 
|-
| [[Template:Infobox musical artist]] || [[:Category:Pages using Template:Infobox musical artist with unknown parameters]] 
|-
| [[Template:Infobox NASCAR race report]] || [[:Category:Pages using infobox NASCAR race report with unknown parameters]]
|-
| [[Template:Infobox nerve]] || [[:Category:Anatomy infobox template using unsupported parameters]] 
|-
| [[Template:Infobox neuron]] || [[:Category:Anatomy infobox template using unsupported parameters]] 
|-
| [[Template:Infobox political party]] || [[:Category:Pages using infobox political party with unknown parameters]]
|-
| [[Template:Infobox public transit]] || [[:Category:Public transit articles with unsupported infobox fields]]
|-
| [[Template:Infobox restaurant]] || [[:Category:Pages using infobox restaurant with unsupported parameters]]
|-
| [[Template:Infobox school district]] || [[:Category:Pages using infobox school district with unsupported parameters]]
|-
| [[Template:Infobox settlement]] || [[:Category:Settlement articles requiring maintenance]]
|-
| [[Template:Infobox speedway rider]] || [[:Category:Pages using infobox speedway rider with unknown parameters]]
|-
| [[Template:Infobox sports rivalry]] || [[:Category:Pages using infobox sports rivalry with unknown parameters]]
|-
| [[Template:Infobox vein]] || [[:Category:Anatomy infobox template using unsupported parameters]] 
|-
| [[Template:Multiple issues]] || [[:Category:Pages using multiple issues with incorrect parameters]]
|-
| [[Template:WikiProject Africa]] || [[:Category:Africa articles with invalid parameters]]
|-
| [[Template:WikiProject Central America]] || [[:Category:Central America articles with invalid parameters]]
|-
| [[Template:WikiProject United States]] || [[:Category:United States articles with invalid parameters]]
|-
| [[Template:Year box]] || [[:Category:Pages using year box with unknown parameters]]
|}
For a more up-to-date list, [//en.wikipedia.org/w/index.php?title=Special:Search&limit=500&offset=0&ns10=1&search=insource%3A%2FCheck+for+unknown+parameters%2F search for the "check for unknown parameters" within the template namespace].

==See also==
* {{clc|Unknown parameters}} (category page can have {{tl|Unknown parameters category}})
* [[:module:TemplatePar]] - similar function (originally from dewiki)
* [[Template:Parameters]] and [[Module:Parameters]] – generates a list of parameter names for a given template
* [[: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

<includeonly>{{sandbox other||
<!-- Categories go here and interwikis go in Wikidata. -->

}}</includeonly>