View source for Plantilla:Ús de la plantilla/ús

<noinclude>{{Subpàgina d'ús}}</noinclude><!-- a diferència de l'ús normal, aquesta subpàgina s'inclou de forma diferent i necessita aquestes etiquetes-->
<!-- SI US PLAU,
     AFEGIU CATEGORIES I INTERWIKIS AL FINAL D'AQUESTA PÀGINA -->	
Aquesta plantilla, {{tl|Ús de la plantilla}}, permet documentar la informació d'ús de les plantilles. 

Per a la majoria de les instruccions sobre com i quan utilitzar aquesta plantilla, vegeu [[Viquipèdia:Documentació de plantilles]].

Aquesta plantilla mostra una caixa de color, com la que esteu veient, i carrega el contingut d'una subpàgina /ús. També pot carregar altres continguts segons els paràmetres.

El propòsit és documentar la informació d'ús de les plantilles i altres pàgines que s'usen transcloses. Normalment s'utilitzarà en l'espai de noms de plantilles, però també es pot utilitzar en altres [[Viquipèdia:espai de noms||espais de noms]] que permetin crear subpàgines.

L'ús d'aquesta plantilla permet separar el codi propi de la plantilla del text d'informació. Així les plantilles sensibles o d'alt ús es poden [[Viquipèdia:Pàgina protegida|protegir]] i, alhora, es permet que qualsevol usuari pugui modificar la documentació, categories i enllaços interwiki.

==Ús==
Normalment aquesta plantilla s'utilitza sense paràmetres, al final de la plantilla o de la pàgina de codi, entre etiquetes <code>&lt;noinclude></code>:

<pre>
<!--Última línia de codi de la plantilla--><noinclude>
{{ús de la plantilla}}
<!-- Afegiu categories i interwikis en la subpàgina /ús, no aquí! -->
</noinclude>
</pre>

Llavors aquesta plantilla carrega automàticament el contingut de la subpàgina /ús corresponent a la plantilla on s'estigui usant.

Aquesta plantilla també pot carregar el contingut d'una altra pàgina:

<pre>
<!--Última línia de codi de la plantilla--><noinclude>
{{ús de la plantilla|Plantilla:Una altra pàgina/ús}}
</noinclude>
</pre>

Cal notar que en carregar el contingut d'una pàgina diferent a la subpàgina local /ús llavors resulta complicat gestionar els enllaços de categories i interwikis.

El contingut també es pot proporcionar directament com a text:

<pre>
<!--Última línia de codi de la plantilla--><noinclude>
{{ús de la plantilla|contingut=
Text de documentació.
}}
</noinclude>
</pre>

Quan s'utilitza el paràmetre {{para|contingut}}, la caixa de documentació normalment no mostrarà els enllaços com [modifica] [refresca] a l'encapçalament. Si existeix igualment la subpàgina /ús apareixerà en els enllaços al peu de la pàgina.

El paràmetre {{para|1}} i el paràmetre {{para|contingut}} també es poden combinar:

<pre>
<!--Última línia de codi de la plantilla--><noinclude>
{{ús de la plantilla
|1=Plantilla:Pàgina/ús
|contingut=
{{Plantilla:Pàgina/ús |paràmetres}}
}}
</noinclude>
</pre>

La pàgina proporcionada com a paràmetre 1 és usada pels enllaços [mostra] [modifica] i els enllaços al peu de la caixa. El paràmetre "contingut" s'utilitza pel contingut mostrat a la caixa. En l'exemple, es mostra el contingut depenent d'uns paràmetres.

== Bones pràctiques ==
El codi cal afegir-lo a continuació de l'última línia de la plantilla, sense espais ni salts de línia abans de <code><nowiki><noinclude></nowiki></code> ja que aquests espais o salts de línia s'inclourien en les pàgines on s'utilitzi la plantilla provocant efectes inesperats.

Quan no existeix la subpàgina /ús, aquesta plantilla proporciona un enllaç [crea]. També es pot crear amb la pestanya "Documentació" que apareix en l'espai de plantilles. En crear-la s'afegeix un text en precàrrega proporcionat per {{tl|ús de la plantilla/precàrrega}}. Si no existeix la subpàgina "/ús" categoritza la plantilla a [[:Categoria:Plantilles sense informació d'ús]]. Si es crea primer la pàgina de codi posant <nowiki>{{ús de la plantilla}}</nowiki> d'entrada queda categoritzada. Si després es crea la subpàgina /ús, cal esperar a una actualització per a que tregui la categoria o bé fer alguna modificació en la pàgina de codi que forci regenerar les inclusions. L'actualització de categories posades a través de plantilles no sempre és immediata. La recomanació és primer crear la subpàgina de documentació i desprès posar <nowiki>{{ús de la plantilla}}</nowiki> a la pàgina de codi.

Les categories i els enllaços interwiki corresponents a la pròpia plantilla s'haurien d'afegir al final de la subpàgina /ús, entre les etiquetes <code><nowiki><includeonly>...</includeonly></nowiki></code>.

Aquesta plantilla detecta automàticament si existeix una protecció. En aquest cas afegeix la plantilla {{tl|plantilla protegida}}. Vegeu la documentació d'aquesta plantilla per a més informació.

== Títol ==
El títol per defecte de la caixa és:
:[[Fitxer:Template-info.png|32px]] '''Documentació de la plantilla'''

Es pot utilitzar el paràmetre {{para|títol}} per canviar-lo:
:<code><nowiki>{{ús de la plantilla |títol=Documentació de la infotaula}}</nowiki></code>

Si el paràmetre està definit però buit llavors no es mostra cap títol ni tampoc els enllaços en l'encapçalament.

Amb el paràmetre {{para|estil-títol}} es poden canviar els valors CSS, per exemple::
:<code>estil-títol = color: red; font-size: 150%;</code>

== Enllaços a peu de pàgina ==
A peu de pàgina es mostra una petita caixa amb alguns enllaços sobre la documentació. Aquests enllaços poden canviar segons els paràmetres i segons l'espai de noms.

El contingut es pot modificar amb el paràmetre {{para|enllaços}}, per exemple:
:{{para|enllaços|Aquesta documentació està generada per [<nowiki />[Plantilla:Ús d'infotaules de país]]}}

Per eliminar la caixa d'enllaços en pot usar {{para|enllaços|no}}.

Un dels enllaços generats normalment és per fer una versió de proves. L'espai de proves es troba en l'espai d'usuari amb el prefix "Usuari:Exemple/proves/". Un enllaç "(crea)" permet fer una còpia de la plantilla en l'espai propi de proves per després poder fer previsualitzacions de pàgines tal com quedarien amb la plantilla de proves a [[Especial:TemplateSandbox]]. Quan aquesta plantilla s'usa en l'espai de proves, canvia el contingut per un específic amb enllaços d'utilitat per a les proves, generat per {{tl|ús de la plantilla/espai de proves}}.

== Ús en pàgines de discussió ==
Aquesta plantilla s'usa normalment en l'espai de plantilles. Pot servir també per a altres pàgines d'altres espais de noms usades per fer inclusions com les plantilles. En alguns casos no serà possible usar-la en l'espai base sinó en la discussió:
* Les plantilles preparades per fer precàrregues no poden usar <code><nowiki><noinclude></nowiki></code> ja que el seu contingut s'inclou igualment en la precàrrega.
* En l'espai MediaWiki normalment <code><nowiki><noinclude></nowiki></code> no funciona en els missatges del sistema, a més que aquest espai cal mantenir-lo simple de codi per millor rendiment.
* Els espais principal, Fitxer, MediaWiki i Categoria no tenen la funció de subpàgines.

En usar aquesta plantilla en pàgines de discussió, hauria d'estar abans dels fils de discussió i sense les etiquetes <code><nowiki><noinclude></nowiki></code>.

== Vegeu també ==
*[[Viquipèdia:Documentació de plantilles]]

<includeonly><!-- CATEGORIES I INTERWIKIS AQUÍ, GRÀCIES -->
[[Categoria:Plantilles per a plantilles|Us de la plantilla]]

</includeonly>