Help:TemplateData/ja

拡張機能でウィキテキストテンプレートとそのパラメーターの情報を保存すると編集インターフェイスがそれを取得してテンプレートエディタに表示するため、そのテンプレートを使用したページの編集がしやすくなります.

Since April 2019, TemplateData is part of the default user experience for all users on all Wikimedia wikis when they add a template, including unregistered users. Both the default source and visual editors incorporate it in some way. It is also used elsewhere in scripts, tools and gadgets. 自分自身のwikiで使用したい場合は、Extension:テンプレートデータをインストールする必要があります.

Adding TemplateData to a template essentially consists of inserting a small block of JSON code (explained below) on the template's documentation page. There are two main ways you can do this, either manually or by using the TemplateData editor, a graphical user interface located on the "Edit"/"Edit source" pages of templates on wikis with the TemplateData extension installed. The JSON contains a list of parameters with info about each parameter of the template as well as the template as a whole. These are outlined below.

Once a template has TemplateData, this information will show in the user interface when a user adds the template, sometimes in place of original info or sometimes as additional info. In some cases, it may change how the editor behaves when editing or inserting the template. This can make it much easier for users to identify what they need to do with the template when adding it.

History
TemplateData was originally developed in early 2013 with in mind, which was in MediaWiki testing stages at the time. VisualEditor is the main visual editing interface for Wikimedia wikis, and TemplateData allowed it to have a more useful interface when adding templates. It was officially supported by VisualEditor immediately. As VisualEditor was rolled out to the various major Wikimedia wikis as a default feature from 2013 through 2016, TemplateData became a part of them as well.

In March 2018, Sam Wilson developed, a GUI template editor extension for the default Wikimedia source editor, (otherwise known as the 2010 wikitext editor), designed to make the process of adding templates easier by using information from TemplateData. In April 2019, TemplateWizard was made a default part of the 2010 wikitext editor on all Wikimedia wikis. This meant that TemplateData was now a default part of both the visual editor and the source editor on Wikimedia wikis.

テンプレートデータ編集ツール
TemplateData 拡張機能には TemplateData の追加と編集を行うため同名の組み込みツールがあり、画像で手順を示す UI を採用しています.

テンプレートデータ編集ツールを使用するには、テンプレートのページ（またはその解説下位ページ）を開き「編集」ボタンもしくは「ソースを編集」ボタンを押します. すると編集ウィンドウの上部に「」というボタンとページ名が表示されます. （訳注：図のボタン名は Manage TemplateData）



このボタンをクリックするとTemplateData 編集機能が開きます.

編集ツールを使うとテンプレートの引数の記入と最も一般的な属性の設定ができます. 編集したページに既存の一連のテンプレートデータがある場合、該当するページをテンプレートデータ編集ツールで開くと登録済みのデータが自動で表示されます. 1番目のボックス (訳注：図のTemplate description (en)の欄) ではテンプレートの簡略な説明を平文で書いたり更新したりします. その次の欄では「提案パラメータを追加」または「引数を追加」ボタンを使って、テンプレートに使用するパラメータの名前と属性を登録します（ボタンは図中に "Add suggested parameter(s)" および "Add parameter" と表示）.

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



各引数の記述が終わったら「適用」ボタンをクリックし、空いている編集ボックスに整形済みのテンプレートデータを挿入します. 編集ツールのウィンドウが閉じても作業はまだ終わりではなく、通常の「投稿」ボタンを忘れずに押して必ずページを保存します.

注意：テンプレートデータ編集ツールがテンプレートデータを配置する先は、テンプレートページか、その解説下位ページのいずれか片方です. テンプレートデータを追加する場所は、それを配置するためにどのページを開く（編集する）かによって決まります. ただし、1件のテンプレートに複数ブロックのテンプレートデータが存在しても、実際にはそれらのブロックのうちの1つしか使われません. ページにテンプレートデータが既にある場合は、テンプレートデータを複数ブロック作るエラーを避けるために、ページ内の既存のテンプレートデータを編集する必要があります.

テンプレートデータの位置
テンプレートデータはそれを説明する対象のページに配置するか、もしくはそこに参照読み込みします. テンプレート内では常にタグで挟みます. ページの通常のレンダリングでは#例に示したように自動生成された説明文書を表示します.

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

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

こうすると2つのタグの間のすべてがTemplateDataであり、ソフトウェアがテンプレートを使用する際に必ず参照するよう指示します.

例
テンプレートデータ内の説明は標準的な配置に従います. 仮に「コモンズ」という名前のテンプレートがあり、特定のトピックに関するコモンズのカテゴリとリンクさせるとします. これに対応する既定のパラメータは1件で、コモンズのカテゴリ名ということにします. その場合のテンプレートデータは次のようになります.

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

{   "description": "これは記事についてコモンズカテゴリにリンクするためのテンプレートです. ", "params": { "1": {           "label": "コモンズのカテゴリ", "description": "リンクするコモンズのカテゴリ. ", "default": "Category:CommonsRoot", "type": "string", "required": true }   } }

説明とパラメーター
Each parameter for TemplateData is listed below with a description and example. They are also listed at Extension:TemplateData#Format.

The order of the parameters does not affect functionality, as long as those within, for example, the  object are kept within the object.

Within the parameter's name
Note: if neither "required", "suggested" nor "deprecated" are set as true for a parameter, its status will show as "optional" in the TemplateData documentation.

処理が終わったら、「保存」を押します. エラーがある場合には保存できません (一瞬、戸惑うかもしれませんが、破壊の予防になります). 自力でエラーを解決できないときは喜んでお手伝いしますので、フィードバック用のページに投稿して何をどうしたかったか説明をお願いします.

注記：ダイナミックなTemplateDataを作成するためにハックテンプレートの不正使用を試みようとする場合、保存前にエラーの検証はできない点にご注意ください.

注記：どの情報も半角の二重引用符で挟んであり (例外は  と  ) 、かたまりごとに半角カンマで区切る点に注意します (ならびの末尾を除く).

Effects of the type parameter
The  parameter can have multiple different effects or no effect depending on the value and depending on the template editor. Its effects are listed as follows.



The  value is intended for numerical values, including minus values and decimals.


 * In VisualEditor and the 2017 wikitext editor,  has no visible effect.
 * In the 2010 wikitext editor with TemplateWizard,,  causes the input box to display a "+" and "-" button on either side, which raise or lower a number value in the input box, respectively, and the user can only type numbers into the box. The buttons can also lower the number into negatives.



The  value is intended for any string of plain text.


 * In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard),  has no visible effect compared to.



The  value is intended for content that should be forced to stay on one line.


 * In VisualEditor and the 2017 wikitext editor,  prevents a parameter's input box from allowing new lines, which are usually possible in these editors.
 * In the 2010 wikitext editor with TemplateWizard,  has no visible effect (input boxes do not allow new lines by default in this editor).



The https:// value is intended for a URL, with Internet protocol (e.g., "https://") included.


 * In VisualEditor and the 2017 wikitext editor,  makes the input box display an external link icon (a square with arrow pointing out of it) in the left hand side of the box and makes the box glow red when the user clicks away without entering a URL value that includes a valid Internet protocol (e.g., "https://", "ftp://" or "//") followed by some text. This second effect is similar to that of the "required" setting, but it does not warn the user if they attempt to insert the template without a valid URL. It also occurs with any status setting (such as "suggested" or "deprecated").
 * In the 2010 wikitext editor with TemplateWizard,  has no visible effect.



The  value is intended for a page name on a wiki.


 * In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard),  makes the parameter input box show a suggestion dropdown menu containing a list of pages on the wiki, such as Wikipedia articles, which can be selected. Namespaces can also be defined in the search. Additionally, in VisualEditor and the 2017 wikitext editor, it forces the input box content to stay on one line. It has no other visible effect and doesn't prevent a non-page from being inputted.



The  value is intended for a file name hosted either locally on a wiki or on Wikimedia Commons.


 * In VisualEditor and the 2017 wikitext editor,  has no visible effect.
 * In the 2010 wikitext editor with TemplateWizard,  makes the parameter input box show a suggestion dropdown menu containing a list of files hosted both locally and on Wikimedia Commons, which can be selected. It also shows the thumbnail of the files. It has no other visible effect and doesn't prevent a non-file from being inputted.



The  value is intended for the name of a template.


 * In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard),  makes the parameter input box show a suggestion dropdown menu containing a list of templates, which can be selected. Additionally, in VisualEditor and the 2017 wikitext editor, it forces the input box content to stay on one line. It has no other visible effect and doesn't prevent a non-template from being inputted.



The  value is intended for a username on a wiki.


 * In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard),  makes the parameter input box show a suggestion dropdown menu containing a list of actual users' names, which can be selected. Additionally, in VisualEditor and the 2017 wikitext editor, it forces the input box content to stay on one line. It has no other visible effect and doesn't prevent a non-username from being inputted.



The  value is intended for wikitext of page content, for example, links, images or text formatting.


 * In VisualEditor and the 2017 wikitext editor,  has no visible effect.
 * In the 2010 wikitext editor with TemplateWizard,  makes the parameter input box one line taller and allows new lines, which regular input boxes in the 2010 wikitext editor do not.



The  value is intended for wikitext that cannot stand alone, i.e. it lacks an opening or closing tag or refers to other parts of wikitext.


 * In VisualEditor and the 2017 wikitext editor,  has no visible effect.
 * In the 2010 wikitext editor with TemplateWizard,  makes the parameter input box one line taller and allows new lines, which regular input boxes in the 2010 wikitext editor do not.

With other parameters


 * In VisualEditor and the 2017 wikitext editor,  overrides the visible effects of   - when both are set, the input box will not contain a URL icon nor glow red when the user clicks away without entering a valid URL.
 * In the 2010 wikitext editor with TemplateWizard,  overrides the effects of   - the value of "autovalue" will not be automatically placed in the input box if the parameter type is "number".

特別な書式
When editing the  value, you create custom formats by inputting a set of wikitext symbols using some predefined rules.


 * - start of the template
 * - content (e.g., string, integer or parameter). This underscore serves to indicate the minimum length of a value in characters and can be repeated, like . If this length is not reached, it fills the remaining characters with spaces. This can be used to align all equals signs to a specific position after a parameter (if used with   for new lines).
 * - pipe (separates parameters)
 * - equals sign (precedes the value of a parameter)
 * or pressing the enter key - new line (this will display as  in the entry field)
 * - space (can be used with  to indent new lines)
 * - end of the template

The wikitext should at least meet the minimum of, otherwise there will be an invalid format string error.

ブランク定型
以下に示す値が空の定型を複写して使用すると、特定のテンプレートに新規にテンプレートデータを記入できます. タグは最も一般的なタグのみ提供してあります.

Syntax error in JSON / Bad JSON format
This error occurs if you attempt to save TemplateData that has certain types of invalid JSON code, such as duplicate keys (parameters) or trailing/missing commas, in VisualEditor or the 2017 wikitext editor (JavaScript-based editors).

"Syntax error in JSON" shows if you attempt to save such code in VisualEditor or the 2017 wikitext editor, while "Bad JSON format" shows if you attempt to open up such code in the TemplateData GUI editor, on template pages.

This error can come up quite frequently while editing a template's TemplateData. The most common mistakes that cause this error include excess commas (such as trailing commas), missing commas and missing quotation marks.


 * Examples of trailing commas:


 * Examples of missing commas:


 * Example of missing quotation marks:

To fix these errors, you can either look for the errors in the code yourself, or you can enter the JSON block into an external JSON validator, such as JSONLint, and it will highlight the problematic commas and keys that should be removed.

Due to a longstanding bug, users using the 2010 wikitext editor are able to save pages that have such invalid JSON (details: ), as the JavaScript parser is less strict and allows invalid JSON.

Required property "paramOrder(number)" not found.
This error occurs if you state a parameter in  that is not stated in  .The number in the square brackets refers to the parameter in   that is missing. It refers to its order in the sequence, but it is one less than its actual position, since  is an array; 0 is the first one, 1 is the second, etc.

To fix this, make sure all parameters stated in  are listed in  .Alternatively, you can remove the   object to remove this error.

Invalid value for property "paramOrder(number)".
This error occurs if you state a parameter in  that is not stated in  .The number in the square brackets refers to the parameter in   that shouldn't be there. It refers to its order in the sequence, but it is one less than its actual position, since  is an array; 0 is the first one, 1 is the second, etc.

To fix this, make sure all parameters stated in  are listed in  .Alternatively, you can remove the   object to remove this error.

Property "params.parametername.required" is expected to be of type "boolean".
This error occurs if you put quotation marks around the value of either  or.

These are boolean values, not strings, therefore they require no quotation marks. To fix this, remove any quotation marks around the values  or   for these parameters.

Property "format" is expected to be ...
If the  parameter exists but its value is not ,   or a valid format string, you will see the error message "Property "format" is expected to be "inline", "block", or a valid format string."

To fix this, make sure the value after  equals   or   and that there no spelling mistakes. Alternatively, if it's wikitext, make sure it contains a minimum of  and that there are no mistakes in the syntax that would normally cause a template to fail, such as duplicate equals signs or missing/duplicate curly brackets; see the section #Custom formats for the syntax for custom formats.Alternatively, you can remove the   parameter to remove this error.

Unexpected property "parametername".
This error occurs if you state a parameter in any object that is not a parameter of that object. This may be due to spelling mistakes, or you may have written the parameter of one object under another object that it doesn't belong to.

For example, you might have written the parameter  under the root TemplateData object instead of inside  :

Alternatively, if the unexpected parameter is under a template parameter inside, you'll see its name after "params.parametername." in the error.

To fix this, make sure your parameters are in their correct location, and make sure there aren't any spelling mistakes in the parameter names. Additionally, make sure you don't state any parameters that don't exist for an object. You can check which parameters exist for an object on this page, in the section.

Required property "params" not found.
This error occurs if there is no  object in the TemplateData.This is a necessary object, as it contains all the details of each parameter, so to fix this error, make sure it's added and that there are no spelling mistakes. See the section above on how to add the  parameter.

制限とフィードバック

 * 不足している機能 — テンプレートデータをあえて機能を制限したツールのサンプルとして提供したのは、どんな機能を求めているか利用者に教えてもらうことで開発の支援をお願いできないかという考えがあるからです. テンプレートデータの新機能の提案がありましたら、ぜひお知らせください.
 * テンプレート表示が遅れる — テンプレートページへ TemplateData を追加後、ビジュアルエディターでテンプレートを開くと、メタデータがすぐに表示されるはずです. しかしながらメタデータの表示には数時間を要する可能性があります. 強制的に更新するには (説明文書の下位ページではなく) テンプレートページ自体に空編集をします. 空編集を行うテンプレートページを開き、「任意の変更を加えず編集要約欄は空欄のまま」ページを保存します.
 * 現在の問題 — 現在のバグや機能要求のリストはWikimedia バグトラッカーで利用可能です.

その他のツール

 * : ツールバーのダイアログウィンドウ. テンプレートデータから生成したフォームを使い、テンプレートにウィキテキストを記入するために使用.
 * TemplateData Wizard: テンプレートデータを生成するツール. インタラクティブなインターフェースを使用.
 * Skeleton TemplateData generator: テンプレートのソースウィキコードを解読するツール. 使用するすべてのパラメータ（引数）を検出し、値が空のドキュメントとパラメータの一覧を出力.
 * JSONLint: 手入力したJSONが正しいかどうか確認するツール. 構文エラーの発見に役立つ.
 * このウィキにあるテンプレートデータを備えたテンプレートの一覧
 * ドイツ語版ウィキペディアのテンプレートに備わったテンプレートデータでは、ボックス内にテンプレートのデータを表示. テンプレートはそのデータとともにドイツ語版ウィキペディアの特定のカテゴリに分類される