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

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



引数の別名
一部のテンプレートは、同じ引数を別の名前ででも扱えます.

例えば、 は、  とも、  とも書けます.

この情報をTemplateDataに加えるには、単純に、別名を引数の情報に加えるだけでいいのです.



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



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



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



制限と問題点

 * 機能の不足 — TemplateDataは、ごくわずかの機能しか実装していないツールの典型です. それは、利用者自身が望む機能の追加を助けてくれるだろうと期待されているからです. もしまだない機能で実装を望むものがあるなら、どうぞ教えてください.
 * テンプレートを表示する際の遅延 — テンプレートにTemplateDataを追加した後で、テンプレートをビジュアルエディターで開くと、メタデータがすぐさま表示されるはずです. しかしながら、メタデータが表示されるようになるまでには何時間もがかかるかもしれません. テンプレートページを（docぺーじではなく）を空編集すれば、更新を急かすことができます. 空編集をするには、テンプレートページの編集画面を開き、何も変更を加えずに保存します.
 * 現在の問題点 — 既知のバグおよび機能の要望の一覧は Bugzilla にあります.



ツール

 * w:fr:Utilisateur:Ltrlg/scripts/TemplateDataEditor.js — TemplateData の追加作業を容易にするユーザースクリプト (現在はフランス語のみ)
 * w:en:User:NicoV/TemplateDataEditor — 上記のスクリプトを英語に翻訳したもの