Plantilla:Documentación/doc

De Wikiviajes, la guía libre de viajes
Ir a la navegación Ir a la búsqueda

Esta plantilla automáticamente muestra un cuadro de documentación como el que estás viendo ahora.

El uso de esta plantilla permite que las plantillas que la utilizan se puedan documentar y categorizar, independientemente de que éstas se encuentren protegidas o no.

Uso[editar]

/doc normal[editar]

<noinclude>
{{documentación}}</noinclude>

La plantilla carga el contenido de la subpágina /doc desde donde es usada.

Cualquier página /doc[editar]

<noinclude>
{{documentación|Plantilla:cualquier página/doc}}</noinclude>

Además se puede cargar la documentación de cualquier otra plantilla para evitar redundancias.

Mejor práctica[editar]

Este código debe añadirse al final del código de la plantilla, sin espacios de más antes de «<noinclude>» (que causaría espacios de más en páginas donde se usa la plantilla). El parámetro puede usarse como se muestra más arriba para incluir una página de documentación arbitraria.

Las categorías e interwikis que aplican a la propia plantilla deben añadirse a la página de documentación, dentro de etiquetas <includeonly> e </includeonly>.

Si la página de documentación contiene etiquetas includeonly o noinclude como parte de la documentación, reemplázalas «<» por «&lt;».

Funciones[editar]

Si la página de documentación no existe, el enlace «crear» incluye un parámetro de precarga de manera que haciendo clic en él se pre-rellenará el formulario de edición con el formato básico de la página de documentación.

Detalles técnicos[editar]

Esta plantilla llama a {{documentación/caja inicial}} y a {{documentación/caja final}}. La /caja inicial (y la /caja final) contienen la mayoría del código.

La página de precarga para el enlace [crear] de la página /doc es Plantilla:Documentación/precarga. Las páginas de precarga para los enlaces [crear] de las páginas /zona de pruebas y /casos de prueba son Plantilla:Documentación/precarga-zona de pruebas y Plantilla:Documentación/precarga-casos de prueba.

Véase también[editar]

Fuente[editar]