Help:Extension:TemplateWizard

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Help:Extension:TemplateWizard and the translation is 100% complete.

Other languages:
English • ‎dansk • ‎español • ‎français • ‎italiano • ‎polski • ‎čeština • ‎русский • ‎українська • ‎中文 • ‎日本語

テンプレートウィザードとは?

テンプレートウィザード (TemplateWizard) はWikiEditorツールバーにボタンを作る MediaWiki 拡張機能 で、ウィキテキスト にテンプレートを挿入する設定欄をポップアップで表示します。

この拡張機能の使い方は?

  • 編集するページをウィキテキスト翻訳機能で開く (2017年版ウィキテキスト翻訳機能は非対応)
  • テンプレートを挿入する位置にカーソルを置いてから、ツールバーのOOjs UI icon puzzle-ltr.svgアイコンを押す
- TemplateWizard icon.png ジグソーパズルのピースの形
  • 設定用のダイアログ枠が表示される

テンプレートの探し方は?

  • 記入欄にテンプレートの名前を1文字目から入力しはじめると、選択できる候補のリストが表示される。

TemplateWizard help search en.png

  • 注記:テンプレートデータTemplateDataを備えたテンプレートのみ説明を表示。そのためテンプレートにはTemplateDataの記入が推奨される。
  • 目当てのテンプレートが見つかったらクリックして (あるいは矢印キーで) 選択、 Enterキー.を押す。するとデータ入力欄に遷移する。

選んだテンプレートにデータを入力する方法は?

  • 画面上部にテンプレート挿入用メニューバーが現れテンプレート名と説明を表示し、OOjs UI icon link-ltr-progressive.svgボタンでテンプレートのウィキページへ遷移します。バーはOOjs UI icon trash-destructive.svgで閉じ、通常の検索バーが使えるようになります。
  • 挿入指定欄の左半分はパラメータ(属性) 一覧で必須、推奨、オプションの3つに分類されます。欄の一番下にあるボタンを使い、利用しない欄を一括で除去できます。パラメータのないテンプレートはこの欄に何も表示がありません。テンプレートの特定のパラメータをクリックすると右欄に追加できます。
  • 挿入指定欄の右半分は利用者が値を記入するデータ記入欄で、実際にウィキテキストに挿入するテンプレートに反映されます。ウィキページの編集欄に入力されるのは、この欄にあるパラメータに限定されます (欄がある限り値が空でもテンプレートはパラメータとして処理し、パラメータ欄がない場合と異なる結果を出力します)。
  • データ欄の詳細は、テンプレート表示欄の枠外上部にあるアイコンをそれぞれクリックすると参照できます。

TemplateWizard help template en.png

  • テンプレートウィザードが最も効果的に作動するには、対応するテンプレートデータの定義が欠かせません。つまりパラメータの詳細は、既定の値のほか構造化データとして保存されます。(この作業手順の情報はテンプレートデータのヘルプを参照してください。) テンプレートデータの定義がなくてもテンプレートウィザードは有効ですが、一部の機能は制限されます。

下記の2節を使い、テンプレートデータの有無によるモードの違いを説明します。

  • 必要な欄のみ既定で追加
  • 欄の情報をポップアップ表示
  • ウィキのページ名を自動で補足
  • コモンズのファイル名の自動補完
  • カスタム化できる入力欄。日付や複数語からなる文章、数値ほか。

ウィザードをデータと使う

テンプレートウィザードにある7タイプの入力欄はテンプレートデータに定義してあります。

名称[fn 1] タイプ[fn 2] 入力欄 備考
1. 番号 number NumberInputWidget
2. 日付 date DateInputWidget
3. 利用者名 wiki-user-name UserInputWidget
4. ページ wiki-page-name TitleInputWidget ページ名 (ファイル名を含む。)
5. ファイル wiki-file-name TitleInputWidget ファイル名前空間にあるタイトルに限定。サムネイル画像とともに表示。
6. テンプレート wiki-template-name TitleInputWidget テンプレート名前空間にあるタイトルに限定。
7. その他の項目 TextInputWidget その他のタイプを標準のテキスト形式のデータとして表示。文の内容は自由。
  1. テンプレートデータ欄に記入する名称。
  2. テンプレートJSONに使うタイプの種類

テンプレートデータは上記の説明以外にもさまざまなタイプの欄に対応する。タスク T200664に投稿するとよい場合もある。

テンプレートデータを利用せずにテンプレートウィザードを使うには

テンプレートに対応するテンプレートデータがない場合、パラメータの名前を推定してラベルに使い、標準のテキスト記入欄に組みこんで表示します。

注記としてこの一覧には重複や廃止済みのパラメータが混入したり、パラメータによっては載っていない可能性があります。原因はテンプレートの作者が以下の例のようなパラメータ名のブレを生じさせがちだからです。{{{full name|{{{Full Name}}}}}} (パイプ記号の前は小文字で後は大文字という違いに注意)。パラメータにはこうあるべきという定型がしばしばあり、確認するにはそのテンプレートの説明文書を読むしかありません (自作のテンプレートの説明文書を読み直すのなら、そのときにテンプレートデータを記入しませんか、今後の利用者が混乱するのを予防できます!)。

テンプレートを挿入するには?

テンプレートの記入欄に必要と思うパラメータをすべて追加し、値を決めたら (空のパラメータを設定するため値を空にする場合を含む) ダイアログ枠右上の「Submit」ボタンを押すと、その時点でメインの編集ボックスにあるカーソルの位置にテンプレートのウィキテキストが挿入されます。

挿入されるテンプレートの文字列は、テンプレートデータで設定した書式に従います。つまり設定がない場合は地の文と同じ「インライン」書式です。特定のテンプレートに個別の書式を当てることは不可能です (もちろんテンプレートのウィキテキストは挿入後、編集が可能です)。

関連項目