ClickHelp User Manual

Documentation Outputs FAQ

ClickHelp User Manual/ClickHelp FAQ/Documentation Outputs FAQ

Frequently asked questions about generating different types of documentation outputs.

Can users download a PDF version of the documentation? 

Yes. You need to prepare the PDF file beforehand, add it to the ClickHelp File Storage, and insert a link to it into the header or footer of your help topics. Pay attention to conditional styles and elements - you can vary the content style and structure when preparing for the PDF output (remove video elements, remove topic footers, etc.). 

What are the options for using conditional tags? 

With conditional tags in ClickHelp, you can create multiple versions of the same documentation by hiding or showing parts of the content. You can use conditional blocks inside a topic content to make some parts conditional. You can assign Output Tags to topics in the Table of Contents to include/exclude them. You can even make project style and script files conditional by assigning Output Tags for them in the project settings. Learn more on Output Tags: Output Tags.

How do I specify output tags for my output? 

Output tags are created here: ToolsGlobal SettingsDynamic OutputOutput Tags. After you create some tags, you will be able to use them for different parts of documentation — assign them to text blocks, topics, style, and script files. Later on, when you are ready to publish your projects, you specify one or several Output Tags on the first step of the Publish Wizard (in the advanced settings). Learn more on Output Tags: Output Tags.

Can we create private publications available only to some clients? 

Yes. You can create Restricted Publications and grant access only to certain Power Reader accounts. To learn more about the Power Reader account type, check this topic: Power Reader Accounts. To learn how to create documentation with restricted access, read Restricted User Manuals.

How to specify export configurations (if I want to export to PDF/DOCX/ePub, etc.)? 

When exporting a publication, open the advanced publishing settings in the Publish Wizard. You will see a combo box where you can choose an export configuration (or, create a new one and set it up as you move further in the Wizard).