From: Igor Pirnovar <gooigpi@...>
Date: 2009-02-22T01:19:04+09:00
Subject: Re: How does one generate a "main page" for rdoc documentation?

Tom Link wrote:
> That's what documentation tools like rdoc & man are made 
> for: being read.

It is rather ironic and perhaps insulting that you would think the 
knowledge which is the basis for this discussion comes naturally by 
birth.

> ... the output of rdoc --help was that there is a -D command
> line option that includes these diagrams.

Unfortunately, all these references to the graphics all point to 
http://www.research.att.com/sw/tools/graphviz/. The web page is 
overwhelming and talks about generating graphic. None of this is really 
needed. What is missing in rdoc documentation is a simple directive to 
include an in-line image - perhaps something like:
  +-----------------------------+
  | # [IMG:URL]                 |
  | #     or                    |
  | # [IMG:file://image.png]    |
  +-----------------------------+
Indeed, at one point it would be nice to generate area-clickable image 
(diagram) that could be used in rdoc output. But without being able to 
place in an inactive - still image, all the reading of tones of 
theoretical possibilities, that at the end may not even do what one 
wishes, is an unnecessary  waste of time. The "smart" or more to the 
point annoying answers like yours, Tom, certainly do not help. I already 
forgot all the stuff I read and tried when I needed this feature in 
rdoc, so much so that I decided to include the missing rdoc feature 
myself.

The bottom line is that as a user having a long and considerable 
experience with rdoc I still can not put a diagram into my documentation 
produced with rdoc, without the additional under the hood meddling, and 
forgive me if I find comments like yours rather inappropriate.
-- 
Posted via http://www.ruby-forum.com/.