Doc

Documentación

[purge]

Para utilizar, crear una sub-página de la plantilla llamada doc, pon

{{doc/start}}  [links]  [edit]

Documentación [purge]

en el inicio de la documentación, y

{{doc/end}}  [links]  [edit]

Esta documentación está transcluida desde Plantilla:Doc/doc. (editar | historial)

al final.

Volver a la página principal de la plantilla y poner <noinclude>

{{doc}}  [links]  [edit]

Plantilla:Doc/doc

</noinclude> en un nueva línea después del final de la plantilla. /doc páginas se añadirán automáticamente a Categoría:Plantillas de documentación.

Optional parameters

clear

Si su página principal plantilla ha flotante contenido y que le gustaría detenerlo repasando la documentación , poner

{{doc/start|clear}}  [links]  [edit]

Documentación [purge]

en lugar de

{{doc/start}}  [links]  [edit]

Documentación [purge]

en la página de documentación.

Esto también es útil para las plantillas que no utilizan <includeonly>, ya que poner un poco de espacio entre la plantilla y el cuadro de la documentación.

nodoc=1

Si una plantilla no tiene ninguna documentación y no sabes cómo usarlo , poner

{{doc/start|nodoc=1}}  [links]  [edit]

Documentación [purge]

(o si la plantilla necesita claro así, ) en lugar de

{{doc/start}}  [links]  [edit]

Documentación [purge]

en su página de documentación.

Fondo de la documentación será de color rojo para que sea más visible , y la página será añadido a Categoría:Plantillas sin documentación.

baddoc=1

Similar a nodoc, esto se utiliza para marcar plantillas que "hacer" tener documentación, pero no es muy bueno. Esto puede significar que no tiene suficientes ejemplos, no explica todas las funciones correctamente, o no explica el punto de la plantilla correctamente.
Fondo de la documentación será de color amarillo para que sea más visible , y la página se añade a Categoría:Plantillas mal documentadas.

Si se especifican ambas , baddoc será ignorado.