ClickHelp User Manual

Step 2. Create Help Topics

Previous Step:   Step 1. Create a Project  

In this topic, you will learn how to work with the content in ClickHelp:

First, let's take a look at our newly created Project. You can open it from Author Dashboard - select the project and click it to open:

Select a project on the Author Dashboard

Once you click, you'll see what your Project contents look like so far. There are two main areas as shown in the screenshot below. The Table Of Contents ( TOC ) is to the left and the topic content area is to the right. The TOC tree already has three topics created. These are sample topics demonstrating what type of content you can create, and giving a short overview of the main content editing functions.

Adding New Content

  • Let's create a New Topic by clicking the plus button. 
    Click the Plus button to create a new topic
  • You will see a window just like the one in the screenshot below. There, you'll need to specify your topic's title, ID, what content will be used and location:
    Create New Topic dialog

To learn more, refer to this article: Create a Topic.

  • Now, you can see the newly created topic in the TOC.
    The newly created topic in the TOC
    The default topics can be deleted, they are only examples. To delete a topic, select it in the TOC and click the right mouse button, and select Delete.
  • Select your new topic in the TOC and click the Edit button in the top part of the page. The topic will open in the Design mode.
    The Design mode of the topic editor
  • Let's delete the default content and add our own. The Font section helps a lot with some quick editing. For example, to make the text bold, select the needed word and click the corresponding B element as shown on the screenshot.
    Make the text bold using the Fonts section on the Ribbon Bar
  • The selected text will become bold:
    Bold text in the topic
  • This is how a Heading is created in the text. Select the desired text snippet, go to the Styles section, and pick the needed Heading from the dropdown menu:
    Choose a Heading in the dropdown menu 
  • The selected text will be marked as a heading, and the corresponding heading style (depending on the template you use) will be applied:
    Heading in the text 
     Learn more about topic styling here.
  • If you want to change a Topic's title, you can just hover your mouse pointer over the title line marked on the screenshot below and click it.
    Change a topic's title by hovering a mouse over the title line
  • The click will lead you straight to your topic's properties. Here, you can change the title and the ID. Don't forget to save your changes by clicking the green Save Changes button in the top-right corner. Then, click the Back to topic link right above it. But, we really like the title, so we'll leave it as it is.
    Topic title in the topic's properties

Inserting Images

Now, let's add an image to our manual. We will be uploading it from our computer. To do this:

  • Go to the Insert tab on the topic editor's ribbon bar.
  • Click the Image element in the Media section. The following dialog will appear:
    Insert Image dialog
  • Drag and drop the needed image to the dialog, or click in the center of the drop zone to browse your computer.
    Preview section in the Insert Image dialog
  • You will see your image appearing as a preview to the right and, as a file in the File Storage to the left.
  • Click OK.

Now, we have an image in our Topic.  Well done! This is what our topic looks like now:

Image inserted into the topic

Adding Links

Let's learn how to insert other basic elements to the contents - links. We are going to reference the wiki article we took our content from.

To create a link:

  • Go to the  Insert tab of the editor's ribbon bar.
  • Click the Link element in the Links section. You'll get the Insert Link dialog:
    Insert Link dialog
  • As the link source is located outside our Project, select the Web Link radio button at the top of the dialog.
  • Fill the URL, Text, and ToolTip fields like this:
    Web Link radio button at the top of the Insert Link dialog
  • Click OK. This is what the link will look like in the text:
    The link in the text

We have just created a link. Great job!

One more thing we will learn here is how to insert  Warning Boxes.

Inserting a Warning Box

When you want to emphasize some important piece of information and draw the readers' attention to it, you can use a Warning Box. To insert it, do the following:

  • Go to the Insert tab of the editor's ribbon bar.
  • Click Insert and select the Warning Box in the Quick Parts section. 
  • Type the warning's text inside the box element that will appear in the topic contents.
    Warning Box in the text

Congrats on creating a Warning Box!

We have completed creating the Project content. In a real project, you can create many topics and organize them in a tree-like structure in TOC. For the sake of simplicity, we will keep only one topic in our test project and proceed with the project publishing.

Next step:  Step 3. Publishing a User Manual