THIS IS A SAMPLE OF THE FULL VERSION DOCUMENTATION. TO SEE THE DOCUMENTATION FOR THIS EVALUATION VERSION, PLEASE REFER TO THE README.TXT FILE INCLUDED IN THE .ZIP FILE.

To change the look and feel of the menu, you will first need to use a text editor (such as NotePad in the Windows 9x/NT systems). Open the index.html file under the software directory into your text editor. Where you see the <applet> tag is where you will start editing.

PLEASE NOTE: This is a sample of the full documentation and is subject to change in the full version.

Brief Overview of how the menu works:

To give a brief overview of how the menu works, it is as follows. You design your menu, exactly as you would like it to look (as if it was fully expanded). You can include whatever graphics, fonts, colors, etc that you want, and have any kind of spacing, multiple levels, etc.

You then design a 'mouseover' state for your menu, i.e., what you would like the menu to look like if someone put a mouse over a particular menu item, and was going to click on it. This can be things such as highlighting, adding buttons, etc.

Then, through the extra parameters in the applet, you specify things such as how 'large' (high) each particular menu item is, in pixels, and also associate a particular customizable special effect that you want to occur.

This is a sample of what you HTML code would look like for the full version:

<applet code="ABCNavUltimate.class" width="211" height="260">
<param name="defaultitemHeight" value="52">
<param name="bgcolor" value="FFFFFF">
<param name="copyright" value="http://www.wyka-warzecha.com">
<param name="default_effect" value="1|default">
<param name="sound" value="on">
<param name="numItems" value="5">
<param name="Item1" value="1|no_url|noframe|opened|default_height|1|defaultFXparam">
<param name="Item2" value="2|no_url|noframe|closed|default_height|0|defaultFXparam">
<param name="Item3" value="2|no_url|noframe|closed|default_height|7|defaultFXparam">
<param name="Item4" value="3|no_url|noframe|closed|default_height|0|defaultFXparam">
<param name="Item5" value="1|no_url|noframe|closed|default_height|0|defaultFXparam">
<param name="imageMain" value="new_menu.jpg">
<param name="imageMouseOver" value="new_menu_hilite.jpg">
<param name="licensekey" value="PLACE_KEY_HERE">
</applet>


Common Mistakes to avoid:


Getting Started:




The first thing that is very important is the opening <applet> tag. It will probably say something like this:

<applet CODE="ABCNavUltimate.class" HEIGHT="260" WIDTH="211">

The 'height' parameter should be set to the maximum size (height) that your menu will be at any given time when a particular branch is expanded. For example, say all your menu items are 10 pixels high.
Then, say you have 5 main menu items. The first four menu items, when expanded, contain 2 'sub' menus (i.e., branches off the main menu). The fifth item contains 10 'sub' menus. Since the fifth item is the largest possible branch that could be shown at one time, you would need 10 pixels/menu item x 5 menu items= 50 pixels (for the 'main' menu) plus 10 pixels/menu item x 10 menu items for the fifth branch when fully expanded, = 100 pixels. So, 50+100=150 pixels, so you would need to change your menu height to '150'. I.e.,

<applet CODE="ABCNavUltimate.class" HEIGHT="150" WIDTH="211">

Main Parameter Information

Here is the main parameter information that you can customize globally. I.e., what the background color is, the default menu height, etc.

defaultItemHeight This is the default menu item height in pixels.

Say for example your total menu size (height) was 200 pixels, and you had (in total) four menu items that were all the same height. Since you had 4 items, each would be 50 pixels each, so you would set the parameter as:

<param name="defaultitemHeight" value="50">

bgcolor This is the background color that should appear when doing special effects, or when the menu is not fully expanded.
(For example, if your page background color was white, you would set this parameter to the same color, in hexadecimal. I.e.,

<param name="bgcolor" value="FFFFFF">
copyright This is a parameter that must apper in order for the software to fully function.

<param name="copyright" value="http://www.wyka-warzecha.com">
default_effect If you wish to have a default effect (which is displayed when none is chosen for another menu item, which will be explained later), then enter the default effect that should appear. You can do it one of two ways, simply have the effect number, followed by |default, which simply uses the program defaults, i.e.,

<param name="default_effect" value="1|default">

Or, you can enter your own defaults (which are in the format of:
|Maximum Value|Step Size|Sleep Time (milliseconds)|

For example,
Say you want the effect to rotate to the right (which is #2), at a maximum rotation of 90 degrees, step size of 3 (each 'frame' in the animation would increase by 3 degrees) and sleep for 10 millisecons (0.01 seconds)/animation frame. Then you would have:

<param name="default_effect" value="2|90|3|10">
sound If you want to have a sound when someone mouseovers a menu item, simply make this parameter equal to 'on'. Otherwise, set it to 'off'. For example:

<param name="sound" value="on">

MAKE SURE YOU COPY THE SOUND FILE TO YOUR WEBSITE!
numitems This should be set to the number of menu items that you have in total. So, for example, if you had 5 menu items, you would set this parameter as:

<param name="numItems" value=5>
Item1, Item2, . . . These are your actual menu items. The format is as follows:
  • MENU LEVEL
    This is the current 'level' or 'branch' that your menu item is on. Each 'increasing' number means it is a sub-level of a branch. For example, if you had (where ellipsis (. . . ) just means the rest of the line):

    <param name="Item1" value="1|http://www.mysite.com| . . .
    <param name="Item2" value="2|http://www.mysite.com| . . .
    <param name="Item3" value="3|http://www.mysite.com| . . .

    This would mean that, as soon as someone sees your menu, they would only see the first menu item. As soon as they clicked on 'item1', then it would expand to show both item1 & item2. Then if s/he clicked on 'item2', then 'item3' would appear.
  • URL
    This is the URL that someone should automatically go to, if they click on this menu item. If it is just an expanding menu branch (i.e., should not link to anywhere), simply say "no_url".
  • FRAME TARGET/NO FRAME
    If you are using frames, specify the name of the frame, otherwise, simply put "noframe".
  • OPEN/CLOSED
    This specifies whether or not the particular menu branch should be open ('expanded') when the software initially loads up, or closed.
  • PIXEL HEIGHT OF MENU ITEM (or DEFAULT_HEIGHT)
    This is the pixel height of the current menu item. If your menu item should use the 'default_height' (as discussed above), then simply put in 'default_height'.
  • SPECIAL EFFECT
    This is covered in more detail later.

CORRECT EXAMPLE

<param name="Item1" value="1|no_url|noframe|closed|default_height|1|defaultFXParam">

Numbering

The numbering of the menu items starts at '1' (i.e., item1, item2, ..., etc).

imageMain This is the main menu image that appears automatically
imageMouseOver This is for the 'mouseover' state image, i.e., what the menu items should look like when the mouse is over them.

Menu Items Effects

Following is more information about how you change the effects for the actual menu items.
There are three different ways you can use the special effects. The first is as follows:

First Method:

You can use one of the Create a default effect.

First, in the 'global' parameter, change the the "default_effect" parameter. You can select one of the effects (listed later on) followed by 'default' to use the built-in defaults, for example:

<param name="default_effect" value="1|default">

Would mean that the default effect was to scroll up/down providing there was a submenu when the menu item is clicked.
If you wished to change the default effect, add in three numbers (separated by "|") as described in the table below. (In the case of the slider effect, you would have four numbers -- the last number being the line thickness).


Then, for your menu items, simply do not include the fx parameters, for example:
<param name="Item1" value="1|no_url|noframe|closed|default_height">

Every menu item that follows this format will use the 'default' effect.

Second Method:
The way of adding effects would be to include the effect number plus "|defaultFXparam" after it, for example:
<param name="Item1" value="1|no_url|noframe|closed|default_height|2|defaultFXparam"> uses #2, (the 'scrolling right' effect, and the built in defaults).

Third Method:
Finally, the last way to change the effect of a menu item is to use what is in the following table.
You would have all the default parameters, followed by what is in the table. For example,
<param name="Item1" value="1|http://www.mysite.com|noframe|closed|default_height|0|0|0|0">

MENU EFFECTS

This section describes the various effects that you can achieve with this software.

The effects (unless stated otherwise) follow this format:
|Maximum Value|Step Size|Sleep Time (milliseconds)|

For example,
Say you want the effect to rotate to the right (which is #2), at a maximum rotation of 90 degrees, step size of 3 (each 'frame' in the animation would increase by 3 degrees) and sleep for 10 millisecons (0.01 seconds)/animation frame. Then you would have:

|90|3|10

Following is a detailed listing of all the effects and usage:

Effect Number Purpose of Effect
0-Do Nothing This is a 'do-nothing' effect. If there is a sub-menu to this item, then it simply expands it (with no scrolling). There are no parameters you can change for this, so an example would be:

<param name="Item1" value="1|no_url|noframe|opened|default_height|0|0|0|0">
1-Scrolling This is a 'scroll' effect. When the mouse button is clicked, and providing there is a sub-menu, the sub-menu scrolls open. The values that can
be changed are the pixel step (of the scrolling expansion) and long to sleep between each 'animation frame'. For example, if you wanted to to increase by 3 pixels, and sleep for 10 milliseconds each animation frame, you would have:

<param name="Item1" value="1|no_url|noframe|opened|default_height|1|0|3|10">
2-Rotate Right This effect rotates the animation to the right. The parameters that can be changed are the 'maximum rotate degree', rotate step size and sleep between animation frames. For example, to rotate to a maximum of 45 degrees, in steps of 3 degrees, and sleep for 10 milliseconds per animation frame, you would have:

<param name="Item1" value="1|no_url|noframe|opened|default_height|2|45|3|10">

3-Rotate Left This effect rotates the animation to the left. The parameters that can be changed are the 'maximum rotate degree', rotate step size and sleep between animation frames. For example, to rotate to a maximum of 45 degrees, in steps of 3 degrees, and sleep for 10 milliseconds per animation frame, you would have:

<param name="Item1" value="1|no_url|noframe|opened|default_height|3|45|3|10">

4-Rotate Right Speed Blur This effect rotates the animation to the right with a speed blur. The parameters that can be changed are the 'maximum rotate degree', rotate step size and sleep between animation frames. For example, to rotate to a maximum of 45 degrees, in steps of 3 degrees, and sleep for 10 milliseconds per animation frame, you would have:

<param name="Item1" value="1|no_url|noframe|opened|default_height|4|45|3|10">

5-Rotate Left Speed Blur This effect rotates the animation to the left with a speed blur. The parameters that can be changed are the 'maximum rotate degree', rotate step size and sleep between animation frames. For example, to rotate to a maximum of 45 degrees, in steps of 3 degrees, and sleep for 10 milliseconds per animation frame, you would have:

<param name="Item1" value="1|no_url|noframe|opened|default_height|5|45|3|10">

6-Slicer This allows you to use the slicer effect. The effects that you can change are: maximum spread distance, increment, sleep value and slice thickness (the thickness in pixels of the lines that split apart). So, for example, if you wanted to make a slicer that spread 100 pixels, by a an increment of 3 pixels, slept for 10 milliseconds, and was 2 pixels wide, you would do the following:

<param name="Item1" value="1|no_url|noframe|opened|default_height|6|100|10|2">
7-IncreaseFX This option means that you want to cycle through the effects everytime someone clicks on it. (This is a 'global' cycle -- i.e., is applicable to all the menu items you choose). (The global cycle uses the built in defaults for the effects). For example,

<param name="Item1" value="1|no_url|noframe|opened|default_height|7|defaultFXparam">
8-RandomFX This randomly chooses an effect, and uses the built in defaults. For example,

<param name="Item1" value="1|no_url|noframe|opened|default_height|7|defaultFXparam">