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 utilitzats en altres pàgines en les següents formes:


 * - com es descriu més amunt, l'enllaç serà reemplaçat de forma dinàmica el contingut actual de Plantilla:Nom en el moment en què es carrega la pàgina amb l'enllaç de la plantilla. L'enllaç es mantindrà sense canvis en la font de la pàgina.
 * - quan s'utilitza aquest enllaç de plantilla, serà reemplaçat una vegada per totes amb el contingut de Plantilla:Nom a partir del moment en què es desa la pàgina amb l'enllaç: una còpia de la contingut de Plantilla:Nom serà substituït per l'enllaç de la plantilla. El contingut és llavors una part de la pàgina, incloent, i es poden editar amb normalitat, per separat dels originals. Nota: els canvis posteriors en la pàgina de la plantilla d'origen no es propagaran a la pàgina amb l'enllaç de la plantilla.
 * — això es va introduir per permetre la substitució que no es trenqui la transclusió, mireu w:en:Help:Substitution.
 * inclou la plantilla en una forma que la mostra com la sintaxi del wiki primera (la forma  fa) quan la pàgina que la conté està desgavellada.

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:


 * inclou
 * inclou
 * inclou
 * es reemplaça amb el contingut de

Si no hi ha tal espai de noms, el títol complet se suposa que és una plantilla:


 * inclou

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.

Així que la nota serà similar a tot arreu que s'utilitzi, es pot definir, per exemple, una plantilla anomenada Template:Thankyou, que per a aquesta versió d'ajuda (en català), i per semblança a les altres wikis, serà Template:Thankyou/ca, tot i que haguéssim pogut establir una redirecció. Encara que la nota hagi de ser similar cada vegada que un usuari doni gràcies a un altre usuari, el seu contingut específic (és a dir, la raó i la signatura) serà diferent. Per aquesta raó, el contingut ha de passar com a paràmetres. Si deixem de banda els elements restants per donar format a la caixa i col·locar la imatge, el contingut bàsic de la plantilla és la següent:

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 anònims, 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:

Nota: La identificació de paràmetres per ordre (amb, etc.) només funciona amb els paràmetres anònims. Qualsevol paràmetre identificat per nom, com es mostra a continuació, no estarà accessible per a la plantilla que utilitzi números ordinals.

Nota: 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 16235). 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:

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

Paràmetres amb nom
La tercera via per passar paràmetres és pel seu nom, en lloc de nombres (nota: els paràmetres amb nom són sensibles a caixa). 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:

L'avantatge d'utilitzar paràmetres amb nom a la plantilla, a més de també fer-la més flexible en l'ordre dels paràmetres que es poden passar, 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:

Ordre d'avaluació
Els paràmetres de les plantilles s'avaluen del tot abans que es passin a la plantilla. Així que si un dels vostres paràmetres és una crida a una altra plantilla, és el paràmetre expandit el que es passa en realitat.

esdevé abans d'esdevenir:

En uns pocs casos, aquest ordre d'avaluació comporta una diferència respecte de l'alternativa. (L'alternativa és comprovar els resultats de la crida a la plantilla per veure si hi ha plantilles addicionals a expandir.)

En primer lloc, el nom de la plantilla es pot expandir alhora que els paràmetres i de la mateixa manera.

Així, es podria expandir a De manera que una plantilla anomenada  mostraria les gràcies en la llengua preferida (tant se val com s'hagués determinat).

En segon lloc, la plantilla que s'està cridant no pot construir una plantilla a partir de peces que s'han de cridar després. Per exemple, una plantilla que prengués la forma no funcionaria si fos i fos.

En tercer lloc, el paràmetre que es passa només s'expandeix un cop, i no en cada posició on apareix a la plantilla. Això és més eficient per al servidor MediaWiki.

Finalment, la plantilla que s'està cridant no pot evitar que el paràmetre s'expandeixi. Encara que una plantilla només utilitzi un paràmetre en alguna circumstància, el paràmetre sempre haurà estat expandit abans que es fes la crida.

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 "Template:Aaaa".

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 contingut d'aquestes dues etiquetes.

En la transclusió es rebutja tot allò que és fora d'etiquetes. Even sections tagged includeonly are discarded in the transclusion unless they are also tagged as onlyinclude. The focus is on what is outside this tag.

Nesting of these tags is also possible.

The three partial transclusion tags enable all possible combinations of what is processed and rendered. Comments also fill a role.

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.

Linking to a template
To link to a template instead of including it, use the tl template. The name of the template the editor wants to link to goes after the vertical pipe. For example: links to the navbar template.

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) * Marqueu la casella "".
 * 4) * Desactiveu 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.

Això copiarà tot el codi necessari i serà suficient per a la majoria de plantilles. If it doesn't work also check for red links listed under "Pages transcluded onto the current version of this page:", below the edit box. If there are any repeat the above steps for these as well.

After successfully importing the template and all its linked templates from the other wiki, edit it to change customisations to suit your wiki. For example to change a logo, remove redundant categories or red links.

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.

Vegeu també

 * – un exemple d'ús especial de plantilla
 * – coses de luxe que es troben en algunes plantilles
 * - additional fancy control functions such as #if and #switch
 * - guidance on using parser functions in templates
 * 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
 * m:Help:Embed page – incrustació de les pàgines dels espais de noms diferents de.
 * Extension:PageTemplates
 * Extension:PageTemplates
 * Extension:PageTemplates
 * Extension:PageTemplates