Help:TemplateData/pt-br

O que é TemplateData?
 é uma maneira de guardar informações sobre uma predefinição wikitexto e seus parâmetros, de forma que o Editor Visual poderá recuperá-lo e exibi-lo em seu editor de predefinições, facilitando a edição de páginas que usam essa predefinição.

A sintaxe TemplateData permite a usuários escreverem pequenos trechos de dados estruturados na página de uma predefinição, ou interpolá-los na página dessa predefinição (como a página de documentação de uma predefinição). Uma vez que essa predefinição possui esses dados, ela poderá ser exibida corretamente no Editor Visual. Embora pareça complexo, na verdade é algo bastante fácil.

TemplateData editor
Há uma ferramenta integrada para editar TemplateData de um jeito mais simples.

Para usar o editor do TemplateData, vá à página da predefinição (ou à subpágina de sua documentação) e clique no botão "Editar". Isto lhe fornecerá o botão "", bem acima da janela de edição aberta. Clique nesse botão para entrar na interface gráfica de edição do TemplateData. Este editor lhe permite adicionar parâmetros de predefinição e definir os atributos mais comuns. Se a página editada por você já tiver um bloco de TemplateData, então a informação já documentada será exibida automaticamente quando você abrir a página certa no editor do TemplateData. Na primeira caixa, você poderá adicionar ou atualizar uma curta descrição da predefinição em texto sem formatação. Depois disso, você poderá usar os botões "Importar parâmetro(s) sugerido(s)" e "Adicionar parâmetro" para documentar os nomes e atributos dos parâmetros utilizados pela predefinição.

Você pode listar o nome do parâmetro, seus nomes alternativos, seu rótulo e sua descrição que será exibida aos usuários. Você pode fornecer também um exemplo de como usar o parâmetro. O único campo obrigatório é Nome (o primeiro campo de cada linha), em que você pode guardar o nome exato do parâmetro, sensível a maiúsculas e minúsculas. No menu suspenso "Tipo" que será mostrado, você poderá escolher o tipo de conteúdo que o parâmetro deverá receber, como um string (para respostas em texto sem formatação), uma página (para links a outras páginas), ou datas. Caso a predefinição possa gerar um erro se o parâmetro for deixado em branco, marque como "Obrigatório". Caso o parâmetro seja usado frequentemente ou seja recomendado, marque como "Sugerido". O botão "Remover informação do parâmetro" deletará a entrada do parâmetro do TemplateData. Quando você terminar com a documentação de cada parâmetro, clique em "Aplicar" para inserir o TemplateData pré-formatado dentro da caixa de edição aberta. Você deve ainda salvar a página, usando o botão "Salvar" abaixo da janela de edição.

Atenção: O editor do TemplateData posicionará o TemplateData ou na página da predefinição ou na subpágina da documentação. Você poderá determinar onde o TemplateData será adicionado abrindo (editando) a página em que você deseja posicioná-lo. Todavia, se múltiplos blocos de TemplateData são posicionados na mesma predefinição, então apenas um desses blocos será utilizado. Caso já haja TemplateData numa página, então você deverá editar a página em que o TemplateData foi anteriormente colocado para evitar a criação acidental de múltiplos blocos de TemplateData.

Limitations and questions

 * Funcionalidades ausentes — O TemplateData é um exemplo de ferramenta que foi disponibilizada com algumas funcionalidades, na esperança que usuários possam ajudar a guiar o desenvolvimento de funcionalidades desejadas por eles. Caso você queira requisitar novas funções para TemplateData, por favor avise-nos.
 * Demora para aparecer nas predefinições — Após adicionar TemplateData a uma predefinição, os metadados deverão ser visíveis imediatamente quando ela for aberta no Editor Visual. No entanto, é possível que levem horas para aparecerem. Você poderá forçar uma atualização fazendo uma edição vazia na própria página da predefinição (e não na subpágina da sua documentação). Para fazer uma edição vazia, abra a página de edição da predefinição, e salve-a sem fazer quaisquer mudanças.
 * Problemas atuais — Uma lista de bugs atuais e pedidos para funcionalidades está disponível no rastreador de bugs da Wikimedia.

Structure of TemplateData
A estrutura do TemplateData é baseada no padrão JSON, e é bastante simples. Note que todas as descrições no TemplateData devem estar em texto sem formatação (sem wikitexto, sem links, etc).

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

Isso diz ao programa que tudo que está entre as duas tags é TemplateData, e deve ser usado como referência quando a predefinição for empregada.

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:

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:

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.
 * List of all templates with TemplateData on this wiki
 * With dewiki template TemplateData template data is shown in a box, and the template is added to a category of templates with template data