BitClust のウェブインターフェイスについて。
既存の機能¶
- ライブラリ一覧、クラス一覧、ライブラリのページ、クラスのページ、メソッドのページ
- ライブラリ、クラスの要約抽出 (ドキュメントの第一段落を抜き出すだけ)
- スーパークラス、include しているモジュール、所属ライブラリなどのメタデータ表示
- ライブラリを require すると「追加されるメソッド」「再定義されるメソッド」のサポート
これから実装する機能¶
- クラスの alias、ライブラリの alias のサポート
- 「ぜんぶ読む」機能 (メソッドのドキュメントで、 pack テンプレートとか printf フォーマットとかの長いドキュメントを隠すために使う)
- インクリメンタルなメソッド検索
- クラスツリーの自動生成
- 継承しているメソッドの表示
- ウェブ上からの編集 (メンテナのみ)
- パッチ管理 → BitClustPatchManagementSystem
- 対応する rdoc の表示
- メソッドのソースコード表示 (Ruby, C)
やるきのない FAQ¶
- Q. このウェブインターフェイスって自分のマシンでも動くの？
- A. もちろん。
- Q. じゃあそのへんのドキュメントを書け
- A. もうちょい仕様が固まったらね。とりあえずbitclust --help でも見れ
- Q. なんで Rails じゃないの？
- A. Railsが嫌いだから
- Q. かっこわるくない？
- A. かっこいいCSSを書いてくれ
- Q. 操作しにくい
- A. まだα版だからしょうがない
- Q. いじってたら落ちた
- A. まだα版だからしょうがない
- Q. 反応が遅い
- A. いまは CGI で動かしてるからだと思う
- Q. なんで FastCGI にしないの？
- A. 実装は済んでるけどデバッグその他のためにあえて CGI