Share:
ClickHelp Documentation

Create a Web Help Manual

In the  ClickHelp documentation tool, you can create different kinds of outputs for your documentation using the single-sourcing techniques,. Also, you can choose your output format that will cover your needs. Among other formats, ClickHelp supports the Web Help output.

What is Web Help?

Web Help is a file-based format - it comes in a form of a set of HTML files, accompanied by images, CSS and script files. Those are static files that have no connection with the documentation tool where they were created. This is a great way to view the browser-based documentation offline, as well as host it on your own web server. One of the most popular use cases for Web Help is hosting it inside isolated networks that don't have Internet access.

Web Help documentation contains a Table of Contents and Search for easier content navigation, and may have other functions as well.

Typically, it can be opened in any web browser - either as a file stored on disk, or as a web resource hosted on a local web server.

Exporting Publications to Web Help

To create a Web Help manual in ClickHelp, do the following:

  • Once you have published a project, choose your Publication and start the Export Wizard (for example, you can do this from the Projects page of your ClickHelp portal).
  • Choose HTML5 Web Help from the list of suggested export formats:
     
  • Follow the wizard steps. The last one will provide you with a download link:
     
  • Click the link to download the archive to your PC. This will be a zip archive with all the required files inside.

The archive content will look something like this:

Now, your exported Web Help documentation can be shipped with your product and opened in a web browser offline, or you can host it on your own server.

The easiest way to open the Web Help in a browser offline is to double-click the index.html file in the root folder of the archive.

You can also reach any topic directly by opening its HTLM located in the HTML folder of your Web Help archive.

This is an example of how your Web Help documentation will look when opened in a browser:

Creating Links in Web Help

Each help topic of your Web Help documentation has a unique URL. This makes it easy to create links for topics. A default link address looks like this:
.../index.html#topic-name

The Web Help documentation also supports anchor links (links to certain topic sections). The anchor links look like this:
.../index.html#topic-name/a/anchorName

In the example above, you can see the topic name in the URL followed by the "a" keyword and then the anchor name goes.

Learn more on Help Authoring Basics here: