mxp.plugins.HelpButton

Needed Files

In order to use this plugin you need to include this files in the build.cfg:

• src/mxp/plugins/HelpButton.js and its dependencies

NOTE: In the default configuration these files are present.

Plugin description

This plugin allow to add a custom help button to MapStore Manager. This will show an help window with a checkbox that allow the user to disable the show on startup for the next times.

Configuration Example

You can configure it adding this plugin with this configuration:

    { 
        "ptype": "mxp_help",
        "text":"Help", 
        "title":"Help Window",
        "fileDocURL": "my_startup_page.html",
        "actionTarget":{
             "target": "north.tbar",
             "index": 6
            }

    }

The basic parameters are:

• fileDocURL: The URL of the window content ( if present the window will display an iframe)
• description if fileDocURL is null, this configuration string will contain the html to display in the window.
• showOnStartup Display the window on startup.