Documentación de plantilla
|
|---|
| Nota: partes de la muestra de la plantilla pueden no ser visibles sin los valores proporcionados. |
| Ver o editar esta documentación. (Acerca de la documentación de la plantilla) |
| Los editores pueden experimentar en las páginas sandbox y test case de esta plantilla. |
Descripción[editar código]
Esta plantilla se utiliza para insertar descripciones en las páginas de plantilla.
Sintaxis[editar código]
Agregue <noinclude>Plantilla:T</noinclude> al final de la página de la plantilla.
Agregue <noinclude>Plantilla:T</noinclude> para transcluir una página alternativa de la subpágina /doc.
Uso[editar código]
En la página de Plantillas[editar código]
Este es el formato normal cuando se usa:
CÓDIGO DE PLANTILLA<includeonly>Cualquier categoría que la plantilla inserte en los artículos</includeonly><noinclude>
{{documentación}}</noinclude>
Si su plantilla no es un div o una tabla completos, es posible que deba cerrar las etiquetas justo antes de insertar {{documentación}} (dentro de las etiquetas noinclude).
Un salto de línea justo antes de {{documentación}} también puede ser útil, ya que ayuda a evitar que la plantilla de documentación "se encuentre" con el código anterior.
En la página de documentación[editar código]
La página de documentación generalmente se encuentra en la subpágina /doc para una plantilla, pero se puede especificar una página diferente con el primer parámetro de la plantilla (ver Syntax).
Normalmente, querrá escribir algo como lo siguiente en la página de documentación:
==Descripción==
Esta plantilla se utiliza para hacer algo.
==Sintaxis==
Escribe <code>{{t|nombre de la plantilla}}</code> en alguna parte.
==Muestras==
<código><nowiki>{{nombre de la plantilla|input}}</nowiki></código>
da como resultado...
{{nombre de la plantilla|input}}
<includeonly>Cualquier categoría para la plantilla misma</includeonly><noinclude>[[Categoría:Documentación de la plantilla|{{PAGENAME}}]]</noinclude>
Use cualquiera o todas las secciones anteriores de descripción/sintaxis/salida de muestra. También puede agregar "ver también" u otras secciones.
Tenga en cuenta que el ejemplo anterior también usa las plantillas Platilla:T y Platilla:T/pieza.