モジュール:Check for unknown parameters

モジュールの解説かいせつ[表示ひょうじ] [編集へんしゅう] [履歴りれき] [キャッシュを破棄はき]

このモジュールはテンプレート内ないで不明ふめいな引数ひきすうを検査けんさするのに使つかわれます。

使つかい方かた

基本きほん的てきな使つかい方かた

{{#invoke:check for unknown parameters|check
|unknown=[[Category:何なんらかの追跡ついせきカテゴリ]]
|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までが既知きちとされる引数ひきすうであり、名無ななし引数ひきすうも|1|2|argname1|argname2|...のように指定していできます。この呼よび出だしで記入きにゅうされていない引数ひきすうが指定していされている場合ばあい、モジュールはunknown引数ひきすうを返かえします。_VALUE_のキーワードは当該とうがい引数ひきすう名めいを返かえします。このキーワードはエラーメッセージをより正確せいかくにしたり、追跡ついせきカテゴリでソートキーとして使つかったりできます。

このモジュールは既定きていでは空白くうはくと空白くうはく以外いがいを指定していした引数ひきすうを区別くべつしません。例たとえば、|foo=xと|foo=は同おなじ扱あつかいになります。空白くうはく以外いがいを指定していした引数ひきすうのみ追跡ついせきする場合ばあいは|ignoreblank=1を指定していしてください。

このモジュールは既定きていでは空白くうはくの名無ななし引数ひきすうを追跡ついせきしません。例たとえば、|2=は無視むしされます。このような引数ひきすうを追跡ついせきする場合ばあいは|showblankpositional=1を指定していしてください。

Luaパターン

このモジュールではLuaパターン（正規せいき表現ひょうげんと似にている）が使つかえます。これは数すう多おおくの引数ひきすうが何なんらかのパターンに従したがっているときに使つかえます。例たとえば、Template:Infobox3colsでは下記かきのように指定していして、headerNUM、labelNUM、dataNUM、dataNUMa、dataNUMb、dataNUMc、rowcellstyleNUM（NUMは数字すうじ）といった形かたちの引数ひきすうをマッチしています。

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

例れい

{{Infobox
| above = {{{name|}}}
| label1 = 高たかさ
| data1 = {{{height|}}}
| label2 = 重おもさ
| data2 = {{{weight|}}}
| label3 = ウェブサイト
| data3 = {{{website|}}}
}}<!-- 
  Infoboxの終おわり、追跡ついせきの始はじまり
-->{{#invoke:Check for unknown parameters|check
| unknown = {{main other|[[Category:何なんらかの追跡ついせきカテゴリ|_VALUE_]]}}
| preview = 不明ふめいな引数ひきすう "_VALUE_"
| name
| height | weight
| website
}}

このモジュールを使用しようしているテンプレート

検索けんさくをご参照さんしょうください。

関連かんれん項目こうもく

• Module:TemplatePar（ドイツ語ご版ばんウィキペディアより移入いにゅう）
• en:Template:Parametersとen:Module:Parameters – テンプレートから引数ひきすう名めいのリストを生成せいせいする
• he:Module:ParamValidator - TemplateDataに基もとづいて引数ひきすうの検査けんさを行おこなう、ヘブライ語ごウィキペディアのモジュール（英語えいごの説明せつめい文ぶんあり）。下記かきを検査けんさできます：
  • TemplateDataにない引数ひきすうの使用しよう
  • TemplateDataで非ひ推奨すいしょうと指定していされた引数ひきすう
  • 引数ひきすう内容ないようの打うち間あいだ違ちがい（主おもに「数字すうじ」とされる引数ひきすうで数字すうじ以外いがいが入力にゅうりょくされた場合ばあい）
  • TemplateDataで必須ひっすと指定していされた引数ひきすうの未み指定してい
  • 引数ひきすうとそのエイリアスの両方りょうほうが指定していされている場合ばあい

この解説かいせつは、モジュール:Check for unknown parameters/docから呼よび出だされています。 (編集へんしゅう | 履歴りれき)
編集へんしゅう者しゃは、このモジュールをサンドボックス (編集へんしゅう | 差分さぶん)とテストケース (作成さくせい)で試ためすことができます。（解説かいせつ）
このモジュールのサブページ一覧いちらん。

-- 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 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)
end

function 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 'Found _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 = '<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 _, 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)
end

function p.check(frame)
	local args = frame.args
	local pargs = frame:getParent().args
	return p._check(args, pargs)
end

return p