Help:TemplateData/pt

 é um modo de armazenamento de informação acerca de um modelo de wikitexto e os seus parâmetros, de modo que o Editor Visual possa recuperá-lo e exibi-lo no seu editor de modelos, tornando assim mais fácil a edição das páginas que utilizam esse modelo. Também é utilizado em outros lugares 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 Extension:TemplateData.

A sintaxe "TemplateData" permite que os utilizadores escrevam partes pequenas de dados estruturados numa página de modelo, ou para ser interpolados nessa página de modelo (tal como a página de documentação de modelo). Assim que o modelo tenha os dados estruturados, este pode ser exibido corretamente no editor visual. Embora isto possa parecer complexo, é na verdade muito fácil.

Editor de TemplateData
Existe uma ferramenta interna para editar "TemplateData" de uma forma mais simples.

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

Clique neste botão para entrar na GUI para editar TemplateData.

O editor permite-lhe adicionar parâmetros de de modelo 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 do modelo em texto simples. After that, you can use the "Add suggested parameter(s)" and "Add parameter" buttons to document the names and attributes of the parameters that the template uses.

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á exibida para os 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, o nome do parâmetro é sensível a maiúsculas e minúsculas. No menu suspenso "Tipo", pode escolher o tipo de conteúdo que o parâmetro deverá receber, tais como uma "string" (para textos sem formatação), página (para ligações a outras páginas), ou datas. Se o modelo irá gerar um erro se este parâmetro for deixado em deixado em branco, então marque-o como "Obrigatório". Se o parâmetro é utilizado frequentemente ou é recomendado, então marque-o como "Recomendado". O botão "Remover informação do parâmetro" irá eliminar a entrada do parâmetro de TemplateData.



Quando terminar a documentação de cada um dos parâmetros, clica em "Aplicar" para inserir o TemplateData pré-formatado na caixa de edição aberta. Deve ainda guardar a página, ao utilizar o botão normal "Guardar" debaixo da janela de edição.

Atenção: o editor de TemplateData irá inserir TemoplateData na página do modelo ou na subpágina da documentação. Poderá determinar onde o TemplateData será adicionado ao abrir (editar) a página onde deseja adicioná-lo. No entanto, se vários blocos de TemplateData forem adicionados ao mesmo modelo, apenas será utilizado um desses blocos. Se TemplateData já existir numa página, então deverá editar a página onde ele foi previamente adicionado, a fim de evitar a criação acidental de vários blocos de TemplateData.

Limitações e perguntas

 * 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 de funcionalidades desejadas por eles. Se pretender solicitar novas funcionalidades para TemplateData, por favor, diga-nos.
 * Atraso na apresentação nos modelos — Depois de adicionar TemplateData a um modelo, os metadados deverão estar visíveis imediatamente assim que o modelo for aberto no Editor Visual. Contudo, é possível que leve várias horas para que os metadados sejam mostrados. Pode forçar uma atualização ao efetuar uma edição vazia na própria página do modelo (e não na subpágina da documentação). Para realizar uma edição vazia, abra a página do modelo para editar, e guardar a a página "sem qualquer alteração e sem a adição de qualquer resumo da edição''.
 * Problemas actuais — Uma lista de erros actuais e pedidos de funcionalidades está disponível no rastreador de erros da Wikimedia.

Localização de TemplateData
TemplateData deve estar na página que descreve, ou estar interpolados nela. Num modelo, este tipicamente deve estar envolvido em "tags". Numa página normal de renderização, esta exibe documentação gerada automaticamente como mostrado no #Exemplo.

Estrutura de TemplateData
A estrutura de TemplateData baseia-se no JSON padrão. Tenha em atenção 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 é escrever um par de "tags", em qualquer lugar na subpágina da documentação do modelo, 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:

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

Custom formats
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:

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 the prefix  with the values to make them 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

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