コンテンツにスキップ

モジュール:Unsubst

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

{{Citation needed}} や {{Refimprove}} などのメンテナンステンプレートは、subst展開されるべきではありません。この問題を回避する方法のひとつは、テンプレートを「展開しても再びテンプレート呼び出しの形で残す」ように作ることです。このモジュールはその処理を実装します。

インフォボックスや、パラメーターがブロック形式で記述されるその他のテンプレートでは、Module:Unsubst-infobox を使用してください。

使い方

[編集]

テンプレートを自己subst展開するようにするには、既存のテンプレートコード全体を以下のように囲みます： 

{{SAFESUBST:<noinclude />#invoke:Unsubst||$B=

 [ ... 既存のテンプレートコード ... ]

}}

subst展開されていない状態で表示されるウィキテキストは $B に指定します。#invoke に渡された他のすべてのパラメーターは、生成されるテンプレート呼び出しにデフォルト値として含まれます。これらのデフォルトパラメーターの値として __DATE__ を使用すると、展開されたテンプレート呼び出しにはその時点の月と年が挿入されます。

テンプレートの中には、<noinclude> タグはあるが、それに対応する閉じタグ </noinclude> が存在しないものもあります。そのような場合は、閉じタグを }} の直前に追加する必要があります。

上級オプション

[編集]
{{SAFESUBST:<noinclude />#invoke:Unsubst||$params=[パラメーター一覧]|$aliases=[エイリアス一覧]|$flags=[フラグ]|$B=

 [ ... 既存のテンプレートコード ... ]

}}

Lua の制限により、subst展開時にはパラメーターの順序がランダムになることがあります。$params を指定することで、テンプレートパラメーターの順序をカンマ区切りで明示できます（例：egg,bacon,sausage,cheese,spam）。数値付きのパラメーターは他のパラメーターより前に記述してください。残りのパラメーターは末尾に追加されます。

パラメーターのエイリアスは $aliases に指定できます（$params には含めないでください）。各エイリアスとその置換先は エイリアス>置換先 の形式で記述し、それらをカンマで区切ります（例：œuf>egg,melt>cheese）。このオプションは $params なしでも使用可能です。

$flags ではモジュールの挙動を細かく制御できます。カンマ区切りで指定でき、使用可能なフラグは次のとおりです： - override: 呼び出し元の #invoke: 側のパラメーターを優先 - keep-whitespace: 無名パラメーターの前後の空白を除去しない - remove-empty: 空のパラメーターを削除

これらのパラメーターにはパーサ関数を使用することもでき、より複雑なオプション指定が可能です（パーサ関数、テンプレート、モジュール呼び出しは SAFESUBST:<noinclude /> を使ってください）。

$template-name パラメーターを使うと、展開後のテンプレート名を任意の名前に置き換えることができます。

使用例

[編集]

テンプレート「Template:Example」に以下のコードが含まれているとします： 

{{SAFESUBST:<noinclude />#invoke:Unsubst||foo=bar |date=__DATE__ |$B=

 [ ... テンプレート本体 ... ]

}}

次のように展開されます：

元の呼び出し 展開結果
{{subst:example}} {{Example|date=3月 2026|foo=bar}}
{{subst:example|foo=X}} {{Example|date=3月 2026|foo=X}}
{{subst:example|baz=X}} {{Example|baz=X|date=3月 2026|foo=bar}}
{{subst:example|date=January 2001}} {{Example|date=January 2001|foo=bar}}
この解説は、モジュール:Unsubst/docから呼び出されています。 (編集 | 履歴)
編集者は、このモジュールをサンドボックス (作成 | 複製)とテストケース (作成)で試すことができます。（解説）
このモジュールのサブページ一覧。

local checkType = require('libraryUtil').checkType

local p = {}

local BODY_PARAM = '$B'

local specialParams = {
	['$params'] = 'parameter list',
	['$aliases'] = 'parameter aliases',
	['$flags'] = 'flags',
	['$B'] = 'template content',
	['$template-name'] = 'template invocation name override',
}

function p.main(frame, body)
	-- If we are substing, this function returns a template invocation, and if
	-- not, it returns the template body. The template body can be specified in
	-- the body parameter, or in the template parameter defined in the
	-- BODY_PARAM variable. This function can be called from Lua or from
	-- #invoke.

	-- Return the template body if we aren't substing.
	if not mw.isSubsting() then
		if body ~= nil then
			return body
		elseif frame.args[BODY_PARAM] ~= nil then
			return frame.args[BODY_PARAM]
		else
			error(string.format(
				"no template content specified (use parameter '%s' from #invoke)",
				BODY_PARAM
			), 2)
		end
	end

	-- Sanity check for the frame object.
	if type(frame) ~= 'table'
		or type(frame.getParent) ~= 'function'
		or not frame:getParent()
	then
		error(
			"argument #1 to 'main' must be a frame object with a parent " ..
			"frame available",
			2
		)
	end

	-- Find the invocation name.
	local mTemplateInvocation = require('Module:Template invocation')
	local name

	if frame.args['$template-name'] and '' ~= frame.args['$template-name'] then
		name = frame.args['$template-name']										-- override whatever the template name is with this name
	else
		name = mTemplateInvocation.name(frame:getParent():getTitle())
	end

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

	-- Trim parameters, if not specified otherwise
	if not string.find( ','..(frame.args['$flags'] or '')..',', ',%s*keep%-whitespace%s*,' ) then
		for k, v in pairs( args ) do args[k] = mw.ustring.match(v, '^%s*(.*)%s*$') or '' end
	end

	-- Pull information from parameter aliases
	local aliases = {}
	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*' )
			aliases[tonumber(mw.ustring.match(tmp[1], '^[1-9][0-9]*$')) or tmp[1]] = ((tonumber(mw.ustring.match(tmp[2], '^[1-9][0-9]*$'))) or tmp[2])
		end
	end
	for k, v in pairs( aliases ) do
		if args[k] and ( not args[v] or args[v] == '' ) then
			args[v] = args[k]
		end
		args[k] = nil
	end

	-- Remove empty parameters, if specified
	if string.find( ','..(frame.args['$flags'] or '')..',', ',%s*remove%-empty%s*,' ) then
		local tmp = 0
		for k, v in ipairs( args ) do
			if v ~= '' or ( args[k+1] and args[k+1] ~= '' ) or ( args[k+2] and args[k+2] ~= '' ) then
				tmp = k
			else
				break
			end
		end
		for k, v in pairs( args ) do
			if v == '' then
				if not (type(k) == 'number' and k < tmp) then args[k] = nil end
			end
		end
	end

	-- Order parameters
	if frame.args['$params'] then
		local params, tmp = mw.text.split( frame.args['$params'], '%s*,%s*' ), {}
		for k, v in ipairs(params) do
			v = tonumber(mw.ustring.match(v, '^[1-9][0-9]*$')) or v
			if args[v] then tmp[v], args[v] = args[v], nil end
		end
		for k, v in pairs(args) do tmp[k], args[k] = args[k], nil end
		args = tmp
	end

	return mTemplateInvocation.invocation(name, args)
end

p[''] = p.main -- For backwards compatibility

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