Modulo:Arguments/man

Da Esopedia, l'Enciclopedia dell'[[Ordine Martinista Antico e Tradizionale|O.M.A.T.]] per gli Iniziati.

Questa è la pagina di documentazione per Modulo:Arguments

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 rimozione 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 <ref>...</ref>
  • Molte caratteristiche possono essere personalizzate.

Uso base

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

Nello scenario base si può usare getArgs all'interno della funzione principale. La variabile args è una tabella che dopo la chiamata conterrà gli argomenti provenienti da #invoke (vedi sotto per i dettagli). <source 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 </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è che da un'istruzione #invoke, non deve avere un oggetto frame disponibile, migliorando così la performance.

<source 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 </source>

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

<source 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 </source>

Opzioni

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

<source 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 }) </source>

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 e 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 ciò questo modulo rimuove di default tutti gli argomenti vuoti o composti unicamente da spazi.

Similmente gli spazi possono causare problemi nel gestire argomenti posizionali. Sebbene gli spazi all'inizio o alla fine degli argomenti nominali siano rimossi, questi sono preservati 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 trim e removeBlanks a false.

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

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 valueFunc. L'input di questa opzione deve essere una funzione che riceve due parametri, key e value, e ritorna un singolo valore. Questo valore è quello che viene ritornato quando di accede al campo key nella tabella args.

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. <source 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 }) </source>

Esempio 2: questa funzione rimuove gli argomenti vuoti e li converte tutti in minuscolo, ma non rimuove gli spazi dagli argomenti posizionali. <source 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 }) </source>

Nota: le funzioni sopra falliscono se l'input passato non è del tipo string o nil. Questo può avvenire se usate la funzione getArgs 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 per gli argomenti provenienti da un #invoke (cioè c'è una funzione p.main e una p._main o qualcosa di simile).

Si noti che la funzione valueFunc è chiamata più o meno ogni volta che un argomento viene richiesto dalla tabella args, quindi per motivi di performance occorre assicurarvi che il codice inserito sia efficente.

Frame e frame padre

Gli argomenti della tabella args possono essere passati contemporaneamente dal frame corrente o dal suo frame padre. Supponiamo per esempio di avere un modulo chiamato Module:ExampleArgs. Questo modulo stampa i primi due argomenti posizionali che riceve.


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

I possibili risultati della chiamata di Template:ExampleArgs sono:

Codice Risultato
{{ExampleArgs}} firstInvokeArg
{{ExampleArgs|firstTemplateArg}} firstInvokeArg
{{ExampleArgs|firstTemplateArg|secondTemplateArg}} firstInvokeArg secondTemplateArg

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

frameOnly
Codice Risultato
{{ExampleArgs}} firstInvokeArg
{{ExampleArgs|firstTemplateArg}} firstInvokeArg
{{ExampleArgs|firstTemplateArg|secondTemplateArg}} firstInvokeArg
parentOnly
Codice Risultato
{{ExampleArgs}}
{{ExampleArgs|firstTemplateArg}} firstTemplateArg
{{ExampleArgs|firstTemplateArg|secondTemplateArg}} firstTemplateArg secondTemplateArg
parentFirst
Codice Risultato
{{ExampleArgs}} firstInvokeArg
{{ExampleArgs|firstTemplateArg}} firstTemplateArg
{{ExampleArgs|firstTemplateArg|secondTemplateArg}} firstTemplateArg secondTemplateArg

Nota: se entrambe le opzioni frameOnly e parentOnly sono true, il modulo non recupererà alcun argomento dalla chiamata di #invoke. Probabilmente questo non è il risultato desiderato.

Wrappers

L'opzione wrappers è da utilizzare per specificare un numero limitato di template di interfaccia, cioè template il cui solo scopo è di chiamare un modulo, passando al modulo gli argomenti con cui è stato richiamato il template (che si troveranno presenti nel frame padre). Se il modulo rileva di essere chiamato da uno dei template elencati nell'opzione wrappers controllerà solo gli argomenti del frame padre, in caso contrario controllerà solo gli argomenti nel frame passato a getArgs. 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 è {{#invoke:Side box|main}} (ecludendo il contenuto in <noinclude>...</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 parentOnly, ma in questo caso l'#invoke non funzionerebbe se richiamata da pagine diverse da en:Template:Side box. Per esempio se il modulo Side box venisse richiamato da un'altra pagina con il codice {{#invoke:Side box|main|text=Some text}} il valore del parametro text sarebbe ignorato. Usando l'opzione wrappers per specificare Template:Side box come template di interfaccia, possiamo fare in modo che una chiamata {{#invoke:Side box|main|text=Some text}} presente in altre pagine funzioni anche se modulo continuerà ad evitare di controllare gli argomenti se chiamato dal template Template:Side box.

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

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


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

Note:

  1. Il modulo riconoscerà automatica se richiamato dalla sottopagina /sandbox di un template di interfaccia. Quindi non è necessario specificarle.
  2. L'opzione wrappers ha la precedenza sulle opzioni frameOnly, parentOnly e parentFirst. Se l'opzione wrappers è settata queste opzioni saranno ignorate.
  3. Se l'opzione wrappers è settata e non è disponibile un frame padre il modulo userà gli argomenti del frame corrente passati a getArgs.

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 generalmente creare una nuova tabella con i nuovi valori e copiarvi gli argomenti necessari dalla tabella args è uno stile di codifica migliore.

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

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

Tag Ref

Questo modulo usa metatable per recuperare gli argomenti da #invoke evitando di accedere al frame corrente e al frame padre usando la funzione pairs(). Questo può essere d'aiuto se gli argomenti passati al modulo possono contenere tag <ref>...</ref>.

Nel momento in cui un tag <ref>...</ref> viene acceduto da Lua, è immediatamente processato dal software Mediawiki e il suo contenuto viene aggiunto nella lista di note a fondo voce (nel punto in cui viene inserito il tag <Reference />. Se per qualche motivo il modulo omette il tag reference nell'output ciò creerà una nota fantasma — 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 pairs() 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 pairs(args) 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 #, la funzione next() 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.