Share:
ClickHelp Documentation

Create a PDF Manual

ClickHelp is an online help authoring tool that allows using the single-sourcing techniques to get multiple outputs from the same source.

The source is your ClickHelp project - you use variables, conditional blocks and snippets in your project topics. Depending on the output you want to get, you publish this project with varying settings that match the specifics of the target format. As a result, you will get multiple publications, each of which may be targeted for a set of formats.

For example, one publication will be visible to readers online - this one will use all the beauty of CSS 3, backgrounds, dynamic elements, videos, animations, etc. And another publication of the same project will be targeted for printed formats like PDF - it will exclude any dynamic elements (by using conditional blocks, or styles) and will use a simplified CSS stylesheet without shading, glowing and other things that may not look good in the grayscale printed format.

To create a PDF manual, follow this process:

  • Click Publish under a project name.

  • Choose PDF file from the dropdown list and click Next.

  • To make sure only ready content is exported, enable the Publish only Ready topics option.

  • Choose Printed output settings. You can use MS Word template, this format is easy-to-use. Click Next.

  • Specify the heading elements and click Next. It'll trigger the export process.

  • Once you click Next, you will see the exporting progress. Once it is completed, you will see a link to the exported file - click it to download the file.

You can also create a publication first, and then export it:

  • When the content is ready in your project, create a publication with the settings matching the specifics of the PDF/printed document format.
  • Once your project is published, open your Portal Dashboard and click Export under the publication name.

  • Step 1
    Select the PDF format, and specify the output file location in the ClickHelp file storage.
     
  • Choose Printed output settings. You can use MS Word template, this format is easy-to-use.
  • Step 2
    Specify the heading elements and click Next. It'll trigger the export process.
  • Step 3

    Once you click Next, you will see the exporting progress. Once it is completed, you will see a link to the exported file - click it to download the file. 

    You can find the resulting file in the ClickHelp file storage - click File Manager in the main menu.

  • Using Export configuration
  • If MS Word template format is not appropriate for you, you may create a new export configuration by selecting [Use Export configuration] and  [New...] in the drop-downs and click Next. The export configuration will store your exporting settings, so you can re-use them later.

  • Step 2
    Configure the cover page and the Table of Contents styles.

  • Step 3
    Specify styles for the heading elements - you can use different settings for different heading levels. 

  • Step 4
    Now, it's time to select the paper size for the output and page orientation.
    You can also enable page numbering on this step.

Once you click Next on step 4, you will see the exporting progress.

You can also find the resulting file in the ClickHelp file storage - click File Manager in the main menu.