Modulo:Arguments/man: differenze tra le versioni

Versione delle 10:49, 26 set 2020

Versione delle 22:50, 22 nov 2020

Riga 9:

=== Uso base ===

Prima di tutto si deve caricare il modulo. Contiene un'unica funzione chiamata <code>getArgs</code>.

<sourcesyntaxhighlight lang="lua">

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

</syntaxhighlight>

</source>

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).

<sourcesyntaxhighlight lang="lua">

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

local p = {}

Riga 24:

return p

</syntaxhighlight>

</source>

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èanziché da un'istruzione #invoke, non deve avere un oggetto frame disponibile, migliorando così la performance.

<sourcesyntaxhighlight lang="lua">

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

local p = {}

Riga 42:

return p

</syntaxhighlight>

</source>

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

<sourcesyntaxhighlight lang="lua">

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

Riga 71:

return p

</syntaxhighlight>

</source>

=== Opzioni ===

Riga 77:

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

<sourcesyntaxhighlight lang="lua">

local args = getArgs(frame, {

trim = false,

Riga 94:

noOverwrite = true

})

</syntaxhighlight>

</source>

=== Rimuovere gli spazi bianchi ===

Riga 100:

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è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>.

<sourcesyntaxhighlight lang="lua">

local args = getArgs(frame, {

trim = false,

removeBlanks = false

})

</syntaxhighlight>

</source>

=== Formattazione personalizzata degli argomenti ===

Riga 116:

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.

<sourcesyntaxhighlight lang="lua">

local args = getArgs(frame, {

valueFunc = function (key, value)

Riga 130:

end

})

</syntaxhighlight>

</source>

Esempio 2: questa funzione rimuove gli argomenti vuoti e converte quelli non vuoti in minuscolo, ma non rimuove gli spazi dagli argomenti posizionali.

<sourcesyntaxhighlight lang="lua">

local args = getArgs(frame, {

valueFunc = function (key, value)

Riga 146:

end

})

</syntaxhighlight>

</source>

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).

Riga 155:

|testo=

Esempio 1:

<sourcesyntaxhighlight lang="lua">

local args = getArgs(frame, {

valueFunc = function (key, value)

Riga 172:

end

})

</syntaxhighlight>

</source>

Esempio 2:

<sourcesyntaxhighlight lang="lua">

local args = getArgs(frame, {

valueFunc = function (key, value)

Riga 190:

end

})

</syntaxhighlight>

</source>

}}

Poichè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 efficenteefficiente.

=== Frame e frame padre ===

Riga 203:

|colore=#99FF99

|testo=

<sourcesyntaxhighlight lang="lua">

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

local p = {}

Riga 219:

return p

</syntaxhighlight>

</source>

}}

<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".

Line 306 ⟶ 305:

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

<sourcesyntaxhighlight lang="lua">

local args = getArgs(frame, {

wrappers = 'Template:Wrapper template'

})

</syntaxhighlight>

</source>

<sourcesyntaxhighlight lang="lua">

local args = getArgs(frame, {

wrappers = {

Line 321 ⟶ 319:

}

})

</syntaxhighlight>

</source>

Note:

Line 332 ⟶ 330:

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.

<sourcesyntaxhighlight lang="lua">

args.foo = 'some value'

</syntaxhighlight>

</source>

È 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.