Help:TemplateData/es

 es una extensión que almacena información y parámetros asociados a una plantilla wikitexto y la pone a disposición de una interfaz de edición que puede recuperarla y presentarla en un editor de plantillas -- todo lo cual ayuda a los usuarios a añadir y editar plantillas en las páginas.

Desde abril de 2019, TemplateData forma parte de la experiencia de usuario predeterminada para todos los usuarios de todos los wikis de Wikimedia cuando añaden una plantilla, incluidos los usuarios no registrados. Tanto los editores de fuente por defecto como los visuales lo incorporan de alguna manera, al igual que muchos scripts, herramientas y gadgets. Si quieres esta funcionalidad en tu propia wiki, instala.

Añadir TemplateData a una plantilla consiste básicamente en insertar un bloque pequeño de código JSON (explicado más abajo) en la página de documentación de la plantilla. Puede hacerlo manualmente o con el editor TemplateData, una interfaz de usuario gráfica ubicada en las secciones «Editar»/«Editar código» de páginas de plantillas en wikis con la extensión TemplateData instalada. El JSON contiene una lista de los parámetros de la plantilla e información sobre esos parámetros y sobre la plantilla en su conjunto (ver más abajo para más detalles).

Las plantillas que contienen TemplateData mostrarán esta información en la interfaz de usuario cuando un usuario añada la plantilla. En algunos casos, cambiará la forma en que se comporta el editor cuando se utiliza para editar o insertar una plantilla determinada, facilitando a los usuarios los pasos necesarios para añadir una plantilla determinada.

Historia
Template data was originally developed in early 2013 with in mind, which was in MediaWiki testing stages at the time. VisualEditor es la principal interfaz de edición visual para los wikis de Wikimedia, y TemplateData le permitió tener una interfaz más útil al añadir plantillas. Fue soportado oficialmente por VisualEditor inmediatamente. A medida que VisualEditor se desplegó en las principales wikis de Wikimedia como una característica por defecto desde 2013 hasta 2016, TemplateData se convirtió en una parte de ellos también.

En diciembre de 2016, la interfaz de VisualEditor se puso a disposición para editar el código fuente como una función beta. Esto se denominó el. Esto trajo las características de TemplateData a la edición de fuentes por primera vez.

En marzo de 2018, Sam Wilson desarrolló, una extensión del editor de plantillas de la interfaz gráfica de usuario para el editor de fuentes predeterminado de Wikimedia, (también conocido como el editor de wikitextos de 2010), diseñado para facilitar el proceso de adición de plantillas utilizando la información de TemplateData. En Abril 2019, TemplateWizard se convirtió en una parte por defecto del editor de wikitexto de 2010 en todos los wikis de Wikimedia. Esto significaba que TemplateData era ahora una parte por defecto tanto del editor visual como del editor de fuentes en los wikis de Wikimedia.



Agregar o editar TemplateData
Para añadir o editar TemplateData, primero navegue a la página de una plantilla, situada en "/Template:Templatename".

Checking the current state
Before adding or editing template data, check whether the template has a documentation subpage. Then check whether the template already contains template data and, if so, whether it's located on the template page or the documentation subpage.

Documentation subpages
Hay dos formas principales en que las plantillas en la mayoría de los wikis de Wikimedia almacenan sus notas de uso y otros datos que no deberían incluirse en la propia plantilla, como las categorías en las que debería estar la plantilla:

On pages like this, the {{}} template transcludes all the /doc page's content onto the template page, keeping the template's source code much cleaner.
 * The vast majority of templates keep usage notes and other data that doesn't belong on the template page itself on a documentation subpage: "/Template:Templatename/doc".
 * On templates with documentation subpages, the "Test Template Info-Icon - Version (2).svg Template documentation" heading will be followed by links such as [view], [edit], [history] and [purge].

You can spot it on these pages by looking for an occurrence of  between  tags.
 * A few template pages have retained that information on the template's main page.

Different wikis may present all this differently. Rarely, main template pages may still contain documentation even when you've checked all of the foregoing; here, a user will have added a custom /doc page title between " " and " " and then added content after " ".

You can also look for a notice at the bottom of the page similar to this: "The above documentation is transcluded from Template:Templatename/doc".

Templates without documentation subpages
If a template doesn't have a documentation subpage, create it and move the template's documentation there (or a placeholder for it). Then you can add template data to the documentation subpage.

Creating the subpage and moving the documentation
To create the documentation subpage, click ""/"" on the main template page; look for the tags and their contents (usually at the bottom).

It should look something like this:

You may also find that it already contains template data. If so, it will look something like this:

Select everything after " " and before "" and cut it into your clipboard or save it in a temporary document. Delete " ", leaving only the following:

Save the template page.

Now, to create the new subpage, look at your browser's address bar and add /doc to the end of the URL. Press Enter, then choose the option to create a new page.

If this wiki has a {{}} notice template, add it at the top of the new page. You may also wish to add other templates, such as a {{}} or {{}} link (if supported by the wiki in question). See m:Help:Template documentation for more info.

Insert the text you cut or saved in the previous text (beneath the notice template, if applicable).

Wrap any categories in tags so that they apply only to the template's main page:

Many wikis have a  template. Use this template here if it's likely that the template you're editing exists in a sandbox version (located at "Template:Templatename/sandbox") in order to prevent the categories from applying to the sandbox page:

Finally, publish the page.

You can now add and edit the template data on the documentation subpage using the instructions described in #Methods.

Adding and editing template data on the main template page
If you can't create the /doc page, you can add and edit template data on the template's main page by following the instructions in #Methods.

If a template has a documentation subpage, check both the main page and the documentation subpage for the presence of template data (the tag followed by an array inside curly brackets:  ).

Alternatively, the TemplateData extension can perform this check for you. Click "" or "" on either page. If the template already has template data on either page, you will see a yellow notice at the top of the page saying either:



or

If the template has template data on its documentation subpage

If the template has template data on its documentation subpage, this is the page you should edit. You can do this by clicking the "[edit]" located after the heading " Template documentation" (or similar), or, if you are already on the /doc page, by clicking "" or "" at the top. Follow the guidance at #Methods to add or edit the template data.

If the template has template data on its main page

If the template has template data on its main page, you once again have two options:


 * You can either move to its documentation subpage. This is the preferred option.


 * Or, you can edit it on the main template page.

Moving template data to the documentation subpage

To do this, click ""/"" on the main template page, and look for the tags, enclosed within  tags. It should look something like this:

Cut only the tags and their contents out of the code, then save the page.

Next, edit the documentation subpage by clicking the "[edit]" located after the heading " Template documentation" (or similar).

Type a heading, like "Template data", then beneath it paste the template data.

You can now edit the template data based on the guidance at #Methods.

Editing template data on the main template page

If you do not wish to move the template data to the /doc page, you can edit it on the main template page. See #Methods for how to edit template data.

If the template does not yet have template data but has a doc subpage

If the template does not yet have template data, you should add it to the documentation subpage.

Do this by clicking the "[edit]" located after the heading " Template documentation" (or similar), or, if you are already on the /doc page, by clicking "" or "" at the top. Type a heading, like "Template data", then add it beneath this heading. The section #Methods explains how to add template data.

Methods


Editor de TemplateData
This is a simple way to add or edit template data, recommended for less experienced users.

El editor de TemplateData es una intefaz gráfica de usuario para añadir y editar TemplateData. It is part of the TemplateData extension, available on any template's page (or documentation subpage) by clicking "" or "".

Tras pulsar el botón "" o "", verás un botón encima del área de edición y título de la página que dice "".

|453px

Pulsando este botón te llevará al Editor de TemplateData. Si la página en la que te encuentras ya contiene un bloque de TemplateData, aparecerá de forma automática la información ya documentada.

600px|La herramienta de edición TemplateData, en una página que todavía no contiene TemplateData.

Features in the above window:


 * The top item chooses the language of the interface text. It allows you to enter text content in multiple languages, displayed to users based on their settings in Preferences, not based on the wiki's language; different wikis have entirely different template databases. If no language template data exists, the interface will only offer users the wiki's own language, but users can click "" to add more inputs. The language code is displayed in brackets next to the parameters to which it can be applied, such as descriptions and labels.
 * The next item is the template description. This is the description of the template as a whole; it's shown to users in numerous places in the template editors while adding a template. This parameter and its effects are outlined here.
 * The third item controls the wikitext formatting of the template. This parameter determines how the wikitext will be laid out when the user clicks "", the two main types being  (on one line) and   (on new lines). This parameter and its effects are outlined here.
 * If the user chooses "", they can enter wikitext under "" according to rules outlined here, in order to create a custom layout for the template when the user clicks "".


 * The fourth item configures a template's parameters. If parameters have already been defined in template data, this area displays them in a list. If the template's source code specifies parameters for which no template data exists, you may see a button labeled "". The editor extracts these suggestions from the template's source code by looking for  or  . Clicking "" will add these parameters using their names as defined in the source code. A green notice will also appear at the top, for example, "".
 * At the bottom of the window you see an "" button. This allows you to add a parameter manually with a custom name.

Continue to the next step by clicking any one of the parameters in the list. This will allow you to edit that parameter's info.

600px

All of these features and their effects are outlined in the section #Within a parameter's name.

When finished, click "". This will automatically insert the template data at the bottom of the page before the tag; or, if already present, it will be updated with the new information without changing its position. The template data text will also be selected when you click "".

The template data editor creates a  parameter at the bottom of the template data (or updates it if it already exists). contains the current template data parameters in the order in which they were displayed by the template data editor. You can change the  by dragging the parameters up and down in the template data editor using the three horizontal bars on the left. and its effects are described here.

After this, click "" to save your revision of the page.

Manual method
You can also add or edit template data manually. 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.). Template data follows a few very simple rules and accepts only a few dozen possible predefined parameters and values, typically following a  format.

Adding template data manually

Considerations:


 * If you're adding template data on a template's documentation subpage (recommended), you may add it anywhere on the page; check to see if your language's Wikipedia has a preferred location for it. For example, on the English Wikipedia, template data is typically near the bottom of the documentation page; on the German Wikipedia, it is typically at the top.
 * If you're adding template data on a template's main page (not recommended; see #Prior checks), you must make sure to place it inside the  tags.

Click "" or "" on the respective page, then move to the place in the page where you intend to add template data and write a heading: "Template data".

Many wikis have a TemplateData header template that adds a short notice regarding template data. If your wiki does, add it after the heading.

To start adding template data, type an opening and closing tag and a pair of curly brackets on new lines, with an empty line between them:

Next, add an indent on the empty line between the two curly brackets, and start adding parameters. Details for the parameters can be found at #Template data parameters. Most are optional; some are highly recommended.

Parameters can be in any order, but what follows is the order that best conforms to template data documentation and makes the content easiest to use for editors:

Make sure the parameters, for example, in the  object, remain inside that object; otherwise you will trigger an "" error when you try to save.

Ejemplo

Here is some example template data for a hypothetical cleanup template. Such a template would display a notice and place the page into a dated category based on the month and year entered. The notice might also contain a link to a talk page section. The template data would look something like this:

The corresponding template data documentation would display as follows:

{	"description": "Use this template to indicate that an article is in need of cleanup.", "format": "inline", "params": { "date": { "label": "Month and year", "description": "The month and year that the template was added", "type": "string", "autovalue": " ", "example": "January 2013", "suggested": true },		"reason": { "aliases": ["1"], "label": "Reason", "description": "The reason the article is in need of cleanup", "type": "string" },		"talk": { "aliases": ["talksection"], "label": "Talk page section", "description": "The section of the talk page containing relevant discussion", "type": "string" }	},	"paramOrder": [ "date", "reason", "talk" ] }



Descripción y parámetros
All available template data parameters are listed below with a description and example. They are also listed in more technical detail at Extension:TemplateData#Format.

Within a parameter's name
Note: if neither,   nor   are set as   for a parameter, its status will show as   in the template data documentation.

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 template data, it cannot be checked for errors before saving.

Ten en cuenta que cada fragmento de información está entre comillas (a excepción de  y  ), y separado del siguiente por una coma (a menos que sea el último).

Type parameter
El parámetro, está destinado a señalar a un editor de plantillas La naturaleza del valor de un parámetro. In some cases, template editors have been programmed to modify the user interface for a certain parameter according to this template data value, such as to only allow the user to enter valid values that match the specified type. This parameter does not have any functional effect on the template parameter or its value; it merely controls how template editors see and treat the parameter in editing mode.

How to use

It is used by adding the  parameter, followed by a colon and a space, then adding any of the values listed in the table below in quotation marks.

Example:

Effects

As of February 2020, only 5 of the 13 type values have visible effects in VisualEditor and the 2017 wikitext editor, while 8 have visible effects in TemplateWizard.

The effects of certain values are likely to change as the template editors get updates to support them. One such effort for VisualEditor and the 2017 wikitext editor is tracked in the Phabricator task T55613. A similar effort to get TemplateWizard to support the boolean value is tracked in T200664.

The currently known effects are listed as follows.

Formatos personalizados
When editing the  value, you create custom formats by inputting a set of wikitext symbols using some predefined rules.


 * - start of the template
 * - content (e.g., string, integer or parameter). This underscore serves to indicate the minimum length of a value in characters and can be repeated, like . If this length is not reached, it fills the remaining characters with spaces. This can be used to align all equals signs to a specific position after a parameter (if used with   for new lines).
 * - pipe (separates parameters)
 * - equals sign (precedes the value of a parameter)
 * or pressing the enter key - new line (this will display as  in the entry field)
 * - space (can be used with  to indent new lines)
 * - end of the template

The wikitext should at least meet the minimum of, otherwise there will be an invalid format string error.



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.

/ Bad JSON format
These errors occur when saving template data, usually manually edited, with invalid JSON code (duplicate keys/parameters, trailing or missing commas, etc.) in the visual editor or the 2017 wikitext editor.

"" appears in the visual editor and the 2017 wikitext editor; "Bad JSON format" appears when editing in the template data GUI editor.

These errors can be difficult to detect and come in too many forms to list. The best way to avoid them is to edit template data exclusively with the template data editor; the best way to detect them once they've occurred is to use an external JSON validator, such as JSONLint, which will highlight errors and aid in fixing them.

The 2010 wikitext editor does not check for invalid JSON thanks to an old, unfixed bug. Pages that contain invalid JSON may throw alarming "" messages. To fix these errors, your best bet is to use a JSON validator (see above).

This error occurs if you state a parameter in  that is not stated in. The number in the square brackets refers to the parameter in  that is missing. It refers to its order in the sequence, but it is one less than its actual position, since  is an array; 0 is the first one, 1 is the second, etc.

To fix this, make sure all parameters stated in  are listed in. Alternatively, you can remove the  object to remove this error.

This error occurs if you state a parameter in  that is not stated in. The number in the square brackets refers to the parameter in  that shouldn't be there. It refers to its order in the sequence, but it is one less than its actual position, since  is an array; 0 is the first one, 1 is the second, etc.

To fix this, make sure all parameters stated in  are listed in. Alternatively, you can remove the  object to remove this error.

This error occurs if you put quotation marks around the value of either  or.

These are boolean values, not strings, therefore they require no quotation marks. To fix this, remove any quotation marks around the values  or   for these parameters.

Property "format" is expected to be ...
If the  parameter exists but its value is not ,   or a valid format string, you will see the error message "".

To fix this, make sure the value after  equals   or   and that there no spelling mistakes. Alternatively, if it's wikitext, make sure it contains a minimum of  and that there are no mistakes in the syntax that would normally cause a template to fail, such as duplicate equals signs or missing/duplicate curly brackets; see the section #Custom formats for the syntax for custom formats. Alternatively, you can remove the  parameter to remove this error.

This error occurs if you state a parameter that does not exist in template data. This is probably due to spelling mistakes.

It also occurs if you state a parameter in any template data object that is not a parameter of that object. This may be due to spelling mistakes, or you may have written the parameter of one template data object under another object that it doesn't belong to.

For example, you might have written the parameter  under the root template data object instead of inside  :

Alternatively, if the unexpected parameter is under a template parameter inside, you'll see its name after "params.parametername." in the error.

To fix this, make sure there aren't any spelling mistakes in the parameter names, and make sure your parameters are in their correct location. Additionally, make sure you don't state any parameters that don't exist for a template data object. You can check which parameters exist for an object in the section #Template data parameters.

This error occurs if there is no  object in the template data. This is a necessary object, as it contains all the details of each parameter, so to fix this error, make sure it's added and that there are no spelling mistakes. See the section above on how to add the  parameter.



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.



Otras herramientas

 * : A toolbar dialog window for entering template wikitext via an form built from template data.
 * 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
 * https://query.wikidata.org/ and Query Helper