|
Viquipèdia:Documentació de plantillesLes plantilles són un element potent del MediaWiki, però poden resultar confuses pels novells i també els usuaris experimentats poden tenir dificultats per treure'n l'entrellat de les més complexes. Per millorar la facilitat d'ús, tota plantilla hauria de tenir la documentació corresponent. La documentació de plantilla hauria d'explicar què fa i com cal utilitzar-la. Hauria de ser prou simple per a que un usuari sense coneixement complet de les complexitats de la sintaxi d'una plantilla, que inclou molts usuaris experimentats que centren la seva atenció en altres àrees, la pugui utilitzar correctament. Això és especialment necessari en cas de plantilles molt àmpliament utilitzades. Què s'ha d'explicarLa documentació de la plantilla hauria d'explicar:
La documentació d'ús de la plantilla es posa sovint en una subpàgina de la mateixa plantilla i s'inclou al final de la pàgina de plantilla. Així se separa el codi de la plantilla, sovint complex, del text explicatiu fent més fàcil modificar-lo. Això permet també protegir les plantilles quan sigui necessari mentre queda oberta la modificació del text de la documentació per a qualsevol usuari. En cas que s'afegeixi el text de documentació en la mateixa plantilla, en utilitzar-la aquest text també s'ha de processar fent-la menys efectiva i reduint els límits imposats de procés pel MediaWiki. En qualsevol cas, la documentació cal incloure-la dins de les etiquetes Com crear una subpàgina de documentació d'úsLes subpàgines de documentació d'ús de plantilla tenen un nom i un format estandarditzats per mantenir una consistència. El nom de la subpàgina és "/ús". Per exemple, la plantilla anomenada El format suggerit i precarregat per la pestanya "Documentació" és el següent: {{Subpàgina de plantilla}}
<!-- SI US PLAU, AFEGIU LES CATEGORIES AL FINAL D'AQUESTA PÀGINA -->
== Descripció ==
== Sintaxi ==
== Vegeu també ==
<includeonly>
{{ORDENA:{{PAGENAME}}}}<!-- CATEGORIES AQUÍ, GRÀCIES -->
</includeonly>
La primera línia, {{Subpàgina de plantilla}}, mostrarà un missatge explicatiu sobre aquesta pàgina amb un enllaç a la pàgina amb el codi de la plantilla. Afegiu el text de documentació després de la primera línia. Les seccions suggerides són orientatives i es poden substituir segons faci falta. Les categories i els interwikis han d'anar sota de la línia que ho indica, deixant el comentari per mantenir l'estructura quan la pàgina es modifiqui en el futur. El preformat afegir un {{ORDENA:{{PAGENAME}}}} per assegurar-se que la Un cop creada la subpàgina ja la podeu incloure a la plantilla ( [--última línia de codi--]<noinclude>
{{ús de la plantilla}}
</noinclude>
Amb això s'inclourà la subpàgina /ús al final de la pàgina de la plantilla. Important: Assegureu-vos que l'etiqueta Si la plantilla ja està protegida, demaneu a un administrador que ho faci o afegiu la plantilla {{modificació protegida}} en la pàgina de discussió de la plantilla. Si ja existeix text de documentació, categories o interwikis, traslladeu-los a la subpàgina /ús ja que és millor no tenir la documentació dividida en dues pàgines. Si s'afegeix la plantilla {{ús de la plantilla}} sense que existeixi la subpàgina /ús, es mostrarà un enllaç addicional per a crear-la. Igualment, es precarrega l'estructura estandarditzada definida a la plantilla {{ús de la plantilla/precàrrega}}. En cas de reanomenar la plantilla s'hauria de reanomenar també la subpàgina /ús. Els administrador disposen d'aquesta facilitat per defecte. Per no dispersar les discussions, no es mostra la pestanya per la pàgina Plantilla en blancPer generar una plantilla en blanc, que després pugui ser copiada de la documentació i enganxada en una altra pàgina, utilitzeu:
Per a més informació vegeu {{Parameters}}. ExemplesPer generar una instància de la plantilla, poblada amb els seus propis noms de propietats, utilitzeu:
Per a més informació vegeu {{Parameter names example}}. Categories i enllaços interwiki
Vegeu també
|
Portal di Ensiklopedia Dunia
