Ayuda:Plantillas/Uso

De Wikiversidad
Ir a la navegación Ir a la búsqueda

¿Dónde documentar una plantilla?[editar]

La documentación de uso de una plantilla debe ser colocada en las subpáginas "/uso" de las plantillas, para lo cuál es necesario introducir la plantilla de documentación de uso al final de la página principal de la plantilla a documentar, copiando (o adaptando) el siguiente código:

<noinclude>{{documentación de plantilla}}
[[Categoría:Nombre de la categoría de la plantilla|{{PAGENAME}}]]

[[de:Vorlage:Nombre de la plantilla equivalente alemana]]
[[el:Πρότυπο:Nombre de la plantilla equivalente griega]]
[[en:Template:Nombre de la plantilla equivalente inglesa]]
[[fr:Modèle:Nombre de la plantilla equivalente francesa]]
[[it:Template:Nombre de la plantilla equivalente italiana]]
</noinclude>

Es recomendable introducir la documentación de uso en la subpágina "/uso" para descargar la página de la plantilla, tanto para acelerar la carga de las mismas en los artículos (cuando se trate de plantillas de uso extendido), como para que la página de la plantilla en sí no sea excesivamente larga.

¿Cómo documentar una plantilla?[editar]

Una vez introducida la plantilla correspondiente en la página principal, aparecerá en ésta el cuadro de documentación de uso con un enlace directo a la subpágina "/uso", donde irá la información de ayuda. Se debe pulsar dicho enlace para editar la subpágina e introducir la información correspondiente. Es recomendable organizarla con la siguiente estructura:

  1. Uso, utilidad de la plantilla, cuándo usarla y dónde situarla.
  2. Sintaxis, cómo escribir la plantilla.
  3. Observaciones, notas a tener en cuenta (esta sección no es obligatoria).
  4. Variantes, variantes de la plantilla (esta sección no es obligatoria).
  5. Véase también, otra información de interés relacionada con la plantilla (esta sección no es obligatoria).

Las categorías y los interwikis se escribirán al final de la subpágina, entre las etiquetas <includeonly> y </includeonly>.

Modelos de documentos de uso[editar]

A continuación se listan algunos ejemplos de documentación que pueden ser copiados tal cual, o adaptarlos a las necesidades del editor.

Para plantillas simples (sin parámetros):
<noinclude>{{Subpágina documentación de plantilla}}</noinclude>
==Uso==
Indicar cómo utilizar esta plantilla, cuándo usarla y dónde colocarla.

==Sintaxis==
<pre>{{<!-- Nombre de la plantilla -->}}</pre>

==Observaciones==
Cuestiones a tener en cuenta.

==Variantes==
:* {{M|<!--Nombre de la plantilla relacionada-->}}

==Véase también==
:*[[Páginas de interés]]
Para plantillas con parámetros ordenados:
<noinclude>{{Subpágina documentación de plantilla}}</noinclude>
==Uso==
Indicar cómo utilizar esta plantilla, cuándo usarla y dónde colocarla.

==Sintaxis==
<pre>{{<!--Nombre de la plantilla-->|1|2|etc.}}</pre>

===Parámetros===
<pre>
:* <code>1</code> : descripción1.
:* <code>2</code> : descripción2.
:* etc.
</pre>

==Observaciones==
Cuestiones a tener en cuenta.

==Variantes==
:* {{M|<!--Nombre de la plantilla relacionada-->}}

==Véase también==
:*[[Páginas de interés]]
Para plantillas con parámetros nombrados:
<noinclude>{{Subpágina documentación de plantilla}}</noinclude>
==Uso==
Indicar cómo utilizar esta plantilla, cuándo usarla y dónde colocarla.

==Sintaxis==
<pre>{{<!-- Nombre de la plantilla -->
   |parámetro1=valor1
   |parámetro2=valor2
   |parámetro3=valor3
   |etc.
 }}
</pre>

===Parámetros===
<pre>
:* <code>parámetro1</code> : descripción1.
:* <code>parámetro2</code> : descripción2.
:* <code>parámetro3</code> : descripción3.
:* etc.
</pre>

==Observaciones==
Cuestiones a tener en cuenta.

==Variantes==
:* {{M|<!--Nombre de la plantilla relacionada-->}}

==Véase también==
:* [[Páginas de interés]]


Ejemplos de Plantillas bien documentadas[editar]