La {{documentation}}plantilla se utiliza para contener la información documentada y las instrucciones de una determinada plantilla, normalmente desde una subpágina /doc. También se puede configurar para cargar el contenido desde otras páginas o ser alimentada directamente por texto.
Para obtener instrucciones detalladas sobre cómo y cuándo utilizar esta plantilla, consulte Wikipedia:Documentación de la plantilla (acceso directo: WP:TDOC ).
Esta plantilla tiene dos partes: el "cuadro de documentación" grande con la documentación adentro junto con una barra de herramientas (los [view][edit][history][purge]enlaces), y el "cuadro de enlace" más pequeño que muestra metadatos sobre la documentación junto con los enlaces a la zona protegida y los casos de prueba .
El uso de esta plantilla permite proteger las plantillas , cuando sea necesario, al tiempo que permite a cualquier persona editar la documentación y las categorías.
Normalmente, la plantilla se utiliza sin parámetros y se coloca dentro, <noinclude>...</noinclude>en la parte inferior de la página de la plantilla (ver § Ubicación y etiquetas para obtener más información):
<!--Última línea del código de tu plantilla--> < noinclude > {{ Documentación }} <!-- Agregar 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 tu plantilla--> < noinclude > {{ Documentación | Plantilla:Otra página/doc }} </ noinclude >Tenga en cuenta que al cargar la documentación desde una página distinta a la subpágina local /doc, resulta complicado manejar las categorías.
La documentación también se puede introducir directamente como texto, utilizando el |content=parámetro:
<!--Última línea del código de tu plantilla--> < noinclude > {{ Documentación | contenido = <!-- documentación de la plantilla --> }}</ noinclude >Al utilizar este parámetro, no se mostrará la barra de herramientas. Tenga en cuenta que la subpágina /doc en el cuadro de vínculo seguirá apareciendo si existe.
Tenga en cuenta también 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 lista a continuación para ver 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=con el valor que 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|heading-style=font-size:150%;color:red; opcionales, como . No es necesario omitir las comillas " "y agregar el punto y coma final ;.
Para personalizar el cuadro de enlace, 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 utiliza el código |page=Template:Edit protected, la plantilla se comportará exactamente como si estuviera en la página Template:Edit protected , lo que incluye mostrar la documentación de Template:Edit protected/doc , vincularla a Template:Edit protected/sandbox , etc. Este 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 espacio antes <noinclude>(lo que hace que se muestren espacios adicionales en las páginas donde se transcluye la plantilla):
<!--Última línea del código de tu plantilla--> < noinclude > {{ documentación }} <!-- Agregar categorías a la subpágina /doc --> </ noinclude >Para insertar automáticamente el texto anterior, también puede utilizar el acceso directo del código de sustitución .{{subst:doc-code}}
Dependiendo de dónde se coloque la documentación, puede resultar complicado gestionar las categorías y los enlaces interwiki. Consulta Wikipedia:Documentación de plantilla § Categorías y enlaces interwiki para obtener información sobre cómo añadirlos.
Si la página de documentación no existe, la barra de herramientas se reemplaza por un [create][purge]enlace. El [create]enlace crea automáticamente la página con texto precargado con la sintaxis básica de la documentación. El texto precargado también se utiliza para los enlaces /sandbox y /testcases [create].
La página de precarga para el enlace /doc [create]es Template:Documentation/preload . Las páginas de precarga para los enlaces /sandbox y /testcases son Template:Documentation/preload-sandbox y Template:Documentation/preload-testcases[mirror] . La página de precarga para el enlace /sandbox es Template:Documentation/mirror .
Esta plantilla también agrega automáticamente {{ pp-template }} a una página de plantilla protegida. Cuando esta plantilla está en una subpágina /sandbox, también agrega la plantilla {{ Template sandbox notice }} .
Según el espacio de nombres, el cuadro de vínculo puede tener menos funciones o no aparecer en absoluto. La siguiente tabla muestra esto:
Además de eso, si se especifica |1=o |content=, no se mostrará el texto "Agregar categorías a la subpágina /doc".
Esta plantilla se coloca normalmente en el espacio de nombres del asunto , pero en algunos casos es necesario que esté en el espacio de nombres de la conversación :
<noinclude>a menudo no funciona en los mensajes del sistema y el espacio de nombres MediaWiki debe mantenerse limpio por razones de rendimiento.Cuando se coloca en páginas de discusión, esta plantilla generalmente se ubica 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 tema, excepto en los espacios de nombres que no tienen habilitada la función de subpágina de 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 de la categoría para evitar la creación de categorías vacías. También hay muchas otras razones técnicas por las que la página /doc debe almacenarse debajo de la página de discusión para esos (pero solo esos) 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] | header-style = | header = | link box = }}o{{ Documentación | [ruta a la página de documentación] | contenido = | estilo-de-encabezado = | encabezado = | cuadro de enlace = | página = }}