Moxi Media Inc.
<tools> Discussion Forum

IMF Developer's Guide » Site Configuration » <tools>  

The <tools> element is used to define a set of map tools. The tools element should contain multiple elements with button and tool definitions. Spaces can also be added between the buttons and tools on the toolbar.

Note: At v4.0.6, tools, buttons and spaces are defined with separate elements per the specification below. The <help> sub-element has also been dropped and replaced with an attribute.

You may define multiple toolsets with different names. Each toolset can contain a different set of tools and a separate help document to describe the tools. To open a toolset other than default when the site is started, follow the following example:

<tool-frame url="$FRAMEWORK/imfTools.jsp?toolset=markup" />

To use the default toolset, the toolset argument above can be omitted, or called with the toolset named "default". To switch toolsets from a tool in the toolset, define a button as follows:

<button name="Standard Tools"
        url="$FRAMEWORK/imfTools.jsp?toolset=default"
        target="toolFrame"
        hint="Standard Tools"
        status="Shows the standard tool set."
        graphic="$FRAMEWORK/tools/tools_close.gif"
        width="16" height="16" />

Frequency Parent Elements (this element is valid within):
PRS+ <site-config>
   

Frequency Child Elements:
O+ <button>
O+ <space>
O+ <tool>
   

Frequency Description (in this context)
PRS+ The <tools> element must appear one or more times within the parent <site-config> element in the specified sequence.
O+ The child element may appear zero or more times within the <tool> element in any order. However, at least one tool or button must be defined.
   

Attributes Description
active The name of the tool that is active when the site opens. Required.
description A text description of the toolset for use in the imfToolsets.jsp script that can be shown to the user to change toolsets.
help The help document for the toolset. Optional, defaults to "$FRAMEWORK/imfHelp.jsp".
toolset The name of the toolset, made up by the designer. Use "default" if there is only one toolset defined. Required.