Ayuda: manuales de plantilla
Las plantillas son una característica muy poderosa del software MediaWiki , pero pueden ser difíciles de usar para los nuevos usuarios, e incluso los expertos pueden tener problemas para comprender cómo funcionan las más complejas. Por esta razón, las plantillas siempre deben venir con un manual de usuario, legible en la propia página de la plantilla.
El manual debe explicar qué hace una plantilla y cómo usarla, de una manera suficientemente clara incluso para los usuarios que no son expertos en la sintaxis de programación de plantillas, no pocos incluso entre los veteranos de Wikipedia.
En cuanto a la estructura, todos los manuales deben cumplir en la medida de lo posible con esta guía, con el fin de intentar estandarizar su funcionalidad y apariencia gráfica.
 - Mostrador de información |
Que incluir en el manual
Una plantilla de manual debe incluir:
- El propósito de la plantilla: el resultado, si no es inmediatamente obvio, la utilidad, junto con la descripción de los tipos de páginas y elementos para los que es posible o no utilizar.
- Los parámetros de la plantilla: si es suficiente indicarlos secuencialmente o si deben ser nombrados explícitamente, si son obligatorios u opcionales, cuáles son los valores permitidos para cada parámetro, cuáles son los valores por defecto y qué efecto tienen. Todo esto debe explicarse claramente, para todos los parámetros.
- Si la plantilla puede y / o debe ser subestimada o no.
- Ejemplos de uso : indicación del código de lenguaje wiki exacto que debe usarse y el resultado que produce. El ejemplo debe incluirse entre
<code>...</code>, para que sea claro y fácil de copiar, como por ejemplo:
{{non firmato|pinco pallino|01:19, 13 set 2010}}
Si la plantilla se puede utilizar de muchas formas diferentes, con o sin parámetros opcionales, se deben dar ejemplos apropiados. Puede resultar muy útil incluir la propia plantilla en tu manual unas cuantas veces, en varios ejemplos reales, con diferentes parámetros, indicando lo mismo. - Páginas relacionadas : si la plantilla pertenece a una serie, incluya los wikilinks a las otras plantillas de la misma serie, para facilitar la navegación (una plantilla de navegación especial puede ser útil). Sin embargo, se deben indicar plantillas similares y las diferencias para elegir la más adecuada. Finalmente, es necesario indicar las páginas de ayuda, pautas y proyecto útiles para entender cómo utilizar la plantilla.
Crea un manual
La documentación de la plantilla a menudo se escribe en una subpágina de la propia plantilla que luego se incluye al final del código de la plantilla.
Para crear un manual, asegúrese de que la página de la plantilla no esté ya presente en la plantilla: service man ( {{ man }} ). Si está ausente, insértelo entre las <noinclude></noinclude> (para evitar que el manual sea reportado en las páginas que usan la plantilla), guarde la página y haga clic en la palabra ¡ Crear instrucciones! .
El manual se inserta en una subpágina porque de esta manera el código, a menudo complejo, se separa de la documentación, lo que hace que la parte de la documentación sea más fácil de compilar y administrar. También permite una protección más fácil del código de la plantilla, cuando sea necesario, dejando a cualquiera la posibilidad de modificar o integrar el manual.
Editar un manual
Los manuales de plantilla siempre se pueden editar. Si ha introducido el {{ man }} correctamente, habrá un enlace para editarlo.
Estructura del manual
Por lo tanto, dentro del manual debe encontrar estas secciones esenciales:
Incipit
== Uso ==
== Parametri ==
== Esempi d'uso ==
== Note ==
== Pagine correlate ==
[[Categoria:Manuali dei template]]
Comience a escribir el manual escribiendo el propósito y la utilidad para los que se creó la plantilla.
Usar
Proporcione detalles sobre los tipos de páginas y elementos en los que es posible o no su uso, y comparación con plantillas similares.
Parámetros
Debe explicarse el funcionamiento de cada parámetro. Un buen método es escribir el código de la plantilla en la forma en que se utilizará, con una explicación de los parámetros al lado.
P.ej:
{{Nombre de la plantilla
| parámetro1 =
| parámetro2 =
...
}}
- parámetro1 = explicación del parámetro1
- parámetro2 = explicación del parámetro2
- ...
Para ingresar parámetros, especialmente si hay muchos, puede usar las plantillas {{ TableTemplate }} y {{ Parameter }} con la tabla de colores relativos para asignar prioridades.
Las hay obligatorias , opcionales , recomendadas y a tener en cuenta , es decir, aquellas en las que solo se aceptan determinados valores, para lo cual de ser necesario se recomienda insertar un subapartado (por ejemplo == Valori accettati dal parametro "pincopallino" == ) para explicar mejor cómo funciona.
Ejemplos de uso
A veces, la explicación de los parámetros por sí sola puede no ser suficiente para aclarar cómo utilizar la plantilla. Por lo tanto, se recomienda proporcionar algunos ejemplos prácticos en los que se usó la plantilla creando el encabezado == Esempi d'uso == .
Habitualmente se utiliza la forma " código - ejemplo ", es decir, a la izquierda el código como se debe insertar ya la derecha lo que genera el código, que es la plantilla tal y como aparece en las páginas en las que se utiliza.
El código de ejemplo se incluirá en el <poem><code><nowiki>...</nowiki></code></poem> (" código ") o <pre>..</pre> (" pre -formateado ") para facilitar la lectura.
P.ej:
Con la etiqueta <poem><code><nowiki>...</nowiki></code></poem>
{{Libro
|titolo=commedia
|titoloalfa=Divina Commedia
|immagine=Gustave Doré - Dante Alighieri - Inferno - Plate 18 (Canto V - Dante has a touch of the vapours).jpg
|didascalia=Scena del poema illustrata da<br>[[Gustave Doré]]
|autore=[[Dante Alighieri]]
|annoorig=tra il [[1304]] e il [[1321]]
|genere=[[Poema]]
|protagonista=[[Dante]]
|altri_personaggi=[[Virgilio]], [[Beatrice]]
}}
Con la etiqueta <pre>..</pre>
{{Libro
| título = comedia
| titoloalfa = Divina Comedia
| image = Gustave Doré - Dante Alighieri - Inferno - Lámina 18 (Canto V - Dante tiene un toque de vapores) .jpg
| caption = Escena del poema ilustrado por <br> [[Gustave Doré]]
| autor = [[Dante Alighieri]]
| annoorig = entre [[1304]] y [[1321]]
| género = [[Poema]]
| protagonista = [[Dante]]
| otros_caracteres = [[Virgil]], [[Beatrice]]
}} | comedia | |
|---|---|
 Gustave Doré | |
| Autor | Dante Alighieri |
| 1ª ed. original | entre 1304 y 1321 |
| Escribe | Poema |
| Protagonistas | Dante |
| Otros personajes | Virgilio , Beatriz |
En el caso de plantillas que sean excesivamente anchas, o que ocupen todo el ancho de la página, puede insertar la plantilla generada como ejemplo debajo del código de explicación.
Nota
El uso de notas también está permitido en los manuales de la plantilla, con el fin de proporcionar toda la información posible.
Páginas relacionadas
Para facilitar la navegación entre las plantillas, que a menudo puede resultar compleja, es recomendable incluir, bajo el encabezado == Pagine correlate == , las plantillas vinculadas a la en cuestión. Se recomienda el uso de una lista con viñetas para enumerarlos .
Por ejemplo, para la plantilla {{ Columns }} escriba:
Finalmente, entre las páginas relacionadas, también se deben insertar páginas de ayuda o pautas sobre el uso de la plantilla.
Finalmente, es aconsejable colocar la plantilla {{ Proyecto }} que enumera los proyectos en los que la plantilla cae temáticamente, además del Proyecto: Plantilla .
Por ejemplo, para la plantilla {{ Film }} (que se utiliza en los elementos relacionados con el Proyecto: Cine ) escriba:
{{Progetto|Cinema|Template}}
para obtener:
Las abreviaturas útiles (redirecciones) del nombre de la plantilla se pueden informar al comienzo del manual a través de {{ abreviaturas }}.
Categorización
Cada manual debe insertarse en la Categoría: Manuales de plantilla escribiendo la cadena al final de la página:
<noinclude>[[Categoria:Manuali dei template]]</noinclude>
Las etiquetas noinclude evitan esta categorización incluso para las páginas en las que se insertará la plantilla.