Wiki Scholarship

Mô đun:Check for unknown parameters

Tài liệu mô đun

This module may be appended to a template to check for uses of unknown parameters. Unlike many other modules, this module is not implemented by a template.

Usage

Basic usage

{{#invoke:Check for unknown parameters|check|unknown=[[Category:Some tracking category]]|arg1|arg2|arg3|argN}}

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_"|arg1|arg2|...|argN}}

or for an explicit red error message

{{#invoke:Check for unknown parameters|check|unknown=<span class="error">Sorry, I don't recognize _VALUE_span>|arg1|arg2|...|argN}}

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, Infobox3cols uses

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

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

Example

{{Infobox| above = {{{name|}}}| label1 = Height| data1 = {{{height|}}}| label2 = Weight| data2 = {{{weight|}}}| label3 = Website| data3 = {{{website|}}}}}{{#invoke:Check for unknown parameters|check| unknown = {{Main other|[[Category:Some tracking category|_VALUE_]]}}| preview = unknown parameter "_VALUE_"| name| height | weight| website}}

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

Tài liệu bên trên được truyền tải từ Mô đun:Check for unknown parameters/tài liệu. (sửa | lịch sử)
Biên tập viên sửa đổi có thể thử nghiệm trong các trang chỗ thử (tạo | sao) và trường hợp kiểm thử (tạo) của mô đun này.
Các trang con của mô đun này.

-- 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 listlocal p = {}local function trim(s)	return s:match('^%s*(.-)%s*$')endlocal function isnotempty(s)	return s and s:match('%S')endlocal 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 pos, 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 = {}	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)endfunction p._check(args, pargs)	if type(args) ~= "table" or type(pargs) ~= "table" then		-- TODO: error handling		return	end	local ignoreblank = isnotempty(args['ignoreblank'])	local showblankpos = isnotempty(args['showblankpositional'])	local knownargs = {}	local unknown = args['unknown'] or 'Tìm thấy _VALUE_, '	local preview = args['preview']	local values = {}	local res = {}	local regexps = {}	-- create the list of known args, regular expressions, and the return string	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	if isnotempty(preview) then		preview = '
Cảnh báo: ' .. preview .. ' (thông báo này chỉ được hiển thị trong bản xem trước).
' elseif preview == nil then preview = unknown end -- loop over the parent args, and make sure they are on the list 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 and ( showblankpos or isnotempty(v) ) then table.insert(values, k .. ' = ' .. clean(v)) end end -- add results to the output tables if #values > 0 then if mw.getCurrentFrame():preprocess( "{{REVISIONID}}" ) == "" then unknown = preview end for _, v in pairs(values) do if v == '' then -- Fix odd bug for | = which gets stripped to the empty string and -- breaks category links v = ' ' end -- avoid error with v = 'example%2' ("invalid capture index") local r = unknown:gsub('_VALUE_', {_VALUE_ = v}) table.insert(res, r) end end return table.concat(res)endfunction p.check(frame) local args = frame.args local pargs = frame:getParent().args return p._check(args, pargs)endreturn p
Lấy từ “https://vi.wikipedia.org/w/index.php?title=Mô_đun:Check_for_unknown_parameters&oldid=67233547”