The <settings-menu-option> element is used to control the options
displayed on the Settings Menu page (imfSettingsMenu.jsp) in the IMF viewer.
Items on the Settings menu page are intended to support user-definable preferences.
This element may be repeated multiple times to define the individual options that
appear on the page.
The options shown on the Settings Menu page are a combination of the values
read from the default site configuration file and the application's site configuration
file. If an option is found in both files, the one in the application's site configuration file
replaces the value defined in the default file. To turn off an option set in the
default site configuration file, define an option in your application's site configuration
file with the same description and the enabled attribute equal to false.
| Frequency |
Parent Elements (the <settings-menu-option> element is valid within): |
|
POS+ |
<site-config> |
| |
|
|
| Frequency |
Description (in this context) |
|
POS+ |
The <settings-menu-option> element may appear zero or more times
in the <site-config> element in the specified sequence.
|
| |
|
|
|
Attributes |
Description |
|
title |
The short title before the description for the option on the Settings Menu page. Required.
|
|
description |
The text description for the option to appear on the Settings Menu page. Required.
|
|
url |
The URL of the script to run when the option is selected. The URL can contain the
special variable $IMF or $IMF to specify that the document is relative to
the IMF installation directory. Absolute URLs or javascript references may also
be used. URLs that don't start with http: or javascript: or $IMF or $IMF
are resolved relative to the location of the XML file. Required.
|
|
target |
The name of the frame that the url should be executed in. Suggested choices are
"dataFrame", "hiddenFrame" or "_blank". Optional, defaults to "dataFrame".
|
|
enabled |
Whether the option appears on the settings menu page. This is used to turn off
an option that has been defined in the default site configuration file.
Valid choices are "true" or "false". Optional, defaults to true.
|
| |
|
|
Example:
<!-- Note: not a real IMF script. -->
<settings-menu-option title="Projection" description="Change the map projection." url="changeProjection.jsp" target="dataFrame"/>
