Help:TemplateData
 |
Nota: Al editar esta página, aceptas liberar tu contribución bajo la licencia CC0. Consulta las páginas de ayuda sobre el dominio público para obtener más información.
|
|
TemplateData es una forma de almacenar información acerca de una plantilla de wikitexto y sus parámetros, para que el editor visual pueda recupararla y desplegarla en su editor de plantillas, haciendo más fácil editar páginas usando esa plantilla. También se usa en otros lugares, como scripts, herramientas y accesorios.
La extensión TemplateData es instalada en todas las wikis WMF. Si tienes tu propia wiki, entonces necesitarás instalar Extension:TemplateData.
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 el editor visual. Aunque puede sonar complejo, realmente es muy fácil.
Contents
Editor de TemplateData
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 "Gestionar TemplateData", justo arriba de la ventana de edición abierta:
Presiona este botón para ingresar a la herramienta GUI y editar TemplateData.
El editor permite añadir parámetros y establecer los atributos más comunes. Si la página que editaste ya contiene un bloque de TemplateData, se mostrará de forma automática la información ya documentada cuando abres la página correcta en el editor de TemplateData. En la primera caja, puedes añadir o actualizar una pequeña descripción de la plantilla en texto plano. Después, puedes usar los botones "Agregar parámetro(s) sugerido(s)" y "Agregar parámetro" para documentar los nombres y atributos de los parámetros que usa la plantilla.
If the template page is protected, you can copy-and-paste the template code in the subpage, use the "Add suggested parameter(s)" button there, copy the TemplateData content, edit back the subpage to get rid of the template code and then paste the TemplateData content. To know where to paste the TemplateData content inside the subpage, you can edit TemplateData without adding anything; you can then replace the <templatedata> and </templatedata> tags and their content by pasting over them.
Puedes listar el nombre del parámetro, cualquier alias para él, la etiqueta y la descripción que se mostrará a los usuarios. También puedes proveer un ejemplo de cómo usar el parámetro. 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ú desplegable "Tipo", puedes elegir el tipo de contenido que el parámetro debe recibir, tal como una cadena (para respuestas de texto plano), una página (para los enlaces a otras páginas), o fechas. Si la plantilla producirá 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 información del parámetro" 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.
Limitaciones y preguntas
- 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 el editor visual. Sin embargo, es posible que tome varias 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 ni escribiendo ningún resumen de edición".
- Problemas actuales — En el sistema de seguimiento de incidencias de Wikimedia hallarás una lista de los errores y las solicitudes de funciones actuales.
Ubicación de TemplateData
TemplateData debe estar en la página que describe, o estar transcluído en ella.
En una plantilla, típicamente debe estar envuelto en etiquetas <noinclude>.
En una página normal de rendering, se muestra documentación autogenerada como se muestra en #Ejemplo.
Estructura de TemplateData
La estructura de TemplateData se basa en el estándar JSON. 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 <templatedata>, dondesea en la subpágina de documentación de la plantilla, así:
<templatedata>
{
... // El contenido de TemplateData va aquí
}
</templatedata>
Esto le dice al software que todo lo que está entre las dos etiquetas es TemplateData, y debe referenciarse cuando se utiliza la plantilla.
Ejemplo
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í:
<templatedata>
{
"description": "Una plantilla para enlazar a 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
}
}
}
</templatedata>
Esto se mostraría, en la plantilla, de la siguiente forma:
Una plantilla para vincular una categoría de Commons sobre un artículo
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Categoría de Commons | 1 | La categoría de Commons que deseas vincular.
| String | required |
Descripción y parámetros
| description | La primera etiqueta es "description", que describe qué hace la plantilla.
|
"description": "Una plantilla para enlazar a la categoría de Commons",
|
|---|---|---|
| format | El siguiente es "format", el cual describe cómo debería presentarse la representación de wikitexto de la plantilla. Este puede ser configurado como los formatos estándar "inline" (predeterminado) o "block", o un formato personalizado; consulta más adelante para más detalles.
Si el parámetro es configurado como
Si el parámetro es configurado como {{Foo
| bar = baz
| qux = quux
}}
|
"format": inline
|
| params | Enseguida hay una etiqueta "params", la cual indica qué secciones subsecuentes cubren cada parámetro en la plantilla.
Todos los parámetros que siguen se incluyen en la sección |
"params": {
... // los parámetros van aquí
}
|
| Dentro de cada subsección de parámetro, la primera etiqueta es el nombre del parámetro de la plantilla dentro de la plantilla.
Si el parámetro tiene un nombre, como Si el parámetro es "unnamed", el significado es solo un número como Todos los bits de información acerca de este parámetro se incluyen en la sección que empieza con el nombre del parámetro. |
"1": { // nombre del parámetro
... // información acerca del parámetro va aquí
}
| |
| label | Enseguida tenemos "label", en la cual pones un título legible por humanos que se desplegará dentro del editor de etiquetas.
|
"label": "Categoría de Commons",
|
| description | Luego tenemos "description": este nombre es una descripción del parámetro, no de la etiqueta como un todo.
|
"description": "La categoría de Commons a la que quieres vincular.",
|
| default | El siguiente es "default". Algunas plantillas tienen un valor predeterminado que se usa a menos que lo cambies. Este elemento dice al usuario cuál es el valor predeterminado para este parámetro.
Puedes ignorar este parámetro si no hay ningún valor predeterminado. |
"default": "Category:CommonsRoot",
|
| type | Además tememos "type", el cual controla cómo el editor de plantillas interpretará el parámetro. Este puede ser:
Other types include:
|
"type": "string",
|
| required | Después tenemos "required", que se puede configurar como true o false.
Esto simplemente controla si llenar el parámetro es obligatorio para tal plantilla. Si no lo especificas, se asumirá como |
"required": true
|
| suggested | Está "suggested", que puede configurarse como true o false.
Este es un estado para los parámetros que no son obligatorios sino recomendados por su alto valor a los usuarios de plantillas. Si no se especifica, se asumirá que es |
"suggested": true
|
| deprecated | Finalmente, está "deprecated", que puede configurarse como true, false o una cadena de caracteres describiendo lo que los usuarios deberían hacer en su lugar.
Este es un estatus para parámetros que no deberían volver a usarse, pero que todavía existen de momento.
Esto podría ser porque los usos de la plantilla están siendo movidos de una configuración de parámetros a otra.
Si no especificas, se asumirá que es |
"deprecated": "Please use 'publicationDate' instead."
|
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 if you are abusing a hack template to dynamically generate TemplateData, it cannot be checked for errors before saving.
Ten en cuenta que cada fragmento de información está encerrada entre comillas (a excepción de true y false), y separado del siguiente por una coma (a menos que sea el último).
Formatos personalizados
When editing custom format strings in the TemplateData editor you can either type \n or press the enter key to represent a newline; in either case it will display as ↵ in the entry field.
| Objetivo | Cadena de formato | Salida |
|---|---|---|
| Inline formatting | {{_|_=_}} inline
|
{{Foo|bar=baz|qux=quux}}{{Bar}}
|
| Formateo en bloque | {{_\n| _ = _\n}} block
|
{{Foo
| bar = baz
| qux = quux
}}{{Bar
}}
|
| Sin espacio antes del nombre de parámetro, cada plantilla en su propia línea | \n{{_\n|_ = _\n}}\n
|
{{Foo
|bar = baz
|qux = quux
}}
{{Bar
}}
|
| Sangrar cada parámetro | {{_\n |_ = _\n}}
|
{{Foo
|bar = baz
|qux = quux
}}{{Bar
}}
|
| Alinear todos nombres de parámetro a una longitud dada | {{_\n|_______________ = _\n}}\n |
{{Foo
|bar = baz
|qux = quux
|veryverylongparameter = bat
}}
{{Bar
}}
|
| Caracteres de tubo al final de la línea anterior | {{_|\n _______________ = _}}
|
{{Foo|
bar = baz|
qux = quux}}{{Bar}}
|
| Los estilos entrelíneas con más espacio, deben estar al comienzo de la línea | \n{{_ | _ = _}}
|
{{Foo | bar = baz | qux = quux}}
{{Bar }}
|
| Template at the start of a line, indent-aligned parameters, pipe beforehand | \n{{_ |\n _______________ = _}}
|
{{Foo |
bar = baz |
qux = quux}}
{{Bar}}
|
Alias de parámetros
Algunas plantillas permiten que el mismo parámetro tenga diferentes nombres.
Por ejemplo, {{Commons|category=Apples}} también se puede escribir como {{Commons|Apples}} o {{Commons|link=Apples}}.
Par agregar esta información a TemplateData, simplemente necesitas agregar los alias a la información del parámetro:
"params": {
"categoría": {
...
"aliases": ["1", "enlace"]
}
Valor automático
Puedes especificar un "autovalor" para un parámetro. Cuando los usuarios agregan la plantilla a una página, este valor se añadirá automáticamente. Por ejemplo, muchas plantillas de limpieza necesitan tener la fecha en que se añadieron; si especificas un autovalor para el parámetro de fecha de la plantilla, posteriormente la fecha se completará automáticamente.
Para agregar esta información a TemplateData, simplemente agrega el autovalor a la información del parámetro.
Probablemente quieras usar subst: para hacer que los valores se incluyan:
"params": {
"fecha": {
...
"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
}
Parámetros múltiples
Si tienes múltiples parámetros, solo repite cada sección (comenzando por la etiqueta "1") y llénala como mejor te parezca. Ten en cuenta que si una plantilla tiene varios parámetros, es necesario separarlos con una coma en el templatedata, así:
"params": {
"1": {
...
}, // nota la coma aquí
"2": {
...
}, // y aquí
"3": {
...
}
}
Parámetros similares
Cuando una plantilla tiene varios parámetros, a veces algunos de ellos pueden ser del mismo tipo. En este caso, sólo es necesario para proporcionar propiedades completas para el primero, y los demás pueden "heredar" sus propiedades de la primera.
"params": {
"tema1": {
"label": "Tema",
"description": "Un tema mencionado en esta página de desambiguación",
"type": "string"
},
"tema2": {
"inherits": "tema1"
},
"tema3": {
"inherits": "tema1"
},
}
Texto modelo en blanco
Puedes copiar el texto modelo en blanco para agregar un nuevo TemplateData a una plantilla. Sólo se incluyen las etiquteas más comunes.
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "",
"description": "",
"type": ""
},
"2": {
"label": "",
"description": "",
"type": ""
}
}
}
</templatedata>
Errors
Syntax Error in JSON / Bad JSON format
Due to a long standing bug, users using the old wikitext editor are able to save pages which have certain types of invalid JSON, such as duplicate keys or trailing commas (details: task T128029). However if you attempt to save this page in a JavaScript based editor, such as VisualEditor or the 2017 Wikitext editor, you will see an error message "Syntax error in JSON," as the JavaScript parser is stricter and doesn't allow invalid JSON. Additionally, if you attempt to open up such invalid JSON with the Template Data GUI editor, you will see the error message, "Bad JSON format." To fix these errors, you can enter the JSON block into an external JSON validator, such as https://jsonlint.com/, and it will highlight the problematic commas and keys so they can be removed.
Otras herramientas
- Ayuda:Extensión:TemplateWizard
- A toolbar dialog window for entering template wikitext via an form built from TemplateData.
- TemplateData Wizard
- Una herramienta que genera TemplateData a través de una interfaz interactiva.
- Skeleton TemplateData generator
- Una herramienta que lee el código wikicode fuente de una plantilla, trata de encontrar todos los parámetros usados y muestra un documento esquematizado con los parámetros indicados.
- JSONLint
- Una herramienta que te permite validar JSON manualmente escrito para encontrar errores en la sintaxis.
- Lista de todas las plantillas con TemplateData en este wiki
- Con TemplateData de la plantilla dewiki la información de la plantila se muestra en una caja y la plantilla se agrega a una categoría de plantillas con la información de la plantilla
