るりまWiki: BitClust

2008-07-12 10:46:09 +0900 (357d); rev 25

BitClust は新リファレンスマニュアルの核となるプログラムです。ドキュメントデータベースからウェブインターフェイス、執筆支援ツールまで、いろいろ入ってます。計画に参加するメンバーは必ず入手しておいてください。

入手方法

BitClust は Subversion レポジトリのみで公開されています。詳しい入手方法については SubversionRepository を見てください。

インストール

いまはまだアップデートが激しいので、ちゃんとインストールする方法は提供していません。チェックアウトしたら、 PATH の通ってるディレクトリにコマンドをシンボリックリンクしてください。

使用方法

Phase2WorkingScheme などが参考になります。

また各コマンドに --help を付けて起動するとオプションの簡単な説明が表示されます。

主要コマンド

bitclust: リファレンスデータベースの更新、表示、検索などを行う。以下の「bitclust サブコマンド」の項も参照。
refe: BitClust データベースに対応した ReFe (ReFe2)。

bitclust サブコマンド

bitclust init: BitClust データベースを初期化する。

例

bitclust -d ./db-1_8_6 init version=1.8.6 encoding=euc-jp

bitclust update: BitClust データベースを更新する。

例

bitclust -d ./db-1_8_6 update --stdlibtree=../doctree/refm/api/src

bitclust list: 特定の種類のエントリをリストする。

例

bitclust -d ./db list --library
bitclust -d ./db list --class
bitclust -d ./db list --method

bitclust lookup: 指定されたエントリの内容を出力する。

例

bitclust -d ./db lookup --library=_builtin
bitclust -d ./db lookup --class=Object
bitclust -d ./db lookup --method=Object#inspect
bitclust -d ./db lookup --method=Object#inspect --html

bitclust search: refe と同じ(refeの本体)。

例

bitclust -d ./db search Object#inspect

bitclust property: データベースプロパティを操作する。

例

bitclust -d ./db property list
bitclust -d ./db property get encoding
bitclust -d ./db property set encoding euc-jp

bitclust chm: 未実装。Windows 向けの HTML Help を出力する => tools/bc-tohtm.rbで実装された。
bitclust statichtml: 未実装。静的 HTML を出力する。
bitclust info: 未実装。info を出力する。

ツール (tools/*.rb)

bc-classes: システムに存在する全 ruby について、定義されているクラスを表示する
bc-convert: 旧リファレンスマニュアルのファイルを BitClust フォーマットに変換する
bc-list: リファレンスファイルに含まれるメソッドエントリをリストする
bc-methods: システムに存在する全 ruby について、定義されているメソッドを表示する。るりまの *.rd ファイルに書かれてあるメソッドに不足がないかもチェックできる。 -c をつけると不足しているメソッドの ri の内容が表示される。ライブラリに対して使うときは -r オプションが必須。 [ruby-reference-manual:468], [ruby-reference-manual:558]。

例

bc-methods Object
bc-methods -rLIBRARY --ruby=RUBY_VERSION --diff=RDFILE CLASS_NAME
bc-methods -rstringio --ruby=1.9.0 --diff=StringIO StringIO
ruby-1.9 bc-methods.rb --ruby=1.9.0 --diff=Object Object  -c

bc-preproc: プリプロセスだけを行う
bc-rdoc: RDoc データベースと BitClust データベースを比較処理。 [ruby-reference-manual:468]
bc-tohtml: リファレンスの1ファイルを HTML に変換する。データベースの更新なしにhtmlへの変換結果が見られて便利。

例

bc-tohtml.rb --target=Range Range > t.html
bc-tohtml.rb ../doctree/refm/api/src/_builtin/Array --target Array > t.html
bc-tohtml.rb ../doctree/refm/api/src/net/https.rd > a.html
bc-tohtml.rb src/zlib/GzipReader                              #ライブラリGzipReader
bc-tohtml.rb src/zlib/GzipReader --target=Zlib::GZipReader    #クラスGzipReader
bc-tohtml.rb --force mkmf.rd                                  #ファイルの全体を強制的に出力する
bc-tohtml.rb --ruby=1.8.6 --target=Array Array > t.html       #rubyのバージョンを指定

bc-tochm: Microsoft HTML Workshop用のchm素材を出力する。それなりに時間がかかるので、http://0xcc.net/ruby-progressbar/ をインストールしておくと良い(gemからは入らないので注意)。

例

bc-tochm.rb -d ./db -o ~/tmp/chm    #-o省略時は ./chm に出力される
このあと、hhc.exe ~/tmp/chm/refm.hhp とするとrefm.chmができる

forall-ruby: システムに存在する全 ruby について、同じコマンドラインオプションを付けて実行する

ウェブインターフェイス

実装の詳細

system revision 1.162