Revisión del 22:02 5 oct 2008 editar Jurock (discusión \| contribs.) Editores, Revisores 19 352 ediciones Página Nueva: {{how-to\|WP:DOC}} Las plantillas son una parte muy poderosa de w:MediaWiki, pero pueden ser confusas para nuevos usuarios, e incluso los más experimentados...		Revisión del 22:11 5 oct 2008 editar deshacer Jurock (discusión \| contribs.) Editores, Revisores 19 352 ediciones Sin resumen de edición Ir a siguiente diferencia →
Línea 1: {{~~how-to\|WP:DOC~~convención}} Las '''[[Ayuda:Plantillas\|plantillas]]''' son una parte muy poderosa de [[w:MediaWiki\|MediaWiki]], pero pueden ser confusas para nuevos usuarios, e incluso los más experimentados pueden tener dificultad con las más complejas. Las plantillas deberán, en consecuencia, estar acompañadas por una '''[[w:documentación\|documentación]]''' para ayudar en el uso por parte del usuario promedio. La documentación deberá explicar qué hace una plantilla y cómo usarla. Debe ser lo suficientemente simple para que un usuario sin conocimientos profundos sobre plantillas puedan utilizarlas correctamente. Esto es especialmente cierto en el caso de plantillas utilizadas ampliamente. Línea 13: * '''Ejemplos de uso'''. Se debe especificar el wikitexto exacto que deberá ser usado, y el resultado que produce, y debe ser fácil de copiar al utilizar <code><nowiki><code>...</code></nowiki></code> o un cuadro con <nowiki><pre>...</pre></nowiki>. * '''Plantillas relacionadas''' Si la plantilla es una de una serie de plantillas, incluye los enlaces a estas – en particular, asegúrate de que cada plantilla de la serie esté enlazada con el resto, ya que hace la navegación más fácil. * '''[[Ayuda:categorías\|categorías]]''' e '''[[Ayuda:~~interwikis~~Enlaces interlingüísticos\|interwikis]]''' apropiados, donde sea aplicable. Las categorías de plantillas se encuentran en [[:Categoría:Wikinoticias:Plantillas]]. '''Estos deberán incluirse en la página de documentación''' utilizando tags <code>&ltincludeonly>&lt/includeonly></code> == Subpágina == Línea 33: Si no existe una página de documentación, entonces se deberá crearla. En el caso de que no exista aún la página de documentación pero la plantilla es añadida, se especificará que no existe tal página y se dará un enlace; si primero se añade la plantilla {{tl\|uso de plantilla}} y luego cliquea en el enlace que esta produce al no tener subpágina de documentación, se puede utilizar [[mw:Extension:Inputbox#Preload\|precarga]] para crear la página más fácil. '''Asegúrate''' de que el código de <code><nowiki><noinclude></nowiki></code> comience luego del último ~~caracter~~carácter del código de la plantilla, y '''no''' en una nueva línea. De otro modo, el espacio extra se insertará ''debajo'' de la plantilla cuando se la utilice, lo que no es usualmente lo deseado. ==== Categorías e interwikis ====▼ También, añade las categorías e interwikis en la página de documentación, ya que así la documentación no estará esparcida en dos páginas.▼ ▲~~También, añade~~Añade las categorías e interwikis (que sean utilizados en la plantilla en sí, pero '''no''' al ser transcluida) en la página de documentación, ya que así la documentación no ~~estará~~deberá estar esparcida en dos páginas. ▲==== Categorías e interwikis === * '''Para categorizar la plantilla''', añade la categoría entre tags <code><includeonly>...<includeonly></code> en la subpágina de documentación. * '''Para añadir interwikis a la plantilla''', añade los interwikis entre los mismos tags <code><includeonly>...<includeonly></code> que se habían utilizado en la subpágina de documentación.▼ * '''Para categorizar la subpágina''', cuya categoría deberá ser únicamente {{catlink\|Wikinoticias:Indicaciones para el uso de plantillas}}, añade <code><nowiki>[[Categoría:Wikinoticias:Indicaciones para el uso de plantillas]]</nowiki></code> entre tags <code><noinclude>...</noinclude></code>. ▲'''Para añadir interwikis a la plantilla''', añade los interwikis entre los mismos tags <code><includeonly>...<includeonly></code> que se habían utilizado en la subpágina de documentación. * '''Para que la plantille categorice un artículo''', es decir, que al ser transcluida añada un artículo a alguna categoría, la categoría deberá estar entre tags <code><includeonly>...<includeonly></code> '''en la plantilla, no la subpágina'''. ~~'''Para categorizar la subpágina''', cuya categoría deberá ser únicamente {{catlink\|Wikinoticias:<!--~~ '''To place the ''doc'' subpage into a category''', add the <code><nowiki>[[Category:Category name]]</nowiki></code> code inside a <code><nowiki><noinclude></nowiki></code>...<code><nowiki></noinclude></nowiki></code> section on the ''doc'' subpage. '''To make the template place an article into a category''' (when the article includes the template), add the <code><nowiki>[[Category:Category name]]</nowiki></code> code inside an <code><nowiki><includeonly></nowiki></code>...<code><nowiki></includeonly></nowiki></code> section on the template page. === Ventajas === Línea 55 ⟶ 50: * Introducir la documentación en una subpágina hace que sea menor el texto que tiene que ser procesado cada vez que la plantilla es transcluida, razón por la cual los desarrolladores de MediaWiki lo [http://en.wikipedia.org/w/index.php?title=Wikipedia:Village_pump_(technical)&diff=prev&oldid=69888944 han recomendado] == Véase también == * {{tl\|uso de plantilla}} – La plantilla que deberá utilizarse para crear la subpágina de documentación de plantilla * [[m:Help:Templates#Noinclude, includeonly, and onlyinclude\|<TT><noinclude></TT> ~~and~~e <TT><includeonly></TT>]]▼ [[Categoría:Wikinoticias:Indicaciones para el uso de plantillas\| ]] ~~== Categories and interwiki links ==~~ '''To place the template itself into a category''', add the <code><nowiki>[[Category:Category name]]</nowiki></code> code inside an <code><nowiki><includeonly></nowiki></code>...<code><nowiki></includeonly></nowiki></code> section on the ''doc'' subpage. '''To create an interwiki link for the template itself''', add the <code><nowiki>[[Languagecode:Template name]]</nowiki></code> code inside an <code><nowiki><includeonly></nowiki></code>...<code><nowiki></includeonly></nowiki></code> section on the ''doc'' subpage. '''To place the ''doc'' subpage into a category''', add the <code><nowiki>[[Category:Category name]]</nowiki></code> code inside a <code><nowiki><noinclude></nowiki></code>...<code><nowiki></noinclude></nowiki></code> section on the ''doc'' subpage. '''To make the template place an article into a category''' (when the article includes the template), add the <code><nowiki>[[Category:Category name]]</nowiki></code> code inside an <code><nowiki><includeonly></nowiki></code>...<code><nowiki></includeonly></nowiki></code> section on the template page. ~~== Example ==~~ See the heavily-used [[Template:Cite web]] for an example of detailed template documentation. Note that the template itself is protected, but the documentation subpage, [[Template:Cite web/doc]] is unprotected and can still be edited. ~~== /sandbox and /testcases ==~~ Before doing changes to a template it can be good to first copy the template code to a sandbox and run some testcases, since the template might be visible on thousands of pages. If you create subpages named exactly "'''/sandbox'''" and "'''/testcases'''" to a template then the green {{tlc\|documentation}} box on the template auto-detects this and will show links to those pages in its header. See [[Wikipedia:Template test cases]] for more information. ~~== Several templates, one documentation page ==~~ When several templates work together or are very similar then it is often clearer and easier to maintain one single documentation page that documents them together. The simplest way to do this is to make a full documentation page at one of the templates, and then make "soft redirects" from the other templates. That is, to make very short documentation pages at the other templates that have only one or two sentences that states where the full documentation can be found and link to it. See for instance {{tl\|wrap}}. ~~== See also ==~~ * {{tl\|Documentation}} – Transcludes the documentation on the template page, and provides documentation view, edit and history links * {{tl\|Documentation subpage}} – Explains that what follows is documentation, and links to the documented page ~~Other:~~ ▲* [[m:Help:Templates#Noinclude, includeonly, and onlyinclude\|<TT><noinclude></TT> and <TT><includeonly></TT>]] * [[Wikipedia:High-risk templates]] * [[Wikipedia:Template test cases]] ~~[[Category:Wikipedia templates\|{{PAGENAME}}]]~~ ~~[[Category:Template documentation\| <!--SPACE-->]]~~ ~~[[ar:ويكيبيديا:توثيق قالب]]~~ ~~[[hu:Wikipédia:Sablondokumentáció]]~~ ~~[[id:Wikipedia:Dokumentasi templat]]~~ ~~[[mk:Википедија:Документирање на шаблон]]~~ ~~[[ja:Help:テンプレートの説明文]]~~ ~~[[uk:Вікіпедія:Документація шаблонів]]~~ ~~[[zh:Wikipedia:模板文档頁模式]]~~

Diferencia entre revisiones de «Wikinoticias:Documentación de plantilla»