Help:テンプレートデータ

From mediawiki.org
This page is a translated version of the page Help:TemplateData and the translation is 80% complete.
PD 注意: このページを編集すると、編集内容が CC0 のもとで公開されることに同意したと見なされます。詳細はパブリック・ドメインのヘルプ ページを参照してください。
PD

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

2019年4月時点ではテンプレートデータ機能はウィキメディアのすべてのウィキに既定の UX (利用者体験) として組み込まれました。アカウントを登録していてもいなくても、参加する利用者がテンプレートを追加すると適用されます。 既定のソース編集でもビジュアル編集でも適用しており、その点はスクリプトやツール、ガジェットの一部と同様です。 この機能を自身のウィキで使用したい場合は、Extension:TemplateData をインストールします。

特定のテンプレートに TemplateData を組み込み、この拡張機能に対応させる手順は、テンプレートの説明文書のページに JSON の小さなコードブロックを追加します (詳細は下記の説明をご参照ください)。 実行する方法は手動か、 TemplateData 編集機能を使うかです。後者は 画像的な UI で、TemplateData 拡張機能を組み込んだウィキの、それぞれのテンプレートに対応する「編集/ソースを編集」ページから利用できます。 JSON にはパラメーターの一覧が含まれ、テンプレートの個々のパラメーターの情報と、テンプレート本体の説明を添えてあります(詳細は下記をご参照ください)。

個別のテンプレートに TemplateData が設定されると、この情報は利用者がテンプレートを追加するたびユーザーインターフェースに表示されます。 これを使って編集したり当該のテンプレートを追加した場合、時にはそのせいでエディタの挙動を変化させることもあり、すると当該のテンプレートを追加しようとした利用者は、手順がずっと楽になります。

歴史

テンプレートデータTemplateData の開発は2013年、VisualEditor を念頭に始まり、当時は MediaWiki の試験段階に置かれました。 VisualEditor はウィキメディアのウィキ群で採用するメインの視覚的な編集インターフェースで、TemplateData ではテンプレートの追加をするとき、より利便性の高いエディタとしてこれを容認しています。 VisualEditor では即時に公式にサポートされました。 2013年から2016年にかけてさまざまなウィキメディアのウィキ群で VisualEditor を既定の機能として導入した結果、TemplateData もその一環となりました。

2016年12月時点で VisualEditor インターフェースはベータ機能として、ソースコード編集に使えるようになりました。 これを名づけて2017年版ウィキテキストエディター . このとき初めて、TemplateData の機能をソース編集に導入しました。

サム・ウィルソン Sam Wilson は2018年3月に TemplateWizard を発表、TemplateData を利用してテンプレートを追加する手順をより簡略化するために既定の Wikimedia ソースエディター WikiEditor (別称2010年ウィキエディター) に GUI テンプレート エディター拡張機能を導入しました。 2019年4月には Wikimedia の全てのウィキで TemplateWizard を2010年ウィキテキスト エディターの既定部分に導入しています。 これはすなわち、現状でウィキメディアのウィキ群における TemplateData は、ビジュアル編集でもソース編集でも規定の部分となったことを意味します。

テンプレートの追加/編集

TemplateData の追加手順は、まずテンプレートのページを「/Template:テンプレートの名前」から開きます。

Checking the current state

Before adding or editing TemplateData, check whether the template has a documentation subpage. Then check whether the template already contains TemplateData and, if so, whether it's located on the template page or the documentation subpage.

Be sure to check whether a subpage exists. If you add TemplateData to a template's main page while a subpage exists with TemplateData, the TemplateData in the main page will override the data on the subpage.

説明文書下位ページ

Wikimedia のほとんどのウィキでは、使い方の解説その他のデータなどテンプレート本体に書いてはいけない情報を、主に2つの方法で保存しています。情報とはたとえばテンプレートのカテゴリなどで、保存先は次になります。

  • ほぼ全てのテンプレートは、テンプレートのメインページに書く場所のないもの(使い方の注記その他のデータ)を下位ページの解説文書ページに記しています(訳注:右は下位ページの指定例)。「/Template:Templatename/doc」 この類のページでは{{Documentation}}テンプレートが当該の /doc のコンテンツを全てテンプレートのページに呼び出しており、これによってテンプレートのソースコードの見た目がずいぶんとスッキリします。
    • 特定のテンプレートに /doc ページがあるかさっとチェックするには、「Test Template Info-Icon - Version (2).svg テンプレートの解説文書」 (あるいは同類の) 見出しの行の端に「[表示] [編集] [履歴] [キャッシュを破棄]」のリンクがあるかどうかでわかります。
  • 一部のテンプレートはそれらの情報をそのメインページに置いています。 この事例では、‎<noinclude>タグの間に記してある{{Documentation|content=が書いてある箇所を探します。

Different wikis may present all this differently. ごくまれには、上記のチェック項目を確かめたのに、それでもメインのテンプレートページに説明文書が残る場合があります。 利用者が「{{Documentation|」から「|content=」までの間にカスタム化した /doc ページ名を使い、なおかつ「|content=」の後にコンテンツを記入した場合に発生します。

You can also look for a notice at the bottom of the page similar to this: "The above documentation is transcluded from Template:Templatename/doc".

Templates without documentation subpages

特定のテンプレートに解説を記した下位ページがない場合は作成し、テンプレートの解説ページをその直下に移動します (もしくはプレースフォルダを作成して収容) この処理後、解説文書の下位ページに TemplateData を追加します。

doc 下位ページの作成、解説文書のコンテンツの移動
Wikimedia のほとんどウィキの多くは、当該のウィキでページを作成するには利用者登録後、特定の日数が経ったかどうか、指定の回数以上の編集実績があるかどうかを条件にしています。

実行するにはテンプレートのメインページで「編集」または「ソースを編集」をクリック、‎<noinclude> タグに挟まれた記述を探します。位置は通常、ページ最下部。

内容は以下のようになります。

<noinclude>
{{Documentation|content=
== Usage ==

Information about usage.

== More example headings ==

More example contents

[[Category:Example category]]
[[Category:Example category 2]]
}}
</noinclude>

すでに TemplateData を内包しているかもしれません。 その場合、内容は以下のようになります:

<noinclude>
{{Documentation|content=
...
<templatedata>
{
    "description": "",
    "params": {
        "1": {
            "label": "Example parameter",
            "description": "Example parameter description",
            "type": "string"
        }
    }
}
</templatedata>
</noinclude>

|content=」に続き、「‎</noinclude>」より前にある記述を選択してカット(訳注=外部エディタにペーストして仮に保存しておくのがお勧め)。次に「|content=」を削除すると、次の文字列が残るはずです。

<noinclude>
{{Documentation}}
</noinclude>

テンプレート ページを保存してください。

Now, to create the new subpage, look at your browser's address bar and add /doc to the end of the URL. Press ↵ Enter, then choose the option to create a new page.

ご利用のウィキで{{Documentation subpage}}の通知テンプレートを採用しているなら、ページ最上部に記入しておきます。 その他のテンプレートの追加も検討しましょう。ご利用のウィキで採用済みなら{{Purge button}}や{{Purge}}のリンクがその一例です。 詳細情報は m:Help:Template documentation を参照してください。

Insert the text you cut or saved in the previous text (beneath the notice template, if applicable).

Wrap any categories in ‎<includeonly> tags so that they apply only to the template's main page:

<includeonly>
[[Category:Example category]]
[[Category:Example category 2]]
</includeonly>

多くのウィキでは{{Sandbox other}}というテンプレートがあります。 Use this template here if it's likely that the template you're editing exists in a sandbox version (located at "Template:Templatename/sandbox") in order to prevent the categories from applying to the sandbox page:

<includeonly>{{sandbox other||
[[Category:Example category]]
[[Category:Example category 2]]
}}</includeonly>

最後に、ページを公開します。

解説下位ページでTemplateDataを追加または編集でき、#方法節の指示に従います。

テンプレートのメインページに TemplateData を追加もしくは編集する

/doc ページを作成できない場合は、TemplateDataをテンプレートのメインページで追加/編集できます。手順は#方法に従います。

テンプレートに解説文書の下位ページがある場合は、すでに TemplateData があるかどうか調べ、また所在はテンプレートのページか、解説文書の下位ページか確認します。

別の方法として、TemplateData 拡張機能はこの検査を利用者に代わって実行します。 どちらかのページで「編集」または「ソースを編集」をクリック。 どちらかのページにテンプレートに対応する TemplateData がある場合、ページ上部に黄色の通知が現れ、内容は次のいずれかを表示します。

注意: ページ「[[Template:Templatename/doc]]」に類似するテンプレートデータブロックが既に存在します。

or

注意: ページ「[[Template:Templatename]]」に類似するテンプレートデータブロックが既に存在します。

特定のテンプレートの解説下位ページに TemplateData がある場合

当該のテンプレートの TemplateData が、解説用下位ページに存在する場合、編集はそちらで行ってください。 実行するには見出しTest Template Info-Icon - Version (2).svg テンプレート解説文書」 (または同等), の右にある 「[編集]」ボタンをクリック、または既に/docページを開いている場合は、ページ上部の「編集」または「ソースを編集」をクリックします。 TemplateDataの追加もしくは編集は、#方法に従います。

もしメインページに TemplateData がある場合

当該のテンプレートの TemplateData がメインページに存在する場合、ここでも選択肢は2つあります。

  • このとき解説文書の下位ページに移動してもかまいません。こちらの選択肢の方がお勧めです。
  • もう一つの選択肢は、テンプレートのメインページで編集する。

TemplateData を解説会ページに移動するには

実行するにはテンプレートのメインページで「編集」または「ソースを編集」をクリック、‎<noinclude>タグの位置を探し、その中の‎<templatedata> タグに挟まれた記述を見ます。 内容は以下のようになります。

<noinclude>
{{Documentation}}
<templatedata>
{
    "description": "",
    "params": {
        "1": {
            "label": "Example parameter",
            "description": "Example parameter description",
            "type": "string"
        }
    }
}
</templatedata>
</noinclude>

‎<templatedata>タグとそれに挟まれた内容だけを指定し、コード文から切り出したらページを保存。

次に、解説会ページを編集するため見出し「Test Template Info-Icon - Version (2).svg テンプレート解説文書」 (もしくは同等) の右にある「[編集]」ボタンをクリックします。

見出しを「TemplateData」のように記入し、この見出しの下に TemplateData を貼り付けます。

TemplateDataの編集ができる状態になったので、#方法節の指示に従います。

テンプレートのメインページで TemplateData を編集するには

もしメインのテンプレートページから TemplateData を解説ページ /doc に移動したくない場合は、そのままメインの方で編集が可能です。 #Methods節に TemplateData の編集方法を示します。

テンプレートに/docページはあるがまだ TemplateData がない場合

もしテンプレートにまだTemplateDataがない場合には、解説下位ページに追加する必要があります。

実行するには見出し「Test Template Info-Icon - Version (2).svg テンプレート解説文書」 (または同等) の右にある 「[編集]」ボタンをクリック、または既に/docページを開いている場合は、ページ上部の「編集」または「ソースを編集」をクリックします。 見出しを「TemplateData」のように記入し、この見出しの下に追加します。 #Methods節に TemplateData の追加方法を示します。

方法

TemplateData エディタの方法

これはTemplateDataの編集もしくは追加のいちばん簡略な方法で、経験が浅い利用者にも使えます。

TemplateData 拡張機能は画像で手順を示す UI を採用し、TemplateData の追加と編集を行います。 It is part of the TemplateData extension, available on any template's page (or documentation subpage) by clicking "編集" or "ソースを編集".

操作として「編集」「ソースを編集」のいずれかを押すと、編集枠のページ名の上部にボタン「テンプレートデータを管理」が現れます。

Manage template documentation button for TemplateData 2014.png

このボタンをクリックするとTemplateData 編集機能が開きます。 ページに既存のテンプレートデータがある場合、自動的に表示されます。

テンプレートデータ編集ツールのスクリーンショット

上述の窓には次の機能があります。

  • The top item chooses the language of the interface text. It allows you to enter text content in multiple languages, displayed to users based on their settings in Preferences, not based on the wiki's language; different wikis have entirely different template databases. If no language TemplateData exists, the interface will only offer users the wiki's own language, but users can click "言語を追加" to add more inputs. The language code is displayed in brackets next to the parameters to which it can be applied, such as descriptions and labels.
  • 次の項目はテンプレートの説明です。ここにテンプレート全体の説明を記し、テンプレートの追加作業中、あちこちで利用者に表示します。このパラメータとその効果は こちらにまとめてあります。
  • 3番目の項目はテンプレートのウィキテキストの書式を制御します。このパラメータは、利用者が「適用」を押したときにウィキテキストをどうレイアウトするか指定し、主に2種類、"inline" (1行表示) と "block" (複数行) のどちらかになります。このパラメータとその効果のまとめは、こちら
利用者が「Custom」を選択した場合、「Custom format string」のところにウィキテキストを入力します。書式のまとめはこちらで、利用者が「適用」を押したときに示す、当該テンプレートに特別のレイアウトを生成します。
  • The fourth item configures a template's parameters. If parameters have already been defined in TemplateData, this area displays them in a list. If the template's source code specifies parameters for which no TemplateData exists, you may see a button labeled "2件の提案パラメーターを追加". The editor extracts these suggestions from the template's source code by looking for {{{parametername}}} or {{{parametername|}}}. Clicking "2件の提案パラメーターを追加" will add these parameters using their names as defined in the source code. A green notice will also appear at the top, for example, "2 個の引数が新たに取り込まれました: names of parameters".
  • 編集窓のいちばん下に「引数を追加」ボタンがあるはずです。これを使うと手動でパラメータを追加でき、自分で選んだ名前でカスタム化できます。

次の段階として、このリストにあるパラメータをどれでもクリックしてください。するとパラメータの情報を編集できます。

テンプレートデータ編集ツールのスクリーンショット。2番目のパラメーターが追加されているサンプル

前述の機能もその効果も全て、#パラメータの名称の節に解説しました。

  • The TemplateData editor will not allow you to change a parameter to a blank "名前". Parameters in TemplateData that somehow acquire blank strings as names will not cause issues in the 2010 wikitext editor with TemplateWizard, but neither VisualEditor nor the 2017 wikitext editor will display them at all. This is the only mandatory field in the TemplateData editor.
  • 「引数情報を除去」をクリックすると、パラメーター自体と説明文を TemplateData から削除します。その直後に「X」を押さない限り、後から取り消しもTemplateDataへの削除内容の回復も不可能です。「適用」を押した場合は、Ctrl+Z で取り消せます。
  • 変更を記入して TemplateData の編集画面から出ると、警告が表示されて変更点を破棄するかどうか質問されます。

編集を終えたら、「引数情報を除去」をクリックしてください。 するとページの最下部、‎</noinclude> タグの直前に TemplateData が自動で挿入されます。あるいはページ状に既に存在するなら、その TemplateData を上書きして更新、記入された位置は維持されます。 TemplateData の記述内容は、やはり「引数情報を除去」ボタンを押した時に反映されます。

TemplateData エディタは TemplateData の最下部に、パラメーターの "paramOrder" を作成 (もしくは既存であれば更新します)。 "paramOrder" には TemplateData エディタに表示される順序にしたがい TemplateData パラメータを並べてあります。 You can change the "paramOrder" by dragging the parameters up and down in the TemplateData editor using the three horizontal bars on the left. "paramOrder" and its effects are described here.

その後、「保存」ボタンを押してページの改訂箇所を保存します。

手動の処理

代替の方法として、手動でTemplateDataの追加や編集ができます。状態によってはこの方法を使いたい、もしくはそれしかない場合もあるかもしれません。 テンプレートデータの構造は JSON 標準に基づいているものの、利用者は JSON がわからなくても TemplateData を配置できます。 テンプレートデータは複数の非常に簡単な規則に従い、40、50件の事前に定義されたパラメーターと値に限定して対応し、通常は "parameter": "value" の書式に従います。

TemplateData を手動で追加する

事前準備:

  • テンプレートの説明文書下位ページにTemplateData を記入する場合、当該ページのどこに配置してもかまいません。ご利用の言語版で通例となる配置場所がないかどうかご確認ください。たとえばウィキペディア英語版だと、TemplateData の配置は通常、説明文書ページの最下部です。ドイツ語版ならページ最上部です。
  • テンプレートのメインページに TemplateData を追加する場合 (処理は避けるべき理由は#Prior checksをご参照)、きちんと ‎<noinclude>...‎</noinclude> タグで囲んだかどうか十分に留意する必要があります。

まず初めに、対象ページで「編集」編集ボタン または「ソースを編集」ソースを編集ボタンを押し、次に開いた編集窓で TemplateData を追加する箇所を表示させたら、見出しを「TemplateData」などと記入します。

ウィキの多くはテンプレート {{TemplateData header}} を採用し、TemplateData に関する短い通知を追加します。もしお使いのウィキでもそうであれば、目次の次の行に後者を追加してください。

TemplateData の書き初めは、改行して開くタグと閉じるタグとして‎<templatedata>とその内側に半角の波カッコで挟み、改行して次のセットを記入します。

<templatedata>
{

}
</templatedata>

次に、空行に弓カッコ2個を書き、インデントを挟みこんでからパラメータの記述をはじめます。パラメータごとの詳細は#TemplateData parametersの節をご参照ください。ほとんどはオプションですが、中には強く推奨されるものもあります。

パラメータの記入の順序は決まっていないものの、 TemplateData 解説文書に登場する順序に合わせ、編集者の使いやすさを優先すると、次の順序です。

<templatedata>
{
    "description": "",
    "format": "",
    "params": {
        "parameter1": {
            "aliases": ["",""]
            "label": "",
            "description": "",
            "type": ""
        }
    },
    "paramOrder": [
    	""
    ]
}
</templatedata>

またパラメータの順序は、たとえば"params"オブジェクトでそのオブジェクト内に置かれていることを確認します。ない場合にはエラーが発生して保存時に「予期しないプロパティ」というメッセージが表示されます。

クリーンアップ用のテンプレートを想定すると、サンプルとなる TemplateData を例示します。 このテンプレートは通知を表示するもので、ソースコードの設定により、当該ページはテンプレート入力時点の年と月に合わせて日付付きのカテゴリに分類されます。 通知には指定により、トークページの特定の節へのリンクを書くことができます。その場合、TemplateData の見た目は例えば次のとおりです。

<templatedata>
{
	"description": "Use this template to indicate that an article is in need of cleanup.",
	"format": "inline",
	"params": {
		"date": {
			"label": "Month and year",
			"description": "The month and year that the template was added",
			"type": "string",
			"autovalue": "{{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}",
			"example": "January 2013",
			"suggested": true
		},
		"reason": {
			"aliases": ["1"],
			"label": "Reason",
			"description": "The reason the article is in need of cleanup",
			"type": "string"
		},
		"talk": {
			"aliases": ["talksection"],
			"label": "Talk page section",
			"description": "The section of the talk page containing relevant discussion",
			"type": "string"
		}
	},
	"paramOrder": [
		"date",
		"reason",
        "talk"
	]
}
</templatedata>

対応する TemplateData 解説ページの表示を以下に例示します。

Use this template to indicate that an article is in need of cleanup.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Month and yeardate

The month and year that the template was added

Example
January 2013
Auto value
{{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}
Stringsuggested
Reasonreason 1

The reason the article is in need of cleanup

Stringoptional
Talk page sectiontalk talksection

The section of the talk page containing relevant discussion

Stringoptional

TemplateDataのパラメーター

TemplateData に用意された全てのパラメータは、以下に列挙して説明と例を示します。 これらに詳しい技術情報を添えてExtension:TemplateData#Format節にも一覧にしてあります。

  • この情報は2021年11月時点で現状に即しており、パラメータの新規追加あるいはテンプレート編集インターフェイスの更新により、既存のパラメータを維持したり、特定のパラメータの扱い方が変わったりします。
  • ウィキ マークアップは解説やラベルでは動作しません。 平文のみの文字列しか受け付けません。
  • New lines ("\n") in descriptions, labels, examples or defaults will not show in any of the main editors (TemplateWizard, VisualEditor or the 2017 wikitext editor), even though they show in the auto-generated TemplateData documentation. They are replaced by a null string in input forms and by a space elsewhere.
パラメーター 説明
description

"description"パラメータはテンプレートの役割を説明します。 オプション、ただし強く推奨されます。

効果

テンプレートの解説ページには、「Template data for [テンプレート名]のテンプレートデータ」という見出しに続いて平文で説明が書いてあります。

主流のどのエディタでも (VisualEditor 2017年版ウィキテキストエディター TemplateWizardを有効にした同WikiEditor )、説明文は主な例2件を記述します。

  • 利用者がテンプレートを検索した場合、検索候補それぞれの次の行に表示
  • テンプレート編集機能のテンプレート名の下にあり、テンプレートのパラメータに値を付与します。

VisualEditor および2017年版ウィキ文エディタでは、検索候補ごとに説明文をおよそ半角50文字前後に短縮して表示して「...」を添えますが、テンプレートの編集ウィンドウでは解説文書の全文を示します。 どちらもグレーの文字で表示されます。

テンプレートのエディタのメインの窓では、説明が4行よりも多いと (半角で 540 文字前後)、スクロールバーが出現し、表示文字は黒色になります。

指定しない場合

説明するパラメータが存在しない、もしくは指定がない場合は、TemplateData 説明ページの小見出し「[template name]のテンプレートデータ」以下に「説明はありません。」と表示されます。 そのほか:

  • これは VisualEditor および2017年版ウィキ文エディタでは、まるで TemplateData のないテンプレートと同様の挙動をし、説明文書ではなく以下の文字列を表示します。
The "Template:Templatename" template doesn't yet have a description, but there might be some information on the template's page.
  • 2010年版ウィキテキストエディタでTemplateWizardを使うと、解説文の表示の代わりに次の文が表示されます(ただし検索結果の候補欄を除外。)
「このテンプレートには説明文書がありません。」
TemplateData が存在しない場合、この部分は標準のプレースホルダの説明と次のように異なります。
  • 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節をご参照ください。

このパラメータはオプション、ただし強く推奨されます。 このパラメータがない場合の既定の挙動は、インラインの書式設定となり、TemplateData 説明ページにある表の見出しの下には、対応する通知は表示されません。

効果

インライン:

パラメーターを "inline" に設定すると、テンプレートによって個人設定に対応する通知を TemplateData 説明文書に表示します。表示位置は表の見出し テンプレートの引数 の直下で、次のような表現が作成されます。

{{int|quotation-marks|[<translate>circles and pipes icon</translate>] {{int|templatedata-doc-format-inline}}}}

挿入すると、テンプレートの作用でウィキテキストが1行にレイアウトされ、要素と要素の間に半角アキが入りません。以下の例をご参照ください。

{{Foo|bar=baz|qux=quux}}

ブロック:

パラメータを "block" に設定すると TemplateData 説明文書に、テンプレートによって次のような表現が作成されます。

{{int|quotation-marks|[<translate>stacked blocks and pipes icon</translate>] [[int|templatedata-doc-format-block}}}}

挿入すると、パラメータはテンプレートの作用で1行に1こずつ配置され、要素と要素の間に半角アキが入ります。以下の例をご参照ください。

{{Foo
| bar = baz
| qux = quux
}}

特別な書式:

別の方法として、パラメータに一式の特定のウィキテキストを指定した場合、#Custom formats欄の仕様に従うなら、そのテンプレートのTemplateData 解説文書に個人設定の通知が表示され、例文は以下のとおりです。

"[<translate>cogwheel icon</translate>] {{int|templatedata-doc-format-custom}}"

挿入すると、テンプレートはウィキテキストを指定のウィキテキストとしてレイアウトします。

"format": "inline"
params

"params" オブジェクトには、テンプレートに使うパラメータを網羅して情報を示します。これは必須であり、個々のパラメータは#Within params(パラメータに含むもの)節を参照してください。

それぞれのパラメータの名前に続けて一式の TemplateData のサブパラメータを#パラメータの名称節から拾って付与します。

複数のパラメータがある場合は、閉じる波カッコごとに半角カンマ「,」(区切り子)で区切って 並べますが、最後の閉じる波カッコ1ヵ所の後には区切り子を入れないでください (例を参照)。

"params": {
    "parameter1": {
        ...    // パラメーター情報
    },      // このカンマを見落とさないこと
    "parameter2": {
        ...    // パラメーター情報
    },      // こちらにもあります:
    "parameter3": {
        ...    // パラメーター情報
    }       // ただしここにはありません
}
paramOrder

"paramOrder" オブジェクトはオプションとしてテンプレートエディタに加えると、テンプレートのパラメータの表示順序を規定します。

使い方

使い方を説明すると、パラメータ "paramOrder"を書き入れ、その直後に半角コロン「:」半角アキ、開く半角角カッコ「[」を記入すると有効になりますので、引用符内(")にテンプレートのパラメータ名を好きな順番で半角カンマ「,」で区切って入力します。 最後に、作業を終えるため閉じる半角角カッコ「]」を記入します。

パラメータは改行しないまま記入して大丈夫 ("paramOrder": ["param1","param2","param3"]可能) ですが、改行してから書いたほうが、読みやすいことは確かです。

TemplateData エディタの挙動と同様、"paramOrder"は必ず"params"の後に置くよう推奨されます。注意点は TemplateData 解説文書には記載がないものの、パラメータの並び順を強制的に決めるからです。 将来の編集者には、わざわざ"paramOrder"よりも下までスクロールするより、パラメータの細部をざっとチェックしてから編集したいと考える人もいるかもしれませんし、特にパラメータが多数ある場合にはありがちだからです。 記入する位置を TemplateData, の最下部にせず、他の場所を選ぶならば、一連の文字列の終わりに必ず半角カンマを入力してください。

TemplateData 内に記述した全てのパラメータをここに書き込みます。さもないと「必須のプロパティ「必須のプロパティ名」がありません。」のエラー警告が表示されます。

指定しない場合

Without "paramOrder", the template's parameters will display in the order in which the template's source code declares them. If the source code contains objects inside objects, the parameters in outer objects will come first, followed by inner objects.

他のパラメータの場合

2010年版ウィキ文エディタで TemplateWizard を有効にした場合。

  • "required" parameters always appear at the top, regardless of the order in "paramOrder".
  • "suggested" parameters will always appear second, above "optional" ones.
  • "deprecated" parameters won't appear at all in this editor; see the description of "deprecated" for more info.
  • "paramOrder" はこれらのカテゴリ間でのみ順位を強制し (つまり "required"パラメータはすべて"paramOrder"で指定した順序に並び、"suggested"パラメータはすべて同様に配置されるものの、全"suggested"パラメータは"required"パラメータのグループより下に表示されます。)

"paramOrder"は VisualEditor および2017年版ウィキ文エディタではパラメータの状況に無関係に順序を強制的に配置します。

"paramOrder": [
	"date",
	"reason",
	"talk"
]

パラメータに含むもの

パラメーター 説明
引数名
params オブジェクトの最上位レベルの項目のみ、テンプレートのパラメータ名に採用されます。

たとえばテンプレートのソースコード内に {{{date}}} がある場合、これを"date"と命名して "params" の配下に置きます。

表示されるパラメータの名称が {{{1}}} その他の数字の場合があります (そららの TemplateData 名はたとえば "1" となります。) これに似たパラメータの挙動は、利用者がテンプレートを挿入しようとすると変数名と等号の記入を阻害します (つまり|parametername=value|ではなく |value|)。 複数の名無しパラメータがある場合、添えた数字はどの項目名のないパラメータを指し示すか識別します。 一例として、次の記述の場合です。

{{example template|value1|value2}}

value1はパラメーター{{{1}}}の値、value2はパラメーター{{{2}}}の値です。 その方向に合わせて TemplateData のパラメーターをきちんと解説してください。

注記:利用者が{{{1}}}ではなく強制的に{{{2}}}を使用させることは可能で、それには地の文にウィキテキストで「|2=」と入力、またはテンプレートのエディタにパラメータ「2」と記入します。 Finally, note that "aliases" creates alternatives to the parameter name which can be used interchangeably, and "label" replaces the parameter name in the user interface with the specified label (for situations in which the parameter name is not human readable or easily understood).

使い方

これらの「引数名」オブジェクトには個別にパラメータの情報一式を書く必要があり、形式はさらに TemplateData パラメータで表現します。 下記の節「パラメータの名称」(Within a parameter's name) には、一覧があります。

"1": {     // パラメータの名前
    ...    // パラメータに関する情報はここに。
}

パラメータの名称

パラメータ 説明
aliases

"aliases" パラメータはオプションの項目で、特定のテンプレートに複数の名称があるとき使います。 テンプレートのソースコードを開いて確認するには、次の文字列を探します。

{{{parameter1|{{{parameter2}}}}}}

or

{{{parameter1|{{{parameter2|}}}}}}

これはつまり、これらのパラメーターのどちらかに利用者が値を記入すると、同等の関数を実行します。 文字通り訳すなら、「parameter1 の値。パラメーター1が存在しないもしくは値がある場合: parameter2 の値」となります。 2番目の事例では、意味するところは「parameter2 がないもしくは値が定義してある場合、値は無視されます」です。

使い方を説明すると、パラメータ "aliases"を書き入れ、文字列"aliases"の直後に半角コロン「:」半角アキ、開く半角角カッコ「[」を記入。続けてパラメーターの別名を引用符内に半角カンマ「,」で区切って入力します。 最後に、半角角カッコ「]」を記入して作業を終えます。

"aliases": ["1", "talk", "talksection"],
inherits

"inherits"パラメータはオプションで、他のパラメータの TemplateData をすべて継承させる場合に指定します。 これも上書き可能で、それにはパラメータ継承を指定したどのパラメータでも使えます。

このパラメータを使うには、"inherits" : と入力し、"talk" または "1"などその他のテンプレート・パラメータの名称を続けて記入します。 続けて必要であれば、その下に別の特定の設定、例えば"label" : "A different label"を記入します。 1番目のパラメータは、2番目のパラメータのプロパティをすべて継承しますが、除外されるものは次のとおりです。

    "params": {
        "トピック1": {
            "label": "トピック",
            "description": "曖昧さ回避ページにあげたトピック",
            "type": "string"
        },
        "トピック2": {
            "inherits": "トピック1"
        },
        "トピック3": {
            "inherits": "トピック1",
            "label" : "A different label"
        }
    }
label

次の"label"に人間が読めるパラメータのタイトルを指定すると、テンプレート編集ツール内に表示します。 常にパラメータ本来の名称の代わりに項目名が表示され、ウィキ文内で別名を記した場合も同様です。 このパラメータはオプション、ただし強く推奨されます。

"label": "年と月",
description

ここで言う "description" の箇所とはテンプレート全体の説明ではなく、パラメータの説明です。 This description appears below the parameter name (a long descriptions will be shortened with a button to optionally expand it). オプション、ただし強く推奨されます。

"description": "テンプレートが挿入された年と月",
type

See the [[<tvar name=1>#Type parameter</tvar>|#Type parameter]] section.

default

テンプレートの特定のパラメーターには特定の既定値を保持します。利用者が変更しない限り、その値が使用されます。 項目"default"はオプションで、解説文書内に限定して存在する既定値を利用者に示すために使います。 値は必ずしも既定値と一致する必要はなく (実際に存在したとして)、関数に影響しません(Not to be confused with "autovalue", which is a functional parameter that fills in a field for the user.)

効果

主要なエディタすべて (VisualEditor、2017年版ウィキ文エディタならびに2010年版のウィキ文エディタで TemplateWizard を有効にした場合) では、編集対象のパラメータの設定値が空の場合、入力ボックス内に "default" の文字列をグレーで反転表示し、その書式は "Default: default text" です。 さらに加えて、パラメータ解説文にも平文の黒字で表示されます (利用者が丸付き「i」マークにカーソルを合わせとき。) これは VisualEditor および2017年版ウィキ文エディタの場合は指定により、パラメータの説明の下部で「欄の記入は 必須もしくは「欄は非推奨」の直下 (2010年版ウィキ文エディタでは非表示) で「」がある場合はその上に配置します (2010年版ウィキ文エディタのパラメータ解説では "example" は非表示。) 2010年版ウィキテキスト・エディターでTemplateWizardを利用すると、パラメータの説明の直後、同じ行に半角スペースを挟み、"default" のテキストとして表示します。 他のエディターを使った場合と同じ見た目で表示します("Default: default text"。)

他のパラメータの場合

その他のどのエディター (VisualEditor、2017年版ウィキテキスト エディター、TemplateWizardを有効にした同2010年版) でも、"default" を指定した場合には "example" の値は入力ボックスに表示されません。

"default": "Category:CommonsRoot",
autovalue

A parameter can be assigned an "autovalue". When a user adds the template to a page, this value will automatically appear in the input box. For example, many cleanup templates need the date added; setting the "autovalue" for the template's date parameter to be {{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}, the month and year that the template was added will be filled in automatically.

This value can be overwritten by the user in the template editor.

他のパラメータの場合

その他の主流のエディター (VisualEditor、2017年版ウィキテキスト エディタならびにTemplateWizard を有効にした同2010年版) では、"autovalue"は2017年版ウィキテキスト エディターと VisualEditor では"url"の視覚効果を上書きします。 詳細は"type"の説明文書をご参照ください。

"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
example

The "example" parameter is optional and documentary only; its value contains an example that helps the template's user understand the correct way to fill in the parameter (not to be confused with "suggested"; see that entry for more information).

効果

主流のどのエディタ (VisualEditor、2017年版ウィキテキスト エディタならびに TemplateWizard を有効にした同2010年版) でも、このプロパティはパラメータ説明 (指定がある場合は"default"文) の直下に表示されます。

他のパラメータの場合

主流のどのエディタ (VisualEditor、2017年版のウィキテキストエディタ、TemplateWizardを有効にした同2010年版) でも、"default"を指定した場合には "example" の値は入力欄に表示されません。

"example": "January 2013",
required

続いて "required" があります。truefalse のどちらか一方を設定できます。 指定しなければ、false とみなされます。

このテンプレートにとって当該のパラメータ記入が必須かどうか定義します。

効果

この状況は VisualEditor および 2017年版ウィキテキストエディター にいくつかの影響を与えます。

  • it displays the parameter automatically when a user inserts the template;
  • it shows a black asterisk within the input box, on the right;
  • パタメーターの説明の下の行に、「このフィールドは必須です。」とグレーの斜体で表示します。
  • 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 WikiEditor with Extension:TemplateWizard , as in the other editors, it displays the parameter automatically when a user inserts the template, but the parameter cannot be removed using this or any editor. パラメーターの説明に「このフィールドは必須です。」とは表示しません。代わりに欄外に「必須の引数」という見出しの下にリストします。 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".

他のパラメータの場合

"deprecated" のステータスに設定した場合、2017年版ウィキテキストエディタと VisualEditor では、このパラメータの機能性を上書きしませんが、 TemplateWizard を有効にした同2010年版では上書きされます。 詳細情報は "deprecated" の説明文書を参照してください。

"required": true
suggested

続いて "suggested" は、truefalse のどちらか一方を設定します。 指定しなければ、false とみなされます。

Use "suggested" for parameters that are not mandatory but strongly recommended for template users to provide. When filling in this parameter, a user will see this suggestion.

効果

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. それ以外の目に見える効果はなく、その他の文字列や警告は表示されません。

In the WikiEditor with TemplateWizard, it does not place the parameter in the template automatically but instead causes it to be listed on the side under "推奨される引数". The user can then click a "+" next to the parameter to add it to the template.

他のパラメータの場合

主要なエディタすべてで、この状況の機能性よりも "required" が優先されます (VisualEditor、2010年版および2017年版ウィキ文エディタ。) 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"truefalse、または代わりにすべきことの説明を設定します。 指定しなければ、false とみなされます。

これはパラメータの使用が既に推奨されないものの、いまだに存在していることを示すものです。 この現象は、テンプレートを使用は するパラメータの組み合わせが変更された場合に起こりえます。

効果

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 "以下の理由によりこのフィールドは推奨されません。deprecation reason" is shown below the parameter description. It does not affect the functionality or usability of the parameter or show any additional warnings.

文字列を入れるという現実に対し、2020年1月時点で主要なエディタのどれも (VisualEditor、2010年版もしくは2017年版ウィキ文エディタ) 利用者に対して文字列の内容を表示しません。 Inputting a string has the same effect as true.

2010年版ウィキ文エディタで TemplateWizard を有効にした場合でも、この値を true に設定してもパラメータの追加あるいは表示はできません。

他のパラメータの場合

これと "suggested" の両方を true に設定すると、TemplateData 説明文書のパラメータの状況は "deprecated" となるものの、VisualEditor および 2017年版ウィキ文エディタでは両方の機能とも有効に保たれます。利用者がテンプレートを挿入するとパラメータが自動で表示されますが、"deprecated" の警告を伴います。

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.

TemplateWizard を有効にした2010年版ウィキテキストエディタで "deprecated" を指定すると、"required" および "suggested" の指定を上書きします。

"deprecated": "代わりに「publicationDate」を使用してください。"
推奨値

The parameter property suggestedvalues lets you define a list of parameter values to be shown to VisualEditor users in a dropdown for easy selection. This can be done either directly in JSON or using the TemplateData editor (no coding required). パラメータのうち、以下のオプション (reference) を設定すると、 VisualEditor で推奨値を表示できます。

  • content
  • line
  • string
  • number
  • unknown
  • unbalanced wikitext

その他のタイプ (file, page, template, user, date, boolean, URL) は現状ではサポート外です。理由は VisualEditor 側で既に一定の機能を割り当て済みのためで、たとえば自動補完などは VisualEditor を使用すると、推奨値のドロップダウン・メニューと衝突してしまいます。

TemplateData の編集は JSON でウィキテキスト形式で実行

パラメータのタイプを問わず推奨値を加えるには、JSON に新しいプロパティ "suggestedvalues" を記入します。また “suggestedvalues” 属性は必ず文字列の一覧にします。

Editing TemplateData with the TemplateData Editor

  1. Click on "テンプレートデータを管理".
  2. 推奨値を追加したいパラメータ名をクリック。
  3. 未処理の場合は、パラメータのタイプを以下のどれかに設定します。content, line, string, number, unknown, unbalanced wikitext。新しい入力欄「Suggested values」(推奨値) が表示されるはずです。パラメータが既に上記のいずれかに設定してある場合は、入力欄は既に画面上にあるはずです。
  4. スペースも特殊記号も含め、おすすめの (複数の) 値を入力します。

Effects

TemplateData に値を指定すると、VisualEditor で上述のパラメータのタイプの場合、コンボ・ボックスに表示します (ドロップダウンの一種で利用者が好みの文字列を入力できるもの)。利用者は表示された値の一覧から好きなものを選んでクリックします。その一覧が長い場合 -- 例えば特定の国の州の名前全部など -- 入力欄に目的の値を入力すると、文字入力と連動して一覧にフィルタがかかり、入力文字に適合する値にしぼり込みます。入力した文字を変更するには、まず入力値を消去します。すると、いったん消えたドロップダウンメニューが再表示されます。もし利用者が求めている値が一覧に掲載されていない場合は、て入力します (例えば「message in a bottle」。)

	"suggestedvalues": [
		"Journal",
		"Book",
		"Newspaper",
		"Magazine"
	]

注記:特定のパラメータに関して "required" "suggested" "deprecated" のどれも true に設定されていない場合、ステータスは TemplateData 解説文書に "optional" として表示されます。

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

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

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

type パラメーター

そのあとは"type"パラメータの役割は、テンプレートエディタに、そのパラメータ値の解釈を伝えることです。 テンプレート編集機能は場合により、特定のパラメータに限定して TemplateData 値に適合するように UI を補修しており、例えば利用者が入力できる有効な値を指定のタイプに限定するなどです。 このパラメータには、テンプレートのパラメータもしくはその設定値に影響する機能はありません。テンプレート編集者が編集モードでどう表示するか、パラメータをどう扱うか指定するのみです。

使い方

これを使用するには "type" パラメータを追加し、その後にコロン+スペースを足してから、下記の表にある引用符で挟まれた値のどれかを選んで記入します。

例:

"type": "string",

効果

2020年2月時点でTemplateWizard が全13件の変数種別のうち8件を表示したのに対し、VisualEditor および2017年版ウィキ文エディタは5種のみでした。

特定の入力値は、それに対応するテンプレートエディタ機能の更新に従って効果が変わる場合もあります。VisualEditor ならびに 2017年版ウィキテキスト エディタの場合、そのような影響は Phabricator タスク T55613 で追跡しています。同様のサポートをするには TemplateWizard が真偽値に対応する必要があり、T200664 で追跡しています。

現在の既知の問題は以下にまとめてあります。

Value 説明
unknown

"unknown" の値は、タイプを指定しない場合の既定値です。手動でも指定でき、"type": "unknown" と入力します。

効果

その他の主流のエディタ (VisualEditor、2017年版ウィキテキスト エディタならびに TemplateWizard を有効にした同2010年版) では、TemplateData のないテンプレートと比較した場合、"unknown" は目に見える効果がありません。

number

"number" の値は数値を対象としており、負の数値や小数も含みます。

効果

  • VisualEditor と2017年ウィキテキスト エディタを使うと、"number"は見た目に影響を与えません。
  • TemplateWizard を有効にした2010年版ウィキテキスト エディタ では、"number"の影響で入力欄に「+」と「-」ボタンを欄の左右どちらかに表示し、利用者が入力欄に記入できる数値が増えたり減ったります。 ボタンを押すと数値を負の数値に変換できます。

他のパラメータの場合

  • TemplateWizard を有効にした2010年版ウィキテキスト エディタ では、"number""autovalue" を上書きします。パラメータ値が "number" の場合、入力欄に "autovalue" が自動で記入されません。
string

"string" の値は平文の文字列を対象にします。

効果

その他の主流のエディタ (2017年版ウィキテキスト エディタ、TemplateWizard を有効にした同2010年版ならびに VisualEditor) では、"unknown" と比較して "string" には目に見える効果がありません。

line

"line" は強制的に1行に収めるべきコンテンツを対象とします。

効果

  • VisualEditor ならびに2017年版ウィキテキスト エディタではパラメータの入力欄に通常は新しい行が記入できるのに、"line" によって追加できなくなります。
  • TemplateWizard を有効にした2010年版ウィキテキスト エディタでは、"line" には目に見える効果がありません (このエディタは既定で入力欄に改行を許しません)。
boolean

真偽値 "boolean" は値が true、false、unknown でも対象とします。これをマニュアルには「1」「0」もしくは空白値と説明してあります。

効果

2020年2月時点で、主流のウィキメディアエディタ(2017年版ウィキテキスト エディタと TemplateWizard を有効にした同2010年版と VisualEditor) のいずれも、この値を使っていません。目に見える効果はありません。

チェックボックスautovalue:0が VisualEditor に表示されると、オンとオフの切り替えができます。

date

日付値 "date" の書式は YYYY-MM-DD (ISO 8601) 形式とします。例えば 2014-05-22 と書きます。TemplateData マニュアルには ISO 8601 日付時刻の組み合わせ、例えば「2014-05-22T16:01:12Z」などにも対応すると記されていますが、February 2020年2月時点で実際上は主流の編集インタフェースで後者の書式は使っておらず、ウィキメディアのテンプレートのパラメータ類はほぼ全て日付と時刻を個別の変数として受け取ります。

効果

  • VisualEditor と2017年版ウィキテキスト エディタを使うと、"date" は見た目に影響を与えません。
  • 2010年ウィキテキスト エディタに TemplateWizard を組み込むと、パラメータ値の入力ボックスの幅は3分の2に縮まり、日付値"date"がドロップダウン表示のカレンダーを追加するので、利用者はそこから入力する日付を選べます。また入力ボックスにグレーの文字で「YYYY-MM-DD」と記入の書式を示します。この標準形を守らない日付を入力すると入力欄が赤くなり、それでもエディタは (入力値が数字だと) 常に標準形に適合する書式で日付を出力、または何も出力しません (文字列のみを入力したか何も入力しなかった場合。)

他のパラメータの場合

  • TemplateWizard を有効にした2010年版ウィキテキスト エディタ では、"date"は自動値"autovalue"の指定を上書きします。パラメータの種類が"date"の場合、入力欄に自動値"autovalue"は自動入力されません。
url

"url" の値はURLアドレスを、インタネットプロトコル (例「https://」や「//」) ごと対象にします。

効果

  • 2017年版ウィキテキストエディタとビジュアルエディタの場合、"url" で入力欄の左側に外部リンクのアイコンを表示 (四角い枠入りの矢印)、もし入力欄以外をクリックした際に有効なインターネットプロトコルを含む URL と文字列 (例=「https://」、「ftp://」や「//」) を未記入の場合は、入力欄自体が赤く表示されて警告します。 この2番目の効果に似ている「required」設定では、有効な URL を未入力のままテンプレートを挿入しようとしても、警告は発しません。 表示はどの設定でも行います (例えば「suggested"」か「deprecated」でも)。
  • 2010版ウィキテキスト エディタでは、TemplateWizard を有効にすると"url"の効果は目に見えません。

他のパラメータの場合

  • 2017年版ウィキテキストエディタとVisualEditor の場合、"autovalue""url"の視覚効果を上書きします。つまり両方を有効にすると、入力ボックスには URL アイコンも表示せず、有効な URL を未記入のまま入力欄を離れても警告の赤色表示になりません。
wiki-page-name

"wiki-page-name" の値はそれぞれのウィキのページ名を対象にします。

効果

主流のエディタにおいて (2017年版ウィキテキストエディタならびにTemplateWizard を有効にした同2010年版、VisualEditor)、"wiki-page-name" によりパラメータの入力欄に選択肢のドロップダウンメンニューが加わり、テンプレートのリストからどれか選ぶことができます。 名前空間も検索で定義できます。 このほか、VisualEditor ならびに2017年ウィキテキスト エディタでは、入力ボックスの内容は強制的に折り返しのない1行に表示されます。 それ以外の目に見える効果はなく、ページ名以外の入力を阻止しません。

wiki-file-name

"wiki-file-name" の値はファイル名が対象で、特定のウィキにローカルに保存されたか、Wikimedia コモンズにあるかを問いません。

効果

  • 2017年ウィキテキスト エディタ とVisualEditor 使うと、"wiki-file-name"は見た目の影響を与えません。
  • 2010年版ウィキテキストエディタで TemplateWizard を有効にすると、"wiki-file-name" によりパラメータの入力欄にドロップダウンメニューが追加されて画像一覧から選べるようになり、それら画像はローカルのウィキと Wikimedia コモンズの両方からお勧めされます。 The file names do not contain the "File:" namespace prefix. このドロップダウンメニューには、画像ファイルのサムネールも表示されます。 それ以外の目に見える効果はなく、ファイル名以外の入力を阻止しません。
wiki-template-name

"wiki-template-name" の値はそれぞれのテンプレート名を対象にします。

効果

主流のエディタにおいて (VisualEditor、2017年版ウィキテキストエディタならびに同2010年版で TemplateWizard を有効にした場合)、"wiki-template-name" によりパラメータの入力欄に選択肢のドロップダウンメニューが加わり、テンプレートのリストからどれか選ぶことができます。 このほか、VisualEditor ならびに2017年ウィキテキスト エディタでは、入力ボックスの内容は強制的に折り返しのない1行に表示されます。 それ以外の目に見える効果はなく、テンプレート名以外の入力を阻止しません。

wiki-user-name

"wiki-user-name" の値はそれぞれの利用者名を対象にします。

効果

主流のエディタにおいて (2017年版ウィキテキスト エディタならびにTemplateWizard を有効にした同2010年版、VisualEditor)、"wiki-user-name" によりパラメータの入力欄に選択肢のドロップダウンメンニューが加わり、実際の利用者名のリストからどれか選ぶことができます。 このほか、VisualEditor ならびに2017年ウィキテキスト エディタでは、入力ボックスの内容は強制的に折り返しのない1行に表示されます。 それ以外の目に見える効果はなく、利用者名以外の入力を阻止しません。

content

"content" という値は、それぞれのページのコンテンツについて、例えばリンク類や画像、文の書式設定を記述するウィキテキストを対象にしています。

効果

  • VisualEditor と2017年版ウィキテキスト エディタを使うと、"content"は見た目に影響を与えません。
  • 2010年版ウィキテキスト エディタで TemplateWizard を有効にすると、"content"によりパラメータの入力箱の高さが1行分広がって行が追加できるようになり、このエディタの通常の入力欄と異なった挙動となります。
unbalanced-wikitext

値の "unbalanced-wikitext" はウィキテキストのうち単独では、つまり開く・閉じるタグがないと無効なもの、またはウィキテキストの他の部分を参照するものを入力します。

効果

  • VisualEditor と2017年ウィキテキスト エディタを使うと、"unbalanced-wikitext"は見た目の影響を与えません。
  • 2010年版ウィキテキスト エディタで TemplateWizard を有効にすると、"unbalanced-wikitext"によりパラメータの入力箱の高さが1行分広がって行が追加できるようになり、この2010年版エディタの通常の入力欄と異なった挙動となります。

特別な書式

"format"の値を編集するときはカスタム化した書式を作成するものとし、その方法は既に定義のある規則に従いウィキテキストの記号一式を記入することです。

  • {{ - テンプレート開始
  • _ - コンテンツ (例=文字列、整数、パラメータ。) この半角アンダーバーは、特定の値の最小値を文字数で指定し、_______のように連続して使用もできます。 この文字数より少ないと、足りない文字数にスペース(空白)を補います。 これはパラメータ名の後ろに続く等号(イコール)を任意の一意の位置揃えするために使えます (改行に続く新しい行で\nと併用した場合。)
  • | - パイプ記号 (パラメータの区切り記号)
  • = - 等号 (パラメータの値の前に置く)
  • \n またはEnterキーを押す - 新しい行を追加(入力欄にと表示)
  • - スペース (新しい行を字下げするには\nと併用)
  • }} - テンプレート終了

ウィキテキストは最小値{{_|_=_}}以上とし、足りないと文字列の書式が不適切というエラーになります。

使用できる書式の例
目的 書式文字列 出力
インラインの書式設定 {{_|_=_}}
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>

エラー

JSON の構文エラーです。 / JSON 書式の間違い

一連のエラーの原因はビジュアルエディタもしくは2017年テキストエディタで、特定の無効な JSON コードを含む TemplateData (キーまたはパラメータの重複もしくはカンマが足りない・不用など) を、たいがいは手入力で編集して保存しようとした場合が想定されます。

VisualEditor または2017年ウィキテキスト エディタを使った場合は「JSON の構文エラーです。」が、また「JSON 書式の間違い」とはTemplateData GUI エディタを使った場合にそれぞれ表示されます。

These errors can be difficult to detect and come in too many forms to list. The best way to avoid them is to edit template data exclusively with the TemplateData editor; the best way to detect them once they've occurred is to use an external JSON validator, such as JSONLint, which will highlight errors and aid in fixing them.

The 2010 wikitext editor does not check for invalid JSON thanks to an old, unfixed bug (タスク T128029). Pages that contain invalid JSON may throw alarming "内部エラー" messages. To fix these errors, your best bet is to use a JSON validator (see above).

必須のプロパティ「paramOrder(number)」が見つかりません。

このエラーの原因は"params"内のパラメータが"paramOrder"に記述がない場合です。 半角四角カッコ内の数字は、"paramOrder"内に本来、あるべきなのに、そこに書かれてないパラメータを指示します。パラメータが先頭から何番目か示してあるのですが、実際の位置マイナス1で表示されていて、"paramOrder"はアレーだからです。つまり1位が0で始まるため、1は2位などと続きます。

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

修正方法は、"params"に記述したパラメータが全点、"paramOrder"にあるか確認し、記入します。 代替策として、"paramOrder"オブジェクトを除去するとエラーは出なくなります。

プロパティ "paramOrder(number)" の値が無効です。

このエラーの原因は"paramOrder"内のパラメータが"params"に記述がない場合です。 半角四角カッコ内の数字は、"paramOrder"内に記述されているが、本来、そこに書くべきではないパラメータを指示します。パラメータが先頭から何番目か示してあるのですが、実際の位置マイナス1で表示されていて、"paramOrder"はアレーだからです。つまり1位が0で始まるため、1は2位などと続きます。

"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]".

修正方法は、"paramOrder"に記述したパラメータが全点、"params"にあるか確認し、記入します。 代替策として、"paramOrder"オブジェクトを除去するとエラーは出なくなります。

プロパティ "params.parametername.required" の種別は "boolean" になるはずです。

このエラーは"required" (必須)、もしくは"suggested" (推奨) の値を引用符で挟んだ場合に発生します。

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

文字列ではなく真偽値であるため、引用符は不要です。 修正方法は、これらパラメータtrueまたはfalseの前後の引用符を除去します。

プロパティ "format" が取る値は……

もし "format" パラメータは存在するが設定値が "inline" または "block" 以外、あるいは書式ストリングが無効の場合、次のエラーメッセージ「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.

修正するには、"format": 直後の設定値が "inline" もしくは "block" と等しく、また文字のつづりに間違いがないことを確認します。代わりの方法としてウィキ文であること、{{_|_=_}} は最少で、かつテンプレートの障害を防ぐため構文にエラーがないことを確かめ、とくに等号「=」が連続しないか大カッコ記号「{」と「}」のペアが崩れて片方だけ多い・足りない状態ではないかを確認します。カスタム書式の構文の詳細は#Custom formats節をご参照ください。 代替策として、"format"オブジェクトを除去するとエラーは出なくなります。

予期しないプロパティ"parametername "が使われています。

エラーの原因は$2に記述のない$1内にパラメータを定義したからです。 原因はスペル間違いにあります。

<templatedata>
{
    "description": "",
    "format": "inline",
    "params": {
        "1": {
            "label": "",
            "descriptino": "", // <-- spelling mistake
            "type": ""
        }
    }
}
</templatedata>

別の原因としてそのオブジェクトのパラメータではないのに、TemplateData オブジェクト内にパラメータを宣言した場合です。スペル間違いか、上位のオブジェクトの下位に置かれた TemplateData オブジェクト内にそのパラメータを記入していませんか。

一例として、パラメータ"label"をTemplateData のオブジェクト"params"内ではなく、ルートに書いてしまったとします。

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

別の方法として、"params"内のテンプレートのパラメータに想定外のパラメータが含まれる場合、名称はエラー内の"パラメーターparametername." 配下に表示します。

修正方法は、パラメータ名のスペル間違いの修正と、さらにパラメータを正しい位置におくことです。 それに加え、TemplateData オブジェクトに該当しないパラメータを記述していないか確認します。 特定のオブジェクトにどのパラメータが設定されているか、#TemplateData parametersの節をご参照ください。

必須のプロパティ「params」が見つかりません。

エラーの原因は、 TemplateData 内に "params" オブジェクトが1点もないからです。 このオブジェクトは必須であり、パラメータ1個ごとの詳細を含むからです。エラーの修正方法は、オブジェクトを記入することと、スペル間違いの修正です。 "params" パラメータの追加方法は、このページの前述の節をご参照ください。

制限とフィードバック

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

その他のツール

Help:Extension:TemplateWizard
ツールバーのダイアログウィンドウ。テンプレートデータから生成したフォームを使い、テンプレートにウィキテキストを記入するために使用。
TemplateData Wizard
テンプレートデータを生成するツール。インタラクティブなインターフェースを使用。
Skeleton TemplateData generator
テンプレートのソースウィキコードを解読するツール。使用するすべてのパラメータ(引数)を検出し、値が空のドキュメントとパラメータの一覧を出力。
JSONLint
手入力したJSONが正しいかどうか確認するツール。構文エラーの発見に役立つ。