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.

Dentro del nombre del parámetro
Nota: si tampoco "requerido", "sugerido" ni "deprecated" está puesto como cierto para un parámetro, su estado mostrará tan "opcional" en el TemplateData documentación.

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.

Nota que si estás maltratando una plantilla de tajo a dinámicamente generar TemplateData, no pueda ser comprobado para errores antes de salvar.

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

Efectos del parámetro de tipo
El $ 1 parámetro puede tener efectos diferentes múltiples o ningún efecto que depende de el valor y según el editor de plantilla. Sus efectos están listados como sigue.



El $ 1 valor está pretendido para valores numéricos, incluyendo minus valores y decimales.


 * En VisualEditor y el 20 1 7 wikitext editor,  tiene no efecto visible.
 * En el 2 0 1 0 wikitext editor con TemplateWizard,,  causa la caja de entrada para mostrar un "+" y "$ 3 " botón en cualquier lado, los cuales levantan o bajar un valor de número en la caja de entrada, respectivamente, y el usuario puede sólo números de tipo a la caja. Los botones también pueden bajar el número a negativos.



El $ 1 valor está pretendido para cualquier cuerda de texto sencillo.


 * En todos los editores principales (VisualEditor, 2 0 1 7 wikitext editor y el 2010 wikitext editor con TemplateWizard),   tiene no el efecto visible comparó a.



El $ 1 valor está pretendido para contentar aquello tendría que ser forzado para quedarse encima uno tacha.


 * En VisualEditor y el 20 1 7 wikitext editor,  impide la caja de entrada de un parámetro de dejar líneas nuevas, los cuales son normalmente posibles en estos editores.
 * En el 20 1 0 wikitext editor con TemplateWizard,  tiene no efecto visible (cajas de entrada no dejan líneas nuevas por default en este editor).



El https:// valor está pretendido para un URL, con protocolo de Internet (p. ej., "$ 1 ") incluido.


 * En VisualEditor y el 20 1 7 wikitext editor,  marcas la caja de entrada muestra un icono de enlace externo (una plaza con la flecha que señala fuera de él) en el lado de mano izquierdo de la caja y hace el rojo de fulgor de la caja cuándo los clics de usuario fuera sin introducir un URL valor que incluye un protocolo de Internet válido (p. ej., "https://", "ftp://" o "//") siguió por algún texto. Este segundo efecto es similar a aquello del "requerido" encuadre, pero no advierte el usuario si  intentan para insertar la plantilla sin un válido URL. También ocurre con cualquier encuadre de estado (como "sugerido" o "deprecated").
 * En el 20 1 0 wikitext editor con TemplateWizard,  tiene no efecto visible.



El $ 1 valor está pretendido para un nombre de página en un wiki.


 * En todos los editores principales (VisualEditor, 20 1 7 wikitext editor y el 2010 wikitext editor con TemplateWizard),   marcas la caja de entrada del parámetro muestra una sugerencia dropdown la carta que contiene una lista de páginas en el wiki, como artículos de Wikipedia, los cuales pueden ser seleccionados. Espacios de nombres también puede ser definido en la búsqueda. Además, en VisualEditor y el 2017 wikitext editor,  fuerza el contenido de caja de la entrada para quedarse encima uno tacha. Tiene no otro efecto visible y no impide un no-página de ser ingresado.



El $ 1 valor está pretendido para un nombre de archivo hosted tampoco localmente en un wiki o en Wikimedia Commons.


 * En VisualEditor y el 20 1 7 wikitext editor,  tiene no efecto visible.
 * En el 20 1 0 wikitext editor con TemplateWizard,  marcas la caja de entrada del parámetro muestra una sugerencia dropdown la carta que contiene una lista de archivos hosted ambos localmente y en Wikimedia Commons, los cuales pueden ser seleccionados. También muestra el thumbnail de los archivos. Tiene no otro efecto visible y no impide un no-archivo de ser inputted.



El $ 1 valor está pretendido para el nombre de una plantilla.


 * En todos los editores principales (VisualEditor, 20 1 7 wikitext editor y el 2010 wikitext editor con TemplateWizard),   marcas la caja de entrada del parámetro muestra una sugerencia dropdown la carta que contiene una lista de plantillas, los cuales pueden ser seleccionados. Además, en VisualEditor y el 2017 wikitext editor,  fuerza el contenido de caja de la entrada para quedarse encima uno tacha. Tiene no otro efecto visible y no impide un no-plantilla de ser ingresado.



El $ 1 valor está pretendido para un nombre de usuario en un wiki.


 * En todos los editores principales (VisualEditor, 20 1 7 wikitext editor y el 2010 wikitext editor con TemplateWizard),   marcas la caja de entrada del parámetro muestra una sugerencia dropdown la carta que contiene una lista de páginas en el wiki, como artículos de Wikipedia, los cuales pueden ser seleccionados. Además, en VisualEditor y el 2017 wikitext editor,  fuerza el contenido de caja de la entrada para quedarse encima uno tacha. Tiene no otro efecto visible y no impide un no-nombre de usuario de ser ingresado.



El $ 1 valor está pretendido para wikitext de contenido de página, por ejemplo, enlaces, imágenes o texto formatting.


 * En VisualEditor y el 20 1 7 wikitext editor,  tiene no efecto visible.
 * En el 20 1 0 wikitext editor con TemplateWizard,  marcas la caja de entrada del parámetro uno tacha más alto y deja líneas nuevas, el cual cajas de entrada regular en el 2010 wikitext editor  no.



El $ 1 valor está pretendido para wikitext que no puede estar sólo, i.e. carece de un de apertura o cerrando etiqueta o refiere a otras partes de wikitexto.


 * En VisualEditor y el 20 1 7 wikitext editor,  tiene no efecto visible.
 * En el 20 1 0 wikitext editor con TemplateWizard,  marcas la caja de entrada del parámetro uno tacha más alto y deja líneas nuevas, el cual cajas de entrada regular en el 2010 wikitext editor.

Con otros parámetros


 * En VisualEditor y el 2 0 1 7 wikitext editor,  overrides los efectos visibles de   - cuándo ambos están puestos, la caja de entrada no contendrá un URL icono ni rojo de fulgor cuándo los clics de usuario fuera sin introducir un válido URL.
 * En el 2 0 1 0 wikitext editor con TemplateWizard,  overrides los efectos de   - el valor de "autovalue" no será automáticamente colocado en la caja de entrada si el tipo de parámetro es número "".

Formatos hechos de encargo
Cuándo editando el $ 1 valor, creas formatos hechos de encargo por inputting un conjunto de wikitexto los símbolos que utilizan algún predefinido reglas.


 * - Inicio de la plantilla
 * - Contenido (p. ej., cuerda, entero o parámetro). Este underscore sirve para indicar la longitud mínima de un valor en caracteres y puede ser repetido, como $ 1 . Si esta longitud no es lograda, llena los caracteres restantes con espacios. Esto puede soler alinear todo equals señales a una posición concreta después de un parámetro (si utilizado con $ 1 para líneas nuevas).
 * - Tubo (separa parámetros)
 * - Es igual Señal (precede el valor de un parámetro)
 * $ 1 o pulsando el introducir clave - línea nueva (esto mostrará tan $ 2 en el campo de entrada)
 * - Espacio (puede ser utilizado con  a indent líneas nuevas)
 * - Fin de la plantilla

El wikitext al menos tendría que conocer el mínimo de, otherwise habrá un error de cuerda de formato nulo.

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.

Error de sintaxis en JSON / Malo JSON formato
Este error ocurre si intentas para salvar TemplateData aquello tiene tipos seguros de nulos JSON código, como llaves duplicadas (parámetros) o comas/desaparecidas finales, en VisualEditor o el 2017 wikitext editor (Javascript-basó editores).

"Error de sintaxis en JSON" espectáculos si intentas para salvar tal código en VisualEditor o el 2017 wikitext editor, mientras "Malo JSON espectáculos" de formato si  intentas para abrir arriba de tal código en el TemplateData GUI editor, encima páginas de plantilla.

Este error puede venir arriba bastante frecuentemente mientras editando una plantilla TemplateData. Las equivocaciones más comunes que causa este error incluye comas sobrantes (como comas finales), perdiendo comas y marcas de mención desaparecida.


 * Ejemplos de comas finales:


 * Ejemplos de comas desaparecidas:


 * Ejemplo de marcas de mención desaparecida:

Para fijar estos errores, tampoco puedes buscar los errores en el código tú, o puedes introducir el JSON bloque a un externo JSON validator, como $ 1, y  destaque las comas problemáticas y llaves que tendría que ser sacado.

Debido a un longstanding bicho, los usuarios que utilizan el 20 1 0 wikitext el editor es capaz de salvar páginas que tiene tal nulo JSON (detalles: ), cuando el Javascript parser es menos estricto y deja nulo JSON.

Propiedad requerida "paramOrder(número)" no encontrado.
Este error ocurre si declaras un parámetro en $ 1 aquello no es declarado en $ 2 .El número en los paréntesis cuadrados refiere al parámetro en   aquello falta. Refiere a su orden en la secuencia, pero es uno  menos de su posición real, desde $ 1 es una variedad; 0 es el primer un, 1 es el segundo, etc.

Para fijar esto, marca seguro todos los parámetros declararon en $ 1 está listado en $ 2 .Alternativamente,  puedes sacar el $ 1 objeto para sacar este error.

Valor nulo para propiedad "paramOrder(número)".
Este error ocurre si declaras un parámetro en $ 1 aquello no es declarado en $ 2 .El número en los paréntesis cuadrados refiere al parámetro en   aquello no tendría que ser allí. Refiere a su orden en la secuencia, pero es uno  menos de su posición real, desde $ 1 es una variedad; 0 es el primer un, 1 es el segundo, etc.

Para fijar esto, marca seguro todos los parámetros declararon en $ 1 está listado en $ 2 .Alternativamente,  puedes sacar el $ 1 objeto para sacar este error.

Se espera que la propiedad "params.parametername.required" sea del tipo "booleano"
Este error ocurre si pones marcas de mención alrededor del valor de cualquier "requerido" o "sugerido".

Estos son valores booleanos, no cuerdas, por lo tanto requieren #ninguno marcas de mención. Para fijar esto, sacar cualesquier marcas de mención alrededor de los valores $ 1 o $ 2 para estos parámetros.

Formato "de propiedad" está esperado para ser ...
Si el $ 1 parámetro existe pero su valor no es $ 2, $ 3 o una cuerda de formato válida, verás el formato de Propiedad "de mensaje "de error" está esperado para ser "inline", "bloque", o una cuerda de formato válida."

Para fijar esto, marca seguro el valor después de que "formato": equals $ 1 o $ 2 y que allí #ninguno equivocaciones de ortografía. Alternativamente, si es wikitext, marca seguro  contiene un mínimo de $ 3 y que no hay ninguna equivocación en la sintaxis que normalmente causaría una plantilla para fallar, como duplicado equals señales o desaparecidos/duplicados curly paréntesis; ver la sección #  #Hecho para la sintaxis para formatos hechos de encargo.Alternativamente,  puedes sacar el $ 1 parámetro para sacar este error.

Propiedad inesperada "parametername".
Este error ocurre si declaras un parámetro en cualquier objeto que no es un parámetro de aquel objeto. Esto puede deber a deletrear equivocaciones, o puedes haber escrito el parámetro de uno objeta bajo otro objeto que no pertenece a.

Por ejemplo, podrías haber escrito el parámetro $ 2 bajo la raíz TemplateData objeto en vez de dentro de $ 3 :

Alternativamente, si el parámetro inesperado es bajo un parámetro de plantilla dentro de $ 1, verás su nombre después de "params.parametername." En el error.

Para fijar esto, marca seguro vuestros parámetros son en su ubicación correcta, y marca seguro no hay cualesquier equivocaciones de ortografía en los nombres de parámetro. Además, marca seguro no declaras cualesquier parámetros que no existe para un objeto. Puedes comprobar qué parámetros existen para un objeto en esta página, en la sección.

Propiedad requerida "params" no encontrado.
Este error ocurre si hay no $ 1 objeto en el TemplateData.Esto es un objeto necesario, cuando  contiene todos los detalles de cada parámetro, así que para fijar este error, marca seguro  está añadido y que  hay #ninguno equivocaciones de ortografía. Ve la sección encima encima cómo para añadir el $ 2 parámetro.

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

 * : Un barra de herramientas ventana de diálogo para introducir plantilla wikitexto vía una forma construida de 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