Open main menu

MediaWiki β

This page is a translated version of the page Help:Templates and the translation is 99% complete.

Other languages:
العربية • ‎беларуская (тарашкевіца)‎ • ‎български • ‎भोजपुरी • ‎català • ‎čeština • ‎dansk • ‎Deutsch • ‎Zazaki • ‎English • ‎español • ‎فارسی • ‎suomi • ‎français • ‎עברית • ‎हिन्दी • ‎hrvatski • ‎Bahasa Indonesia • ‎italiano • ‎日本語 • ‎ಕನ್ನಡ • ‎한국어 • ‎Lëtzebuergesch • ‎lietuvių • ‎मैथिली • ‎Napulitano • ‎Nederlands • ‎polski • ‎پښتو • ‎português • ‎português do Brasil • ‎română • ‎русский • ‎سنڌي • ‎slovenčina • ‎српски / srpski • ‎தமிழ் • ‎Tagalog • ‎Türkçe • ‎українська • ‎اردو • ‎Tiếng Việt • ‎中文
PD Nota: Se modifichi questa pagina, certifichi che stai pubblicando il tuo contributo sotto licenza CC0. Vedi le pagine di aiuto sul dominio pubblico per maggiori informazioni.
PD

Se ci sono pezzi di testo che vuoi includere in molte pagine senza ripeterlo, MediaWiki ti offre la possibilità di usare un template (come quello che genera il riquadro in alto). A differenza delle estensioni e dei file multimediali, non esiste una raccolta centrale per i template. I template possono essere di nuova creazione, oppure, per evitare di replicare lavoro già fatto, possono essere esportati da un'altra wiki, come Wikipedia, e quindi importati nella wiki in oggetto.

Creazione

I template sono normali pagine Wiki il cui contenuto è progettato per essere transcluso (incorporato) in altre pagine. I template seguono la convenzione per cui il titolo è preceduto dal prefisso Template:, il che le assegna a detto namespace, devi semplicemente crearli come ogni altra pagina.

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

Ciao! Benvenuto nella wiki

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

{{Welcome/it}}

in qualsiasi altra pagina, quando questa pagina è vista il testo "Ciao! Benvenuto nella Wiki." apparirà al posto di {{Welcome/it}}.

Puoi quindi inserire {{Welcome/it}} in qualsiasi punto di qualsiasi pagina quando vuoi dare il benvenuto a qualcuno. Supponi che esso sia usato in 100 pagine. Se quindi tu cambi il contenuto del template in:

Ciao a tutti! Benvenuti in questa fantastica Wiki.

e rivisiti qualsiasi delle 100 pagine dove il template era usato 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 queste pagine

Questo è il meccanismo base. Ci sono molte azioni disponibili di transclusione che arricchiscono il meccanismo e rendono i template molto utili.

Uso

I template possono essere usati in altre pagine wiki, nei seguenti modi:

  • {{Nome}}; 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.
  • {{subst:Nome}}; quando questo collegamento template viene utilizzato, esso verrà rimpiazzato definitivamente dal contenuto della pagina "[[Template:Nome]]", 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 più nella pagina che conteneva il collegamento al template, in quanto la sostituzione è ormai avvenuta.
  • {{safesubst:Name}}; questo collegamento è stato introdotto per permettere una sostituzione che non interrompe la transclusione. Leggi anche w:en:Help:Substitution#The safesubst: modifier.
  • {{msgnw:Nome}} include il contenuto della pagina "[[Template:Nome]]" come testo in modalità wiki grezza ( in questo modo <nowiki> ) 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:

  • {{Template:Nomepagina}} include [[Template:Nomepagina]]
  • {{Talk:Nomepagina}} include [[Talk:Nomepagina]]
  • {{:Nomepagina}} include [[Nomepagina]]
    • {{subst::Nomepagina}} viene sostituito dal contenuto di [[Nomepagina]]

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.

  • {{Foo:Bar}} include [[Template:Foo:Bar]]

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:


Un piccolo ringraziamento...
per tutto il tuo impegno.
Abbracci, Me


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:

'''Un piccolo ringraziamento ...'''
per {{{1}}}.
Abbracci, {{{2}}}

Notare l'uso di {{{1}}} e {{{2}}}. 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:

{{Thankyou/it|tutto il tuo impegno|Me}}

In questo caso, il template {{Thankyou/it}} riceve i parametri {{{1}}}=tutto il tuo impegno e {{{2}}}=Me, producendo come risultato:

Un piccolo ringraziamento...
per tutto il tuo impegno.
Abbracci, Me


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

{{Ti ringrazio|Me|per il tuo impegno}}

produrrebbe questo risultato:

Un piccolo ringraziamento...
per Me.
Abbracci, il tuo impegno


Nota: identificare i parametri dall'ordine sequenziale in cui essi sono passati (attraverso {{{1}}} 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:

{{Thankyou/it|2=Me|1=tua amicizia}}

Questa volta, il template {{Thankyou/it}} riceve i parametri {{{1}}}=tua amicizia e {{{2}}}=Me, nonostante questi siano stati inseriti in ordine inverso, e produce:

Un piccolo ringraziamento...
per tua amicizia.
Abbracci, Me


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 {{{ragione}}}.
Abbracci, {{{firma}}}

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

{{Thankyou/it|firma=Me|ragione=per essere te stesso}}

In questo caso, il template {{Thankyou/it}} riceve i parametri {{{ragione}}}=per quel che sei e {{{firma}}}=Me, producendo come risultato:

Un piccolo ringraziamento...
per per essere ciò che sei.
Abbracci, Me

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.

Valori predefiniti

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

{{Thankyou/it}}

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

Un piccolo ringraziamento...
per {{{1}}}.
Abbracci, {{{2}}}


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:

<pre><nowiki>'''Un piccolo ringraziamento...'''
per {{{motivo|tutto}}}.
abbracci, {{{firma|Me}}}</nowiki></pre>

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

Un piccolo ringraziamento...
per tutto.
Abbracci, Me


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.

{{Thankyou/it|motivo=la visita a ({{Welcome/it}})|firma=Me}}

diventa

{{Thankyou/it|motivo=la visita (Ciao a tutti! Benvenuti in questa meravigliosa  wiki.)|firma=Me}}

prima che diventi:

Un piccolo ringraziamento...
per la visita a (Ciao a tutti! Benvenuti a questa meravigliosa wiki.).
Abbracci, Me


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

{{Grazie in {{linguaggio preferito}}|firma=Me}}

potrebbe essere espanso in

{{Grazie in francese|firma=Me}}

Così che un template che ha chiamato Grazie in francese 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 {{inizio della chiamata}}{{fine della chiamata}} non funzionerebbe se inizio della chiamata fosse {{Thankyou/it| e fine della chiamata fosse firma=Me}}.

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.

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 "{{Aaaa}}", 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 <noinclude> e <includeonly>.

Ogni cosa tra <noinclude> e </noinclude> 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:

Al'opposto il testo tra <includeonly> e </includeonly> 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 una coda di lavoro (job queue). 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 <noinclude> e <includeonly> 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 <onlyinclude> 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 Pagine speciali (sul fianco sinistro) > cliccare Tutte le pagine . Oppure .../wiki/Special:SpecialPages e quindi .../Special:AllPages
  2. nella casella a discesa Namespace:, selezionare Template e cliccare Vai.

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

<noinclude>
== Uso: ==
Benvenuto agli utenti:
{{Thankyou/it|ragione=tua ragione|firma=tua firma}}
</noinclude>

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

Collegarsi a un template

Per connettersi a un template invece di includerlo, si usi il template {{tl}}. Il nome del template che l'editor vuole collegare si inserisce alla destra del pipe verticale. Per esempio: {{tl|navbar}} collega al template {{navbar}}

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:
    • 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.
    • Spuntare il box "Includi i template".
    • togliere la spunta alla casella "Includi solo la versione attuale, non l'intera cronologia".
    • cliccare "Esporta".
  2. 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 ParserFunctions/it e testa se una qualsiasi delle funzioni elencate vengano usate nel template copiato. Se è così, bisogna installare Extension:ParserFunctions/it. 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 {{#invoke: }} nel template è una firma della sua presenza. Nel caso venga usato, c'è bisogno installi l' estensione Scribunto 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 class="foobar") 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