Tweet

Ajuda:Plantilles

De TarracoWiki

Les plantilles són pàgines que pertanyen a l'espai de noms Plantilla: (també en anglès Template:, nom vàlid a tots els projectes) i es fan servir per incloure fitxes o models comuns als articles. El seu contingut es pot reutilitzar en tots els articles que vulguem, sense tornar a introduir el codi.

En realitat, qualsevol pàgina de la TarracoWiki es pot utilitzar com a plantilla, però és molt recomanable crear-les en l'espai de noms Plantilla: per a una bona separació dels tipus de pàgines (articles, discussions, ajuda, viquipèdia, plantilles).

Contingut

1 Ús d'una plantilla
2 Plantilles disponibles
- 2.1 Creació d'una plantilla
3 Paràmetres: Afegir dades a la plantilla
4 Etiquetes <noinclude> i <includeonly>
5 Vegeu també

Ús d'una plantilla

Si volem emprar una plantilla que està desada amb el nom Plantilla:nom-de-la-plantilla per a incloure-la dins d'un article, s'ha d'escriure {{nom-de-la-plantilla}} sense necessitat d'escriure Plantilla: davant del nom.

En general, aquest és l'ús més habitual de les plantilles i el recomanat, ja que l'espai d'edició en edicions posteriors resulta més diàfan. Un cop desats els canvis, qualsevol canvi en la plantilla es reflectirà en el canvi de la pàgina.

Hi ha casos especials d'ús de la plantilla. Si es tracta de que es visualitzin tots els continguts d'altres pàgines, hem d'escriure el nom complet, i els dos punts per als articles. Per exemple:

{{TarracoWiki:Categories}}: inclou el contingut de TarracoWiki:Categories.

{{:Portada}}: inclou el contingut de la Portada.

En tots aquests casos, el codi del nostre article conté solament la referència a la plantilla. Si el que volem és copiar el contingut de la plantilla dintre l'article per a editar-lo, hem d'escriure

{{subst:nom-de-la-plantilla}}.

Plantilles disponibles

Si ja sabem com utilitzar les plantilles i volem conèixer les que estan a la nostra disposició a la TarracoWiki, visita Categoria:TarracoWiki:Plantilles i TarracoWiki:Plantilles.

Creació d'una plantilla

Les plantilles es creen i editen igual que els articles, amb la particularitat de que el nom ha de començar amb Plantilla:. Actualment es disposa d'un bon nombre de plantilles. Abans d'iniciar una plantilla nova verifiquem que no existeixi ja alguna amb la mateixa funció. Es recomana triar un nom curt però amb sentit, perquè es pugui recordar fàcilment. Les plantilles es categoritzen en alguna de les categories dintre de Categoria:TarracoWiki:Plantilles. Si la sintaxi de la plantilla és complexa, com en el cas de la plantilla {{Fitxa dades}}, es recomana incloure una descripció del seu ús, afegint després del codi de la plantilla, al final de la pàgina, la següent expressió:

<noinclude>{{Documentació}}</noinclude>

Desem la plantilla. Un cop desada apareixerà un marcador addicional que ens ha de permetre crear una subpàgina de documentació. En aquesta subpàgina podem afegir la informació d'ús de la plantilla, així com una explicació dels usos previstos per a la plantilla, altres plantilles i pàgines de l'espai TarracoWiki que s'hi relacionen, les categories, etc... Aquesta pàgina va associada amb la pàgina principal de la plantilla, de manera que si algun cop es decideix reanomenar la pàgina principal aquesta també es reanomenarà i no es perdrà. Aquesta dissociació permet editar la informació d'ús de la plantilla sense haver d'editar la plantilla separant les edicions sobre el codi propi del funcionament de la plantilla amb les edicions relatives a les instruccions d'ús.

Per un exemple vegem: Plantilla:Comarca i Plantilla:Comarca/doc

Paràmetres: Afegir dades a la plantilla

Sovint, les plantilles es poden "personalitzar" per a cada article on vagi inserida: en diem afegir paràmetres. La manera en que cada plantilla tracta els paràmetres és una qüestió de disseny i funcionament de cada plantilla.

Incloure una plantilla amb paràmetres

Ens podem trobar amb dos formes d'utilitzar plantilles amb paràmetres, que dependran de com han estat creades:

1. {{nom-de-la-plantilla|paràmetre-1|paràmetre-2|...}}:

Fixem-nos que per separar paràmetres es fa servir el símbol | que podem trobar sota de l'espai d'edició quan estem editant articles, i que els paràmetres han de ser introduïts separant-los per aquest símbol.

Exemple paràmetres simple
Amb un exemple s'entén millor: La Plantilla:Us, accepta un paràmetre, el nom d'usuari que volem que aparegui com enllaç a la seva plana personal. Com s'ha vist abans, per a fer aparèixer la plantilla Us afegim el següent text a l'article `{{Us}}`. Per afegir el paràmetre amb l'usuari concret, escriurem per exemple `{{us\|Fritz Lang}}` i apareixerà de la següent manera: Fritz Lang

2. {{nom-de-la-plantilla|paràmetre-1 = valor-1|paràmetre-2 = valor-2|...}}:

Els paràmetres obligatòriament tenen un nom seguit del símbol '=' amb el valor que assignem. D'aquesta manera, l'ordre d'introducció dels paràmetres no és significatiu i ens assegurem de quin valor estem assignant a cada paràmete.

Exemple paràmetres amb nom
Consulta la plantilla {{Persona}} per veure el funcionament.

Consulta dels paràmetres de cada plantilla

Podem conèixer quins tipus de paràmetres accepta una plantilla, quines funcions genera cada paràmetre i com incloure aquestes funcions visitant la seva pàgina de descripció. Hi ha plantilles que requereixen obligatòriament la inclusió d'algun tipus de paràmetre, n'hi ha en que no és obligatori i fins i tot n'hi ha que no en tenen definits.

Utilitzar els paràmetres dins la plantilla

Dintre de la pàgina de descripció de la plantilla, cada paràmetre s'inclou escrivint el seu número entre claus triples:

{{{1}}} - és el primer paràmetre.

{{{2}}}, {{{3}}}, ... - la resta de paràmetres.

O bé, si utilitzem la sintaxi amb nom de paràmetres:

{{{paràmetre-1}}} - seria el paràmetre amb aquest nom.

Etiquetes <noinclude> i <includeonly>

Les etiquetes <noinclude> i <includeonly> serveixen per determinar quina part de la plantilla no serà inclosa quan es faci servir en un article (noinclude), o mostrada només quan la plantilla sigui inclosa (includeonly).

Són molt útils perquè permeten tractar les plantilles com la resta d'articles:

noinclude permet:
- Categoritzar la plantilla.
- Fer-hi enllaços interwiki
- Afegir-hi instruccions d'ús
includeonly permet:
- Afegir tots els articles que incloguin la plantilla a una categoria, però sense afegir la plantilla a aquesta categoria.

Sense aquestes etiquetes, tots el continguts de la plantilla serien inclosos a l'article que la referenciés.

Exemple de creació de plantilla
<includeonly>El nom de la ''cosa'' és: '''{{{nom}}}'''[[Categoria:Coses]]</includeonly><noinclude> ==Instruccions d'ús de la plantilla "nom de la cosa"== {{nom_de_la_cosa \| nom = \|}} [[Categoria:Exemples]]</noinclude>

En aquest exemple les instruccions d'ús no seran incloses a l'article que faci servir aquesta plantilla, i aquest article no s'inclourà en la categoria "Exemples" gràcies a les etiquetes <noinclude>.

L'article que faci servir aquesta plantilla s'inclourà a la categoria "Coses", però no la mateixa plantilla. A més, quan algú llegeixi la pàgina de la plantilla no li serà mostrat el codi que fa que la plantilla funcioni, haurà d'editar-la per veure-ho, donat que està dins de les etiquetes <includeonly>.

Atenció: qualsevol espai o salt de línia entre el codi de la plantilla i l'etiqueta <noinclude> s'inclourà en els articles que la facin servir.