Help:TemplateData/es

What is TemplateData?
TemplateData es una forma de almacenar información acerca de una plantilla y sus parámetros, para que  VisualEditor pueda recupararlo y desplegarlo en el editor de plantillas, haciendo más fácil editar plantillas.

La sintaxis de TemplateData permite a los usuarios escribir pequeñas partes de información estructurada a una página de plantilla, o para incluirse en una página de plantilla (tal como una página de documentación de plantillas). Una vez que una plantilla tiene esta información estructurada, puede desplegarse apropiadamente en VisualEditor. Aunque puede sonar complejo, realmente es muy fácil.

TemplateData editor
Hay una herramienta integrada para la edición de TemplateData de forma más simple.

Para usar el editor de TemplateData, ve a la página de la plantilla (o a su subpágina de documentación) y presiona el botón "Editar". Te mostrará un botón que dice "", justo arriba de la ventana de edición abierta: Presiona este botón para ingresar a la herramienta visual y editar TemplateData. El editor te permite añadir una fila por cada parámetro de plantilla y establecer los atributos más comunes. Si la página que ya has editado contiene un bloque de TemplateData, a continuación, la información ya documentada se mostrará automáticamente cuando abras la página correcta en el editor TemplateData. En el primer cuadro, se puede añadir o actualizar una breve descripción de la plantilla en texto plano. Después de eso, puedes utilizar los botones "Importar parámetros" y "Añadir parámetros" para documentar los nombres y atributos de los parámetros que utiliza la plantilla.

Puedes listar el nombre del parámetro, cualquier alias para él, la etiqueta y la descripción que se mostrará a los usuarios. El único campo obligatorio es el nombre (el primer campo en cada fila), que es donde se graba el registro exacto, distinguiendo entre mayúsculas y minúsculas, del parámetro. En el menú emergente, puedes elegir el tipo de contenido que el parámetro debe recibir, tal como una cadena (para respuestas de texto plano), la página (para los enlaces a otras páginas), o fechas. Si la plantilla produjera un error si este parámetro se deja en blanco, por favor márcalo como "Obligatorio". Si el parámetro se utiliza o se recomienda habitualmente, márcalo como "sugerido". El botón "Eliminar" eliminará la entrada del parámetro desde TemplateData. Cuando termines de documentar cada uno de los parámetros, presiona "Aplicar" para insertar el TemplateData preformateado dentro de la caja de edición abierta. Debes todavía guardar la página, usar el botón normal "Guardar" debajo de la ventana de edición.

Precuaución: El editor TemplateData colocará el TemplateData tanto en la página de la plantilla o en una subpágina de la documentación. Tú determinas dónde el TemplateData se agregará al abrir (editar) la página donde quieres que el TemplateData se coloque. Sin embargo, si múltiples bloques TemplateData se colocan en la misma plantilla, solo uno de los bloques TemplateData se utilizará. Si ya hay un TemplateData en una página, necesitarás editar la página donde se colocó previamente el TemplateData para evitar accidentalmente crear bloques múltiples de TemplateData.

Limitations and questions

 * Funcionalidades faltantes — TemplateData es mucho un ejemplo de herramienta que se hizo disponible con pocas características, con la esperanza de que los usuarios ayuden al desarrollo de guías de caracterísiticas cuando lo decidan. Si quisieras solicitar nuevas caracerísticas de TemplateData, por favor, háznoslo saber.
 * Retrasos mostrando las plantillas — Después de agregar TemplateData a una plantilla, la metainformación debiera ser visible inmediatamente cuando la plantilla se abra en VisualEditor. Sin embargo, es posible que tome horas antes que la metainformación se muestre. Puedes forzar una actualización haciendo una edición nula a la propia página de la plantilla (no la subpágina de la documentación). Para realizar una edición nula, abre la página de la plantilla para editarla y guarda la página "sin hacer ningún cambio".
 * Problemas actuales — Una lista actual de fallas y funciones solicitadas está disponible [phabricator:maniphest/query/5OLCQh34NZjK/#R en el seguidor de incidencias de Wikimedia].

Structure of TemplateData
La estructura de TemplateData se basa en el estándar JSON, y es bastante sencilla. Ten en cuenta que todas las descripciones en TemplateData deben estar en texto plano (sin wikitexto, sin enlaces, etc.).

Lo primero qué hacer es escribir un par de etiquetas, dondesea en la subpágina de documentación de la plantilla, así:

Esto le dice al software que todo lo que está entre las dos etiquetas es TemplateData, y debe referenciarse cuando se utiliza la plantilla.

Example
Las descripciones dentro de TemplateData siguen una distribución estándar; digamos que tienes una plantilla llamada "Commons" para vincular a una categoría de Commons sobre un tema en particular. Se necesita un parámetro obligatorio: el nombre de la categoría en Commons. Tu TemplateData se vería algo así:

Esto se mostraría, en la plantilla, de la siguiente forma:

{   "description": "Una plantilla para vincular una categoría de Commons sobre un artículo", "params": { "1": {           "label": "Categoría de Commons", "description": "La categoría de Commons que deseas vincular.", "default": "Category:CommonsRoot", "type": "string", "required": true }   } }

Description and parameters
Una vez que hayas terminado, presiona "Guardar". Si hay errores, no se te permitirá guardar, (lo cual puede ser molesto pero se asgura que no se pueda romper nada). Si tienes algun error, explica en la página de comentarios lo qué estabas tratando de hacer y estaremos encantados de ayudarte.

Note that each bit of information is enclosed in quotation marks (except for  and  ), and separated from the next bit by a comma (unless it's the last one).

Parameter aliases
Algunas plantillas permiten que el mismo parámetro tenga diferentes nombres.

For example,  could also be written as   or.

To add this information to TemplateData, you simply need to add the aliases to the parameter's information:

Auto value
You can specify an "autovalue" for a parameter. When users add the template to a page, this value will be added automatically. For example, many clean-up templates need to have the date added; if you specify an autovalue for the template's date parameter, then the date will be filled in automatically.

To add this information to TemplateData, simply add the autovalue to the parameter's information. You will probably want to use  to make the values stick:

Multiple parameters
If you have multiple parameters, just repeat each section (starting from the "1" tag) and fill it out as you see fit. Note that if a template has multiple parameters, you need to separate them with a comma in the templatedata, like so:

Similar parameters
When a template has multiple parameters, sometimes some of them can be of the same kind. In this case, you only need to provide full properties for the first one, and the others can "inherit" their properties from it.

Blank boilerplate
You can copy the blank boilerplate below to add new TemplateData to a template. Only the most common tags are included.

Other tools

 * TemplateDataEditor — A user script that makes the process of adding TemplateData easier. It currently exists in French (contains English, Italian, Japanese and Korean translations), and can easily be translated into other languages.
 * TemplateData Wizard — A tool that generates TemplateData through an interactive interface.
 * Skeleton TemplateData generator — A tool that reads the source wikicode of a template, tries to find all the parameters used and outputs a skeleton document with the parameters listed.
 * JSONLint — A tool that allows you to validate manually-written JSON to help find errors in the syntax.
 * Lista de todas las plantillas con TemplateData en este wiki
 * With dewiki template TemplateData template data is shown in a box, and the template is added to a category of templates with template data