From: Eric Hodel <drbrain@...7.net>
Date: 2008-02-23T06:41:43+09:00
Subject: Re: RDoc question: How do I make a link from the README file to a specific RDOC Page

On Feb 22, 2008, at 12:49 PM, Joel VanderWerf wrote:
> Eric Hodel wrote:
>> On Feb 13, 2008, at 12:10 PM, Jesper Rønn-Jensen wrote:
>>> This is an excerpt from the ActiveWarehouse-etl README file
>>>
>>> * Multiple source types. Current supported types:
>>> * Fixed-width and delimited text files
>>> * XML files through SAX
>>> * Apache combined log format
>>>
>>> I want to link the word "Fixed-width" to the page  
>>> ETL::Parser::FixedWidthParser
>>>
>>> How can i do that in an optimal way to keep readability in the  
>>> source file?
>> RDoc only supports links to external pages and auto-linking via  
>> method/class names.
>
> There is the 'link' directive in rdoc. For example:
>
> {README}[link:../ruby-api/files/README.html]
>
> The {...} part is used for the visible text of the link.
>
> I'm not sure if it is possible to link to a class rather than a  
> file, but of course you can just link to the HTML file containing  
> the class's generated rdoc.

As I recall, the names of classes are generated, so it will be  
difficult to have a stable link.