From: Joel VanderWerf <vjoel@...>
Date: 2004-10-25T03:39:42+09:00
Subject: Re: How do I use rdoc's link: hyperlinks?

Tim Hunter wrote:
> I'm trying to include a hyperlink using the label[url] form, where the
> hyperlink uses the link: prefix to refer to a local file. However I'm not
> able to get rdoc to generate the correct href. What's the right way to do
> this?

Is the local file one of those generated by rdoc? This has worked for me:

   doc/protocol.txt[link:files/doc/protocol_txt.html]

where my dirs are:

   doc/
     protocol.txt   # doc source file
     api/
       classes/
       files/
         doc/
           protocol_txt.html # generated by rdoc
         lib/
       index.html
   lib/

and I run rdoc with the options

   rdoc -o doc/api doc/*.txt

Seems a bit contorted, but it works :)