Help:Templates/ca

Si teniu textos estàndard que voldríeu incloure en diverses pàgines, la funció de plantilles MediaWiki entra en joc.

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

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

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. Si la seva pàgina identifica qualsevol paràmetre per número o nom, com es mostra a continuació, aquest mètode ja no estarà disponible per a la plantilla que els rep.

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, 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 pot canviar per:

Un petit agraïment... for. 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-li:

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

llavors  defineix que si no hi ha cap 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 paràmetre, es tradueix en el següent:

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.

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:

Usage
Welcome users:

Then, an editor can simply copy and paste the example to use the template.

Còpia d'un wiki a un altre
Templates often require CSS or other templates, so users frequently have trouble copying templates from one wiki to another. The steps below should work for most templates.

Codi de MediaWiki
If you have import rights (Specifically importupload) on the new wiki:
 * 1) Go to Special:Export on the original wiki, and download an .xml file with the complete history of all necessary templates, as follows:
 * 2) * Enter the name of the template in the big text box, e.g. "Template:Welcome". Pay special attention to capitalization and special characters — if the template name isn't exactly correct, the export may still occur but the .xml file will not have the expected data.
 * 3) * Check the box "".
 * 4) * Uncheck the box "".
 * 5) * Click "".
 * 6) Go to Special:Import on the new wiki and upload the .xml file.

If you don't have import rights on the new wiki:


 * 1) Go to the template you want to copy from the original wiki. Go to the edit page, and copy all the wikitext
 * 2) 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.
 * 3) 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.

This will copy the entire code necessary, and will suffice for some templates.

Extensions
An extension often used in templates is ParserFunctions. Visit page and check if any of the functions listed there are used in the templates you've copied. If so, you have to install the. To install it, you'll need system admin access to the server of your MediaWiki installation.

Another dependency that may be used in templates, especially those on Wikipedia, is Lua. Having  in template code is a good sign for it. In case it's used, you need to install the and system admin access is required too. See that page for more instructions about installing and using the extension.

CSS i codi JavaScript
Besides MediaWiki code, many templates make use of CSS and some rely on JavaScript to work fully. If the copied templates are not behaving as expected, this may be the cause. To copy the required CSS and JavaScript to your wiki you'll normally need to have admin privileges, because you'll be editing system messages in the "MediaWiki:" namespace.


 * 1) Look for the use of CSS classes (text like  ) in the template text. If those classes appear in "MediaWiki:Common.css" or "MediaWiki:Monobook.css" on the original wiki, copy them to "MediaWiki:Common.css" on the new wiki and check if the template is now fine.


 * 1) If the copied template is still not working as expected, check if there is code in "MediaWiki:Common.js" or "MediaWiki:Monobook.js" on the original wiki. If so, you can try copying it to "MediaWiki:Common.js" on the new wiki. Normally, it is a good idea to only copy code from trusted sources, and first browsing the code to identify and select the parts that are relevant. You may find comments that can serve as clues to identify the functionality of each part.

Vegeu també

 * Special:MyLanguage/Help:External searches – a template special use case example
 * Special:MyLanguage/Help:Magic words – fancy stuff you may find in some templates
 * Special:MyLanguage/Help:Parser functions in templates
 * – contains a much more thorough manual on how exactly templates function
 * – describes even more advanced techniques such as dynamic template calls and variable variables
 * – embedding pages from namespaces other than.