Share:
ClickHelp Documentation

Import from Microsoft Word

 

In ClickHelp, you can import user manuals stored in the Microsoft Word format to your documentation portal.

As far as Microsoft Word related formats are concerned, ClickHelp supports the following formats for import:

  • DOCX — OpenXML, Microsoft Word 2007, and later;
  • DOC — Microsoft Word 97-2003;
  • RTF — Rich Text Format.
Important
For a Microsoft Word file to be imported to ClickHelp correctly, you need to accept all the changes in this document. For this, find the Review tab in Microsoft Word, and go to Review > Accept > Accept all changes in the document. Save the file and proceed with the steps described below.

 To import a Microsoft Word document from your PC:

  1. Open Author Dashboard and click the Import Document button. 

  2. In the Import Project Wizard, pick Microsoft Word file, and where to import the content. You can create a new project or add the topics to an existing project
  3. If you want to create a new project, give it a name and a Project ID.
  4. Click Next. You'll see the Import Settings step of the Wizard. First, let's place the Microsoft Word file in the specified area on the left (either drag&drop it or browse the way to the file on your PC), and wait for the file to finish uploading. You'll see its name near the top of the drop area when it's ready.
  5. On the right side of the window on the same step, you need to configure the import. First, choose an appropriate way of splitting your document into topics. You have the following four options to choose from:
    • Style outline level (Heading 1, Heading 2...) — a new topic will be created with each Heading specified in the document. Different levels of Headings will become parent and child topics respectively.
      Important
      Don't forget to specify the Max outline level. It will influence the depth of the TOC hierarchy ClickHelp will create.
    • Paragraph outline level — topics will be defined by the outline levels specified in the document's paragraph settings. The hierarchy will be preserved.
    • TC fields — topics are defined by TC fields (special invisible elements used in the Microsoft Office to define Table of Contents) of the MS Word document .
    • Import as a single topic — the whole document will be treated as one topic.
  6. Choose how ClickHelp should handle the styles in your MS Word document after the import. There are three options available. In the dialog itself, you can read some basic information about those three options. To get more in-depth information, check the Handling Content Styles help topic.
  7. You can also choose the Image format for the images from your document. PNG and JPEG are available.
  8. If you chose to import the document into an existing project, this settings page will have one more drop-down box allowing you to pick the way the Imported Styles are treated — whether they are copied to a new style file or to a file existing in the project.
  9. Check Generate CSS classes if you want inline styles from the imported project copied to a CSS file, and CSS classes created with automatic names for repeated classes.

    Note
    CSS classes are created for all the imported styles. The names of the CSS styles represent their encoded attributes (for example, for the bold font, the class name is cs0719DCD37). This means that two CSS rules with different names but with the same properties will be detected and merged into one rule. For this to happen, we strongly recommend using the Existing style file and Optimize styles options, especially, when uploading multiple documents into one project, as the style cleanup is performed and duplicated styles are handled. If you need to find and replace those created CSS classes, use Global Find and Replace.
  10. Click Next and proceed to the third wizard step where the import itself is performed.

  11. Click Next to get to the finishing step. You'll see the window containing links to your imported project and styles.

  12. Click Finish.

Following these steps, you will successfully import any amount of documents into your user manual having it perfectly structured and styled right at the import.

Learn more about MS Word import specifics in this section: