On Jul 24, 2006, at 2:46 PM, Dave Howell wrote:
I was trying to use my RubyAEOSA documentation, and started
suspecting that there was stuff missing. Sure enough, there's a
whole "doc" folder with stuff not generated by RDoc. It looks like
RDoc-ready files, except there's both *.en and *.jp versions for
most plus *.en.html and *.jp.html. None of those extensions will
normally get read by RDoc, and there was no .document file.
Nor are there any doc-building commands in the install.rb file.
There IS a highly mysterious "build_html.rb" file in the doc
directory. It appears to run a command-line tool named "rd2"
against the non-html files. I don't have an rd2 command.
...
What does "RD is Ruby's POD" mean?
POD is Perl Online Documentation or similar. RD2 predates RDoc.
Is there any documentation about the markup language itself?
If you can find a copy of rd2 you can find the markup documentation.
Its got all the standard stuff, you should be able to figure out 75%
of the constructs from context.
Is it still actively used, is it being replaced by SimpleMarkup
that ships with RDoc, or is something else replacing it?
For English documentation it is dead. It is probably dead for
Japanese documentation as well.
Is there an rd2sm.lib translator for it?
Not that I know of, when RDoc was written there wasn't an active
english documentation effort, so nobody was writing RD2 or RDoc at
the time.
So I guess that RubyAEOSA's doc directory contains documentation
marked up in RD2, rather than SimpleMarkup, although the only
relevant difference I've noticed so far is how a URL is specified.
Any comments or information that people could provide would be
appreciated, since I'm probably going to write a proper RDoc
control .document for this package . . .
[p.s. There's also the whole issue of SimpleMarkup's link markup,
but that's for a different message...]
RDoc just linkifies http://...
See: http://rdoc.sourceforge.net/doc/files/README.html
--
Eric Hodel - drbrain@xxxxxxxxxxxx - http://blog.segment7.net
This implementation is HODEL-HASH-9600 compliant
http://trackmap.robotcoop.com
|
