Extension:TemplateData

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Extension:TemplateData and the translation is 58% complete.
Other languages:
English • ‎dansk • ‎español • ‎français • ‎português • ‎русский • ‎українська • ‎अवधी • ‎中文 • ‎日本語
MediaWiki扩展手册
OOjs UI icon advanced.svg
TemplateData
发布状态： 稳定版
Screenshot of TemplateData extension.png
实现 标签 , API
描述 允許存儲，檢索和可视化有關模板的信息
作者 Timo Tijhof, Moriel Schottlender, James Forrester, Trevor Pascal, Bartosz Dziewoński, Marielle Volz, ...
最新版本 0.1.2 (持续更新)
MediaWiki 1.25+. TemplateData master仅支持core的master; 否则，使用匹配分支（例如，TemplateData REL1_26与核心REL1_26，或匹配WMF发布分支）。
PHP 5.4+
数据庫更新 否
许可协议 GNU通用公眾授權條款2.0
下载
下载扩展
Git [?]:
参数
$wgTemplateDataUseGUI
标签
<templatedata>
使用的钩子
翻译TemplateData扩展如果在translatewiki.net可用
检查使用和版本矩阵。
问题 开放的工作 · 报告错误

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

安装

  • 下载文件，并将其放置在您extensions/文件夹中的TemplateData目录内。
  • 将下列代码放置在您的LocalSettings.php的底部： 
    wfLoadExtension( 'TemplateData' );
  • Yes 完成 – 在您的wiki上导航至Special:Version，以验证扩展已成功安装。

致使用MediaWiki 1.24或更早版本的用户：

上面的说明介绍的是安装此扩展的新方法，它使用wfLoadExtension()。 如果您需要在早期版本（MediaWiki 1.24和更早版本）中安装此扩展，而不是wfLoadExtension( 'TemplateData' );，您需要使用： 

require_once "$IP/extensions/TemplateData/TemplateData.php";

编辑数据

TemplateData扩展通过在模板页面的wikitext中定义<templatedata>标记来工作（可选地，它也可以从不同的页面中转换）。 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 <templatedata> 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 <templatedata> block is included on a page, the TemplateData extension performs the following checks when the page is being saved:

  1. The contents must be valid JSON;
  2. Each item within the JSON structure must be of the expected type as specified below (e.g. object, array, or a primitive); and
  3. For those items which have a specified list of possible values (e.g. params.yourParameterName.type), the value in the JSON object must match one of those values.

If any of these checks fails, the server will not be permitted saving and an error message will be displayed above the edit page.

For autovalue items, bug 2700 prevents subst: from working in any template that is added inside a <tag>, including <ref> and <gallery> 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 {{#tag:templatedata}} in lieu of <templatedata>.

Format

The below is a visualised version of the JSON data as defined on the template page enclosed by <templatedata></templatedata> tags. The formal specification is available in the TemplateData repository. Refer to Specification.md for the latest version.

TemplateData object

The TemplateData object is a JSON root element enclosed in a <templatedata> element on the template page.

Key Type Description
description InterfaceText or null A brief description of the template. It must be in plain text. Once filled, it can be displayed as caption when editing a single template and perhaps in search results when users pick one of many. The default is null.
params Object containing Param objects An object that maps each parameter name of the template to a corresponding Param object describing the properties of that parameter.
paramOrder Array containing parameter name strings The logical order in which parameters should be displayed. The array contains each parameter key exactly once. Each string must be a valid key in the params object. If this key does not exist in the <templatedata></templatedata> structure on the template page, it is added to the structure provided by the API using the order in which the parameters occur within the TemplateData object.
sets Array containing
Set objects 		An array containing set specifications. A set is a group of parameters that should be used together. The default is []. Note that the sets functionality is still in development.
format string, either inline or block How the template's wikitext representation SHOULD be laid out. The default is inline. See Help:TemplateData#Custom_formats for other custom formats.
maps A Maps object An object that maps a simplified name of a third party consumer of the template data (i.e. Citoid, Wikidata, etc.) to an object that in turn maps a name of a consumer parameter to one or more corresponding names of template parameters.

Param object

Key Type Default Description
label InterfaceText null A (very) brief name for the parameter. Try to keep under 20-ish characters.
description InterfaceText null A brief description of the parameter, for users to know which to pick from an option list.
required boolean false Whether the parameter is required for the template to work (true if this parameter must be specified).
suggested boolean false Whether the parameter is suggested for the template to be useful (true if this parameter should be specified).
deprecated boolean or string false Whether the parameter is deprecated; this can be a string of instructions for the user detailing what instead the user can do, or be simply true.
aliases Array containing strings [] List of aliases. An alias is an alternative name for the parameter that may be used instead of (not in addition to) the primary name. Aliases are not documented in a separate Parameter object. If they need more information, they should be in their own property marked "deprecated".
default InterfaceText null The default value used by the template if no value is assigned to the parameter, or a description thereof.
autovalue string null A dynamically-generated default value in wikitext, such as today's date or the editing user's name; this will often involve wikitext substitution, such as {{subst:CURRENTYEAR}}.
example InterfaceText null An example text for the parameter, to help users fill in the proper value.
type string "unknown" The type of the parameter, for (soft) type hinting. One of:
String Value Type of Parameter
"unknown" Assumed type if not set
"number" Any numerical value (without decimal points or thousand separators)
"string" Any textual value. May contain line breaks.
"line" Short text field – use for names, labels, and other short-form fields. This is supposed to be text that is not expected to contain line breaks.
"boolean" A boolean value ('1' for true, '0' for false, '' for unknown), see three-valued logic.
"date" A date in ISO 8601 format, e.g. "2014-05-09" or "2014-05-09T16:01:12Z"
"url" A URL, including protocol, e.g. "http://www.example.org", "https://example.org", or "//example.org".
"wiki-page-name" A valid MediaWiki page name for the current wiki. Doesn't have to exist, but if not, should be a valid page name which could be created.
"wiki-file-name" A valid MediaWiki file name for the current wiki. Doesn't have to exist, but if not, should be a valid file name which could be uploaded. Should not include the namespace (e.g. "Foo.svg" not "File:Foo.svg" or "Bild:Foo.svg").
"wiki-template-name" A valid MediaWiki Template name for the current wiki.
"wiki-user-name" A valid MediaWiki user name for the current wiki. Doesn't have to exist, but if not, should be a valid user name which could be created. Should not include the namespace (e.g. "Foo" not "User:Foo" or "Usario:Foo").
"content" Page content in wikitext, such as text style, links, images, etc.
"unbalanced-wikitext" Raw wikitext that should not be treated as standalone content because it is unbalanced – for example, templates concatenating incomplete wikitext as a bigger whole, such as {{echo|before=<u>|after=</u>}}
inherits string none
substituted		 The name key of another parameter (must be a valid key in the params object). The current Parameter Object will inherit properties from the specified Parameter Object, with local properties overriding the inherited ones.

Set object

Key

Type

Default

Description

— Array of Arrays [] The type of the parameter, for (soft) type hinting. One of:
Set Object

Key

Object or primitive type

Description

label InterfaceText A (very) brief name for the parameter set. Try to keep under 20-ish characters.
params Array of strings One or more names of parameters to include in the set (each must be a valid key in the params object). A parameter may be in multiple sets. Not every parameter must be in a set.

Maps object

Key

Type

Default

Description

name of consumer object {} An object that maps a name of a consumer to an object that in turn maps a name of a consumer parameter to one or more corresponding names of template parameters.

The names of the template parameters can be specified either as a string (one name), an array of strings (several names), or an array of arrays of strings (several sets of names); each of these strings must be a valid key in the params object elsewhere in the same template's TemplateData.

A specific template parameter may be in multiple maps, and it may be used in the values of multiple keys in a given map, but not every template parameter must be in a map.

A shortened example from English Wikipedia's Template:Cite_news#TemplateData illustrates the structure of a maps object. 

{
	"proveit": {
		"main": "title",
		"textarea": [
			"quote"
		]
	},
	"citoid": {
		"title": "title",
		"url": "url",
		"publisher": "publisher",
		"publicationTitle": "work",
		"date": "date",
		…
		"ISSN": [
			"issn"
		],
		"ISBN": [
			"isbn"
		],
		…
		"contributor": "others",
		"author": [
			[
				"first",
				"last"
			],
			[
				"first2",
				"last2"
			],
			…
			[
				"first9",
				"last9"
			]
		],
		"editor": [
			[
				"editor-first",
				"editor-last"
			]
		]
	}
}

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 null.

String type

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:

Key Type Description
Wikipedia language code string Localized string for use on the Wikipedia corresponding to the given language code.

Example of object mapping:

Key Value
"en" "Welcome to Wikipedia"
"de" "Willkommen bei Wikipedia"
"fe" "Bienvenue sur Wikipédia"
"nl" "Welkom op Wikipedia"
"it" "Benvenuti su Wikipedia"
"es" "Bienvenidos a Wikipedia"
"ru" "Добро пожаловать в Википедию"

Example

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

<templatedata>
{
    "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": "{{subst:#time:Y-m-d}}"
        },
        "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"
            ]
        }
    }
}
</templatedata>

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

Label unsigned comments in a conversation.

Template parameters

ParameterDescriptionTypeStatus
User's nameuser 1

User name of person who forgot to sign their comment.

Userrequired
Datedate 2

Timestamp of when the comment was posted, in YYYY-MM-DD format.

Auto value
{{subst:#time:Y-m-d}}
Unknownsuggested
Yearyear

no description

Numberoptional
Monthmonth

no description

Numberoptional
Dayday

no description

Numberoptional
Commentcomment

no description

Unknownoptional

API

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

api.php?action=templatedata&titles=Template:Cite%20web&format=jsonfm [在Api沙盒中尝试]

This returns the template data for Template:Cite web. The <templatedata>...</templatedata> 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 <templatedata>...</templatedata> block. In response to the API request, extension TemplateData makes the following changes to the JSON object:

  1. An overall Pages Object containing one or more Page Objects
  2. An object with a numeric key: a Page Object
  1. Add the title key with the name of the page from which the data was requested (e.g. "Template:Cite web").
  2. Add the paramOrder key and array using the order in which the parameters occur in the params key within the TemplateData Object on the template page.
  3. Add the sets key
  4. Change all TemplateText occurrences that are just strings to objects with a single key for the current wiki's Wikipedia language code
  5. Remove all inherits 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.
  2. Add default values for all keys in each Parameter Object which have not been explicitly defined or inherited.

Visualised differences in a TemplateData JSON object delivered by the API

Wrapper objects added to JSON delivered by API
These are not defined in the JSON object enclosed by the <templatedata> tags on the template page.
JSON Root
Key Type Description
pages Page Object The page object (contains one key which is the page number). If multiple pages were requested at one time there will be multiple Page Objects.

Page Object
Key Type Description
(page number) TemplateData Object The TemplateData Object containing the information payload. The key is a static page number for the template page from which the JSON data was requested.


TemplateData Object (added by API)
The following key is added to the root of the JSON object which is enclosed in <templatedata> tags on the template page.
Key Type Default Description
title string The page name of the template (e.g. "Template:Cite web").
This key is not contained in the JSON structure on the template page. It is added to the structure by the MediaWiki software in route to delivery via the API.
paramOrder Array containing parameter name strings The logical order in which parameters should be displayed. The array contains each parameter key exactly once. Each string must be a valid key in the params object.
If this does not exist in the <templatedata></templatedata> structure on the template page, it is added to the structure as provided by the API using the order in which the parameters occur within the TemplateData object.
sets Array containing Set Objects An array containing set specifications. A set is a group of parameters that should be used together.
If this does not exist on the template page it is added as an empty array to the structure provided by the API.


Parameter Objects from API
Key Type Description
label InterfaceText translated to InterfaceText object, if not already in that format.
required boolean If not defined, default value of false added.
description InterfaceText or null If defined as a string, converted to a InterfaceText object. If not defined, key is added with a null value.
deprecated boolean or string If not defined, default value of false added.
aliases Array of strings If not defined, a default empty array is assigned (i.e. [] ).
default string If not defined, default of "" is assigned.
type string If not defined, default of "unknown" is assigned.
inherits removed This key is removed and all inherited keys are added. Keys defined for the current parameter take precedence and any keys not defined on either the current param, or the one from which it inherits are given the default value.


InterfaceText (Object or null):
An object containing strings keyed by language code.
Key Object or
primitive type		 Description
Object
(containing localized strings by Wikipedia language code)
If a TemplateData field on the template page contains a string, not an object with localized strings, MediaWiki translates it into an InterfaceText Object with a string assigned to the key name of the source Wikipedia Wikipedia language code. The default for all InterfaceText fields is null.
(Wiki language code) string Localized string for use on the Wikipedia corresponding to the Wikipedia language code.


Example of JSON object provided by API

The response to an API request for the TemplateData structure in the Example of TemplateData structure WikiText on template page section (above) can be seen:

配置

变量 默认 描述
$wgTemplateDataUseGUI true Experimental dialog interface to edit templatedata JSON

参见

Retrieved from "https://www.mediawiki.org/w/index.php?title=Extension:TemplateData/zh&oldid=3622284"