Help:TemplateData/pt-br



O que é TemplateData?
TemplateData é uma forma de armazenar informação sobre uma predefinição e seus parâmetros, de tal modo que o Editor Visual possa obtê-la e exibi-la no editor de predefinições, facilitando assim a edição das predefinições.

TemplateData permite que os usuários escrevam pequenos trechos de dados estruturados na página de uma predefinição, ou em uma página que será transcluída na predefinição (tal como uma paǵina de documentação). Uma vez que a predefinição tenha esses dados estruturados, eles podem ser exibidos adequadamente no Editor Visual. Mesmo que isso pareça complicado, na verdade é bastante fácil.



Estrutura de TemplateData
A estrutura de TemplateData é baseada no padrão JSON, e é bastante simples. Note que todas as descrições em TemplateData precisam estar em texto simples (sem código wiki, links, etc.).

A primeira coisa a fazer é digitar um par de  tags, em qualquer lugar de sua subpágina de documentação, assim:

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



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

Isso apareceria, na predefinição, da seguinte forma: {       "description": "Uma predefinição para ligar o artigo com uma categoria relacionada do Commons", "params": { "1": {                       "label": "Categoria do Commons", "description": "A categoria do Commons para a qual deseja criar um link.", "default": "Category:CommonsRoot", "type": "string", "required": true }       } }



Descrição e 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).



Nomes alternativos dos parâmetros
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:



Vários parâmetros
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 semelhantes
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.



Limitações e questões

 * Funcionalidades ausentes — 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.
 * Demora a aparecer nas predefinições — 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.
 * Problemas atuais — A list of current bugs and feature requests is available in bugzilla.



Ferramentas

 * 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.