From: bbense+comp.lang.ruby.Sep.05.02@... Date: 2002-09-05T23:47:53+09:00 Subject: Re: suggestions to the Ruby community -----BEGIN PGP SIGNED MESSAGE----- In article <7DC1217518FCD311A08A0050DA78574003C6B5BF@iamspems04.interprise.com>, Berger, Daniel wrote: >I've been following the documentation discussion with some interest. Some >of this has focused on rd2. > >At the risk of being branded a heretic by the Ruby Community, I believe >there's an alternative that we haven't considered. > >POD. > >That's right - POD. POD as in Perl's "Plain Old Data". POD and rd2 are >markup languages. They have nothing to do with the language (i.e. Perl or >Ruby) itself. I can put rd2 documentation in a Perl module just as easily >as I can use POD to document my Ruby modules. > - - Actually this jibes with some thoughts I've had as well. I think it would be very cool if rdoc could output POD or rd2. I'm not sure what the easiest path is whether to try and transform the xml output or just write a rd2/POD generator. - - POD's great advantage is that you actually don't need any tools to read it. rd2 is fairly readable as well. If we could standardize on an output format that was easily transformable and easily parsable, they lot's of handy reference tools could be built. Here's my thoughts for moving forward. 1. Get rdoc to write out rd2 2. Teach ri to read rd2 and look for it in installed ruby libs. 3. Write some documentation and stick it on the ruby-lang.org wiki. The Japanese Ruby Doc project seems to be getting regular input. The english side hasn't been touched in over a year. - - Booker C. Bense -----BEGIN PGP SIGNATURE----- Version: 2.6.2 iQCVAwUBPXdoVmTWTAjn5N/lAQH1GwP/fICXr7MzoQuMFbfn+qI/+u420WHBQfRe 0MmbXdO/SY+oWdAWyqX00gfHljRMBFbV3rq6vpO5/8VuyEQzFYdN5JjNsGI23zwh gq3PLATFyCaBsrwi6RfAQX/mywr65+HFVCK7+FGmZuy0QHIR0Pj7vbuyXO9ggrHY H3zCFziIgZw= =qtKL -----END PGP SIGNATURE-----