ClickHelp User Manual

Creating Content FAQ

Frequently asked questions about content creation.

Can I insert videos into topics? 

Yes, you can. ClickHelp supports inserting videos from such video-sharing websites as Vimeo, YouTube, To learn more, check out Insert Videos.

Can I update a specific screenshot in all topics at once? 

Yes, you can. Images are stored in your portal File Storage and referenced in topics. You can replace a specific image file directly in the File Storage using the File Manager dialog in the main menu — all topics that use the screenshot will start showing the new image. We recommend that you store your screenshots and images in some logical folder structure rather than in a single folder - this makes the update process easier.

How do I create a link for file download? 

To create this kind of link, first, upload the file to be downloaded to the ClickHelp File Storage. Then, go to the Insert tab of the Design mode ribbon bar and click Link in the Links section. Choose the File link type and specify the URL to your downloadable file. Type the link text in the corresponding field and click OK.

Can I create links to topics from other projects? What about links to my website or Twitter? 

Yes, you can create any link type. This functionality is available for you in the Insert tab of the topic editor’s ribbon bar — when you click Link, the Insert Link dialog gives you a choice of several link types.

How can I insert a footer snippet into all topics? 

First, create a topic and fill it with your footer content. Make sure this topic is excluded from publishing (in the topic properties, set Do not publish) so it does not present in the Table of Contents as individual documents. Then, insert this footer topic into other topics as a Snippet — via the Single-Sourcing tab of the Design mode. This will make it easier to update the footer in all topics at once.

How can I remove a footer or a header snippet? 

To remove a footer/header snippet, switch to the editing mode for your topic, click the label of the Snippet (at the top-left of the Snippet box), and press Delete on your keyboard.

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.