Extension:TemplateData/ja

TemplateData拡張機能は タグとAPIを導入し、これらは共に、テンプレートをどのように呼び出すべきなのかを編集者が指定できるようにします. この情報は、エンドユーザーにきちんと書式化された表として提供され、また他のシステム（例えばVisualEditor）を機能させる JSON API が、テンプレートやその引数と連携するインターフェースを構築できるようにします. 詳細なヘルプはをご参照ください.

インストール


データの編集
TemplateData 拡張機能は、テンプレートページのウィキテキストに定義された タグを持つことによって機能します（オプションとして他のページから参照読み込みさせることもできます）. これは多くのウィキにおいて一般的な、別のページからテンプレートの説明文書を参照読み込みするレイアウト（必須ではありません）と互換性があるように設計されています. タグのこのコンテンツは以下で説明する形式を使用する有効なJSON形式でなければなりません. すべての記述はプレーンテキストでなければなりません（テンプレートデータの中でウィキテキストは使えません）.

ブロックがページに含まれるときは、TemplateData 拡張機能がぺージの保存時に次の各点を確認します.


 * 1) コンテンツは有効な JSON かどうか;
 * 2) その JSON 構造内の項目は、以下に指定した種類のひとつかどうか (例：オブジェクト、配列、またはプリミティブ).
 * 3) その項目が取りうる値 の一覧があり (例  )、JSON オブジェクト内の値はそのどれかに該当すること.

これら項目がひとつでも不適合の場合、サーバはページの保存を承認せず、編集ページの上部にエラーメッセージを表示します.

自動値 (autovalue) 項目は、 タグに挟まれたテンプレート内の  は  でも  でも、bug 2700によって無効にされます. TemplateData ブロックは正しく保存されますが、結果として得られるウィキテキストはテンプレートを使用したときに正しく処理されません.

ただし の代わりに   を使うことはできませんのでご留意ください.

書式
下記にテンプレートページに定義されたJSONデータを可視化し、タブで挟んで表してあります. 正式の項目定義はリポジトリのTemplateDataをご参照ください. 最新版の情報はSpecification.mdをご参照ください.



TemplateData オブジェクト
TemplateDataオブジェクトはJSON ルート要素 で、テンプレートページの要素に括られています.



Param オブジェクト


Set オブジェクト


Maps オブジェクト


InterfaceText (文字列またはオブジェクト)
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.



オブジェクト型
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
 * 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

設定


関連項目

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