ClickHelp User Manual

Topic Editor - Design Mode

ClickHelp User Manual/Authoring/Topic Editor/Topic Editor - Design Mode

ClickHelp offers a multifunctional Design mode to make authoring easier and more efficient. The content displayed in your Design mode will look similar to your final output. This is a simple and convenient way to make your documentation look the way you want it to.

Let's take a closer look at the Design mode ribbon bar.

Home Tab

The Home tab has all the basic functionality of an MS Word-like text editing tool (like changing the font style, size and color, creating bullet or ordered lists, aligning your content on the page, etc.). Pay attention to the fact that you can quickly proceed with editing or managing your project CSS files by simply clicking the Open '.css' For Editing...  or Manage Project Style Files element correspondingly in the Styles section. The CSS editor or the  Project Styles options will open in a new browser window.

The View section switches the Full-Screen mode on and off. The Spell Checker section contains the Check Spelling feature and the Validation section contains the feature that finds broken links.

The Home tab of the Ribbon bar

Insert Tab

The main purpose of the Insert tab elements is adding some content to your topics other than ordinary text. Using this tab's functionality, you can quickly add to your docs such elements as videos, images, links, anchors, warning boxes, etc. The Navigation section allows inserting links to the Top , Next , or Previous topics with just a couple of clicks. To add some Conditional Content to your topic or make your current content conditional, click the Single-Sourcing tab of the More section or simply choose the corresponding tab from the Design mode ribbon bar. 

The Insert tab of the Ribbon bar

Single-Sourcing Tab

The Single-Sourcing tab offers a wide range of options for Conditional Content to choose from. Here, you can insert or manage your Variables in the Variables section, quickly insert a Snippet of a topic in the Snippets section and, also, fulfill one of the most common tasks in documentation authoring - create Conditional Content using the Output Tags in the Conditional Content section. Plus, the Single-Sourcing tab features a Help section that stores basic information on Conditional Content.

The Single-sourcing tab of the Ribbon bar

View Tab

The View tab allows you to see how your Output Tags will affect the topics display. You can manage your tags in the Output Tag Preview section, and get a clear picture of what this or that Output Tag does to the final output.

The View tab of the Ribbon bar

Table Tab

The Table tab includes various options for table creation. Here, you can easily modify your table using the Delete, Insert and Merge sections. Also, you can set table properties in the Properties section. They can be applied to either the whole table (Table Properties) or its elements ( Row, Column, and Cell properties).

The Table tab of the Ribbon bar