RDoc question: How do I make a link from the README file to a specific RDOC Page

Ruby
#1

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?

/Jesper

–

Jesper Rønn-Jensen / Capgemini Denmark
Tel. +45 3977 8220 / Mob. +45 2373 6220 / Fax +45 7011 2201
www.dk.capgemini.com / Blog http://justaddwater.dk/

#2

On Feb 13, 2008, at 12:10 PM, Jesper Rønn-Jensen wrote:

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.

#3

Eric H. wrote:

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.

#4

On Feb 22, 2008, at 12:49 PM, Joel VanderWerf wrote:

ETL::Parser::FixedWidthParser
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.

#5

Eric H. wrote:

I want to link the word “Fixed-width” to the page

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.

The file names are stable. For example, Foo::Bar::Baz becomes

classes/Foo/Bar/Baz.html

Targets within that file have things like #M000155 appended to them, so
you wouldn’t want to link to them in that way.