Help:Plantilles

From MediaWiki.org
Jump to: navigation, search
This page is a translated version of the page Help:Templates and the translation is 94% complete.

Other languages:
العربية • ‎بلوچی مکرانی • ‎български • ‎català • ‎Deutsch • ‎Zazaki • ‎English • ‎British English • ‎español • ‎suomi • ‎français • ‎עברית • ‎Bahasa Indonesia • ‎italiano • ‎日本語 • ‎한국어 • ‎Lëtzebuergesch • ‎Nederlands • ‎polski • ‎پښتو • ‎português • ‎português do Brasil • ‎română • ‎русский • ‎slovenčina • ‎தமிழ் • ‎Türkçe • ‎Tiếng Việt • ‎中文 • ‎中文(台灣)‎
PD Nota: Si editeu aquesta pàgina, esteu acceptant que la vostra actualització contribueixi en el marc de les CC0. Mireu Pàgines d'Ajuda de Domini Públic per a més informació.
PD

Si teniu textos estàndard que voldríeu incloure en diverses pàgines, la funció de plantilles MediaWiki entra en joc. Unlike extensions and media files, there is no central repository for templates. 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.

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

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

Ús

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

  • {{Nom}} - 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.
  • {{subst:Nom}} - 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.
  • {{safesubst:Nom}} — això es va introduir per permetre la substitució que no es trenqui la transclusió, mireu w:en:Help:Substitution#The safesubst: modifier.
  • {{msgnw:Nom}} inclou la plantilla en una forma que la mostra com la sintaxi del wiki primera (la forma <nowiki> 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:

  • {{Plantilla:NomDePàgina}} inclou [[Plantilla:NomDePàgina]]
  • {{Foo:NomDePàgina}} inclou [[Foo:NomDePàgina]]
  • {{:NomDePàgina}} inclou [[NomDePàgina]]
    • {{subst::NomDePàgina}} es reemplaça amb el contingut de [[NomDePàgina]]

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

  • {{Foo:Bar}} inclou [[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:

Flors d'exemple
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.

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

Flors d'exemple
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:

Flors d'exemple
Un petit agraïment...
per Jo.
Una abraçada, tot el vostre esforç


Nota: la identificació de paràmetres per ordre (amb {{{1}}}, 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:

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

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

Flors d'exemple
Un petit agraïment...
per vostra amistat.
Una abraçada, Jo


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 {{{raó}}}.
Una abraçada, {{{signatura}}}

Dins de la plantilla, fem servir {{{raó}}} i {{{signatura}}} 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:

{{Thankyou/ca|signatura=Jo|raó=ser qui ets}}

En aquest cas, la plantilla {{Thankyou/ca}} rep els paràmetres {{{raó}}}=ser qui ets i {{{signatura}}}=Jo del que resulta:

Flors d'exemple
Un petit agraïment...
per ser qui ets.
Una abraçada, Jo

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:

{{Thankyou/ca}}

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

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


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 {{{raó|cada cosa}}}.
Una abraçada, {{{signatura|Jo}}}

llavors {{{raó|cada cosa}}} defineix que si no hi ha cap paràmetre {{{raó}}}, llavors s'utilitzarà el valor per cada cosa. De la mateixa manera, definint {{{signatura|Jo}}}, el paràmetre per defecte de {{{signatura}}} serà Jo. Ara, la transclusió de plantilla sense passar cap paràmetre, es tradueix en el següent:

Flors d'exemple
Un petit agraïment...
per cada cosa.
Una abraçada, Jo


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

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.

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 Special pages > All pages
  2. En la llista de Namespace:, escollir Template i clicar Go.

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.

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:
    • 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.
    • Marqueu la casella "Include templates".
    • Desactiveu la casella "Include only the current revision, not the full history".
    • Cliqueu "Export".
  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 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 sucessfully 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 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ó 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. Look for the use of CSS classes (text like class="foobar") in the template text. If those classes appear in "MediaWiki:Common.css" or "MediaWiki:Monobook.css" on the original wiki, copy those classes to "MediaWiki:Common.css" on the new wiki and check if the template is now fine.
  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é