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 syntax allows users to write small bits of structured data to a template page, or to be transcluded into that template page (such as on a template documentation page). Once a template has this structured data, it can be displayed properly in the VisualEditor. While this may sound complex, it's actually very easy.



Editor de TemplateData
There is a built-in tool for editing TemplateData in a simpler way.

Pa usar l'editor de TemplateData, vete a la páxina de la plantía (o a la subpáxina de documentación) y calca nel botón «Editar». Con esto apaecerá un botón que diz «» al principiu de la ventana d'edición abierta: Calca nesti botón pa entrar na interfaz gráfica de la ferramienta pa editar TemplateData. L'editor te permite amestar una filera por cada parámetru de la plantía y configurar los atributos más comúnes. Si la páxina qu'editasti yá contién un bloque de TemplateData, la información que yá ta documentada amosaráse de mou automáticu cuando abras la páxina correuta nel editor de TemplateData. Nel primer cuadru, podrás amestar o anovar una descripción curtia de la plantía en testu planu. Después, puedes usar los botones «Importar parámetros» y «Amestar parámetros» pa documentar los nomes y atributos de los parámetros qu'usa la plantía.

You can list the name of the parameter, any aliases for it, the label and the description that will display to users. The only required field is Name (the first field in each row), which is where you record the exact, case-sensitive name of the parameter. In the pop-up menu, you can choose the type of content that the parameter should receive, such as a string (for plain-text answers), page (for links to other pages), or dates. If the template will produce an error if this parameter is left blank, please mark it as "Required". If the parameter is commonly used or recommended, then mark it as "Suggested". The "Remove" button will delete the parameter's entry from TemplateData.

When you are finished documenting each of the parameters, click "Apply" to insert the pre-formatted TemplateData into the open editing box. You must still save the page, using the normal "Save" button underneath the editing window.

Caution: The TemplateData editor will place TemplateData on either the template page or on a documentation subpage. You determine where the TemplateData will be added by opening (editing) the page that you want the TemplateData to be placed on. However, if multiple TemplateData blocks are placed on the same template, then only one of those TemplateData blocks will be used. If there is already TemplateData on a page, then you need to edit the page where the TemplateData was previously placed to avoid accidentally creating multiple blocks of TemplateData.



Estructura de TemplateData
La estructura de TemplateData ta basada nel estándar JSON, y ye enforma eanciella. Ten 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:

Na plantía, esto veríase asina: {       "description": "Una plantía pa enllazar a una categoría de commons sobro un artículu", "params": { "1": {                       "label": "Categoría de Commons", "description": "La categoría de commons a la que quies enllazar.", "default": "Category:CommonsRoot", "type": "string", "required": true }       } }



Descripción y parámetros
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:



Valor auto
You can specify an "autovalue" for a parameter. When users add the template to a page, this value will be added automatically. For example, many clean-up templates need to have the date added; if you specify an autovalue for the template's date parameter, then the date will be filled in automatically.

To add this information to TemplateData, simply add the autovalue to the parameter's information. You will probably want to use  to make the values stick:



Parámetros múltiples
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:



Parámetros asemeyaos
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.



Llímites y entrugues

 * Carauterístiques que falten — TemplateData ye dafechu un exemplu de ferramienta llanzada con poques carauterístiques, esperando que los usuarios ayuden a guiar el desendolcu de les carauterístiques que deseen. Si quies solicitar carauterístiques nueves pa TemplateData, por favor, infórmanos.
 * Retrasos p'amosar nes plantíes — Tres amestar TemplateData a una plantía, los metadatos tendríen de vese darréu cuando la plantía s'abre en VisualEditor. Sicasí, ye posible que pasen hores antes de que se vean los metadatos. Pues forzar un anovamientu faciendo una edición nula na propia páxina de la plantía (non na subpáxina de documentación). Pa facer una edición nula, abri pa editar la páxina de la plantía, y guarda la páxina ensin facer cambios.
 * Problemes actuales — Hai una llista de bugs actuales y solicitúes de carauterístiques disponible en bugzilla.



Otres ferramientes

 * TemplateDataEditor — Un script d'usuariu que fai más fácil el procesu d'amestar TemplateData. Anguaño esiste en francés (contién traducciones al inglés, italianu, xaponés y coreanu), y pue traducise a otres llingües fácilmente.
 * TemplateData Wizard — Una ferramienta que xenera TemplateData con una interfaz interactiva.
 * Skeleton TemplateData generator — Una ferramienta que llee el códigu wiki fonte d'una plantía, intenta alcontrar tolos parámetros qu'usa y saca una cadarma de documentu cola llista de parámetros.
 * JSONLint — Una ferramienta que te permite validar JSON escritu a mano p'ayudate a alcontrar errores de sintaxis.
 * List of all templates with TemplateData on this wiki