ClickHelp Documentation

Import from CHM


ClickHelp offers you the CHM import functionality. The CHM format is still one of the most popular formats in the documentation authoring field for the Windows platform. Although, CHM is considered a bit obsolete, still, many applications are shipped with the user documentation stored in this format, and the majority of help authoring tools support it. 

Further, you will learn how to import your existing CHM manual to be able to work with it in ClickHelp.

Project Import from CHM

ClickHelp supports importing an existing CHM manual to create a new project. The importing process preserves the Table of Contents structure, the Index keywords, styles and scripts of the original manual.

To import a CHM file:

  • Go to the Author Dashboard page and hover the mouse pointer over the plus button. 
  • Click Import Existing Manual.

  • Choose CHM file (Microsoft Compiled HTML Help) in the wizard. You can create a new project or add the topics to an existing project

  • If you want to create a new project, give it a name and a Project ID

  • Click Next and upload your CHM file to the ClickHelp file storage (either drag&drop it or browse the way to the file on your PC), and it will immediately appear in the Uploaded Files
  • On the right side of the Import Project Wizard, you need to configure the Topics encoding. Make sure to set this setting if you do not have the encoding specified explicitly in the imported HTML files.
  • Click Next.
  • On the last step, you will see the importing log. You may see some warnings in the log - they are typically about the broken links in the topics, you can fix them later.
  • Click Finish.
Note that you can also import from CHM to an existing project. For this, on the first wizard step, pick the needed existing project from the drop-down box next to Import to.

The standard CHM viewer uses the Internet Explorer control to display the contents. In other browsers, the same styles may look a little bit different. So, you may want to modify the style files of the newly created project: 

  • Select the project on the Author Dashboard page.
  • Click Current project at the top of the page, then click Settings.
  • Navigate to the Basic Settings category.
  • In the Project Styles list, you will see the CSS files imported from the CHM file. Typically, there is only one file there.
  • Click  near the CSS file entry to open it for editing. The editor will open in a new browser window.
  • To start editing the file, click Lock & Edit in the top-right corner of the window.