コンテンツにスキップ

英文维基 | 中文维基 | 日文维基 | 草榴社区

「モジュール:Check for unknown parameters」の版間の差分

削除された内容 追加された内容
m モジュール:Check for unknown parameters」を保護しました: 影響が特に大きいテンプレート: 現時点で 20716 ページからの読み込み ([編集=管理者のみに許可] (無期限) [移動=管理者のみ...
モジュール:Check for unknown parameters/sandbox 2016-07-26T16:33:36‎‎ UTC{←継承元: en:Module:Check for unknown parameters 2016年6月23日 (木) 14:41(UTC)より)} より全文転記; WP:AN/PEに基づく。
16行目: 16行目:
local pargs = frame:getParent().args
local pargs = frame:getParent().args
local ignoreblank = isnotempty(frame.args['ignoreblank'])
local ignoreblank = isnotempty(frame.args['ignoreblank'])
local checkpos = isnotempty(frame.args['checkpositional'])
local showblankpos = isnotempty(frame.args['showblankpositional'])
local knownargs = {}
local knownargs = {}
local unknown = frame.args['unknown'] or 'Found _VALUE_, '
local unknown = frame.args['unknown'] or 'Found _VALUE_, '
local preview = frame.args['preview']
local preview = frame.args['preview']


local values = {}
local res = {}
local res = {}
local regexps = {}
local regexps = {}

local comments = {}
local commentstr = ''
local ispreview = frame:preprocess( "{{REVISIONID}}" ) == "" and 1 or 0
-- create the list of known args, regular expressions, and the return string
-- create the list of known args, regular expressions, and the return string
for k, v in pairs(args) do
for k, v in pairs(args) do
41行目: 38行目:
elseif preview == nil then
elseif preview == nil then
preview = unknown
preview = unknown
end
if ispreview == 1 then
unknown = preview
ignoreblank = false
end
-- adds one result to the output tables
local function addresult(k)
if k == '' then
-- Fix odd bug for | = which gets stripped to the empty string and
-- breaks category links
k = ' '
end
local r = unknown:gsub('_VALUE_', k)
table.insert(res, r)
table.insert(comments, '"' .. k .. '"')
end
end


71行目: 52行目:
if not knownflag and ( not ignoreblank or isnotempty(v) ) then
if not knownflag and ( not ignoreblank or isnotempty(v) ) then
k = mw.ustring.gsub(k, '[^%w\-_ ]', '?')
k = mw.ustring.gsub(k, '[^%w\-_ ]', '?')
addresult(k)
table.insert(values, k)
end
end
elseif checkpos and
elseif type(k) == 'number' and
type(k) == 'number' and
knownargs[tostring(k)] == nil and
knownargs[tostring(k)] == nil and
( not ignoreblank or isnotempty(v) )
( showblankpos or isnotempty(v) )
then
then
local vlen = mw.ustring.len(v)
addresult(k)
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
end
end


-- add resuls to the output tables
if #comments > 0 then
if #values > 0 then
commentstr = '<!-- Module:Check for unknown parameters results: ' ..
if frame:preprocess( "{{REVISIONID}}" ) == "" then
table.concat(comments, ', ') .. '-->'
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
end

return table.concat(res) .. commentstr
return table.concat(res)
end
end



2016年8月11日 (木) 03:12時点における版

モジュールの解説[表示] [編集] [履歴] [キャッシュを破棄]

このモジュールはテンプレート内で不明な引数を検査するのに使われます。

使い方

基本的な使い方

{{#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}}

上記の例において、arg1arg2からargNまでが既知とされる引数であり、名無し引数も|1|2|argname1|argname2|...のように指定できます。この呼び出しで記入されていない引数が指定されている場合、モジュールはunknown引数を返します。_VALUE_のキーワードは当該引数名を返します。このキーワードはエラーメッセージをより正確にしたり、追跡カテゴリでソートキーとして使ったりできます。

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

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

Luaパターン

このモジュールではLuaパターン正規表現と似ている)が使えます。これは数多くの引数が何らかのパターンに従っているときに使えます。例えば、Template:Infobox3colsでは下記のように指定して、headerNUMlabelNUMdataNUMdataNUMadataNUMbdataNUMcrowcellstyleNUM(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:Parametersen:Module:Parameters – テンプレートから引数名のリストを生成する
  • he:Module:ParamValidator - TemplateDataに基づいて引数の検査を行う、ヘブライ語ウィキペディアのモジュール(英語の説明文あり)。下記を検査できます:
    • TemplateDataにない引数の使用
    • TemplateDataで非推奨と指定された引数
    • 引数内容の打ち間違い(主に「数字」とされる引数で数字以外が入力された場合)
    • TemplateDataで必須と指定された引数の未指定
    • 引数とそのエイリアスの両方が指定されている場合

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