Create a new article
Write your page title here:
We currently have 230 articles on Farthest Frontier. Type your article name above or create one of the articles listed here!

    Farthest Frontier

    Module:Check for unknown parameters/doc

    This is the documentation page for Module:Check for unknown parameters

    This module may be appended to a template to check for uses of unknown parameters.


    Basic usage

    {{#invoke:check for unknown parameters|check
    |unknown=[[Category:Some tracking category]]

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

    {{#invoke:check for unknown parameters|check
    |unknown=[[Category:Some tracking category|_VALUE_]]
    |preview=unknown parameter "_VALUE_"

    or for an explicit red error message

    {{#invoke:check for unknown parameters|check
    |unknown=<span class="error">Sorry, I don't recognize _VALUE_</span>

    Here, arg1, arg2, ..., argN, are the known parameters. Unnamed (positional) parameters can be added too: |1|2|argname1|argname2|.... Any parameter which is used, but not on this list, will cause the module to return whatever is passed with the unknown parameter. 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.

    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.

    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.

    Lua patterns

    This module supports Lua patterns (similar to regular expressions), which are useful when there are many known parameters which use a systematic pattern. For example, template:infobox3cols uses

    | regexp1 = header[%d][%d]*
    | regexp2 = label[%d][%d]*
    | regexp3 = data[%d][%d]*[abc]?
    | regexp4 = class[%d][%d]*[abc]?
    | regexp5 = rowclass[%d][%d]*
    | regexp6 = rowstyle[%d][%d]*
    | regexp7 = rowcellstyle[%d][%d]*

    to match all parameters of the form headerNUM, labelNUM, dataNUM, dataNUMa, dataNUMb, dataNUMc, ..., rowcellstyleNUM, where NUM is a string of digits.


    | 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_"
    | name
    | height | weight
    | website

    See also

    Cookies help us deliver our services. By using our services, you agree to our use of cookies.
    Cookies help us deliver our services. By using our services, you agree to our use of cookies.