×

Publishing CHM file

 
CHM file is one of the most convenient ways to deliver your software help in a single indexed file together with your application setup bundle. Using HTMLHelp API you can open a specific topic within the CHM file (e.g. by file name or Help Context ID number). With CHM you can implement context sensitive help functionality in your software application.
 
 
 
There are several ways to publish your help project to CHM:
  • click button in the application toolbar;
  • go to the Options menu and click the Export to CHM menu option;
  • use the Alt+Shift+M keyboard shortcut.
 
The following dialog window will appear:
 
Publishing CHM file
 
1

Path field

1. Path field
 
Click Browse... to specify the path to the exported file.
 
Click button to open target folder in Windows Explorer.
2

Run validation tool

2. Run validation tool
 
Check this option to validate your project files before publishing the CHM file.
3

Open CHM file

3. Open CHM file
 
Clear this checkbox if you don't want to open the generated CHM file once the export process finishes.
4

Progress bar

 
This bar shows the progress of the publishing process.
5

Process log

 
This section shows the log messages of the publishing process.
6

More options

6. More options
 
 
Click this button to display the CHM export settings dialog where you can configure the options for the output files.
7

Start/stop export

7. Start/stop export
 
 
Press this button to start the publishing process. Once it started, this button turns into the Stop export button. Click Stop export to stop the publishing process (e.g. if you need to make changes to your project).
8

Close

8. Close
 
 
Press this button to close the Export to CHM file dialog.
 
Upon completion of the publishing process, Dr.Explain will open the generated CHM file (if you didn't clear the Open CHM file checkbox):
 
Made by Dr.Explain, software documentation tool