Module:Check for unknown parameters/sandbox
Appearance
From Wikipedia, the free encyclopedia
This is the module sandbox page for Module:Check for unknown parameters (diff).
See also the companion subpage for test cases (run).
See also the companion subpage for test cases (run).
[画像:Warning] This Lua module is used in system messages, and on approximately 21,900,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 own module sandbox. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them.
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 own module sandbox. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them.
[画像:Ready for use] This module is rated as ready for general use. It has reached a mature form and is thought to be relatively bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other Wikipedia resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing.
[画像:Protected] This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing.
This module can only be edited by administrators because it is transcluded onto one or more cascade-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:
{{#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 class="error">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]}}
From a module
[edit ]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
[edit ]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 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. To include 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 of Module:Rugby box for a simple example or Module:Infobox3cols or Module:Flag for more complicated examples.
See also
[edit ]- Category:Unknown parameters (291) (category page can have header {{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
The above documentation is transcluded from Module:Check for unknown parameters/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (edit | run) pages.
Add categories to the /doc subpage. Subpages of this module.
Editors can experiment in this module's sandbox (edit | diff) and testcases (edit | run) pages.
Add categories to the /doc subpage. Subpages of this module.
-- This module may be used to compare the arguments passed to the parent -- with a list of arguments, returning a specified result if an argument is -- not on the list local p = {} local function trim(s) return s:match('^%s*(.-)%s*$') end local function isnotempty(s) return s and s:match('%S') end local function clean(text) -- Return text cleaned for display and truncated if too long. -- Strip markers are replaced with dummy text representing the original wikitext. local truncated local function truncate(text) if truncated then return '' end if mw.ustring.len(text) > 25 then truncated = true text = mw.ustring.sub(text, 1, 25) .. '...' end return mw.text.nowiki(text) end local parts = {} local pos for before, tag, remainder in text:gmatch('([^127円]*)127円[^127円]*%-(%l+)%-[^127円]*127円()') do pos = remainder table.insert(parts, truncate(before) .. '<' .. tag .. '>...</' .. tag .. '>') end table.insert(parts, truncate(text:sub(pos or 1))) return table.concat(parts) end local function get_values(args, pargs) -- create the list of known args, regular expressions, and the return string local knownargs = {} local regexps = {} for k, v in pairs(args) do if type(k) == 'number' then v = trim(v) knownargs[v] = 1 elseif k:find('^regexp[1-9][0-9]*$') then table.insert(regexps, '^' .. v .. '$') end end -- loop over the parent args, and make sure they are on the list local ignoreblank = isnotempty(args['ignoreblank']) local showblankpos = isnotempty(args['showblankpositional']) local values = {} for k, v in pairs(pargs) do if type(k) == 'string' and knownargs[k] == nil then local knownflag = false for _, regexp in ipairs(regexps) do if mw.ustring.match(k, regexp) then knownflag = true break end end if not knownflag and ( not ignoreblank or isnotempty(v) ) then table.insert(values, clean(k)) end elseif type(k) == 'number' and knownargs[tostring(k)] == nil then local knownflag = false for _, regexp in ipairs(regexps) do if mw.ustring.match(tostring(k), regexp) then knownflag = true break end end if not knownflag and ( showblankpos or isnotempty(v) ) then table.insert(values, k .. ' = ' .. clean(v)) end end end return values end function p._check(args, pargs) if type(args) ~= "table" or type(pargs) ~= "table" then -- TODO: error handling return end local values = get_values(args, pargs) -- add results to the output tables local previews = {} local categories = {} local unknown_category = args['unknown'] local preview_text = args['preview'] or 'Found _VALUE_, ' if #values > 0 then preview_text = require('Module:If preview')._warning({preview_text}) for _, v in pairs(values) do -- Fix odd bug for | = which gets stripped to the empty string and -- breaks category links if v == '' then v = ' ' end -- avoid error with v = 'example%2' ("invalid capture index") local category = unknown_category:gsub('_VALUE_', {_VALUE_ = v}) local preview = preview_text:gsub('_VALUE_', {_VALUE_ = v}) table.insert(categories, category) table.insert(previews, preview) end end return table.concat(previews) .. "\n" .. table.concat(categories) end function p.check(frame) local args = frame.args local pargs = frame:getParent().args return p._check(args, pargs) end return p