Help:TemplateData/es



Qué es TempleteData?
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 fragmentos de datos estructurados en una plantilla de página, o ser transcluida a esa plantilla de plantilla (como en la página de documentación). Una vez que una plantilla tiene estructurados sus datos, puede ser mostrada apropiadamente en VisualEditor. Aunque ésto pueda sonar complejo, es en realidad muy fácil.



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

La primera cosa que hay que hacer es escribir un par 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 lo que está entre las dos etiquetas es TemplateData, y debe ser referenciado cuando se utiliza la plantilla.



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

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.", "default": "Category:CommonsRoot", "type": "string", "required": true }       } }



Descripción y parámetros
Una vez que haya terminado, presione "save". Si hay errores, no se permitirá guardar, (lo cual puede ser molesto 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 estaremos encantados de ayudarlo.

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



Alias de parámetros
Algunas plantillas permiten que el mismo parámetro 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 del mismo tipo. En este caso, solamente necesita proveer todas las propiedades para el primero de ellos, 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
 * Retrasos mostrando las plantillas — Luego de agregar TemplateData a una plantilla, los metadatos deberían ser visibles inmediatamente cuando la plantilla se abre en VisualEditor. Sin embargo, es posible que tome algunas horas antes que se se vean los metadatos. Usted puede forzar una actualización haciendo una edición nula a la página de la plantilla (no la subpágina de documentación). Para realizar una edición ula, abra la página de la plantilla para edición y grabe la página "sin hacer ningún cambio".
 * Noticias actuales — una lista actual de fallas y funciones solicitadas está disponible en in bugzilla.



Herramientas

 * TemplateDataEditor — Traducción de la anterior secuencia de comandos (script) en inglés.
 * TemplateData Wizard — Una herramienta que genera TemplateData a través de una interfaz interactiva.
 * Skeleton TemplateData generator — A tool that reads the source wikicode of a template, tries to find all the parameters used and outputs a skeleton document with the parameters listed.
 * JSONLint — A tool that allows you to validate manually-written JSON to help find errors in the syntax.