WMDE Technical Wishes/Suggested values for template parameters/ja
このページではテンプレートのパラメータの推奨値に関して「テンプレートの操作を簡略化する」という視点から、開発の進捗状態とプロジェクトに関する協議内容を 述べます。この視点について一般情報と、実施するプロジェクトを選んだ背景はこちらのページをご参照ください。
| テンプレートのパラメータ推奨値 | |
|---|---|
| Status | 展開先は全てのウィキ |
| Focus area | テンプレート類 |
| Phabricator | T273857 |
| Responsible | 技術要望チーム |
皆さんからのコメントや質問は、ぜひ協議のページにお寄せください。
説明
ビジュアルエディタを使ってテンプレートにパラメータ値を入力する場合、特定のパラメータにどの値が期待されるか、しばしば一目では把握できないことがあります。テンプレートによっては正解の値が決まっているのに、ユーザーがその値をいつでも確認できるわけではありません。たとえばユーザーが小説に関する記事を編集し、情報ボックスのパラメータ「ジャンル」で分野を指定しようとすると、れを入力すればよいか迷ってしまうかもしれません。犯罪、スリラー、それともミステリーが正しいの？
新しいパラメータ属性 suggestedvalues を使うと、テンプレートを使ったり管理する人は誰もが、特定のパラメータに対応する推奨ちの定義が可能になります。定義すると、それらの値はビジュアルエディタの利用者に対してドロップダウンメニューの形で表示されます。テンプレートを使う人は、パラメータに値を記入するときにドロップダウンの中から適切な値をさっと選ぶことが可能になります。あるいは表示された一覧にない値を入力したい場合は（例えば上図の例ではSci-Fi Crime）、それも選択肢として用意されています。記事によってはカスタマイズした値が必要になる状況があり得るため、推奨値でない物を記入することもできるように考えます。
この方法なら、利用者は期待される値もその正しい書式も事前にわからなくても問題ありません。いちいちテンプレートの解説ページへ行って、どの値をそれぞれのフィールドに記入するか確認する手間もなくなるし、あるいは正しい入力値は何かと考える必要すらなくなるのです。この新機能が特にお役に立つのは、テンプレートの使い方に慣れていない人たちです。
これによりエラーを未然に防ぎ、テンプレートに手動で値を入力する手間を省き、値の書式統一を一定化する効果があります。テンプレートのダイアログに予定している改善の提案と合わせると、値の推奨機能はテンプレート類をビジュアルエディタでもっと使いやすくするはずです。
新しい機能の使い方
新しいパラメータの属性として、 suggestedvalues を指定するとビジュアルエディターの利用者にドロップダウンとしてどのパラメータ値の一覧を表示すことで簡単に選べるようにできます。この機能を使うには、まずそれぞれのテンプレートデータに推奨値類を先に追加しておく必要があります。それには直接、JSON に書き込むか、テンプレートデータ用エディターを使うかできます (後者ならコードが分からなくても大丈夫。) それぞれの詳細は以下に説明します。
テンプレートデータ
パラメータのうち、以下のオプション類を設定すると、ビジュアルエディターで表示する推奨値を追加できます。
- content (コンテンツ)
- line (行)
- string (文字列)
- number (数値)
- unknown (不明)
- unbalanced wikitext (ウィキ文だが不均衡)
現状では、その他の種類 (file、page、template、user、date、boolean、URL) はサポート外で、その理由はビジュアルエディターでそれぞれ、既に自動補完など特別な機能を与えてあるため、推奨値のドロップダウン・メニューと干渉してしまうからです。
TemplateData の編集は JSON でウィキテキスト形式で実行
パラメータの種別を問わず推奨値を加えるには、JSON に新しいプロパティ“suggestedvalues” を記入します。また “suggestedvalues” 属性は必ず文字列の一覧にします。
例を示すならこんな感じです。
"media_type": {
"label": "媒体の種別",
"example": "新聞",
"type": "string",
"description": "その記事を掲載した媒体は？",
"suggestedvalues": [
"定期刊行物・論文集",
"書籍",
"新聞",
"雑誌"
]
}
専用エディターを使い テンプレートデータを編集するには
上記に示したパラメータ値に関しては、推奨値を追加するにはテンプレートデータのエディターを使います。
ステップ1. "Manage TemplateData" をクリック。
ステップ2. 推奨値を追加したいパラメーターの名前をクリック。
ステップ3. パラメータの種類が未設定の場合は、次のどれかに設定：content、line、string、number、unknown、unbalanced wikitext。すると新規の入力欄 "Suggested values" が表示される。先の属性が種別のどれかに設定してあるなら、その入力欄に表示してあるか確認。（訳注：content (コンテンツ)、line (行)、string (文字列)、number (数値)、unknown (不明)、unbalanced wikitext (ウィキ文だが不均衡)。）
ステップ4. 提案された値（複数可）、例えば任意のスペース記号や特殊文字でも良いので、一覧に追加するには Enter を押す。
ビジュアルエディターへの影響
テンプレートデータ (TemplateData ) に値を指定すると、ビジュアルエディター (VisualEditor) で上述のパラメータのタイプの場合、コンボ・ボックスに表示します (ドロップダウンの一種で利用者が好みの文字列を入力できるもの)。利用者は表示された値の一覧から好きなものを選んでクリックします。その一覧が長い場合 -- 例えば特定の国の州の名前全部など -- 入力欄に目的の値を入力すると、文字入力と連動して一覧にフィルタがかかり、入力文字に適合する値にしぼり込みます。入力した文字を変更するには、まず入力値を消去します。すると、いったん消えたドロップダウンメニューが再表示されます。もし利用者が求めている値が一覧に掲載されていない場合は、手入力します (例えば「message in a bottle」。)
現状と次の段階
- 全てのウィキに展開したのは2021年4月29日時点です。