Movatterモバイル変換


[0]ホーム

URL:


Jump to content
WikipediaThe Free Encyclopedia
Search

Module:Check for unknown parameters/doc

From Wikipedia, the free encyclopedia
<Module:Check for unknown parameters
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.
WarningThis 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.

Usage

[edit]

From a template

[edit]

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

[edit]

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.

Parameters

[edit]
  • arg1,arg2, ...,argN, are the known parameters.
  • Unnamed (positional) parameters can be added too:|1|2|arg1|arg2|....
  • Lua patterns (similar toregular 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 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.
  • 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. Toinclude blank positional parameters in the tracking use|showblankpositional=1.

Example

[edit]
{{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

[edit]

See the end ofModule:Rugby box for a simple example orModule:Infobox3cols orModule:Flag for more complicated examples.

See also

[edit]
Retrieved from "https://en.wikipedia.org/w/index.php?title=Module:Check_for_unknown_parameters/doc&oldid=1294070495"
Hidden category:

[8]ページ先頭

©2009-2025 Movatter.jp