Viquidites:Documentació de plantilles: diferència entre les revisions

* '''Exemples d'ús''': especifiqueu exactament la sintaxi a utilitzar i el resultat que produeix. El text wiki es pot incloure entre les etiquetes {{nowrap|<code><nowiki><code>…</code></nowiki></code>}} per deixar clar què és el que cal escriure i facilitar la còpia, <code>com aquesta mateixa mostra</code>. Si la plantilla es pot utilitzar de diferents maneres, per exemple amb paràmetres opcionals o sense, proporcioneu diferents exemples. Una bona manera de fer-ho és incloent la pròpia plantilla en la documentació (amb exemples reals), i cada vegada amb paràmetres diferents mostrant-los en cada cas.

* '''Plantilles relacionades''': si la plantilla forma part d'una sèrie de plantilles relacionades, afegiu els enllaços a aquestes plantilles per facilitar la navegació i amb una breu explicació de les diferències entre elles.

 

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.