Help:Templates/it

Se si vuole includere lo stesso testo in diverse pagine, la possibilità offerta da MediaWiki di usare un template può tornare utile. A differenza delle estensioni e dei file multimediali, non esiste un archivio centrale per i template. I template possono essere creati da zero, oppure, per evitare di replicare lavoro già fatto, possono essere esportati da un altro wiki, (per esempio, Wikipedia) e quindi importati nel wiki in oggetto.

Creazione
I template sono pagine wiki standard il cui contenuto è progettato per essere trascluso (incorporato) all'interno di altre pagine. I template seguono una convenzione secondo la quale il nome è preceduto da " ", assegnandolo a quel namespace; oltre a questo, è possibile crearli come qualsiasi altra pagina wiki.

L'utilizzo più semplice di un template è riportato qui sotto. Se crei una pagina Template:Benvenuto con il seguente contenuto:

Ciao! Benvenuto nella wiki

avrai creato il tuo primo template! Se poi inserisci il codice:

in qualsiasi altra pagina, quando quest'ultima viene visualizzata il testo "Ciao! Benvenuto nella wiki." apparirà al posto di. Il contenuto del template è "transcluso", cioè integrato, nella pagina.

Puoi quindi inserire  in qualsiasi punto di qualsiasi pagina ogniqualvolta vuoi dare il benvenuto a qualcuno. Supponi che esso sia usato in 100 pagine. Se successivamente cambi il contenuto del template in:

Ciao! Benvenuto in questa fantastica wiki.

e rivisiti una qualsiasi delle 100 pagine dove è stato usato il template vedrai il nuovo testo al posto dell'originale. In questo modo hai cambiato il contenuto di 100 pagine senza modificarle, perché il template viene transcluso in esse.

Questo è il meccanismo di base. Ci sono molte caratteristiche aggiuntive della transclusione che arricchiscono questo meccanismo e rendono i template molto utili.

Uso
I template possono essere usati in altre pagine in questi modi:


 * ; come detto sopra, questo collegamento verrà sostituito dinamicamente dal contenuto della pagina "Template:Nome" quando la pagina verrà caricata. Il collegamento resterà invariato nel codice sorgente della pagina in cui è inserito.
 * ; quando viene utilizzato questo collegamento al template, esso verrà rimpiazzato definitivamente dal contenuto della pagina "Template:Nome", così come si presenta quando la pagina in cui è inserito viene salvata: una copia del contenuto di "Template:Nome" andrà a sostituire il collegamento al template. I contenuti diverranno quindi una parte integrante della pagina in cui vengono inclusi, e possono essere modificati normalmente, in maniera separata rispetto all'originale. Nota: eventuali nuove modifiche al codice sorgente del template non si propagheranno nella pagina che conteneva il collegamento al template, in quanto la sostituzione è ormai avvenuta.
 * ; questo collegamento è stato introdotto per permettere che la transclusione di un template che contiene una sostituzione effettui quella sostituzione. Vedere w:it:Aiuto:Subst.
 * include il contenuto della pagina "Template:Nome" come testo in modalità wiki grezza ( in questo modo  ) quando la pagina che lo contiene viene caricata.

In realtà, una qualsiasi pagina wiki può essere usata come template, semplicemente specificando il namespace in cui è inclusa, quindi:


 * include
 * include
 * include
 * viene sostituito dal contenuto di

Se il namespace specificato non esiste, viene considerato tutto come titolo di un template:


 * include

Parametri
Per arricchire il meccanismo della transclusione, MediaWiki permette che vengano passati dei parametri a un template quando esso viene transcluso. I parametri permettono al template di produrre contenuti diversi o di avere comportamenti diversi.

Supponiamo che si voglia inserire una breve nota di ringraziamento nella pagina di discussione di altri utenti, del tipo:

La nota di ringraziamento avrà una motivazione (in questo caso, "tutto il tuo impegno") e una firma ("me"). L'obiettivo è che qualunque utente sia in grado di ringraziare qualunque altro utente per qualsiasi possibile motivazione.

Per far sì che la nota appaia in modo simile ovunque essa sia usata, è possibile definire un template chiamato, ad esempio. Sebbene la nota debba apparire simile ogni volta che un utente ne ringrazia un altro, il suo contenuto specifico (cioè la motivazione e la firma) saranno diversi. Per questa ragione, essi dovrebbero essere passati come parametri. Se si ignora ogni altro elemento necessario a strutturare il riquadro e posizionare l'immagine, il nucleo del template sarà questo:

Notare l'uso di  e. Questo è il sistema per identificare, all'interno dei template, i parametri che verranno passati quando il template viene usato. Notare che, all'interno del template, ciascun parametro è racchiuso da tre parentesi graffe:. Questo differisce dal normale utilizzo del nome del template.

Quando si usa questo tipo di template in una pagina, è necessario inserire i parametri separandoli con una "pipe". MediaWiki permette di passare i parametri ad un template in tre modi: anonimamente, per ordine progressivo e per nome.

Parametri anonimi
Per passare al template parametri anonimi, elencare i valori di tali parametri in maniera sequenziale rispettando la sequenza numerica dei parametri:

In questo caso, il template  riceve i parametri   e , producendo come risultato:

L'ordine in cui i parametri anonimi vengono passati è cruciale per il comportamento del template. Invertire l'ordine dei parametri, come in questo caso:

produrrebbe questo risultato:

Parametri numerati
Per passare un parametro tramite un numero, è sufficiente identificarlo con quel numero quando viene passato:

Questa volta, il template  riceve i parametri   e , nonostante questi siano stati inseriti in ordine inverso, e produce:


 * Esempi:

produce:

Parametri nominali
Il terzo modo di passare i parametri è tramite un nome, al posto di un numero. In questo caso, il contenuto del template dovrà essere così modificato:

Un piccolo ringraziamento... per. Abbracci,

All'interno del template, vengono usati  e   per identificare ciascun parametro, invece di un numero. Per passare questi parametri tramite nome, essi vanno identificati all'inserimento:

In questo caso, il template  riceve i parametri   e , producendo come risultato:

I parametri sono case sensitive, quindi:

produce:

Il vantaggio di usare parametri nominali, oltre al fatto di non doversi preoccupare dell'ordine in cui vengono passati, è che rendono il codice del template più comprensibile, soprattutto nel caso ci fossero molti parametri.

Valori predefiniti
Se si transclude un template che richiede dei parametri, ma essi non vengono forniti, in questo modo:

nell'esempio con parametri numerati di cui sopra si otterrebbe quanto segue:

Dal momento che non è stato passato alcun parametro il template presenta i parametri stessi, invece dei rispettivi valori. In questo caso, potrebbe essere utile definire dei valori predefiniti per i parametri, ovvero dei valori da usare in caso non sia passato nessun valore. Ad esempio, se il contenuto del template viene modificato in:

allora  definisce che se non viene fornito un parametro , allora verrà usato il valore. Allo stesso modo,, imposta il valore predefinito del parametro   come. Ora, transcludendo di nuovo il template senza passare parametri, il risultato sarà il seguente:

Spesso i valori predefiniti sono usati per specificare nomi alternativi ai parametri. Per esempio, se è definito " ", il template allora cercherà prima un parametro di nome "a". Se non definito, userà il parametro di nome "b". Se nessuno dei due parametri "a" e "b" è definito, il template non produrrà nessun output.

Valutazione
Generally speaking, template parameters are substituted into the template after tokenization, but as is. They are not evaluated until they are used.

This has a few consequences. First of all, if you have a  containing , and a   containing  , and put   on a page, mytemplate isn't transcluded, because tokens like "|" cannot be added by a template and keep their special meaning in templates. You can still use templates to control the name of a parameter or template, but you cannot split a template call amongst multiple templates.

The second consequence of this is dead-code elimination. If you make a template call like, and Template:Foo does not contain  , then the displaytitle is not used, since it is only evaluated when needed, and it there is no parameter to substitute it into, so it is never evaluated. This usually comes into play when using Extension:ParserFunctions, and can be especially noticed when used in combination with the  magic word that varies by user language.

Template calls starting with the magic word  or   are evaluated in a separate first pass that only happens at save time, along with ~ and links using the pipe trick. If they cannot be evaluated during the first pass, subst: calls are ignored, and safesubst: are treated as if a normal template.

Many but not all parser functions, parser tags and trancluded special pages are not directly included like templates but instead are replaced by a "strip marker". This means you cannot manipulate the results with parser functions like padleft: or similar functions from extensions, as they see the strip marker instead of the result of the parser function.

Ricorsione nei template
Includere un template in se stesso non condurrà MediaWiki ad una ricorsione infinita. MediaWiki bloccherà la ricorsione e mostrerà il nome del template in grassetto. Per esempio, se il contenuto di "Template:Aaaa" è " ", lo mostrerà come "a a Template loop detected: Template:Aaaa z z".

Forbidden idiom
This safeguard precludes a potentially useful template idiom where a template self-normalizes its own calling arguments. In this forbidden example  can either be called   or. If called in the first manner, it recurses into itself with the second argument structure (obtained using string parser functions), which then follows a unified processing path.



If  is modified to recurse into   and   is an identical manual copy of   this idiom works fine as the self-recursion safeguard operates dynamically and not statically.

A feasible way for the MediaWiki software to loosen the self-recursion rule would be to require that each recursive call have a distinct argument count from all previous active calls, at most once recursing with the argument count non-decreasing. That would provide a strong guarantee against infinite self-recursion while enabling useful idioms such as the one described here in a flexible manner.

If the processing path is of low complexity, a simple solution using only one template is to handle each calling convention on a separate if/else branch, duplicating the logic of the processing path within each case. If the processing path is more complex, each call-structure case can delegate to an implementation template with a unified call structure which provides the final template behaviour.

Tables in parameters
Since the syntax for wikitables involves pipes in single braces ({ }) and using the pipe trick will not work in transclusion parameters, one will have to create a table as a separate page and transclude it from there.

Controllare che parte del template includere
Per impostazione predefinita, il contenuto di un template verrà mostrato integralmente, sia quando viene visionato direttamente, sia quando esso è incluso in un'altra pagina. Tuttavia, è possibile controllare quale parte del template verrà vista e quale parte verrà inclusa usando i tag  e.

Ogni cosa tra e  verrà mostrata solo quando il template è visualizzato direttamente, ma non quando esso è incluso in altre pagine. Ciò è utile quando si vuole includere del testo o del codice in un template, ma non si vuole estendere tale contenuto alle pagine che lo includono, come in questi casi:


 * i collegamenti a categorie quando si categorizza il template stesso
 * gli interlink verso template simili in altre lingue
 * il testo di aiuto sull'uso del template

Al contrario, il testo tra e  verrà elaborato e visualizzato solo quando il template viene incluso in altre pagine, ma non quando viene visto direttamente. Possibili usi sono:


 * le pagine che categoricizzano che includono il template. Nota: quando vengono modificate le categorie applicate da un template in questo modo, la categorizzazione delle pagine che lo includono potrebbe non essere aggiornata fino a che trascorra del tempo: questo processo viene gestito da . Per forzare l'aggiornamento della categorizzazione di una pagina specifica, aprire la pagina per la modifica e salvarla senza modifiche.
 * Assicurarsi che il codice del template non sia eseguito quando si visualizza la pagina stessa. Tipicamente questo accade perché sono necessari dei parametri, e l'esecuzione senza di essi porta a risultati indesiderati.

Tutto ciò che si trova al di fuori dei tag e  viene processato e mostrato normalmente; ovvero, sia quando la pagina del template viene visualizzata direttamente, sia quando il template è incluso in un'altra pagina. L'attenzione è su ciò che sta tra questi due tag.

Tutto ciò che è esterno ai tag viene escluso dalla trasclusione. Perfino le sezioni presenti all'interno dei tag includeonly sono scartate dalla transclusione, a meno che esse non siano taggate anche come onlyinclude. L'attenzione è su ciò che sta all'esterno di questo tag.

Questi tag si possono anche annidare.

I tre tag parziali di trasclusione permettono tutte le possibili combinazioni di ciò che è processato e visualizzato. Anche i commenti hanno il loro ruolo.

Organizzare i template
Per far sì che i template siano efficaci, è necessario che gli utenti possano rintracciarli e comprendere come usarli.

Per trovareli, gli utenti possono:
 * 1) cliccare ' (sul fianco sinistro) > '. Oppure  .../wiki/Special:SpecialPages  e quindi  .../Special:AllPages
 * 2) nel menu a tendina ', selezionare Template  e cliccare '.

Per fornire informazioni sull'utilizzo, includere un esempio nella pagina del template come segue:

Uso
Benvenuto agli utenti:

A questo punto, un contributore potrà semplicemente fare copia e incolla dell'esempio per iniziare ad usare il template.

Collegarsi a un template
Un collegamento ipertestuale ad una pagina di template si crea nello stesso modo in cui si crea un collegamento ad una qualsiasi altra pagina del wiki. Per esempio, il wikilink Template:Navbar è generato usando il wikitesto.

Su molti wiki, il Template:Tl può essere utilizzato per fornire un link a un template formattato in modo che sia circondato dalle "doppie parentesi graffe" necessarie per transcludere il template senza però effettuare veramente la transclusione. Per esempio, il codice  può essere usato per creare il collegamento Navbar.

Questo viene utilizzato speso nella documentazione, sulle pagine di aiuto e sulle pagine di discussione quando ci si vuole riferire ad un particolare template. Lo stesso effetto può essere raggiunto usando, ma il primo approccio richiede di scrivere molti meno caratteri. Su ogni wiki il template Tl, se esiste, può presentare o meno il testo in un elemento "code" o come testo monospaziato. Altrimenti (come in questo wiki), ciò potrebbe essere fatto da un altro template con un nome simile. Vedere, per esempio, la sezione "Vedere anche" della documentazione del Template:Tl.

Importare da un wiki ad un altro
I template spesso richiedono le impostazioni di stile CSS o altri template, quindi spesso gli utenti fanno fatica a copiare i template da un wiki a un altro. Il procedimento seguente dovrebbe funzionare per la maggior parte dei template.

Codice MediaWiki
Se si posseggono i diritti di importazione (in particolare di importazione e upload) sul nuovo wiki:


 * 1) Andare su Special:Export sul wiki di origine e scaricare un file .xml con la cronologia completa di tutti i template necessari, come segue:
 * 2) * Inserire il nome del template nel box di testo grande, ad. es. "Template:Benvenuto". Porta speciale attenzione alle lettere maiuscole e ai caratteri speciali - se il nome del template non è proprio esatto, l'esportazione può aver luogo ma il file .xml può non contenere i dati che ci aspettiamo.
 * 3) * Selezionare la casella "".
 * 4) * Selezionare la casella "".
 * 5) * cliccare "".
 * 6) Vai a Special:Import sulla nuova wiki e carica il file .xml.

Se non hai diritti di importazione nella nuova wiki:


 * 1) Va al template che vuoi copiare dall'originale wiki. Aprila in modifica e copia il testo wiki.
 * 2) Sulla nuova wiki, vai su una pagina con lo stesso nome del template che hai copiato. Apri la pagina in modifica/crea e incolla il wikitesto che avevi copiato. Nel sommario di edit di ogni template, collegati alla pagina originale per i diritti di attribuzione originale.
 * 3) Tornando alla wiki originale nella finestra di modifica, cerca la lista dei Templates che puntano a questa pagina. Per ogni template nella lista riesegui queste istruzioni allo stesso modo. Fallo anche per ogni template che a sua volta usa questi template e così via.

Questo copia l'intero codice necessario ed è sufficiente per la maggior parte dei template. Note that only page elements parsed in rendering the page get exported, so, for example, documentation subpages are not exported as part of this process. Se non funziona cerca anche l'elenco di i link rossi sotto "Pagine transcluse sulla versione corrente di questa pagina:" sotto il box di modifica. Se ce ne sono ancora altri ripeti i passi sopra anche per quelli e copia anche il codice nei moduli.

Dopo aver importato con successo il template e averlo collegato alle altre wiki, editarlo per cambiare la caratterizzazione per adattarlo alla tua wiki. Per esempio cambiare un logo, rimuovere categorie rindondanti o collegamenti rossi (rotti).

Estensioni
Una estensione spesso usata nei template sono le Funzioni di Analisi del flusso di dati (parser). Visita la pagina e testa se una qualsiasi delle funzioni elencate vengano usate nel template copiato. Se è così, bisogna installare. Per installarle c'è bisogno di avere l'accesso come amministratore al server della tua installazione MediaWiki.

Un'altra dipendenza che può essere usata nei template, specialmente quelli in Wikipedia, è Lua. Avere   nel template è una firma della sua presenza. Nel caso venga usato, c'è bisogno di installare l'estensione ed è richiesto di avere l'accesso come amministratore. Guarda quella pagina per maggiori istruzioni sull'installare e l'uso dell'estensione sopradetta.

Codice CSS e JavaScript
Oltre al codice MediaWiki, molti template fanno uso del CSS e talvolta si affidano al JavaScript per essere completamente operativi. Se i template copiate non si comportano come ci si aspetta, questo può essere la causa. Per ricopiare il CSS richiesto e il JavaScript nella tua wiki normalmente dovresti avere i privilegi d'accesso come amministratore, perchè devi aver accesso in modifica ai messaggi di systema nel namespace "MediaWiki:".


 * 1) cerca se vengano usate classi CSS (testo come  )  tra il testo del template. Se quelle classi appaiono in "MediaWiki:Common.css" or "MediaWiki:Monobook.css" sulla wiki originale, copia quelle classi in "MediaWiki:Common.css" sulla nuova wiki e controlla che il template ora lavori ottimamente.
 * 2) Se il template copiato non lavora ancora come ci si aspetta, controlla non ci sia del codice in  "MediaWiki:Common.js" o  "MediaWiki:Monobook.js" sulla wiki originale. Se è così, puoi tentare di copiarlo in "MediaWiki:Common.js" nella nuova wiki. Normalmente è una buona idea copiare soltanto codice da sorgenti sicure, e prima navigare il codice per identificare le parti che sono rilevanti. Dovresti trovare commenti che servono da punti chiave per identificare la funzionalità di ogni singola parte.

Vedi anche

 * w:Help:Table - the easiest instructions to use.
 * – un template di uso speciale che può servire da esempio
 * – qualcosa di bizzarro che puoi trovare in alcuni template
 * – controlli di funzione elaborati come #if e #switch
 * – guida sull'uso delle funzioni di analisi del flusso (parser) nei template
 * m:Help:Template/it — contiene un manuale approfondito di come funzionino i template
 * m:Help:Advanced templates/it — descrive anche più avanzate tecniche come le chiamate dinamiche ai template e le variabili mutevoli
 * m:Help:Embed page/it — pagine legate ai namespaces che non siano.
 * – Using templates as the starting text of a page
 * – Using templates as the starting text of a page
 * – Using templates as the starting text of a page
 * – Using templates as the starting text of a page
 * – Using templates as the starting text of a page

Collegamenti esterni

 * Miraheze template repository - MediaWiki templates intended for general use.