Help:TemplateData/gl



Qué é TempleteData?
TemplateData é unha maneira de almacenar información acerca dun modelo e dos seus parámetros, de forma que o editor visual sexa capaz de recuperala e mostrala no editor de modelos, facendo máis doada a edición de modelos.

TemplateData permite ós usuarios escribir pequenos fragmentos de dados estruturados nun modelo de páxina, ou ser transcluída a ese modelo de modelo (como na páxina de documentación). Unha vez que un modelo ten estruturados os seus dados, pode ser mostrada apropiadamente no editor visual. Aínda que isto poida sonar complexo, é en realidade moi sinxelo.



Estrutura de TemplateData
A estrutura de TemplateData baséase no estándar JSON, e é bastante sinxelo. Teña en conta que todas as descricións en TemplateData deben estar en texto plano (sen texto wiki, sen ligazóns, etc.).

A primeira cousa que hai que facer é escribir un par de etiquetas, en calqueira parte na subpáxina de documentación da plantilla, como por exemplo:

Isto dille ó software que todo o que está entre as dúas etiquetas é o TemplateData, e debe ser referenciado cando se utilice o modelo.



Exemplo
As descricións dentro de TemplateData seguen unha distribución estándar, digamos que vostede ten un modelo chamado "Commons" para ligar a unha categoría de Commons sobre un tema en particular. Necesítase un parámetro obrigatorio: o nome da categoría en Commons. O seu TemplateData sería algo así:

Mostrarase no modelo do seguinte xeito: {       "description": "Un modelo para ligar unha categoría de Commons sobre un artigo", "params": { "1": {                       "label": "Categoría de Commons", "description": "A categoría de Commons á que desexa ligar.", "default": "Category:CommonsRoot", "type": "string", "required": true }       } }



Descrición e parámetros
Así que o teñas listo, preme "gardar". Se cometeu algún erro, non lle permitirá gardar (isto é molesto, pero asegura de que non poida estropear nada). Deberá desfacer os erros, explicar na páxina de comentarios o que estaba tentando facer, e nós estaremos encantados de responderlle.

Decátese de que cada parte de información está rodeado por comiñas (excepto para  e  ), e separado da seguinte parte por unha coma (a non ser que sexa a última).



Alias de parámetros
Algúns modelos permiten que o mesmo parámetro teña diferentes nomes.

Por exemplo,  pode escribirse tamén como   ou.

Para engadir esta información no TemplateData, só ten que engadir os alias á información do parámetro:



Múltiples parámetros
Se ten múltiples parámetros, só ten que repetir cada sección (comezando dende a marca "1") e enchelos como xa se veu. Teña en conta que si un modelo ten múltiples parámetros, necesita separalos cunha coma no templatedata, deste xeito:



Parámetros similares
Cando un modelo ten múltiples parámetro, ás veces algúns deles poden ser do mesmo tipo. Neste caso, só ten que proporcionar todas as propiedades do primeiro, e os demáis poden "herdar" as propiedades del.



Borrar texto estándar
Vostede pode copiar o texto estándar en blanco de abaixo e engadir un novo TemplateData ó modelo. Só se inclúen as etiquetas máis comúns.



Limitacións e preguntas

 * Características perdidas — TemplateData is very much an example of tool that was made available with few features, in hope that users would help to guide development of features that they desired. If you'd like to request new features for TemplateData, please let us know.
 * 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

 * TemplateDataEditor — A user script that makes the process of adding TemplateData easier. It currently exists in English and French, and can easily be translated into other languages.
 * TemplateData Wizard — A tool that generates TemplateData through an interactive interface.
 * 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.