Getting Started with Paligo

Context-Sensitive Help

There are many ways to create context-sensitive help, and it's possible to create custom solutions. But Paligo has an easy way built-in to do this in the HTML5 output.

Usually, creating context-sensitive help means mapping the id from the software component in your product that needs a help topic connected to the id of the topic itself.

This is normally done in what is called a mapping file (or sometimes a "header" file). Paligo automatically creates this mapping file for you, if you do as follows:

  1. Get the id's for the application components in your product.

  2. In the topic corresponding to a particular application component, add the attribute xinfo:appid on the top (section) element in the topic.

  3. Give the attribute the value of the component(s) that should open this topic. If there are multiple components calling the same topic, separate them with semicolons. For example:

    imagedialog_123;imagebrowser_234

  4. Publish the publication. This creates a mapping file in JSON format that will automatically be used to map any url requests to the right topic.

  5. In your product, your developers can call the context-sensitive help using the internal application id's as a string parameter. For example:

    www.youronlinehelp.com?contextId=imagedialog_123

Note

Note that the JSON mapping file can also be created manually, looking at the format produced above, but the above method is usually easier and more reliable. Should something be changed after publication, however, there's no problem editing it manually for that purpose.

Should you need to publish any other type of context-sensitive help, than the built-in version, please contact support for assistance.