Diferencia entre revisiones de «Documentación/doc»

Revisión del 02:06 19 nov 2016

Esta plantilla automáticamente muestra un cuadro de documentación como el que estás viendo ahora.

El uso de esta plantilla permite que las plantillas que la utilizan se puedan documentar y categorizar, independientemente de que éstas se encuentren protegidas o no.

Uso

/doc normal

<noinclude>
{{documentación}}</noinclude>

La plantilla carga el contenido de la subpágina /doc desde donde es usada.

Cualquier página /doc

<noinclude>
{{documentación|Plantilla:cualquier página/doc}}</noinclude>

Además se puede cargar la documentación de cualquier otra plantilla para evitar redundancias.

Mejor práctica

Este código debe añadirse al final del código de la plantilla, sin espacios de más antes de «<noinclude>» (que causaría espacios de más en páginas donde se usa la plantilla). El parámetro puede usarse como se muestra más arriba para incluir una página de documentación arbitraria.

Las categorías que aplican a la propia plantilla deben añadirse a la página de documentación, dentro de etiquetas <includeonly> e </includeonly>. Y los enlaces interwiki deben añadirse en Wikidata.

Si la página de documentación contiene etiquetas includeonly o noinclude como parte de la documentación, reemplázalas «<» por «<».

Funciones

Si la página de documentación no existe, el enlace «crear» incluye un parámetro de precarga de manera que haciendo clic en él se pre-rellenará el formulario de edición con el formato básico de la página de documentación.

Detalles técnicos

Esta plantilla llama a {{documentación/caja inicial}} y a {{documentación/caja final}}. La /caja inicial (y la /caja final) contienen la mayoría del código.

La página de precarga para el enlace [crear] de la página /doc es Plantilla:Documentación/precarga. Las páginas de precarga para los enlaces [crear] de las páginas /zona de pruebas y /casos de prueba son Plantilla:Documentación/precarga-zona de pruebas y Plantilla:Documentación/precarga-casos de prueba.

Véase también

@@ Línea 1: / Línea 1: @@
 {{subpágina de documentación}}
-<!-- POR FAVOR AÑADE LAS CATEGORÍAS E INTERWIKIS AL FINAL DE ESTA PÁGINA -->
+Esta plantilla automáticamente muestra un cuadro de documentación como el que estás viendo ahora.
-__NOTOC__
-Esta plantilla automaticamente muestra un cuadro de documentación como el que estás viendo ahora.
-== Uso ==
+El uso de esta plantilla permite que las plantillas que la utilizan se puedan documentar y categorizar, independientemente de que éstas se encuentren [[Wikipedia:Política de protección|protegidas]] o no.
-=== /doc normal ===
+=== Uso ===
+==== /doc normal ====
 <pre><noinclude>
 {{documentación}}</noinclude></pre>
@@ Línea 11: / Línea 11: @@
 La plantilla carga el contenido de la subpágina /doc desde donde es usada.
-=== Cualquier página /doc ===
+==== Cualquier página /doc ====
 <pre><noinclude>
 {{documentación|Plantilla:cualquier página/doc}}</noinclude></pre>
@@ Línea 17: / Línea 17: @@
 Además se puede cargar la documentación de cualquier otra plantilla para evitar redundancias.
-=== Mejor práctica ===
+==== Mejor práctica ====
 Este código debe añadirse al final del código de la plantilla, sin espacios de más antes de «<code>&lt;noinclude></code>» (que causaría espacios de más en páginas donde se usa la plantilla). El parámetro puede usarse como se muestra más arriba para incluir una página de documentación arbitraria.
-Las categorías y los enlaces interwiki que aplican a la propia plantilla deben añadirse a la página de documentación, dentro de etiquetas <code><nowiki><includeonly></nowiki></code> e <code><nowiki></includeonly></nowiki></code>.
+Las categorías que aplican a la propia plantilla deben añadirse a la página de documentación, dentro de etiquetas <code><nowiki><includeonly></nowiki></code> e <code><nowiki></includeonly></nowiki></code>. Y los enlaces interwiki deben añadirse en [[Wikidata]].
-Si la página de documentación contiene etiquetas includeonly o noinclude como parte de la documentación, reemplaza las «<» por «&amp;lt;».
+Si la página de documentación contiene etiquetas includeonly o noinclude como parte de la documentación, reemplázalas «<» por «&amp;lt;».
-== Funciones ==
+=== Funciones ===
 Si la página de documentación no existe, el enlace «crear» incluye un parámetro de precarga de manera que haciendo clic en él se pre-rellenará el formulario de edición con el formato básico de la página de documentación.
-== Fundamento ==
+=== Detalles técnicos ===
-El uso de esta plantilla permite que las plantillas sean [[Wikipedia:Política de protección|protegidas]] cuando sea necesario, mientras que permite a cualquiera editar la documentación, las categorías y los enlaces interwiki.
+Esta plantilla llama a {{ep|documentación/caja inicial}} y a {{ep|documentación/caja final}}. La /caja inicial (y la /caja final) contienen la mayoría del código.
+La página de precarga para el enlace <small>[crear]</small> de la página /doc es [[Plantilla:Documentación/precarga]]. Las páginas de precarga para los enlaces <small>[crear]</small> de las páginas /zona de pruebas y /casos de prueba son [[Plantilla:Documentación/precarga-zona de pruebas]] y [[Plantilla:Documentación/precarga-casos de prueba]].
-== Véase también ==
+=== Véase también ===
 * [[Plantilla:Documentación/doc]]
+* [[Plantilla:Documentación/caja]]
 * [[Plantilla:Documentación/precarga]]
+* [[Plantilla:Documentación/precarga módulo]]
+* [[Plantilla:Documentación/precarga módulo tests]]
 * [[Plantilla:Documentación/zona de pruebas]]
 * [[Plantilla:Subpágina de documentación]]
 <includeonly>
-[[Categoría:Wikipedia:Plantillas de plantillas|{{PAGENAME}}]]
+[[Categoría:Wikipedia:Plantillas de documentación]]
-[[simple:Template:Documentation]]
-[[ar:قالب:توثيق]]
-[[ba:Ҡалып:Doc]]
-[[bg:Шаблон:Документация]]
-[[bs:Šablon:Dokumentacija]]
-[[ca:Plantilla:Ús de la plantilla]]
-[[cs:Šablona:Dokumentace]]
-[[cy:Nodyn:Doc]]
-[[da:Skabelon:Dokumentation]]
-[[de:Vorlage:Dokumentation]]
-[[dsb:Pśedłoga:Dokumentacija]]
-[[et:Mall:Usage of template]]
-[[en:Template:Documentation]]
-[[eo:Ŝablono:Dok]]
-[[eu:Txantiloi:Txantiloi dokumentazioa]]
-[[fa:الگو:توضیحات]]
-[[fr:Modèle:Documentation]]
-[[gl:Modelo:Uso de marcador]]
-[[he:תבנית:תיעוד]]
-[[hsb:Předłoha:Dokumentacija]]
-[[la:Formula:Documentation]]
-[[hu:Sablon:Sablondokumentáció]]
-[[hy:Կաղապար:Փաստաթղթեր]]
-[[ia:Patrono:Docpatrono]]
-[[id:Templat:Dokumentasi]]
-[[it:Template:Man]]
-[[ja:Template:Documentation]]
-[[ko:틀:틀 설명문서]]
-[[ku:Şablon:Belgekirin]]
-[[ml:ഫലകം:വിവരണം]]
-[[ms:Templat:Dokumentasi]]
-[[no:mal:Dokumentasjon]]
-[[nl:Sjabloon:Sjabdoc]]
-[[pl:Szablon:Dokumentacja]]
-[[pt:Predefinição:Documentação]]
-[[ro:Format:Documentaţie]]
-[[ru:Шаблон:Doc]]
-[[sk:Šablóna:Dokumentácia]]
-[[sl:Predloga:Dokumentacija]]
-[[sr:Шаблон:Документација]]
-[[sq:Stampa:Dokumentacion]]
-[[stq:Foarloage:Dokumentation]]
-[[sv:Mall:Dokumentation]]
-[[tl:Template:Documantation]]
-[[tpi:Template:Template doc]]
-[[uk:Шаблон:Документація]]
-[[ur:سانچہ:دستاویز]]
-[[war:Template:Documentation]]
-[[zh:Template:Documentation]]
-[[te:మూస:Documentation]]
 </includeonly>

Plantilla