Howto generate the documentation in Windows Help file format (chm)
by Daan Broekhof · 10/11/2004 (5:56 pm) · 6 comments
In my efforts to make myself more at home with using the Torque engine, I tried to get a nice searchable documentation file.. after trying all sorts of dodgy shareware programs to convert the oxygen generated html to a windows help format (chm), I found out that doxygen itself can almost directly generate such a file itself!
This solution is also floating around in the forums, but here is a tidy resource about it:
The step-by-step howto:
> Download the Microsoft HTML Help Workshop here: Microsoft MSDN page (the 'Download Htmlhelp.exe' link)
> Install above program.
> Edit the doxygen configuration file (located at 'doc\doxygen\html\doxygen.html.cfg') and change the following entries:
> Follow the steps of generating the HTML version of the documentation: Online documentation page
-- EDIT --
Or, if you don't like command line mucking about, ignore the above documentation link and use the doxygen wizard called doxywizard which comes with the latest win32/linux doxygen version 1.3.9.1 (and maybe with earlier versions).
> Run doxywizard
> Load the edited doxygen configuration file (with the 'Load..' button, eh?)
> Change the working directory to the torque root dir (just strip off the 'doc\doxygen\html\')
> Click the 'Start' button
> Let it munch a while
-- /EDIT --
And voila! A nice and snappy 5mbish torque.chm file is waiting for you in the \documentation directory!
--------------
Should by any chance you have an older doxygen version installed that won't automaticly make a .chm file and you don't want to recompile a more recent version from source, here are some manual operations to generate it:
(Like the binary I downloaded from the doxygen site, which included a version 1.2.9.1 doxygen.exe where 1.3.8 is name of the file ~ weird)
> Follow all the above directions
> Open up the Windows Command Prompt (the thingy you get from typing 'cmd' in start->run, yeah ;)
> Go to your 'documentation' directory in your torque dir.
> execute the following command:
This will generate an 'index.chm'.. just rename it to 'torque.chm' and you're done.
This solution is also floating around in the forums, but here is a tidy resource about it:
The step-by-step howto:
> Download the Microsoft HTML Help Workshop here: Microsoft MSDN page (the 'Download Htmlhelp.exe' link)
> Install above program.
> Edit the doxygen configuration file (located at 'doc\doxygen\html\doxygen.html.cfg') and change the following entries:
GENERATE_HTMLHELP = NO --> GENERATE_HTMLHELP = YES
BINARY_TOC = NO --> BINARY_TOC = YES
TOC_EXPAND = NO --> TOC_EXPAND = YES
HHC_LOCATION = --> HHC_LOCATION = "{path to MS HTML Help Workshop}\hhc.exe"> Follow the steps of generating the HTML version of the documentation: Online documentation page
-- EDIT --
Or, if you don't like command line mucking about, ignore the above documentation link and use the doxygen wizard called doxywizard which comes with the latest win32/linux doxygen version 1.3.9.1 (and maybe with earlier versions).
> Run doxywizard
> Load the edited doxygen configuration file (with the 'Load..' button, eh?)
> Change the working directory to the torque root dir (just strip off the 'doc\doxygen\html\')
> Click the 'Start' button
> Let it munch a while
-- /EDIT --
And voila! A nice and snappy 5mbish torque.chm file is waiting for you in the \documentation directory!
--------------
Should by any chance you have an older doxygen version installed that won't automaticly make a .chm file and you don't want to recompile a more recent version from source, here are some manual operations to generate it:
(Like the binary I downloaded from the doxygen site, which included a version 1.2.9.1 doxygen.exe where 1.3.8 is name of the file ~ weird)
> Follow all the above directions
> Open up the Windows Command Prompt (the thingy you get from typing 'cmd' in start->run, yeah ;)
> Go to your 'documentation' directory in your torque dir.
> execute the following command:
"{path to the dir you installed Microsoft HTML Help Workshop}\hhc.exe index.hhp"This will generate an 'index.chm'.. just rename it to 'torque.chm' and you're done.
#2
But providing one for say.. the 1.3 milestone is something that should be looked into. Perhaps I'll generate some docs today for the various milestones and submit those as a resource.
10/13/2004 (7:20 am)
Well probably it's the same reason why the html source docs aren't available for download: they would have to be re-generated whenever you update your torque source.But providing one for say.. the 1.3 milestone is something that should be looked into. Perhaps I'll generate some docs today for the various milestones and submit those as a resource.
#3
GG has already determined how much of the docs they are willing to share with non-torque owners and that is availabe from their website.
Also, if you are a registered torque owner you can generate the docs yourself - for your version of the code which is much more useful than the generic docs from the download. dOxygen and all the tools are free and registered owners are generally programmers who would have only minor difficulty setting up the process to do it. I use a simple DOS batch file to generate mine and it only took a few minutes to write.
10/18/2004 (7:20 am)
I think that the reason its not happening is that publication of the complete docs is a violation of the EULA - unless you make it available only to registered torque owners. So the way to do it is set it up as a pointer that can only be accessed from a part of the GG website limited to registered torque owners.GG has already determined how much of the docs they are willing to share with non-torque owners and that is availabe from their website.
Also, if you are a registered torque owner you can generate the docs yourself - for your version of the code which is much more useful than the generic docs from the download. dOxygen and all the tools are free and registered owners are generally programmers who would have only minor difficulty setting up the process to do it. I use a simple DOS batch file to generate mine and it only took a few minutes to write.
#4
And I completely agree that users should generate their own documentation, if they made additions to the source or are experienced enough to do it in an few minutes... but for starting torque programmers it saves alot of hassle and time if they don't have have to jump through all the hoops just to get the standard documentation.
10/18/2004 (8:03 am)
Garagegames can make resources available for Torque license holders only, so that won't be a problem. (I have a 5mb .chm sitting here ready to be distributed, but the max upload for a resource is 2mb, see this forum topic)And I completely agree that users should generate their own documentation, if they made additions to the source or are experienced enough to do it in an few minutes... but for starting torque programmers it saves alot of hassle and time if they don't have have to jump through all the hoops just to get the standard documentation.
#5
10/24/2004 (2:25 pm)
Daan, can you email me the file pls?
#6
Thanks!
10/28/2004 (10:49 am)
Very nice resource. This is probably even better than a printed copy ( if you are a fan of printed docs ), mostly because of the nice search feature.Thanks!
Torque Owner Eric C. Tomlinson