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

Revision as of 22:27, 1 December 2018

Latest revision as of 11:44, 5 June 2025

(70 intermediate revisions by 42 users not shown)

Line 1:

{{Used in system}}

{{High-risk|8200000+}}

{{moduleModule rating|p}}

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

<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->

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

This'''Module:Check for unknown parameters''' is used to check for uses of unknown parameters in a template or module. It may be appended to a template toat checkthe forend usesor ofcalled unknowndirectly parametersfrom a module.

== Usage ==

=== BasicFrom usagea template ===

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

<pre>

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

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

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

</pre>

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

<pre>

{{#invoke:check for unknown parameters|check

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

|preview=unknown parameter "_VALUE_"

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

</pre>

or for an explicit red error message

<pre>

{{#invoke:check for unknown parameters|check

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

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

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

To sort the entries into a tracking category by parameter with a preview 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{{=}}<nowiki>[</nowiki>[Category:Some tracking category|_VALUE_]]|preview{{=}}unknown parameter "_VALUE_"|arg1|arg2|...|argN}}

or forFor an explicit red error message, 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{{=<}}&lt;span class{{=}}"error">Sorry, I don't recognize _VALUE_<&lt;/span>|arg1|arg2|...|argN}}

===To use Lua patterns, ===use:

* {{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]}}

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, [[template:infobox3cols]] uses

<pre>

===From a module===

| regexp1 = header[%d][%d]*

To call from a module, use:

| regexp2 = label[%d][%d]*

<syntaxhighlight lang="lua">

| regexp3 = data[%d][%d]*[abc]?

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

| regexp4 = class[%d][%d]*[abc]?

local result = checkForUnknownParameters._check(validArgs, args)

| regexp5 = rowclass[%d][%d]*

</syntaxhighlight>

| regexp6 = rowstyle[%d][%d]*

| regexp7 = rowcellstyle[%d][%d]*

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

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

== 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, [[template:infobox3cols]] 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 {{paraPara|foo|x}} and {{paraPara|foo}} are reported. To only track non-blank parameters use {{para|ignoreblank|1}}.

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

== Example ==

<syntaxhighlight lang="wikitext">

<pre>

{{Infobox

| above = {{{name|}}}

Line 60 ⟶ 55:

end infobox, start tracking

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

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

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

| name

| height | weight

| website

}}

</syntaxhighlight>

</pre>

==Call from within Lua code==

See the end of [[Module:Rugby box]] for a simple example or [[Module:Infobox3cols]] or [[Module:Flag]] for more complicated examples.

==See also==

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

* [[Module:Check for deprecated parametersParams]] -– similarfor modulecomplex that checks foroperations deprecatedinvolving parameters

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

* [[:module:TemplatePar]] - similar function (originally from dewiki)

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

* [[Module:Check for clobbered parameters]] – module that checks for conflicting parameters

* [[:moduleModule:TemplatePar]] -– similar function (originally from dewiki)

* [[Template:Parameters]] and [[Module:Parameters]] – generates a list of parameter names for a given template

* [[Project:TemplateData]] based template parameter validation

* [[:he:Module:ParamValidator]] - parameter validation system on hewiki, relies on TemplateData. module doc in English. checks the following:

* [[Module:Parameter validation]] checks a lot more

**use of undeclared parameters

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

** use of parameters marked in templatedata "deprecated"

** mistyped (mainly, parameters declared in templatedata as "number" receiving non-numerical value)

**missing parameters marked in TemplateData as "required"

**understands aliases, and warns when more than one alias of a parameter is used

<includeonly>{{sandboxSandbox other||

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

|unknown=[[Category:SomeModules that add a tracking category]]

[[Category:Template metamodules]]

}}</includeonly>

<noinclude>

[[Category:Module documentation pages]]

</noinclude>