Jump to content

Manual:ファイルページの警告

From mediawiki.org
This page is a translated version of the page Manual:File page warnings and the translation is 62% complete.
  • 利用者
  • システム管理者
  • 開発者
  • 翻訳者
MediaWiki の PDF ファイルページの新機能 - 警告シンボルとポップアップ情報ボックス。

Gerrit change 194565 は、異なるファイル タイプに関する警告をファイル ページに追加するためのフレームワークを作成します。 以下はその実装方法です:

  1. 警告のメッセージを追加します。 最大で 4 つまで設定できますが、そのうち 1 つは必須です:
    1. 'main' - これは警告の本文テキストです。
    2. 'header' - 利用者の注意を引くための警告のタイトル
    3. 'footer' - 警告の説明、例えば「これはすべての PDF ファイルに関する警告であり、この特定のファイルに関するものではありません。」
    4. 'info' - さらなる情報へのリンク用のテキスト。 URL はあとで指定できます。
  2. Create and register a ResourceLoader module with the messages you just created. This will be used to load them onto the client.
  3. 扱おうとしているファイル タイプのために、MediaHandler のサブクラスを作成または見つけます。 ほとんどのファイルは既定で ImageHandler またはそのサブクラスによって処理されます。特定のファイル タイプ用の特殊なハンドラーが存在しない場合は、それを作成できます。
  4. Override the default implementations of the needsWarning and getWarningConfig methods on your MediaHandler class. needsWarning should return true if you want a warning to be used, and getWarningConfig should return an object of the following structure:
return array(
  'module' => 'pdfhandler.filewarning', // The name of the module you created above
  'link' => 'http://example.com', // The link for your link to more information about the problem or solutions
  'messages' => array(
    // The names of the messages you created above
    'main' => '...', 'header' => '...', 'footer' => '...', 'info' => '...'
  )
);

After that, your warning should show up! Report any bugs in Phabricator and we'll get to it as soon as we can.