トップ 差分 一覧 Farm ソース 検索 ヘルプ RSS ログイン

BugTrack-plugin/336

ページの作成や編集にはユーザ登録が必要です。

プラグイン設定ページを少しだけ使い易くするプラグイン改造

  • 投稿者: ぐうます
  • カテゴリ: 修正
  • 優先度: 低
  • 状態: 提案
  • 日時: 2007年03月17日 22時59分20秒

 内容

プラグイン設定ページに機能を追加して、プラグインの有効/無効を効率よく判断できるようにするためのプラグイン改造です。

追加される機能

  • プラグイン設定ページの各チェックボックスについて、そのチェックボックスを有効にしたときに Wiki ソース中で使えるようになるプラグインコマンド名[1]を表示します。
  • プラグイン設定ページから、各プラグインコマンド(無効のプラグインも含む)のヘルプ・ドキュメントを開くためのリンクを表示します。
  • admin プラグイン及び core プラグインを無効化できないようにします。(20070501版にて追加した機能)

本改造適用後のプラグイン設定ページ画面例

改造対象ファイル

FreeStyle Wiki 標準添付の plugin/admin/AdminPluginHandler.pm

対応する FSWiki バージョン

  • 本改造は、FreeStyle Wiki 3.6.2 の plugin/admin/AdminPluginHandler.pm に対して実施し、動作確認しました。
  • plugin/admin/AdminPluginHandler.pm は FreeStyle Wiki 3.5.3 〜 3.6.2 で変更が無く、またヘルプ・ドキュメント表示の際に使用する plugin/info/PluginHelpHandler.pm もこの範囲で変更が無いので、少なくともこの範囲のバージョンに対しては適用可能と思われます。

インストール

  • 念のため、オリジナルの plugin/admin/AdminPluginHandler.pm を別名に変更するなどして保存して下さい。
  • 次の 2 つの方法のいずれかにより、改造適用後の AdminPluginHandler.pm をインストールして下さい。
    • 添付ファイル AdminPluginHandler.pm.20070501(500) をダウンロードし、ファイル名を AdminPluginHandler.pm に変更した後、plugin/admin フォルダに保存して下さい。
    • もしくは patch AdminPluginHandler.pm.20070501.patch(457) を オリジナルの AdminPluginHandler.pm に対し適用下さい。
  • 本改造適用後のプラグイン設定ページに表示されるリンクから各プラグインコマンドのヘルプ・ドキュメントを正しく開くため、プラグイン設定ページにて info プラグインを有効にして下さい。

変更履歴

2007-05-01 - AdminPluginHandler.pm.20070501(500)
  • ヘルプ・ドキュメントへのリンクの HTML 出力にて、「&」が「&」になっていなかったのを修正。
  • info プラグインが有効になっていないとき、warning を表示するようにした(ヘルプ・ドキュメントへのリンクにて、info プラグインの機能である action PLUGINHELP を使用しており、info プラグインが無効だとヘルプ・ドキュメントが開けないため)。
  • admin プラグイン及び core プラグインを無効化できないようにした。
2007-03-17 - AdminPluginHandler.pm.20070317
  • 初版

ライセンス

標準添付のプラグインの改造なので、GPL です。

備考

プラグインのヘルプ・ドキュメントは、別ウィンドウで表示するようにしました。同じウィンドウで表示すると、変更したけれど保存ボタンを押す前(適用前)のプラグイン設定ページのチェックボックスの内容が消えてしまうからです。

  • [1]「プラグイン」という用語は、(1)「有効/無効を選択する単位として 1 つのフォルダに格納される、FSWiki に機能を追加するためのファイル群一式」を表す場合と、(2)「Wiki ソース中で記述することにより、(1)の意味でのプラグインにより追加される各機能を呼び出すことができるコマンド」を表す 2 つの場合があり、どちらの意味であるかは通常は文脈から容易に分かるのですが、本ページのように両者が同時に出てくる文脈上では混乱しがちなので、ここでは前者を「プラグイン」と呼び、後者を「プラグインコマンド」と呼ぶことにします。

(※2007-05-31 追記『入門 Wiki』 p.302「プラグイン開発」の項によりますと、(1)を「プラグインパッケージ」、(2)を「プラグイン」と呼ぶのが正しいそうです。不勉強でした。)

 コメント

  • プラグイン名と実際にソースに記述するものが違う場合、迷うことが多かったので助かっています。 - 通りすがり (2007年03月19日 09時02分17秒)
  • 初版にて、ヘルプ・ドキュメントへのリンクの HTML 出力の「&」が「&」になっていなかったのを修正するとともに、少し機能を追加しました。詳細は上記をご参照願います。なお、20070501版はブラシュアップ程度の更新なので、初版で特に不具合ない場合にはそのままご使用いただいても問題ないと思います。 - ぐうます (2007年05月01日 04時20分04秒)
お名前: コメント: