Distributing online Help

The way you distribute your online Help depends on the Help format you are delivering and how it's going to be used. The following information briefly summarizes the different distribution methods.

  1. HTML Help for applications: This kind of Help is intended to describe how to use a Windows application and it often includes context-sensitive Help. HTML Help is compiled into a single .CHM file, making it convenient to distribute with an application. If you are delivering a set of .CHM files that are part of a large project, you distribute all .CHM files as a group. You provide your developer with the .CHM files and they are included with the application so everything is properly installed on end users' systems.

  2. HTML Help standalone: This kind of Help can be used as an online book, training guide, technical support manual, sales catalog or some other type of documentation that is not used with an application. All of the information contained in the Help project is compiled into a single .CHM file for easy distribution. You copy this file on disk or CD and distribute to end users.

  3. WebHelp (cross-platform Help): This kind of Help can be used with an application or as a standalone product (for example, on Web sites, corporate intranets, online books, etc.). It is in uncompiled format and all the files you need to distribute are generated and saved in a subfolder in your project for easy distribution. For cross-platform Help, you provide your developer with the files so everything is properly installed on end users' systems. For intranets and Web pages, you provide your Webmaster with these files so they can be posted to your company's server. You can also copy the files on disk or CD (if your project will be used as an online book, training guide or some other online document) and distribute them to end users.

  4. JavaHelp: This kind of Help is used with applications written in the Java programming language. It can be distributed in both uncompressed or compressed format (with or without source files). All the files you need to distribute are generated and saved in a subfolder in your project for easy distribution. You provide your developer with copies of these files so they are properly installed on end users' systems.

  5. Oracle Help: This kind of Help is primarily used with applications written in the Java programming language, but can be used with applications written in any language. Oracle Help can be distributed in either uncompressed or compressed format (with or without source files). Files for your finished project are generated and then saved in a subfolder within your project. You provide your developer with copies of these individual files or a compiled file.