Plantilla:Doc
Para utilizarlo, crea una subpágina desde la plantilla llamada doc, coloca {{doc/start}}
al inicio de tu documentación y {{doc/end}}
al final.
Regresa a la página principal de tu plantilla y coloca <noinclude>{{doc}}
</noinclude> en una nueva línea después del final de la plantilla. Las páginas /doc se añadirán automáticamente a Category:Documentación de plantillas.
Parámetros opcionales
clear
Si la página principal de tu plantilla tiene contenido flotante y deseas evitar que sobresalga sobre la documentación, coloca {{doc/start|clear}}
en lugar de {{doc/start}}
en tu página de documentación.
Esto también es útil para plantillas que no utilizan <includeonly>, ya que creará un espacio entre la plantilla y el cuadro de documentación.
nodoc=1
Si una plantilla no tiene documentación y no sabes cómo usarla, coloca {{doc/start|nodoc=1}}
(o si la plantilla también necesita clear, {{doc/start|clear|nodoc=1}}
) en lugar de {{doc/start}}
en tu página de documentación.
El fondo de la documentación se volverá rojo para hacerlo más visible y la página se añadirá a Categoría:Plantillas sin documentación.
baddoc=1
Similar a nodoc, se utiliza para marcar plantillas que sí tienen documentación, pero no es muy buena. Esto puede significar que no tiene suficientes ejemplos, no explica todas las funciones correctamente o no explica adecuadamente el propósito de la plantilla.
El fondo de la documentación se volverá amarillo para hacerlo más visible y la página se añadirá a Categoría:Plantillas con mala documentación.
Si se especifican tanto nodoc como baddoc, se ignorará baddoc.