Extension:TemplateData/zh

TemplateData扩展引入了标记和API，它们共同允许编辑者指定应如何调用模板. 此信息作为最终用户的格式良好的表提供，并作为JSON API提供，它使其他系统（例如VisualEditor）能够构建用于处理模板及其参数的接口. 有关深入的帮助，请参阅.

编辑数据
TemplateData扩展通过在模板页面的wikitext中定义标记来工作（可选地，它也可以从不同的页面中转换）. This is designed to be compatible with the common layout many wikis have of transcluding template documentation from a separate page (but is not required). This content of the tag must be valid JSON using the format described below; note that all descriptions must be in plain text (no wikitext is accepted inside the template data).

When a block is included on a page, the TemplateData extension performs the following checks when the page is being saved:

内容必须是有效的JSON； JSON结构中的每一项必须是下文指定的预设类型（例如对象、数组或原始类型）；以及 对于那些具有指定的可能的值的列表（例如 ）的项，JSON对象中的值必须与这些值中的某一种相匹配.

如果这些检查中的任何一项失败，服务器将不允许用户保存，并且将在编辑页面的上方显示错误消息.

For autovalue items, bug 2700 prevents  from working in any template that is added inside a, including  and  tags. The TemplateData block will save correctly, but the resulting wikitext will not be parsed correctly when the template is used.

Note that  you cannot use  in lieu of.

格式
The below is a visualised version of the JSON data as defined on the template page enclosed by   tags. The formal specification is available in the TemplateData repository. 有关最新版本，请参考Specification.md.

模板数据对象
模板数据对象是一个“JSON根元素”，其被附于在模板页上的 元素中.

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.

字符串类型
If it is a string, it must contain a non-localized string in the content language of the local wiki.

Object type
If it is an object, the object must have this mapping:

示例
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 and array using the order in which the parameters occur in the   key within the TemplateData Object on the template page.
 * 添加 键
 * Change all TemplateText occurrences that are just strings to objects with a single key for the current wiki's Wikipedia language code
 * 删除所有 键.
 * 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:
 * HTML格式：https://www.mediawiki.org/w/api.php?action=templatedata&titles=Extension:TemplateData&format=jsonfm
 * 由API提供：https://www.mediawiki.org/w/api.php?action=templatedata&titles=Extension:TemplateData

参见

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