From: Rick DeNatale <rick.denatale@...>
Date: 2009-02-22T04:38:57+09:00
Subject: Re: How does one generate a "main page" for rdoc documentation?

--0016e644cf3239a6f0046372ede2
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: 7bit

On Sat, Feb 21, 2009 at 1:21 AM, Igor Pirnovar <gooigpi@gmail.com> wrote:

> Rick Denatale wrote:
>
> > And there are lots of options which affect what it outputs
>
>
>
>
> Unfortunately, none of the above hyperlinks work for in-line images.
> There may very well be a number of directives that work with images and
> are not documented for general public. For instance the rdoc's own
> documentation uses the following cool area-clickable image
> http://rdoc.sourceforge.net/doc/dot/f_1.png. You can check it out at
> http://rdoc.sourceforge.net/doc/index.html. I'd be very happy if someone
> would document how this works, but my gut filling is that even their own
> documentation may be manually tweaked behind the scene.


I'm pretty sure that those are there simply through the use of the --diagram
option of rdoc and were automatically generated using doc.

For static images all you need to do is put them somewhere relative to the
docs directory and use the image: markup

For example if I have an image dontswing.jpg in the parent directory of rdoc
generated doc directory I can do

# This documents the Foo class
# link:../dontswing.jpg
class Foo
end

and $rdoc *.rb

shows that image in the documentation for foo.

If you want to put the image somewhere underneath the doc directory, you
can, but you have to do it yourself, and probably want a rake task to do
that after you've (re)generated the rdoc output.


>
> I sincerely hope I am wrong, and that someone will show up here and give
> us a usable example or at least the damn directive to include a passive
> in-line images, rather than a man pages in the style of RtFM.
>

I'd never done that myself but it really did take just a bit of reading the
doc and a little experimentation.


-- 
Rick DeNatale

Blog: http://talklikeaduck.denhaven2.com/
Twitter: http://twitter.com/RickDeNatale
WWR: http://www.workingwithrails.com/person/9021-rick-denatale
LinkedIn: http://www.linkedin.com/in/rickdenatale

--0016e644cf3239a6f0046372ede2--