Modulo:Arguments/man

O mòdolo Arguments o l'é 'n mòdolo Lua pi-â gestión di argoménti pasæ da #invoke. O l'é 'n metamòdolo pensòu p'êse dêuviòu inte di âtri mòdoli e no gh'à da êse ciamòu con #invoke. E seu fonçioìn inclùddan:

• Levâ i spàççi giànchi da-e estremitæ di argoménti e i argoménti vêui.
• Pasâ i argoménti da-a cornîxe prezénte e da quélla moæ contenporaniaménte (védde chi aprêuvo pe ciù detàggi).
• Pasâ i argoménti diretaménte da 'n âtro mòdolo Lua o da-a consòlle de debug.
• Repigiâ i argoménti sôlo quànde sèrvan, p'evitâ di problêmi co-o tag <ref>…</ref>
• Personalizâ vàrie caraterìstiche.

Ûzo de bâze

Prìmma de tùtto bezéugna caregâ o mòdolo. O contêgne a sôla fonçión ciamâ getArgs.

local getArgs = require('Modulo:Arguments').getArgs

Into câxo de bâze se peu dêuviâ getArgs diretaménte inta fonçión prinçipâ. A variàbile args a l'é 'na tabélla che, dòppo da ciamâ, a contegniâ i argoménti in arîvo da #invoke (véddi chi aprêuvo pe-i detàggi).

local getArgs = require('Modulo:Arguments').getArgs
local p = {}

function p.main(frame)
	local args = getArgs(frame)
	-- Main module code goes here.
end

return p

A ògni mòddo, o mêgio scistêma o l'é quéllo de dêuviâ 'na fonçión dedicâ a procesâ i argoménti de #invoke de mòddo che se sto mòdolo chi o l'é ciamòu da un âtro mòdolo Lua, ciufîto che da 'n'instruçión #invoke, no gh'àgge da avéi 'na cornîxe a dispoxiçión, megiàndo coscì a performance.

local getArgs = require('Modulo:Arguments').getArgs
local p = {}

function p.main(frame)
	local args = getArgs(frame)
	return p._main(args)
end

function p._main(args)
	-- Main module code goes here.
end

return p

Se se veu che ciù fonçioìn dêuvian i mæximi argoménti, rendéndoli acescìbili da #invoke, se peu dêuviâ 'na fonçión de interfàccia.

local getArgs = require('Modulo:Arguments').getArgs

local function makeInvokeFunc(funcName)
	return function (frame)
		local args = getArgs(frame)
		return p[funcName](args)
	end
end

local p = {}

p.func1 = makeInvokeFunc('_func1')

function p._func1(args)
	-- Code for the first function goes here.
end

p.func2 = makeInvokeFunc('_func2')

function p._func2(args)
	-- Code for the second function goes here.
end

return p

Inpostaçioìn

L'é disponìbile de fonçioìn de ciù:

local args = getArgs(frame, {
	trim = false,
	removeBlanks = false,
	valueFunc = function (key, value)
		-- Code for processing one argument
	end,
	frameOnly = true,
	parentOnly = true,
	parentFirst = true,
	wrappers = {
		'Template:A wrapper template',
		'Template:Another wrapper template'
	},
	readOnly = true,
	noOverwrite = true
})

Levâ i spàççi giànchi

I argoménti vêui són de spésso 'n problêma pi-â conversción di template MediaWiki in Lua: inta scintàsci di template e strìnghe vêue e quélle formæ da spàççi són conscideræ fâse, pe cóntra in Lua són conscideræ vêe. P'evitâ sto problêma chi, o mòdolo o lêva in ötomàtico tùtti i argoménti vêui ò formæ sôlo da spàççi.

Quànde sèrvan i argoménti vêui ò i spàççi giànchi se peu impostâ e çèrnie trim e removeBlanks a false.

local args = getArgs(frame, {
	trim = false,
	removeBlanks = false
})

Formataçión personalizâ di argoménti

Se se veu levâ çèrti argoménti vêui, ma no di âtri, ò se veu che tùtti i argoménti poxiçiónali vêgnan minóscoli, se peu dêuviâ a çèrnia valueFunc. L'input de sta çèrnia o gh'à da êse 'na fonçión con doî paràmetri, key e value, e o restitoìsce 'n valô séncio, restitoîo quànde se acêde a-o cànpo key inta tabèlla args.

Prìmmo ezénpio: sta fonçión chi a consèrva i spàççi vêui pò-u prìmmo argoménto poxiçiónale, ma a o lêva da l'inprinçìpio e da-a fìn de tùtti i argoménti e quélli vêui.

local args = getArgs(frame, {
	valueFunc = function (key, value)
		if key == 1 then
			return value
		elseif value then
			value = mw.text.trim(value)
			if value ~= '' then
				return value
			end
		end
		return nil
	end
})

Segóndo ezénpio: sta fonçión chi a lêva i argoménti vêui e a convèrte quélli no vêui in minóscolo, ma a no lêva i spàççi da-i argoménti poxiçionâli.

local args = getArgs(frame, {
	valueFunc = function (key, value)
		if not value then
			return nil
		end
		value = mw.ustring.lower(value)
		if mw.ustring.find(value, '%S') then
			return value
		end
		return nil
	end
})

Nòtta: e fonçioìn chi de d'âto no fonçiónn-an se l'input o no l'é do tîpo string ò nil. Quésto o peu sucêde se l'é dêuviòu a fonçión getArgs inta fonçión prinçipâ do mòdolo e quélla fonçión a l'é reciamâ da 'n âtro modulo Lua. Pe evitâ sto problêma chi bezéugna dêuviâ 'na fonçión specìfica pe-i argoménti ciamâ da 'n #invoke (sàiva a dî co-ina fonçión p.main e 'na fonçión p._main).

Ezénpio 1

local args = getArgs(frame, {
	valueFunc = function (key, value)
		if key == 1 then
			return value
		elseif type(value) == 'string' then
			value = mw.text.trim(value)
			if value ~= '' then
				return value
			else
				return nil
			end
		else
			return value
		end
	end
})

Ezénpio 2

local args = getArgs(frame, {
	valueFunc = function (key, value)
		if type(value) == 'string' then
			value = mw.ustring.lower(value)
			if mw.ustring.find(value, '%S') then
				return value
			else
				return nil
			end
		else
			return value
		end
	end
})

Zaché a fonçión valueFunc a l'é ciamâ tòsto tùtte e vòtte che 'n argoménto o vêgne domandòu da-a tabélla args, bezéugna aseghiâse chò-u seu còdice o ségge eficénte.

Frame e frame poæ

I argoménti da tabélla args pêuan êse pasæ a-o mæximo moménto da-o frame prezénte (quéllo ciamòu con #invoke) ò da-o seu frame poæ (quéllo ch'o contêgne l'#invoke). Prezénpio, se gh'é 'n mòdolo ciamòu Module:ExampleArgs sto lì o stànpa i prìmmi doî argoménti poxiçiónali riçevûi.

Còdice de Modulo

ExampleArgs

local getArgs = require('Modulo:Arguments').getArgs
local p = {}

function p.main(frame)
	local args = getArgs(frame)
	return p._main(args)
end

function p._main(args)
	local first = args[1] or ''
	local second = args[2] or ''
	return first .. ' ' .. second
end

return p

Module:ExampleArgs o l'é ciamòu da Template:ExampleArgs, ch'o contêgne o còdice {{#invoke:ExampleArgs|main|firstInvokeArg}}. Quésto o dà cómme rizultâto "firstInvokeArg".

I rizultâti poscìbili da ciamâ de Template:ExampleArgs són:

Còdice	Rizultâto
{{ExampleArgs}}	firstInvokeArg
{{ExampleArgs|firstTemplateArg}}	firstInvokeArg
{{ExampleArgs|firstTemplateArg|secondTemplateArg}}	firstInvokeArg secondTemplateArg

Gh'é træ çèrnia da dêuviâ pe cangiâne o conportaménto: frameOnly, parentOnly e parentFirst. Se frameOnly o l'é true alôa l'é acetòu sôlo i argoménti pasæ da-o frame prezénte, se parentOnly o l'é true l'é acetòu sôlo i argoménti pasæ da-o frame ò template poæ e se parentFirst o l'é true l'é acetòu ségge i argoménti do frame prezénte che quélli do frame poæ, che gh'aviàn a prioritæ. Prezénpio, i rizultâti són:

frameOnly pe esclùdde i argoménti da-o template

Còdice	Rizultâto
{{ExampleArgs}}	firstInvokeArg
{{ExampleArgs|firstTemplateArg}}	firstInvokeArg
{{ExampleArgs|firstTemplateArg|secondTemplateArg}}	firstInvokeArg

parentOnly pe avéi sôlo i argoménti da-o template

Còdice	Rizultâto
{{ExampleArgs}}
{{ExampleArgs|firstTemplateArg}}î	firstTemplateArg
{{ExampleArgs|firstTemplateArg|secondTemplateArg}}	firstTemplateArg secondTemplateArg

parentFirst pe avéi i argoménti da-o template che pìggian in scî argoménti da fonçión ch'a-i reciàmma

Còdice	Rizultâto
{{ExampleArgs}}	firstInvokeArg
{{ExampleArgs|firstTemplateArg}}	firstTemplateArg
{{ExampleArgs|firstTemplateArg|secondTemplateArg}}	firstTemplateArg secondTemplateArg

Nòtte

1. Se tùtte dôe e çèrnie frameOnly e parentOnly són true, o mòdolo o no repìggia nisciùn argoménto da-a ciamâ de #invoke.
2. Inte çèrte scitoaçioìn o frame poæ o poriéiva no êse disponìbile, prezénpio se a getArgs l'é pasòu o frame poæ ciufîto che quéllo prezénte. Inte sto câxo chi sôlo i argoménti do frame prezénte són dêuviæ, se parentOnly l'é vêo no l'é dêuviòu nisciùn argoménto e parentFirst e frameOnly no gh'à de efètti.

Wrappers

A çèrnia wrappers a l'é da dêuviâ pe specificâ 'n nùmero limitòu de "template de interfàccia", sàiva a dî di template che gh'àn l'ùnica fonçión de reciamâ 'n mòdolo Se o mòdolo o rilêva ch'o l'é stæto ciamòu da un di template da lìsta da çèrnia wrappers o contròlla sôlo che i argoménti do frame poæ, sedónca o contròlla sôlo che i argoménti into frame pasòu a getArgs. Quésto o permétte a-i mòdoli d'êse ciamæ da 'n #invoke ò da 'n template de interfàccia sénsa pèrdie inta performance asociâ a-o fæto de dovéi controlâ ségge o frame poæ che quéllo prezénte pe ògni intrâ a 'n argoménto.

Prezénpio o còdice do tempalte de en.wiki en:Template:Side box o l'é {{#invoke:Side box|main}} (levòu o contegnûo inte <noinclude>…</noinclude>). No gh'é de raxoìn pe controlâ i argoménti pasæ drîti a l'#invoke dæto che no gh'é de argoménti inta ciamâ into còdice do template. Se poriéiva evitâ de controlâli fàndo ûzo da çèrnia parentOnly, ma inte sto câxo chi l'#invoke o no fonçioniéiva se ciamâ da pàgine despægie da en:Template:Side box. Prezénpio se o mòdolo Side box o foîse reciamòu da 'n'âtra pàgina co-o còdice {{#invoke:Side box|main|text=Some text}} o valô do paràmetro text o saiéiva ignoròu. Dêuviàndo a çèrnia wrappers pe specificâ Template:Side box cómme "template de interfàccia", se peu fâ scîe che 'na ciamâ {{#invoke:Side box|main|text=Some text}} prezénte inte de âtre pàgine a fonçiónn-e ànche se o mòdolo o và avànti a evitâ de controlâ i argoménti se ciamòu da-o template Template:Side box.

E pàgine che contêgnan di template de interfàccia pêuan êse specificæ cómme strìnga ò cómme array de strìnghe.

I wrapper pêuan êse specificæ tànto cómme strìnga che cómme array de strìnghe.

local args = getArgs(frame, {
wrappers = 'Template:Wrapper template'
})

local args = getArgs(frame, {
wrappers = {
'Template:Wrapper 1',
'Template:Wrapper 2',
-- Any number of wrapper templates can be added here.
}
})

Nòtte:

1. O mòdolo o riconósce in outomàtico se ciamòu da-a sotopàgina /sandbox de 'n template de interfàccia. Dónca no l'é necesâio specificâla.
2. A çèrnia wrappers a càngio o default de çèrnie frameOnly, parentOnly e parentFirst. Prezénpio, se parentOnly o l'é mìsso in mòddo esplìcito a fâso, e ciamæ da-o template de interfàccia càregan tànto i argoménti do template prezénte che inte quéllo poæ, scibén che-e ciamæ pe mêzo de template diferénti da quélli specificæ cómme de interfàccia càrega sôlo i argoménti do frame prezénte.
3. Se a decixón quànde a çèrnia "wrappers" a l'é indicâ a no l'é disponìbile, 'n frame poæ o mòdolo o dêuvia i argoménti do frame prezénte pasæ a getArgs.

Scrîve in sciâ tabélla args

De vòtte, poriéiva servî scrîve nêuvi valoî in sciâ tabélla args. Quésto l'é poscìbile dêuviàndo o valô de default de sto mòdolo chi. A ògni mòddoo, pò-u sòlito o l'é 'n mêgio stîle de codìfica che creê 'na tabélla nêuva dónde copiâ i argoménti necesâi da-a tabélla args e i nêuvi valoî.

args.foo = 'some value'

L'é poscìbile cangiâ sto conportaménto chi co-e çèrnie readOnly e noOverwrite. Se readOnly o l'é true alôa no l'é poscìbile scrîve di nêuvi valoî inta tabélla args. Se noOverwrite o l'é true, l'é poscìbile azónze di nêuvi valoî ma no se peu cangiâ 'n valô pasòu da l'#invoke.

Tag Ref

Sto mòdolo chi o l'adêuvia metatable pe repigiâ i argoménti da #invoke sénsa dêuviâ a fonçión pairs() pe intrâ a-o frame prezénte e a-o frame poæ. Quésto o peu êse d'agiùtto se i argoménti pasæ a-o mòdolo pêuan contegnî tag <ref>…</ref>.

Quànde 'n mòdolo Lua o l'acêde a 'n argoménto ch'o contêgne 'n tag <ref>…</ref>, sto chi o l'é sùbito procesòu da-o software Mediawiki e o seu contegnûo o l'é azónto inta lìsta de nòtte a-o fóndo da pàgina. Se pe quàrche motîvo o mòdolo o levàsse da-o rizultâto ch'o restitoìsce l'argoménto ch'o contêgne o tag ref sto chi o crêa 'na nòtta fantaxîma — 'na nòtta ch'a l'apâre inta lìsta de nòtte, ma sénsa de nùmeri dónde conligâse. Sto chi o l'é stæto 'n problêma co-i mòdoli ch'adêuvian a fonçión pairs() pe rilevâ l'ûzo di argoménti da-o frame prezénte ò da-o frame poæ, dæto che quésti procèssan in outomàtico tùtti i argoménti a dispoxiçión.

Sto mòdolo chi o risólve o problêma permeténdo l'intrâ tànto a-i argoménti do frame prezénte che a quélli do frame poæ, repigiàndone bén i argoménti sôlo quand'o l'é necesâio. A ògni mòddo, o problêma o se prezénte tórna se l'é dêuviòu a fonçión pairs(args) inte quàrche pónto do mòdolo.

Lìmiti conosciûi

Dêuviâ e metatable o gh'à di svantàggi. A ciù pàrte de fonçioìn Lua pe-e tabélle a no fonçiónn-a bén in sciâ tabélla args, inclûzo l'òperatô #, a fonçión next() e-e fonçioìn da libràia table. Se l'é inportànte pò-u mòdolo l'ûzo de ste fonçioìn chi, bezéugna procesâ i argoménto co-ina pròpia fonçión in càngio de dêuviâ sto mòdolo chi.