ClickHelp User Manual
Use Web Help as Context Help Source
Usually, the Context Help feature is used to show the content from a live online publication. However, 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:
- Go to Properties → Context Help of any topic.
-
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:
- Download the script file from your portal using this URL.
- Host it alongside your HTML 5 WebHelp content.
- Change the URL in the context help snippet to reflect the new custom location of the script file.
- 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:
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"). |