Help:TemplateData/es

$La extensión es una extensión utilizó para almacenar información sobre un wikitext plantilla y sus parámetros de modo que una interfaz de editar puede recuperar y mostrar esta información en su editor de plantilla, por ello haciéndolo más fácil para usuarios para añadir y editar plantillas en páginas.

Desde entonces en abril de 2019, TemplateData es parte del default experiencia de usuario para todos los usuarios encima todo wikis de Wikimedia  cuándo  añaden una plantilla, incluyendo usuarios no registrados. Ambos el default la fuente y los editores visuales incorporan él en alguna manera. Es también utilizado en otro lugar en guiones, herramientas y gadgets. Si tienes tu propia wiki, entonces necesitarás instalar Extension:TemplateData.

Añadiendo TemplateData a una plantilla esencialmente consta de insertar un bloque pequeño de JSON código (explicado abajo) en la página de documentación de la plantilla. Hay dos maneras principales puedes hacer este, tampoco manualmente o por utilizar el TemplateData editor, una interfaz de usuario gráfica localizada en el "Editar"/"Editar páginas" de fuente de plantillas en wikis con el TemplateData la extensión instalada. El JSON contiene una lista de parámetros con info sobre cada parámetro de la plantilla así como la plantilla globalmente. Estos están perfilados abajo.

Una vez una plantilla ha TemplateData, esta información mostrará en la interfaz de usuario cuándo un usuario añade la plantilla, a veces en sitio de original info o a veces tan adicional info. En algunos casos, pueda cambiar cómo el editor behaves cuándo editando o insertando la plantilla. Esto lo puede hacer mucho más fácil para usuarios para identificar qué necesitan hacer con la plantilla cuándo añadiéndolo.

Historia
TemplateData Era originalmente desarrollado en temprano 2013 con en mente, el cual era en MediaWiki etapas de testaje en el tiempo. VisualEditor Es el principal visual editando interfaz para Wikimedia wikis, y TemplateData dejado lo para tener una interfaz más útil cuándo añadiendo plantillas. Sea oficialmente apoyado por VisualEditor inmediatamente. Tan VisualEditor estuvo rodado fuera al varios importante Wikimedia wikis como default característica de 2013 a través de 2016, TemplateData devenía una parte de ellos también.

En Marzo de 2018, Sam Wilson desarrolló, un GUI extensión de editor de la plantilla para el default Wikimedia editor de fuente, $ 3 (otherwise sabido como el 2010 wikitext editor), diseñado para hacer el proceso de añadir las plantillas más fáciles por utilizar información de TemplateData. En abril 2019, TemplateWizard estuvo hecho un default parte del 2010 wikitext editor encima todo Wikimedia wikis. Esto significó que TemplateData era ahora un default parte de ambos el editor visual y el editor de fuente en Wikimedia wikis.

Editor de TemplateData
El TemplateData el editor es una herramienta construido al TemplateData extensión para añadir y editando TemplateData utilizando una interfaz de usuario gráfica.

Es accesible por ir a la página de cualquier plantilla (o documentación subpage) y clicking "Editar" o "Editar fuente". Después de hacer este, verás un botón por encima del área de editar y la página titulan aquello dice "$dirigir".



Haciendo clic este botón introducirá el TemplateData editor.

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.

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.

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. 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, 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.

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í:

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 }   } }

Descripción y parámetros
Cada parámetro para TemplateData está listado abajo con una descripción y ejemplo. Son también listados en Extensión:TemplateData#Formato.

El orden de los parámetros no afecta funcionalidad, mientras aquellos dentro, por ejemplo, el $ 1 objeto está mantenido dentro del objeto.

Within the parameter's name
Note: if neither "required", "suggested" nor "deprecated" are set as true for a parameter, its status will show as "optional" in the TemplateData 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 TemplateData, 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).

Effects of the type parameter
The  parameter can have multiple different effects or no effect depending on the value and depending on the template editor. Its effects are listed as follows.



The  value is intended for numerical values, including minus values and decimals.


 * In VisualEditor and the 2017 wikitext editor,  has no visible effect.
 * In the 2010 wikitext editor with TemplateWizard,,  causes the input box to display a "+" and "-" button on either side, which raise or lower a number value in the input box, respectively, and the user can only type numbers into the box. The buttons can also lower the number into negatives.



The  value is intended for any string of plain text.


 * In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard),  has no visible effect compared to.



The  value is intended for content that should be forced to stay on one line.


 * In VisualEditor and the 2017 wikitext editor,  prevents a parameter's input box from allowing new lines, which are usually possible in these editors.
 * In the 2010 wikitext editor with TemplateWizard,  has no visible effect (input boxes do not allow new lines by default in this editor).



The https:// value is intended for a URL, with Internet protocol (e.g., "https://") included.


 * In VisualEditor and the 2017 wikitext editor,  makes the input box display an external link icon (a square with arrow pointing out of it) in the left hand side of the box and makes the box glow red when the user clicks away without entering a URL value that includes a valid Internet protocol (e.g., "https://", "ftp://" or "//") followed by some text. This second effect is similar to that of the "required" setting, but it does not warn the user if they attempt to insert the template without a valid URL. It also occurs with any status setting (such as "suggested" or "deprecated").
 * In the 2010 wikitext editor with TemplateWizard,  has no visible effect.



The  value is intended for a page name on a wiki.


 * In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard),  makes the parameter input box show a suggestion dropdown menu containing a list of pages on the wiki, such as Wikipedia articles, which can be selected. Namespaces can also be defined in the search. Additionally, in VisualEditor and the 2017 wikitext editor, it forces the input box content to stay on one line. It has no other visible effect and doesn't prevent a non-page from being inputted.



The  value is intended for a file name hosted either locally on a wiki or on Wikimedia Commons.


 * In VisualEditor and the 2017 wikitext editor,  has no visible effect.
 * In the 2010 wikitext editor with TemplateWizard,  makes the parameter input box show a suggestion dropdown menu containing a list of files hosted both locally and on Wikimedia Commons, which can be selected. It also shows the thumbnail of the files. It has no other visible effect and doesn't prevent a non-file from being inputted.



The  value is intended for the name of a template.


 * In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard),  makes the parameter input box show a suggestion dropdown menu containing a list of templates, which can be selected. Additionally, in VisualEditor and the 2017 wikitext editor, it forces the input box content to stay on one line. It has no other visible effect and doesn't prevent a non-template from being inputted.



The  value is intended for a username on a wiki.


 * In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard),  makes the parameter input box show a suggestion dropdown menu containing a list of actual users' names, which can be selected. Additionally, in VisualEditor and the 2017 wikitext editor, it forces the input box content to stay on one line. It has no other visible effect and doesn't prevent a non-username from being inputted.



The  value is intended for wikitext of page content, for example, links, images or text formatting.


 * In VisualEditor and the 2017 wikitext editor,  has no visible effect.
 * In the 2010 wikitext editor with TemplateWizard,  makes the parameter input box one line taller and allows new lines, which regular input boxes in the 2010 wikitext editor do not.



The  value is intended for wikitext that cannot stand alone, i.e. it lacks an opening or closing tag or refers to other parts of wikitext.


 * In VisualEditor and the 2017 wikitext editor,  has no visible effect.
 * In the 2010 wikitext editor with TemplateWizard,  makes the parameter input box one line taller and allows new lines, which regular input boxes in the 2010 wikitext editor do not.

With other parameters


 * In VisualEditor and the 2017 wikitext editor,  overrides the visible effects of   - when both are set, the input box will not contain a URL icon nor glow red when the user clicks away without entering a valid URL.
 * In the 2010 wikitext editor with TemplateWizard,  overrides the effects of   - the value of "autovalue" will not be automatically placed in the input box if the parameter type is "number".

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.

Syntax error in JSON / Bad JSON format
This error occurs if you attempt to save TemplateData that has certain types of invalid JSON code, such as duplicate keys (parameters) or trailing/missing commas, in VisualEditor or the 2017 wikitext editor (JavaScript-based editors).

"Syntax error in JSON" shows if you attempt to save such code in VisualEditor or the 2017 wikitext editor, while "Bad JSON format" shows if you attempt to open up such code in the TemplateData GUI editor, on template pages.

This error can come up quite frequently while editing a template's TemplateData. The most common mistakes that cause this error include excess commas (such as trailing commas), missing commas and missing quotation marks.


 * Examples of trailing commas:


 * Examples of missing commas:


 * Example of missing quotation marks:

To fix these errors, you can either look for the errors in the code yourself, or you can enter the JSON block into an external JSON validator, such as JSONLint, and it will highlight the problematic commas and keys that should be removed.

Due to a longstanding bug, users using the 2010 wikitext editor are able to save pages that have such invalid JSON (details: ), as the JavaScript parser is less strict and allows invalid JSON.

Required property "paramOrder(number)" not found.
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.

Invalid value for property "paramOrder(number)".
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.

Property "params.parametername.required" is expected to be of type "boolean".
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 "Property "format" is expected to be "inline", "block", or a valid format string."

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.

Unexpected property "parametername".
This error occurs if you state a parameter in any 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 object under another object that it doesn't belong to.

For example, you might have written the parameter  under the root TemplateData 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 your parameters are in their correct location, and make sure there aren't any spelling mistakes in the parameter names. Additionally, make sure you don't state any parameters that don't exist for an object. You can check which parameters exist for an object on this page, in the section.

Required property "params" not found.
This error occurs if there is no  object in the TemplateData.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 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