模块:Check for unknown parameters

此模块附于模板来检测未知参数的使用。

用法

基本用法

{{#invoke:check for unknown parameters|check
|unknown=[[分类:某追踪分类]]
|arg1|arg2|...|argN}}

或使用带预览错误信息的参数来排序追踪分类中的条目

{{#invoke:check for unknown parameters|check
|unknown=[[Category:某追踪分类|_VALUE_]]
|preview=未知参数“_VALUE_”
|arg1|arg2|...|argN}}

或直接显示红色错误信息

{{#invoke:check for unknown parameters|check
|unknown=<span class="error">不好意思，_VALUE_是什么？</span>
|arg1|arg2|...|argN}}

以上代码中，arg1、arg2、...、argN为已知参数。任何被使用的未列出参数都会导致模块返回unknown参数中的内容。这样有利于排序追踪列表中的条目，亦有利于提供具体信息。

默认情况下，模块不区分已定义但留空的参数和非空参数。要仅追踪非空参数，请使用|ignoreblank=1。

默认情况下，模块忽略空白位置参数。要追踪空白位置参数，请使用|showblankpositional=1。

正则表达式

本模块支持正则表达式，可在使用大量有规律格式的参数时使用。如，template:infobox3cols中有

| 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]*

即可匹配所有headerNUM、labelNUM、dataNUM、dataNUMa、dataNUMb、dataNUMc、...、rowcellstyleNUM格式的参数，其中NUM为一段数字。

举例

{{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 = [[Category:Some tracking category|_VALUE_]]
| preview = unknown parameter "_VALUE_"
| name
| height | weight
| website
}}

另请参阅

• module:TemplatePar（来自德语维基百科）
• Template:Parameters 与 Module:Parameters – 生成给定模板的参数名列表

---

-- 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 trim(s) ~= ''
end

function p.check (frame)
	local args = frame.args
	local pargs = frame:getParent().args
	local ignoreblank = isnotempty(frame.args['ignoreblank'])
	local showblankpos = isnotempty(frame.args['showblankpositional'])
	local knownargs = {}
	local unknown = frame.args['unknown'] or 'Found _VALUE_, '
	local preview = frame.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 = '<div class="hatnote" style="color:red"><strong>警告：</strong>' .. preview .. '（此信息仅在预览中显示）。</div>'
	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 i, 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
				k = mw.ustring.gsub(k, '[^%w\-_ ]', '?')
				table.insert(values, k)
			end
		elseif type(k) == 'number' and 
			knownargs[tostring(k)] == nil and
			( showblankpos or isnotempty(v) )
		then
			local vlen = mw.ustring.len(v)
			v = mw.ustring.sub(v, 1, (vlen < 25) and vlen or 25) 
			v = mw.ustring.gsub(v, '[^%w\-_ ]', '?')
			table.insert(values, k .. ' = ' .. v .. ((vlen >= 25) and ' ...' or ''))
		end
	end

	-- add resuls to the output tables
	if #values > 0 then
		if frame:preprocess( "{{REVISIONID}}" ) == "" then
			unknown = preview
		end
		for k, 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
			local r =  unknown:gsub('_VALUE_', v)
			table.insert(res, r)
		end
	end

	return table.concat(res)
end

return p