Module:Check for unknown parameters/doc
Tools
Actions
General
Print/export
In other projects
![]() | This is adocumentationsubpage forModule:Check for unknown parameters. It may contain usage information,categories and other content that is not part of the original module page. |
![]() | This Lua module is used in system messages, and onapproximately 22,100,000 pages, or roughly 35% of all pages. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid major disruption and server load, any changes should be tested in the module's/sandbox or/testcases subpages, or in your ownmodule sandbox. The tested changes can be added to this page in a single edit. Please discuss changes on thetalk page before implementing them. |
![]() | This module can only be edited byadministrators because it istranscluded onto one or morecascade-protected pages. |
![]() | This module depends on the following other modules: |
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.
To sort entries into a tracking category by parameter, use:
{{#invoke:Check for unknown parameters|check|unknown=[[Category:Some tracking category|_VALUE_]]|arg1|arg2|arg3|argN}}
To sort the entries into a tracking category by parameter with a preview error message, use:
{{#invoke:Check for unknown parameters|check|unknown=[[Category:Some tracking category|_VALUE_]]|preview=unknown parameter "_VALUE_"|arg1|arg2|...|argN}}
For an explicit red error message, use:
{{#invoke:Check for unknown parameters|check|unknown=<span>Sorry, I don't recognize _VALUE_</span>|arg1|arg2|...|argN}}
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]}}
To call from a module, use:
localcheckForUnknownParameters=require("Module:Check for unknown parameters")localresult=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.
arg1
,arg2
, ...,argN
, are the known parameters.|1|2|arg1|arg2|...
.|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 unknown 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._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. Toinclude blank positional parameters in the tracking use|showblankpositional=1
.{{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}}
See the end ofModule:Rugby box for a simple example orModule:Infobox3cols orModule:Flag for more complicated examples.