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

Jump to navigation Jump to search

Module:Check for unknown parameters/doc (view source)

Revision as of 15:39, 29 August 2024

893 bytes added ,  29 August 2024
Added the page to Category:Module documentation pages
VisualWikitext
>Tomoneill
(copy from https://en.wikipedia.org/w/index.php?title=Module:Check_for_unknown_parameters/doc&oldid=893608666)
 
>Nickps
Line 1: Line 1:
{{module rating|p}}
{{Used in system}}
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
{{Module rating|p}}
{{Lua|Module:If preview|noprotcat=yes}}


This module may be appended to a template to check for uses of unknown parameters.
'''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|...|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.


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}}.
To sort the entries into a tracking category by parameter with a preview error message, use:
* {{mlx|Check for unknown parameters|check|unknown{{=}}<nowiki>[</nowiki>[Category:Some tracking category|_VALUE_]]|preview{{=}}unknown parameter "_VALUE_"|arg1|arg2|...|argN}}


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}}.
For an explicit red error message, use:
* {{mlx|Check for unknown parameters|check|unknown{{=}}&lt;span class{{=}}"error">Sorry, I don't recognize _VALUE_&lt;/span>|arg1|arg2|...|argN}}


=== Lua patterns ===
To use Lua patterns, 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, [[template:infobox3cols]] uses
* {{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>
 
| regexp1 = header[%d][%d]*
===From a module===
| regexp2 = label[%d][%d]*
To call from a module, use:
| regexp3 = data[%d][%d]*[abc]?
<syntaxhighlight lang="lua">
| regexp4 = class[%d][%d]*[abc]?
local checkForUnknownParameters = require("Module:Check for unknown parameters")
| regexp5 = rowclass[%d][%d]*
local result = checkForUnknownParameters._check(validArgs, args)
| regexp6 = rowstyle[%d][%d]*
</syntaxhighlight>
| regexp7 = rowcellstyle[%d][%d]*
 
</pre>
Where the first set of args are the module args below and the second set of args are the parameters that are checked.
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>.
* [[: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.
* {{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.
* {{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.
* {{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}}.
* {{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 ==
== Example ==
<pre>
<syntaxhighlight lang="wikitext">
{{Infobox
{{Infobox
| above = {{{name|}}}
| above = {{{name|}}}
Line 59: 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==
==See also==
* {{clc|Unknown parameters}} (category page can have {{tl|Unknown parameters category}})
* {{Clc|Unknown parameters}} (category page can have header {{tl|Unknown parameters category}})
* [[Module:Check for deprecated parameters]] - similar module that checks for deprecated parameters
* [[Module:Params]] – for complex operations involving parameters
* [[:module:TemplatePar]] - similar function (originally from dewiki)
* [[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
* [[Template:Parameters]] and [[Module:Parameters]] – generates a list of parameter names for a given template
* [[:he:Module:ParamValidator]] - parameter validation system on hewiki, relies on TemplateData. module doc in English. checks the following:
* [[Project:TemplateData]] based template parameter validation
**use of undeclared parameters
* [[Module:Parameter validation]] checks a lot more
** use of parameters marked in templatedata "deprecated"
* [[User:Bamyers99/TemplateParametersTool]] - A tool for checking usage of template parameters
** 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>{{sandbox other||
<includeonly>{{Sandbox other||
<!-- Categories go here and interwikis go in Wikidata. -->
<!-- Categories go here and interwikis go in Wikidata. -->
[[Category:Modules that add a tracking category]]


}}</includeonly>
}}</includeonly>
<noinclude>
[[Category:Module documentation pages]]
</noinclude>
Anonymous user
Retrieved from ‘https://saintapedia.org/wiki/Special:MobileDiff/1425’

Navigation menu