Diferencia entre revisiones de «Plantilla:Doc/start»
(Avoid using any templates here, so that the "Templates used on this page" section is correct when viewing a template's page.) |
|||
| Línea 8: | Línea 8: | ||
--><div style="margin: 0em auto 1em; background-color: #{{#if: {{{nodoc|}}} | F9EAEA | {{#if: {{{baddoc|}}} | F9F2EA | EAF4F9 }} }}; border: 1px solid #AAAAAA; padding: 1em;"> | --><div style="margin: 0em auto 1em; background-color: #{{#if: {{{nodoc|}}} | F9EAEA | {{#if: {{{baddoc|}}} | F9F2EA | EAF4F9 }} }}; border: 1px solid #AAAAAA; padding: 1em;"> | ||
<div style="padding-bottom: 3px; border-bottom: 1px solid #AAAAAA; margin-bottom: 1ex;"><!-- | <div style="padding-bottom: 3px; border-bottom: 1px solid #AAAAAA; margin-bottom: 1ex;"><!-- | ||
| − | -->[[File:Template-{{#if: {{{nodoc|}}} | no | {{#if: {{{baddoc|}}} | bad }} }}info.png|50px]] <span style="font-weight: bold; font-size: 125%;"> | + | -->[[File:Template-{{#if: {{{nodoc|}}} | no | {{#if: {{{baddoc|}}} | bad }} }}info.png|50px]] <span style="font-weight: bold; font-size: 125%;">Documentation</span><!-- |
| − | --><div style="float: right; margin-left: 5px">[{{fullurl | + | --><div class="plainlinks" style="float: right; margin-left: 5px">[[{{fullurl:{{FULLPAGENAME}}|action=purge}} purge]]</div></div><!-- |
| − | -->{{#if: {{{nodoc|}}} | ''' | + | -->{{#if: {{{nodoc|}}} | '''This template has no documentation. If you know how to use this template, please add some.'''<!-- |
-->{{#ifeq: {{SUBPAGENAME}} | doc | | [[Category:Templates with no documentation|{{BASEPAGENAME}}]]}} |<!-- | -->{{#ifeq: {{SUBPAGENAME}} | doc | | [[Category:Templates with no documentation|{{BASEPAGENAME}}]]}} |<!-- | ||
| − | -->{{#if: {{{baddoc|}}} | ''' | + | -->{{#if: {{{baddoc|}}} | '''This template's documentation has been marked as bad. Please improve or add to it.'''<!-- |
-->{{#ifeq: {{SUBPAGENAME}} | doc | | [[Category:Templates with bad documentation|{{BASEPAGENAME}}]]}}<!-- | -->{{#ifeq: {{SUBPAGENAME}} | doc | | [[Category:Templates with bad documentation|{{BASEPAGENAME}}]]}}<!-- | ||
-->}} }}</includeonly><noinclude> | -->}} }}</includeonly><noinclude> | ||
{{doc}}</noinclude> | {{doc}}</noinclude> | ||
Revisión del 10:42 9 ago 2012
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.
