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. 

Important

Migration and import are not the same. Import is a tool that significantly speeds up the migration process, but it is only a part of it. You should always manually check every import to ensure no content is missing, and the styling is preserved where necessary.

In ClickHelp, we provide Migration Services. Contact us at support@clickhelp.com if you're interested!

Further, you will learn how to import your existing CHM manual 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.

Note
When importing a CHM file to ClickHelp, its chapters and pages are converted to topics nodes with children and topics without children. But if a CHM page is set as an empty topic, ClickHelp will convert it to a folder. You can read about the difference between topics and folders here.

To import a CHM file:

  • Go to the Author Dashboard and click Import Document.
    Import Document button on the Author Dashboard
  • Choose the CHM file (Microsoft Compiled HTML Help) in the wizard. You can create a new project or add the topics to an existing project
    Choose the Import format and the Import to options in the Import Poject wizard
  • If you want to create a new project, give it a name and a Project ID
    Specify Project name and Project ID in the Import Project wizard
  • 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
    The Uploaded Files field in the Import Project wizard 
  • 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.

The standard CHM viewer uses 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.