Help:TemplateData/ast



¿Qué ye TemplateData?
TemplateData ye una manera de guardar información d'una plantía y los sos parámetros, de mou que VisualEditor pueda recuperala y amosala nel editor de plantíes, faciendo d'esti mou más fácil editar plantíes.

TemplateData permite que los usuarios escriban pequeños cachos de datos estructuraos nuna páxina de plantía, o que se trescluya nesa páxina de plantía (por exemplu, na páxina de documentación). Cuando una plantía tien estos datos estructuraos, pue vese correutamente en VisualEditor. Anque esto pue sonar complicao, en realidá ye cenciello enforma.



Estructura de TemplateData
La estructura de TemplateData ta basada nel estándar JSON, y ye enforma canciella. Tenga presente que toles descripciones de TemplateData han de tar en testu planu (nin testu wiki, nin enllaces, etc.).

Lo primero qu'hai que facer ye escribir un par d'etiquetes, en cualquier llugar de la subpáxina de documentación de la plantía, asina:

Esto diz al software que tolo qu'hai ente les dos etiquetes ye TemplateData, y tien de referenciase cuando s'use la plantía.



Exemplu
The descriptions inside TemplateData follow a standard layout; let's say that you have a template called "Commons" for linking to a Commons category about a topic. It takes one mandatory parameter: the name of the category on Commons. The TemplateData would look something like this:

This would display, in the template, like so: {       "description": "A template for linking to a commons category about an article", "params": { "1": {                       "label": "Commons category", "description": "The commons category you want to link to.", "default": "Category:CommonsRoot", "type": "string", "required": true }       } }



Description and parameters
Once you're done, hit "save". If you've made errors, it will not let you save (which is disruptive, but means you can't break anything). Should you run into errors, explain on the feedback page what you were trying to do, and we will be happy to help.

Note that each bit of information is enclosed in quotation marks (except for  and  ), and separated from the next bit by a comma (unless it's the last one).



Parameter aliases
Some templates allow a same parameter to have different names.

For example,  could also be written as   or.

To add this information to TemplateData, you simply need to add the aliases to the parameter's information:



Multiple parameters
If you have multiple parameters, just repeat each section (starting from the "1" tag) and fill it out as you see fit. Note that if a template has multiple parameters, you need to separate them with a comma in the templatedata, like so:



Similar parameters
When a template has multiple parameters, sometimes some of them can be of the same kind. In this case, you only need to provide full properties for the first one, and the others can "inherit" their properties from it.



Blank boilerplate
You can copy the blank boilerplate below to add new TemplateData to a template. Only the most common tags are included.



Limitations and questions

 * Missing features — 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.