The APPLETDATA parameter is used to supply details of main menu (branch) entries, (sub)menu items, icons, hints and links. It can be used in two different ways...

  1) "xxx" refers to the [path/]name of an ASCII text
     file that contains configuration data.
  2) "xxx" refers to configuration data
     that is directly specified.

In both cases configuration data is structured in exactly the same way, using HTML-like tags. The <MENU>...</MENU> tag pair is used to enclose the data required to specify a main menu entry, and associated menu items (if any) are specified using the <ITEM> tag. Here is the formal declaration of these tags (square brackets denote optional)...

  
  <MENU [~]Caption[,icon[,icon]] | Link[,Target] | [Hint]> 
    <ITEM  Caption[,icon[,icon]] | Link[,Target] | [Hint]>
    <ITEM...>
    <ITEM...>
  </MENU>
  

  Caption refers to the text caption that appears in the menu.
  In the case of MENU captions a leading tilde '~' character specifies
  that menu branch should be displayed open on applet startup.

  icon refers to up to two optional icon numbers, separated
  from the caption by comma delimiters. The first number refers to the
  icon displayed when a main MENU is closed (or ITEM that has not yet been
  selected). The second number refers to the icon displayed when a main
  MENU branch is open (or when an ITEM has been selected).
    The numbers themselves represent the position of an icon in
  the icon graphic file (see ICONGRAPHIC parameter).

  Link refers to the URL to invoke when the menu entry is clicked.
  A Link can include a comma delimited trailing Target (a destination
  window or frame name). For more info on targets see the DEFTARGET
  parameter.

  Hint refers to a text string to display in the browser status
  bar. If the hint is set to a single equals character '=' the Link URL
  will be displayed as a hint. If the hint is set to a double equals
  character '==' the Caption will be displayed as a hint.

NOTE 2:
< and > characters are used as tag delimiters by default. This character pair can be changed, see DELIMITERS parameter.

NOTE 3:
For a configuration script example you can use as a template see HTML code examples.

back to top

Where xx is a 2-character string denoting the characters to be used as configuration data MENU and ITEM tag delimiters, for example "[]", "{}".

You may want to change the default delimiters if you are using Frontpage or other HTML editor that likes to automatically reformat unrecognised HTML tags (only a potential problem if menu config data is specified directly in the APPLETDATA parameter).

back to top

Where x is either 0 or 1. When zero, all menu branches can be opened or closed at will by the menu user. When 1, only one branch can be open at any one time - as branches are selected open the previously open branch will be automatically closed. Only applies to toplevel menu branches.

NOTE 1:
In the menu configuration script data a tilde '~' character can be inserted to specify a menu branch should appear open on applet startup. When AUTOCLOSE is set to 1 only the first such branch will be displayed open.

back to top

Where "xxx" is the [path/]name of a GIF/JPG image file. If the size of the image is smaller than the applet the menu background will be tiled with multiple copies of the image, if the image is larger it will be clipped. If path information is included it should be relative to the document base (the directory containing the HTML file in which the applet is used).

If this parameter is left unspecified the menu background will be painted in the color specified in the BACKCOLOR parameter.

back to top

Where "xxx" is the [path/]name of a GIF image file containing icon images. If path information is included it should be relative to the document base (the directory containing the HTML file in which the applet is used).

Icon images file structure
Inside the file icon images must be arranged horizontally (for an example see the included menu icons file tnicons.gif). Each icon section must be equal in size. tnicons.gif is the icon file used by the Java Hermit TreeNav applet demo. It contains 4 images - 2 for MENU closed/open, 2 for ITEM unvisited/visited.

The leftmost icon is number 1, next is number 2, and so on...

You can add more icons to the file, extending the range of icons available. See APPLETDATA parameter for info on how to specify optional icon numbers in your menu structure. If you use a file containing less or more than 4 icons (the default number) set the ICONCOUNT parameter to tell the applet how many icons are in the file - necessary for correct display.

Tranparent vs. non-transparent icon images
If icons have a transparent background then the background color displayed will be that set in the BACKCOLOR parameter. This is the preferred method (if a background graphic is used it will not show through icon transparent areas - it's necessary to set a BACKCOLOR that matches the graphic). Alternatively icons can be non-transparent, in which case icons will display with their own predefined background color.

back to top

Where x is a decimal number representing the number of icons present in the icon graphic file (see ICONGRAPHIC parameter). If your icon file contains the standard 4 icons (or icons are not used) there is no need to include this parameter.

back to top

Where x is a decimal number between 0 and 8, represesenting the pixel thickness of the applet border. Set to zero for no border.

back to top

Where x is a decimal number between 1 and 4:
1 = solid, 2 = 3D raised, 3 = 3D sunk, 4 = 3D frame.

NOTE 1:
3D borders only work correctly with certain colors, try to use 'browser safe' medium bright colors. Colors are futher discussed in the parameter color values section.

back to top

Where x is the required color of the applet border. May be a decimal or hexadecimal color number.

back to top

Where x is either 0 for no scrollbars, 1 for vertical scrollbar, 2 for horizontal scrollbar or 3 for both horizontal and vertical scrollbars.

back to top

Where x is the width of vertical scrollbar and height of horizontal scrollber in screen pixels. Available range 8 - 24.

back to top

Where x is the required color of the scrollbar. May be a decimal or hexadecimal color number.

NOTE 1:
Scrollbars use 3D effects to paint slider thumbs. For the best visual effect use a medium brightness color.

back to top

Where x is the required color of the menu background. May be a decimal or hexadecimal color number.

NOTE 1:
The BACKCOLOR is that which will show through icon transparent areas. When a background graphic is used this color must be selected to blend with the graphic.

back to top

Where x is the required color of the menu entries text. May be a decimal or hexadecimal color number.

back to top

Where x is the number of screen pixels by which to indent menu entries from the applet left edge.

back to top

Where xxx is the menu entries text font facename, y is the font style, z is the font size in points. Comma delimiters (without leading or trailing spaces) separate facename, style and size.

Available styles are 0 = plain, 1 = bold, 2 = italic, 3 = bold italic.

back to top

Where "xxx" is the [path/]name of an .au audio file. AUDIO1 refers to a sound played when a menu branch is opened or closed, AUDIO2 refers to a sound played when a menu item entry is selected.

If path information is included it should be relative to the document base (the directory containing the HTML file in which the applet is used).

NOTE 1:
Audio files should be as small as possible to avoid degrading applet performance.

back to top

Where "xxx" is the name of a frame or window in which to display linked documents, or one of the reserved window names _self, _top, _blank or _parent. Use to specify a destination frame/window for links in the applet configuration data that do not have an individually specified target.

NOTE 1:
Typically all TreeNav linked documents will be required to display in the same destination frame/window. In such cases it is only necessary to set DEFTARGET to the name of the frame or window, no targets need to be specified in the applet configuration links data.

back to top

To ensure colors display as accurately as possible always use colors from the 'safe browser palette'. In hexadecimal notation safe colors are built from combinations of 00, 33, 66, 99, CC and FF. For example, #3366CC is a 'safe' color but #3366DD is not.

hexadecimal colors are arranged #RRGGBB. For example in color #3366CC value 33 is the RED component, 66 is the GREEN component and CC is the BLUE component.

In TreeNav there is no option for auto scrollbars (that appear and disappear as required). Where scrollbars are specified they are always visible.

Parameter changes...

    GTreeMenu                          TreeNav
    ---------                          -------

    BOXCOLOR                           no equivalent
    SCROLLBAR                          SCROLLBARS
    SCROLLWIDTH                        SCROLLSIZE
    FONTFACE, FONTSTYLE, FONTSIZE      TEXTFONT
    no equivalent                      AUTOCLOSE
    no equivalent                      AUDIO1
    no equivalent                      AUDIO2

back to top

NOTE 1:
The version of tnmenu.txt included as an example has had the Java Hermit site specific links removed and replaced with the phrase link_url_goes_here.

back to top

If things are not working try the following...

• Ensure Java is enabled in your browser.
• Offline testing an applet-containing HTML file by automatically starting a browser from an HTML editor (or by using a clickable shortcut) can cause spurious errors. Try invoking the test page from a browser bookmark.
• Check carefully for spelling and case errors in APPLET tag and PARAM values.
• If your HTML code, class files, config script file etc are split between more than one folder try putting them all in the same folder.
• FTP class and graphic files in binary mode.
• FTP config script and HTML files in ascii (text) mode.

It's always essential to final test over a live Internet connection (use a test page nobody else can view before you release it on the general public).

Please read this documentation carefully before contacting the hermit for technical assistance. If requesting help include as much information as possible (description of problem, browser and OS details, testing online or offline?). Include a copy of your HTML and configuration script (please do not mail graphics files) and, if available, a URL to the page on which the problem occurs.

back to top