Share:
ClickHelp Documentation

Content Importing and Migration

If you are migrating your content from another help authoring tool, you can use the ClickHelp content import functionality to make the migration easier. Here, we will consider important things to pay attention to while migrating your documentation to ClickHelp.

Prepare Your Content for Migration

Think over the following things:

  • The future structure of your projects.
  •  How many projects you need in ClickHelp.
  • Your projects will be separated, or you will unite them in one project in ClickHelp and use conditions to generate different outputs.
  • Pay attention to things like styles and scripts that are specific for the tool you're migrating from. It's better to delete them if you don't need them. Thanks to Global Find and Replace, you can find all these things and replace them after the migration.

Choose Documentation Format for Migration

ClickHelp supports different import formats:

  • CHM file (Microsoft Compiled HTML Help). This is the recommended format since its internal structure is based on HTML, which provides the best import results.
  • HTML/XHTML/Web Help zipped (topics, images, styles and scripts in a single .zip archive)
  • Microsoft Word file (DOC or DOCX)
  • RTF file (Rich Text Format)
  • ODT file (OpenDocument, OpenOffice.org file format)

What should you choose? Here are some notes to help you decide:

  • As content is stored in the HTML format and styles are in CSS in ClickHelp, the best way is to import content in the HTML format. In this case, your docs formatting will be imported better. To learn more, refer to this topic: Import from HTML.
  • The WebHelp format contains additional files like navigation, scripts and the like, so if you import a WebHelp file it will be required to clean up the formatting before and after importing - delete unnecessary HTML files like master pages or search pages. Moreover, topics are stored in one folder in a WebHelp file, so after importing they will be on the same level, and you will have to reorganize them manually. It's easy with the drag&drop support in the Table of Contents panel.
  • The MS Word format is not the same as the web formats but TOC structure will be imported correctly. ClickHelp will handle Styles in your MS Word document after the import, you just need to choose the Optimize styles option, it performs style cleanup to make it easier to maintain the imported content in the future. To learn more, refer to this topic: Import from Microsoft Word.
  • What should you do before and after migration? Before exporting your manual from your current tool, check your content, delete the documents and files you don't need to migrate. Then look through your content after migration to replace older elements generated by your older tool (See Also lists, Next/Previous navigation links, footers and headers) with those offered by ClickHelp. Use Global Find and Replace to find and delete (or replace) those elements items.

Here is a table from which you can learn what format is best for migration from various tools to ClickHelp:

Current Documentation Tool Recommended Exporting Format
FastHelp CHM
RoboHelp CHM
MS Word DOC, DOCX
Confluence HTML
Flare CHM

Instructions on Importing

Here are instructions on how to import documentation in different formats: 

If you have questions or issues on migration, the ClickHelp team will be happy to help you. Contact us at support@clickhelp.com.