Re: The Secret of RDoc HTML links.

On Mon, 24 Jul 2006, Dave Howell wrote:

> 
> On Jul 24, 2006, at 16:16, Eric Hodel wrote:
> 
> > > [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
> 
> Looks like the same readme that comes with RDoc itself. There's nothing
> whatsoever on that page about how to . . . what the heck?
> 
> Oh, that's really remarkable.

Rdoc is a pretty amazing tool.
> 
> 
> So, first, if one installs Ruby, RDoc pointedly installs absolutely no
> documentation about itself. Since getting RDoc to generate HTML documentation

I recently sent a patch to ruby-core to amend the .document files
to this effect.  I've not noticed a decision on it yet, but these
people are busy, with 1.8.5 due out in the middle of August.

> was nigh-impossible without instructions, I eventually convinced it that maybe

rdoc --help is pretty helpful.  The markup information takes a little
more finding, but if you have the Pickaxe book ["Programming Ruby", Dave
Thomas et al] then it's well explained in there.  

Most of the stuff I have for Ruby Documentation is here:

http://www.eng.cse.dmu.ac.uk/~hgs/ruby/#docs

so if you find links you think should be there, then please let me know.
As for things being on the web and not on your disk, my favourite tool
for handling that is wget.
http://www.gnu.org/software/wget/

Others prefer curl.
http://curl.haxx.se/


        HTH
        Hugh