Open main menu

Help:TemplateData

This page is a translated version of the page Help:TemplateData and the translation is 47% complete.

Other languages:
Bahasa Indonesia • ‎Cymraeg • ‎Deutsch • ‎English • ‎Ilokano • ‎Lëtzebuergesch • ‎Nederlands • ‎Oromoo • ‎Scots • ‎Tiếng Việt • ‎Türkçe • ‎Zazaki • ‎asturianu • ‎azərbaycanca • ‎català • ‎dansk • ‎emiliàn e rumagnòl • ‎español • ‎euskara • ‎français • ‎føroyskt • ‎galego • ‎hrvatski • ‎italiano • ‎lietuvių • ‎magyar • ‎occitan • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎slovenčina • ‎slovenščina • ‎suomi • ‎svenska • ‎čeština • ‎Ελληνικά • ‎български • ‎русский • ‎српски / srpski • ‎українська • ‎հայերեն • ‎ייִדיש • ‎עברית • ‎العربية • ‎تۆرکجه • ‎سنڌي • ‎فارسی • ‎پښتو • ‎अङ्गिका • ‎अवधी • ‎मराठी • ‎हिन्दी • ‎বাংলা • ‎ไทย • ‎ქართული • ‎中文 • ‎日本語 • ‎ꯃꯤꯇꯩ ꯂꯣꯟ • ‎한국어
PD Nota: Ao editar esta página, você concorda em publicar a sua contribuição no âmbito da licença CC0. Veja as páginas de ajuda do domínio público para mais informações.
PD

TemplateData é uma forma de armazenar informação sobre uma predefinição em texto wiki e os seus parâmetros, de modo que o Editor Visual possa obtê-la e apresentá-la no seu editor de predefinições, tornando assim mais fácil a edição das páginas que utilizam essa predefinição. A extensão também é utilizada em ficheiros de comandos, ferramentas e gadgets.

A extensão TemplateData está instalada em todas as wikis operadas pela Wikimedia Foundation. 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 na página de uma predefinição, ou para serem transcluídos para dentro dessa página de predefinição (como a página de documentação de uma predefinição). Assim que uma predefinição tenha estes dados estruturados, ela pode ser apresentada 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á à página da predefinição (ou a sua subpágina de documentação) e clique em «Editar». Isso irá apresentar-lhe um botão «Gerir dados TemplateData», logo acima da janela de edição aberta:

Manage template documentation button for TemplateData 2014.png

Clique neste botão para entrar na interface gráfica de edição de TemplateData.

Uma captura de ecrã da ferramenta de edição 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.

Se a documentação da predefinição estiver numa subpágina, o botão «Adicionar parâmetros sugeridos» só aparece na página da predefinição. A solution is to edit the template page, click on the "Add suggested parameter(s)" in the TemplateData editor and then copy-and-paste the TemplateData content (between the <templatedata> and </templatedata> tags) in the documentation subpage.

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 <templatedata> and </templatedata> 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.

Screenshot of the TemplateData editor, showing a second parameter being added

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 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 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 — Está disponível no sistema de rastreamento de incidências da Wikimedia, uma lista dos defeitos atuais e de pedidos de funcionalidades.

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 <noinclude> . 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 <templatedata>, em qualquer lugar da subpágina de documentação da predefinição, assim:

<templatedata>
{
    ...       // O conteúdo TemplateData fica aqui
}
</templatedata>

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:

<templatedata>
{
    "description": "A template for linking to a commons category about an article",
    "params": {
        "1": {
            "label": "Categoria da wiki Commons",
            "description": "A categoria de destino na wiki Commons.",
            "default": "Category:CommonsRoot",
            "type": "string",
            "required": true
        }
    }
}
</templatedata>

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

Uma predefinição que cria uma hiperligação para uma categoria da wiki Commons sobre um artigo

Template parameters

ParameterDescriptionTypeStatus
Categoria da wiki Commons1

A categoria de destino na wiki Commons.

Default
Category:CommonsRoot
Stringrequired

Descrição e parâmetros

description The first tag is a "description", which describes what the template does.
"description": "A template for linking to a commons category",
format Next is "format", which describes how the template's wikitext representation should be laid out. This can be set to the standard formats of "inline" (padrão) and "block", or to a custom format; see below for more details.

If the parameter is set to "inline" it will create a wikitext representation with no white space, like so:

{{Foo|bar=baz|qux=quux}}

If the parameter is set to "block" it will create a wikitext representation with line breaks and single spaces between each part, like so:

{{Foo
| bar = baz
| qux = quux
}}
"format": inline
params There is then a "params" tag, which indicates that subsequent sections cover each parameter in the template.

All the parameters that follow are included in the "params" section.

"params": {
    ...    // parameters go here
}
  Within each parameter's subsection, the first tag is the name of the template parameter within the template.

If the parameter has a name, like {{{category-link}}}, this tag would be "category-link".

If the parameter is "unnamed", meaning it's just a number like {{{1}}}, this tag would be "1".

All the bits of information about this parameter are included in the section that starts with the parameter's name.

"1": {     // name of the parameter
    ...    // information about the parameter goes here
}
label Next we have "label", in which you put a human-readable title for the parameter that will be displayed within the template editor.
"label": "Categoria da wiki Commons",
description We then have "description": this time, it's a description of the parameter, not of the template as a whole.
"description": "The commons category you want to link to.",
default Next is "default". Some templates have a default value that is used unless you change it. This item tells the user what the default value for this parameter is.

You can ignore this parameter if there's no default.

"default": "Category:CommonsRoot",
type After that we have "type", which controls how the template editor will interpret that parameter. The most common types are:
  • "string": a set of characters, like this sentence;
  • "number": a set of digits;
  • "boolean": '0' for false, '1' for true, '' for unknown;
  • "wiki-user-name": a set of characters that represents a user's name;
  • "wiki-page-name": a set of characters that represents a page's title.
  • "wiki-file-name": a file name.

Other types include: "unknown", "date", "url", "wiki-template-name", "content", "unbalanced-wikitext", "line"

"type": "string",
required We then have "required", which can be set to either true or false.

This simply controls whether filling out the parameter is mandatory for that template. If you don't specify, it will be assumed to be false.

"required": true
suggested There is "suggested", which can be set to either true or false.

This is a status for parameters which are not 'required' but are recommended to be high value (but not mandatory) for template users. If you don't specify, it will be assumed to be false.

"suggested": true
deprecated

Finally, there is "deprecated", which can be set to true, false, or a string describing what users should instead do.

This is a status for parameters which should not be used any more, but still exist for the time being. This could be because uses of the template are being moved from one set of parameters to another. If you don't specify, it will be assumed to be false.

"deprecated": "Please use 'publicationDate' instead."

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 true and false), 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 \n or press the enter key to represent a newline; in either case it will display as in the entry field.

Exemplos de formatos que pode utilizar
Objetivo Texto de formato Resultado
Formatação em linha {{_|_=_}}
inline
{{Foo|bar=baz|qux=quux}}{{Bar}}
Formatação de bloco {{_\n| _ = _\n}}
block
{{Foo
| bar = baz
| qux = quux
}}{{Bar
}}
No space before the parameter name,

each template on its own line

\n{{_\n|_ = _\n}}\n
{{Foo
|bar = baz
|qux = quux
}}
{{Bar
}}
Indent each parameter {{_\n |_ = _\n}}
{{Foo
 |bar = baz
 |qux = quux
}}{{Bar
}}
Align all parameter names to a given length {{_\n|_______________ = _\n}}\n
{{Foo
|bar             = baz
|qux             = quux
|veryverylongparameter = bat
}}
{{Bar
}}
Pipe characters at the end of the previous line {{_|\n _______________ = _}}
{{Foo|
  bar             = baz|
  qux             = quux}}{{Bar}}
Inline style with more spaces, must be at start of line \n{{_ | _ = _}}
{{Foo | bar = baz | qux = quux}}
{{Bar }}
Template at the start of a line, indent-aligned parameters, pipe beforehand \n{{_ |\n _______________ = _}}
{{Foo |
  bar             = baz |
  qux             = quux}}
{{Bar}}

Nomes alternativos para os parâmetros

Some templates allow a same parameter to have different names.

For example, {{Commons|category=Apples}} could also be written as {{Commons|Apples}} or {{Commons|link=Apples}}.

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

    "params": {
        "categoria": {
            ...
            "aliases": ["1", "hiperligação"]
        }

Valor automático

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 subst: with the values to make them stick:

    "params": {
        "data": {
            ...
            "autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
        }

Parâmetros múltiplos

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:

"params": {
    "1": {
        ...
    },      // notice the comma here
    "2": {
        ...
    },      // and here
    "3": {
        ...
    }
}

Parâmetros semelhantes

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.

    "params": {
        "tópico1": {
            "label": "Tópico",
            "description": "Um tópico mencionado nesta página de desambiguação",
            "type": "string"
        },
        "tópico2": {
            "inherits": "tópico1"
        },
        "tópico3": {
            "inherits": "tópico1"
        },
    }

Blank boilerplate

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

<templatedata>
{
    "description": "",
    "params": {
        "1": {
            "label": "",
            "description": "",
            "type": ""
        },
        "2": {
            "label": "",
            "description": "",
            "type": ""
        }
    }
}
</templatedata>

Outras ferramentas

Help:Extension:TemplateWizard
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.