Extension:TemplateData/pt

A extensão TemplateData insere uma tag e uma API, que juntas, permite aos editores especificar como os modelos devem ser chamados. Esta informação está disponível como uma tabela bem formatada para os utilizadores finais, e como uma API JSON, que permite outros sistemas (por exemplo, o Editor Visual) para criar interfaces para trabalhar com modelos e os seus parâmetros. Consulte para obter ajuda detalhada.

Instalação


Edição de dados
A extensão TemplateData funciona com uma etiqueta definida no texto wiki de uma página de modelo (opcionalmente, este também pode ser transcrito de uma página diferente). Esta é projetada para ser compatível com o layout comum que muitas wikis têm de transcrever a documentação do modelo de uma página separada (mas não é obrigatório). O conteúdo da etiqueta deve ser um JSON válido utilziando o formato descrito em baixo; note que todas as descrições devem estar em texto não formatado (texto wiki não é permitido dentro dos dados do modelo).

Quando um bloco é incluído na página, a extensão DadosDeModelo executa as seguintes verificações quando a página está sendo salva:


 * 1) Os conteúdos devem ser um JSON válido;
 * 2) Cada item com da estrutura JSON devem ser do tipo esperado, conforme especificado abaixo (por exemplo, objeto, matriz ou primitivo); e
 * 3) Para aqueles itens que possuem uma lista específica de valores possíveis (por exemplo,  ), o valor no objeto JSON deve corresponder a um desses valores.

Se alguma dessas verificações falhar, o servidor não permitirá o salvamento e uma mensagem de erro será exibida acima da página de edição.

Para itens de autovalor, o bug 2700 impede  de trabalhar em qualquer modelo adicionado dentro de, incluindo as tags  e. O bloco DadosDeModelo salvará corretamente, mas o wikitexto de resultado não será analisado corretamente quando o modelo é usado.

Observe que você não pode usar  no lugar de.

Formato
Abaixo está a versão visualizada dos dados JSON como definidas na página de modelo entre as tags . A especificação formal está disponível no repositório TemplateData. Consulte Specification.md para a versão mais recente.



Objeto de TemplateData
O objeto de TemplateData é um "elemento raiz JSON" incluído num elemento na página do modelo.



Objeto de Param


Definir objeto


InterfaceText (string or object)
A free-form plain-text string (i.e. no wikitext or HTML) in the content-language of the wiki, or an object containing those strings keyed by language code.

The default value for all InterfaceText fields is.



Tipo de sttring
If it is a string, it must contain a non-localized string in the content language of the local wiki.



Tipo de objeto
If it is an object, the object must have this mapping:

Exemplo
An example TemplateData structure as specified within wikitext on a template page.

Below is how the above example would be displayed on the template page:

{   "description": "Label unsigned comments in a conversation.", "params": { "user": { "label": "User's name", "type": "wiki-user-name", "required": true, "description": "User name of person who forgot to sign their comment.", "aliases": ["1"] },       "date": { "label": "Date", "suggested": true, "description": { "en": "Timestamp of when the comment was posted, in YYYY-MM-DD format." },           "aliases": ["2"], "autovalue": "" },       "year": { "label": "Year", "type": "number" },       "month": { "label": "Month", "inherits": "year" },       "day": { "label": "Day", "inherits": "year" },       "comment": { "required": false }   },    "sets": [ {           "label": "Date", "params": ["year", "month", "day"] }   ],    "maps": { "ExampleConsumer": { "foo": "user", "bar": ["year", "month", "day"], "quux": [ "date", ["day", "month"], ["month", "year"], "year" ]       }    } }

API
See the generated help at Special:ApiHelp/templatedata. A sample invocation (formatted for human readability) is:

This returns the template data for Template:Cite web. The  block for this template is on its transcluded template documentation page, en:Template:Cite web/doc.

Additions and changes to JSON as received from the API
The JSON structure provided in response to an API HTTP get request is significantly different than that which is defined in the  block. In response to the API request, extension TemplateData makes the following changes to the JSON object:


 * Adds two wrapping objects:
 * An overall Pages Object containing one or more Page Objects
 * An object with a numeric key: a Page Object
 * Additions/changes to the actual TemplateData Object
 * Add the  key with the name of the page from which the data was requested (e.g. "Template:Cite web").
 * Add the  key
 * Change all TemplateText occurrences that are just strings to objects with a single key for the current wiki's Wikipedia language code
 * Remove all  keys.
 * Add all properties from parameter from which an inheritance is defined which are not superseded by explicitly defined keys in the inheritor's Parameter Object.
 * Add default values for all keys in each Parameter Object which have not been explicitly defined or inherited.

Example of JSON object provided by API
The response to an API request for the TemplateData structure in the Example section (above) can be seen:
 * In HTML format: https://www.mediawiki.org/w/api.php?action=templatedata&titles=Extension:TemplateData&format=jsonfm
 * As delivered by the API: https://www.mediawiki.org/w/api.php?action=templatedata&titles=Extension:TemplateData

Configuração


Consulte também

 * – user interface for selecting and inserting templates' wikitext, based on their TemplateData.
 * GitHub: jeblad/TemplateData – alternate version with some Lua functionality.
 * Translatable template