Skip navigation.
Software » web2help » web2help guide » Overview

Overview


web2help is an authoring tool for CHM help files.

web2help assumes that, somewhere in the web, you created your help pages. The reason is that it is very easy to put a bunch of web pages on the web; and there is an infinite number of tools that will help you in generating and maintaining a web site, including CMS's (we suggest MODx) or wiki systems.

Once you have your documentation ready on the web, you must tell web2help how to "parse" your HTML pages to extract useful things and throw away all the rest (navigation menus, advertisement, etc.). Don't be afraid of this! Parsing is done automatically by web2help, you just need to tell the program what to pick from the parsed content. You'll perform this step only once, for your entire documentation site.

Finally, tell web2help the URL's of the pages you want to grab. Organize them as a tree (it will be the summary tree of your help file). Hit "compile", and your help file is ready!

web2help will grab the help files and all the embedded resource files (images, etc.).

Prerequisites

In order to compile the CHM file, you need to download and install the official CHM compiler from Microsoft, i.e., HTML Help Workshop. It is freely available on Microsoft web site. Please install it in the predefined directory.