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

Revision as of 20:57, 6 February 2024

Latest revision as of 11:44, 5 June 2025

(18 intermediate revisions by 12 users not shown)

Line 1:

{{Used in system}}

{{Module rating|p}}

{{cascade-protected template|page=module}}

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

This'''Module:Check modulefor mayunknown beparameters''' appendedis to a templateused to check for uses of unknown parameters. Unlikein manya othertemplate modules, thisor module. isIt ''not''may implementedbe byappended to a template at the end or called directly from a module.

== Usage ==

=== BasicFrom usagea template ===

or toTo sort the entries ininto thea tracking category by parameter, with a preview error messageuse:

<syntaxhighlight lang="wikitext">

* {{#invoke:mlx|Check for unknown parameters|check|unknown{{=}}<nowiki>[</nowiki>[Category:Some tracking category|_VALUE_]]|arg1|arg2|arg3|argN}}

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

To sort the entries into a tracking category by parameter with a preview error message, use:

|arg1|arg2|arg3|argN}}

* {{mlx|Check for unknown parameters|check|unknown{{=}}<nowiki>[</nowiki>[Category:Some tracking category|_VALUE_]]|preview{{=}}unknown parameter "_VALUE_"|arg1|arg2|...|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.

or forFor an explicit red error message, use:

By default, the module makes no distinction between a defined-but-blank parameter and a non-blank parameter. That is, both unlisted {{Para|foo|x}} and {{Para|foo}} are reported. To only track non-blank parameters use {{Para|ignoreblank|1}}.

* {{mlx|Check for unknown parameters|check|unknown{{=<}}&lt;span class{{=}}"error">Sorry, I don't recognize _VALUE_<&lt;/span>|arg1|arg2|...|argN}}

To use Lua patterns, use:

By default, the module ignores blank positional parameters. That is, an unlisted {{Para|2}} is ignored. To ''include'' blank positional parameters in the tracking use {{Para|showblankpositional|1}}.

* {{mlx|Check for unknown parameters|check|unknown{{=}}<nowiki>[</nowiki>[Category:Some tracking category|_VALUE_]]|preview{{=}}unknown parameter "_VALUE_"|arg1|arg2|...|argN|regexp1{{=}}header[%d]+|regexp2{{=}}date[1-9]}}

===From Lua patternsa module===

To call from a module, use:

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, <code>[[Module:Infobox3cols|Infobox3cols]]</code> uses

<syntaxhighlight lang="lua">

local checkForUnknownParameters = require("Module:Check for unknown parameters")

regexp1 = "header[%d]+",

local result = checkForUnknownParameters._check(validArgs, args)

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.

Where the first set of args are the module args below and the second set of args are the parameters that are checked.

== Parameters ==

* <code>arg1</code>, <code>arg2</code>, ..., <code>argN</code>, are the known parameters.

* Unnamed (positional) parameters can be added too: <code>|1|2|arg1|arg2|...</code>.

This module supports* [[:mw:Extension:Scribunto/Lua reference manual#Patterns|Lua patterns]] (similar to [[regular expression]]s) usage with parameters is also supported (such as: {{para|regexp1|header[%d]+}}, which{{para|regexp2|date[1-9]}}, are{{para|regexp3|data[%d]+[abc]?}}). This is useful when there are many known parameters which use a systematic pattern. For example, <code>[[Module:Infobox3cols|Infobox3cols]]</code> uses

* {{para|unknown}} – what happens when an unknown parameter is used. Typically use either a tracking category to place pages that use unknown parameters, or an error.

* {{para|preview}} – the text to be displayed when in preview mode and an unknown parameter is used.

* 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* {{para|ignoreblank|1}} – by default, the module makes no distinction between a defined-but-blank parameter and a non-blank parameter. That is, both unlisted {{Para|foo|x}} and {{Para|foo}} are reported. To only track non-blank parameters use {{Parapara|ignoreblank|1}}.

By* {{para|showblankpositional|1}} – by default, the module ignores blank positional parameters. That is, an unlisted {{Parapara|2}} is ignored. To ''{{em|include''}} blank positional parameters in the tracking use {{Parapara|showblankpositional|1}}.

== Example ==

Line 61 ⟶ 56:

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

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

| preview = unknown parameter "_VALUE_" | height | name | website | weight

| name

| height | weight

| website

}}

</syntaxhighlight>

Line 86 ⟶ 78:

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

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

[[Category:Template metamodules]]

}}</includeonly>

<noinclude>

[[Category:Module documentation pages]]

</noinclude>