Aiuto:Template

Da Esopedia, l'Enciclopedia dell'[[Ordine Martinista Antico e Tradizionale|O.M.A.T.]] per gli Iniziati.
TIPI DI PAGINA
Voce · Discussione (Bar)
Categoria · Portale
File (Immagine · Suono)
Pagina di servizio
Template · Linea guida
Progetto · Pagina utente
Modulo
Tutti i namespace

In Esopedia, un template, "modello" in italiano, ma letteralmente "sagoma", "calco") è una pagina speciale creata per essere inclusa in altre pagine tramite il meccanismo dell'inclusione.


Può essere usata per diversi scopi:

  • inserire facilmente del testo ripetuto su diverse pagine, scrivendolo una sola volta, come per i template di navigazione
  • inserire degli elementi standard, delle tabelle informative o degli avvisi
  • inserire elementi di cui sia possibile programmare il comportamento in funzione di alcune variabili.


I template sono contenuti nel namespace template, cioè il namespace le cui pagine hanno la forma "Template:NOME" (ad esempio: Template:S).

Nuvola apps khelpcenter.pngSportello informazioni


Inserimento

Exquisite-kfind.pngLo stesso argomento in dettaglio: Aiuto:Inclusione.
Esempio di inclusione


Tutte le pagine con questo namespace possono essere inserite rapidamente in una pagina, semplicemente scrivendo il nome del template (la parte che segue la scritta Template:) tra doppie parentesi graffe[1], come in {{NOME}}.

Questo riferimento nel wikitext provoca l'inserimento del contenuto del template quando la pagina viene visualizzata.


Se la pagina "Template:nome" non esiste, allora {{nome}} funziona come [[Template:nome]], un link a una pagina non esistente, che porta alla pagina di edit.


Non è consentito l'inserimento di template inesistenti.


Se il template non si trova nel namespace apposito (perché ancora in lavorazione, o perché si tratta di un inserimento di un'altra pagina) può essere usato ugualmente, inserendo il nome con il percorso completo (ad esempio {{utente:NOME COGNOME/Pagina di prova}}).


L'inserimento è case sensitive, ovvero il software distingue le lettere maiuscole e minuscole, ad eccezione della prima lettera e degli spazi che sono equivalenti agli underscore ( "_" ). Quindi:

  • i template {{pagina di prova}} e il template {{pagina di Prova}} saranno riconosciuti come differenti
  • i template {{pagina di prova}} e {{pagina_di_prova}} saranno identici.


È possibile utilizzare l'inclusione ricorsiva: un template incluso in una pagina può contenere a sua volta uno o più template.


Nell'inserire i template è possibile dichiarare delle variabili che verranno usate all'interno dello stesso: in questo caso si parla di template parametrico.


Template parametrici

Curly Brackets.svg

Quando si costruisce un template, può essere necessario lasciare all'utente la possibilità di personalizzare una parte del testo o del comportamento del template, a seconda della pagina dove viene inserito. In questo caso, l'utente indica uno o più parametri che poi verranno sfruttati per la rappresentazione a video del template stesso. Ad esempio il template:Film mostra dati diversi a seconda del film che descrive.


In ogni pagina in cui il template è inserito, i parametri vengono espressi di seguito al nome del template, separati da barre verticali, e possono essere identificati da un nome di parametro o da un ordine progressivo. Il metodo di identificazione dipende da come è stato costruito il template ed è spiegato nel suo manuale; possono anche essere supportati entrambi.


Esempio di inclusione con parametri chiamati per nome:

{{nome template|nome=Tizio|cognome=Caio|data=martedì}}


Esempio di inclusione con parametri in ordine progressivo:

{{nome template|Tizio|Caio|martedì}}


All'interno del template stesso, in mezzo al wikicodice che costituisce la pagina "Template:nome template", i parametri sono rappresentati da etichette racchiuse tra triple parentesi graffe; quando il template verrà incluso, a queste etichette verranno sostituiti i valori di testo assegnati di volta in volta dall'utente ai parametri.


Nel primo esempio:

{{{nome}}}, {{{cognome}}} e {{{data}}}

Nel secondo:

{{{1}}}, {{{2}}} e {{{3}}}


La sintassi per esteso è dunque

{{templatename|nomeparametro1=valoreparametro1|nomeparametro2=valoreparametro2}}
con i tag {{{nomeparametro}}} nel template
oppure
{{templatename|valoreparametro1|valoreparametro2}}
con i tag {{{1}}}, {{{2}}}, ecc. nel template.


nota importante: i tag dei parametri nel template hanno tre parentesi graffe e non due!


Esempio

La pagina "Template:Saluto" contiene:

Ciao {{{nome}}}, come va?

Il template viene incluso in una voce digitando:

{{Saluto|nome=Tizio}}

Dopo aver salvato la modifica, nella voce comparirà:

Ciao Tizio, come va?


Nella fase di rendering (ossia di generazione a video del risultato dell'inserimento del template), i parametri in soprannumero saranno ignorati. Se invece i parametri sono insufficienti, normalmente si verificherà un errore, a meno che non sia stata prevista la possibilità di omettere un dato parametro.


Solitamente un parametro si rende opzionale con la forma {{{1|}}} oppure {{{1|Pippo}}}, cioè con una barra verticale dopo il nome. La barra significa che, in mancanza di quel parametro, verrà usato di default il valore successivo alla barra (niente, nel primo caso; "Pippo" nel secondo).
Il default non viene applicato se il parametro è vuoto, ma la sua dichiarazione è comunque presente: chiamando {{nome template|}} (o {{nome template|nome=}} se tale parametro ha un nome) il valore del parametro sarà proprio nullo e non "Pippo". Per controllare che il parametro non sia né assente né vuoto è necessaria la funzione #if.


Notare che quando si usa la notazione con = gli eventuali spazi e ritorni a capo intorno ai valori dei parametri vengono ignorati, quindi {{Saluto|nome=Tizio}} è equivalente a {{Saluto| nome = Tizio }}, mentre non è così per le dichiarazioni implicite: {{Saluto|Tizio}} e {{Saluto| Tizio }} sono differenti. Gli spazi spesso sono comunque innocui, ma se così non fosse, un possibile trucco per rimuoverli è {{#if:toglispazi|{{{1}}}}}.


Modificare un template

Per vedere il contenuto di un template è necessario aprirlo in modalità modifica.


Andando semplicemente sulla pagina del template, a seconda di come questa è impostata si otterrà nei casi più comuni un esempio di visualizzazione del template o una pagina di istruzioni, a volte accompagnate da un avviso che marca i template più complessi e di difficile modifica.


Per andare alla pagina di un template, oltre a digitare il suo nome nella casella di ricerca, è possibile cliccare sul tag modifica di una voce in cui è contenuto il template. In fondo a sinistra, dopo il wikicodice della voce, apparirà una sezione con titolo "Template utilizzati in questa pagina", contenente i link a tutti i template inseriti nella pagina.


È necessaria una precisazione importante:


NON MODIFICARE MAI IL CONTENUTO DI UN TEMPLATE IN USO SE NON SAI QUELLO CHE STAI FACENDO


Modificare un template molto richiamato può danneggiare numerose pagine, oltre a sovraccaricare di lavoro i server di Esopedia, che devono aggiornare tutte le pagine che lo includono. È sempre meglio fare delle prove prima di modificare template molto usati, sfruttando l'anteprima oppure le sandbox.


Quando un template è aperto in modifica, è possibile come per tutte le pagine visualizzare l'anteprima del template stesso; inoltre, per i template è disponibile un'altra funzione (il riquadro "<templatesandbox-editform-legend>") che consente di visualizzare direttamente l'effetto che avrebbero le modifiche in una voce che include già il template, senza dover fare alcun salvataggio, nemmeno di sandbox.


Creare un template

La creazione di un template nuovo avviene come per qualsiasi altra pagina. Poiché un template è fatto per essere utilizzato in diverse voci, talvolta anche migliaia, è bene discutere l'opportunità della sua creazione, ad esempio presso un progetto tematico.


Quando scrivi un template è sempre una buona idea effettuare le seguenti operazioni:

  • Inserire tutto il codice e il testo del template tra i tag <includeonly></includeonly>
  • Inserire le categorie a cui il template appartiene, un breve testo di istruzioni (o meglio ancora un manuale) e una presentazione delle funzioni del template tra i tag <noinclude></noinclude>
  • Anche gli eventuali Interlink vanno inseriti sempre nella sezione compresa tra i tag <noinclude></noinclude>

Se non si rispettano queste norme, le categorie e gli eventuali interlink si ripercuoteranno su tutte le voci in cui il template è inserito, sovrapponendosi, erroneamente, alle categorie e interlink presenti nella voce. Si veda Aiuto:Inclusione per una descrizione di questi tag.

msgnw

Nel wikitext, usare "msgnw:" dopo le parentesi graffe aperte per visualizzarne il contenuto. Per esempio {{ITA}} e {{msgnw:ITA}} visualizzano rispettivamente:


Italia Italia
e
{{bandiera|ITA|nome}}<noinclude> {{Protetta}} [[Categoria:Template bandierine nazionali]] </noinclude>


Elenco delle pagine che contengono un template

Per verificare quali pagine contengono un template si utilizza (come per qualsiasi pagina) il Puntano qui degli strumenti a sinistra. Allorché il template contiene al suo interno una categoria può essere più immediato andare a quella categoria.


Elenco dei template inclusi in una pagina

Se si vuole visualizzare l'elenco dei template inclusi in una pagina, aprire tale pagina in modalità modifica (o visualizza sorgente, per le pagine protette).


Poco sotto il riquadro di modifica, sulla sinistra, vi è una parte della pagina dal titolo "Template utilizzati in questa pagina:" che elenca i vari template inclusi nella pagina in questione. È possibile cliccare sul nome di uno di essi per raggiungere la relativa pagina e da lì, eventualmente, editarla.


Nota: Lì sono indicati non solo i template inclusi direttamente, ma anche indirettamente (cioè quelli inclusi a loro volta in un template incluso nella pagina, e così via).


Utilizzo

I template sono utili per ogni testo che occorre avere in due o più pagine e non occorre che il testo venga modificato indipendentemente per adattarlo alle pagine in cui è presente. Dal momento che è possibile utilizzare i parametri, le versioni possono anche essere differenziate dal momento che i parametri sono indipendenti fra le varie pagine.


I template non solo sono comodi ma possono aiutare a raggiungere l'uniformità fra le pagine.


Tipiche applicazioni sono:

  • Template sinottici (detti anche infobox), che ogni volta mostrano lo stesso tipo di informazione con lo stesso formato ma differenziato utilizzando i parametri, per esempio il già menzionato {{Stato}}. Questi template vanno inseriti in alto a destra nella voce.


Template mappe attive

Un tipo di template di navigazione, ma questa volta i link alle varie voci sono parte di un'immagine. Utile per regioni geografiche, parti anatomiche o altro. Si trovano nella Categoria:Mappe attive.


Utilizzi sconsigliati

Si sconsiglia di duplicare i contenuti (sia con i template che senza), per esempio mettere una sezione che ha a che fare con A e B sia in A che in B. Questo genera confusione e irrita il lettore, soprattutto se il testo ripetuto non è immediatamente riconoscibile con una formattazione speciale. In questi casi conviene usare i link con le duplicazioni limitate il più possibile.


Limitazioni

Un nome di parametro o il suo valore non può contenere il carattere "|", dal momento che serve per separare i parametri. Se occorre usare un "piped link", usare lo stile dei link esterni o due parametri distinti, o usare il template {{!}}.


Inoltre se il nome delle variabili non viene specificato il loro valore non può contenere il segno "=". Se si ha bisogno di inserire il segno "=" in un template che usa i nomi impliciti per le variabili allora è necessario esplicitarne il nome, ad esempio:

questa sintassi funziona correttamente: {{Template|A|B}}
ma questa non funziona: {{Template|A=10|B=32}}
per porvi rimedio, è necessario usare questa variante: {{Template|1= A=10|2= B=32}}

Si può ovviare a ciò usando il template {{=}} nel seguente modo: {{Template|A{{=}}10|B{{=}}32}}

In un template, il nome di un altro template non può dipendere da un parametro.


In un template, un wikilink dipendente da un parametro è reso come un link ad una pagina non esistente; per evitare questo utilizzare lo stile dei link esterni.

Vedere per esempio en:Template:T2, richiamato con {{T2|H|a}} risulterà in Esopedia come en:List_of_people_by_name:_Ha e richiamato con {{T2|H|1}} risulterà en:List_of_people_by_name:_H1. Questi link, anche se appaiono come esterni, sono comunque link a pagine interne e non mostrano se la pagina esiste quindi, indipendentemente dal contenuto, mostrano la pagina e non la pagina di modifica.


Cache

Quando una pagina nel namespace dei template viene modificata, automaticamente azzera la cache di tutte le pagine che utilizzano il template. Comunque, esistono casi di dipendenza indiretta in cui la pagina potrebbe non venire aggiornata anche premendo Ctrl-F5 o simili. Questo è, per esempio, il caso delle pagine (in genere pagine di discussione sui template) che si riferiscono a [Template:Tc], contenente {{msgnw:{{PAGENAME}}}}, probabilmente perché la pagina di template dipende da una variabile.


Sostituzione di un template (subst:)

Exquisite-kfind.pngLo stesso argomento in dettaglio: Aiuto:Subst.

Mettendo "subst:" dopo le doppie graffe aperte, questo comando nel wikitesto verrà rimpiazzato dal contenuto del template quando la pagina verrà salvata. Se qualcuno modificherà la pagina in seguito, non vedrà più il tag nel wikitesto ma solo il testo sostituito.


Controllare l'aspetto grafico

Quando si modifica la grafica di un template, è buona norma controllarne l'aspetto con i principali browser, poiché non tutti i browser visualizzano la grafica di Esopedia allo stesso modo. Vedi anche Esopedia:Accessibilità del contenuto.


Parentesi graffe

Per inserire le doppie parentesi graffe che aprono e chiudono un template esistono diversi modi che dipendono sia dal layout di tastiera sia dal sistema operativo. Si può anche fare copia e incolla da qui: {{ }}

graffa aperta graffa chiusa sistema
ALT_GR+7 ALT_GR+0 GNU/Linux
ALT_GR+8 ALT_GR+9 GNU/Linux
ALT+123 ALT+125 Microsoft Windows
ALT_GR+SHIFT+è ALT_GR+SHIFT++ Microsoft Windows - GNU/Linux
ALT+CTRL+SHIFT+è ALT+CTRL+SHIFT++ Microsoft Windows
??è ??+ Mac OS (con il layout Italiano – Pro)


Variabili di sistema

Le variabili di sistema possono essere considerate come dei template speciali gestiti con la medesima sintassi, anche se il sistema le riconosce senza necessità di una pagina corrispondente nel namespace Template, che anzi, qualora fosse creata con un nome già usato dalle variabili, verrebbe ignorata.


È possibile usare le variabili anche all'interno dei template, oltre ai parametri dichiarati dall'utente, per ottenere alcune informazioni come i nomi delle pagine in cui il template è incluso ({{PAGENAME}}) o la data ({{CURRENTDAY}} {{CURRENTMONTHNAME}} e {{CURRENTYEAR}} nelle varie combinazioni).

Una parola magica in un template è valutata dopo l'inserimento nella pagina che lo referenzia, per esempio se la parola magica {{PAGENAME}} appare nel wikicodice di un template, è resa con il nome della pagina che la contiene e non con il nome del template.


Esempi

(Vedi Puntano qui per le pagine che usano questi template)


Ricerca combinata

Exquisite-kfind.png Albero delle categorie riguardanti i Template
(in corsivo le pagine)

Exquisite-kfind.png Ricerca nel namespace Template



Note

  1. Con la tastiera italiana la parentesi graffa aperta si può ottenere premendo Alt Gr+ Shift+[ mentre la parentesi graffa chiusa premendo Alt Gr+ Shift+])


Pagine correlate

  • Template:Tl: utile per citare template (in documentazione, esempi, discussioni ecc.)
  • Template:Avviso: normalmente i template di avviso nelle voci e pagine di servizio sono basati su questo


template Progetto Template: collabora a Esopedia sull'argomento template