Plantilla:Documentación de plantilla

De Wikiversidad
Ir a la navegación Ir a la búsqueda
[ver] [editar]Template-info.svg Documentación de plantilla

Uso[editar]

Esta plantilla muestra un cuadro con la documentación de la plantilla, justo como el que estás viendo ahora, con el objeto de mostrar la documentación de uso de las plantillas de Wikiversidad. Ésta debe ser colocada al final de la página principal de la plantilla en cuestión, entre las etiquetas <noinclude> y </noinclude>. Es recomendable organizar la información de ayuda 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).

Sintaxis[editar]

{{Documentación de plantilla}}

Observaciones[editar]

  • Un carácter enmascarado en la página de documentación que no esté dentro de {} dobles o triples o () dobles desordena las funciones propias de esta plantilla, porque el contenido de esa página se asigna al parámetro de la plantilla. Usa &#124; en su lugar.
  • Si la documentación contiene las etiquetas includeonly y/o noinclude dentro de etiquetas nowiki, reemplaza "<" con "&lt;".