=begin

= Ruby Browser for Apollo

* ((<概要>))
* ((<インストール>))
* ((<アンインストール>))
* ((<使い方>))
* ((<ライセンス>))
* ((<謝辞>))
* ((<連絡先>))

= 概要

Ruby Browser for Apolloは五十嵐さん(igarashi@ueda.info.waseda.ac.jp)
が作られたRuby/GTKのrbbr.rb(Ruby Browser)をApolloに移植したものです。

= インストール
ap-rbbr-xxx.zipを解凍するだけです。

#  == Windows

#  付属しているinstall.rbをApollo.exeで読みこんで実行すれば、
#  GUIのインストーラーが立ちあがりますので、後はその指示に従ってください。

#  コマンドラインからruby.exeを使ってインストールする場合は

#    ruby.exe install.rb

#  とすればGUIインストーラーが立ちあがります。
#  CUIインストーラーの方が好きな方は

#    ruby.exe install.rb -d [folder]

#  とすれば、GUIインストーラーを立ち上げずにfolderにインストールすることが
#  出来ます。CUIでインストールする場合はあらかじめfolderを作成しておいてください。

#  Ruby Browser for Apolloの動作にはWSHは必要ありませんが、   
#  インストール時にショートカットを作成するためにWSHを使用しています。
#  作者の環境ではWSHなしの環境を試せないので、
#  どのようなエラーが出るか分かりません。
#  もし、バグがあったら連絡先まで知らせてください。

#  Ruby Browser for Apolloを実行する時はap-rbbrという名前のショートカットを
#  ダブルクリックしてください。 

#  == Linux

#  RPMのパッケージを

#    rpm -ivh ap-rbbr-x.x.x-y.noarch.rpm 
  
#    (x.x.xにはRuby Browser for Apolloのバージョンが入ります)
#    (yにはリリース番号が入ります)

#  としてインストールすると、/usr/share/ap-rbbr以下にRubyスクリプトが、
#  /usr/binにap-rbbrというシェルスクリプトがインストールされます。
#  今のところ、シェルスクリプトのap-rbbrは
#  パラメーターをあらかじめ決めているので、
#  お使いの環境に合わせてap-rbbrを編集してください。
#  インストールに成功すれば、コマンドラインから

#    ap-rbbr

#  でRuby Browser for Apolloが起動します。

== リファレンス
バージョン042からrefeとpi2indexを使って、関数や定数の説明を表示させることが
できるようになりました。必要なインデックスとライブラリを同梱しているので、
配布物がかなり大きくなっています。

((*注意*)): refeやpi2indexがなくてもRuby Browser for Apolloを使用することはできます。

= アンインストール

== Windows
レジストリは使用していませんので、インストール先のフォルダーを
削除すればアンインストールすることができます。

#  == Linux

= 使い方
Ruby Browser for Apolloをインストールしたフォルダーで

  ruby_ap ap-rbbr.rb

とするか、apollo.exeでap-rbbr.rbを読みこんで実行すれば、
Ruby Browser for Apolloが起動します。

起動後に画面の左側にRubyのクラスの階層構造を
表示したツリーが現れます。
ツリーにあるクラス名をクリックすると、
そのクラスの関数の名前とその関数の引数、
あるいは定数の名前とその定数の値が
右側のリストに表示されます。
(親クラスにある関数や定数は表示されません。) 

ツールバーのrefernceのボタンを押すと、下の方にメモが現れます。
refeのボタンが押されている状態で右側のリストの部分の関数名や
定数名をダブルクリックすると、
その関数や定数の説明がメモの部分に表示されます。

referenceのボタンが上がった状態だとメモは隠れてしまって
何も表示されません。

== メニュー

=== ファイル

==== ライブラリのロード
このメニューを押すと、ダイアログが出ますので、
そこにrequireしたいライブラリの名前を
入力してください。ライブラリのrequireに成功した場合は
そのライブラリをrequireした状態でツリーのクラスの階層構造を再構成します。

==== スクリプトのロード
このメニューを押すと、ファイル選択のダイアログが出ますので、
loadしたいファイル名を入力してください。ファイルのloadに成功した場合は
そのファイルをloadした状態でツリーのクラスの階層構造を再構成します。

==== 閉じる
Ruby Browser for Apolloを終了します。

=== 検索

==== クラスの検索
このメニューを押すと、ダイアログが出ますので、
探したいクラスの名前を入力してください。
入力された名前のクラスが存在する場合は
リストの部分にそのクラスの関数や定数が表示されます。

ツリーの方はスクロールの挙動が上手く操作できないので、
今のところ少し表示がおかしいです。

=== ツリー操作

==== すべてのノードを開く
すべてのノード(+のようなもの)を開きます。

=== ヘルプ

==== このソフトについて
このメニューを押しても何も起こりません。

== ツールバー

=== ALL
すべてのクラスが表示されます。

=== Apollo
Apollo関連のクラスだけが表示されます。モジュールについてはすべて表示されます。


=== reference
このボタンが押されている状態でリストの関数名や定数名を
ダブルクリックすると、メモの部分に関数や定数の説明が表示されます。

= ライセンス
Ruby Browser for Apolloに含まれるrbbr-lib.rbはRuby/GTKのrbbr.rbを
変更したものですので、オリジナルのrbbr.rbのライセンスに従います。

irb-locale.rbはRubyに標準添付されているirbのlocale.rbと同一のものです。
これに関してはirbのライセンスに従います。

別ファイルにしているrefe-aprbbr.zipは
オリジナルのrefeのライセンスに従います。
refeのライセンスはGPLですが、作者の方から配布の許可は受けています。

上記以外の私が書いた部分についてはRubyライセンスとします。

= 謝辞 

* ((<Ruby|URL:http://www.ruby-lang.org/>))の作者である まつもとゆきひろさん
* ((<Apollo|URL:http://www.users.yun.co.jp/~moriq/ruby/>))の作者である もりきゅうさん
* Ruby Browser for Apolloを作製する時にアドバイスをして頂いた ((<たけ(tk)さん|URL:http://member.nifty.ne.jp/take_tk/>))
* Ruby Browser for Apolloの元になったrbbr.rbと((<Ruby(('/'))GTK|URL:http://www.ruby-lang.org/gtk/>))の作者である五十嵐さん
* refeの作者である ((<青木峰郎さん|URL:http://www9.xdsl.ne.jp/~aamine/>))
* irbの作者である 石塚圭樹さん

= 連絡先  
mzh@portnet.ne.jp

=end
