コンテンツにスキップ

モジュール:Unsubst-infobox

リンクを追加
提供: Wikisource
モジュールの解説[表示] [編集] [履歴] [キャッシュを破棄]

使い方

[編集]

{{SAFESUBST:<noinclude />#invoke:Unsubst-infobox||$B=テンプレート本体|$params=パラメーター一覧}}

インフォボックスはsubst展開されるべきではありません。これを回避するための一つの方法は、テンプレートを「展開してもそのまま transclude（展開なし）として残す」ようにすることです。このモジュールは Module:Unsubst に似ています。parameters には、呼び出し元のインフォボックステンプレートが受け取るパラメーター名をカンマ区切りで指定します。

パラメーター一覧

[編集]
$B
モジュールを使用していない場合のテンプレート本体の内容。
$params
カンマ区切りで指定されたテンプレートのパラメーター一覧（エイリアスは含まない）。なお、$params=1 のように位置パラメーターを含めたテンプレートと、{{subst:example|a}} のような記事中の使用では、{{subst:example|a|1=}} のように上書きされるバグがあります。
$aliases
パラメーター置換の一覧をカンマ区切りで指定。形式は old1>new1,old2>new2。たとえば |$aliases=2>details|$params=details のように指定した場合、{{subst:example|abc|def|ghi}} のような使用において {{subst:example|abc|details=def}} となり、整合性の問題でデータが失われることがあります。
$set3
通常は短めのパラメーター一覧（カンマ区切り）。$params に含まれるすべてのパラメーターがここに含まれていれば、このリストが使用されます。特定の条件下でのみ使われるパラメーター群をまとめる用途など。
$set2
条件付きで $set3 または $params（直前に選ばれた方）を置き換えるリスト。通常はそれよりも多くのパラメーターを含みます。
$set1
条件付きで $set3、$set2、または $params（最後に選ばれたもの）を置き換えます。通常はもっとも包括的なリストです。
$extra
$params（または使用された $set1, $set2, $set3）のいずれかに含まれるパラメーターのうち、テンプレート内で実際に使用されていない限りはsubst展開後に表示されなくてよいものを指定（カンマ区切り）。未使用・空白なら出力されません。
$indent
各行の先頭に追加するスペースの数。子インフォボックスなどで便利です。
$flags
挙動を制御するためのフラグ（カンマ区切り）。現在有効な値は override のみです。これは、テンプレート呼び出しにおける引数よりも、モジュール呼び出しで設定された引数を優先するという意味です。たとえば、テンプレート呼び出しで number=6 と指定され、モジュール呼び出しで date=7 と指定されているとき、$flags に override を含めると出力は date=7 になり、含めなければ date=6 になります。
$template-name
subst展開後のテンプレート名を任意の名前に置き換えるために使用できます。

上記以外のすべてのパラメーターはテンプレートへの通常の入力として扱われます。入力値が空でなく、かつテンプレートの有効なパラメーターであれば、transclusion 側の値が空の場合に限り展開後の出力にその値が表示されます。ただし、$flags に override が指定されていれば、transclusion 側の値に関係なく出力されます。

この解説は、モジュール:Unsubst-infobox/docから呼び出されています。 (編集 | 履歴)
編集者は、このモジュールをサンドボックス (作成 | 複製)とテストケース (作成)で試すことができます。（解説）
このモジュールのサブページ一覧。

local p = {}

local specialParams = {
	['$params'] = 'all parameters',
	['$extra'] = 'extra parameters',
	['$set1'] = 'parameter set 1',
	['$set2'] = 'parameter set 2',
	['$set3'] = 'parameter set 3',
	['$aliases'] = 'parameter aliases',
	['$indent'] = 'indent',
	['$flags'] = 'flags',
	['$B'] = 'template content',
	['$template-name'] = 'template invocation name override'
}

p[''] = function ( frame )
	if not frame:getParent() then
		error( '{{#invoke:Unsubst-infobox|}} makes no sense without a parent frame' )
	end
	if not frame.args['$B'] then
		error( '{{#invoke:Unsubst-infobox|}} requires parameter $B (template content)' )
	end
	if not frame.args['$params'] then
		error( '{{#invoke:Unsubst-infobox|}} requires parameter $params (parameter list)' )
	end

	if mw.isSubsting() then
		---- substing
		-- Combine passed args with passed defaults
		local args = {}
		if string.find( ','..(frame.args['$flags'] or '')..',', ',%s*override%s*,' ) then
			for k, v in pairs( frame:getParent().args ) do
				args[k] = v
			end
			for k, v in pairs( frame.args ) do
				if not specialParams[k] then
					if v == '__DATE__' then
						v = mw.getContentLanguage():formatDate( 'F Y' )
					end
					args[k] = v
				end
			end
		else
			for k, v in pairs( frame.args ) do
				if not specialParams[k] then
					if v == '__DATE__' then
						v = mw.getContentLanguage():formatDate( 'F Y' )
					end
					args[k] = v
				end
			end
			for k, v in pairs( frame:getParent().args ) do
				args[k] = v
			end
		end

		-- Build an equivalent template invocation
		-- First, find the title to use
		local titleobj = mw.title.new(frame:getParent():getTitle())
		local title
		if titleobj.namespace == 10 then -- NS_TEMPLATE
			title = titleobj.text
		elseif titleobj.namespace == 0 then -- NS_MAIN
			title = ':' .. titleobj.text
		else
			title = titleobj.prefixedText
		end

		if frame.args['$template-name'] and '' ~= frame.args['$template-name'] then
			title = frame.args['$template-name'] -- override whatever the template name is with this name
		end

		-- Remove empty fields
		for k, v in pairs( args ) do
			if v == '' then args[k] = nil end
		end

		-- Pull information from parameter aliases
		local aliases, extra = {}, {}
		if frame.args['$aliases'] then
			local list = mw.text.split( frame.args['$aliases'], '%s*,%s*' )
			for k, v in ipairs( list ) do
				local tmp = mw.text.split( v, '%s*>%s*' )
				local alias = (tonumber(mw.ustring.match(tmp[1], '^[1-9][0-9]*$'))) or tmp[1]
				aliases[alias] = ((tonumber(mw.ustring.match(tmp[2], '^[1-9][0-9]*$'))) or tmp[2])
				extra[alias] = true
			end
		end
		for k, v in pairs( aliases ) do
			if args[k] and not args[v] then args[v], args[k] = args[k], nil end
		end

		-- Build the invocation body with numbered args first, then named
		local ret = '{{' .. title
		for k, v in ipairs( args ) do
			if mw.ustring.find( v, '=', 1, true ) then
				-- likely something like 1=foo=bar, we need to do it as a named arg
				break
			end
			ret = ret .. '|' .. v
			args[k] = nil
		end

		-- Pull lists from special parameters
		local discard = {}
		local params = mw.text.split( frame.args['$params'], '%s*,%s*' )
		for k, v in ipairs( params ) do
			-- Numbered args don't go here
			if mw.ustring.match(v, '^[1-9][0-9]*$') then
				table.insert( discard, 1, k )
			end
		end
		for k, v in ipairs( discard ) do table.remove( params, v ) end
		local sets, setparams = {{}, {}, {}}, {}
		for k = 1, 3 do
			local v = frame.args['$set' .. k]
			if v then
				setparams[k] = mw.text.split( v, '%s*,%s*' )
				discard = {}
				for x, y in ipairs( setparams[k] ) do
					sets[k][setparams[k][x]] = true
					-- Numbered args don't go here
					if mw.ustring.match(y, '^[1-9][0-9]*$') then
						table.insert( discard, 1, x )
					end
				end
    			for x, y in ipairs( discard ) do table.remove( setparams[k], y ) end
			end
		end
		if frame.args['$extra'] then
			local tmp = mw.text.split( frame.args['$extra'], '%s*,%s*' )
			for k, v in ipairs( tmp ) do extra[(tonumber(mw.ustring.match(v, '^[1-9][0-9]*$'))) or v] = true end
		end

		-- Replace parameter list with short version if full version not necessary
		local tmp = {}
		for k, v in ipairs( sets ) do
			if next(v) then  -- if table v is not empty
				for _, x in ipairs( params ) do
					if args[x] and not v[x] then
						tmp[k] = true
						break
					end
				end
				if not tmp[k] then params = setparams[k] end
			end
		end

		-- Align parameters correctly and remove extra ones
		local maxlength = 0
		discard = {}
		for k, v in ipairs( params ) do
			if (not extra[v]) or args[v] then
				local tmp = mw.ustring.len( tostring( v ) )
				if tmp > maxlength then maxlength = tmp end
			else
				table.insert( discard, 1, k )
			end
		end
		for k, v in ipairs( discard ) do table.remove( params, v ) end
		local indent = mw.ustring.rep(' ', (tonumber(frame.args['$indent']) or 0))
		-- Numbered args after discontinuity continue first
		discard = {}
		for k, v in pairs( args ) do
			if mw.ustring.match(k, '^[1-9][0-9]*$') then table.insert ( discard, 1, k ) end
		end
		for k, v in ipairs( discard ) do table.insert( params, 1, v ) end

		local space, newline = ' ', '\n'
		if not next(params) then space, newline = '', '' end

		for k, v in ipairs( params ) do
			local tmp = space
			if mw.ustring.match( mw.ustring.sub( ( args[v] or '' ) .. ' ', 1, 1 ), '[%*:;#]' ) then tmp = '\n' end
			ret = ret .. newline .. indent .. '|' .. space .. v .. string.rep(' ', (maxlength - mw.ustring.len( v ))) .. space .. '=' .. tmp .. (args[v] or '')
		end
		
		ret = ret .. newline .. '}}'

		ret = mw.ustring.gsub(ret, '%s+\n', '\n')

		return ret
	else
		-- Not substing
		-- Just return the "body"
		return frame.args['$B']
	end
end

return p
「https://ja.wikisource.org/w/index.php?title=モジュール:Unsubst-infobox&oldid=228196」から取得