Modulo:Arguments/man: differenze tra le versioni

Versione delle 22:50, 22 nov 2020

Versione attuale delle 02:24, 4 set 2024

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

Riga 102:

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

Riga 197:

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

Riga 322:

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

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