Los datos de la plantilla son la descripción estandarizada de una plantilla, utilizada por el VisualEditor predeterminado , el editor de wikitexto opcional de 2017 y otras herramientas para mejorar la experiencia de edición de plantillas para el usuario. Tanto VisualEditor 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 está codificada formalmente (por cualquier editor de wiki) utilizando 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 debería ser el valor del parámetro.
Con los datos de la plantilla, se proporciona una lista de parámetros admitidos (y su descripción) para la plantilla.
Los datos de la plantilla proporcionan contexto para cada parámetro y hacen que sea mucho más fácil para los usuarios modificar las plantillas.
Cualquiera puede ayudar agregando datos de plantilla a las plantillas (particularmente las de alto perfil, como cuadros de información ) para que sean más fáciles de editar en VisualEditor. El siguiente es un ejemplo mínimo, colocado en la página de documentación de una plantilla:
< templatedata >{ "descripción" : "inserte descripción aquí" , "params" : { "primer parámetro" : { "etiqueta" : "x" , "descripción" : "x" , "tipo" : "cadena" , " sugerido" : verdadero , "autovalor" : "valor automático derivado" , "predeterminado" : "valor predeterminado" , "requerido" : falso } } }</ 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:
El tutorial de datos de plantilla explica en detalle cómo agregar información de datos de plantilla a una plantilla.
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 una fácil 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 los valores se hayan agregado a los datos de la plantilla, VisualEditor los mostrará en un cuadro combinado (un menú desplegable en el que los usuarios también pueden ingresar 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 los estados de un país), el usuario puede comenzar a escribir en el campo, tras lo cual la lista se filtrará para mostrar solo los valores que contengan el texto escrito. Para cambiar un valor ingresado, el usuario simplemente debe borrar el campo y la lista desplegable completa aparecerá nuevamente. 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 de parámetro debe establecerse en una de las siguientes opciones:
Otros tipos (archivo, página, plantilla, usuario, fecha, booleano, URL) no se admiten 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.
Para agregar valores sugeridos a cualquier tipo de parámetro, agregue la nueva propiedad " suggestedvalues" al parámetro en JSON. El atributo "valores sugeridos" debe ser una lista de cadenas.
Un ejemplo podría verse así:
"media_type" : { "label" : "Tipo de medio" , "ejemplo" : "Periódico" , "tipo" : "cadena" , "descripción" : "¿En qué medio se publicó el artículo?" , "valores sugeridos" : [ "Diario" , "Libro" , "Periódico" , "Revista" ] } Para los tipos de parámetros enumerados anteriormente, puede agregar valores sugeridos utilizando el editor de datos de plantilla.
Aquí puede ver un ejemplo de cómo agregar valores sugeridos en el editor TemplateData.