いがらしです。

At Thu, 7 Oct 1999 00:44:11 +0900,
in [ruby-list:17476] Re: Ruby Library Manual,
matz / netlab.co.jp (Yukihiro Matsumoto) wrote:
> 
> In message "[ruby-list:17465] Ruby Library Manual"
>     on 99/10/06, TAKAHASHI Masayoshi <maki / inac.co.jp> writes:
> 
> |3. 載っていない場合、そろそろライブラリのマニュアルもまとめよっかなー、
> |   なーんて思っている方はいたりしますか？(^^;
> 
> ドキュメント類はRDで書き直そうと思ってるのですが、rubyapiも
> 気になってます。

rubyapiって何それ？ という方がほとんどだと思うので少し説明を。

クラスやモジュールのドキュメントをXMLで記述して、それをもとに
HTML文書やその他の形式として生成しようという話がありまして、
[ruby-list:10399]あたりのスレッドで議論されたのですが、
DTDや仕様は特に決められてはいません。

福嶋さんのrubyapi.dtdを基にしていがらしが勝手に決めたDTDが
    http://www.ueda.info.waseda.ac.jp/~igarashi/ruby/rubyapi.dtd
で、この形式で書かれたドキュメントをHTML(など)に変換するツール
rubyapi2(html, etc)を作成中です。

rubyapi2はドキュメント対象のライブラリをすべてrequireして
メソッド・定数名等の照合を行なうなどRDの手軽さとは対極にあるので、
仕様変更の少ない拡張ライブラリ向きかなと考えています。
個人的には*.rbなライブラリにも使っていますが。

Ruby/GTKのAPI Documentはこれを使って生成しています。
組み込みライブラリのマニュアルもrubyapiで書こうとしてたんですが
    http://www.ueda.info.waseda.ac.jp/~igarashi/ruby/api-ja/
Ruby/GTKの方を優先している関係で進んでいません。
ツールとサンプルを公開すればやっていただける方がいるかも知れませんが、
他にもっとふさわしい方式があるかもと思って躊躇しています。

＃なにはともあれブツを公開しなくちゃいけませんね。 ＞ 私

--
五十嵐  宏  (Hiroshi IGARASHI)