Plantilla:Documentación

[editar] [refrescar] Documentación de Plantilla

Esta es la plantilla {{documentación}}.

Esta plantilla permite que se puedan proteger las plantillas críticas cuando sea necesario, mientras que a la vez cualquier usuario pueda editar la documentación de la plantilla, ampliando los ejemplos, clarificando su uso, o añadiendo categorías y enlaces interwikis.

Tiene otras dos plantillas auxiliares de las cuales se sirve para simplificar la codificación: {{documentación/core}} y {{documentación/core2}}.

La plantilla {{documentación}} llama a {{documentación/core2}} que a su vez llama a esta plantilla, que contiene la mayor parte de la codificación de {{documentación}}, mientras que {{documentación}} y {{documentación/core2}} procesan los parámetros de entrada. De esta forma se obtiene un código mas simple.

Uso

El uso normal de esta plantilla es añadirla, sin parámetros, al final de la página plantilla que se está documentando, dentro de una sección <noinclude>:

<!--Última linea del código de la plantilla--><noinclude>
{{documentación}}
<!-- Añadir categorías e interwikis en la subpágina de documentación, no aquí -->
</noinclude>

Esta plantila automáticamente carga el contenido de la subpágina /doc en la plantilla que la usa.

Esta plantilla se ha realizado basándose en la más compleja y extensa de la Wikipedia, la descripción completa y extensa de todos los posibles parámetros y capacidades se puede consultar en wikipedia:Template:Documentation, en inglés.

Cómo se crea una subpágina de documentación

Las subpáginas de documentación se deben nombrar y formatear usando el siguiente modelo general, por consistencia.

• Si suponemos que la página se llama Plantilla:X, creamos una subpágina llamada Plantilla:X/code
• Incluimos el siguiente código.

{{subdoc}}
<!-- POR FAVOR CATEGORÍAS Y ENLACES INTERWIKIS AL FINAL -->

=== Uso ===

<includeonly><!-- CATEGORÍAS Y ENLACES INTERWIKIS AQUÍ, GRACIAS -->

</includeonly>

• Guardamos la subpágina y volvemos a la Plantilla. Editamos la plantilla y añadimos lo siguiente al final del código de la plantilla:

<noinclude>
{{documentación}}
<!-- CATEGORÍAS Y ENLACES INTERWIKIS EN LA SUBPÁGINA /doc, GRACIAS -->
</noinclude>