Help:TemplateData/pt-br

 é uma extensão usada para armazenar informações sobre uma predefinição de wikitexto e seus parâmetros, de forma que o editor visual possa as recuperar e exibir esta informação em seu editor de predefinições, facilitando a edição de páginas que usam aquela predefinição.

Desde abril de 2019, TemplateData é parte da experiência padrão do usuário para todos os usuários nas wikis da Wikimedia quando eles adicionam um template, incluindo usuários não-registrados. Tanto a fonte padrão quanto os editores visuais incorporam ela de alguma maneira. Ela também é usada em outros lugares como de scripts, ferramentas e gadgets. Se tem a sua própria wiki, então, terá de instalar.

Adicionando TemplateData a um template consiste essencialmente em inserir um pequeno bloco de código JSON (explicado abaixo) no template de documentação da página. Embora possa parecer complicado, é bastante simples. Há duas maneiras principais de fazer isso, manualmente ou usando o editor TemplateData, um usuário de interface gráfica localizado nas páginas "Editar"/"Editar Código-fonte" de templates da wikis com o TemplateData instalado. JSON contém uma lista de parâmetros com informações sobre cada parâmetro do template bem como o template como um todo. Eles estão sublinhados abaixo.

Uma vez que um template tenha TemplateData, esta informação aparecerá na interface do usuário quando um usuário adicionar o template, às vezes no lugar da informação original ou como informação adicional. Em alguns casos, isso pode mudar a maneira como o editor se comporta quando editando ou inserindo o template. Isso pode facilitar muito para usuários identificarem o que eles precisam fazer com um template ao adicioná-lo.

História
TemplateData foi originalmente desenvolvido no início de 2013 com em mente, que foi na época do estágio de testes da MediaWiki na época. VisualEditor é a interface visual de edição principal para as wikis da Wikimedia, e TemplateData permitiu que houvesse uma interface mais útil ao adicionar templates. Ela foi imediatamente apoiada oficialmente pela VisualEditor Como VisualEditor foi lançado nas várias principais wikis da Wikimedia como um recurso padrão de 2013 a 2016, TemplateData se tornou parte disso também.

Em dezembro de 2016, a interface do VisualEditor foi disponibilizada para edição de código-fonte como um recurso beta. Isso foi denominado editor wikitexto 2017. Isso trouxe os recursos do TemplateData para edição de código-fonte pela primeira vez.

Em março de 2018, Sam Wilson desenvolveu, uma extensão de edição de template GUI para o padrão de edição de código-fonte da Wikimedia, (também conhecido como o editor de wikitexto de 2010), projetado para fazer o processo de edição de templates mais fácil usando informações do TemplateData. Em abril de 2019, TemplateWizard foi feito parte padrão do editor de wikitexto de 2010 em todas as wikis da Wikimedia. Isso significava que TemplateData era agora parte padrão de ambos o editor visual e o editor de código-fonte das wikis da Wikimedia.

Adicionar ou editar TemplateData
Para adicionar ou editar TemplateData, primeiro navegue até a página de uma predefinição, localizada em "/Predefinição:Nome".

Verificações prévias
Há duas coisas que você deve verificar antes de adicionar ou editar TemplateData, na seguinte ordem:


 * 1) se a predefinição tem uma subpágina de documentação
 * 2) se a predefinição já tem TemplateData e se ele está localizado na página ou na subpágina de documentação.

Verificando a subpágina de documentação

A primeira coisa a fazer é identificar se a predefinição possui uma subpágina para sua documentação ou não.

Existem duas maneiras principais das predefinições informarem seus métodos de uso e outros dados que não devem ser incluídos na própria predefinição, como categorias:


 * A grande maioria usa uma subpágina de documentação. Esta é uma página com o mesmo nome da predefinição seguido por "/doc". Neste caso, na página da predefinição, após o código-fonte, há apenas o texto " " entre tags . Aqui, a predefinição Documentation transclui todo o conteúdo da página com "/doc". Isso faz com que o código-fonte da predefinição pareça muito mais limpo.
 * Uma pequena minoria mantém as informações na página da predefinição, após seu código-fonte. Neste caso, está contido " ", que está entre as tags.

Você pode identificar rapidamente se uma predefinição tem uma página "/doc", verificando se ela mostra " Documentação" (ou similar) seguido por links como "[ver] [editar] [histórico] [purgar]" depois dele. Isso pode parecer um pouco diferente em wikis diferentes. Raramente, a página da predefinição pode ter ainda conteúdo de documentação, mesmo se você vir esses botões e houver uma página "/doc". This will happen if a user has added a custom /doc page title between " " and " " then added content after " ".

A slightly more reliable way to check is by looking for the notice, "The above documentation is transcluded from Template:Templatename/doc" (or similar), in the box at the bottom of the page.

Se uma predefinição não tiver uma subpágina de documentação

Se uma predefinição não tiver uma subpágina de documentação, você terá duas opções:


 * Você pode criá-lo ou mover sua documentação (se houver) para lá. Depois disso, você pode adicionar TemplateData à subpágina de documentação. Esta é a opção preferida.
 * Ou você pode adicionar ou editar TemplateData na página da predefinição.

Criando a subpágina doc e movendo o conteúdo da documentação

Na maioria dos projetos da Wikimedia, você só pode criar uma página se for um usuário registrado (e, pelo menos na Wikipédia em inglês, necessita mais de quatro dias como registrado e pelo menos dez edições).

Para fazer isso, clique em "Editar/Editar código-fonte" na página da predefinição e procure as tags  e seu conteúdo, geralmente na parte inferior.

Deve ser parecido com isto:

Também pode já ter TemplateData. Isso será parecido com:

Select everything after " " and before "", cut it, then delete " ", so you are just left with:

Agora, salve a página.

Em seguida, adicione "/doc" ao URL na barra do navegador após o nome da predefinição e pressione Enter. Then, click "Create source".

If your wiki has a Documentation subpage notice template, add it at the top. You may also want to add some other templates, like a Purge button or Purge link, if your wiki has it. Veja meta:Help:Template documentation para mais informações.

Abaixo disso, cole o conteúdo da área de transferência.

Em seguida, inclua as categorias dentro das tags. Isso é para que eles não tenham efeito na subpágina de documentação, apenas na página da predefinição.

Será parecido com este:

Alguns wikis (incluindo a Wikipédia em inglês) tem uma predefinição. Use this if the template can be expected to have a sandbox version, located at "Template:Templatename/sandbox". Isso impedirá que as categorias tenham efeito na página de testes.

Será parecido com este:

Depois disso, clique em "Salvar página".

Agora você pode adicionar ou editar o TemplateData na subpágina da documentação com base na orientação em.

Adicionar ou editar TemplateData na página da predefinição

Se você não deseja ou não consegue criar a página /doc, pode adicionar ou editar TemplateData na página da predefinição. Siga as orientações em para fazer isso.

Se uma predefinição tem uma subpágina de documentação

Se uma predefinição possui uma subpágina de documentação, você deve verificar agora se já possui TemplateData e se está localizado na página principal ou na subpágina de documentação.

Verifique a página da predefinição e a subpágina "/doc" para a presença de TemplateData; parece algo assim:

{   "description": "", "params": { "1": {           "label": "Example parameter", "description": "Example parameter description", "type": "string" }   } }

Como alternativa, a extensão TemplateData pode realizar essa verificação para você. Clique em "Editar" ou "Editar código-fonte" em qualquer uma das páginas.

Se a predefinição já tiver TemplateData em qualquer página, você verá um aviso amarelo na parte superior da página dizendo:


 * "Please note: there is already a TemplateData block on the related page "Template:Templatename/doc"", or


 * "Please note: there is already a TemplateData block on the related page "Template:Templatename""

Se a predefinição tiver TemplateData em sua subpágina de documentação

Se a predefinição tiver TemplateData em sua subpágina de documentação, esta é a página que você deve editar. You can do this by clicking the "[edit]" located after the heading " Template documentation" (or similar), or, if you are already on the /doc page, by clicking "Edit" or "Edit source" at the top. Siga as orientações em para adicionar ou editar o TemplateData.

Se a predefinição tiver TemplateData em sua página principal

Se a predefinição tiver TemplateData em sua página principal, você terá novamente duas opções:


 * Você pode ir para a subpágina de documentação. Esta é a opção preferida.
 * Ou você pode editá-lo na página principal da predefinição.

Movendo TemplateData para a subpágina de documentação

Para fazer isso, clique em "Editar/Editar código-fonte" na página da predefinição e procure as tags, dentro das tags. Deve ser parecido com isto:

Cut only the tags and their contents out of the code, then save the page.

Next, edit the documentation subpage by clicking the "[edit]" located after the heading " Template documentation" (or similar).

Type a heading, like "TemplateData", then beneath it paste the TemplateData.

You can now edit the TemplateData based on the guidance at.

Editando TemplateData na página principal da predefinição

Se você não deseja mover o TemplateData para a página /doc, você pode editá-lo na página principal da predefinição. Veja para saber como editar TemplateData.

Se a predefinição ainda não tiver TemplateData, mas tiver uma subpágina doc

Se a predefinição ainda não tiver TemplateData, você deve adicioná-lo à subpágina de documentação.

Do this by clicking the "[edit]" located after the heading " Template documentation" (or similar), or, if you are already on the /doc page, by clicking "Edit" or "Edit source" at the top. Type a heading, like "TemplateData", then add it beneath this heading. A seção explica como adicionar TemplateData.

Método do editor TemplateData
Esta é a maneira mais simples de adicionar ou editar TemplateData, possível para usuários inexperientes.

O editor TemplateData é uma interface gráfica do usuário para adicionar e editar TemplateData. Faz parte da extensão TemplateData. Para acessar a ferramenta, vá em qualquer página de modelo (ou subpágina de documentação) e clique em "Editar" ou "Editar código-fonte".

Após clicar em "Editar" ou "Editar código-fonte", você verá um botão acima da área de edição e o título da página que diz "".

Clique nesse botão para entrar na interface gráfica de edição da TemplateData. Se a página em que você está já contém TemplateData, isso será mostrado aqui automaticamente.

Recursos na janela acima:


 * The top item is "Language". This item allows you to enter text content in multiple different languages, which will show depending on the language setting of the user in Preferences. It will not show depending on the language wiki, as different wikis have entirely different databases of templates. If no language TemplateData exists yet, only the language of the wiki the user is on will be available, but the user can click "Add language" to add more inputs. The language code will show in brackets next to the parameters for which it can be applied to. These include descriptions and labels.
 * The next item is the template description. This is the description of the template as a whole and is shown in various places to the user in the template editors while adding a template. This parameter and its effects are outlined here.
 * The third item is the wikitext formatting of the template. This parameter determines how the wikitext should be laid out when the user clicks "Insert", the two main types being "inline" (on one line) and "block" (on new lines). This parameter and its effects are outlined here.
 * If the user chooses "Custom", they will be able to enter a set of wikitext under "Custom format string", according to rules outlined here, to create a custom layout for the template when the user clicks "Insert".


 * The fourth item is "Template parameters". This contains a list of parameters already defined in the TemplateData, if they exist. If there are parameters stated in the template's source code for which no TemplateData exists yet, you may see a button called "Add suggested parameters". These are extracted from the template's source code by looking for  or  . Clicking "Add suggested parameters" will add these parameters under their names as defined in the source code. This will also show a green notice at the top: "2 new parameters were imported: names of parameters".
 * At the bottom is "Add parameter". This allows you to add a parameter manually with a custom name.

The next stage is clicking any one of the parameters in the list. This will allow you to edit that parameter's info.



All of these features and their effects are outlined at #Within a parameter's name.

When you are finished, click "Apply". This will automatically insert the TemplateData at the bottom of the page before the tag; or, if it already exists, it will update it with the new information without changing its position at all. The TemplateData text will also be selected when you click "Apply".

The TemplateData editor creates a  parameter at the bottom of the TemplateData or updates it if it already exists. This contains the current TemplateData parameters in the order they were displayed in the TemplateData editor. You can change the paramOrder by dragging the parameters in different orders in the TemplateData editor using the three horizontal bars on the left. and its effects are outlined here.

After this, click "Save" to save the revision of the page.

Manual method
The alternative is to add or edit TemplateData manually. You may need or wish to do this in some cases. A estrutura do TemplateData é baseada no padrão JSON, mas você não precisa aprender JSON para aprender como colocar TemplateData. It follows a few very simple rules and takes only a few dozen possible predefined parameters and values, almost always in a  format.

Adicionar TemplateData manualmente

Pré-considerações:


 * Se você estiver adicionando TemplateData em uma subpágina de documentação, você pode adicioná-lo em qualquer lugar da página; verifique se a Wikipédia do seu idioma tem um local preferido para ele. Por exemplo, na Wikipédia em inglês, TemplateData está normalmente próximo ao final da página de documentação; na Wikipédia alemã, normalmente está no topo.
 * If you're adding TemplateData on a template's main page (which is not preferred; see #Prior checks), you must make sure that it is within the  tags.

First, click "Edit" or "Edit source" on the respective page, then go to the position you are adding the TemplateData and write a heading like "TemplateData".

Many wikis (but not all) have a TemplateData header template, which adds a short notice about the TemplateData. If yours does, add this after the heading.

To start adding the TemplateData, type an opening and closing tag and a pair of curly brackets on new lines, with an empty line between them:

Next, add an indent on the empty line between the two curly brackets, and start adding parameters. Details for the parameters can be found at. Most are optional, but some are highly recommended.

Parameters can be in any order, but the order that will best correlate with what shows in the TemplateData documentation and contribute to ease of use for editors is the following:

Also, make sure the parameters within, for example, the  object are kept within that object, or you will receive an "Unexpected property" error when you try to save.

Exemplo

Aqui estão alguns exemplos de TemplateData para uma predefinição hipotética. The template would display a notice, and its source code would be programmed to place the page into a dated category based on the month and year entered. The notice could also contain a link to a talk page section, if specified. The TemplateData would look something like this:

The corresponding TemplateData documentation would display as the following:

{	"description": "Use this template to indicate that an article is in need of cleanup.", "format": "inline", "params": { "date": { "label": "Month and year", "description": "The month and year that the template was added", "type": "string", "autovalue": " ", "example": "January 2013", "suggested": true },		"reason": { "aliases": ["1"], "label": "Reason", "description": "The reason the article is in need of cleanup", "type": "string" },		"talk": { "aliases": ["talksection"], "label": "Talk page section", "description": "The section of the talk page containing relevant discussion", "type": "string" }	},	"paramOrder": [ "date", "reason", "talk" ] }

Parâmetro da TemplateData
Each parameter for TemplateData is listed below with a description and example. They are also listed at Extension:TemplateData#Format.

Within a parameter's name
Note: if neither "required", "suggested" nor "deprecated" are set as true for a parameter, its status will show as "optional" in the TemplateData documentation.

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

Type parameter
The  parameter is meant to signal to a template editor the nature of a parameter's value. In some cases, template editors have been programmed to modify the user interface for a certain parameter according to this TemplateData value, such as to only allow the user to enter valid values that match the specified type. This parameter does not have any functional effect on the template parameter or its value; it merely controls how template editors see and treat the parameter in editing mode.

How to use

It is used by adding the  parameter, followed by a colon and a space, then adding any of the values listed in the table below in speech marks.

Example:

Effects

As of February 2020, only 5 of the 13 type values have visible effects in VisualEditor and the 2017 wikitext editor, while 8 have visible effects in TemplateWizard.

The effects of certain values are likely to change as the template editors get updates to support them. One such effort for VisualEditor and the 2017 wikitext editor is tracked in the Phabricator task T55613. A similar effort to get TemplateWizard to support the boolean value is tracked in T200664.

The currently known effects are listed as follows.

Formatos personalizados
When editing the  value, you create custom formats by inputting a set of wikitext symbols using some predefined rules.


 * - start of the template
 * - content (e.g., string, integer or parameter). This underscore serves to indicate the minimum length of a value in characters and can be repeated, like . If this length is not reached, it fills the remaining characters with spaces. This can be used to align all equals signs to a specific position after a parameter (if used with   for new lines).
 * - pipe (separates parameters)
 * - equals sign (precedes the value of a parameter)
 * or pressing the enter key - new line (this will display as  in the entry field)
 * - space (can be used with  to indent new lines)
 * - end of the template

The wikitext should at least meet the minimum of, otherwise there will be an invalid format string error.

Blank boilerplate
You can copy the blank boilerplate below to add new TemplateData to a template. Only the most common tags are included.

Erro de sintaxe em JSON / Formato JSON ruim
This error occurs if you attempt to save TemplateData that has certain types of invalid JSON code, such as duplicate keys (parameters) or trailing/missing commas, in VisualEditor or the 2017 wikitext editor (JavaScript-based editors).

"Syntax error in JSON" shows if you attempt to save such code in VisualEditor or the 2017 wikitext editor, while "Bad JSON format" shows if you attempt to open up such code in the TemplateData GUI editor, on template pages.

This error can come up quite frequently while editing a template's TemplateData. The most common mistakes that cause this error include excess commas (such as trailing commas), missing commas and missing quotation marks.


 * Examples of trailing commas:


 * Examples of missing commas:


 * Example of missing quotation marks:

To fix these errors, you can either look for the errors in the code yourself, or you can enter the JSON block into an external JSON validator, such as JSONLint, and it will highlight the problematic commas and keys that should be removed.

Due to a longstanding bug, users using the 2010 wikitext editor are able to save pages that have such invalid JSON (details: ), as the JavaScript parser is less strict and allows invalid JSON.

Propriedade "paramOrder(number)" não encontrada.
This error occurs if you state a parameter in  that is not stated in. The number in the square brackets refers to the parameter in  that is missing. It refers to its order in the sequence, but it is one less than its actual position, since  is an array; 0 is the first one, 1 is the second, etc.

To fix this, make sure all parameters stated in  are listed in. Alternatively, you can remove the  object to remove this error.

Valor inválido para propriedade "paramOrder(number)".
This error occurs if you state a parameter in  that is not stated in. The number in the square brackets refers to the parameter in  that shouldn't be there. It refers to its order in the sequence, but it is one less than its actual position, since  is an array; 0 is the first one, 1 is the second, etc.

To fix this, make sure all parameters stated in  are listed in. Alternatively, you can remove the  object to remove this error.

Property "params.parametername.required" is expected to be of type "boolean".
This error occurs if you put quotation marks around the value of either  or.

These are boolean values, not strings, therefore they require no quotation marks. To fix this, remove any quotation marks around the values  or   for these parameters.

Property "format" is expected to be ...
If the  parameter exists but its value is not ,   or a valid format string, you will see the error message "Property "format" is expected to be "inline", "block", or a valid format string."

To fix this, make sure the value after  equals   or   and that there no spelling mistakes. Alternatively, if it's wikitext, make sure it contains a minimum of  and that there are no mistakes in the syntax that would normally cause a template to fail, such as duplicate equals signs or missing/duplicate curly brackets; see the section #Custom formats for the syntax for custom formats. Alternatively, you can remove the  parameter to remove this error.

Unexpected property "parametername".
This error occurs if you state a parameter that does not exist in TemplateData. This is probably due to spelling mistakes.

It also occurs if you state a parameter in any TemplateData object that is not a parameter of that object. This may be due to spelling mistakes, or you may have written the parameter of one TemplateData object under another object that it doesn't belong to.

For example, you might have written the parameter  under the root TemplateData object instead of inside  :

Alternatively, if the unexpected parameter is under a template parameter inside, you'll see its name after "params.parametername." in the error.

To fix this, make sure there aren't any spelling mistakes in the parameter names, and make sure your parameters are in their correct location. Additionally, make sure you don't state any parameters that don't exist for a TemplateData object. You can check which parameters exist for an object in the section #TemplateData parameters.

Required property "params" not found.
This error occurs if there is no  object in the TemplateData. This is a necessary object, as it contains all the details of each parameter, so to fix this error, make sure it's added and that there are no spelling mistakes. See the section above on how to add the  parameter.

Limitações e comentários

 * 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 – Depois de adicionar TemplateData a um modelo, os metadados devem ser visíveis imediatamente quando o modelo é aberto no editor visual. No entanto, é possível que demore várias horas até que os metadados sejam exibidos. 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 realizar uma edição nula, abra a página do modelo para edição e salve a página sem fazer nenhuma alteração e sem adicionar nenhum resumo de edição.
 * Problemas atuais – Uma lista de bugs atuais e pedidos para funcionalidades está disponível no rastreador de bugs da Wikimedia.

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 JSON escrito manualmente para ajudar a encontrar 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
 * https://query.wikidata.org/ and Query Helper