Wikipedia:PlantillaData

Descripción estandarizada de una plantilla
  • WP:VE/TD
  • Página de inicio: TDATA

¿Qué son los datos de plantilla?

Los datos de plantilla son la descripción estandarizada de una plantilla, utilizada por el Editor visual predeterminado , el editor de wikitexto opcional de 2017 y otras herramientas para mejorar la experiencia de edición de plantillas para el usuario. Tanto el Editor visual como el editor de wikitexto de 2017 incluyen un asistente para editar plantillas, pero para que el asistente sea más útil, debe presentar información específica al usuario sobre cada plantilla, como una breve descripción del propósito de la plantilla y sus parámetros. Esta información se codifica formalmente (por cualquier editor de wiki) utilizando datos de plantilla.

Edición sin datos de plantilla

Sin datos de plantilla, cada parámetro debe agregarse manualmente al insertar una nueva plantilla.

No se proporciona información sobre cuál debe ser el valor del parámetro.

Edición con datos de plantilla

Con los datos de la plantilla, se proporciona una lista de parámetros admitidos (y su descripción) para la plantilla.

Los datos de plantilla proporcionan contexto para cada parámetro y hacen que sea mucho más fácil para los usuarios modificar las plantillas.

Agregar datos de plantilla

Cualquiera puede ayudar agregando datos de plantilla a las plantillas (en particular, a las de alto perfil, como los cuadros de información ) para que sean más fáciles de editar en el Editor visual. El siguiente es un ejemplo mínimo, ubicado en la página de documentación de una plantilla como una nueva sección:

==TemplateData== {{ encabezado TemplateData }}< templatedata >{ "description" : "insertar descripción aquí" , "params" : { "primer parámetro" : { "label" : "x" , "description" : "x" , "type" : "string" , "suggested" : true , "autovalue" : "valor automático derivado" , "default" : "valor predeterminado" , "required" : false } } }</ templatedata >                      

También puede agregar o editar datos de plantilla usando una GUI , presionando el siguiente botón que aparece en la parte superior de la página de edición:Editar datos de plantilla

El tutorial de datos de plantilla explica en detalle cómo agregar información de datos de plantilla a una plantilla.

Agregar valores sugeridos para los parámetros

La propiedad de parámetro suggestedvaluesle permite definir una lista de valores de parámetros que se mostrarán a los usuarios de VisualEditor en un menú desplegable para facilitar su selección. Esto se puede hacer directamente en JSON o utilizando el editor TemplateData sin necesidad de codificación. Ambos métodos se explican en detalle a continuación.

Una vez que se han añadido los valores a los datos de la plantilla, el Editor visual los mostrará en un cuadro combinado (un menú desplegable en el que los usuarios también pueden introducir un valor personalizado). El usuario selecciona el valor deseado haciendo clic en él. Si la lista de valores es larga (por ejemplo, una lista de estados de un país), el usuario puede empezar a escribir en el campo, con lo que la lista se filtrará para mostrar únicamente los valores que contengan el texto escrito. Para cambiar un valor introducido, el usuario simplemente debe borrar el campo y aparecerá de nuevo la lista desplegable completa. Si el usuario necesita un valor que no está incluido en la lista (por ejemplo, "mensaje en una botella"), puede escribirlo manualmente.

Para que los valores sugeridos se muestren en el Editor visual, el tipo del parámetro debe establecerse en una de las siguientes opciones:

  • contenido
  • línea
  • cadena
  • número
  • desconocido
  • wikitexto desequilibrado.

Otros tipos (archivo, página, plantilla, usuario, fecha, booleano, URL) no son compatibles actualmente porque ya tienen funcionalidades especiales en el Editor Visual (como autocompletar) que interferirían con el menú desplegable de valores sugeridos en el Editor Visual.

Agregar valores sugeridos para parámetros en wikitexto

Para agregar valores sugeridos a cualquier tipo de parámetro, agregue la nueva propiedad “ suggestedvalues” al parámetro en JSON. El atributo “suggestedvalues” debe ser una lista de cadenas.

Un ejemplo podría verse así:

"media_type" : { "label" : "Tipo de medio" , "example" : "Periódico" , "type" : "string" , "description" : "¿En qué medio se publicó el artículo?" , "suggestedvalues" : [ "Revista" , "Libro" , "Periódico" , "Revista" ] }          

Cómo agregar valores sugeridos para los parámetros con el editor de datos de plantilla

Para los tipos de parámetros enumerados anteriormente, puede agregar valores sugeridos utilizando el editor de datos de plantilla.

  • Paso 1. Haga clic en "Administrar datos de plantilla".
  • Paso 2. Haga clic en el nombre del parámetro al que desea agregar valores sugeridos.
  • Paso 3. Si aún no lo está, configure el tipo del parámetro con uno de los siguientes: contenido, línea, cadena, número, wikitexto desconocido o no balanceado. Aparecerá un nuevo campo de entrada "Valores sugeridos". Si el parámetro ya está configurado con uno de estos tipos, el campo de entrada ya debería estar visible.
  • Paso 4. Escriba los valores sugeridos, incluidos los espacios y caracteres especiales, y presione Entrar para agregarlos a la lista.

Aquí puede ver un ejemplo de cómo agregar valores sugeridos en el editor TemplateData.

Importación de datos de plantilla

Algunas plantillas importan sus TemplateData desde WP:Wikimedia Commons . Esto se puede hacer usando {{ #invoke:TNT |doc}}. Por ejemplo, {{#invoke:TNT|doc|Uses TemplateStyles}} carga TemplateData desde c:Data:Templadata/Uses_TemplateStyles.tab que se usa en Template:Uses TemplateStyles/doc .

Plantillas usadas

Véase también

Obtenido de "https://es.wikipedia.org/w/index.php?title=Wikipedia:TemplateData&oldid=1246887752"