ClickHelp Documentation

Requirements and Platforms

ClickHelp is a browser-based help authoring tool. To use it, all you need is a web browser.

Many ClickHelp functions use the client-side JavaScript to provide responsive UI to technical writers. Some web browsers may require additional configuration to allow script execution. In most situations, when scripting is disabled, ClickHelp will notify you about this. It will also give you the steps to fix the browser settings. When it does not do so, read this help topic to learn how to proceed.

Supported Web Browsers

  • Mozilla Firefox
  • Google Chrome
  • Microsoft Internet Explorer 9+
  • Microsoft Edge 79+ (Chromium-based)
  • Opera
  • Apple Safari
  • Most browsers based on WebKit

Your web browser is not on the list? Web applications are supposed to be accessible from almost any web browser. ClickHelp is also built with this idea in mind. We are using technologies supported by the majority of existing web browser. So, even if your web browser is not explicitly listed above, give it a try - it will probably work. If there are any UI glitches, contact our Support Team and provide a screenshot or a video of the issue - we will try to sort things out!

Enable JavaScript in Your Web Browser

Browsers interface and settings are constantly changing. You can find an up-to-date set of instructions for the major web browsers here:

Browser-Specific Requirements: Internet Explorer

Internet Explorer is well-known for its restrictive environment. In certain IE versions, having JavaScript enabled is not enough. Specifically, some complex popup dialogs of ClickHelp (like File Managers) run in an IFrame for better user experience. To make sure those dialogs work properly, add * to the Trusted Sites list in Internet Explorer options. Here are the steps:

  • Click the Tools button, and then click Internet options.
  • Click the Security tab, and then click the Trusted sites security zone.
  • Click the Sites button.
  • Clear the Require server verification (https:) for all sites in this zone check box.
  • Enter this web site URL to the edit box: *
  • Click Add.
  • Click Close, and then click OK.
  • Close all Internet Explorer windows, and re-start the browser.

Here is a demonstration of the process:

Adding ClickHelp to Trusted Sites in Internet Explorer Options

Internet Connection Requirements

ClickHelp is an online solution with rich functionality, it requires a stable Internet connection. The minimum required connection parameters are listed below:

  • Download speed: at least 20 MBits/second
  • Upload speed: at least 20 Mbits/second
  • Ping time: less than 150 ms