Visualizza wikitesto di Modulo:Arguments/man

{{Man modulo}}
Modulo Lua per la gestione degli argomenti passati da #invoke. È un metamodulo scritto per essere usato da altri moduli e non dovrebbe essere chiamato direttamente da #invoke. Le sue funzioni includono:
* Rimuovere gli spazi bianchi dall'estremità degli argomenti e rimuovere degli argomenti vuoti.
* Passare gli argomenti sia dal frame corrente che da quello padre allo stesso tempo (vedi sotto per i dettagli).
* Passare gli argomenti direttamente da un altro modulo Lua o dalla console di debug.
* Recuperare gli argomenti solo quando necessario, il che può evitare a risolvere alcuni problemi con il tag {{tag|ref}}
* Personalizzare molte caratteristiche.

=== Uso base ===
Prima di tutto si deve caricare il modulo. Contiene un'unica funzione chiamata <code>getArgs</code>.
<syntaxhighlight lang="lua">
local getArgs = require('Module:Arguments').getArgs
</syntaxhighlight>

Nello scenario base si può usare getArgs all'interno della funzione principale. La variabile <code>args</code> è una tabella che dopo la chiamata conterrà gli argomenti provenienti da #invoke (vedi sotto per i dettagli).
<syntaxhighlight lang="lua">
local getArgs = require('Module:Arguments').getArgs
local p = {}

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

return p
</syntaxhighlight>

Comunque la pratica raccomandata è di usare una funzione specificatamente per processare gli argomenti di #invoke, in modo che se il modulo è richiamato da un altro modulo Lua, anziché da un'istruzione #invoke, non deve avere un oggetto frame disponibile, migliorando così la performance.

<syntaxhighlight lang="lua">
local getArgs = require('Module: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
</syntaxhighlight>

Se si desidera che più funzioni usino gli stessi argomenti e si vuole renderle accessibili da #invoke si può usare una funzione di interfaccia.

<syntaxhighlight lang="lua">
local getArgs = require('Module: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
</syntaxhighlight>

=== Opzioni ===

Sono disponibili le seguenti opzioni, spiegate nelle sezioni che seguono.

<syntaxhighlight lang="lua">
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
})
</syntaxhighlight>

=== Rimuovere gli spazi bianchi ===

Gli argomenti vuoti sono spesso un problema per novizi nella conversione di template MediaWiki in Lua. Nella sintassi dei template le stringhe vuote e quelle composte solo da spazi sono considerate false. Comunque in Lua le stringhe vuote o consistenti solo di spazi bianchi sono considerate vere. Questo significa che se non si presta attenzione a questo punto nello scrivere moduli Lua può darsi che si tratti come vero quello che invece si sarebbe desiderato trattare come falso. Per evitare questo problema il modulo rimuove di default tutti gli argomenti vuoti o composti unicamente da spazi.

Similmente gli spazi possono causare problemi nel gestire argomenti posizionali. Nei template Mediawiki anche se gli spazi all'inizio o alla fine degli argomenti nominali sono rimossi, vengono invece conservati per gli argomenti posizionali. Poiché nella maggior parte dei casi questo non è il comportamento desiderato il modulo li rimuove per default.

Comunque a volte si devono gestire gli argomenti vuoti in ingresso o mantenere gli spazi bianchi negli argomenti posizionali per convertire i template esattamente come sono stati scritti. In questo caso si possono impostare le opzioni <code>trim</code> e <code>removeBlanks</code> a <code>false</code>.

<syntaxhighlight lang="lua">
local args = getArgs(frame, {
	trim = false,
	removeBlanks = false
})
</syntaxhighlight>

=== Formattazione personalizzata degli argomenti ===

A volte si desidera rimuovere alcuni argomenti vuoti, ma non altri o forse si desidera rendere minuscoli tutti gli argomenti posizionali. Per farlo si può usare l'opzione <code>valueFunc</code>. L'input di questa opzione deve essere una funzione che riceve due parametri, <code>key</code> e <code>value</code>, e ritorna un singolo valore, che viene restituito quando di accede al campo <code>key</code> nella tabella <code>args</code>.

Primo esempio: questa funzione conserva gli spazi vuoti per il primo argomento posizionale, ma lo rimuove dall'inizio e dalla fine di tutti gli argomenti e rimuove quelli vuoti.
<syntaxhighlight lang="lua">
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
})
</syntaxhighlight>

Esempio 2: questa funzione rimuove gli argomenti vuoti e converte quelli non vuoti in minuscolo, ma non rimuove gli spazi dagli argomenti posizionali.
<syntaxhighlight lang="lua">
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
})
</syntaxhighlight>

Nota: le funzioni sopra falliscono se l'input passato non è del tipo <code>string</code> o <code>nil</code>. Questo può avvenire se usate la funzione <code>getArgs</code> nella funzione principale del vostro modulo e quella funzione è richiamata da un altro modulo Lua. In questo caso occorrerà controllare il tipo dell'input. Questo problema non si pone se si usa una funzione specializzata per gli argomenti provenienti da un #invoke (cioè c'è una funzione <code>p.main</code> e una <code>p._main</code> o qualcosa di simile).

{{Cassetto
|titolo=Esempio 1 e esempio 2 con controllo del tipo
|colore=#99FF99
|testo=
Esempio 1:
<syntaxhighlight lang="lua">
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
})
</syntaxhighlight>

Esempio 2:
<syntaxhighlight lang="lua">
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
})
</syntaxhighlight>
}}

Poiché la funzione <code>valueFunc</code> è chiamata più o meno ogni volta che un argomento viene richiesto dalla tabella <code>args</code> si deve assicurarsi che il suo codice sia efficiente.

=== Frame e frame padre ===

Gli argomenti della tabella <code>args</code> possono essere passati contemporaneamente dal frame corrente (quello che richiama un template contentente l'#invoke) o dal suo frame padre (quello che contiene l'#invoke). Supponiamo per esempio di avere un modulo chiamato <code>Module:ExampleArgs</code>. Questo modulo stampa i primi due argomenti posizionali che riceve.

{{Cassetto
|titolo=Codice di Module:ExampleArgs
|colore=#99FF99
|testo=
<syntaxhighlight lang="lua">
local getArgs = require('Module: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
</syntaxhighlight>
}}

<code>Module:ExampleArgs</code> viene chiamato da <code>Template:ExampleArgs</code>, che contiene il codice <code><nowiki>{{#invoke:ExampleArgs|main|firstInvokeArg}}</nowiki></code>. questo produce il risultato "firstInvokeArg".

I possibili risultati della chiamata di <code>Template:ExampleArgs</code> sono:

{| class="wikitable" style="width: 50em; max-width: 100%;"
|-
! style="width: 60%;" | Codice
! style="width: 40%;" | Risultato
|-
| <code><nowiki>{{ExampleArgs}}</nowiki></code>
| firstInvokeArg
|-
| <code><nowiki>{{ExampleArgs|firstTemplateArg}}</nowiki></code>
| firstInvokeArg
|-
| <code><nowiki>{{ExampleArgs|firstTemplateArg|secondTemplateArg}}</nowiki></code>
| firstInvokeArg secondTemplateArg
|}

Ci sono tre opzioni che si possono usare per cambiare questo comportamento: <code>frameOnly</code>, <code>parentOnly</code> e <code>parentFirst</code>. Se <code>frameOnly</code> è <code>true</code> allora saranno accettati solo gli argomenti passati dal frame corrente (funzioni richiamanti), se <code>parentOnly</code> è <code>true</code> saranno accettati solo gli argomenti passati dal frame padre (il template) e se <code>parentFirst</code> è <code>true</code> saranno accettati sia gli argomenti del frame corrente, che quelli del frame padre, ma quelli del frame padre (quelli del template) avranno la priorità su quelli del frame corrente. Di seguito i risultati dell'esempio con le varie opzioni:

; frameOnly <small>per escludere gli argomenti dal template</small>
{| class="wikitable" style="width: 50em; max-width: 100%;"
|-
! style="width: 60%;" | Codice
! style="width: 40%;" | Risultato
|-
| <code><nowiki>{{ExampleArgs}}</nowiki></code>
| firstInvokeArg
|-
| <code><nowiki>{{ExampleArgs|firstTemplateArg}}</nowiki></code>
| firstInvokeArg
|-
| <code><nowiki>{{ExampleArgs|firstTemplateArg|secondTemplateArg}}</nowiki></code>
| firstInvokeArg
|}

; parentOnly <small>per avere solo gli argomenti dal template</small>
{| class="wikitable" style="width: 50em; max-width: 100%;"
|-
! style="width: 60%;" | Codice
! style="width: 40%;" | Risultato
|-
| <code><nowiki>{{ExampleArgs}}</nowiki></code>
|
|-
| <code><nowiki>{{ExampleArgs|firstTemplateArg}}</nowiki></code>
| firstTemplateArg
|-
| <code><nowiki>{{ExampleArgs|firstTemplateArg|secondTemplateArg}}</nowiki></code>
| firstTemplateArg secondTemplateArg
|}

; parentFirst <small>per avere gli argomenti dal template che sovrascrivono gli argomenti della funzione richiamante</small>
{| class="wikitable" style="width: 50em; max-width: 100%;"
|-
! style="width: 60%;" | Codice
! style="width: 40%;" | Risultato
|-
| <code><nowiki>{{ExampleArgs}}</nowiki></code>
| firstInvokeArg
|-
| <code><nowiki>{{ExampleArgs|firstTemplateArg}}</nowiki></code>
| firstTemplateArg
|-
| <code><nowiki>{{ExampleArgs|firstTemplateArg|secondTemplateArg}}</nowiki></code>
| firstTemplateArg secondTemplateArg
|}

Note
# Se entrambe le opzioni <code>frameOnly</code> e <code>parentOnly</code> sono <code>true</code>, il modulo non recupererà alcun argomento dalla chiamata di #invoke. Probabilmente questo non è il risultato desiderato.
# In alcune situazioni il frame padre potrebbe non essere disponibile, per esempio se a getArgs viene passato il frame padre piuttosto che quello corrente. In questo caso solo gli argomenti del frame corrente saranno usati, se <code>parentOnly</code> è vero non sarà usato nessun argomento e le opzioni <code>parentFirst</code> e <code>frameOnly</code> non avranno effetto.

=== Wrappers ===

L'opzione <code>wrappers</code> è da utilizzare per specificare un numero limitato di ''template di interfaccia'', cioè template il cui solo scopo è di chiamare un modulo. Se il modulo rileva di essere chiamato da uno dei template elencati nell'opzione <code>wrappers</code> controllerà solo gli argomenti del frame padre, in caso contrario controllerà solo gli argomenti nel frame passato a <code>getArgs</code>. questo permette ai moduli di essere chiamati da un'#invoke oppure da un template di interfaccia senza la perdita di performance associata al dover controllare sia il frame padre che quello corrente per ogni accesso a un argomento.

Ad esempio il codice del template di en.wiki [[:en:Template:Side box]] è <code><nowiki>{{#invoke:Side box|main}}</nowiki></code> (escludendo il contenuto in {{tag|noinclude}}). Non c'è motivo per controllare gli argomenti passati direttamente all'#invoke dato che non c'è nessun argomento nella chiamata nel codice del template. Potremmo evitare di controllarli usando l'opzione <code>parentOnly</code>, ma in questo caso l'#invoke non funzionerebbe se richiamata da pagine diverse da [[:en:Template:Side box]]. Per esempio se il modulo <code>Side box</code> venisse richiamato da un'altra pagina con il codice <code><nowiki>{{#invoke:Side box|main|text=Some text}}</nowiki></code> il valore del parametro <code>text</code> sarebbe ignorato. Usando l'opzione <code>wrappers</code> per specificare <code>Template:Side box</code> come ''template di interfaccia'', possiamo fare in modo che una chiamata <code><nowiki>{{#invoke:Side box|main|text=Some text}}</nowiki></code> presente in altre pagine funzioni anche se modulo continuerà ad evitare di controllare gli argomenti se chiamato dal template <code>Template:Side box</code>.

Le pagine contenenti template di interfaccia possono essere specificate come stringa o come array di stringhe.

Wrappers can be specified either as a string, or as an array of strings.

<syntaxhighlight lang="lua">
local args = getArgs(frame, {
wrappers = 'Template:Wrapper template'
})
</syntaxhighlight>

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

Note:
# Il modulo riconoscerà automaticamente se richiamato dalla sottopagina /sandbox di un template di interfaccia. Quindi non è necessario specificarle.
# L'opzione <code>wrappers</code> cambia il default delle opzioni <code>frameOnly</code>, <code>parentOnly</code> e <code>parentFirst</code>. Se per esempio <code>parentOnly</code> viene settato esplicitamente a falso le chiamate dal template di interfaccia caricheranno sia gli argomenti del template corrente che in quello padre, sebbene chiamate attraverso template diversi da quelli specificati come di interfaccia caricheranno solo gli argomenti del frame corrente.
# Se l'opzione quando l'opzione ''wrappers'' è settata non è disponibile un frame padre il modulo userà gli argomenti del frame corrente passati a <code>getArgs</code>.

=== Scrivere sulla tabella args ===

A volte può essere utile scrivere nuovi valori sulla tabella args. Questo è possibile usando il valore di default di questo modulo. Comunque di solito è uno stile di codifica migliore creare una nuova tabella in cui copiare gli argomenti necessari dalla tabella args e i nuovi valori.

<syntaxhighlight lang="lua">
args.foo = 'some value'
</syntaxhighlight>

È possibile alterare questo comportamento con le opzioni <code>readOnly</code> e <code>noOverwrite</code>. Se <code>readOnly</code> è <code>true</code> allora non è possibile scrivere nuovi valori nella tabella args. Se <code>noOverwrite</code> è <code>true</code> è possibile aggiungere nuovi valori ma non è possibile cambiare un valore passato dall'#invoke.

=== Tag Ref ===
Questo modulo usa [[mw:Extension:Scribunto/Lua reference manual#Metatables|metatable]] per recuperare gli argomenti da #invoke senza usare la funzione <code>pairs()</code> per accedere al frame corrente e al frame padre. Questo può essere d'aiuto se gli argomenti passati al modulo possono contenere tag {{tag|ref}}.

Nel momento in cui un modulo Lua accede a un argomento contenente un tag {{tag|ref}} questo è immediatamente processato dal software Mediawiki e il suo contenuto viene aggiunto nella lista di note a fondo voce. Se per qualche motivo il modulo omette dal risultato che ritorna l'argomento contenente il tag ref questo creerà una nota fantasma &mdash; una nota che appare nella lista delle note, ma senza alcun numero a cui collegarsi. Questo è stato un problema con i moduli che usano la funzione <code>pairs()</code> per rilevare l'uso degli argomenti dal frame corrente o dal frame padre, dato che questi processano automaticamente tutti gli argomenti disponibili.

Questo modulo risolve il problema permettendo l'accesso sia agli argomenti del frame che del frame padre, pur recuperando gli argomenti solo se necessario. Il problema comunque si ripresenterà se usate la funzione <code>pairs(args)</code> da qualche altra parte del vostro modulo.

=== Limitazioni note ===

L'uso delle metatable ha i suoi svantaggi. La maggior parte delle funzioni Lua per le tabelle non funzionerà propriamente sulla tabella args, incluso l'operatore <code>#</code>, la funzione <code>next()</code> e le funzioni della libreria table. Se usare queste è importante per il vostro modulo dovrete processare gli argomenti con una vostra funzione invece di usare questo modulo.

<includeonly>[[Categoria:Moduli]]{{Protetta}}</includeonly>
<noinclude>[[Categoria:Manuali dei moduli]]</noinclude>