Modulo:Arguments/man: differenze tra le versioni

Versione delle 07:24, 10 ago 2019

Versione attuale delle 02:24, 4 set 2024

(3 versioni intermedie di 3 utenti non mostrate)

Riga 5:

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

<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è cheanziché 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 ===

Gli argomenti della tabella <code>args</code> possono essere passati contemporaneamente dal frame corrente (quello che richiama un template contentenecontentente 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

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 294 ⟶ 293:

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

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:

# Il modulo riconoscerà automaticaautomaticamente 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 escplictamenteesplicitamente 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 ===

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.

Line 341 ⟶ 339:

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