From: Joel VanderWerf <vjoel@...>
Date: 2008-02-23T05:49:25+09:00
Subject: Re: RDoc question: How do I make a link from the README file to a specific RDOC Page

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.

-- 
        vjoel : Joel VanderWerf : path berkeley edu : 510 665 3407