Help:TemplateData/pt-br

 é uma maneira de armazenar informações sobre uma predefinição de wikitexto e seus parâmetros, de forma que o editor visual possa as recuperar e exibir em seu editor de predefinições, facilitando a edição de páginas que usam aquela predefinição. É usada também em scripts, ferramentas e gadgets.

A extensão TemplateData está instalada em todas as wikis operadas pela Wikimedia Foundation. Se você possui sua própria wiki, então terá que instalar Special:MyLanguage/Extension:TemplateData.

A sintaxe da TemplateData permite a usuários escreverem pequenos trechos de dados estruturados na página de uma predefinição, ou interpolá-los na página da 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.

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

Para usar o editor de 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.

O editor permite-lhe adicionar parâmetros de predefinições e definir os atributos mais comuns. Se a página que editou já contém um bloco de TemplateData, então a informação já documentada será mostrada automaticamente quando abrir a página correta no editor de TemplateData. Na primeira caixa, pode adicionar ou atualizar uma breve descrição da predefinição em texto simples. Depois, pode usar os botões «Adicionar parâmetros sugeridos» e «Adicionar parâmetro» para documentar os nomes e atributos dos parâmetros que a predefinição usa.

If the template page is protected, you can copy-and-paste the template code in the subpage, use the "Add suggested parameter(s)" button there, copy the TemplateData content, edit back the subpage to get rid of the template code and then paste the TemplateData content. To know where to paste the TemplateData content inside the subpage, you can edit TemplateData without adding anything; you can then replace the and tags and their content by pasting over them.

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 ligações 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.

Limitações e questões

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

Localização do TemplateData
TemplateData deve estar na página que descreve, ou deve estar transcluído nela. In a template, it shall typically be wrapped into tags. On normal page rendering, it displays autogenerated documentation as shown in #Example.

Estrutura do TemplateData
A estrutura do TemplateData é baseada no padrão JSON. Note que todas as descrições no TemplateData devem estar em texto sem formatação (sem wikitexto, sem ligações, 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.

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:

Isto seria apresentado, na predefinição, assim:

{   "description": "Uma predefinição que cria uma ligação para uma categoria da wiki Commons sobre um artigo", "params": { "1": {           "label": "Categoria do Commons", "description": "A categoria de destino na wiki Commons.", "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 if you are abusing a hack template to dynamically generate TemplateData, it cannot be checked for errors before saving.

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

Formatos personalizados
When editing custom format strings in the TemplateData editor you can either type  or press the enter key to represent a newline; in either case it will display as   in the entry field.

{| class="wikitable" ! style="width:25%" | Objective ! Format string ! Output each template on its own line
 * + Examples of formats you can use
 * Inline formatting
 * Block formatting
 * No space before the parameter name,
 * Block formatting
 * No space before the parameter name,
 * Block formatting
 * No space before the parameter name,
 * No space before the parameter name,
 * No space before the parameter name,
 * No space before the parameter name,
 * Indent each parameter
 * Align all parameter names to a given length
 * Align all parameter names to a given length
 * Align all parameter names to a given length
 * Align all parameter names to a given length
 * Align all parameter names to a given length
 * Pipe characters at the end of the previous line
 * Inline style with more spaces, must be at start of line
 * Inline style with more spaces, must be at start of line
 * Inline style with more spaces, must be at start of line
 * Inline style with more spaces, must be at start of line
 * Inline style with more spaces, must be at start of line
 * Template at the start of a line, indent-aligned parameters, pipe beforehand
 * could also be written as  or.
 * could also be written as  or.

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

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

Para acrescentar essa informação ao TemplateData, simplesmente acrescente o autovalor à informação do parâmetro. Você provavelmente vai querer usar  para fazer os valores serem inseridos:

Múltiplos 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 similares
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.

Syntax Error in JSON / Bad JSON format
Due to a long standing bug, users using the old wikitext editor are able to save pages which have certain types of invalid JSON, such as duplicate keys or trailing commas (details: ). However if you attempt to save this page in a JavaScript based editor, such as VisualEditor or the 2017 Wikitext editor, you will see an error message "Syntax error in JSON," as the JavaScript parser is stricter and doesn't allow invalid JSON. Additionally, if you attempt to open up such invalid JSON with the Template Data GUI editor, you will see the error message, "Bad JSON format." To fix these errors, you can enter the JSON block into an external JSON validator, such as https://jsonlint.com/, and it will highlight the problematic commas and keys so they can be removed.

Outras ferramentas

 * : A toolbar dialog window for entering template wikitext via an form built from TemplateData.
 * 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: Uma ferramenta que permite validar o JSON escrito manualmente para ajudar a localizar erros na sintaxe.
 * 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