coﾘ・ー・ﾝ＜2nd life

■RDoc をインクリメンタルサーチする greasemonkey スクリプト

http://rails2u.com/misc/rdocincsearch.user.js

今現在、ruby ライブラリのドキュメントは rdoc で生成するのが一般的です。その中のドキュメント生成の方法の一つのフォーマットに html があり、ライブラリドキュメントの Web の公開形式といえば rdoc が生成した html がスタンダードな感じです。また rubygems をインストールすると使える、ローカルで httpd(webrick) を起動してライブラリドキュメントを閲覧できる gem_server も rdoc の html を利用して表示しています。

しかし、rdoc の出力する html は検索ができないので、たくさんのメソッドから必要なメソッドを探すのに苦労します。そんなわけで rdoc を JavaScript でインクリメンタルサーチできるようにする greasemonkey スクリプトを作ってみました。オンラインで公開されてる rdoc から、gem_server の rdoc、http://api.rubyonrails.org/ のちょっと html がカスタマイズされてるような rdoc まで幅広く検索することができます。また クラス名#メソッド名 (Base#render とか) で絞り込んだり、ESC で入力をクリアすることもできます。わりとかなり便利かも。

それとブラウザに依存しないように書いたつもりなので、試してませんが Gecko エンジンじゃないブラウザでも動作するような気がします。

ツイートする

Permalink | コメント(0) | トラックバック(4) | 19:18