Plantilla:Documentación
Documentación de la plantilla
|
---|
Atención: algunas partes de la plantilla pueden quedar ocultas sin los valores apropiados. |
Ver o editar esta documentación. (Acerca de la plantilla de documentación) |
Los editores pueden experimentar con el cajón de sastre y los ejemplos de esta plantilla. |
- Descripción
- Esta plantilla se usa para insertar descripciones en las páginas de las plantillas.
- Sintaxis
- Añade
<noinclude>{{Documentación}}</noinclude>
al final de la página de una plantilla.
- Añade
<noinclude>{{Documentación|<página de documentación>}}</noinclude>
para transcluir una página alternativa a la subpágina /doc.
- Uso
- En la página de la plantilla
Este es el formato habitual cuando se usa:
CÓDIGO DE LA PLANTILLA <includeonly>Cualquier categoría que se quiera insertar en los artículos que usen esta plantilla</includeonly> <noinclude>{{Documentación}}</noinclude>
Si tu plantilla no tiene una tabla o un contenedor div al completo, puede que necesites cerrar esas etiquetas antes de insertar {{Documentación}}
(dentro de las etiquetas noinclude).
Puede ser útil incluir un salto de línea justo antes de {{Documentación}}
para ayudar a prevenir que la plantilla de documentación se ejecute sobre el código anterior.
- En la página de documentación
Normalmente la página de documentación se ubica en la subpágina /doc de la plantilla, pero se puede especificar una página diferente dentro del primer parámetro de la plantilla (consulta el apartado Sintaxis).
Igualmente se suele querer escribir algo parecido a esto en la página de documentación:
;Descripción :Esta plantilla se usa para hacer algo. ;Sintaxis :Escribe <code>{{t|nombre de la plantilla}}</code> en algún lugar. ;Ejemplos :<code><nowiki>{{nombre de la plantilla|parámetro}}</nowiki></code> que tiene como resultado esto: :{{nombre de la plantilla|parámetro}} <includeonly>Cualquier categoría que se quiera insertar en los artículos que usen esta plantilla</includeonly> <noinclude>[[Categoría:Documentación de plantilla]]</noinclude>
Usa cualquiera de las secciones de arriba. Puede que también quieras añadir una sección "Ver también" u otras secciones.
Ten en cuenta que el ejemplo de arriba también usa la plantilla Plantilla:T