Help:TemplateData/ja



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

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



TemplateData の構造
TemplateData の構造は JSON の標準に基づいており、かなりシンプルです. TemplateData 内の説明 (description) はプレーンテキスト形式に限られることにご注意ください (ウィキテキスト、リンクなどは使用できません).

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

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



例
TemplateData 内の記述は標準的なレイアウトに従っています. ここでは「Commons」というテンプレートを例にとって説明します. このテンプレートは、ある主題に関するコモンズのカテゴリにリンクします. このテンプレートには必須の引数が1つあります (コモンズでのカテゴリ名). TemplateData はだいたい以下のようになります:

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



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

それぞれの情報が「"」(二重引用符) で囲まれていることにご注意ください ( 、 を除く). また、後続のブロックとは「,」(カンマ) で区切られていることにもご注意ください (ただし最後のみカンマ不要).



引数の別名
一部のテンプレートでは、同じ引数について別の名前 (別名) を使用できる場合があります.

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

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



複数の引数
複数の引数がある場合は、各セクションを繰り返して (「1」タグから始めて) 必要に応じて情報を記入してください. テンプレートに複数の引数がある場合は、TemplateData 内で各引数をカンマ で区切る必要があることにご注意ください. 例を以下に示します:



類似の引数
テンプレートに複数の引数があるとき、同じ種類の引数がある場合があります. この場合、1 つめの引数のみにすべての情報を記述する必要がありますが、残りの引数については 1 つめの引数の情報を「継承」(inherit) できます.



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



制限と問題点

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



ツール

 * TemplateDataEditor — TemplateData を追加する作業を簡単にするユーザー スクリプト. 現在は英語版とフランス語版がありますが、容易に他の言語に翻訳できます.
 * TemplateData Wizard — 対話的なインターフェイスで TemplateData を生成するツール
 * Skeleton TemplateData generator — テンプレートのソース ウィキコードを読み取り、使用されているすべての引数を可能な限り見つけて、引数が列挙された説明文書の骨組みを出力するツール
 * JSONLint — 手作業で作成した JSON を検証して構文エラーを見つけられるようにするツール