Memo

= Ruby リファレンスマニュアル計画

== 予定

* メンテナンスフェイズに移行したので特にない

== 仕様

* ファイルは Git で管理
* CGI で動的生成
    * BitChannel ベース
* require 名をベースにしてファイルを作る
    * ビルトインクラスは _builtin とかなんとか
* メソッドの記述は RD
* 全バージョンが一つのファイルに同居
    * 動的に各バージョンのサイトを生成
* クラスの継承関係も自動的に検出できるように
* メソッド検索もできるように
    * ReFe ベース
* 静的 HTML
    * 動的に生成されるものをすべて静的に生成
    * 生成されたものは内容が重複する場合もある
* ファイル単位のページでは h のインデックスを出す
* ファイル単位のページでは「このライブラリが提供するクラス」を表示
* クラス単位のページではメソッドのインデックスを出す
* クラス / メソッドのページでは関連するクラスやライブラリに
  リンクを張る

== レイアウト

/
    index.html
    install/
    refm/
        spec/
        api/
            index.fcgi
            files/        仮想パス
            classes/      仮想パス
            methods/      仮想パス
            search/c/m    ??
        capi/
            index.fcgi
    faq/
    tutorial/
    rhg/  ??

== 懸念

* URL が全部変わる -> しかたない
* 文法は RD でいいの？
* リファレンスマニュアル以外はどうやって管理する？
    * Wiki ちっくな何か... だろうか
* リファレンスマニュアルから FAQ へのリンク？
    * URL を直に書け！
* InterWikiName みたいな仕組みがあるとよさげ？
* コミットのたびにインデックスを全部リビルドするのはなあ