モジュール:If preview

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

このモジュールは{{If preview}}と{{Preview warning}}を実装します。テンプレートやモジュールでプレビュー中かどうかを判定するときに使用します。

テンプレートでは{{If preview}}と{{Preview warning}}を使い、このテンプレートを直接呼び出さないでください。

ほかのモジュールからこのモジュールのmain()関数を呼び出す場合、argsテーブルを含むframeテーブルを渡す必要があります。プレビュー時に表示する警告文については、_warning()を呼び出してください。

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

local p = {}

local cfg = mw.loadData('Module:If preview/configuration')

--[[
main

This function returns either the first argument or second argument passed to
this module, depending on whether the page is being previewed.

]]
function p.main(frame)
	if cfg.preview then
		return frame.args[1] or ''
	else
		return frame.args[2] or ''
	end
end

--[[
pmain

This function returns either the first argument or second argument passed to
this module's parent (i.e. template using this module), depending on whether it
is being previewed.

]]
function p.pmain(frame)
	return p.main(frame:getParent())
end


local function warning_text(warning)
	return mw.ustring.format(
		cfg.warning_infrastructure,
		cfg.templatestyles,
		warning
	)
end

function p._warning(args)
	
	local warning = args[1] and args[1]:match('^%s*(.-)%s*$') or ''
	if warning == '' then
		return warning_text(cfg.missing_warning)
	end
	
	if not cfg.preview then return '' end
	
	return warning_text(warning)
end

--[[
warning

This function returns a "preview warning", which is the first argument marked
up with HTML and some supporting text, depending on whether the page is being previewed.

disabled since we'll implement the template version in general

]]
--function p.warning(frame)
--	return p._warning(frame.args)
--end

--[[
warning, but for pass-through templates like {{preview warning}}
]]
function p.pwarning(frame)
	return p._warning(frame:getParent().args)
end

return p