Hatena::ブログ(Diary)

mooz deceives you

(about 'mooz) ; => "See http://mooz.github.com/index-ja.html"

 | 

October 21 (Wed), 2009

KeySnail 1.0 の新機能「プラグインシステム」を使う

プラグインシステムとは

先日 KeySnail が 0.9 系列から 1.0.x へとバージョンアップしました。その際追加された目玉機能が、このエントリで紹介する「プラグインシステム」です。

まずは次のスクリーンショットをご覧下さい。

f:id:mooz:20091120210105p:image

一見すると Firefox のアドオン管理画面のようにも見えますが、これは KeySnail のプラグインを管理する「プラグインマネージャ」のスクリーンショットとなります。

左の列に現在インストールされている KeySnail のプラグインが並び、その右には選択されているプラグインの説明が表示されます。

プラグインシステムを導入することの利点

これまでもユーザの方が書いたスクリプトをウェブからコピーし自身の初期化ファイル (.keysnail.js) に張り付けることで、 KeySnail を拡張していくことが可能となっていました。

しかし、このようなカスタマイズ方式には次のような欠点があります。

  • 長く利用しているうちに初期化ファイルが肥大化してしまう
    • どの場所にどのような設定を書いたのか分かりにくく
    • ある設定を無効にしたい場合に大変
  • コピーして貼り付けはやっぱり面倒
  • スクリプトのアップデートなどが行えない
  • スクリプトの利用方法などが配布元を見ないと分からない

そこで、今回導入されたプラグインシステムには次のような機能が搭載されました。

  • プラグインの有効 / 無効状態切り替え機能
  • 右クリックインストール機能
  • インラインドキュメント機能
  • アップデート機能

このエントリでは、これらの機能について説明していきたいと思います。

プラグインの有効 / 無効状態切り替え機能

Greasemonkey という拡張機能では、各スクリプトの有効 / 無効状態を切り替えることができますが、 KeySnail のプラグインシステムも同様にして、各プラグインの有効 / 無効状態を切り替えることが可能となっています。

f:id:mooz:20091021221402p:image

インストールはしてみたものの今のところは必要ないかな、という場合などはプラグインを無効にしておけば良いでしょう。

右クリックインストール機能

KeySnail プラグインへのリンクを右クリックすると、次のようにしてコンテキストメニューへ「このプラグインをインストール」という項目が表れます。

f:id:mooz:20091021221346p:image

この項目をクリックすれば次に示すスクリーンショットのようにインストール画面が現れますので、十分に危険性を理解した上でインストールを行うことが出来ます。

f:id:mooz:20091021221322p:image

インラインドキュメント機能

KeySnail プラグインでは E4X という技術を用い、プラグイン内にドキュメントなどのメタ情報を記述することが可能となっています。これは Vimperator プラグインの pluginManager.js にアイディアを得たものです。

f:id:mooz:20091021222557p:image

プラグインマネージャでプラグインを選択すればドキュメントを閲覧することができますので、使い方を調べるときなどにいちいち配布元へと向かう必要がなくなり便利かと思います。

アップデート機能

インラインドキュメントのところで説明したとおり、 KeySnail では E4X という技術を使いプラグインにメタ情報を持たせることができます。

KeySnail はそのメタ情報のひとつである「アップデート URL」というものを用い、プラグインのアップデートを行います。

手順は簡単です。利用者は何も考えずにプラグインマネージャで「更新を確認」するだけ。プラグイン開発者側もプラグインをいじった後、バージョンの部分を変更してアップロードしなおすだけで OK です。

プラグインを使ってみる

プラグインを使ってみたいと思った方は、まず次の URL を右クリックしてファイルへ保存した後、 Firefox へドラッグアンドドロップして下さい。こうすることで最新の KeySnail がインストールされます。

右クリックして「対象をファイルへ保存」

正しくアップデートが行われれば、ステータスバーの KeySnail アイコンを右クリックした時のメニューに「プラグインマネージャ」というものが追加されているはずです。

そこからプラグインマネージャを開き、指示にしたがってお好みのプラグインをインストールしてみてください。

現在私が把握しているプラグイン情報は no title にまとめてあります。プラグインを書いたという方はぜひご一報下さい。

プラグインを書く

出来たばかりの機能ということもあり、現在利用可能な KeySnail プラグインは数えるほどしかないというのが現状です。

そのためにはユーザの皆さんにプラグインを書いてもらう必要があるので、後日「プラグインの書き方」についての記事を投稿する予定です。

トラックバック - http://d.hatena.ne.jp/mooz/20091021/p1
 |