Creating a regular complied HTML help!..
by VcDeveloper · in Site Feedback · 11/27/2008 (10:05 pm) · 7 replies
Why did you make a regular MS Complied HTML Help? Looking through this IE doc's is frustrating and tidious. My eye's get tired looking through the reference's for Objects and stuff! When you can use a MS Complied help search and index features.
Why didn't you do this at first instead of the online doc's? It's real easy to do!
Why didn't you do this at first instead of the online doc's? It's real easy to do!
#2
As Nathan said, using HTML allows for users of all platforms to access the documentation. This is the only fair way. TorqueX will use both HTML and CHM for its API, simply because it is the only Windows exclusive engine we have.
As the doc writer, I actually prefer HTML because I'm able to spit out articles and tutorials much faster than writing them in Word. It's actually easier, since I can use special formatting and code to display pictures, code blocks, videos, and so on.
As far as the reference docs go, it's not difficult at all to generate your own and compile them into CHM. In fact, this is one of the Doc System changes I'm implementing. I'll talk about that more later on though.
11/27/2008 (10:50 pm)
@VcDeveloper - Sorry you do not like the format. I've had requests for everything: HTML, PDF, Word Doc, OpenOffice, Notepad, and CHM.As Nathan said, using HTML allows for users of all platforms to access the documentation. This is the only fair way. TorqueX will use both HTML and CHM for its API, simply because it is the only Windows exclusive engine we have.
As the doc writer, I actually prefer HTML because I'm able to spit out articles and tutorials much faster than writing them in Word. It's actually easier, since I can use special formatting and code to display pictures, code blocks, videos, and so on.
As far as the reference docs go, it's not difficult at all to generate your own and compile them into CHM. In fact, this is one of the Doc System changes I'm implementing. I'll talk about that more later on though.
#3
Search for "CHM help".
The first link result contains a guide to compiling the C++ HTML documentation generated by dOxygen to CHM format, and the second result gives you a download link for a CHM - though it is a little outdated. There were more but I stopped looking after those two.
It's actually best to generate your own, especially if you have custom functions, classes, and scripts.
11/27/2008 (11:54 pm)
A little forum searching will turn up several CHM documentation links. Search for "CHM help".
The first link result contains a guide to compiling the C++ HTML documentation generated by dOxygen to CHM format, and the second result gives you a download link for a CHM - though it is a little outdated. There were more but I stopped looking after those two.
It's actually best to generate your own, especially if you have custom functions, classes, and scripts.
#4
It's just scrolling up and down the tree list tires my eyes after doing so much. It would be nice if the online doc's had a seach feature of it's own like MS Downlad Center. You can use the dropdown box to trim your search. I mean since TGE features is so rich this could help enormously.
11/28/2008 (7:30 pm)
Thanks for your feed back! I understand now. Ok, I will try to generate my own compiled version using the info giving. Thanks!It's just scrolling up and down the tree list tires my eyes after doing so much. It would be nice if the online doc's had a seach feature of it's own like MS Downlad Center. You can use the dropdown box to trim your search. I mean since TGE features is so rich this could help enormously.
#5
11/28/2008 (7:38 pm)
While not identical to MS CHM, the online documentation does have a search feature. You can search for a word or phrase within the docs and get hits back.
#6
11/28/2008 (9:13 pm)
Man! I didn't notice that.... and I notice it's on the installed doc also! I just tried it and this helps alot! Thanks Again!...
#7
11/28/2008 (11:12 pm)
Man! I didn't notice that.... and I notice it's on the installed doc also! I just tried it and this helps alot! Thanks Again!... 
Torque Owner Nathan Martin
TRON 2001 Network