Help:TemplateData/ja



テンプレートデータとは
TemplateData (テンプレートデータ) とは、テンプレートとそのパラメーターに関する情報を蓄積する一つの方法です. ビジュアルエディターがテンプレートエディター内でテンプレートデータを取得して表示することで、テンプレートを編集しやすくします.

TemplateData があれば、利用者はテンプレートページに構造化されたデータのごく一部分を書くことができますし、あるいはテンプレートページに読み込ませることができます (たとえば、docページなど). テンプレートがこういった構造化されたデータを持てば、ビジュアルエディターの中でちゃんと表示できるようになります. 複雑に聞こえるかもしれませんが、実際のところはとても簡単です.



TemplateDataの仕組み
TemplateDataの仕組みはJSON の基準に基づいており、きわめてシンプルです. TemplateDataの中の記述はすべてプレーンテキストに限らなければなりません（ウィキ記法や、リンクなどはダメです）

最初にすべきことは、テンプレートのdocサブページのどこかに タグを一組タイプすることです. このように：

これにより、この一組のタグに挟まれた内容はすべてTemplateDataであり、テンプレートが使われるときには参照表示しなければならない、とソフトウェアに伝えるわけです.



例
The descriptions inside TemplateData follow a standard layout; let's say that you have a template called "Commons" for linking to a Commons category about a topic. It takes one mandatory parameter: the name of the category on Commons. The TemplateData would look something like this:

This would display, in the template, like so: {       "description": "A template for linking to a commons category about an article", "params": { "1": {                       "label": "コモンズのカテゴリ", "description": "The commons category you want to link to.", "type": "string", "required": true }       } }



説明とパラメーター
Once you're done, hit "save". 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 each bit of information is enclosed in quotation marks (except for  and  ), and separated from the next bit by a comma (unless it's the last one).



Parameter aliases
Some templates allow a same parameter to have different names.

For example,  could also be written as   or.

To add this information to TemplateData, you simply need to add the aliases to the parameter's information:



複数のパラメーター
If you have multiple parameters, just repeat each section (starting from the "1" tag) and fill it out as you see fit. Note that if a template has multiple parameters, you need to separate them with a comma in the templatedata, like so:



Similar parameters
When a template has multiple parameters, sometimes some of them can be of the same kind. In this case, you only need to provide full properties for the first one, and the others can "inherit" their properties from it.



Blank boilerplate
You can copy the blank boilerplate below to add new TemplateData to a template. Only the most common tags are included.



Limitations and questions

 * Missing features — TemplateData is very much an example of tool that was made available with few features, in hope that users would help to guide development of features that they desired. If you'd like to request new features for TemplateData, please let us know.
 * Delays in showing in templates — After adding TemplateData to a template, the metadata should be visible immediately when the template is opened in VisualEditor. However, it is possible that it takes hours before the metadata show. You can force an update by making a null edit to the template page itself (not the documentation subpage). To perform a null edit, open the template page for editing, and save the page without making any change.
 * 現在の問題点 — A list of current bugs and feature requests is available in bugzilla.



ツール

 * w:fr:Utilisateur:Ltrlg/scripts/TemplateDataEditor.js — A user script that makes the process of adding TemplateData easier (currently only available in French).