Help:TemplateData/pt

 é uma forma de armazenar informação sobre um modelo de texto da wiki e os seus parâmetros, de modo que o editor visual possa obtê-lo e apresentá-lo no seu editor de modelo, tornando assim mais fácil a edição das páginas que utilizam esse modelo. Este é também utilizado em 'scripts, ferramentas, e gadgets''.

A extensão "TemplateData" está instalada em todas as wikis operadas pela Fundação Wikimedia. Se tem a sua própria wiki, então, terá de instalar Extensão:Dados de Modelo.

A sintaxe "TemplateData" permite que os utilizadores escrevam partes pequenas de dados estruturados na página de um modelo, ou para serem transferidos para dentro dessa página do modelo (tal como a página de documentação de um modelo). Assim que um modelo tenha estes dados estruturados, ele pode ser apresentado corretamente no editor visual. Embora isto possa parecer complexo, é na verdade muito fácil.

Editor de Dados de Modelo
Existe uma ferramenta incorporada para editar "TemplateData" de uma forma mais simples.

Para utilizar o editor de "TemplateData", vá à página de modelos (ou a sua subpágina de documentação) e clique em "Editar". Isso irá apresentar-lhe um botão «», logo por cima da janela de edição aberta:

Clique neste botão para entrar na interface gráfica de edição de "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.

Pode listar o nome do parâmetro, quaisquer nomes alternativos para o mesmo, a etiqueta e a descrição que será apresentada aos utilizadores. Também pode fornecer um exemplo de como utilizar o parâmetro. O único campo obrigatório é «Nome» (o primeiro campo de cada linha), que é onde regista o nome exato do parâmetro, respeitando o uso de maiúsculas e minúsculas. No menu suspenso «Tipo», pode escolher o tipo de conteúdo que o parâmetro deverá receber, tais como texto (para texto simples), página (para hiperligações para outras páginas) ou datas. Se a predefinição irá gerar um erro se este parâmetro for deixado em branco, então marque-o como «Obrigatório». Se o parâmetro é utilizado frequentemente ou é recomendado, então marque-o como «Sugerido». O botão «Remover informação do parâmetro» elimina a entrada do parâmetro de TemplateData.



Quando terminar de documentar cada parâmetro, clique «Aplicar» para inserir os dados TemplateData preformatados na caixa de edição aberta. Terá, ainda assim, de gravar a página, usando o botão normal «Gravar» abaixo da janela de edição.

Atenção: o editor de TemplateData coloca dados TemplateData na página da predefinição ou numa subpágina de documentação. Pode influenciar onde os dados TemplateData são adicionados abrindo (editando) a página onde deseja adicioná-los. No entanto, se forem colocados vários blocos de TemplateData na mesma predefinição, só será utilizado um desses blocos. Assim, se já existirem dados TemplateData numa página, tem de editar a página no sítio onde os dados TemplateData já estão colocados, para evitar a criação acidental de vários blocos de TemplateData.

Limitações e questões

 * Funcionalidades em falta — TemplateData é um exemplo de uma ferramenta disponibilizada com poucas funcionalidades, na esperança de que os utilizadores possam ajudar a orientar o desenvolvimento das funcionalidades desejadas por eles. Se pretender solicitar novas funcionalidades para TemplateData, então, por favor, diga-nos.
 * Demora para aparecer nas predefinições — Depois de adicionar TemplateData a uma predefinição, os metadados deverão ser visíveis imediatamente assim que a predefinição for aberta no editor visual. Contudo, é possível que os metadados demorem várias horas a aparecer. Pode forçar uma atualização, efetuando uma edição nula da própria página da predefinição (não da subpágina de documentação). Para realizar uma edição nula, abra a página para editar a predefinição e grave-a sem fazer nenhuma alteração e sem adicionar um resumo da edição.
 * Problemas atuais — Uma lista dos erros atuais e de pedidos de funcionalidades está disponível no sistema de rastreamento de erros da Wikimedia.

Localização de TemplateData
Os dados TemplateData devem estar na página que descrevem, ou ser transcluídos para dentro dela. Numa predefinição, devem normalmente estar envolvidos em etiquetas. Durante a composição gráfica normal da página, ela apresenta documentação gerada automaticamente, como é mostrado em #Exemplo.

Estrutura de TemplateData
A estrutura dos dados TemplateData baseia-se no padrão JSON. Tenha em atenção que no TemplateData todas as descrições têm de estar em texto simples (sem texto wiki, sem hiperligações, etc.).

A primeira coisa a fazer é escrever um par de etiquetas, em qualquer lugar da subpágina de documentação da predefiniçã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:

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

{   "description": "Uma predefinição que cria uma hiperligação para uma categoria da wiki Commons sobre um artigo", "params": { "1": {           "label": "Categoria da Commons", "description": "A categoria da Commons que pretende interligar.", "default": "Category:CommonsRoot", "type": "string", "required": true }   } }

Descrição e parâmetros
Each parameter for TemplateData is listed below with a description and example. They are also listed at Extension:TemplateData#Format.

The order of the parameters does not affect functionality, as long as those within, for example, the  object are kept within the object.

Note that this information is current as of February 2020 and may change if new parameters are added or the template editors get updates to treat certain parameters differently or fix certain behaviours.

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

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.

Effects of the type parameter
The  parameter can have multiple different effects or no effect depending on the value and depending on the template editor. Its effects are listed as follows.



The  value is intended for numerical values, including minus values and decimals.


 * In VisualEditor and the 2017 wikitext editor,  has no visible effect.
 * In the 2010 wikitext editor with TemplateWizard,,  causes the input box to display a "+" and "-" button on either side, which raise or lower a number value in the input box, respectively, and the user can only type numbers into the box. The buttons can also lower the number into negatives.



The  value is intended for any string of plain text.


 * In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard),  has no visible effect compared to.



The  value is intended for content that should be forced to stay on one line.


 * In VisualEditor and the 2017 wikitext editor,  prevents a parameter's input box from allowing new lines, which are usually possible in these editors.
 * In the 2010 wikitext editor with TemplateWizard,  has no visible effect (input boxes do not allow new lines by default in this editor).



The https:// value is intended for a URL, with Internet protocol (e.g., "https://") included.


 * In VisualEditor and the 2017 wikitext editor,  makes the input box display an external link icon (a square with arrow pointing out of it) in the left hand side of the box and makes the box glow red when the user clicks away without entering a URL value that includes a valid Internet protocol (e.g., "https://", "ftp://" or "//") followed by some text. This second effect is similar to that of the "required" setting, but it does not warn the user if they attempt to insert the template without a valid URL. It also occurs with any status setting (such as "suggested" or "deprecated").
 * In the 2010 wikitext editor with TemplateWizard,  has no visible effect.



The  value is intended for a page name on a wiki.


 * In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard),  makes the parameter input box show a suggestion dropdown menu containing a list of pages on the wiki, such as Wikipedia articles, which can be selected. Namespaces can also be defined in the search. Additionally, in VisualEditor and the 2017 wikitext editor, it forces the input box content to stay on one line. It has no other visible effect and doesn't prevent a non-page from being inputted.



The  value is intended for a file name hosted either locally on a wiki or on Wikimedia Commons.


 * In VisualEditor and the 2017 wikitext editor,  has no visible effect.
 * In the 2010 wikitext editor with TemplateWizard,  makes the parameter input box show a suggestion dropdown menu containing a list of files hosted both locally and on Wikimedia Commons, which can be selected. It also shows the thumbnail of the files. It has no other visible effect and doesn't prevent a non-file from being inputted.



The  value is intended for the name of a template.


 * In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard),  makes the parameter input box show a suggestion dropdown menu containing a list of templates, which can be selected. Additionally, in VisualEditor and the 2017 wikitext editor, it forces the input box content to stay on one line. It has no other visible effect and doesn't prevent a non-template from being inputted.



The  value is intended for a username on a wiki.


 * In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard),  makes the parameter input box show a suggestion dropdown menu containing a list of actual users' names, which can be selected. Additionally, in VisualEditor and the 2017 wikitext editor, it forces the input box content to stay on one line. It has no other visible effect and doesn't prevent a non-username from being inputted.



The  value is intended for wikitext of page content, for example, links, images or text formatting.


 * In VisualEditor and the 2017 wikitext editor,  has no visible effect.
 * In the 2010 wikitext editor with TemplateWizard,  makes the parameter input box one line taller and allows new lines, which regular input boxes in the 2010 wikitext editor do not.



The  value is intended for wikitext that cannot stand alone, i.e. it lacks an opening or closing tag or refers to other parts of wikitext.


 * In VisualEditor and the 2017 wikitext editor,  has no visible effect.
 * In the 2010 wikitext editor with TemplateWizard,  makes the parameter input box one line taller and allows new lines, which regular input boxes in the 2010 wikitext editor do not.

With other parameters


 * In VisualEditor and the 2017 wikitext editor,  overrides the visible effects of   - when both are set, the input box will not contain a URL icon nor glow red when the user clicks away without entering a valid URL.
 * In the 2010 wikitext editor with TemplateWizard,  overrides the effects of   - the value of "autovalue" will not be automatically placed in the input box if the parameter type is "number".

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 / Mau formato JSON
If you attempt to save TemplateData that has certain types of invalid JSON, such as duplicate keys (parameters) or trailing/missing commas, in VisualEditor or the 2017 wikitext editor (JavaScript-based editors), you will see the error message "Syntax error in JSON". These errors can come up quite frequently while heavily editing a template's TemplateData.

Examples of trailing commas:

Examples of missing commas:

Another common cause is missing quotation marks:

Additionally, if you attempt to open up such invalid JSON with the TemplateData 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 JSONLint, and it will highlight the problematic commas and keys that should be removed. Alternatively, you can look for the errors in the code yourself.

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.

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 in  equals ,   or, if it's wikitext, contains a minimum of. Additionally, if it's wikitext, make sure 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.

Required property "paramOrder(number)" not found.
This error occurs if you state a parameter in  that is not stated in. The number in the square brackets is the parameter in  that is missing (it is one less, since it 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.

Invalid value for property "paramOrder(number)".
This error occurs if you state a parameter in  that is not stated in. The number in the square brackets is the parameter in the  that is missing (it is one less, since it 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.

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.

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: A tool that allows you to validate manually-written JSON to help find errors in the syntax.
 * Lista de todos os modelos com TemplateData nesta 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