From: Martin Stannard <martin@...>
Date: 2002-03-04T06:54:35+09:00
Subject: RE: Windows gurus: generating .chm files from RDoc?

-----Original Message-----
From: Dave Thomas [mailto:Dave@PragmaticProgrammer.com]
Sent: Sunday, 3 March 2002 4:34 PM
To: ruby-talk@ruby-lang.org
Subject: Windows gurus: generating .chm files from RDoc?



> Given that I can generate .html, how much extra effort would it be to
> generate Windows HTMLHelp files? And would folks think it was worth
> it?


> Dave

Hi Dave,

We use Doxygen (http://www.doxygen.org/) for generating C++ documentation
and outputting windows html help files.

You'll need the HTML Help Workshop from microsoft to generate the chm file
from the html source. From briefly looking at the files generated by doxygen
it seems that RDoc will have generate a hhp file that has the following
contents:

[OPTIONS]
Compatibility=1.1
Full-text search=Yes
Contents file=index.hhc
Default Window=indexHelp
Default topic=index.html
Index file=index.hhk
Title=ProjectName

[FILES]
index.html 

Then just call the Help comipler:

"\path_to\HTML Help Workshop\hhc.exe" index.hhp

Doxygen also uses the dot tool for generating class hierarchies and these
are embedded in the chm file,

regards,

Martin