پودمان:If preview

این پودمان برای پیاده‌سازی {{فقط در پیش‌نمایش}} و {{هشدار پیش‌نمایش}} به‌کار می‌رود و به الگوها/پودمان‌ها کمک می‌کند تا دریابند که آیا در حالت پیش‌نمایش هستند یا خیر.

در الگوهای دیگر، به‌کار بردن الگوهایی که برای پیاده‌سازی این پودمان ایجاد شده‌اند، ارجح است.

برای استفاده از تابع ‎main()‎ در یک پودمان، لازم است که یک جدول چارچوب را به‌همراه جدول آرگومان‌ها به پودمان بفرستید.

برای هشدار پیش‌نمایش می‌توانید از ‎_warning()‎ استفاده کنید.

---

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