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 normali pagine wiki il cui contenuto è progettato per essere "transcluso" (incorporato) in altre pagine. Per convenzione, il titolo dei template è preceduto dal prefisso, il che li assegna a detto namespace; a parte questo, possono essere creati come ogni altra pagina wiki.

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

Ciao! Benvenuto nel 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 nel 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 a tutti! Benvenuti in questo fantastico wiki.

e rivisiti 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 è stato trascluso 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 una sostituzione che non interrompe la transclusione. Leggi anche w:en:Help:Substitution.
 * 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 standard può ugualmente essere usata come template, semplicemente specificando il namespace (facendolo precedere dal namespace: ) in cui è inclusa, quindi:


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

Se tale namespace (Namespace: ) non esiste, la stringa viene integralmente funge come collegamento al template (da creare), ovvero viene ulteriormente preceduta dal namespace Template in modo predefinito.


 * include

Parametri
Per espandere 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 attuare 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, "per 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 Template:Thankyou/it, 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 cui 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 a un template in tre modi: Anonimo, Numerato, Nominale.

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:

Nota: identificare i parametri dall'ordine sequenziale in cui essi sono passati (attraverso  e seguenti) funziona solo con parametri anonimi. Se la pagina identifica un qualunque parametro attraverso il nome, come mostrato più avanti, il metodo di accesso per ordine sequenziale ai parametri non sarà più accessibile per il template che li riceve.

Nota: Se un simbolo "=" compare all'interno dei parametri del template, esso potrebbe essere interpretato come un nome di parametro (spiegato più avanti in questo documento) trattando il testo prima del simbolo "=" come nome del parametro e il testo successivo come valore. Questo è un problema comune quando è necessario includere un link esterno, o un elemento HTML con attributi (confronta Task 16235). La soluzione passa attraverso l'uso di parametri con un nome o un numero (il numero rappresenta il nome), come spiegato nella sezione seguente.

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

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

Parametri nominali
Il terzo modo di passare i parametri è tramite nome (Nota: i parametri nominali sono sensibili al maiuscolo/minuscolo), al posto del numero. In questo caso, il contenuto del template dovrà essere modificato così:

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:

Se ci sono molti parametri usare parametri nominali permette oltre che la flessibilità dell'ordine in cui tali parametri possono essere passati, il vantaggio di una miglior comprensione del codice.

produces:

The advantage of using named parameters in your template, besides also being flexible in the order parameters can be passed, is that it makes the template code much easier to understand if there are many parameters.

Valori predefiniti
Se si transclude transclusion 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 un valore non sia passato. 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:

Tempo di valutazione
I parametri del Template sono valutati completamente prima che siano passati al template. Quindi se uno dei tuoi parametri è una chiamata ad un altro template, ciò che è in effetti passato è il parametro espanso.

diventa prima che diventi:

In molte circostanze, questa ordine di valutazione crea una differenza rispetto l'alternativa. (L'alternativa è quella di controllare i risultati della chiamata al template per vedere se ci sono template che devono essere espansi)

Primo, il nome del template può essere espanso allo stesso momento e nello stesso modo dei parametri.

Quindi potrebbe essere espanso in Così che un template che ha chiamato  ha potuto mostrare il ringraziamento nel linguaggio preferito (che comunque è stato definito)

In secondo luogo, il template che viene chiamato non può costruire un altro template da parti da chiamare successivamente. Un template che ha la seguente forma non funzionerebbe se  fosse e fosse.

Terzo, il parametro che viene passato è espanso solo una volta, anziché ovunque il parametro è stato usato nel template. Questo è più efficiente sul server mediawiki.

Infine, il template che viene chiamato non può bloccare il parametro dall'essere espanso. Anche se un template effettivamente userà un solo parametro in alcune circostanze, espanderà tutti i parametri prima che la chiamata venga effettuata.

Exceptions to the order of evaluation
In a few circumstance template parameters are not evaluated before being passed to the template.

Parameters to a  expansion are not evaluated, but are passed literally.

Some magic words are not evaluated as parameters. Their evaluation is delayed because they have side-effects. For example, would not instead
 * 1) evaluate
 * 2) change the display title of the page and
 * 3) call   with parameter 1 being blank
 * 1)   would not be evaluated (yet)
 * 2)   would be called with parameter 1 being
 * 3) only if   is evaluated in , would the display title of the page be changed.

Which magic words are evaluated late like this has not been fully documented. Known ones include:
 * DISPLAYTITLE

Ricorsione nei template
Includere un template in se stesso non induce MediaWiki in infiniti ricorsi. MediaWiki blocca i ricorsi rendendo il nome del template in grassetto. Per esempio, se il contenuto di "Template:Aaaa" is " ", lo mostrerà come "Template:Aaaa".

Controllo sulle inclusioni di template
Per definizione, il contenuto di un template verrà mostrato integralmente, sia quando visionato direttamente, sia quando esso è incluso in un'altra pagina. Tuttavia, è possibile controllare quale parte della pagina del template verrà inclusa nelle altre pagine 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 di Categoria quando si categorizza il template stesso
 * collegamenti di linguaggio verso template simili in altre lingue
 * Testo di aiuto sull'uso del template

Al'opposto il testo tra  e   verrà eseguito e incluso solo nella pagina in cui è inserito il template, ma non quando viene visualizzata la pagina del template. 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.
 * Assicurandosi 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 è ora su ciò che ci sta tra questi due segnaposti (tag).

Ogni cosa fuori i segnaposto  viene rigettato nella trasclusione. Sezioni segnate con un numero pari di includeonly vengono scartate nella trasclusione a meno che siano anche segnate come onlyinclude. L'attenzione è ora su ciò che sta fuori questi segnaposto (tag).

Questi tag si possono anche annidare.

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

Organizzare i template
Per fare sì che ogni utente possa utilizzare al meglio i template, è necessario che essi siano rintracciabili e l'utente possa trovare come usarli.

Per trovare i template, gli utenti possono:
 * 1) cliccare ' (sul fianco sinistro) > cliccare '   . Oppure  .../wiki/Special:SpecialPages  e quindi  .../Special:AllPages
 * 2) nella casella a discesa ', 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 collaboratore potrà semplicemente fare copia e incolla dell'esempio per iniziare ad usare il template.

Collegarsi a un template
A template page can be linked to like any other wiki page. For example, the link Template:Navbar is generated using the wikicode.

On many wikis, Template:Tl can be used to provide a link to a template formatted in a way that shows the "double curly-braces" wikicode necessary to transclude the template without actually doing the tranclusion. For example, the code  may be used to create the link Navbar.

This construct is commonly used in template documentation, on help pages, and on talk pages when referring to templates. The same effect can be achieved by using, but the tl approach involves much less typing. On any given wiki the Tl template, if it exists, may or may not render the text in a "code" element, as shown here. If not, another similarly named template may do so. See, for example, the "See also" section of the documentation of en:Template:Tl at the English Wikipedia.

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

MediaWiki code
Possibile se hai i diritti di importazione (in particolare di importazione e upload) sulla nuova wiki:
 * 1) Vai a  Special:Export sulla wiki di origine e scarica un file  .xml con la storia completa di tutti i necessari template, 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) * Spuntare il box "".
 * 4) * togliere la spunta alla 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. Se non funziona cerca anche l'elenco di i link rossi sotto "Pagine trascluse sulla versione corrente di questa pagina:" sotto il box di modifica. Se ce ne sono ancora altri ripeti i passi sopra anche per quelli.

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 dipendanza 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 installi l' ed è richiesto d'avere l'accesso 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

 * – 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.
 * Extension:PageTemplates
 * Extension:PageTemplates
 * Extension:PageTemplates
 * Extension:PageTemplates