Dokumentasion ti modulo

Katulong a modulo tapno mapakabaelan a masukatan ti plantilia tapno agbalin a mailak-am a plantilia.

Dagiti panagtaripato a plantilia, a kas ti {{Masapul a dakamaten}} wenno {{Refimprove}}, ket nasken a saan a masukatan. Tapno maliklikan ti kasta, nasken a masukatan ti plantilia iti mailak-am a pormana.

Dagit iinfobox ken naskenda koma nga agusar iti Modulo:Unsubst-infobox, ken dagiti pay ania man a sabali a plantilia nga agramam kadagiti parametro iti kasiisgud a pormat ti muton.

Panagusar

urnosen

Ti panangibaliw ti plantilia iti bukod a mangisukat a plantilia, balkoten ti adda a kodigo ti plantilia iti:

{{ {{{|safesubst:}}}#invoke:Unsubst||$B=

 [ ... ti agdama a kodigo ti plantilia ... ]

}}

Ti teksto ti wiki a maiparang no saan a maisukat ket nasken a maited a kas "$B". Dagiti amin a parametro a maipasa iti #invoke ket makopianto iti mapataud a parametro a maiparuar a kas kasisigud a pateg. No ti pateg iti aniaman kadagitoy a kasisigud a parametro ket "__DATE__", dayta a pateg a napataud ti plantilia a naiparuar ket isonto ti agdama a bulan ken tawen.

Adda met dagiti plantilia nga addaan iti <noinclude> ngem awan ti kapada a </noinclude> iti gibus ti plantilia. Kadagita a kaso ti awan a </noinclude> ket nasken a mainayon sakbay ti mangipatingga a }}.

Napasayaat

urnosen
{{ {{{|safesubst:}}}#invoke:Unsubst||$params=[ parameters ]|$aliases=[ aliases ]|$flags=[ flags ]|$B=

 [ ... ti agdama a kodigo ti plantilia ... ]

}}

Gapu dagiti limitasion ti Lua, dagiti parametro ket kadawyan a pugto a maurnos no mailak-am ti plantilia. TIi |$params= ket mabalin a mausar iti #invoke:Unsubst tapno naurnos a mailista dagiti parametro ti plantilia, naisina iti kaw-it (kas itiegg,bacon,sausage,cheese,spam). Dagiti nabilangan a parametro ket nasken a sakbay dagiti dadduma iti listaan. Dagiti ania amna a nabati a parametro ket maikabil iti gibus iti nmapataud a panangawag.

Dagiti parbo anagan ti parametro ket mabalin a amilista iti |$aliases= (ken nasken a saan a mailista iti |$params=), ken automatikonto a masukatan. Ti tunggal maysa a parno a nagan ken ti mangsukat daytoy ket nasken a mapormat a kas alias>replacement, ken iti tunggal maysa kadagita aparis ket nasken a maisina iti kaw-it (kas iti œuf>egg,melt>cheese). Laglagipen a daytoy a parametro ket mabalin no adda wenno awan ti |$params=.

Ti parametro ti |$flags= ket mabalin a mausar tapno mabaliwan dagiti sabali a langa ti panagkukua ti modulo; dagiti maikabil ket maisina iti kaw-it. Dagiti umiso a wagayway ket override (mangipalubos kadagiti parametro iti #invoke: tapno umuna kadagiti parametro iti kasisigud a panangawag iti plantilia); keep-whitespace (mangipawil a mangkissay ti whitespace manipud kadagiti saan a nanaganan a parametro); ken remove-empty (agikkat kadagiti awan linaon a parametro).

Dagitoy aparametro ket mabalin a mabaliwan dagitilanga babaen ti panagusar kadagiti annong ti parser tapno mangited kadagiti ad-adu a komplikado a pagpilian (laglagipen a kadagiti parametro, dagiti ania man nga annong ti parser, wenno plantilia wenno panangawag iti modulo, ket nasken koma nga addaan pay iti {{{|safesubst:}}}).

Kas pagarigan

urnosen

Kas pagarigan ti Plantilia:Kaspagarigan nga aglaon ti sumaganad a kodigo:

{{ {{{|safesubst:}}}#invoke:Unsubst||foo=bar |date=__DATE__ |$B=

 [ ... Mapan ditoy ti kodigo ti plantilia ... ]

}}
Kasisigud Resulta
{{subst:kaspagarigan}} {{Kaspagarigan|foo=bar|date=Nobiembre 2024}}
{{subst:kaspagarigan|foo=X}} {{Kaspagarigan|foo=X|date=Nobiembre 2024}}
{{subst:kaspagarigan|baz=X}} {{Kaspagarigan|foo=bar|baz=X|date=Nobiembre 2024}}
{{subst:kaspagarigan|date=Enero 2001}} {{Kaspagarigan|foo=bar|date=Enero 2001}}

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('Modulo:Panangawag ti plantilia')
	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