Module:Check for unknown parameters/doc: Difference between revisions
(→Templates invoking this module: update list of templates and tracking categories) |
(→Usage) |
||
Line 5: | Line 5: | ||
== Usage == |
== Usage == |
||
==== Basic usage === |
|||
<pre> |
<pre> |
||
{{#invoke:check for unknown parameters|check |
{{#invoke:check for unknown parameters|check |
||
Line 10: | Line 11: | ||
|arg1|arg2|...|argN}} |
|arg1|arg2|...|argN}} |
||
</pre> |
</pre> |
||
or to sort the entries in the tracking category by parameter |
or to sort the entries in the tracking category by parameter with a preview error message |
||
<pre> |
<pre> |
||
{{#invoke:check for unknown parameters|check |
{{#invoke:check for unknown parameters|check |
||
|unknown=[[Category:Some tracking category|_VALUE_]] |
|unknown=[[Category:Some tracking category|_VALUE_]] |
||
|preview=<div class="hatnote" style="color:red"><strong>Warning:</strong> unknown parameter "_VALUE_" (this message is only shown in preview).</div> |
|||
|arg1|arg2|...|argN}} |
|arg1|arg2|...|argN}} |
||
</pre> |
</pre> |
||
Line 22: | Line 24: | ||
|arg1|arg2|...|argN}} |
|arg1|arg2|...|argN}} |
||
</pre> |
</pre> |
||
or to use hidden error messages which can be viewed in the HTML source |
or to use hidden error messages which can be viewed in the HTML source and a preview error message |
||
<pre> |
<pre> |
||
{{#invoke:check for unknown parameters|check |
{{#invoke:check for unknown parameters|check |
||
|unknown=<span class="error" style="display:none">HIDDEN ERROR: Usage of "_VALUE_" is not recognized</span> |
|unknown=<span class="error" style="display:none">HIDDEN ERROR: Usage of "_VALUE_" is not recognized</span> |
||
|preview=<div class="hatnote" style="color:red"><strong>Warning:</strong> unknown parameter "_VALUE_" (this message is only shown in preview).</div> |
|||
|arg1|arg2|...|argN}} |
|arg1|arg2|...|argN}} |
||
</pre> |
</pre> |
||
Line 31: | Line 34: | ||
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 makes no distinction between a defined-but-blank parameter and a non-blank parameter. To only track non-blank parameters use {{para|ignoreblank|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 == |
== Example == |
Revision as of 17:25, December 21, 2015
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|...|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=<div class="hatnote" style="color:red"><strong>Warning:</strong> unknown parameter "_VALUE_" (this message is only shown in preview).</div> |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}}
or to use hidden error messages which can be viewed in the HTML source and a preview error message
{{#invoke:check for unknown parameters|check |unknown=<span class="error" style="display:none">HIDDEN ERROR: Usage of "_VALUE_" is not recognized</span> |preview=<div class="hatnote" style="color:red"><strong>Warning:</strong> unknown parameter "_VALUE_" (this message is only shown in preview).</div> |arg1|arg2|...|argN}}
Here, arg1
, arg2
, ..., argN
, 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 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. To only track non-blank parameters use |ignoreblank=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
| 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 = [[Category:Some tracking category|_VALUE_]] | name | height | weight | website }}
Templates invoking this module
The following is a list of templates which invoke this module, with the associated category for each.
See also
- module:TemplatePar (originally from dewiki)
- Template:Parameters and Module:Parameters – generates a list of parameter names for a given template