Ayuda:Plantillas
| Ayuda de edición (contenidos) |
| Artículos |
| Usando MediaWiki (Referencia rápida) |
Una plantilla es un fragmento de código de Wikivoyage —y de los otros proyectos de la Fundación Wikimedia— que puede ser reutilizado por muchas páginas distintas, sin necesidad de copiar todo el código nuevamente. Corresponden a un tipo de páginas especiales, destinadas a utilizarse dentro de otras, y que utilizan el espacio de nombres «Plantilla:».
Antes de crear una plantilla, asegúrate de leer y entender esta guía, en particular la sección Sugerencias.
Estructura de una plantilla
[editar]El contenido de toda plantilla está distribuido de tres maneras:
Contenido de uso
[editar]Corresponde al código base de la plantilla, que la faculta para hacer algo en particular, distinto de las demás.
Contenido inclusivo: «noinclude»
[editar]Corresponde al código que no se incluirá en las páginas que utilicen la plantilla. Debe escribirse dentro de las etiquetas <noinclude> y </noinclude>, y se utiliza sobre todo para agregar categorías, interwikis y documentación a la plantilla.
Contenido exclusivo: «includeonly»
[editar]Corresponde al código que sólo se incluirá en las páginas que utilicen la plantilla (y no en la plantilla propiamente tal). Debe escribirse dentro de las etiquetas <includeonly> e </includeonly>, y se utiliza sobre todo para agregar categorías a las páginas marcadas con las plantillas.
Ejemplo:
| página | Plantilla:Ejemplo de plantilla | Ejemplo de artículo |
| código |
|
|
| resultado | Este texto se incluye desde la plantilla en el artículo principal |
Este texto está en el artículo, y ...
Este texto se incluye desde la plantilla en el artículo principal |
Cómo utilizar una plantilla
[editar]Supongamos que queremos utilizar una plantilla llamada Plantilla:Nombre_de_plantilla en una página cualquiera, llamada [[Página de ejemplo]]. Esto podemos hacerlo de dos maneras diferentes:
Sustitución
[editar]Se escribe {{subst:Nombre_de_plantilla}} en [[Página de ejemplo]], con lo cual tanto el contenido de uso como el contenido exclusivo de la plantilla se agregan permanentemente a la [[Página de ejemplo]].
La sustitución se utiliza cuando queremos que el contenido incorporado por la plantilla pueda editarse desde la página marcada, sin alterar la plantilla propiamente tal. Así, [[Plantilla:Nombre_de_plantilla]] y [[Página de ejemplo]] siguen siendo independientes, y los cambios que afecten a una, no afectarán a la otra.
Transclusión
[editar]Se escribe {{Nombre_de_plantilla}} en [[Página de ejemplo]], con lo cual, cada vez que la página se carga, también se carga el contenido de la [[Plantilla:Nombre_de_plantilla]], reproduciéndose en la visualización de la página. De esta forma se cargan dos páginas en vez de una: [[Página de ejemplo]] y [[Plantilla:Nombre_de_plantilla]], creando una dependencia entre ambas.
La transclusión ralentiza la carga de las páginas, pero permite rastrear aquellas páginas que utilizan las plantillas (funcionalidad muy útil en ciertas ocasiones). Además, como el contenido de la plantilla utilizada no se guarda en la página que la utiliza, el código de esta última no se ensucia, haciéndose más fácil de entender, y por tanto de editar.
Pseudoplantillas
[editar]Existen páginas, que a pesar de no utilizar el espacio de nombres Plantilla:, son utilizadas como tales. Su inclusión es análoga a las Plantillas normales, con la salvedad de que no se puede obviar el espacio de nombres. Un ejemplo son las userboxes.
Mostrar el nombre en una página
[editar]Para mostrar el nombre de una plantilla en una página se utiliza la plantilla {{Ep}}.
Parámetros
[editar]Plantillas con parámetros
[editar]Las plantillas aceptan parámetros o argumentos, que les permite aumentar sus funcionalidades, adecuándose a las necesidades de cada página que las utiliza. Así, el contenido de una misma plantilla puede variar en función de los valores que toman los parámetros al momento de utilizarse.
Un parámetro se define mediante la etiqueta {{{n}}}, donde n es un número o identificador de texto.
Supongamos que la Plantilla:Nombre_de_plantilla tiene dos parámetros: texto1 y texto2. Entonces, para que una página los utilice (mediante transclusión), se deberá escribir en ella
{{Nombre_de_plantilla|texto1|texto2}}
si no se han definido nombres para los parámetros; y
{{Nombre_de_plantilla|parámetro1=texto1|parámetro2=texto2}}
si los parámetros se han definido con los nombres parámetro1 y parámetro2, respectivamente. Note que las plantillas no están limitadas sólo a dos parámetros, y en general se podrán usar cuantos se necesiten.
Ejemplo:
| página | Plantilla:Ejemplo de plantilla | Ejemplo de artículo |
| código |
|
|
| resultado | La fecha es {{{fecha}}} y la contraseña es {{{clave}}} |
Este texto está en el artículo, y ... |
Nótese cómo en la segunda inclusión, al no asignársele valores a los parámetros fecha y clave, los textos {{{fecha}}} y {{{clave}}} no se reemplazaron y quedaron tal cual. Cómo evitarlo se verá en la sección de Valores por defecto.
Si se le asigna más de un valor al mismo parámetro, sólo la última asignación se tomará en cuenta. Por ejemplo,
{{Ejemplo de plantilla|'''clave=zxcvz'''|'''clave=12345'''}}
es equivalente a
{{Ejemplo de plantilla|'''clave=12345'''}}.
Parámetros posicionales
[editar]Podemos llamar a los parámetros mediante números, de manera que prescindamos de nombrarlos explícitamente. Así, podríamos escribir
{{Nombre de la plantilla|texto1|texto2|...}}
y la plantilla reconocerá automáticamente los parámetros por orden secuencial, como si el primer campo se llamara 1, el segundo 2, etc.
Ejemplo:
| página | Plantilla:Ejemplo de plantilla | Ejemplo de artículo |
| código |
|
|
| resultado | La fecha es {{{1}}} y la contraseña es {{{2}}} |
Este texto está en el artículo, y ... |
Otro Ejemplo:
| página | Plantilla:Muestra cuenta | Ejemplo de artículo |
| código |
|
|
| resultado | La cuenta es {{{1}}} |
Este texto está en el artículo, y ... |
Note que este ejemplo falla. El problema está en que el texto que estamos pasando como primer parámetro («2+2=4») tiene un signo igual. El signo igual se utiliza en la sintaxis de los parámetros nombrados, por lo que el sistema cree que le estamos pasando un parámetro de nombre «2+2» con valor «4». La solución consiste en nombrar explícitamente el nombre del parámetro («1»). Luego del primer signo igual, que se usa para separar el nombre del parámetro de su valor, ya no importa si hay más.
| página | Plantilla:Muestra cuenta | Ejemplo de artículo |
| código |
|
|
| resultado | La cuenta es {{{1}}} |
Este texto está en el artículo, y ... |
Este problema suele suceder a menudo cuando se pasan URL como parámetros posicionales. Muchas veces, las URL (como http://es.wikivoyage.org/w/index.php?title=Ayuda:Plantillas) suelen tener signos igual, y el sistema toma como nombre del parámetro todo lo que esté delante del primero (con la URL de ejemplo, interpretaría que hay un parámetro llamado «http://es.wikivoyage.org/w/index.php?title» con valor «Ayuda:Plantillas»). Por eso, siempre es conveniente nombrar el parámetro explícitamente cuando se le quiera pasar una URL a una plantilla.
Parámetros combinados
[editar]Los parámetros nombrados y posicionales se pueden combinar sin problema. El sistema le asignará un número secuencial a cada uno de los parámetros sin nombre, y luego aplicará las reglas de los parámetros nombrados. Por ejemplo,
{{Info|q|s|commons|2=wikt|wikisource=Ayuda|otro}}
es equivalente a
{{Info|1=q|2=s|3=commons|2=wikt|wikisource=Ayuda|4=otro}}
que, como el parámetro «2» aparece dos veces, es lo mismo que
{{Info|1=q|3=commons|2=wikt|wikisource=Ayuda|4=otro}}.
Valores por defecto
[editar]Es posible especificar valores por defecto para los parámetros, de la siguiente manera:
{{{nombre del parámetro|valor por omisión}}}
Ejemplo:
| página | Plantilla:Ejemplo de plantilla | Ejemplo de artículo |
| código |
|
|
| resultado | La fecha es hoy |
Este texto está en el artículo, y ... |
Como se ve, en la segunda inclusión de la plantilla no se le asignó valor al parámetro fecha, por lo que se incluyó el valor por defecto, hoy.
Sugerencias
[editar]No abuses de las plantillas
[editar]Ten en cuenta que existen muchísimas plantillas para los más diversos temas, y que es muy posible que alguien ya haya creado una plantilla para lo que deseas. Por eso, evita la creación de plantillas redundantes o innecesarias.
No son razones para crear una plantilla:
- Que ya exista una análoga en una wiki de otro idioma: muchas wikis no poseen un control sobre la creación de plantillas, y para una misma tarea puede haber muchísimas, lo que dificulta el mantenimiento. No copiemos los malos ejemplos.
- Que ya exista una plantilla específica para otro tema: dado el caso, en lugar de crear otra plantilla que hace prácticamente lo mismo, es mejor pensar en ampliar la plantilla ya existente, incorporándole parámetros.
Respeta las convenciones de títulos
[editar]A pesar que la política de convenciones de títulos no está orientada a las plantillas, sí es muy deseable que los títulos que elijas sean en español e intuitivos. Lo mismo pasa con los nombres de los parámetros: prefiere aquellos explicativos en lugar a las abreviaciones, pero también evita que sean demasiado largos, para facilidad de uso.
Categoriza y documenta
[editar]Nunca olvides categorizar y documentar las plantillas, mediante la etiqueta «noinclude» explicada inicialmente.