Ajuda:TemplateData
 |
Nota: Ao editar esta página, você concorda em publicar suas contribuições no âmbito da licença CC0. Veja as páginas de ajuda sob domínio público para mais informações. | |
TemplateData é uma extensão que armazena informações e parâmetros associados a uma predefinição de wikitexto e disponibiliza-os a uma interface de edição que os obtem e apresenta em um editor de predefinições — facilitando a adição e edição de predefinições em páginas por parte dos usuários. It also provides a user interface for discovering templates.
Desde abril de 2019, a funcionalidade de dados de predefinição faz parte da experiência de usuário padrão para todos os usuários nas wikis da Wikimedia quando adicionam uma predefinição, incluindo usuários não-registrados. Tanto o editor de código-fonte como o editor visual incorporam-na de alguma maneira, assim como o fazem vários scripts, ferramentas e gadgets. Deseja essa funcionalidade em sua própria wiki? Se sim, instale Extension:TemplateData.
Adicionar dados a uma predefinição para que essa extensão os utilize envolve inserir um simples e breve bloco de código JSON (explicado abaixo) na página de documentação da predefinição.
Há duas maneiras principais de fazer isso, manualmente ou usando o editor de dados da predefinição, uma interface gráfica de usuário localizada nas páginas “Editar”/“Editar código-fonte” das predefinições em wikis com a TemplateData instalada.
O JSON contém uma lista dos parâmetros da predefinição e informações sobre esses parâmetros e sobre a predefinição como um todo (veja abaixo para mais detalhes).
As predefinições que contiverem dados exibirão essas informações na interface de usuário assim que o usuário adicionar a predefinição. Em alguns casos, isso mudará a maneira com a qual o editor se comporta quando estiver editando ou inserindo uma predefinição, facilitando e muito a realização das etapas necessárias para adicionar aquela predefinição por parte do usuário.
História
A funcionalidade TemplateData foi originalmente desenvolvida no início de 2013 com o Editor Visual em mente, o qual estava em estágio de testes no MediaWiki na época. O Editor Visual é a principal interface de edição visual das wikis da Wikimedia, e os dados de predefinição permitem que ele possua uma interface mais útil de adição de predefinições. O TemplateData tornou-se compatível com o Editor Visual desde seu lançamento. À medida que o Editor Visual era implementado em várias wikis grandes da Wikimedia como um recurso padrão entre 2013 e 2016, os dados de predefinição também se tornavam parte delas.
Em dezembro de 2016, como um recurso Beta, a interface do Editor Visual foi disponibilizada para ser usada na edição de código-fonte. A isso denominamos “Editor de wikitexto 2017”. Isso trouxe os recursos de dados de predefinição para a edição de código-fonte pela primeira vez.
Em março de 2018, Sam Wilson desenvolveu o TemplateWizard, uma extensão para edição de predefinições com interface gráfica, a ser usada dentro do editor de código-fonte padrão da Wikimedia, o WikiEditor (também conhecido como “Editor de wikitexto 2010”). Ele foi projetado para facilitar o processo de adição de predefinições, por meio do uso de informações vindas dos dados das predefinições. Em abril de 2019, o TemplateWizard passou a fazer parte do editor de wikitexto 2010 em todas as wikis da Wikimedia por padrão. Isso significa que o dados de predefinição passaram a ser uma parte padrão de ambos o editor visual e o editor de código-fonte das wikis da Wikimedia.
Adicionar ou editar dados de predefinição
Para adicionar ou editar dados de predefinição, primeiro navegue até a página de uma predefinição, localizada em “/Predefinição:Nome da predefinição”.
Checking the current state
Before adding or editing template data, check whether the template has a documentation subpage. Then check whether the template already contains template data and, if so, whether it's located on the template page or the documentation subpage.
Documentation subpages
Existem duas maneiras principais das predefinições informarem suas formas de uso e outros dados que não devem ser incluídos na própria predefinição, como categorias:
- A grande maioria das predefinições mantém informações de uso e outros dados que não pertencem à página da predefinição em uma subpágina de documentação: “/Predefinição:Nome da predefinição/doc”. 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.
- 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.
- Você pode identificar rapidamente se uma predefinição tem uma página /doc, verificando se ela mostra "
- Uma pequena minoria mantém as informações na página da predefinição, após seu código-fonte.
Neste caso, está contido {{Documentation|content=, que está entre as tags <noinclude>.
Different wikis may present all this differently.
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".
here, a user will have added a custom /doc page title between "{{Documentation|" and "|content=" and then added content after "|content=".
You can also look for a notice at the bottom of the page similar to this: "The above documentation is transcluded from Template:Templatename/doc".
Templates without documentation subpages
Se uma predefinição não tiver uma subpágina de documentação, você terá duas opções: Depois disso, você pode adicionar TemplateData à subpágina de documentação. Esta é a opção preferida.
Criando a subpágina doc e movendo o conteúdo da documentação
Para fazer isso, clique em "Editar"/"Editar código-fonte" na página da predefinição e procure as tags <noinclude> e seu conteúdo, geralmente na parte inferior.
Deve ser parecido com isto:
<noinclude>
{{Documentation|content=
== Usage ==
Information about usage.
== More example headings ==
More example contents
[[Category:Example category]]
[[Category:Example category 2]]
}}
</noinclude>
Também pode já ter TemplateData. Isso será parecido com:
<noinclude>
{{Documentation|content=
...
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "Example parameter",
"description": "Example parameter description",
"type": "string"
}
}
}
</templatedata>
</noinclude>
Select everything after "|content=" and before "</noinclude>" and cut it into your clipboard or save it in a temporary document.
Delete "|content=", leaving only the following:
<noinclude>
{{Documentation}}
</noinclude>
Agora, salve a página.
Now, to create the new subpage, look at your browser's address bar and add /doc to the end of the URL. Press ↵ Enter, then choose the option to create a new page.
If this wiki has a {{Documentation subpage}} notice template, add it at the top of the new page. You may also wish to add other templates, such as a {{Purge button}} or {{Purge}} link (if supported by the wiki in question).
Insert the text you cut or saved in the previous text (beneath the notice template, if applicable).
Em seguida, inclua as categorias dentro das tags <includeonly>.
<includeonly>
[[Category:Example category]]
[[Category:Example category 2]]
</includeonly>
Alguns wikis tem uma predefinição {{Sandbox other}}.
Use this template here if it's likely that the template you're editing exists in a sandbox version (located at "Template:Templatename/sandbox") in order to prevent the categories from applying to the sandbox page:
<includeonly>{{sandbox other||
[[Category:Example category]]
[[Category:Example category 2]]
}}</includeonly>
Depois disso, clique em "Salvar página".
Agora você pode adicionar e editar o TemplateData na subpágina da documentação usando as instruções descritas em #Methods.
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 #Métodos para fazer isso.
Se uma predefinição possui uma sobre página de documentação, você deve verificar agora se já possui TemplateData e se está localizado na página principal ou na sobre página de documentação.
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:
- Observe: já existe um bloco de dados da predefinição na página relacionada "[[Template:Templatename/doc]]".
or
- Observe: já existe um bloco de dados da predefinição na página relacionada "[[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 ".svg){kind=icon}
Template documentation" (or similar), or, if you are already on the /doc page, by clicking Editar or Editar código-fonte at the top.
Siga as orientações em #Métodos 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 <templatedata>, dentro das tags <noinclude>.
Deve ser parecido com isto:
<noinclude>
{{Documentation}}
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "Example parameter",
"description": "Example parameter description",
"type": "string"
}
}
}
</templatedata>
</noinclude>
Cut only the <templatedata> 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 "Template data", then beneath it paste the template data.
You can now edit the template data based on the guidance at #Methods.
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 #Métodos 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 Editar or Editar código-fonte at the top.
Type a heading, like "Template data", then add it beneath this heading.
A seção #Métodos explica como adicionar TemplateData.
Métodos
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.
It is part of the TemplateData extension, available on any template's page (or documentation subpage) by clicking Editar or 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 "Editar dados da predefinição".
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 chooses the language of the interface text. It allows you to enter text content in multiple languages, displayed to users based on their settings in Preferences, not based on the wiki's language; different wikis have entirely different template databases.
If no language template data exists, the interface will only offer users the wiki's own language, but users can click Adicionar idioma to add more inputs. The language code is displayed in brackets next to the parameters to which it can be applied, such as descriptions and labels.
- The next item is the template description. This is the description of the template as a whole; it's shown to users in numerous places in the template editors while adding a template. This parameter and its effects are documented below.
- The third item controls the wikitext formatting of the template.
This parameter determines how the wikitext will be laid out when the user clicks Aplicar, the two main types being "inline" (on one line) and "block" (on new lines). This parameter and its effects are documented below.
- If the user chooses
Personalizado, they can enter wikitext underString de formato personalizadoaccording to Custom formats rules documented below, in order to create a custom layout for the template when the user clicksAplicar.
- The fourth item configures a template's parameters.
If parameters have already been defined in template data, this area displays them in a list. If the template's source code specifies parameters for which no template data exists, you may see a button labeled Adicionar 2 parâmetros sugeridos. The editor extracts these suggestions from the template's source code by looking for {{{parametername}}} or {{{parametername|}}}. Clicking Adicionar 2 parâmetros sugeridos will add these parameters using their names as defined in the source code. A green notice will also appear at the top, for example, "2 novo parâmetros foram importados: names of parameters".
- At the bottom of the window you see an
Adicionar parâmetrobutton. This allows you to add a parameter manually with a custom name.
Continue to the next step by 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 in the section #Within a parameter's name.
- The template data editor will not allow you to change a parameter to a blank "Nome".
- Clicking
Remover informações de parâmetrowill delete the parameter and all its information from the template data.
Aplicar by hitting Ctrl+Z.
- Exiting the template data editor after making changes prompts you to confirm that you want to discard your changes.
When finished, click Aplicar.
This will automatically insert the template data at the bottom of the page before the </noinclude> tag; or, if already present, it will be updated with the new information without changing its position.
The template data text will also be selected when you click Aplicar.
The template data editor creates a "paramOrder" parameter at the bottom of the template data (or updates it if it already exists).
paramOrder contains the current template data parameters in the order in which they were displayed by the template data editor.
You can change the paramOrder by dragging the parameters up and down in the template data editor using the three horizontal bars on the left.
paramOrder and its effects are documented below.
After this, click Salvar to save your revision of the page.
Manual method
You can also add or edit template data manually.
A estrutura do TemplateData é baseada no padrão JSON, mas você não precisa aprender JSON para aprender como colocar TemplateData.
Template data follows a few very simple rules and accepts only a few dozen possible predefined parameters and values, typically following a "parameter": "value" 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 template data on a template's main page (not recommended; see #Prior checks), you must make sure to place it inside the
<noinclude>...</noinclude>tags.
Click Editar or Editar código-fonte on the respective page, then move to the place in the page where you intend to add template data and write a heading: "Template data".
Many wikis have a {{Cabeçalho do TemplateData}} template that adds a short notice regarding template data. If your wiki does, add it after the heading.
To start adding template data, type an opening and closing <templatedata> tag and a pair of curly brackets on new lines, with an empty line between them:
<templatedata>
{
}
</templatedata>
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 #Template data parameters. Most are optional; some are highly recommended.
Parameters can be in any order, but what follows is the order that best conforms to template data documentation and makes the content easiest to use for editors:
<templatedata>
{
"description": "",
"format": "",
"params": {
"parameter1": {
"aliases": ["",""]
"label": "",
"description": "",
"type": ""
}
},
"paramOrder": [
""
]
}
</templatedata>
Make sure the parameters, for example, in the "params" object, remain inside that object; otherwise you will trigger an "Propriedade inesperada: "propertyname"." error when you try to save.
Exemplo
Aqui estão alguns exemplos de TemplateData para uma predefinição hipotética. Such a template would display a notice and place the page into a dated category based on the month and year entered. The notice might also contain a link to a talk page section. The template data would look something like this:
<templatedata>
{
"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": "{{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}",
"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"
]
}
</templatedata>
The corresponding template data documentation would display as follows:
Use this template to indicate that an article is in need of cleanup.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Month and year | date | The month and year that the template was added
| String | suggested |
| Reason | reason 1 | The reason the article is in need of cleanup | String | optional |
| Talk page section | talk talksection | The section of the talk page containing relevant discussion | String | optional |
Parâmetro da TemplateData
All available template data parameters (i.e those between tags <templatedata>...</templatedata> of the wiki source) are listed below with a description and example.
They are also listed in more technical detail at Extension:TemplateData#Format.
- This information is current as of November 2021 and may change if new parameters are added or the template editing interfaces get updates to support existing parameters or treat certain parameters differently.
- Wiki markup will not work in descriptions or labels. They are strictly plain text strings.
- New lines ("
\n") in descriptions, labels, examples or defaults will not show in any of the main editors (TemplateWizard, the visual editor or the 2017 wikitext editor), even though they show in the auto-generated template data documentation. They are replaced by a null string in input forms and by a space elsewhere.
| Parâmetro | Descrição | Exemplo |
|---|---|---|
| description |
O parâmetro Efeitos On the template documentation page, the description will show in plain text below the "Template data for [template name]" subheading. In all main editors (VisualEditor, the Editor de wikitexto 2017 and the WikiEditor with TemplateWizard), the description shows in two main instances:
In the visual editor and 2017 wikitext editor, the description gets truncated to about 50 characters under each search suggestion, followed by a "...", but the whole description shows in the main template editor window. Both are shown in grey text. In the main template editor window, descriptions longer than four lines (about 540 characters) are provided a separate scrollbar, and they are shown in black text. If not specified If the description parameter does not exist or is not specified, the text
|
"description": "Um modelo para vincular a uma categoria comum",
|
| format |
The This parameter is not required, but it is recommended. The default behavior when this parameter is not provided is preserving the existing formatting for existing parameters, or inline formatting for newly added parameters and templates. Effects Inline: ( When inserted, the template will lay its wikitext out on a single line with no white space between elements, like so:
Block: ( When inserted, the template will distribute its parameters each on a new line, with single spaces between each element, like so: {{Foo
| bar = baz
| longparameter = quux
}}
Custom formatting: Alternatively, if the parameter is set to a custom string of wikitext, as per the rules listed at #Custom formats, the template will lay its wikitext out as per the given wikitext. |
"format": "inline"
|
| params |
The It should contain the name of each parameter followed by a set of template data sub-parameters listed in #Within a parameter's name. If there are multiple parameters, place a comma between each parameter object, but do not add one after the last curly bracket (see example). |
"params": {
"parameter1": {
... // parameter info
}, // vírgula aqui
"parameter2": {
... // parameter info
}, // e aqui
"parameter3": {
... // parameter info
} // but not here
}
|
| paramOrder |
The How to use Add the parameter The parameters need not be on new lines (they may be written as We recommend you place You must include every parameter mentioned in the template data; otherwise a "A propriedade "propertyname" é requerida mas não foi encontrada." error will show. If not specified Without With other parameters In the 2010 wikitext editor with TemplateWizard:
In the visual editor and the 2017 wikitext editor, |
"paramOrder": [
"date",
"reason",
"talk"
]
|
Within params
| Parameter | Description | Example |
|---|---|---|
| Nome do parâmetro |
The only first-level item of the For example, in a template's source code, You may also see parameters named
Note: a user can still force the use of How to use Each of these |
"1": { // name of the parameter
... // information about the parameter goes here
}
|
Within the parameter's name
| Parameter | Description | Example |
|---|---|---|
| aliases |
The optional
or
This means that if the user inserts either of these parameters with a value, they will perform the same function. Literally, it translates to, "Value of parameter1. If parameter1 doesn't exist or have a value: value of parameter2." In the second case, it also means, "If parameter2 doesn't exist or have a value: no value." To insert the |
"aliases": ["1", "talk", "talksection"],
|
| inherits |
To use this parameter, type |
"params": {
"tópico1": {
"label": "Tópico",
"description": "A topic mentioned on this disambiguation page",
"type": "string"
},
"tópico2": {
"inherits": "tópico1"
},
"tópico3": {
"inherits": "tópico1",
"label" : "A different label"
}
}
|
| label |
The |
"label": "Month and year",
|
| description |
Here, |
"description": "The month and year that the template was inserted",
|
| type |
See the #Type parameter section. |
|
| default |
Some template parameters have a default value which is used unless overridden by the user.
The Effects In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), the With other parameters In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), if |
"default": "Category:CommonsRoot",
|
| autovalue |
A parameter can be assigned an This value can be overwritten by the user in the template editor. With other parameters In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), |
"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
|
| example |
The Effects In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), this property is displayed below the parameter description (and below the With other parameters In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), |
"example": "January 2013",
|
| suggested values |
The parameter property
Other types (file, page, template, user, date, boolean, URL) are not currently supported because they have special functionalities in the visual editor already, such as autocomplete, which would interfere with the drop-down menu for suggested values in the visual editor. Editing template data as JSON in wikitext To add suggested values to any parameter type, add the new property "suggestedvalues" to the parameter in JSON. The “suggestedvalues” attribute must be a list of strings. Editing template data with the template data editor
Effects Once the values have been added to template data, the visual editor will display them in a combo box (a dropdown into which users can also enter a custom value) for the parameter types listed above. The user selects the desired value by clicking on it. If the list of values is long -- for example, a list of a country’s states -- the user can begin typing in the field, whereupon the list will be filtered to show only values containing the typed text. To change an entered value, the user must simply clear the field, and the full dropdown list will appear again. If the user needs a value not included in the list (for example, "message in a bottle") they can type it in manually. |
"suggestedvalues": [
"Journal",
"Book",
"Newspaper",
"Magazine"
]
|
| Status option | Description | Example |
|---|---|---|
| required |
The It determines whether filling in the given parameter is mandatory for the template. Effects This status has several effects in the visual editor and the Editor de wikitexto 2017:
In the WikiEditor with Extensão:TemplateWizard, as in the other editors, it displays the parameter automatically when a user inserts the template, but the parameter cannot be removed using this or any editor.
It also does not display With other parameters In the visual editor and the 2017 wikitext editor, the |
"required": true
|
| suggested |
The Use Effects In the visual editor and the Editor de wikitexto 2017, it causes the parameter to automatically show up when a user inserts a template. If the parameter has an autovalue set, this will also automatically be in the parameter's input box. It has no other effect and doesn't show any additional text or warnings. In the WikiEditor with TemplateWizard, it does not place the parameter in the template automatically but instead causes it to be listed on the side under With other parameters The |
"suggested": true
|
| deprecated |
Finally, there is This is a status for parameters that 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. Effects The effect of this parameter in the visual editor and the 2017 wikitext editor is that a grey exclamation mark shows next to the parameter's label when it is inserted, and in the parameter's information tooltip, the grey, italic text "O campo está obsoleto. deprecation reason" is shown below the parameter description. It does not affect the functionality or usability of the parameter or show any additional warnings. Despite the fact that it can take a string, as of January 2020 none of the main editors (the visual editor, the 2017 wikitext editor or the 2010 wikitext editor) display the contents of the string anywhere to users.
Inputting a string has the same effect as In the 2010 wikitext editor with TemplateWizard, setting this value as With other parameters If you set both this and If you set both this and In the 2010 wikitext editor with TemplateWizard, |
"deprecated": "Please use 'publicationDate' instead."
|
Note: if neither "required", "suggested" nor "deprecated" are set as true for a parameter, its status will show as "optional" in the template data documentation.
Once you're done, hit Salvar.
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 template data, it cannot be checked for errors before saving.
Note that each item of information is enclosed in quotation marks (except for true and false) and separated from the next item by a comma (unless it's the last one).
Type parameter
The "type" 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 template data 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 "type" parameter, followed by a colon and a space, then adding any of the values listed in the table below in quotation marks.
Example:
"type": "string",
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.
| Value | Description | |
|---|---|---|
| unknown | The "unknown" value is the default type value if no type is set. It can also be set manually by typing "type": "unknown".
Effects In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| string |
The Effects In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| line |
The Effects
| |
| content |
The Effects
| |
| unbalanced-wikitext |
The Effects
| |
| wiki-page-name |
The Effects In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| wiki-file-name |
The Effects
| |
| wiki-template-name |
The Effects In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| wiki-user-name |
The Effects In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| number |
The Effects
With other parameters
| |
| boolean | The "boolean" value is intended for a value that is either true, false or unknown. This is intended by the manual to be represented by a "1", "0" or blank value.
Effects With the | |
| date | The "date" value is intended for a date in the YYYY-MM-DD (ISO 8601) format; for example, 2014-05-22. The template data manual also designates it as being intended for ISO 8601 date–time combinations, such as "2014-05-22T16:01:12Z", but in practice no major editing interface as of February 2020 uses it in this fashion, and almost all major Wikimedia template parameters take dates and times separately.
Effects
With other parameters
| |
| url |
The Effects
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").
With other parameters
| |
Formatos personalizados
When editing the "format" 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\nfor new lines).|- pipe (separates parameters)=- equals sign (precedes the value of a parameter)\nor pressing the enter key - new line (this will display as↵in the entry field)\nto 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.
| Objective | Format string | Output |
|---|---|---|
| Inline formatting | {{_|_=_}} inline
|
{{Foo|bar=baz|longparameter=quux}}{{Bar}}
|
| Block formatting | {{_\n| _ = _\n}} block
|
{{Foo
| bar = baz
| longparameter = quux
}}{{Bar}}
|
| No space before the parameter name, each template on its own line | \n{{_\n|_ = _\n}}\n
|
{{Foo
|bar = baz
|longparameter = quux
}}
{{Bar}}
|
| Indent each parameter | {{_\n |_ = _\n}}
|
{{Foo
|bar = baz
|longparameter = quux
}}{{Bar}}
|
| Align all parameter names to a given length | {{_\n|_______________ = _\n}}\n |
{{Foo
|bar = baz
|longparameter = quux
|veryverylongparameter = bat
}}
{{Bar}}
|
| Pipe characters at the end of the previous line | {{_|\n _______________ = _}}
|
{{Foo|
bar = baz|
longparameter = quux}}{{Bar}}
|
| Inline style with more spaces, must be at start of line | \n{{_ | _ = _}}
|
{{Foo | bar = baz | longparameter = quux}}
{{Bar }}
|
| Template at the start of a line, indent-aligned parameters, pipe beforehand | \n{{_ |\n _______________ = _}}
|
{{Foo |
bar = baz |
longparameter = quux}}
{{Bar}}
|
Blank boilerplate
You can copy the blank boilerplate below to add new template data to a template. Only the most common tags are included.
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "",
"description": "",
"type": ""
},
"2": {
"label": "",
"description": "",
"type": ""
}
}
}
</templatedata>
Erros
Erro de sintaxe em JSON. / Formato JSON ruim
These errors occur when saving template data, usually manually edited, with invalid JSON code (duplicate keys/parameters, trailing or missing commas, etc.) in the visual editor or the 2017 wikitext editor.
Erro de sintaxe em JSON. appears in the visual editor and the 2017 wikitext editor; "Bad JSON format" appears when editing in the template data GUI editor.
These errors can be difficult to detect and come in too many forms to list. The best way to avoid them is to edit template data exclusively with the template data editor; the best way to detect them once they've occurred is to use an external JSON validator, such as JSONLint, which will highlight errors and aid in fixing them.
The 2010 wikitext editor does not check for invalid JSON thanks to an old, unfixed bug (T128029).
Pages that contain invalid JSON may throw alarming Erro interno messages.
To fix these errors, your best bet is to use a JSON validator (see above).
A propriedade "paramOrder[number]" é requerida mas não foi encontrada.
This error occurs if you state a parameter in "params" that is not stated in "paramOrder".
The number in the square brackets refers to the parameter in "paramOrder" that is missing.
It refers to its order in the sequence, but it is one less than its actual position, since "paramOrder" is an array; 0 is the first one, 1 is the second, etc.
"params": {
"date": { ...
},
"reason": { ...
},
"talk": { ... // <-- This parameter is not stated in "paramOrder", but it should be.
}
},
"paramOrder": [
"date",
"reason"
]
// Error: Required property "paramOrder[2]" not found.
To fix this, make sure all parameters stated in "params" are listed in "paramOrder".
Alternatively, you can remove the "paramOrder" object to remove this error.
Valor inválido para a propriedade "paramOrder[number]".
This error occurs if you state a parameter in "paramOrder" that is not stated in "params".
The number in the square brackets refers to the parameter in "paramOrder" that shouldn't be there.
It refers to its order in the sequence, but it is one less than its actual position, since "paramOrder" is an array; 0 is the first one, 1 is the second, etc.
"params": {
"date": { ...
},
"talk": { ...
}
},
"paramOrder": [
"date",
"reason", // <-- This parameter is not stated in "params", but it should be.
"talk"
]
// Error: Invalid value for property "paramOrder[1]".
To fix this, make sure all parameters stated in "paramOrder" are listed in "params".
Alternatively, you can remove the "paramOrder" object to remove this error.
A propriedade "params.parametername.required" deveria ser do tipo "boolean".
"suggested": "true" // <-- These quotation marks shouldn't be here.
These are boolean values, not strings, therefore they require no quotation marks.
To fix this, remove any quotation marks around the values true or false for these parameters.
Property "format" is expected to be ...
If the "format" parameter exists but its value is not "inline", "block" or a valid format string, you will see the error message A propriedade "format" deverá ser "inline", "block" ou uma string de formato válida..
"format": "notinline"
// Error : Property "format" is expected to be "inline", "block", or a valid format string.
To fix this, make sure the value after "format": equals "inline" or "block" 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 "format" parameter to remove this error.
Propriedade inesperada: "parametername".
This error occurs if you state a parameter that is unknown in template data. This is probably due to spelling mistakes or the use of uppercase letters instead of lowercase.
<templatedata>
{
"description": "",
"format": "inline",
"params": {
"1": {
"label": "",
"descriptino": "", // <-- spelling mistake
"type": ""
}
}
}
</templatedata>
It also occurs if you state a parameter in any template data 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 template data object under another object that it doesn't belong to.
For example, you might have written the parameter "label" under the root template data object instead of inside "params":
<templatedata>
{
"description": "",
"format": "inline",
"label": "", // <-- incorrectly placed parameter
"params": {
"1": { // ↓ it should be in here
"description": "",
"type": ""
}
}
}
</templatedata>
Alternatively, if the unexpected parameter is under a template parameter inside "params", 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 template data object. You can check which parameters exist for an object in the section #Template data parameters.
A propriedade "params" é requerida mas não foi encontrada.
This error occurs if there is no "params" object in the template data.
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 "params" 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
- Ajuda:Extensão:TemplateWizard
- A toolbar dialog window for entering template wikitext via a form built from template data.
- TemplateData Wizard
- A tool that generates template data 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 template data on this wiki
- With dewiki template template data: 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