Diferencia entre revisiones de «Plantilla:Doc»

Documentación

[purge]

Para utilizarlo, crea una sub-página desde la plantilla llamada doc, pon {{doc/start}} al comienzo de tu documentación, y {{doc/end}} al final.

Regresa a tu plantilla principal e introduce <noinclude>{{/doc}}</noinclude> en una nueva línea después del final de la plantilla. Las páginas /doc automáticamente serán añadidas a Categoría:Plantillas de documentación.

Parámetros Opcionales

clear

Si tu plantilla principal tiene un contenido variable y quieres que la información añadida siempre este sobre la documentación, pon {{doc/start|clear}} en vez de {{doc/start}} en tu página de documentación.
Esto también es útil para las plantillas que no usen <includeonly>, ya que así se puede poner un poco de espacio entre la plantilla y el recuadro de documentación.

nodoc=1

Si tu plantilla no tiene documentación y no sabes como usarla, pon {{doc/start|nodoc=1}} (o si la plantilla necesita usar clear, {{doc/start|clear|nodoc=1}}) en vez de {{doc/start}} en tu página de documentación.
El fondo de la documentación se volverá rojo para hacerlo mas notable, y la página será añadida a Categoría:Plantillas sin documentación.

baddoc=1

Similar a nodoc, esta es usada para marcar las plantillas que tienen documentación, pero no es muy buena. Esto ocurre cuando no hay suficientes ejemplos. no se explican todas las funciones correctamente, o no explica la función de la plantilla adecuadamente.
El fondo de la documentación se volverá amarillo para hacerlo mas notable, y la página será añadida a Categoría:Plantillas con mala documentación.

Si nodoc y baddoc se especifican, baddoc será ignorado.