Help:TemplateData/eu

What is TemplateData?
TemplateData txantiloi bati eta haren parametroei buruzko informazioa gordetzeko modu bat da, VisualEditor-ek berreskuratu eta erakus dezan txantiloi editorean, honela errazagoa izan dadin txantiloiak aldatzea.

TemplateData sintaxiak erabiltzaileei aukera ematen die informazio estrukturatuaren parte txikiak txantiloi- orri batera idazteko, edo txantiloi-orri batean txertatzeko(txantiloi-dokumentazio orri bat bezalaxe). Behin txantiloi batek informazio hori estrukturatua izanda, egoki heda daiteke Ikusizko Editorean. Konplexua dirudien arren, berez oso erraza da.

TemplateData editor
Bada tresna integratu bat TemplateData modu sinpleagoan editatzeko.

TemplateData editorea erabiltzeko, joan txantiloiaren orrira (edo haren dokumentuaren azpiorrira) eta sakatu "Aldatu" botoia. Horrek "" dioen botoi bat emango dizu, justu edizio lehioaren gainean: Sakatu botoi hau TemplateData aldatzeko tresna bisualean sartzeko. Editoreak errenkada bat gehitzeko aukera ematen dizu txantiloi-parametro bakoitzeko, baita atributu ohikoenak ezartzeko ere. Jada editatu duzun orriak TemplateData bloke bat badu, jarraian jada dokumentatua den informazioa automatikoki agertuko da orri egokia TemplateData editorean irekitzen duzunean. Aurreneko koadroan, txantiloiaren deskribapen labur bat testu arruntean gehitu edo aktualizatu daiteke. Horren ostean, erabili ahal dituzu "Parametroak inportatu" eta "Parametroak gehitu" botoiak, txantiloiak erabiltzen dituen parametroen izen eta atributuak dokumentatzeko.

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.

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 the Wikimedia bug tracker.

Structure of TemplateData
TemplateData's structure is based around the JSON standard, and is fairly simple. Note that all descriptions in TemplateData must be in plain text (no wikitext, no links, etc.).

The first thing to do is to type out a pair of  tags, anywhere on the template's documentation subpage, like so:

This tells the software that everything between the two tags is TemplateData, and should be referenced when the template is used.

Example
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:

Txantiloian, honela agertuko da:

{   "description": "Txantiloi bat artikulu bati buruzko Commons kategoriara lotzeko", "params": { "1": {           "label": "Commons kategoria", "description": "Lotu nahi duzun Commons kategoria.", "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
Txantiloi batzuk parametro bakar batek izen ezberdinak izateko aukera ematen dute.

Adibidez,  izan daiteke ere idatzia   edo   bezala.

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

Auto value
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:

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.

Other tools

 * TemplateDataEditor — A user script that makes the process of adding TemplateData easier. It currently exists in French (contains English, Italian, Japanese and Korean translations), 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.
 * Wiki honetan TemplateData duten txantiloi guztien zerrenda.
 * With dewiki template TemplateData template data is shown in a box, and the template is added to a category of templates with template data