Toggle menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

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

mediawiki>Pppery
No edit summary
 
→‎Example: alphabetize parameters for sanity, as the script does
Line 1: Line 1:
This module may be appended to a template to check for uses of unknown parameters.
{{Used in system}}
{{Module rating|p}}
{{Lua|Module:If preview|noprotcat=yes}}
 
'''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 at the end or called directly from a module.


== Usage ==
== Usage ==
=== Basic usage ===
=== From a template ===
<pre>
To sort entries into a tracking category by parameter, use:
{{#invoke:check for unknown parameters|check
* {{mlx|Check for unknown parameters|check|unknown{{=}}<nowiki>[</nowiki>[Category:Some tracking category|_VALUE_]]|arg1|arg2|arg3|argN}}
|unknown=[[Category:Some tracking category]]
 
|arg1|arg2|arg3|argN}}
To sort the entries into a tracking category by parameter with a preview error message, use:
</pre>
* {{mlx|Check for unknown parameters|check|unknown{{=}}<nowiki>[</nowiki>[Category:Some tracking category|_VALUE_]]|preview{{=}}unknown parameter "_VALUE_"|arg1|arg2|...|argN}}
or to sort the entries in the tracking category by parameter with a preview error message
 
<pre>
For an explicit red error message, use:
{{#invoke:check for unknown parameters|check
* {{mlx|Check for unknown parameters|check|unknown{{=}}&lt;span class{{=}}"error">Sorry, I don't recognize _VALUE_&lt;/span>|arg1|arg2|...|argN}}
|unknown=[[Category:Some tracking category|_VALUE_]]
 
|preview=unknown parameter "_VALUE_"
To use Lua patterns, use:
|arg1|arg2|...|argN}}
* {{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]}}
</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.


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}}.
===From a module===
To call from a module, use:
<syntaxhighlight lang="lua">
local checkForUnknownParameters = require("Module:Check for unknown parameters")
local result = checkForUnknownParameters._check(validArgs, args)
</syntaxhighlight>


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}}.
Where the first set of args are the module args below and the second set of args are the parameters that are checked.


=== Lua patterns ===
== Parameters ==
This module supports [[Extension:Scribunto/Lua reference manual#Patterns|Lua patterns]] which are useful when there are many known parameters which use a systematic pattern.  For example, [[:en:template:infobox3cols]] uses
* <code>arg1</code>, <code>arg2</code>, ..., <code>argN</code>, are the known parameters.
<pre>
* Unnamed (positional) parameters can be added too: <code>|1|2|arg1|arg2|...</code>.
| regexp1 = header[%d][%d]*
* [[: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]+}}, {{para|regexp2|date[1-9]}}, {{para|regexp3|data[%d]+[abc]?}}). This is useful when there are many known parameters which use a systematic pattern.
| regexp2 = label[%d][%d]*
* {{para|unknown}} – what happens when an uknown parameter is used. Typically use either a tracking category to place pages that use unknown parameters, or an error.
| regexp3 = data[%d][%d]*[abc]?
* {{para|preview}} – the text to be displayed when in preview mode and an unknown parameter is used.
| regexp4 = class[%d][%d]*[abc]?
* 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.
| regexp5 = rowclass[%d][%d]*
* {{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 {{para|ignoreblank|1}}.
| regexp6 = rowstyle[%d][%d]*
* {{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}}.
| 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 ==
<pre>
<syntaxhighlight lang="wikitext">
{{Infobox
{{Infobox
| above = {{{name|}}}
| above = {{{name|}}}
Line 56: Line 54:
   end infobox, start tracking
   end infobox, start tracking
-->{{#invoke:Check for unknown parameters|check
-->{{#invoke:Check for unknown parameters|check
| unknown = {{main other|[[Category:Some tracking category|_VALUE_]]}}
| unknown = {{Main other|[[Category:Some tracking category|_VALUE_]]}}
| preview = unknown parameter "_VALUE_"
| preview = unknown parameter "_VALUE_" | height | name | website | weight  
| name
| height | weight
| website
}}
}}
</pre>
</syntaxhighlight>
 
==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==
* {{Clc|Unknown parameters}} (category page can have header {{tl|Unknown parameters category}})
* [[Module:Params]] – for complex operations involving parameters
* [[Template:Checks for unknown parameters]] – adds documentation to templates using this module
* [[Module:Check for deprecated parameters]] – similar module that checks for deprecated parameters
* [[Module:Check for clobbered parameters]] – module that checks for conflicting parameters
* [[Module: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
* [[Module:Parameter validation]] checks a lot more
* [[User:Bamyers99/TemplateParametersTool]] - A tool for checking usage of template parameters
 
<includeonly>{{Sandbox other||
<!-- Categories go here and interwikis go in Wikidata. -->
[[Category:Modules that add a tracking category]]
 
}}</includeonly>

Revision as of 19:52, 26 June 2024

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 at the end or called directly from a module.

Usage

From a template

To sort entries into a tracking category by parameter, use:

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

For an explicit red error message, use:

To use Lua patterns, use:

  • {{#invoke:Check for unknown parameters|check|unknown=[[Category:Some tracking category|_VALUE_]]|preview=unknown parameter "_VALUE_"|arg1|arg2|...|argN|regexp1=header[%d]+|regexp2=date[1-9]}}

From a module

To call from a module, use:

local checkForUnknownParameters = require("Module:Check for unknown parameters")
local result = checkForUnknownParameters._check(validArgs, args)

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

Parameters

  • arg1, arg2, ..., argN, are the known parameters.
  • Unnamed (positional) parameters can be added too: |1|2|arg1|arg2|....
  • Lua patterns (similar to regular expressions) usage with parameters is also supported (such as: |regexp1=header[%d]+, |regexp2=date[1-9], |regexp3=data[%d]+[abc]?). This is useful when there are many known parameters which use a systematic pattern.
  • |unknown= – what happens when an uknown parameter is used. Typically use either a tracking category to place pages that use unknown parameters, or an error.
  • |preview= – the text to be displayed when in preview mode and an unknown parameter is used.
  • 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.
  • |ignoreblank=1 – by default, the module makes no distinction between a defined-but-blank parameter and a non-blank parameter. That is, both unlisted |foo=x and |foo= are reported. To only track non-blank parameters use |ignoreblank=1.
  • |showblankpositional=1 – by default, the module ignores blank positional parameters. That is, an unlisted |2= is ignored. To include blank positional parameters in the tracking use |showblankpositional=1.

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 = {{Main other|[[Category:Some tracking category|_VALUE_]]}}
| preview = unknown parameter "_VALUE_" | height | name | website | weight 
}}

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