Ajuda: Dados do Modelo
 |
Nota: Quando modificais esta página, estais a aceitar que a vossa contribuição se publique no marco de CC0. Olhem Páginas de ajuda de domínio público para mais informação. | |
TemplateData é uma extensão utilizada que guarda a informação e os parâmetros associados com o modelo de texto wiki e torna-a disponível para uma interface de edição que pode obter e apresentá-la num editor de model -- tudo isto ajuda os utilizadores a adicionar e editar modelos nas páginas. It also provides a user interface for discovering templates.
Desde abril de 2019, a funcionalidade dos dados de modelo faz parte da experiência do utilizador predefinida para todos os utilizadores em todas as wikis da Wikimédia quando eles adicionam um modelo, incluindo os utilizadores não registados. Tanto a fonte predefinida como os editores visuais incorporam-no de alguma forma, bem como muitos scripts ferramentas e gadgets. Se quiser esta funcionalidade na sua própria wiki, instale Extensão:Dados do Modelo.
Adding template data to a template for this extension to use involves inserting a small, simple block of JSON (explained below) into the template's documentation page.
You can do this manually or with the template data editor, a graphical user interface you can access on a template's Editar/Editar código fonte pages on wikis with the TemplateData extension installed.
The JSON contains a list of the template's parameters and information about those parameters and about the template as a whole (see below for details).
Templates that contain template data will display this information in the user interface when a user adds the template. In some cases, it will change how the editor behaves when you use it to edit or insert a given template, making it much easier for users to perform the steps needed to add a given template.
História
[edit]Os dados do modelo foram originalmente desenvolvidos no início de 2013 com o 'Editor Visual' em mente, que estava nos estágios de testes do MediaWiki na altura. The visual editor is the main visual editing interface for Wikimedia wikis, and template data allows it to have a more useful interface when adding templates. It was officially supported by the visual editor immediately. As the visual editor was rolled out to the various major Wikimedia wikis as a default feature from 2013 through 2016, template data became a part of them as well.
In December 2016, the visual editor interface was made available for editing source code as a beta feature. This was termed the Editor de Texto Wiki 2017. This brought the features of template data to source editing for the first time.
In March 2018, Sam Wilson developed Assistente de Modelo, a GUI template editor extension for the default Wikimedia source editor, WikiEditor (otherwise known as the 2010 wikitext editor), designed to make the process of adding templates easier by using information from template data. In April 2019, TemplateWizard was made a default part of the 2010 wikitext editor on all Wikimedia wikis. This meant that template data was now a default part of both the visual editor and the source editor on Wikimedia wikis.
Adicionar ou editar os dados de modelo
[edit]To add or edit template data, first navigate to a template's page, located at "/Template:Templatename".
Verificar o estado atual
[edit]Antes de adicionar ou editar os dados do modelo, verifique se o modelo tema subpágina de documentação. Then check whether the template already contains template data and, if so, whether it's located on the template page or the documentation subpage.
Subpáginas da documentação
[edit]There are two main ways templates on most Wikimedia wikis store their usage notes and other data that shouldn't be included in the actual template itself, like categories the template should be contained in:
- The vast majority of templates keep usage notes and other data that doesn't belong on the template page itself on a documentation subpage: "/Template:Templatename/doc".
On pages like this, the {{Documentation}} template transcludes all the /doc page's content onto the template page, keeping the template's source code much cleaner.
- On templates with documentation subpages, the "
Template documentation" heading will be followed by links such as [view], [edit], [history] and [purge].
- On templates with documentation subpages, the "
- A few template pages have retained that information on the template's main page.
You can spot it on these pages by looking for an occurrence of {{Documentation|content= between <noinclude> tags.
Different wikis may present all this differently.
Rarely, main template pages may still contain documentation even when you've checked all of the foregoing;
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".
Modelos sem subpáginas de documentação
[edit]If a template doesn't have a documentation subpage, create it and move the template's documentation there (or a placeholder for it). Then you can add template data to the documentation subpage.
Criar a subpágina e mover a documentação
[edit]To create the documentation subpage, click Editar/Editar código fonte on the main template page; look for the <noinclude> tags and their contents (usually at the bottom).
Este deveria parecer-se com isto:
<noinclude>
{{Documentation|content=
== Utilização ==
Informação sobre a utilização.
== Mais cabeçalhos de exemplo ==
Mais conteúdos de exemplo
[[Category:Example category/pt]]
[[Category:Example category 2/pt]]
}}
</noinclude>
Também é possível que este já contenha os dados de modelo. Se sim, este irá parecer-se semelhante a isto:
<noinclude>
{{Documentation|content=
...
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "Parâmetro de exemplo",
"description": "Descrição do parâmetro de exemplo",
"type": "string"
}
}
}
</templatedata>
</noinclude>
Selecione tudo depois de "|content=" e antes de "</noinclude>" e corte isto para a sua área de transferência ou guarde num documento temporário. Elimine "|content=", deixando apenas o seguinte:
<noinclude>
{{Documentation}}
</noinclude>
Guarde a página do modelo.
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).
Wrap any categories in <includeonly> tags so that they apply only to the template's main page:
<includeonly>
[[Category:Example category]]
[[Category:Example category 2]]
</includeonly>
Muitas wikis têm um modelo {{Sandbox other}}.
Utilize este modelo aqui se é que o modelo que está a editar existe numa versão da página de testes (localizada em "Template:"Templatename"/sandbox") para evitar que as categorias se apliquem à página de testes:
<includeonly>{{sandbox other||
[[Category:Example category]]
[[Category:Example category 2]]
}}</includeonly>
Finalmente, publique a página.
You can now add and edit the template data on the documentation subpage using the instructions described in #Methods.
Adicionar e editar os dados do modelo na página principal do modelo
[edit]Se não consegue criar a página /doc, pode adicionar e editar os dados do modelo na página principal do modelo, seguindo as instruções em #Métodos.
Se um modelo tem uma subpágina de documentação, verifique tanto a página principal como a subpágina de documentação para ver se existem dados do modelo (a etiqueta <templatedata> seguida de uma matriz dentro de chavetas: {}).
Alternativamente, a extensão 'Dados do Modelo' pode realizar esta verificação para si.
Clique em Editar ou Editar código fonte em qualquer página.
Se o modelo já tem os dados do modelo em qualquer página, irá ver uma aviso em amarelo no topo da página, dizendo:
- Atenção: já existe um bloco de dados da predefinição na página relacionada "Template:Templatename/doc".
ou
- Atenção: já existe um bloco de dados da predefinição na página relacionada "Template:Templatename".
Se o modelo tem dados do modelo na sua subpágina da documentação
Se o modelo tem dados do modelo na sua subpágina da documentação, é a página que deverá editar.
Pode fazer isto clicando em "[editar]" localizado depois do cabeçalho "
Documentação do modelo (ou similar), ou, se já está na página /doc, clicando em Editar ou Editar código fonte no topo.
Siga as instruções em #Métodos para adicionar ou editar os dados do modelo.
Se o modelo tem dados do modelo na sua página principal
Se o modelo tem os dados do modelo na sua página principal, tem novamente duas opções:
- Pode mover a sua subpágina da documentação. Esta é a opção preferida.
- Ou, pode editá-lo na página principal do modelo.
Mover os dados do modelo para a subpágina da documentação
Para fazer isto, clique em Editar/Editar código fonte na página principal do modelo, e procure pelas etiquetas <templatedata>, incluídas dentro das etiquetas <noinclude>.
Isto deveria parecer-se como isto:
<noinclude>
{{Documentation}}
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "Parâmetro de exemplo",
"description": "Descrição do parâmetro de exemplo",
"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.
Editar os dados do modelo na página principal do modelo
If you do not wish to move the template data to the /doc page, you can edit it on the main template page. Veja #Métodos para saber como editar os dados do modelo.
Se o modelo ainda não tem os dados do modelo mas uma subpágina do documento
If the template does not yet have template data, you should add it to the documentation subpage.
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 secção #Métodos explica como adicionar os dados do modelo.
Métodos
[edit]
Método do editor de dados do modelo
[edit]Esta é uma forma simples para adicionar ou editar os dados do modelo, recomendada para os utilizadores menos experientes.
O editor dos dados de modelo é uma interface do utilizador gráfica para adicionar e editar os dados de modelo.
É parte da extensão 'TemplateData', disponível em qualquer página de modelo (ou subpágina da documentação) clicando em Editar ou Editar código fonte.
Depois de clicar em Editar ou Editar código fonte, irá ver um botão por cima da área de edição e título da página que diz Editar dados da predefinição.
Ao clicar neste botão irá levá-lo para o editor de dados do modelo. Se a página onde está já contém os dados do modelo, isto irá aparecer aqui automaticamente.
Funcionalidades na janela em cima:
- 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 língua 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 underTexto de formato personalizadoaccording to Custom formats rules documented below, in order to create a custom layout for the template when the user clicksAplicar.
- O quarto item configura os parâmetros do modelo. 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|}}}. ClickingAdicionar 2 parâmetros sugeridoswill add these parameters using their names as defined in the source code. A green notice will also appear at the top, for example, "Foram importados 2 parâmetros novos: 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. You can't retrieve or undo this in the template data unless you click "X" afterwards. You can undo any changes made after clickingAplicarby hitting Ctrl+Z.
- Exiting the template data editor after making changes prompts you to confirm that you want to discard your changes.
Quando terminado, clique em 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.
Depois de isto, clique em Gravar para guardar a sua revisão da página.
Método manual
[edit]Também pode adicionar ou editar manualmente os dados de modelo.
Os dados do modelo são escritos em JSON, mas não precisa aprender JSON para saber como criar os dados do modelo.
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 manualmente os dados do modelo
Considerações:
- If you're adding template data on a template's documentation subpage (recommended), you may add it anywhere on the page; check to see if your language's Wikipedia has a preferred location for it. For example, on the English Wikipedia, template data is typically near the bottom of the documentation page; on the German Wikipedia, it is typically at the top.
- 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 {{TemplateData header}} 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 "propertyname" inesperada." error when you try to save.
Exemplo
Here is some example template data for a hypothetical cleanup template. 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": "Mês e ano",
"description": "O mês e o ano em que o modelo foi adicionado",
"type": "string",
"autovalue": "{{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}",
"example": "Janeiro de 2013",
"suggested": true
},
"reason": {
"aliases": ["1"],
"label": "Motivo",
"description": "O motivo pelo que o artigo precisa de ser limpo",
"type": "string"
},
"talk": {
"aliases": ["secção de discussão"],
"label": "Secção da página de discussão",
"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 | |
|---|---|---|---|---|
| Mês e ano | data | O mês e o ano em que o modelo foi adicionado
| String | suggested |
| Motivo | motivo 1 | O motivo pelo que o artigo precisa de ser limpo | String | optional |
| Secção da página de discussão | discussão secção de discussão | A secção da página de discussão contém uma discussão relevante | String | optional |
Parâmetros dos dados do modelo
[edit]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.
- A marcação da wiki não irá funcionar nas descrições ou etiquetas. Elas são estritamente cadeias de carateres de texto sem formato.
- 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 $descrição descreve o que o modelo faz. É opcional mas muito recomendável. 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 Texto Wiki 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. Ambas, são mostradas em texto a cinzento. 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. Se não especificado If the description parameter does not exist or is not specified, the text
|
"description": "A template for linking to a commons category",
|
| format |
The Este parâmetro não é obrigatório, mas é recomendado. 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. Efeitos Em linha: ( When inserted, the template will lay its wikitext out on a single line with no white space between elements, like so:
Bloco: ( 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
}}
Formato personalizado: 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": {
... // informação do parâmetro
}, // vírgula aqui
"parameter2": {
... // informação do parâmetro
}, // e aqui
"parameter3": {
... // informação do parâmetro
} // mas não aqui
}
|
| paramOrder |
The Como utilizar 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 obrigatória "propertyname" não foi encontrada." error will show. Se não especificado Without Com outros parâmetros In the 2010 wikitext editor with TemplateWizard:
In the visual editor and the 2017 wikitext editor, |
"paramOrder": [
"date",
"reason",
"talk"
]
|
Dentro de params
[edit]| Parâmetro | Descrição | Exemplo |
|---|---|---|
| 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 Como utilizar Each of these |
"1": { // nome do parâmetro
... // a informação sobre o parâmetro fica aqui
}
|
Dentro do nome do parâmetro
[edit]| Parâmetro | Descrição | Exemplo |
|---|---|---|
| aliases |
The optional
ou
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ópico 1": {
"label": "Tópico",
"description": "Um tópico mencionado nesta página de desambiguação",
"type": "string"
},
"tópico 2": {
"inherits": "tópico 1"
},
"tópico 3": {
"inherits": "tópico 1",
"label" : "A different label"
}
}
|
| label |
The |
"label": "Mês e ano",
|
| description |
Here, |
"description": "O mês e o ano em que o modelo foi adicionado",
|
| type |
Consulte a secção #Tipo de parâmetro. |
|
| default |
Some template parameters have a default value which is used unless overridden by the user.
The Efeitos In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), the Com outros parâmetros In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), if |
"default": "Category:CommonsRoot",
|
| autovalue |
Pode ser atribuído um This value can be overwritten by the user in the template editor. Com outros parâmetros 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 Efeitos 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 Com outros parâmetros 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. Editar os dados do modelo como JSON no 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. Editar os dados do modelo com o editor de dados do modelo
Efeitos 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": [
"Diário",
"Livro",
"Jornal",
"Revista"
]
|
| Opção de estado | Descrição | Exemplo |
|---|---|---|
| required |
The It determines whether filling in the given parameter is mandatory for the template. Efeitos This status has several effects in the visual editor and the Editor de Texto Wiki 2017:
In the WikiEditor with Extensão:Assistente de Modelo, 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 Com outros parâmetros In the visual editor and the 2017 wikitext editor, the |
"required": true
|
| suggested |
The Use Efeitos In the visual editor and the Editor de Texto Wiki 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 Com outros parâmetros 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. Efeitos 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 Com outros parâmetros If you set both this and If you set both this and In the 2010 wikitext editor with TemplateWizard, |
"deprecated": "Em vez disso, por favor, utilize 'publicationDate'."
|
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 Gravar. 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).
Tipo de parâmetro
[edit]O parâmetro "type", está destinado para assinalar a um editor de modelo a natureza do valor de um parâmetro.
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.
Como utilizar
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.
Exemplo:
"type": "string",
Efeitos
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.
| Valor | Descrição | |
|---|---|---|
| unknown |
The Efeitos In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| string |
The Efeitos In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| line |
The Efeitos
| |
| content |
The Efeitos
| |
| unbalanced-wikitext |
The Efeitos
| |
| wiki-page-name |
The Efeitos In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| wiki-file-name |
The Efeitos
| |
| wiki-template-name |
The Efeitos In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| wiki-user-name |
The Efeitos In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| number |
The Efeitos
Com outros parâmetros
| |
| boolean |
The Efeitos With the | |
| date |
The Efeitos
Com outros parâmetros
| |
| url |
The Efeitos
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").
Com outros parâmetros
| |
Formatos personalizados
[edit]When editing the "format" value, you create custom formats by inputting a set of wikitext symbols using some predefined rules.
{{- início do modelo_- conteúdo (exemplo, string, integro ou parâmetro). 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)}}- fim do modelo
The wikitext should at least meet the minimum of {{_|_=_}}, otherwise there will be an invalid format string error.
| Objetivo | Texto de formato | Resultado |
|---|---|---|
| Formatação em linha | {{_|_=_}} inline
|
{{Foo|bar=baz|longparameter=quux}}{{Bar}}
|
| Formatação de bloco | {{_\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
[edit]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
[edit]
Erro de sintaxe em JSON / Formato JSON incorreto
[edit]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 obrigatória "paramOrder[número]" não foi encontrada.
[edit]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[número]".
[edit]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.nome do parâmetro.required" deveria ser do tipo "boolean".
[edit]"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 ...
[edit]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" deve ter o valor "inline", "block" ou um texto de formato válido..
"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 "nome do parâmetro" inesperada.
[edit]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": "", // <-- erro de ortografia
"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": "", // <-- parâmetro colocado incorretamente
"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 obrigatória "params" não foi encontrada.
[edit]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.
Consulte a secção em cima em como adicionar o parâmetro "params".
Limitações e opinião/comentário
[edit]- 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.
Outras ferramentas
[edit]- Ajuda:Extensão:Assistente de Modelo
- Uma janela da barra de ferramentas para inserir o texto wiki através de um formulário criado a partir dos dados do modelo.
- TemplateData Wizard
- Uma ferramenta que gera dados do modelo através de uma interface interativa.
- Skeleton TemplateData generator
- Uma ferramenta que lê o código wiki fonte de um modelo, tenta encontrar todos os parâmetros utilizados e mostra um documento esquematizado com os parâmetros listados.
- JSONLint
- Uma ferramenta que lhe permite validar JSON manualmente escrito para encontrar erros na sintaxe.
- Lista de todos os modelos com dados de modelo nesta wiki
- Com os 'Dados do Modelo' do modelo dewiki: os dados do modelo são mostrados numa caixa, e o modelo é adicionado a uma categoria de modelos com os dados do modelo
- https://query.wikidata.org/ e "Ajuda de Consulta"