Help:テンプレートデータ

注意: このページを編集すると、編集内容が CC0 のもとで公開されることに同意したと見なされます。詳細はパブリック・ドメインのヘルプ ページを参照してください。 Translate

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

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.

歴史

TemplateData was originally developed in early 2013 with VisualEditor 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 TemplateWizard , a GUI template editor extension for the default Wikimedia source editor, WikiEditor (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つしか使われません。ページにテンプレートデータが既にある場合は、テンプレートデータを複数ブロック作るエラーを避けるために、ページ内の既存のテンプレートデータを編集する必要があります。

テンプレートデータの位置

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

テンプレートデータの構造

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

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

<templatedata>
{
    ...       // テンプレートデータの内容はここに書きます。
}
</templatedata>

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

例

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

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

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

これは記事についてコモンズカテゴリにリンクするためのテンプレートです。

Template parameters

Parameter		Description	Type	Status
コモンズのカテゴリ	1	リンクするコモンズのカテゴリ。 Default Category:CommonsRoot	String	required

説明とパラメーター

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 "params" object are kept within the object.

This information is current as of February 2020 and may change if new parameters are added or the template editing interfaces get updates to treat certain parameters differently or fix certain behaviours.

パラメーター	説明	例
description	最初のタグ"description"はテンプレートの役割を説明します。 It is optional but highly recommended. Wiki markup will not work in the description. It is strictly a plain text string. Effects On the template documentation page, the description will show in plain text below the "Template data for [template name]" subheading. In all main editors (VisualEditor , the 2017年版ウィキテキストエディター and the 2010 wikitext editor with TemplateWizard), the description shows in two main instances: below the template name in each search suggestion when the user is searching for a template below the template name in the template editor, while they are adding values to parameters in the template. In the VisualEditor and 2017 wikitext editor, approximately 50 characters of the description show under each search suggestion, followed by a "...", but the whole description shows in the main template editor window. Both are shown in grey text. In the 2010 wikitext editor with TemplateWizard, the whole description shows under each search suggestion, in grey text. In the main template editor window, descriptions longer than four lines (about 540 characters) are provided a separate scrollbar, and they are shown in black text. If not specified If the description parameter does not exist or is not specified, the text "No description." will be displayed in the TemplateData documentation below the "Template data for [template name]" subheading. Additionally: in VisualEditor and the 2017 wikitext editor, it will behave the same as a template that does not have TemplateData; instead of a description, the following text will display: "The "Template:Cleanup/sandbox" template doesn't yet have a description, but there might be some information on the template's page." in the 2010 wikitext editor with TemplateWizard, the following text will display where the description would be (though not in search suggestions): "No description exists for this template." This is different to the two standard placeholder descriptions when TemplateData doesn't exist: "Due to missing TemplateData, parameters for this template have been auto-generated. Please be aware that they may not be accurate." "No parameters could be determined for this template due to absence of TemplateData documentation. You may insert the template without parameters."	"description": "これはテンプレートについてコモンズカテゴリにリンクするためのテンプレートです。",
format	その次にあるのが "format"です。このテンプレートがウィキテキストの中でどのようなレイアウトで表示されるべきかを説明します。 これには選択肢があり、"inline" と "block" の標準設定にするか、利用者がカスタム書式をウィキテキスト形式のシンボルで書くか選べます。シンボルと例文など、詳細は#Custom formats節をご参照ください。 This parameter is not required, but it is recommended. The default behaviour when this parameter does not exist is inline formatting, and no corresponding notice is displayed in the TemplateData documentation below the table heading. Effects Inline: パラメータを "inline" に設定すると、テンプレートによって個人設定に対応する通知を TemplateData 説明文書に表示します。表示位置は表のヘッダ「テンプレートのパラメータ」の直下で、次のような表現が作成されます。 "[circles and pipes icon] This template prefers inline formatting of parameters." When inserted, the template will lay its wikitext out on a single line with no white space between elements, like so: {{Foo|bar=baz|qux=quux}} Block: パラメータを "block" に設定すると TemplateData 説明文書に、テンプレートによって次のような表現が作成されます。 "[stacked blocks and pipes icon] This template prefers block formatting of parameters." When inserted, the template will distribute its parameters each on a new line, with single spaces between each element, like so: {{Foo | bar = baz | qux = quux }} Custom formatting: Alternatively, if the parameter is set to a custom string of wikitext, as per the rules listed at #Custom formats, the template will display the following preference notice in its TemplateData documentation: "[cogwheel icon] This template has custom formatting." When inserted, the template will lay its wikitext out as per the given wikitext.	"format": "inline"
params	The "params" object contains the information for each parameter of the template. It is required, and its parameters can be viewed in the #Within params section. It should contain the name of each parameter followed by a set of TemplateData sub-parameters listed in #Within the parameter's name. 複数のパラメータがある場合は、1点ごとの波カッコに続けて半角カンマ「,」で区切って 並べます (最後の1点の後だけでは正しく動作しません。)	"params": { "parameter1": { ... // パラメーター情報 }, // このカンマを見落とさないこと "parameter2": { ... // parameter info }, // こちらにもあります: "parameter3": { ... // パラメーター情報 } // but not here }
paramOrder	The "paramOrder" object in an optional object that can force the parameters of a template to show in a specific order when added in the template editor. It is used by adding the parameter "paramOrder", followed by a colon and space, then including the name of each of the template's parameters in speech marks in a desired order, separated by commas, between two square brackets (an array). The parameters do not have to be on new lines (they can be "paramOrder": ["param1","param2","param3"]), but placing them on new lines may aid in legibility. Every parameter mentioned in the TemplateData must be included, or an error will show. Effects In VisualEditor and the 2017 wikitext editor, paramOrder forces its order regardless of the status of each parameter. In the 2010 wikitext editor with TemplateWizard, "required" parameters will always appear at the top, while "suggested" parameters will always appear second, above "optional" ones ("deprecated" parameters won't appear at all; see the description of "deprecated" for more info). paramOrder will only enforce its order within these categories (i.e., all "required" parameters will be in the order specified by "paramOrder", and all "suggested" parameters will be too, but all "suggested" parameters will appear below all "required" parameters).	"paramOrder": [ "date", "reason", "talk" ]

Within params

パラメーター	説明	例
parameter name	params オブジェクトの最上位レベルの項目のみ、テンプレートのパラメータ名に採用されます。 For example, in a template's source code, if you see {{{date}}}, this is a parameter, and this should be added under "params" with the name "date". You may also see parameters named {{{1}}} or another number (whose TemplateData name should be, for example, "1"). These parameters behave in such a way that, when a user inserts a template, they can omit their name and the equals sign (i.e., |value| instead of |parametername=value|). Their number indicates which empty parameter they are when multiple empty parameters are used. For example, expect that in {{example template|value1|value2}} value1 is the value of parameter {{{1}}}, and value2 is the value of parameter {{{2}}}. Make sure to describe your TemplateData parameters accordingly. Note: a user can still force the use of {{{2}}} without {{{1}}} by simply inserting a parameter named "2" in the template editor or typing "|2=" in wikitext. Each of these "parameter name" objects should contain all of the information about the parameter, in the form of more parameters. These are listed in the following section, Within the parameter's name.	"1": { // パラメータの名前 ... // パラメータに関する情報はここに。 }

Within the parameter's name

Parameter	説明	例
aliases	The "aliases" parameter is a optional item for when a template parameter has multiple names. You can check this by going into the template's source code and looking for: {{{parameter1|{{{parameter2}}}}}}, or {{{parameter1|{{{parameter2|}}}}}} This literally translates to, "Value of parameter1. If parameter1 doesn't exist or have a value, value of parameter2." In the second case, it also means, "If parameter2 doesn't exist or have a value, no value." This means that if the user inserts either of these parameters with a value, they will perform the same function. To insert the "aliases" parameter, add the text "aliases" followed by a colon and space, then include the name of each of the parameter's aliases in speech marks, separated by commas, between two square brackets (an array).	"aliases": ["1", "talk", "talksection"]
inherits	"inherits" is an optional parameter for when a parameter should inherit all of the TemplateData of another parameter. This can then be overridden by any parameters specified for the inheriting parameter. To use this parameter, type "inherits" : followed by another template parameter's name, such as "talk" or "1". You can then type another specific setting for the parameter underneath if you wish, like "label" : "A different label". The first parameter will inherit all of the second parameter's properties except this one.	"params": { "トピック1": { "label": "トピック", "description": "曖昧さ回避ページにあげたトピック", "type": "string" }, "トピック2": { "inherits": "トピック1" }, "トピック3": { "inherits": "トピック1", "label" : "A different label" } }
label	次の"label"に人間が読めるパラメータのタイトルを指定すると、テンプレート編集ツール内に表示します。 It displays this in place of the parameter's raw name. This parameter is optional but highly recommended.	"label": "Month and year",
description	パラメータ名によって命名されたそれぞれの項目のうち、 "description" の箇所はテンプレート全体の説明ではなく、パラメータの説明です。 This description is shown in a tooltip when the user hovers over the "i" symbol next to the parameter in the template editor. It is optional but highly recommended.	"description": "The month and year that the template was inserted.",
type	そのあとは"type"パラメータの役割は、テンプレートエディタに、そのパラメータ値の解釈を伝えることです。 In some cases, template editors are programmed to modify the user interface for a certain parameter according to its value type, such as to only allow the user to enter valid values that match that type. This parameter does not have any functional effect on the parameter or its value; it merely controls how template editors see and treat the parameter in editing mode. The most common types are: "string" - この文章のような文字列。 "number" - 数値。 "boolean" - '0' for false, '1' for true, '' for unknown; "wiki-user-name" - 利用者名を表す文字列。 "wiki-page-name" - ページ名を表す文字列。 "wiki-file-name" - ファイル名。 その他の使用できる型: "unknown", "date", "url", "wiki-template-name", "content", "unbalanced-wikitext", "line" To see the effects of the type parameter, see the section #Effects of the type parameter.	"type": "string",
default	Occasionally, a template parameter is programmed to have a default value that is used unless you change it. The "default" item is an optional item intended to tell the user what this value is. The value does not have to match the actual default and has no functional effect. 既定値がない場合はこのパラメーターを無視することが出来ます。 Effects In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), the "default" text will show as grey text in the input box of any open parameter when it is empty, in the format "Default: default text". Additionally, it will show in plain black text in the parameter description (when the user hovers over the "i" symbol). In VisualEditor and the 2017 wikitext editor, this will be below the parameter description, below "Field is required"/"Field is deprecated", if specified (the 2010 wikitext editor doesn't show this text), and above "example", if specified ("example" does not show in the parameter description in the 2010 wikitext editor). In the 2010 wikitext editor with TemplateWizard, the "default" text shows directly after the parameter description, on the same line, following a space. It shows in the same format as the other editors ("Default: default text"). With other parameters In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), if "default" is specified, the "example" value will not show in the input box.	"default": "Category:CommonsRoot",
autovalue	パラメータには "autovalue" つまり自動値を設定できます。利用者がそのようなテンプレートをページに用いる場合、自動値が自動的にインプット欄に表示されます。例えばクリーンアップ用テンプレートの多くには日付の記入が必須で、日付パラメータの自動値をあらかじめ{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}に設定しておくと、日付にテンプレートを追加した月・年の値を自動で付与できます。 This parameter does not force the value to always be this value. The user can freely change the value that is automatically inputted into the parameter in the template editor. With other parameters In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), "autovalue" overrides the visible effects of "url" in VisualEditor and the 2017 wikitext editor. See the description for "type" for more info.	"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
example	The "example" value is an optional value intended to display an example input to show how the parameter is used. Effects In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), it shows a grey text in the input box of any open parameter when it is empty, in the format "e.g. example text". Additionally, in VisualEditor and the 2017 wikitext editor, it shows the same text in black, non-italic font below the parameter description (and below the "default" text, if specified). With other parameters In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), "example" will not show in the input box if "default" is specified.	"example": "January 2013",
required	続いて "required" があります。true か false のどちらか一方を設定できます。 指定しなければ、false とみなされます。 これは、単にこのパラメータの記入が必須かどうかを指定します。 Effects This status has several effects in VisualEditor and the 2017年版ウィキテキストエディター : it makes the parameter automatically show up when a user inserts a template; it shows a grey asterisk next to the parameter label; it shows a black asterisk within the input box, on the right; it shows the grey, italic text "Field is required" below the parameter description; it makes the input box glow red if the user clicks away without entering a value; if a user attempts to insert the template without a value in the required parameter, it will show them a prompt, asking if they are sure. If they confirm, it will insert the parameter with a blank value. It will not stop them from inserting the template, though, and it does not result in a visible error by itself (though templates can be programmed to display an error when a required parameter is not filled in). In the 2010 wikitext editor with TemplateWizard, like in the other editors, it causes the parameter to automatically show up when a user inserts a template, but in this editor the parameter cannot be removed. It also does not display "Field is required" in the parameter description; rather, it lists the parameter on the side under "Required parameters". Other than this, it generally behaves the same as in the other editors, except that the prompt says that the input doesn't "match the expected format". With other parameters In VisualEditor and the 2017 wikitext editor, the "deprecated" status does not override the functionality of this parameter, but in the 2010 wikitext editor with TemplateWizard it does. See the description of "deprecated" for more info.	"required": true
suggested	続いて "suggested" は、true か false のどちらか一方を設定します。 指定しなければ、false とみなされます。 これはテンプレートの利用に際して当該パラメータが「必須」ではないものの強く推奨される（が強制ではない）状態です。 Effects In VisualEditor and the 2017年版ウィキテキストエディター , it causes the parameter to automatically show up when a user inserts a template. If the parameter has an autovalue set, this will also automatically be in the parameter's input box. It has no other effect and doesn't show any additional text or warnings. In the <tvar|1>2010 wikitext editor with TemplateWizard, it does not place the parameter in the template automatically but instead causes it to be listed on the side under "Suggested parameters". The user can then click a "+" next to the parameter to add it to the template. With other parameters The "required" status overrides the functionality of this status in all main editors (VisualEditor, the 2017 wikitext editor and the 2010 wikitext editor). It also overrides the displayed "suggested" status in TemplateData documentation (it will display "required" if both "required" and "suggested" are set to true).	"suggested": true
deprecated	最後の、"deprecated" は true か false、または代わりにすべきことの説明を設定します。 指定しなければ、false とみなされます。 これはパラメータの使用が既に推奨されないものの、いまだに存在していることを示すものです。 この現象は、テンプレートを使用は するパラメータの組み合わせが変更された場合に起こりえます。 Effects The effect of this parameter in VisualEditor and the 2017 wikitext editor is that a grey exclamation mark shows next to the parameter's label when it is inserted, and in the parameter's information tooltip, the grey, italic text "Field is deprecated" is shown below the parameter description. It does not affect the functionality or usability of the parameter or show any additional warnings. Despite the fact that it can take a string, as of January 2020 none of the main editors (VisualEditor, the 2017 wikitext editor or the 2010 wikitext editor) display the contents of the string anywhere to users. Inputting a string has the same effect as true. In the 2010 wikitext editor with TemplateWizard, setting this value as true does not allow the parameter to be added or seen. With other parameters If you set both this and "suggested" as true, the parameter status will show as "deprecated" in the TemplateData documentation, but in VisualEditor and the 2017 wikitext editor both functionalities will be retained; the parameter will automatically show up when a user inserts a template, but it will have the "deprecated" warnings around it. If you set both this and "required" as true, the parameter status will show as "deprecated" in the TemplateData documentation, but in VisualEditor and the 2017 wikitext editor it will have the same functionality as only "required"; the parameter will automatically show up when a user inserts a template, and it will have the "required" warnings around it. This is the same for if you set "deprecated", "suggested" and "required" as true. In the 2010 wikitext editor with TemplateWizard, "deprecated" overrides the parameters "required" and "suggested".	"deprecated": "代わりに'publicationDate'を使用してください。"

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を作成するためにハックテンプレートの不正使用を試みようとする場合、保存前にエラーの検証はできない点にご注意ください。

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

Effects of the type parameter

The "type" 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.

"number":

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

• In VisualEditor and the 2017 wikitext editor, "number" has no visible effect.
• In the 2010 wikitext editor with TemplateWizard, "number", 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.

"string":

The "string" value is intended for any string of plain text.

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

"line":

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

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

"url":

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

• In VisualEditor and the 2017 wikitext editor, "url" 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, "url" has no visible effect.

"wiki-page-name":

The "wiki-page-name" 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), "wiki-page-name" 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.

"wiki-file-name":

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

• In VisualEditor and the 2017 wikitext editor, "wiki-file-name" has no visible effect.
• In the 2010 wikitext editor with TemplateWizard, "wiki-file-name" 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.

"wiki-template-name":

The "wiki-template-name" value is intended for the name of a template.

• In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), "wiki-template-name" 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.

"wiki-user-name":

The "wiki-user-name" value is intended for a username on a wiki.

• In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), "wiki-user-name" 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.

"content":

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

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

"unbalanced-wikitext":

The "unbalanced-wikitext" 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, "unbalanced-wikitext" has no visible effect.
• In the 2010 wikitext editor with TemplateWizard, "unbalanced-wikitext" 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, "autovalue" overrides the visible effects of "url" - 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, "number" overrides the effects of "autovalue" - the value of "autovalue" will not be automatically placed in the input box if the parameter type is "number".

特別な書式

When editing the "format" 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 \n for new lines).
• | - pipe (separates parameters)
• = - equals sign (precedes the value of a parameter)
• \n or pressing the enter key - new line (this will display as ↵ in the entry field)
• - space (can be used with \n 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.

使用できる書式の例

目的	書式文字列	出力
インラインの書式設定	{{_|_=_}} inline	{{Foo|bar=baz|qux=quux}}{{Bar}}
ブロックの書式	{{_\n| _ = _\n}} block	{{Foo | bar = baz | qux = quux }}{{Bar }}
パラメータ名の前に空白（スペース）を入れない。テンプレートごとに改行	\n{{_\n|_ = _\n}}\n	{{Foo |bar = baz |qux = quux }} {{Bar }}
パラメータの位置をインデントで揃える	{{_\n |_ = _\n}}	{{Foo |bar = baz |qux = quux }}{{Bar }}
パラメータ名をすべて一定の文字数に調整	{{_\n|_______________ = _\n}}\n	{{Foo |bar = baz |qux = quux |veryverylongparameter = bat }} {{Bar }}
前の行の終わりにパイプ記号を置く	{{_|\n _______________ = _}}	{{Foo| bar = baz| qux = quux}}{{Bar}}
インラインの書式。半角スペースを多用、行頭の典型	\n{{_ | _ = _}}	{{Foo | bar = baz | qux = quux}} {{Bar }}
行頭に置くテンプレート。パイプ記号に続けてパラメータを置き、インデントで位置を揃える	\n{{_ |\n _______________ = _}}	{{Foo | bar = baz | qux = quux}} {{Bar}}

ブランク定型

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

<templatedata>
{
    "description": "",
    "params": {
        "1": {
            "label": "",
            "description": "",
            "type": ""
        },
        "2": {
            "label": "",
            "description": "",
            "type": ""
        }
    }
}
</templatedata>

エラー

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:

<templatedata>
{
    "description": "",
    "format": "inline",
    "params": {
        "1": {
            "label": "",
            "description": "",
            "type": "", // <-- This comma shouldn't be here.
        }, // <-- This comma shouldn't be here.
    }, // <-- This comma shouldn't be here.
}
</templatedata>

Examples of missing commas:

<templatedata>
{
    "description": "",
    "format": "inline" // <-- A comma should be here.
    "params": {
        "1": {
            "label": "",
            "description": "" // <-- A comma should be here.
            "type": ""
        }
    }
}
</templatedata>

Example of missing quotation marks:

"description": An example description // <-- This text should have 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: タスク T128029), 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 "params" that is not stated in "paramOrder".The number in the square brackets refers to the parameter in "paramOrder" that is missing. It refers to its order in the sequence, but it is one less than its actual position, since "paramOrder" is an array; 0 is the first one, 1 is the second, etc.

"params": {
    "date": { ...
    },
    "reason": { ...
    },
    "talk": { ... // <-- This parameter is not stated in "paramOrder", but it should be.
    }
},
"paramOrder": [
	"date",
	"reason"
]

// Error: Required property "paramOrder[2]" not found.

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

Invalid value for property "paramOrder(number)".

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

"params": {
    "date": { ...
    },
    "talk": { ...
    }
},
"paramOrder": [
	"date",
	"reason", // <-- This parameter is not stated in "params", but it should be.
    "talk"
]

// Error: Invalid value for property "paramOrder[1]".

To fix this, make sure all parameters stated in "paramOrder" are listed in "params".Alternatively, you can remove the "paramOrder" 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 "required" or "suggested".

"suggested": "true" // <-- These quotation marks shouldn't be here.

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

Property "format" is expected to be ...

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

"format": "notinline"

// Error : Property "format" is expected to be "inline", "block", or a valid format string.

To fix this, make sure the value after "format": equals "inline" or "block" 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 "format" 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 "label" under the root TemplateData object instead of inside "params":

<templatedata>
{
    "description": "",
    "format": "inline",
    "label": "", // <-- incorrectly placed parameter
    "params": {
        "1": { // ↓ it should be in here
            "description": "",
            "type": ""
        }
    }
}
</templatedata>

Alternatively, if the unexpected parameter is under a template parameter inside "params", 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 #TemplateData parameters.

Required property "params" not found.

This error occurs if there is no "params" 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 "params" parameter.

制限とフィードバック

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

その他のツール

Help:Extension:TemplateWizard

ツールバーのダイアログウィンドウ。テンプレートデータから生成したフォームを使い、テンプレートにウィキテキストを記入するために使用。

TemplateData Wizard

テンプレートデータを生成するツール。インタラクティブなインターフェースを使用。

Skeleton TemplateData generator

テンプレートのソースウィキコードを解読するツール。使用するすべてのパラメータ（引数）を検出し、値が空のドキュメントとパラメータの一覧を出力。

JSONLint

手入力したJSONが正しいかどうか確認するツール。構文エラーの発見に役立つ。

• このウィキにあるテンプレートデータを備えたテンプレートの一覧
• ドイツ語版ウィキペディアのテンプレートに備わったテンプレートデータでは、ボックス内にテンプレートのデータを表示。テンプレートはそのデータとともにドイツ語版ウィキペディアの特定のカテゴリに分類される