Shawndouglas at 23:19, 18 August 2016

2016-08-18T23:19:50Z

← Older revision		Revision as of 23:19, 18 August 2016
Line 1:		Line 1:
	~~{{module rating\|p}}~~
	<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->		<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->

Shawndouglas: Created as needed.

2016-08-18T23:19:33Z

Created as needed.

New page

{{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. 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. To only track non-blank parameters use {{para|ignoreblank|1}}.

By default, the module ignores blank positional parameters. To include blank positional parameters in the tracking use {{para|showblankpositional|1}}.

=== Regular expressions ===
This module supports regular expressions, 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 = [[Category:Some tracking category|_VALUE_]]
| preview = unknown parameter "_VALUE_"
| name
| height | weight
| website
}}
</pre>

==Templates invoking this module==

The following is a list of 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
|-
| [[Template:Infobox settlement]] || [[:Category:Settlement articles requiring maintenance]]
|}

==See also==
* [[:module:TemplatePar]] (originally from dewiki)
* [[Template:Parameters]] and [[Module:Parameters]] – generates a list of parameter names for a given template

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||


}}</includeonly>

Module:Check for unknown parameters/doc - Revision history

Shawndouglas at 23:19, 18 August 2016

Shawndouglas: Created as needed.