Halian: Created page with "{{Documentation subpage}} 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 === {{#invoke:Check for unknown parameters|check |unknown=Category:Some tracking category |arg1|arg2|arg3|argN}} or to sort the entries in the tracking category by parameter with a preview error message..."

2023-12-11T00:56:40Z

Created page with "{{Documentation subpage}} 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 === <syntaxhighlight lang="wikitext"> {{#invoke:Check for unknown parameters|check |unknown=Category:Some tracking category |arg1|arg2|arg3|argN}} </syntaxhighlight> or to sort the entries in the tracking category by parameter with a preview error message..."

New page

{{Documentation subpage}}

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 ===
<syntaxhighlight lang="wikitext">
{{#invoke:Check for unknown parameters|check
|unknown=[[Category:Some tracking category]]
|arg1|arg2|arg3|argN}}
</syntaxhighlight>
or to sort the entries in the tracking category by parameter with a preview error message
<syntaxhighlight lang="wikitext">
{{#invoke:Check for unknown parameters|check
|unknown=[[Category:Some tracking category|_VALUE_]]
|preview=unknown parameter "_VALUE_"
|arg1|arg2|...|argN}}
</syntaxhighlight>
or for an explicit red error message
<syntaxhighlight lang="wikitext">
{{#invoke:Check for unknown parameters|check
|unknown=<span class="error">Sorry, I don't recognize _VALUE_</span>
|arg1|arg2|...|argN}}
</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. To only track non-blank parameters use <code>|ignoreblank=1</code>.

By default, the module ignores blank positional parameters. To ''include'' blank positional parameters in the tracking use <code>|showblankpositional=1</code>.

=== Lua patterns ===
This module supports [[wikipedia::mw:Extension:Scribunto/Lua reference manual#Patterns|Lua patterns]] (similar to [[wikipedia:regular expression|regular expression]]s), which are useful when there are many known parameters which use a systematic pattern. For example, <code>[[wikipedia:Module:Infobox3cols|Infobox3cols]]</code> uses
<syntaxhighlight lang="lua">
regexp1 = "header[%d]+",
regexp2 = "label[%d]+",
regexp3 = "data[%d]+[abc]?",
regexp4 = "class[%d]+[abc]?",
regexp5 = "rowclass[%d]+",
regexp6 = "rowstyle[%d]+",
regexp7 = "rowcellstyle[%d]+",
</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 ==
<syntaxhighlight lang="wikitext">
{{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
}}
</syntaxhighlight>
<includeonly>

[[Category:Template]]
</includeonly>

Module:Check for unknown parameters/doc - Revision history