Ajuda:Plantilles

Nota: Quan modifiqueu aquesta pàgina, esteu acceptant que la vostra contribució es publiqui en el marc de CC0. Mireu Pàgines d'ajuda de domini públic per a més informació.

Si teniu textos estàndard que voldríeu incloure en diverses pàgines, la funció de plantilles MediaWiki entra en joc. A diferència de les extensions i els fitxers de mitjans, no hi ha cap repositori central per a les plantilles. Les plantilles poden ser escrites de zero o, per estalviar duplicar el treball ja fet, exportades des d'un altre wiki (per exemple la Viquipèdia) i, a continuació, importades al wiki de destinació. Templates can be newly written or, to save duplicating work already done, exported from another wiki e.g. Wikipedia, and then imported into the target wiki.

Basic usage

Les plantilles són pàgines wiki estàndard amb un contingut dissenyat per a ser transclòs a l'interior d'altres pàgines. Les plantilles segueixen una convenció en que el nom té el prefix "Template:", assignant-lo a aquest espai de noms; a més d'això, podeu crear-les com qualsevol altra pàgina wiki.

To transclude a template, you used double open & close curly brackets {{template name}}.

L'ús més simple de plantilles és el següent. Si creeu una pàgina anomenada "Plantilla:Benvinguda" que contingui:

Hola! Benvinguts al wiki.

haureu creat la vostra primera plantilla! Si a continuació, inseriu el codi:

{{Benvinguda}}

en qualsevol altra pàgina, quan aquesta pàgina es vegi el text "Hola! Benvinguts al wiki." apareixerà en lloc de {{Benvinguda}}. El contingut de la plantilla serà "transclòs" en l'altra pàgina, és a dir, que serà integrat a la pàgina.

A continuació, podeu inserir {{Benvinguda}} en qualsevol punt de qualsevol pàgina en la qual desitgeu donar la benvinguda a algú. Suposem que s'utilitza en 100 pàgines. Si a continuació, canvia el contingut de la plantilla per:

Ei! Benvingut/-da a aquest meravellós wiki.

i tornar a visitar alguna de les 100 pàgines en què es va utilitzar la plantilla, veurà el nou text en lloc de l'original. D'aquesta manera, s'ha canviat el contingut de 100 pàgines sense editar, ja que la plantilla esta transclosa en aquestes pàgines.

Aquest és el mecanisme bàsic. Hi ha diverses característiques addicionals de transclusió que enriqueixen aquest mecanisme i fer les plantilles molt útils.

Ways to invoke a template

Les plantilles poden ser utilitzades en altres pàgines en les següents formes:

• {{Nom}} — tal com s'ha descrit anteriorment, aquest text (comunament anomenat "crida de plantilla") se substituirà "dinàmicament" pel contingut de la pàgina anomenada Plantilla:Nom (un procés anomenat "transclusió") cada vegada que la pàgina amb la crida de la plantilla es carrega (és a dir, la visualitza un lector de la wiki). Com que la crida de plantilla roman al codi font de les pàgines, qualsevol canvi posterior a Plantilla:Nom es veurà a la pàgina que conté la crida de plantilla. A més, la pàgina apareixerà entre les que enllacen ("Què hi enllaça") a la plantilla.
• {{subst:Nom}} — quan s'utilitza aquest tipus de crida de plantilla, se substituirà per una còpia estàtica del contingut de la Plantilla:Nom a partir del moment en què la pàgina que conté la crida de la plantilla és desada. És a dir, una còpia del contingut de Plantilla:Nom serà substituïda per la crida de plantilla. No es manté cap enllaç entre la pàgina i la plantilla, de manera que cadascuna es pot editar sense afectar una a l'altra. En efecte, hi ha poca diferència entre substituir el contingut d'aquesta manera i simplement escriure-la al codi font de la pàgina ("manualment"). See Help:Substitution for more information.
• {{safesubst:Nom}}: es va introduir per permetre la substitució recursiva en els casos en què les plantilles contenen crides a altres plantilles o funcions d'analitzador. Vegeu Help:Substitution per a més informació.
• {{msgnw:Nom}}: mostra el contingut de la plantilla com a sintaxi wiki en brut (com ho fa ‎<nowiki>) quan es visualitza la pàgina que la conté. For example, {{msgnw:Template:Thankyou}} displays:

<noinclude> <languages/> </noinclude> '''Un petit agraïment...''' per {{{reason|{{{1}}}}}}. Una abraçada, {{{signature|{{{2}}}}}} <noinclude> [[Category:Template examples{{#translation:}}|{{PAGENAME}}]] </noinclude>.

De fet, una pàgina wiki ordinària també es pot utilitzar com a plantilla, simplement especificant l'espai de noms que on s'està, per la qual cosa:

• {{Plantilla:NomDePàgina}} transclou la pàgina titulada Plantilla:NomDePàgina (equivalent a {{NomDePàgina}})
• {{Discussió:NomDePàgina}} transclou la pàgina titulada Discussió:NomDePàgina
• {{:NomDePàgina}} transclou la pàgina anomenada NomDePàgina (és a dir, a l'espai de noms principal)
  • {{subst::NomDePàgina}} substitueix el contingut de la pàgina anomenada NomDePàgina

Si l'espai de noms especificat no existeix, se suposa que el títol complet és una plantilla:

• {{Foo:Bar}} transclou Plantilla:Foo:Bar

Regardless of what syntax is used, the name of the template can be relative to the current page For example, if {{/bar}} is called on page foo, it will transclude the page foo/bar.

It can also be generated dynamically. For example, {{ {{foo}} }} calls Template:foo and interprets the result as the name of another template to call.

Paràmetres

Per enriquir el mecanisme de transclusió, MediaWiki permet paràmetres que es passen a una plantilla quan es transclou. Els paràmetres permeten que la plantilla tingui continguts diferents o diferents comportaments.

Suposeu que voleu inserir una petita nota d'agraïment a la pàgina de discussió d'altres usuaris, com ara:

Un petit agraïment... per tot el vostre esforç. Una abraçada, jo

La nota d'agraïment tindrà una raó (en aquest cas, "tot el vostre esforç") i una signatura ("jo"). El seu objectiu és que qualsevol usuari pugui donar les gràcies a altres usuaris, per qualsevol raó que sigui.

Per tal que la nota tingui un aspecte similar arreu on es faci servir, podeu definir una plantilla anomenada Template:Thankyou/ca , per exemple. Tot i que la nota hauria de tenir un aspecte semblant sempre que un usuari faci un agraïment a un altre usuari, el seu contingut específic (és a dir, el motiu i la signatura) serà diferent. Per aquest motiu, hauríeu de passar-los com a paràmetres. Si ignorem els elements restants per formatar el quadre i col·locar la imatge, el contingut bàsic de la plantilla serà aquest:

'''Un petit agraïment...'''
per {{{1}}}.
Una abraçada, {{{2}}}

Observeu l'ús de {{{1}}} i {{{2}}}. Aquesta és la manera d'identificar, dins de les plantilles, els paràmetres que es passaran en tant s'utilitza la plantilla. Tingueu en compte que, dins de la plantilla, cada paràmetre està envoltat per tres claus: {{{ }}}. Això és diferent de l'ús normal del nom de la plantilla.

Quan s'utilitza la plantilla d'una pàgina, s'omplen els valors dels paràmetres, separats pe caràcter de la barra vertical (|). MediaWiki permet que els paràmetres que es passen a la plantilla de tres maneres: anònimament, numerada, i amb nom; com veureu a continuació.

Paràmetres anònims

Per passar paràmetres sense nom, es posen els valors dels paràmetres de forma seqüencial:

{{Thankyou/ca|tot el vostre esforç|jo}}

En aquest cas, la plantilla {{Thankyou/ca}} rep els paràmetres {{{1}}}=tot el vostre esforç i {{{2}}}=jo, del que resulta:

Un petit agraïment... per tot el vostre esforç. Una abraçada, jo

L'ordre en que es passen els paràmetres anònimes és crucial per al seu comportament. Invertir l'ordre dels paràmetres, així:

{{Thankyou/ca|jo|tot el vostre esforç}}

donaria el següent resultat:

Un petit agraïment... per jo. Una abraçada, tot el vostre esforç

La identificació de paràmetres per ordre (amb {{{1}}}, etc.) funciona "només" amb paràmetres sense nom. Els paràmetres identificats pel nom, tal com es mostra a continuació, no seran accessibles a la plantilla mitjançant números ordinals.

Si un signe d'igual apareix dins de l'argument del paràmetre anònim d'una plantilla, el paràmetre es podria malinterpretar com a paràmetre amb nom (cosa que s'explica més avall en aquest document), i el text de davant del signe d'igual es podria tractar com el nom del paràmetre i el text de després com el valor de l'argument. Aquest és un problema comú quan necessiteu incloure un enllaç extern o un element HTML amb atributs (vegeu task T16235). La solució temporal és emprar paràmetres amb nom en el seu lloc, o fins i tot paràmetres numerats com s'explica en la secció següent.

Paràmetres numerats

Per passar els paràmetres per número, cal identificar cada paràmetre a passar-li:

{{Thankyou/ca|2=jo|1=la vostra amistat}}

Aquesta vegada, la plantilla {{Thankyou/ca}} rep els paràmetres {{{1}}}=la vostra amistat i {{{2}}}=jo, tot i que s'han proporcionat en ordre invers, i produeix:

Un petit agraïment... per la vostra amistat. Una abraçada, jo

Això també pot ser útil quan qualsevol dels paràmetres numerats conté un signe "=".

Exemples

{{Thankyou/ca|1=afegint “=”|2=jo}}

produeix:

Un petit agraïment... per afegint “=”. Una abraçada, jo

Atenció:

Això també requereix numerar cadascun dels altres paràmetres.

Paràmetres amb nom

La tercera via per passar paràmetres és pel seu nom, en lloc de nombres. En aquest cas, el contingut de la plantilla es canviaria per:

'''Un petit agraïment...'''
per {{{reason}}}.
Una abraçada, {{{signature}}}

Dins de la plantilla, fem servir {{{reason}}} i {{{signature}}} per identificar cada paràmetre, en lloc d'un nombre. Per passar aquests paràmetres pel seu nom, cal identificar cada paràmetre en passar-l'hi:

{{Thankyou/ca|signature=jo|reason=ser qui sou}}

En aquest cas, la plantilla {{Thankyou/ca}} rep els paràmetres {{{reason}}}=ser qui sou i {{{signature}}}=jo del que resulta:

Un petit agraïment... per ser qui sou. Una abraçada, jo

Els paràmetres amb nom distingeixen entre majúscules i minúscules, de manera que:

{{Thankyou/ca|signature=jo|Reason=sent qui ets|reason=distingeix entre majúscules i minúscules}}

produeix:

Un petit agraïment... per distingeix entre majúscules i minúscules. Una abraçada, jo

L'avantatge d'utilitzar paràmetres amb nom a la vostra plantilla, a més de ser flexible en l'ordre que es poden passar els paràmetres, és que fa que el codi de la plantilla sigui molt més fàcil d'entendre si hi ha molts paràmetres.

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 petit agraïment... per supporting both parameter types. Una abraçada, 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 petit agraïment... per supporting both parameter types. Una abraçada, {{{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.

Valors per defecte

See also: m:Help:Parameter default

Si no proporcioneu a una plantilla que transcloeu uns paràmetres que espera, d'aquesta forma:

{{Thankyou/ca}}

en l'exemple dels paràmetres numerats anterior s'arriba al següent:

Un petit agraïment... per {{{1}}}. Una abraçada, {{{2}}}

En el moment que no es passen els arguments, la plantilla presenta els propis paràmetres, en lloc dels seus respectius valors. En aquests casos, pot ser útil definir uns valors predeterminats per als paràmetres, és a dir, uns valors que es faran servir si no se li passa el valor. Per exemple, si el contingut de la plantilla es canviés a:

'''Un petit agraïment...'''
for {{{reason|tot}}}.
Una abraçada, {{{signature|jo}}}

llavors {{{reason|tot}}} defineix que si no es proporciona cap argument per al paràmetre {{{reason}}}, llavors s'utilitzarà el valor per tot. De la mateixa manera, definint {{{signature|jo}}}, el paràmetre per defecte de {{{signature}}} serà jo. Ara, la transclusió de plantilla sense passar cap argument, es tradueix en el següent:

Un petit agraïment... per tot. Una abraçada, jo

El valor d'un paràmetre pot ser una cadena buida. Per exemple, a {{foo|bar=}} o {{foo|bar=|baz=qux}}, la plantilla foo considera que el paràmetre bar és "". Això és diferent d'ometre el paràmetre per complet, cosa que el deixa sense definir i activa el mecanisme de valor predeterminat descrit anteriorment.

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.

Sovint s'utilitzen valors per defecte per especificar noms alternatius de paràmetres. Per exemple, si teniu {{{a|{{{b|}}} }}}, la plantilla buscarà primer un paràmetre anomenat "a". Si no està assignat, utilitzarà el paràmetre anomenat "b". Si no s'assigna ni "a" ni "b", no presentarà res.

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/ca }} with no parameters, does not work: {{thankyou2|everything|me}} -> Un petit agraïment... per {{{1}}}. Una abraçada, {{{2}}} .

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

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

then {{thankyou3|everything|me}} -> Un petit agraïment... per everything. Una abraçada, me } works properly.

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 undefined|parameter is defined}}.

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 { for {
  • Use <nowiki>}}</nowiki> or } for }.
• Use [ for [ and ] 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|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|SPACE1=
|bar|SPACE2=Random stuff
|baz|SPACE3=
   |mumble|SPACE4=
  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

See also: Help:Tracking categories

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.

Avaluació

This is an advanced topic which you can skip unless you need it.

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

This has a few consequences:

1. If you have a Template:Start containing {{mytemplate, and a Template:End containing |foo=bar}}, and put {{start}}{{end}} on a page, mytemplate isn't transcluded, because tokens like "|" cannot be added by a template and keep their special meaning in templates. You can still use templates to control the name of a parameter or template, but you cannot split a template call amongst multiple templates.
2. Dead-code elimination: If you make a template call like {{foo|{{DISPLAYTITLE:Bar}} }}, and Template:Foo does not contain {{{1}}}, then the DISPLAYTITLE is not used, since it is only evaluated when needed, and there is no parameter to substitute it into, so it is never evaluated. This usually comes into play when using Extension:ParserFunctions, and can be especially noticed when used in combination with the int: magic word that varies by user language. 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.

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

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

Recursivitat en plantilles

Incloure una plantilla dins d'ella mateixa no farà que MediaWiki entri en una recursivitat infinita. MediaWiki aturarà la recursivitat amb el nom de la plantilla en negreta. Per exemple, si el contingut de Template:Aaaa és a {{Aaaa}} z, es mostrarà com a «a a z z».

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

{{#if:{{{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 -->}}

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

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

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

Taules en paràmetres

Atès que el caràcter (|) i el signe (=) tenen significats diferents en les crides de plantilles i en les infotaules, per utilitzar la codificació wiki de taula en el valor d'un paràmetre de plantilla, generalment cal "escapar" d'aquests caràcters (és a dir, protegir-los de la interpretació com a codi wiki per part de la plantilla) utilitzant seqüències especials:

• la paraula màgica {{!}} incorporada proporciona una versió "escapada" de | des de MediaWiki 1.24
• la paraula màgica {{=}} incorporada proporciona una versió "escapada" de = des de MediaWiki 1.39

Abans de la introducció d'aquestes paraules màgiques, molts wikis utilitzaven plantilles per aconseguir les mateixes coses. On such a wiki, the magic words take precendence over the same-named templates.

Taula d'exemple

A	B	C
A1	B1	C1
A2	B2	C1

Codi de la taula:

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

Codi de taula escapada:

{{{!}} 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
{{!)}}

Control de la inclusió de la plantilla

Per defecte, el contingut d'una plantilla es mostra en la seva totalitat, tant quan s'observa directament com quan s'inclou en una altra pàgina. No obstant això, podeu controlar quines parts es veuran d'una plantilla mitjançant l'ús de les etiquetes $noinclude, $includeonly i $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.

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

Qualsevol cosa entre ‎<noinclude> i ‎</noinclude> es veurà només quan la pàgina de la plantilla s'està veient directament, però no quan està inclosa en una altra pàgina. Això és útil quan es vol incloure text o codi en una plantilla que no vol propagar-se a qualsevol de les pàgines en que s'inclogui, per exemple en:

• Enllaços a categories per tal de categoritzar la pròpia plantilla
• Enllaços interllengua a les plantilles similars en altres idiomes
• Text explicatiu sobre com utilitzar la plantilla

De la mateixa manera, qualsevol cosa entre ‎<includeonly> i ‎</includeonly> es processarà i es mostra només quan s'està incloent a la pàgina, però no quan la pàgina de la plantilla s'està veient directament, i és útil en situacions com ara:

• La categorització de les pàgines que inclouen la plantilla. Nota: en canviar les categories aplicades per una plantilla d'aquesta manera, la categorització de les pàgines que inclouen aquesta plantilla no s'actualitza fins després d'una estona: això és gestionat per la cua de treballs . Per forçar-ne la re-categorització d'una pàgina en particular, obriu aquella pàgina per a l'edició i guardeu-la sense canvis.
• Assegurar-se que el codi de la plantilla no s'executa quan es veu la pàgina de plantilla per se. Normalment, això es deu al fet que espera paràmetres, i la seva execució sense paràmetres té un resultat no desitjat.

Tot el que estigui fora de les etiquetes ‎<noinclude> i ‎<includeonly> es processa i es mostra normalment; és a dir, tant quan la pàgina de la plantilla s'està veient directament com quan la plantilla està inclosa en una altra pàgina. L'atenció és en el que és dins d'aquestes dues etiquetes.

En la transclusió es rebutja tot allò que és fora d'etiquetes ‎<onlyinclude>. Fins i tot s'hi rebutgen les seccions que estiguin etiquetades com a includeonly llevat que també estiguin etiquetades com a onlyinclude. L'atenció és en el que és fora d'aquesta etiqueta.

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.

Aquestes etiquetes també es poden imbricar.

Les tres etiquetes de transclusió parcials permeten totes les combinacions possibles del que es processa i es representa. Els comentaris també hi juguen un paper. 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|1}}}|1|
== 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.

Organització de les plantilles

Per tal de que les plantilles siguin eficaces, els usuaris necessiten poder-le trobar, i saber com usar-les.

Per trobar-les, els usuaris poden:

1. Clicar Pàgines especials > Totes les pàgines
2. En la llista de Espai de noms:, escollir Template i clicar Vés-hi.

Per donar una informació d'ús, inclourem un exemple com aquest en la pàgina de la plantilla:

<noinclude>
== Ús ==
Benvinguda als usuaris:
{{Thankyou|raó=la vostra raó|signatura=la vostra signatura}}
</noinclude>

Llavors, un editor pot simplement copiar i enganxar l'exemple per utilitzar-ho en la plantilla.

While editing a page, a list of all templates used is available under the editing form, in a collapsible section titled "Aquesta pàgina fa servir les següents plantilles:" (also named "Plantilles usades en aquesta previsualització:", or "Plantilles usades en aquesta secció:" 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.

Enllaçar amb una plantilla

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

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 {{tl|Navbar}} may be used to create the link {{Navbar }}.

This construct is commonly used when referring to templates in template documentation, on help pages, and on talk pages. The same effect can be achieved by using {{[[Template:Navbar|Navbar]]}}, 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 or as monospace type. If not (as on this wiki), another similarly named template may do so. See, for example, the "See also" section of our Template:Tl documentation.

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.

Còpia d'un wiki a un altre

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.

Les plantilles sovint requereixen CSS o altres plantilles, perquè els usuaris sovint tenen de problemes en copiar plantilles d'un wiki a un altre. Els següents passos haurien de funcionar per a la majoria de les plantilles.

Codi de MediaWiki

Si teniu drets d'importació (específicament importupload) en la nova wiki:

1. Aneu a Special:Export del wiki original, i descarregueu un fitxer .xml amb la història completa de totes les plantilles necessàries, com segueix:
   • Entreu el nom de la plantilla en el quadre de text gran, per exemple, "Plantilla:Benvinguda". Pareu especial atenció a les majúscules i els caràcters especials — si el nom de la plantilla no és exactament igual, l'exportació es pot seguir produint, però el fitxer .xml no tindrà les dades esperades.
   • Seleccioneu la casella "Inclou les plantilles".
   • Seleccioneu la casella "Inclou només la versió actual, sense l'historial complet".
   • Cliqueu "Exporta".
2. Aneu a Special:Import en el nou wiki i carregueu el fitxer .xml.

Si no té els drets d'importació sobre el nou wiki:

1. Aneu a la plantilla que voleu copiar del wiki original. Aneu a la pàgina d'edició, i copieu tot el text wiki.
2. En el nou wiki, aneu a la pàgina amb el mateix nom que la plantilla que heu copiat. Premeu Crea/edita i enganxeu el wikitext que heu copiat. Al resum d'edició de cada plantilla, enllaça a la pàgina original per a l'atribució.
3. De tornada al wiki original i en la finestra d'edició, per sota de la caixa d'edició, mireu la llista de "Plantilles usades en aquesta pàgina". Per a cada plantilla que apareix, seguiu aquestes instruccions. També ho heu de fer per a cadascuna de les plantilles utilitzades per cadascuna d'aquelles plantilles, i així successivament.

Això copiarà tot el codi necessari i serà suficient per a la majoria de plantilles. Note that only page elements parsed in rendering the page get exported, consequently documentation subpages are not exported as part of this process. Si no funciona, comproveu si hi ha enllaços vermells a la llista «Pàgines transcloses a la versió actual d'aquesta pàgina:», a sota del quadre d'edició. Si n’hi ha, repetiu els passos anteriors també i copieu el codi als mòduls.

Després d'importar de l'altre wiki la plantilla i totes les plantilles amb què enllaça, modifiqueu-la per adaptar-la al vostre wiki. Per exemple, per canviar un logo o treure categories redundants o enllaços vermells.

Extensions

Una extensió d'ús freqüent en les plantilles és ParserFunctions. Visiteu la pàgina de Extension:ParserFunctions i comproveu si alguna de les funcions enumerades no s'utilitzessin en les plantilles que hàgiu copiat. Si és així, heu d'instal·lar l'extensió Extensió:ParserFunctions . Per instal·lar-la, heu de tenir accés d'administrador al servidor del MediaWiki.

Una altra dependència que es pot utilitzar en les plantilles, especialment en les de la Viquipèdia, és Lua. Tenir {{#invoke: }} en el codi de plantilla és un bon senyal de que es necessitarà Lua. En cas que s'utilitzi, cal instal·lar es requereix l'extensió Scribunto i també caldrà accés d'administrador. Mireu aquella pàgina per obtenir més instruccions sobre la instal·lació i l'ús de l'extensió.

CSS i codi JavaScript

A més de codi de MediaWiki, moltes plantilles fan ús de CSS i algunes es basen en JavaScript per funcionar plenament. Si les plantilles copiadss no es comporten com s'espera, això en pot ser la causa. Per copiar el CSS i el JavaScript al wiki haureu de tenir privilegis d'administrador, perquè haureu d'editar els missatges del sistema en l'espai de noms "MediaWiki:".

1. Busqueu l'ús de classes CSS (text com class="foobar") en el text de la plantilla. Si aquestes classes apareixen en "MediaWiki:Common.css" o "MediaWiki:Monobook.css" al wiki original, copieu-les amb "MediaWiki:Common.css" al nou wiki i comproveu si la plantilla ara va bé.
2. Si la plantilla copiada encara no funciona com s'espera, comproveu si hi ha codi en "MediaWiki:Common.js" o "MediaWiki:Monobook.js" al wiki original. Si és així, vostè podeu intentar copiar-lo en "MediaWiki:Common.js" del nou wiki. Normalment, és una bona idea només copia el codi de fonts de confiança, i la primera vegada buscar en el codi per identificar i seleccionar les parts que són rellevants. Podeu trobar comentaris que poden servir com a pistes per identificar les funcions de cada part.

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

Main page: 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

Vegeu també

General template usage

• m:Help:Calculation
• Help:Substitution
• w:Help:Template – a little more detail than here
• m:Help:Advanced templates – descriu les tècniques fins i tot més avançades, com les crides de plantilla dinàmica i variables
• Help:Multiple-instance templates - on the use of multiple instances of the same template on a page.
• m:Help:Parameter default
• m:Help:Template documentation
• w:WP:Template documentation
• m:Help:Newlines and spaces#Automatic newline

Special constructs used in templates

• Help:Paraules màgiques – coses de luxe que es troben en algunes plantilles
• Help:Extension:ParserFunctions – més funcions de control sofisticades, com ara #if i #switch
• Help:Parser functions in templates – ajuda sobre com utilitzar les funcions d'analitzador a les plantilles
• Help:TemplateData
• Help:Extension:Parser Functions
• Extension:Scribunto

Other relevant information

• Help:ExpandTemplates
• Help:Cerques externes – un exemple d'ús especial de plantilla
• Manual:Importing Wikipedia infoboxes tutorial
• Extension:PageTemplates
• Manual:Creating pages with preloaded text – Using templates as the starting text of a page
• Help:Transclusió – incrustar pàgines de espais de noms que no siguin Plantilla:
• Manual:Template limits
• Ajuda:Què hi enllaça
• Special:Mostlinkedtemplates - shows the templates with the most uses
• Special:Unusedtemplates - shows templates with no uses (although they may be substituted)
• Manual:$wgEnableScaryTranscluding (using templates from other wikis)
• w:WP:Anatomy of a template
• w:Wikipedia:Transclusion costs and benefits
• Manual:Parser.php
• Help:Extension:TemplateSandbox for previewing your changes to a template as it renders elsewhere

External links

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