From: Toshiro Kuwabara <toshirok@...3.so-net.ne.jp>
Date: 2001-05-23T02:53:53+09:00
Subject: [ruby-talk:15548] Re: rdtool: how to add images?

Hi,

On 2001.05.22, at 00:30, Gardian, Milan wrote:
> is there a possibility to add images to the rdtool-generated 
> documentation?
>
> I would like to add some *.png images to the documentation to make it 
> more
> concise. Is this possible with rdtool? If not, are there any Ruby-based
> alternatives (and non-Ruby-based ones)? I would like to write the
> documentation in a plain-text editor and then use something like rdtool 
> to
> compile the "final" HTML documentation.

You can. But the method is a little troublesome.

First, you have to prepare stub file for png image file such like:
(I assume that the  name of your png file is "image.png")

-- stub file, named "stub.html"
<img src="image.png" alt="...">

NOTE:
1. line "-- stub file ..." is just a comment line.
2. rdtool simply embed this stub file into output HTML. so, you can 
write any HTML element
you want.

Second, write following tag(?) on your RD file.

-- on RD file.
<<< stub

same as previous, a line, "-- on RD file", is comment.

"<<< stub" means a direction to embed "stub.html" file to output HTML.

NOTE:
1. You can't indent a line, "<<< stub".
2. not "stub.html" but "stub".

hope this helps you.

---
Tosh
Toshiro Kuwabara