Page Comparison

Background

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

...

The intended audience of this document is the Weave system administrator. 

...

Help

...

The help option can be added to the Weave map client and is accessed by clicking on the Question question mark action button in the map toolbar. On clicking the button, the Help window opens which allows the user to obtain information about the map functionsMap toolbar.

...

Prerequisites

• The Weave Help function requires two bundles which are:

  Code Block
  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 which as this bundle contains the help content.

Updating the config.ini file

...

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:

...

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

<item action="weave.help">
  <startPage>resources/weave/help/html/index2.html</startPage>
  <windowTitle>Weave Help</windowTitle>
</item>

Note that the startPage value is not required (nor is the windowTitle value), and if not set will use the default start page, but . 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.