Help:TemplateData/ja

はウィキテキストテンプレートとそのパラメーターについて保存する方法で、そのためVisualEditorはそれを取得してテンプレートエディタに表示し、簡単にそのテンプレートを使用してページを編集することが出来ます.

テンプレートデータ拡張機能はすべてのWMFウィキにインストールされています. 自分自身のWikiで使用したい場合は、Extension:TemplateDataをインストールする必要があります.

テンプレートデータ構文は、テンプレートページに僅かな構造化データを書き込み、そのテンプレートページ（例えば、テンプレートの解説ページ）から参照読み込みすることができます. テンプレートが構造化データを有していれば、ビジュアルエディターはそれを正しく表示することができます. これは複雑に聞こえるかもしれませんが、実際は非常に簡単なことです.

テンプレートデータ エディター
簡単にテンプレートデータを編集するための組み込みツールがあります.

テンプレートデータ エディターを使用するには、テンプレートのページ（またはその解説下位ページ）へ行き、"編集" ボタンを押してください. 編集ウィンドウの上に "" というボタンがあります.

このボタンをクリックすると、テンプレートデータを編集するための GUI ツールが表示されます.

The editor allows you to add template parameters and to set the most common attributes. If the page you edited already contains a block of TemplateData, then the information already documented will automatically be shown when you open the correct page in the TemplateData editor. In the first box, you can add or update a short description of the template in plain text. After that, you can use the "Add suggested parameter(s)" and "Add parameter" buttons to document the names and attributes of the parameters that the template uses.

If the template page is protected, you can copy-and-paste the template code in the subpage, use the "Add suggested parameter(s)" button there, copy the TemplateData content, edit back the subpage to get rid of the template code and then paste the TemplateData content. To know where to paste the TemplateData content inside the subpage, you can edit TemplateData without adding anything; you can then replace the and tags and their content by pasting over them.

引数の名前、その引数の別名、ラベルとユーザに表示される説明文を一覧表示することができます. また、引数の使用例を提供するすることができます. 唯一の必須入力欄は名前（各行の初めにある入力欄）です. そこには、大文字・小文字を区別して正確に引数の名前を記録します. "型"ドロップダウンメニューには、引数が受け取るべき内容の種類（例えば、平文の回答には「文字列」、他ページへのリンクには「ページ」、あるいは「日時」など）を選択することができます. 引数を空白にしたときにテンプレートにエラーが生じる場合には、その引数を「必須」としてマークしてください. また、一般的に使われているか推奨されている引数には「推奨」としてマークしてください. 「引数情報を除去」ボタンは、テンプレートデータから引数のエントリーを削除します.



各引数の記述が終わったら、開いている編集ボックスに整形済みのテンプレートデータを挿入するために「適用」ボタンをクリックします. あなたには、まだ編集ウィンドウの下にある通常の「投稿」ボタンを使用してページを保存する必要があります.

注意：テンプレートデータエディターは、テンプレートページか解説サブページのいずれかにテンプレートデータを配置します. テンプレートデータを配置したいページを開く（編集する）ことによって、テンプレートデータを追加する場所を決めます. 複数のテンプレートデータブロックが同じテンプレートに配置されている場合には、それらのテンプレートデータブロックのうち一つのみが使われます. ページにテンプレートデータが既にある場合は、複数のテンプレートデータブロックを誤って作ることを避けるために、以前からテンプレートデータが配置されているページを編集する必要があります.

制限と質問

 * 不足している機能 — TemplateData is an example of a 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.
 * テンプレートでの表示が遅れる — テンプレートページへ TemplateData を追加後、ビジュアルエディターでテンプレートを開くと、メタデータがすぐに表示されるはずです. しかしながらメタデータの表示には数時間を要する可能性があります. 強制的に更新するには (説明文書の下位ページではなく) テンプレートページ自体に空編集をします. 空編集を行うテンプレートページを開き、「任意の変更を加えず編集要約欄は空欄のまま」ページを保存します.
 * 現在の問題 — 現在のバグや機能要求のリストはWikimedia バグトラッカーで利用可能です.

テンプレートデータの位置
TemplateData shall be on the page it describes, or be transcluded into it. In a template, it shall typically be wrapped into tags. On normal page rendering, it displays autogenerated documentation as shown in #Example.

テンプレートデータの構造
テンプレートデータの構造は JSON 標準に基づいています. テンプレートデータ内のすべての記述は、プレーンテキスト (ウィキテキストやリンクを使えないなど) でなければならないことに気をつけてください.

はじめにやることは、テンプレートのdocサブページのどこかに タグを対になるように記入することです. 例えば:

テンプレートを使用する際にこれは、2つのタグの間のすべてが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:

記入すると、例えば以下のようにテンプレートページに表示されます.

{   "description": "これは記事についてコモンズカテゴリにリンクするためのテンプレートです. ", "params": { "1": {           "label": "コモンズのカテゴリー", "description": "リンクするコモンズのカテゴリ. ", "default": "Category:CommonsRoot", "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).

Custom formats
When editing custom format strings in the TemplateData editor you can either type  or press the enter key to represent a newline; in either case it will display as   in the entry field.

{| class="wikitable" ! style="width:25%" | Objective ! Format string ! Output each template on its own line
 * + Examples of formats you can use
 * Inline formatting
 * Block formatting
 * No space before the parameter name,
 * Block formatting
 * No space before the parameter name,
 * Block formatting
 * No space before the parameter name,
 * No space before the parameter name,
 * No space before the parameter name,
 * No space before the parameter name,
 * Indent each parameter
 * Align all parameter names to a given length
 * Align all parameter names to a given length
 * Align all parameter names to a given length
 * Align all parameter names to a given length
 * Align all parameter names to a given length
 * Pipe characters at the end of the previous line
 * Inline style with more spaces, must be at start of line
 * Inline style with more spaces, must be at start of line
 * Inline style with more spaces, must be at start of line
 * Inline style with more spaces, must be at start of line
 * Inline style with more spaces, must be at start of line
 * Template at the start of a line, indent-aligned parameters, pipe beforehand
 * could also be written as  or.
 * could also be written as  or.

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

自動値
You can specify an "autovalue" for a parameter. When users add the template to a page, this value will be added automatically. For example, many clean-up templates need to have the date added; if you specify an autovalue for the template's date parameter, then the date will be filled in automatically.

To add this information to TemplateData, simply add the autovalue to the parameter's information. You will probably want to use the prefix  with the values to make them stick:

複数のパラメーター
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:

同様のパラメーター
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.

ブランク定型
You can copy the blank boilerplate below to add new TemplateData to a template. Only the most common tags are included.

その他のツール

 * : A toolbar dialog window for entering template wikitext via an form built from TemplateData.
 * TemplateData Wizard: A tool that generates TemplateData through an interactive interface.
 * Skeleton TemplateData generator: A tool that reads the source wikicode of a template, tries to find all the parameters used and outputs a skeleton document with the parameters listed.
 * JSONLint: A tool that allows you to validate manually-written JSON to help find errors in the syntax.
 * List of all templates with TemplateData on this wiki
 * With dewiki template TemplateData template data is shown in a box, and the template is added to a category of templates with template data