Open main menu

MediaWiki β

ビジュアルエディター/参照ツール

< VisualEditor
This page is a translated version of the page VisualEditor/Citation tool and the translation is 100% complete.

Other languages:
العربية • ‎asturianu • ‎български • ‎català • ‎Cymraeg • ‎dansk • ‎Deutsch • ‎English • ‎español • ‎euskara • ‎فارسی • ‎suomi • ‎français • ‎Հայերեն • ‎Bahasa Indonesia • ‎italiano • ‎日本語 • ‎ქართული • ‎lietuvių • ‎Nederlands • ‎Oromoo • ‎polski • ‎پښتو • ‎português • ‎português do Brasil • ‎русский • ‎سنڌي • ‎slovenščina • ‎svenska • ‎українська • ‎中文

ビジュアルエディターの参照ツール(VisualEditor citation tool)はビジュアルエディターの利用者でもあなたのウィキの出典テンプレートを使うようにするためのツールです。参照ツールを有効化するためにはビジュアルエディターParsoidのインストール、テンプレートの使い方を指定するTemplateDataが含まれている出典テンプレート、ならびにビジュアルエディターと出典テンプレートを関連付けるための.jsonファイルが必要になります。

Contents

出典テンプレートをインポートする

出典機能を使うには出典テンプレートがあなたのウィキのデータベースに含まれている必要があります。新しくインストールされたウィキなど出典テンプレートがない場合、それらを導入する必要があります。最も簡単な導入方法はウィキペディアからコピーすることです。なお、すでに出典テンプレートがある場合は下記の手順を飛ばすことができます。

  1. Extension:ScribuntoExtension:ParserFunctionsExtension:CiteExtension:TemplateDataをインストールします。ウィキペディアの出典テンプレートの大半はLuaというプログラミング言語を使っており(Scribunto拡張機能で使えるようになります)、また同拡張機能のパーサー関数も使っています。Citeは<ref>のタグを使えるようにするための拡張機能です。 これらの拡張機能はウィキペディアの全言語版、並びにウィキメディア財団の全ウィキですでにインストールされています。
  2. ウィキペディアから出典テンプレートを書き出す(Manual:Using_content_from_Wikipediaをご参照ください)。最初はw:en:Template:Cite webw:en:Template:Cite newsw:en:Template:Cite journalw:en:Template:Cite bookの4テンプレートを書き出しましょう。 英語版ウィキペディアなど一部の言語版ではテンプレートの最新版を使うにはLuaモジュールが使える必要もあります。
  3. あなたのウィキのSpecial:Importページでテンプレートをアップロードします(例:http://localhost/index.php/Special:Import )。

テンプレートデータ

参照ツールがテンプレートのデータをビジュアルエディターの欄に読み込むにはExtension:TemplateDataを導入して、各テンプレートでテンプレートデータを指定する必要があります。テンプレートデータを定義する方法、およびテンプレートデータがある/ない場合の表示についてはWikipedia:ビジュアルエディター/TemplateDataをご参照ください。

参照ツールの定義

あなたのウィキでビジュアルエディターの参照ツールを有効化するためにはMediaWiki:Visualeditor-cite-tool-definition.jsonという特別なメッセージを作成する必要があります。これはウィキの間の差が大きく、使いたい機能をカスタマイズする必要があるためです。例えば、あなたのウィキで使われるテンプレートの名前はほかのウィキのそれとは違うかもしれません。

設定メッセージの目的

メッセージ:

  • あなたのウィキにおいて標準の出典で使われるテンプレートを指定します(5つまで指定できます)。
    • ご注意: どのテンプレートにも必ずテンプレートデータが必要です。 指定しなかった場合、かなりわかりにくいシステムになってしまいます。出典テンプレートがまだ使われていない場合は、英語版ウィキペディアからコピーして使うことが多いです。
  • 出典の種類ごとに使いたいラベルを指定します。
    • 標準では"web"、"book"、"news"、"journal"の4種類があります。たとえば、"web"のラベルはMediaWiki:Visualeditor-cite-tool-name-webで指定されます。
  • 出典の種類ごとに使いたいアイコンを指定します。
    • 標準では"ref-cite-web"、"ref-cite-book"、"ref-cite-news"、"ref-cite-journal"の4種類があります。oo-ui-icon-ref-cite-newsといったCSSのクラスを指しており、アイコンはSVGファイルで背景画像として扱われます。

MediaWiki:Visualeditor-cite-tool-definition.jsonの設定メッセージが作成されたら、参照ツールは数分内に使えるようになります。

タイプの追加

もしタイプの追加を考えている場合、開発チームに是非ご連絡ください。助言やアイコン作成などの手助けができるほか、新しく作成されるタイプが全ウィキで定義されるべきか他ウィキと検討することもできます。

タイプを追加する手順:

  1. 作成したいタイプを決める
    • たとえば、データベースへのリファレンスを作成したい場合、そのタイプを"database"と名付けます。
  2. ラベルを作る
    • 例えば、ラベルの名前を"db"にして、MediaWiki:Visualeditor-cite-tool-name-dbで"データベース"というラベルを追加することができます。これはあなたのウィキの言語で記述すべきです。あなたのウィキで複数の言語や文字が使われている場合、ラベルも複数作成する必要があります。
  3. アイコンを作る
    • たとえば、"ref-cite-dbase"というアイコンラベルを作成して、アイコン自体はSVGファイルとしてコモンズにアップロードします。続いて、MediaWiki:Common.cssで"oo-ui-icon-ref-cite-dbase"というアイコンのクラスを作成して、"background-image:url(//upload.wikimedia.org/wikipedia/commons/1/12/VisualEditor_-_Icon_-_Ref_db.svg)"のようにアイコンのURLを追加します。

定義メッセージの例は英語版ウィキペディアポーランド語版ウィキペディアをご参照ください。

トラブルシューティング

Special:VersionではTemplateDataがインストールされていると表示されるにもかかわらず、出典ダイアログに引数欄が表示されない場合、出典テンプレートを編集して、変更点なしで保存する必要があります(いわゆる「空編集」)。 これはTemplateDataが(たとえば、Template:Cite_webではなくTemplate:Cite_web/docに存在するため)参照読み込みされるとき、親テンプレートが編集されるまでTemplateDataがデータベースにロードされないというバグによるものです。タスク T52372もご参照ください。

なお、標準の4テンプレート以外のテンプレートを使用する場合、ユーザー体験はやや違うものとなります。例えば、出典ダイアログにおいて引数の一覧は最初には表示されないが、ボタンを押して引数の一覧を表示させることができます。