Client Actions Help

Weave provides a default Help option that can be added to the Weave Map client. This has standard help pages but can be customised for your project.

The Help option is accessed by clicking on the question mark action button in the Map toolbar.

Open

Open

Prerequisites

• The Weave Help function requires two bundles which are:

  com.cohga.client.weave.help (version 1.2.5 at the time of writing) com.cohga.client.weave.help.content (version 1.0.2 at the time of writing)

• Customised help pages are added to the com.cohga.client.weave.help.content bundle as this bundle contains the help content.

Updating the config.ini file

In order for Weave to start the help bundles, an entry needs to be added to the platform\configuration\config.ini file for each bundle.

These two entries may already exist in config.ini but in case they do not, add the following lines to the end of the file and make sure that the preceding line (last line in the current file) includes a comma and backslash:

Map client configuration

Open your map client XML file and add the following code snippet to the toolbar definition. Save the file and refresh the browser.

Note that the startPage value is not required (nor is the windowTitle value), and if not set will use the default start page. But you can change the value if you want the user to see a different page when first opening the help, for example if you add custom content and want to include your own custom start page.