ClickHelp User Manual

Use Web Help as Context Help Source

ClickHelp User Manual/Publishing/Context Help/Use Web Help as Context Help Source

Usually, the Context Help feature is used to show the content from a live online publicationHowever, the context help is also available even if you host documentation on your own server instead of the ClickHelp Documentation Portal. To implement context help in a Web Help user manual, do the following:

  1. Go to Properties Context Help of any topic.
  2. Under the Context Help HTML Code, you will see the HTML code snippet generated by the system. Find the code line that contains a context help script reference: The code line in the Context Help HTML code
  3. Download the script file from your portal using this URL. 
  4. Host it alongside your HTML 5 WebHelp content.
  5. Change the URL in the context help snippet to reflect the new custom location of the script file.
  6. Change the topic URLs in the snippets so they point to the HTML files of your WebHelp and not to the portal. The URLs are stored in the data-chpw-contentUrl parameter value:The topic URL stored in the data-chpw-contentUrl parameter value in the Context help HTML code

This way, you will be able to use context help for your Web Help documentation.

Tip
It is possible to embed a Web Help search panel into web applications (specify the "noredirect" URL parameter for that) and, optionally, make the panel display search results for a query pre-defined via the "q" URL parameter (like "search.html?noredirect=1&q=test").