Diferencia entre revisiones de «Módulo:Check for unknown parameters/doc»
(Added class="error" to hidden message example as even style="display:none" messages can show up in certain places e.g. Hovercards) |
m (22 revisiones importadas) |
||
(No se muestran 7 ediciones intermedias de 2 usuarios) | |||
Línea 5: | Línea 5: | ||
== Usage == | == Usage == | ||
+ | === Basic usage === | ||
<pre> | <pre> | ||
{{#invoke:check for unknown parameters|check | {{#invoke:check for unknown parameters|check | ||
Línea 10: | Línea 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=unknown parameter "_VALUE_" | ||
|arg1|arg2|...|argN}} | |arg1|arg2|...|argN}} | ||
</pre> | </pre> | ||
Línea 22: | Línea 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=unknown parameter "_VALUE_" | ||
|arg1|arg2|...|argN}} | |arg1|arg2|...|argN}} | ||
</pre> | </pre> | ||
Línea 31: | Línea 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 == | ||
Línea 49: | Línea 64: | ||
-->{{#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 = unknown parameter "_VALUE_" | ||
| name | | name | ||
| height | weight | | height | weight | ||
Línea 87: | Línea 103: | ||
|- | |- | ||
| [[Template:Infobox brain]] || [[:Category:Medicine infobox template using deprecated parameters]] | | [[Template:Infobox brain]] || [[:Category:Medicine infobox template using deprecated parameters]] | ||
+ | |- | ||
+ | | [[Template:Infobox broadcast]] || [[:Category:Broadcast infoboxes with deprecated parameters]] | ||
|- | |- | ||
| [[Template:Infobox city Japan]] || [[:Category:Pages using infobox city Japan with unsupported parameters]] | | [[Template:Infobox city Japan]] || [[:Category:Pages using infobox city Japan with unsupported parameters]] | ||
− | |||
− | |||
|- | |- | ||
| [[Template:Infobox Daytona 500]] || [[:Category:Pages using infobox Daytona 500 with unknown parameters]] | | [[Template:Infobox Daytona 500]] || [[:Category:Pages using infobox Daytona 500 with unknown parameters]] | ||
Línea 101: | Línea 117: | ||
|- | |- | ||
| [[Template:Infobox Hindu temple]] || [[:Category:Pages using infobox Hindu temple with deprecated parameters]] | | [[Template:Infobox Hindu temple]] || [[:Category:Pages using infobox Hindu temple with deprecated parameters]] | ||
+ | |- | ||
+ | | [[Template:Infobox horseraces]] || [[:Category:Pages using infobox horseraces with deprecated parameters]] | ||
|- | |- | ||
| [[Template:Infobox language]] || [[:Category:Language articles with unsupported infobox fields]] | | [[Template:Infobox language]] || [[:Category:Language articles with unsupported infobox fields]] | ||
Línea 115: | Línea 133: | ||
|- | |- | ||
| [[Template:Infobox muscle]] || [[:Category:Medicine infobox template using deprecated parameters]] | | [[Template:Infobox muscle]] || [[:Category:Medicine infobox template using deprecated 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 NASCAR race report]] || [[:Category:Pages using infobox NASCAR race report with unknown parameters]] | ||
Línea 126: | Línea 146: | ||
| [[Template:Infobox political party]] || [[:Category:Political party articles using deprecated parameters]] | | [[Template:Infobox political party]] || [[:Category:Political party articles using deprecated parameters]] | ||
|- | |- | ||
− | | [[Template:Infobox | + | | [[Template:Infobox public transit]] || [[:Category:Public transit articles with unsupported infobox fields]] |
|- | |- | ||
− | | [[Template:Infobox | + | | [[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 school district]] || [[:Category:Pages using infobox school district with unsupported parameters]] | ||
Línea 141: | Línea 161: | ||
|- | |- | ||
| [[Template:Multiple issues]] || [[:Category:Pages using multiple issues with incorrect 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]] | | [[Template:Year box]] || [[:Category:Pages using year box with unknown parameters]] |
Revisión actual del 14:28 31 may 2016
40x40px | This module is rated as beta, and is ready for widespread use. It is still new and should be used with some caution to ensure the results are as expected. |
This module may be appended to a template to check for uses of unknown parameters.
Contenido
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=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}}
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=unknown parameter "_VALUE_" |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_]] | preview = unknown parameter "_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