Aiuto:Template

This page is a translated version of the page Help:Templates and the translation is 47% complete.
Outdated translations are marked like this.
PD Nota: Quando modifichi questa pagina, acconsenti a pubblicare il tuo contributo con licenza CC0. Vedi le pagine di aiuto sul dominio pubblico per maggiori informazioni. PD

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 possono essere esportati da un altro wiki come ad esempio Wikipedia, per evitare di replicare lavoro già fatto, e quindi importati nel wiki di destinazione.

Uso basico

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 cui il nome è preceduto da "Template:", assegnandolo a quel namespace; oltre a questo, è possibile crearli come qualsiasi altra pagina wiki.

Per transcludere un template, hai usato le doppie parentesi graffe aperte e chiuse {{nome del template}}.

L'utilizzo più semplice dei template è riportato qui sotto. Crea una pagina chiamata Template:Welcome con il seguente contenuto:

Ciao! Benvenuto nella wiki.

Avrai creato il tuo primo template! Adesso, inserisci il codice seguente in una nuova pagina:

{{Welcome}}

Quando la nuova pagina viene visualizzata il testo "Ciao! Benvenuto nella wiki." apparirà al posto di {{Welcome}}. Il contenuto del template è transcluso, cioè integrato, nell'altra pagina.

Puoi quindi inserire {{Welcome}} 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.

Modi per invocare un template

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

  • {{Nome}} — come detto sopra, questo testo (comunemente noto come "chiamata al template") verrà sostituito dinamicamente dal contenuto della pagina intitolata Template:Nome (un processo chiamato "transclusione") ogni volta che la pagina la pagina con quella chiamata al template verrà caricata (e.g., visualizzata da un lettore del sito wiki). Siccome la chiama al template rimane nella pagina originaria, ogni modifica successiva al Template:Nome sarà vista sulla pagina contenente quella chiamata al template. Inoltre, la pagina sarà elencata nei "Puntano qui" verso quel template.
  • {{subst:Nome}} — quando si utilizza questo tipo di chiamata al template, il codice viene sostituito da una copia statica del contenuto della pagina Template:Nome, alla versione correntemente presente nel momento in cui la chiamata al template viene salvata. That is, a copy of the contents of Template:Name will be substituted for the template call. No link is maintained between the page and the template, so each can be edited further without affecting the other. In effect, there is little difference between substituting the content in this way and simply typing it into the page's source "manually". See Help:Substitution for more information.
  • {{safesubst:Nome}}; questo collegamento è stato introdotto per permettere che la transclusione di un template che contiene una sostituzione effettui quella sostituzione. Vedere w:it:Aiuto:Subst#Sostituzione a catena.

See Help:Substitution for more information.

  • {{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.

Per esempio, {{msgnw:Template:Thankyou}} mostra:

<noinclude> <languages/> </noinclude> '''Un piccolo ringraziamento...''' per {{{reason|{{{1}}}}}}. Abbracci, {{{signature|{{{2}}}}}} <noinclude> [[Category:Template examples{{#translation:}}|{{PAGENAME}}]] </noinclude>

In realtà, una qualsiasi pagina wiki può essere usata come template, semplicemente specificando il 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 il namespace specificato non esiste, viene considerato tutto come titolo di un template:

  • {{Foo:Bar}} transclude Template:Foo:Bar

Regardless of what syntax is used, the name of the template can be relative to the current page Per esempio, nel caso in cui {{/pluto}} fosse chiamato nella pagina pippo, verrà transclusa la pagina pippo/pluto.

Può anche essere generato dinamicamente. Per esempio, {{ {{pippo}} }} chiama Template:pippo e interpreta il risultato come nome di un'altro template da chiamare.

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:


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


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 Template:Thankyou , 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:

'''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 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:

{{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:

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

produrrebbe questo risultato:


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


identificare i parametri dall'ordine progressivo in cui essi sono passati (con {{{1}}}, ecc.) funziona solo con parametri anonimi. I parametri identificati con il nome, come mostrato di seguito, non saranno accessibili al modello che utilizza i numeri ordinali.
Se all'interno dell'argomento di un parametro anonimo comparisse un simbolo "=", quel parametro potrebbe essere interpretato come un parametro nominale (concetto spiegato più avanti in questo documento). Di conseguenza, il testo prima del simbolo "=" sarebbe considerato il nome del parametro e il testo successivo il valore dell'argomento. Questo è un problema comune quando è necessario includere un collegamento esterno, o un elemento HTML con attributi (vedere task T16235). La soluzione è l'uso di parametri nominali o numerati, come spiegato nella sezione seguente.

Parametri numerati

Per passare un parametro tramite un numero, è sufficiente identificarlo con quel 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


Questo potrebbe essere utile quando almeno uno dei parametri numerati contiene il carattere "=".
Esempi
{{Thankyou/it|1=aver aggiunto “=”|2=Me}}

produce:


Un piccolo ringraziamento... per aver aggiunto “=”. Abbracci, Me

  Attenzione: Ciò richiede anche di numerare tutti gli altri parametri.

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 {{{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=essere ciò che sei}}

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


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


I parametri sono case sensitive, quindi:

{{Thankyou/it|firma=Me|Ragione=essere ciò che sei|ragione=essere sensibile alle maiuscole}}

produce:


Un piccolo ringraziamento... per essere sensibile alle maiuscole. Abbracci, Me


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.

Spaces and newlines are automatically stripped from the start and end of named parameter names and values, but are preserved in unnamed parameters.

Mixing named and unnamed parameters

If the template supports it, both kinds of parameters can be used in one call.

For example, {{Thankyou|supporting both parameter types|signature=Me}} results in:


Un piccolo ringraziamento... per supporting both parameter types. Abbracci, Me


Be careful when doing this, because it can result in conterintuitive results as unnamed parameter counts are based only on the unnamed parameters, not the named parameters. For example, {{Thankyou|Me|reason=supporting both parameter types}} results in:


Un piccolo ringraziamento... per supporting both parameter types. Abbracci, {{{2}}}


The template is coded to prefer the named parameter for the reason over the unnamed parameter, resulting in the "Me" being lost and no signature being given. This results in a default value of {{{2}}} being shown, as explained below.

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 non sia passato nessun valore. Ad esempio, se il contenuto del template viene modificato in:

'''Un piccolo ringraziamento...'''
per {{{ragione|tutto}}}.
abbracci, {{{firma|Me}}}

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


Il valore di un parametro può essere una stringa vuota. Ad esempio, in {{foo|bar=}} o {{foo|bar=|baz=qux}}, il template foo considera il parametro bar come "". Questo è diverso dall'omissione totale del parametro, che lo lascia indefinito e attiva il meccanismo del valore predefinito descritto sopra.
If you need to treat an empty string the same way as a missing parameter, you can use a conditional operator through an extension like ParserFunctions. For instance, {{#if:{{{1|}}}|{{{1|}}}|undefined}} returns undefined if the parameter is either undefined or empty, while {{{1|undefined}}} does so only if the parameter is undefined.

Spesso i valori predefiniti sono usati per specificare nomi alternativi ai parametri. Per esempio, se è definito "{{{a|{{{b|}}} }}}", 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.

Passing parameters to other templates

If raw parameter syntax is generated by the above template call, and then passed through to another template, it is not interpreted as a parameter. This means that {{Thankyou2 }}, which just calls {{Thankyou }} with no parameters, does not work: {{thankyou2|everything|me}}Un piccolo ringraziamento... per {{{1}}}. Abbracci, {{{2}}}


You instead need to explicitly pass the parameter to the other template, i.e if {{Thankyou3 }} contains

{{thankyou|{{{1}}}|{{{2}}}}}

then works properly: {{thankyou3|everything|me}}Un piccolo ringraziamento... per everything. Abbracci, me


This example does not preserve emptiness vs. undefinedness in parameter values - you would need more complicated syntax if you wanted to do that.

Empty vs undefined parameters

The {{t2demo|| a }} (refer to {{T2demo }} ), with a double pipe, sets the first parameter to an empty string instead of leaving it undefined. It produces the output start--middle- a -end, similar to how {{t2demo|1=|2= a }} results in start--middle- a -end. On the other hand, explicitly setting the parameter "2" to "a," results in the first unnamed parameter being left undefined:

{{t2demo|2= a }} results in start-{{{1}}}-middle- a -end

If the second parameter should not be trimmed, it must be unnamed.

Therefore, you can assign an empty string to the first parameter, but you cannot leave it undefined.

Making emptiness and undefinedness equivalent

Good template coding practices result in passing an empty string to a parameter working the same as not assigning any value. This makes things easier and more consistent.

For example, using p= can show that a template has a parameter "p" that doesn't have a value yet.

To make an empty string and an undefined value equivalent, use the following approaches:

  • Use {{{p|}}} exclusively instead of {{{p}}} or q where "q" is a non-empty value.
  • Use conditional checks like {{#if:{{{p|}}}|..{{{p}}}..|..}}, to ensure {{{p}}} is only used when it has a value.

If for some reason you want to treat undefined parameters differently from empty parameters or any other possible value you can compare the same parameter twice with different defaults, i.e {{#ifeq:{{{foo|bar}}}|{{{foo|baz}}}|parameter is defined|parameter is undefined}}.

Using equals signs in unnamed parameters

Unnamed parameters can include equals signs, but this must be done indirectly. Here are some methods using template:T1demo:

Default Value for Undefined Parameter

Assign a default value to an undefined parameter:

{{T1demo|{{{1| a=b }}}}}

This renders as: start a=b end.

Using the {{=}} parser function

Use a parser function that safely includes an equals sign:

{{T1demo| a{{=}}b }}

This renders as: start a=b end.

HTML Entities

Replace the equals sign with an HTML entity for display:

{{T1demo| a=b }}

This renders as: start a=b end.

This renders correctly without affecting the other parameters.

Handling unmatched curly and square brackets

Unmatched curly brackets ({{, }}) or square brackets ([[, ]]) must be inside nowiki tags or use HTML entities:

  • Rendering curly brackets have two options:
    • Use <nowiki>{{</nowiki> or &#123; for {
    • Use <nowiki>}}</nowiki> or &#125; for }.
  • Use &#91; for [ and &#93; for ].

Below are some examples:

Unmatched curly brackets
{{T1demo| <nowiki>{{</nowiki>content<nowiki>}}</nowiki> }}

This correctly renders the braces without breaking the template.

Unmatched square brackets
{{T1demo| text [link] more text }}

This correctly renders the braces without breaking the template.

This renders as: start text [link] more text end

Unmatched pairs not placed in nowiki tags either prevent template expansion or are taken as closing braces for the template call.

Below are some examples:

{{T1demo|abc]]def[[ghi}}

This will not expand correctly because of unmatched brackets.

The correct use:

{{T1demo|abc<nowiki>]]</nowiki>def<nowiki>[[</nowiki>ghi}}

This renders as: startabc]]def[[ghiend

Template-generated brackets

An alternate technique for passing arguments with unmatched brackets is to wrap them in another template

.

In that situation, (which exists with {{(( }} and {{)) }}) on this wiki), the unmatched brackets will be rendered literally, and not decoded as another template call. For example:

{{t1demo|{{((}}t1demo{{))}}}}

results in: start{{t1demo}}end

When substituting a template, template inclusions are parsed once when the subst happens (with the same caveats explained above) and then a second time when rendering the resulting wikitext. For example:

{{subst:((}}t1demo|foo}}

will expand on save to:

{{t1demo|foo}}

which will then render as:

startfooend

If the wikitext generated via the first subst itself includes "subst:" syntax it will not be processed on the same save, but may be on the next save.

This technique may be used to implement recursive substitutions that take multiple saves to evaluate.

Using pipes in parameter values

A parameter value cannot contain a pipe character (|), because it would be interpreted as the end of that parameter and the start of the next parameter.

This can be worked around by using the parser function {{!}}, or the HTML entity &124;. The two methods of doing this have slightly different behavior, which can be relevant in some corner cases like when a template is producing wikitable syntax.

Example: {{T1demo|abc|def}} produces: startabcend

The "def" doesn't display because it is treated as part of another unnamed parameter, which the template does not use.

{{T1demo|abc{{!}}def}} produces: startabc|defend

The "def" displays properly.

{{T1demo|abc&#124;def}} produces: startabc|defend

The "def" displays properly again.

Formatting template calls using extra parameters

Since templates ignore parameters they are passed but do not handle specifically, they can be used as a way of a adding extra whitespace or unused content to the template call.

For example:

{{template name|foo|bar|baz|mumble|quux}}

is equivalent to, assuming the template doesn't recognize SPACEN as a parameter name:

{{template name|SPACE1=
|foo|SPACE2=
|bar|SPACE3=Random stuff
|baz|SPACE4=
   |mumble|SPACE5=
  quux
}}

It is also possible to use the same name for each spacer (often the empty string), but this will populate Category:Pages using duplicate arguments in template calls, which many wikis prefer to keep empty to catch instances of user error.

This can be used to make the template render in a way similar to its output, like showing each row of w:Template:Chess position on its own like to make the wikitext also look like a chessboard.

Tracking parameter usage


It may be wise for a template to add a link or category to a page if a certain parameter or combination of parameters is used, to make if possible to easily determine what pages are using a given parameter, and thus what the impacts of changing that parameter in the template would be.

Processo di valutazione

Questo è un'argomento avanzato che puoi saltare a meno che non ti serva leggerlo.

In generale, i parametri del template vengono sostituiti nel template dopo l'attribuzione dei token così come sono trasmessi. Non vengono valutati finché non vengono utilizzati.

Ciò comporta alcune conseguenze.

  1. Prima di tutto, se si ha un Template:Start che contiene {{mytemplate, e un Template:End che contiene |foo=bar}}, e si mette {{start}}{{end}} in una pagina, mytemplate non è trascluso, perché token come "|" non possono essere aggiunti da un template e mantengono il loro significato speciale nei template. È ancora possibile usare i template per controllare il nome di un parametro o di un template, ma non è possibile dividere una chiamata di un template tra più template.
  2. La seconda conseguenza è l'eliminazione del codice inutilizzato. Se si effettua una chiamata a un template come {{foo|{{DISPLAYTITLE:Bar}} }} e Template:Foo non contiene {{{1}}}, il displaytitle non viene utilizzato, poiché viene valutato solo quando necessario e non c'è un parametro in cui sostituirlo, quindi non viene mai valutato. Questo si verifica di solito quando si usa Extension:ParserFunctions , e si nota soprattutto quando viene usato in combinazione con la parola magica int:, che varia a seconda della lingua dell'utente. This isn't perfect, and in some cases even if the result of expanding a template is not used (because it is part of an if statement condition, for example), the process of evaluating it can still have side effects. For example, any links produced or other templates used will still be added to Special:WhatLinksHere even if they are not displayed.

Template parameters are pass by value, which means a template cannot modify its arguments. Parameters are treated as associative array, and parameter names are evaluated before parameter values. If the same parameter name is given more than once (either as named or unnamed), only the last instace is used, and the page is added to Category:Pages using duplicate arguments in template calls.

Le chiamate ai template che iniziano con la parola magica subst: o safesubst: sono valutate in un primo passaggio separato che avviene solo al momento del salvataggio, insieme a ~~~~ e ai collegamenti che utilizzano il trucco pipe. Se non possono essere valutati durante il primo passaggio, le chiamate a subst: vengono ignorate e safesubst: viene trattato come un normale template.

La maggior parte delle funzioni del parser, i tag del parser e le pagine speciali trascluse non sono incluse direttamente come i template, ma sono sostituite da un "strip marker". Ciò significa che non è possibile manipolare i risultati con funzioni di parser come padleft: o funzioni simili di estensioni, perché vedono lo strip marker invece del risultato della funzione di parser.

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" è "a {{Aaaa}} z", lo mostrerà come "a a Template loop detected: Template:Aaaa z z".

Questa salvaguardia preclude una sintassi potenzialmente utile per i template, in cui un template auto-normalizza i propri argomenti di chiamata. In questo esempio vietato template:d può essere chiamato sia {{d|20200311}} che {{d|y=2020|m=3|d=11}}. Se viene chiamato nel primo modo, ricorre in se stesso con la seconda struttura di argomenti (ottenuta con le funzioni del parser di stringhe), che poi segue un percorso di elaborazione unificato.

{{#if:{{{1|}}}|{{d|y={{#sub:{{{1}}}|0|4}}|m={{#sub:{{{1}}}|4|2}}|d={{#sub:{{{1}}}|6|2}}}}|<!-- processing path with arguments y,m,d regardless of original call pattern -->}}

Se template:d è modificato in modo da rientrare in template:d/2 e template:d/2 è una copia manuale identica di template:d, questo idioma funziona bene, poiché la salvaguardia dell'autoricorsione opera dinamicamente e non staticamente.

Un modo fattibile per il software MediaWiki di allentare la regola dell'autoricorsione sarebbe quello di richiedere che ogni chiamata ricorsiva abbia un numero di argomenti distinto da tutte le precedenti chiamate attive, al massimo una volta ricorsiva con il numero di argomenti non decrescente. Ciò fornirebbe una forte garanzia contro l'auto-ricorsione infinita, consentendo l'utilizzo di idiomi come quello qui descritto in modo flessibile.

Se il percorso di elaborazione è di bassa complessità, una soluzione semplice che utilizza un solo template è gestire ogni convenzione di chiamata su un ramo if/else separato, duplicando la logica del percorso di elaborazione all'interno di ogni caso. Se il percorso di elaborazione è più complesso, ogni caso di struttura di chiamata può essere delegato a un modello di implementazione con una struttura di chiamata unificata che fornisce il comportamento finale del modello.

Tabelle che utilizzano parametri

Since the pipe character (|) and equality sign (=) have different meanings in template calls and wikitables, in order to use table markup in the value of a template parameter one generally needs to "escape" those characters (i.e., protect them from interpretation as template markup) using special sequences:

  • the built-in magic word {{!}} provides an "escaped" version of | since MediaWiki 1.24
  • the built-in magic word {{=}} provides an "escaped" version of = since MediaWiki 1.39

Before the introduction of these magic words, many wikis used templates to accomplish the same things. On such a wiki, the magic words take precendence over the same-named templates.

Example table

A B C
A1 B1 C1
A2 B2 C1

Table code:

{| class=wikitable
!A!!B!!C
|-
|A1||B1||C1
|-
|A2||B2||C1
|}

Escaped table code:

{{{!}} class{{=}}wikitable
!A!!B!!C
{{!}}-
{{!}}A1{{!}}{{!}}B1{{!}}{{!}}C1
{{!}}-
{{!}}A2{{!}}{{!}}B2{{!}}{{!}}C2
{{!}}}

Note that the first left-brace ({) is interpreted as a literal left-brace character because it is immediately followed by the {{!}} magic word. Similarly, the last right-brace (}) is interpreted as a literal right-brace character because it is immediately preceeded by the same magic word. However, in some cases these brace characters do cause problems, so some wikis provide templates for escaping these characters, as well:

  • the template call {{(}} might provide an "escaped" version of {
  • the template call {{)}} might provide an "escaped" version of }

Some wikis go even further and provide other convenience templates like {{(!}} ({|), {{!)}} (|}), {{!!}} (||). On such a wiki, the code can be simplified a bit to this form:

{{(!}} class{{=}}wikitable
!A!!B!!C
{{!}}-
{{!}}A1{{!!}}B1{{!!}}C1
{{!}}-
{{!}}A2{{!!}}B2{{!!}}C2
{{!)}}

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 $noinclude $includeonly e $onlyinclude.

The template's page when viewed directly appears exactly as the template would render without any parameters. If the template requires parameters to function properly, this will result in raw wikitext syntax or errors as a result of them being missing.

For example:

  • If a parameter has no default value, it shows as the literal text {{{1}}}, indicating the template needs a parameter.
  • If a parameter has an empty default value (it is written as {{{1|}}}), it displays nothing, which achieves the intended effect but lacks clarity for self-documentation. Using a non-empty default value like {{{1|$1}}} could clarify a parameter's role, especially for templates involving images.
  • If a parameter without a default is passed to the #expr parser function, it results in an error message: "Expression error: unrecognized punctuation character '{'."
  • If a template creates a table, it's helpful for the template page to show the table's structure rather than the wikitext used to make it. To do this, the table syntax isn't enclosed in tags, and each table element includes both ‎<noinclude>...‎</noinclude> and ‎<includeonly>...‎</includeonly> parts where needed.

However, you can control which parts of a template will be seen and included by the use of the ‎<noinclude>, ‎<includeonly> and ‎<onlyinclude> tags.

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:

  • 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 It's a common pattern on some wikis to use a template like {{Documentation }} to transclude the documentation from a subpage of the template. For example, Template:Void is documented at Template:Void/doc.

Allo stesso modo, tutto ciò che è compreso tra ‎<includeonly> e ‎</includeonly> verrà elaborato e visualizzato solo quando la pagina viene inclusa, ma non quando la pagina del modello viene visualizzata direttamente, ed è utile in situazioni come:

  • Categorizzazione delle pagine 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 qualche tempo dopo: 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 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 ‎<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 è rivolta a ciò che si trova all'interno di questi due tag.

Tutto ciò che è esterno ai tag ‎<onlyinclude> 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 è solo su ciò che sta all'interno di questo tag.

For example, if a page like Help:Templates/onlyinclude demo has the wikitext:

abc<onlyinclude>def</onlyinclude>ghi<includeonly>jkl</includeonly>

The result of transcluding it is def.

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. Inclusion tags are respected when using {{subst:templatename}}, but they are not respected when using {{msgnw:templatename}} as that displays the raw wikitext without any processing.

Section transclusion

To transclude different sections of a template on different pages, you can wrap the content in onlyinclude tags and use an if statement on parameters to select which section.

Consider "Template:Example" with this wikitext:

== Section 1 ==
{{#ifeq:{{{1|1}}}|1|
Content of section one.
}}
{{#ifeq:{{{1|2}}}|2|
== Section 2 ==
Content of section two.
}}

This will render both sections on the example page itself, and allow other pages to transclude the first section with {{example|1}} and the second section with {{example|2}}.

Another approach is to use literal parameter syntax instead:

{{{section1|
== Section 1 ==
Content of section one.
}}}
{{{section2|
== Section 2 ==
Content of section two.
}}}

Transclude the first section with {{example|section2=}} and the second section with {{example|section1=}}. If neither parameter is used, then both sections will display.

A third approach is to use Labeled Section Transclusion.

Organizzare i template

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

Per trovarli, gli utenti possono:

  1. cliccare Pagine speciali (sul fianco sinistro) > Tutte le pagine. Oppure .../wiki/Special:SpecialPages e quindi .../Special:AllPages
  2. nel menu a tendina 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 contributore potrà semplicemente fare copia e incolla dell'esempio per iniziare ad usare il template.

While editing a page, a list of all templates used is available under the editing form, in a collapsible section titled "Template utilizzati in questa pagina:" (also named "Template utilizzati in questa anteprima:", or "Template utilizzati in questa sezione:" depending on the context). This list provides a convenient link to the template's page, as well as information about its protection status. Redirected templates are shown in italics, with the redirect target added as a separate list item.

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 [[Template:Navbar]].

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 {{tl|Navbar}} 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 {{[[Template:Navbar|Navbar]]}}, 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.

Template naming

The name of a template is case-sensitive excluding the first character.

You make redirects for alternate capitalizations. For example, if a template is named "AdminAbbr", you can create a redirect named "Adminabbr". This way, the template can be called with either {{AdminAbbr}} or {{adminabbr}}. If an editor prefers a mix of upper and lower case for clarity, they can use functions like lc or uc. For instance, instead of {{CURRENTINTERNETTIME}}, they could use {{ {{uc:CurrentInternetTime}} }}

Because template names are interpreted in the same way to the names of other pages, underscores are replaced with spaces, and any text after a number sign (what would be a anchor in a standard link) is ignored.

An underscore _ can be alternative to a blank space.

Possible uses of templates

Templates can be used for any situation in which one wants two or more pages to contain identical or similar content that is edited together rather than independently. They can be used to:

  • Provide structured elements on many pages, like infoboxes, maintenance templates, navigational boxes, etc.
  • Perform calculations used as a programming tool on various pages, like w:Template:Sum.
  • Build composite pages that display the content of multiple existing pages together, like w:WP:Village pump (all) which includes content from each section of the village pump. The content of these pages can either be shown individually, or together, but the revision history, watchlist, etc. will only pick up changes to the transcluded pages and the raw wikitext of the composite page itself, not implicit changes to the composite page.
  • Share some content between a few related pages. For example, the list at Help:Preferences#Beta features is duplicated at Beta Features#Current Beta Features. While on MediaWiki.org that is built using Extension:LabeledSectionTransclusion instead, it could have been done using a template.
  • Store content referenced multiple times on the same page, so it only has to be written and calculated once. For example w:Template:Cite Monumentenregister/URL is called twice by w:Template:Cite Monumentenregister in two different places, and using another template means the URL pattern only has to be written once in the base template.
  • Use templates as a programming element to generate a loop: if Template:A calls Template:B 10 times with different parameters, then that crudely simulates a for loop. If Template:B calls Template:C 10 times, then you have a nested loop of 100 calls of Template:C. But keep in mind that it is easy to run into the template limits when using templates as advanced programming constructs, and using Scribunto is generally clearer and easier to follow.

Importare da un wiki ad un altro

It is possible, if allowed by the wiki configuration to transclude templates from other wikis. This configuration setting is disabled on Wikimedia wikis. Otherwise, you need to manually copy the template and its dependencies from the source wiki to the destination wiki to use it.

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.

The steps below should work for most templates.

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:
    • 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.
    • Selezionare la casella "Includi i template".
    • Selezionare la casella "Includi solo la versione attuale, non l'intera cronologia".
    • Cliccare "Esporta".
  2. Andare in Speciale:Importa sulla nuova wiki e caricare il file .xml .

Se non hai i 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.
  1. On the new wiki, go to the page with the same name as the template you copied. Hit create/edit and paste the wikitext you copied. In the edit summary of each template, link to the original page for attribution.
  1. Back in the original wiki at the edit window, below the edit box, look at the list of "Templates used on this page". For each template listed follow these instructions. Also do that for any template used by any of these templates, and so on.

Questo copia l'intero codice necessario ed è sufficiente per la maggior parte dei template. Si noti che vengono esportati solo gli elementi della pagina analizzati durante il rendering; di conseguenza, le sottopagine della documentazione non vengono esportate come parte di questo processo. 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 ParserFunctions e controlla se una qualsiasi delle funzioni elencate vengano usate nel template copiato. Se è così, bisogna installare ParserFunctions . 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 {{#invoke: }} nel template è una buon segno della sua presenza. Nel caso venga usato, c'è bisogno di installare l'estensione Scribunto ed è richiesto avere l'accesso come amministratore. Per ulteriori istruzioni sull'installazione e sull'uso dell'estensione, consultare questa pagina.

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 copiati non si comportano come ci si aspetta, questo può essere la causa. Per copiare i CSS e i JavaScript necessari nel wiki è normalmente necessario avere i privilegi di amministratore, perché si modificheranno i messaggi di sistema 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" sul nuovo 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" sul wiki originale. Se è così, puoi tentare di copiarlo in "MediaWiki:Common.js" nel nuovo 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.

Redirection

If a page uses a redirect as a template, the redirect is resolved before processing the template and the target is used instead. This won't work if the target doesn't exist (a broken redirect), or is itself a redirect (a double redirect).

A page that just includes another page as a template might look like a redirect, but there are several differences between them:

  • The header of the result displays the title of the page it came from.
  • No "Redirected from" message is shown.
  • Buttons like edit, watch, talk, history, "what links here," and "last modified" point to the referring page. To access the target page, use a section edit link and navigate from there.
  • Unless includeonly and/or noinclude tags are used, the referring page shares the same categories as the target page.
  • "Double redirects" work when one or both are this type of pseudo-redirect.
Embedding works on pages that support redirects and doesn't work on pages without it.

Parser functions

Pagina principale: Help:Parser functions

MediaWiki also supports parser functions, which function similarly to templates but follow slightly different syntax:

  • Parser functions utilize a ":" instead of the initial "|".
  • An edit page does not display parser functions used on that page.
  • There is no "What links here" feature for parser functions to identify the pages where they are utilized.
  • Parser functions templates do not generally accept named parameters, so equal signs generally have no special significance. For example:
{{ #if: not blank | x=abc }} gives x=abc

Vedi anche

Utilizzo generale di un template

Costrutti speciali utilizzati nei template

Ulteriori informazioni importanti

Collegamenti esterni