Help:TemplateData/es



Qué es TempletaData?
TemplateData es una manera de almacenar información acerca de una plantilla y sus parámetros, de forma que VisualEditor sea capaz de recuperarla y mostrarla en el editor de plantillas, haciendo más fácil la edición de plantillas.

TemplateData permite a los usuarios escribir pequeños bits de datos estructurados a una página de plantilla, o transcluilo a esa página de plantilla (como en la página de documentación). Una vez que una plantilla tiene estructurados sus datos, puede ser mostrada de apropiadamente en VisualEditor. Aunque ésto suena bastante complejo, es en la actualidad muy fácil.



Estructura de TemplateData
La estructura de TemplateDatase basa en el estándar JSON, y es bastante sencillo. Tenga en cuenta que todas las descripcionies en TemplateData deben estar en texto plano (no en wikitexto, no enlaces, etc.).

La premera cosa que hay que hacer es escribir un para de etiquetas, en cualquier parte en la subpágina de documentación de la plantilla, como por ejemplo:

Esto le dice al software que todo entre las dos etiquetas es TemplateData, y debe ser referido cuando la plantilla se utiliza.



Por ejemplo
Las descripciones dentro de TemplateData siguen una distribución estándar, digamos que usted tiene 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. Su TemplateData sería algo como esto:

Se mostrará 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 a la que desea vincular.", "type": "string", "required": true }       } }



Descripción y parámetros
Una vez que haya terminado, presiona "save". Si hay errores, no se permitirá guardar, (lo cual puede ser mnolesto pero significa que no puede romper nada). Si tiene algun error, puede explicar en la página de comentarios lo qué estaba tratando de hacer, y nosotros estaremos feliz de ayudarlo.

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



Alias de parámetros
Algunas plantillas permiten que un parámetro similar tenga diferentes nombres.

Por ejemplo, puede escribirse también como   or.

Par agregar esta información a TemplateData, simplemente necesita agregar los alias a la información del parámetro:



Múltiples parámetros
Si tiene varios parámetros, simplemente repita cada sección (comenzando con la etiqueta "1") y rellénela como mejor le parezca. Tenga en cuenta que si una plantilla tiene varios parámetros, necesitará separarlos con una coma en TemplateData, de este modo:



Parámetros imilares
Cuando una plantilla tiene múltiples parámetros, a veces algunos de ellos pueden ser de la misma clase. En este caso, sólamente necesita proporcionar todas las propiedades para el primero d eellos, y los otros pueden "heredar" estas propiedades.



Texto respectivo en blanco
Puede copiar el texto respectivo en blanco para agregar un nuevo TemplateDataa una plantilla. Sólo se incluyen las etiqutas más comunes.



Limitaciones y preguntas
herramienta que se puso a disposición con algunas pocas funciones, con la esperanza de que los usuarios puedan ayudar a guiar el desarrollo de las características que se deseen. Si desea solicitar nuevas características para TemplateData, por favor háganos saber.
 * Funciones faltantes — TemplateData es mucho más que un ejemplo de
 * Delays in showing in templates — After adding TemplateData to a template, the metadata should be visible immediately when the template is opened in VisualEditor. However, it is possible that it takes hours before the metadata show. You can force an update by making a null edit to the template page itself (not the documentation subpage). To perform a null edit, open the template page for editing, and save the page without making any change.
 * Current issues — A list of current bugs and feature requests is available in bugzilla.



Tools

 * w:fr:Utilisateur:Ltrlg/scripts/TemplateDataEditor.js — A user script that makes the process of adding TemplateData easier (currently only available in French).