Aquesta plantilla,
{{
Us de la plantilla
}}
, permet documentar la informacio d'us de les plantilles.
Per a la majoria de les instruccions sobre com i quan utilitzar aquesta plantilla, vegeu
Viquipedia:Documentacio de plantilles
.
Aquesta plantilla mostra una caixa de color, com la que esteu veient, i carrega el contingut d'una subpagina /us. Tambe pot carregar altres continguts segons els parametres.
El proposit es documentar la informacio d'us de les plantilles i altres pagines que s'usen transcloses. Normalment s'utilitzara en l'espai de noms de plantilles, pero tambe es pot utilitzar en altres
espais de noms
que permetin crear subpagines.
L'us d'aquesta plantilla permet separar el codi propi de la plantilla del text d'informacio. Aixi les plantilles sensibles o d'alt us es poden
protegir
i, alhora, es permet que qualsevol usuari pugui modificar la documentacio, categories i enllacos interwiki.
Us
Normalment aquesta plantilla s'utilitza sense parametres, al final de la plantilla o de la pagina de codi, entre etiquetes
<noinclude>
:
<!--Ultima linia de codi de la plantilla--><noinclude>
{{us de la plantilla}}
<!-- Afegiu categories en la subpagina /us, no aqui! -->
</noinclude>
Llavors aquesta plantilla carrega automaticament el contingut de la subpagina /us corresponent a la plantilla on s'estigui usant.
Aquesta plantilla tambe pot carregar el contingut d'una altra pagina:
<!--Ultima linia de codi de la plantilla--><noinclude>
{{us de la plantilla|Plantilla:Una altra pagina/us}}
</noinclude>
Cal notar que en carregar el contingut d'una pagina diferent a la subpagina local /us llavors resulta complicat gestionar els enllacos de categories.
El contingut tambe es pot proporcionar directament com a text:
<!--Ultima linia de codi de la plantilla--><noinclude>
{{us de la plantilla|contingut=
Text de documentacio.
}}
</noinclude>
Quan s'utilitza el parametre
|contingut=
, la caixa de documentacio normalment no mostrara els enllacos com [modifica] [refresca] a l'encapcalament. Si existeix igualment la subpagina /us apareixera en els enllacos al peu de la pagina.
El parametre
|1=
i el parametre
|contingut=
tambe es poden combinar:
<!--Ultima linia de codi de la plantilla--><noinclude>
{{us de la plantilla
|1=Plantilla:Pagina/us
|contingut=
{{Plantilla:Pagina/us |parametres}}
}}
</noinclude>
La pagina proporcionada com a parametre 1 es usada pels enllacos [mostra] [modifica] i els enllacos al peu de la caixa. El parametre "contingut" s'utilitza pel contingut mostrat a la caixa. En l'exemple, es mostra el contingut depenent d'uns parametres.
Bones practiques
El codi cal afegir-lo a continuacio de l'ultima linia de la plantilla, sense espais ni salts de linia abans de
<noinclude>
ja que aquests espais o salts de linia s'inclourien en les pagines on s'utilitzi la plantilla provocant efectes inesperats.
Quan no existeix la subpagina /us, aquesta plantilla proporciona un enllac [crea]. Tambe es pot crear amb la pestanya "Documentacio" que apareix en l'espai de plantilles. En crear-la s'afegeix un text en precarrega proporcionat per
{{
us de la plantilla/precarrega
}}
. Si no existeix la subpagina "/us" categoritza la plantilla a
Categoria:Plantilles sense informacio d'us
. Si es crea primer la pagina de codi posant {{us de la plantilla}} d'entrada queda categoritzada. Si despres es crea la subpagina /us, cal esperar a una actualitzacio per a que tregui la categoria o be fer alguna modificacio en la pagina de codi que forci regenerar les inclusions. L'actualitzacio de categories posades a traves de plantilles no sempre es immediata. La recomanacio es primer crear la subpagina de documentacio i despres posar {{us de la plantilla}} a la pagina de codi.
Les categories i els enllacos interwiki corresponents a la propia plantilla s'haurien d'afegir al final de la subpagina /us, entre les etiquetes
<includeonly>...</includeonly>
.
Aquesta plantilla detecta automaticament si existeix una proteccio. En aquest cas afegeix la plantilla
{{
plantilla protegida
}}
. Vegeu la documentacio d'aquesta plantilla per a mes informacio.
Titol
El titol per defecte de la caixa es:
Documentacio de la plantilla
Es pot utilitzar el parametre
|titol=
per canviar-lo:
{{us de la plantilla |titol=Documentacio de la infotaula}}
Si el parametre esta definit pero buit llavors no es mostra cap titol ni tampoc els enllacos en l'encapcalament.
Amb el parametre
|estil-titol=
es poden canviar els valors CSS, per exemple::
estil-titol = color: red; font-size: 150%;
Enllacos a peu de pagina
A peu de pagina es mostra una petita caixa amb alguns enllacos sobre la documentacio. Aquests enllacos poden canviar segons els parametres i segons l'espai de noms.
El contingut es pot modificar amb el parametre
|enllacos=
, per exemple:
|enllacos=Aquesta documentacio esta generada per [[Plantilla:Us d'infotaules de pais]]
Per eliminar la caixa d'enllacos en pot usar
|enllacos=no
.
Un dels enllacos generats normalment es per fer una versio de proves. L'espai de proves es troba en l'espai d'usuari amb el prefix "Usuari:Exemple/proves/". Un enllac "(crea)" permet fer una copia de la plantilla en l'espai propi de proves per despres poder fer previsualitzacions de pagines 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 especific amb enllacos d'utilitat per a les proves, generat per
{{
us de la plantilla/espai de proves
}}
.
Us en pagines de discussio
Aquesta plantilla s'usa normalment en l'espai de plantilles. Pot servir tambe per a altres pagines d'altres espais de noms usades per fer inclusions com les plantilles. En alguns casos no sera possible usar-la en l'espai base sino en la discussio:
- Les plantilles preparades per fer precarregues no poden usar
<noinclude>
ja que el seu contingut s'inclou igualment en la precarrega.
- En l'espai MediaWiki normalment
<noinclude>
no funciona en els missatges del sistema, a mes que aquest espai cal mantenir-lo simple de codi per millor rendiment.
- Els espais principal, Fitxer, MediaWiki i Categoria no tenen la funcio de subpagines.
En usar aquesta plantilla en pagines de discussio, hauria d'estar abans dels fils de discussio i sense les etiquetes
<noinclude>
.
Vegeu tambe