Help:Templates/ca

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ó.

Creació
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 " ", assignant-lo a aquest espai de noms; a més d'això, podeu crear-les com qualsevol altra pàgina wiki.

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:

en qualsevol altra pàgina, quan aquesta pàgina es vegi el text "Hola! Benvinguts al wiki." apareixerà en lloc de. 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  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.

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


 * — 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.
 * — 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").
 * : 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 per a més informació.
 * : mostra el contingut de la plantilla com a sintaxi wiki en brut (com ho fa ) quan es visualitza la pàgina que la conté.

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:


 * transclou la pàgina titulada Plantilla:NomDePàgina (equivalent a )
 * transclou la pàgina titulada Discussió:NomDePàgina
 * transclou la pàgina anomenada NomDePàgina (és a dir, a l'espai de noms principal)
 * 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:


 * transclou Plantilla:Foo:Bar

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:

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

Observeu l'ús de  i. 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:

En aquest cas, la plantilla  rep els paràmetres   i , del que resulta:

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

donaria el següent resultat:



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

Aquesta vegada, la plantilla  rep els paràmetres   i , tot i que s'han proporcionat en ordre invers, i produeix:


 * Exemples:

produeix:



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. Una abraçada,

Dins de la plantilla, fem servir  i   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:

En aquest cas, la plantilla  rep els paràmetres   i   del que resulta:

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

produeix:

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.



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

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

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:

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

Sovint s'utilitzen valors per defecte per especificar noms alternatius de paràmetres. Per exemple, si teniu, 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.

Avaluació
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. First of all, if you have a  containing , and a   containing  , and put   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.

The second consequence of this is dead-code elimination. If you make a template call like, and Template:Foo does not contain  , 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  magic word that varies by user language.

Template calls starting with the magic word  or   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,  calls are ignored, and   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, es mostrarà com a «a a Template loop detected:  Template:Aaaa z z».

Forbidden idiom
This safeguard precludes a potentially useful template idiom where a template self-normalizes its own calling arguments. In this forbidden example  can either be called   or. 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  is modified to recurse into   and   is an identical manual copy of   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   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
Codi de la taula:

Codi de taula escapada:

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 and. On such a wiki, the code can be simplified a bit to this form:



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, i.

Qualsevol cosa entre i  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 i  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 . 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 i  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. 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.

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.



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 ' > '
 * 2) En la llista de ', escollir Template i clicar '.

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

Ús
Benvinguda als usuaris:

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 "" (also named "", or "" 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.

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

This construct is commonly used when referring to templates in template documentation, on help pages, and on talk pages. The same effect can be achieved by using, but the   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.



Còpia d'un wiki a un altre
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:
 * 2) * 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.
 * 3) * Seleccioneu la casella "".
 * 4) * Seleccioneu la casella "".
 * 5) * Cliqueu "".
 * 6) 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 de la wiki originals. 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. Llavors creeu la pàgina i editeu i enganxeu el text wiki copiat. En el resum d'edició de cada plantilla, enllaceu l'atribució a la pàgina original.
 * 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.
 * 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.

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 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ó. 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   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ó 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  ) 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.



General template usage

 * w:Help:Template – a little more detail than here
 * m:Help:Template – conté un manual molt més a fons sobre la funció de les plantilles
 * m:Help:Advanced templates – descriu les tècniques fins i tot més avançades, com les crides de plantilla dinàmica i variables

Special constructs used in templates

 * – coses de luxe que es troben en algunes plantilles
 * – més funcions de control sofisticades, com ara #if i #switch
 * – ajuda sobre com utilitzar les funcions d'analitzador a les plantilles

Other relevant information

 * – un exemple d'ús especial de plantilla
 * – Using templates as the starting text of a page
 * – incrustar pàgines de espais de noms que no siguin
 * – Using templates as the starting text of a page
 * – incrustar pàgines de espais de noms que no siguin
 * – incrustar pàgines de espais de noms que no siguin