Help:TemplateData/sco



Whit is TemplateData?
TemplateData is ae waa o storin information aneat ae template n its parameters, sae that the VeesualEediter can retreeve n displey it in the template eediter, thus makin it easier tae eedit the templates.

The TemplateData permits uisers tae write smaa bits o structured data oan ae template page, or tae be transcluidit intil that template page (like oan ae documentation page). Yince ae template haes this structured data, it can be displeyed properlie in the VeesualEediter. While this micht soond complex, it's actuallie awfa easie.



Structur o TemplateData
The TemplateData's structur is based roond the JSON staundairt, n is fairlie simple. Mynd that aw descreeptions in TemplateData maun be in plain tex (nae wikitex, nae airtins, etc.).

The first thing tae dae is tae type oot ae pair o  tags, oniewhaur oan the template's documentation subpage, like sae:

This tells the saffware that awthing atween the twa tags is TemplateData, n shid be referanced whan the template is uised.



Example
The descreeptions inside the TemplateData follae ae staundairt layoot; lat's say that ye hae ae template cried "Commons" fer airtin til ae Commons categerie aneat ae tapeec. It taks the ae mandatair boondin: the name o the categerie oan Commons. The TemplateData wid luik sommit like this:

This wid displey, in the template, lik sae: {       "description": "Ae template fer airtin til ae commons categerie aneat aen airticle", "params": { "1": {                       "label": "Commons categerie", "description": "The commons categerie that ye want tae airt til.", "default": "Category:CommonsRoot", "type": "string", "required": true }       } }



Descreeption n boondins
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 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.