Module:Check for unknown parameters/doc: Difference between revisions

Revision as of 14:26, 18 April 2023

Revision as of 15:57, 3 July 2023

Line 1:

{{usedUsed in system|in [[MediaWiki:Abusefilter-warning-DS]]}}

{{moduleModule rating|p}}

{{Lua|Module:If preview|noprotcat=yes}}

Line 7:

== Usage ==

=== Basic usage ===

<syntaxhighlight lang="wikitext">

<pre>

{{#invoke:checkCheck for unknown parameters|check

|unknown=[[Category:Some tracking category]]

|arg1|arg2|arg3|argN}}

</syntaxhighlight>

</pre>

or to sort the entries in the tracking category by parameter with a preview error message

<syntaxhighlight lang="wikitext">

<pre>

{{#invoke:checkCheck for unknown parameters|check

|unknown=[[Category:Some tracking category|_VALUE_]]

|preview=unknown parameter "_VALUE_"

|arg1|arg2|...|argN}}

</syntaxhighlight>

</pre>

or for an explicit red error message

<syntaxhighlight lang="wikitext">

<pre>

{{#invoke:checkCheck for unknown parameters|check

|unknown=<span class="error">Sorry, I don't recognize _VALUE_</span>

|arg1|arg2|...|argN}}

</syntaxhighlight>

</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 {{paraPara|foo|x}} and {{paraPara|foo}} are reported. To only track non-blank parameters use {{paraPara|ignoreblank|1}}.

By default, the module ignores blank positional parameters. That is, an unlisted {{paraPara|2}} is ignored. To ''include'' blank positional parameters in the tracking use {{paraPara|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, {{tl<code>[[Module:Infobox3cols|Infobox3cols}}]]</code> uses

<syntaxhighlight lang="lua">

<pre>

| regexp1 = "header[%d]+",

| regexp2 = "label[%d]+",

| regexp3 = "data[%d]+[abc]?",

| regexp4 = "class[%d]+[abc]?",

| regexp5 = "rowclass[%d]+",

| regexp6 = "rowstyle[%d]+",

| regexp7 = "rowcellstyle[%d]+",

</syntaxhighlight>

</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 ==

<syntaxhighlight lang="wikitext">

<pre>

{{Infobox

| above = {{{name|}}}

Line 60:

end infobox, start tracking

-->{{#invoke:Check for unknown parameters|check

| unknown = {{mainMain other|[[Category:Some tracking category|_VALUE_]]}}

| preview = unknown parameter "_VALUE_"

| name

Line 66:

| website

}}

</syntaxhighlight>

</pre>

==Call from within Lua code==

Line 72:

==See also==

* {{clcClc|Unknown parameters}} (category page can have header {{tl|Unknown parameters category}})

* [[Template:Checks for unknown parameters]] – adds documentation to templates using this module

* [[Module:Check for deprecated parameters]] – similar module that checks for deprecated parameters

Line 82:

* [[User:Bamyers99/TemplateParametersTool]] - A tool for checking usage of template parameters

<includeonly>{{sandboxSandbox other||

<!-- Categories go here and interwikis go in Wikidata. -->

[[Category:Modules that add a tracking category]]

}}</includeonly><noinclude>

[[pt:Módulo:Check for unknown parameters]]

</noinclude>