Share:
ClickHelp Documentation

Creating a Custom Word Template

ClickHelp supports exporting documentation using a Word template.

You can use our built-in Word template file for reference. It works out-of-the-box. The template file is located in the ClickHelp File Storage:   Storage/Templates/Printed Manual Export Template.docx

This template can be customized. Also, you can create a Word template anew. Further on, you will learn about the Word template structure and styling.

Template Placeholders

A Word template should include several placeholders: {{TOPICS}}, {{TOC}}, and {{TITLE}}. Placeholders are elements that will be replaced with actual content from your project.

  • {{TOPICS}} - this placeholder is required. All topics content will be placed here. So, it is critical that you have it in your Word template.
  • {{TOC}} and {{TITLE}} are optional placeholders. {{TOC}} will be replaced by the Table of Contents while {{TITLE}} displays your Document title (Publication name).

The placeholders in a template file are just text elements. Take a look at the screenshots below to see how they look like in our default template file.

First, the {{TITLE}} placeholder on the cover page:

Then, the {{TOC}} and {{TOPICS}} placeholders:

 
Information We recommend placing the {{TOC}} and {{TOPICS}} placeholders one under another - without a page break between. As the {{TOPICS}} placeholder creates a page break of its own, the duplicated page breaks will cause an empty page to appear.

Styling a Word Template

A Word template can be customized and styled according to your needs. In this section, you will learn how basic elements like headings, TOC items, and a page background can be changed.

Setting a Custom Background Image

ClickHelp supports the following way of setting up a page background image: 

  • Insert the desired image into either the header or the footer of a page.
  • Resize it according to your needs (it can cover the whole page, half of it, etc.).
  • Choose Behind the Text for this image display.

Inserting a background image this way will let you have the same background on every page of your document (you can set a different background for the first page, which is usually a cover page).

Styling Headings

Headings in a Word template should be styled in the following way:
  • Style a Heading the way you need (change its font, color, font size, etc.)
  • Select the text of this customized Heading.
  • On the Home tab under the Styles section, right-click the needed element (depending on which heading style you want to set up now: Heading 1, Heading 2, etc.) and choose Update Heading ... to Match Selection:

This will assign this style to all headings of this kind in this template. You can set each Heading type this way. The text that you used to create the customized style can be deleted - Microsoft Word will still store all updated styles for this document.

Styling TOC Elements

Apply styling to the {{TOC}} placeholder, and it will be applied to the TOC items.

Information If you are going to create a Printed Output of a project, we recommend publishing your project with the PrintedDoc output tag. This way you will have the document better suited for the printed format.