La {{documentation}}plantilla se utiliza para contener la información documentada y las instrucciones de una determinada plantilla, generalmente de una subpágina /doc. También se puede configurar para cargar el contenido de otras páginas o ser alimentado directamente por texto.
Para obtener instrucciones detalladas sobre cómo y cuándo utilizar esta plantilla, consulte Wikipedia: documentación de la plantilla (atajo: WP:TDOC ).
Esta plantilla tiene dos partes: el "cuadro de documentación" grande con la documentación dentro junto con una barra de herramientas (los [view][edit][history][purge]enlaces) y el "cuadro de enlaces" más pequeño que muestra metadatos sobre la documentación junto con los enlaces de la zona de pruebas y los casos de prueba .
El uso de esta plantilla permite proteger las plantillas , cuando sea necesario, y al mismo tiempo permite que cualquiera edite la documentación y las categorías.
Normalmente, la plantilla se utiliza sin parámetros y se coloca en <noinclude>...</noinclude>la parte inferior de la página de la plantilla (consulte § Ubicación y etiquetas para obtener más información):
<!--Última línea del código de su plantilla--> < noinclude > {{ Documentación }} <!-- Agregue categorías a la subpágina /doc --> </ noinclude >Para transcluir una página diferente a la subpágina /doc, simplemente proporcione |1=lo siguiente:
<!--Última línea del código de su plantilla--> < noinclude > {{ Documentación | Plantilla:Otra página/doc }} </ noinclude >Tenga en cuenta que al cargar la documentación desde una página que no sea la subpágina local /doc, resulta complicado manejar las categorías.
La documentación también se puede enviar directamente como texto, utilizando el |content=parámetro:
<!--Última línea del código de su plantilla--> < noinclude > {{ Documentación | contenido = <!-- documentación de plantilla --> }}</ noinclude >Al utilizar este parámetro, la barra de herramientas no se mostrará. Tenga en cuenta que la subpágina /doc en el cuadro de enlace seguirá apareciendo si existe.
También tenga en cuenta que cuando se especifica |1=y , tiene prioridad y siempre se muestra en el cuadro de documentación.|content=|content=
El encabezado del cuadro de documentación cambia según el espacio de nombres. Consulte la siguiente lista para conocer el texto predeterminado en cada espacio de nombres:
.svg/1280px-Test_Template_Info-Icon_-_Version_(2).svg.png){kind=icon}
Documentación de plantilla Documentación del móduloPara personalizar el encabezado, simplemente configure el parámetro |heading=como desee, por ejemplo |heading=Infobox documentation.
Tenga en cuenta que si el parámetro de encabezado está vacío pero definido (como |heading=), el encabezado junto a la barra de herramientas no se mostrará.
El |heading-style=parámetro puede recibir valores CSS opcionales , como |heading-style=font-size:150%;color:red;. No es que debas omitir las comillas " "y agregar el punto y coma final ;.
Para personalizar el cuadro de enlace, simplemente configúrelo |link box=en otra cosa, como .|link box=The above documentation is automatically generated from Template:Foo
Para ocultar el cuadro de enlace, simplemente configúrelo |link box=en off.
Puede simular la salida de una página determinada utilizando el |page=parámetro. Por ejemplo, si usa el código |page=Template:Edit protected, la plantilla se comportará exactamente como si estuviera en la página Plantilla:Editar protegido , incluyendo mostrar la documentación de Plantilla:Editar protegido/doc , vincular a Plantilla:Editar protegido/sandbox , etc. El parámetro es útil para realizar pruebas y se utiliza ampliamente en la página de casos de prueba del módulo .
Este código debe agregarse en la parte inferior de la página de códigos de la plantilla, sin espacios antes <noinclude>(lo que hace que se muestren espacios en blanco adicionales en las páginas donde se transcluye la plantilla):
<!--Última línea del código de su plantilla--> < noinclude > {{ documentación }} <!-- Agregue categorías a la subpágina /doc --> </ noinclude >Para insertar automáticamente el texto anterior, también puedes utilizar el atajo del código de sustitución .{{subst:doc-code}}
Dependiendo de dónde se encuentre la documentación, puede resultar complicado manejar las categorías y los interwikis. Consulte Wikipedia: documentación de plantilla § Categorías y enlaces interwiki para obtener información sobre cómo agregarlos.
Si la página de documentación no existe, la barra de herramientas se reemplaza con un [create]enlace. Crea automáticamente la página con texto precargado con la sintaxis de documentación básica. El texto de carga previa también se utiliza para los enlaces /sandbox y /testcases [crear].
La página de precarga para el [create]enlace /doc es Plantilla:Documentación/precarga . Las páginas de precarga para los enlaces /sandbox y /testcases son Template:Documentation/preload-sandbox y Template:Documentation/preload-testcases . La página de precarga para el [mirror]enlace /sandbox es Plantilla:Documentación/espejo .
Esta plantilla también agrega automáticamente {{ pp-template }} a una página de plantilla protegida, por lo que no es necesario agregar manualmente esta plantilla a las páginas protegidas.
Cuando esta plantilla está en una subpágina /sandbox, agrega automáticamente la plantilla {{ Aviso de plantilla sandbox }}.
Dependiendo del espacio de nombres, el cuadro de enlace puede tener menos funciones o puede que no aparezca en absoluto. La siguiente tabla muestra esto:
Además de eso, si se especifica |1=o |content=, no se mostrará "Agregar categorías a la subpágina /doc".
Esta plantilla generalmente se coloca en el espacio de nombres del asunto . Pero en algunos casos esta plantilla debe estar en el espacio de nombres de Talk :
<noinclude>menudo no funciona en los mensajes del sistema y dado que el espacio de nombres de MediaWiki debe mantenerse limpio por razones de rendimiento.Cuando se coloca en páginas de discusión, esta plantilla generalmente se coloca cerca de la parte superior de la página y sin <noinclude>...</noinclude>etiquetas.
Las páginas /doc, /sandbox y /testcases normalmente deberían estar en el espacio de nombres del asunto, excepto en los espacios de nombres que no tienen habilitada la función de subpágina MediaWiki: Principal, Archivo y MediaWiki. (Las categorías pueden tener subpáginas, pero la documentación se crea en el espacio de nombres de discusión Categoría para evitar la creación de categorías vacías. También hay muchas otras razones técnicas por las cuales la página /doc debe almacenarse debajo de la página de discusión para aquellas (pero solo esas) espacios de nombres.
Esta plantilla apunta automáticamente sus enlaces [crear] para /doc, /sandbox y /testcases al espacio de nombres correcto.
{{ Documentación }}o{{ Documentación | [ruta a la página de documentación] } }{{ Documentación | contenido = }}o{{ Documentación | [ruta a la página de documentación] | estilo de encabezado = | título = | cuadro de enlace = }}o{{ Documentación | [ruta a la página de documentación] | contenido = | estilo de encabezado = | título = | cuadro de enlace = | página = }}