青木です。

昨日の LL ring で高橋さん・西山さんと相談して、
Ruby リファレンスマニュアル刷新計画の大枠をまとめました。

[日程]

  * 2006-08-31 までに Subversion レポジトリを (loveruby.net で) 公開
  * 2006-09-20 までにアプリケーションを (loveruby.net で) 稼働

[クラスリファレンスの達成目標]

  * Subversion でファイルを直接コミットできること
  * ファイル単位、クラス単位、メソッド単位でドキュメントを見られること
  * クラス単位のときは、継承したメソッドも同時に表示できること
  * メソッドのドキュメントを検索できること (最低でも ReFe レベル)
  * 既存クラスにメソッドを追加するライブラリをうまく取り扱うこと
  * 複数のクラスを含むライブラリをうまく扱うこと
  * Ruby のバージョンごとにドキュメントを分割すること
    (ソースドキュメントではすべて同居させる)
  * 現在手作業で埋め込んでいるクラスやメソッドのインデックスはすべて自動生成する
  * 現「添付ライブラリ」を統合
  * 静的 HTML アーカイブを全自動で生成できること
  * HTML Help を半自動で生成できること
    (コマンド一発で生成できるが、そのコマンドは手で打つ)

[その他に準備するドキュメント]

  * 現「Ruby言語仕様」と旧「Rubyの文法」を再統合して新「Ruby言語仕様」とする
  * 現「拡張ライブラリリファレンスマニュアル」を統合
  * 現「落とし穴」「FAQ」「記号の意味」をまとめて新 FAQ とし、
    リファレンスマニュアルから除外
  * その他の細かい文書はどっかにまとめる

分担について。

[青木が一人でやること]

  * Subversion レポジトリのセッティング (deadline: 8/31)
  * ドキュメント閲覧用ウェブアプリケーションの作成 (dealine: 9/20)
  * その他のドキュメントの物理的配置の決定 (deadline: 8/31)

[他の人の協力を求めること]

  * 青木の決定したファイル配置に合わせて既存のドキュメントを配置しなおす
  * ファイルフォーマットの変換
  * CSS の新規作成
  * HTML Help 作成プログラムの統合

ファイルは一つか二つだけサンプルを作っておくので、それを
参考にして他のファイルをコミットしてください。ファイル
フォーマットはまだ未定ですが、少なくともメソッド単位では
現在のフォーマットに近いものにします。

また CSS も、わたしが作成した原形を元に作業してください。

わたしは HTML Help については知らないので、わたしのコードを
元に HTML Help 作成部分を作ってくださるかたを募集します。

--
青木峰郎

--
ML: ruby-reference-manual@m...
使い方: http://QuickML.com/