Help:TemplateData/ja



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

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



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

最初にすべきことは、テンプレートの説明文下位ページ (/doc) 内の任意の場所に  タグを一組入力することです. 以下のように:

この記述は、ソフトウェアに対して、この一組のタグに挟まれた内容がすべて TemplateData であることを伝え、テンプレートを使用する際に参照するように指示するためのものです.



例
The descriptions inside TemplateDataの中の記述は、標準的なレイアウトに依っています. たとえば、「Commons」というテンプレートがあって、その主題に関するコモンズのカテゴリにリンクすると仮定しましょう. このテンプレートに必須の引数がひとつありますーコモンズにおけるカテゴリの名前です. TemplateDataはだいたいこのようになります：

この TemplateData は、テンプレート内に、以下のように表示されます: {       "description": "記事に関連するコモンズカテゴリにリンクするテンプレート", "params": { "1": {                       "label": "コモンズのカテゴリ", "description": "リンクしたいコモンズのカテゴリ", "type": "string", "required": true }       } }



説明と引数
ぜんぶできたら"save"（保存）をクリックしましょう. エラーがあったら、保存できません（エラーを保存してしまうのは破壊的ですが、つまりは、あなたは何も破壊できない、というわけです）. エラーに遭遇した場合、 フィードバックページ で何をしようとしていたかを説明してください. そうしたら私たちも喜んでお助けするでしょう、.

情報はどれも「"」で囲まれていることにご注意ください（ と  を除く）. また次の情報群とはカンマ（「,」）で区切られていることにもご注意ください（ただし最後の情報にはカンマなし）.



パラメーターの別名
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:



複数のパラメーター
複数の引数がある場合、それぞれのセクションを繰り返して（「1」タグから始めて）適宜情報を加筆編集して下さい. 注意すべきは、あるテンプレートが複数の引数を持つ場合、カンマ（,）で区切ることです. こんな風に：



類似のパラメーター
テンプレートに複数の引数があると、引数のうちのいくつかは同じ種類の場合があります. この場合、一つ目の引数にはきっちりプロパティを付与し、残りは一つ目からプロパティを「inherit（継承？）」させることができます.



空の雛形
テンプレートに新しい TemplateData を追加する際に、以下の空の雛形をコピーして使用できます. よく使用されるタグのみを記述しています.



制限と問題点

 * 機能の不足 — TemplateDataは、ごくわずかの機能しか実装していないツールの典型です. それは、利用者自身が望む機能の追加を助けてくれるだろうと期待されているからです. もしまだない機能で実装を望むものがあるなら、どうぞ教えてください.
 * テンプレートを表示する際の遅延 — 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).
 * w:en:User:NicoV/TemplateDataEditor — The translation of the previous script in English.