From: Toshiro Kuwabara <toshirok@...3.so-net.ne.jp>
Date: 2000-06-12T23:36:37+09:00
Subject: [ruby-talk:03299] Re: about documentation

Hi,

In message "[ruby-talk:03292] about documentation"
    on 00/06/12, Wayne Scott <wscott@ichips.intel.com> writes:
>I want to contribute to the ruby project in my spare time.

good idea! :-)

>Right now one of the biggest needs appears to be English
>documentation.  I notice that Ruby has some form of embedded
>documentation like Perl, but based on its use in the CGI modules it
>does not appear to be the POD format.  Does documentation for this
>format exist?  Have translators been written?  Any reason POD is not
>being used?

Ruby has RD, handy and neat documentation format which you can embed
it in Ruby script.
Please Look my introduction page for more information about RD.
<URL:http://www2.pos.to/~tosh/ruby/rdtool/en/index.html>

"What's RD" is Overview
<URL:http://www2.pos.to/~tosh/ruby/rdtool/en/whats.html>
and "RD Working Draft" help you to learn RD.
<URL:http://www2.pos.to/~tosh/ruby/rdtool/en/doc/rd-draft.html>

>Because of the POD translators you can convert that documentation to
>most formats desired. (HTML, Latex, 'roff, text,...) 

RDtool can do it, it can translate from RD to HTML or man.

---
Tosh
Toshiro Kuwabara