Mindmap Applet 2.4c - Description

Mindmap Applet 2.4c - Description Overview

Here is a revolutionary and intuitive new way to navigate the Web: A Java Applet that combines the Mindmap idea (by Tony Buzan) with the information hiding technique to a complete new way to find information on a site.
Use it to make your pages something special and very intuitive, and let the user have fun with a revolutionary new, graphical Multimedia Java tool.

Awards

JARS Top 5% Applet
one of the "Java-SIG's 100 Best Applets"
order the book online in the Books section (20% off)
one of the TOP10 Java Applets of the german Internet magazine Internet Professional 8/97 (Ziff-Davis)
Gamelan "cool"

Ordering

Visit the Mindmap Applet section of Better Homepage and order a license for using the applet or the complete source code.

For non-commercial use, this Applet is free. The license fee for commercial or Intranet use is $ 79 (US-Dollar) per domain where the Applet is used. The complete source code including all "build" tools and the permission to use it on an unlimited number of domains is also available. The price is $ 790 (US-Dollar).

Usage

Here is a step-by-step instruction how to use it on your homepage.

HTML Design
You need to use frames with this applet. One frame that displays the content, and a second frame that contains the APPLET tag (has to be permanently visible). The Mindmap can be shown in this second frame, or (what is recommended) in a separate window. In this case, the second frame can be very small or invisible (but it must be there).

Here is the HTML code to create an invisible frame:
```
   <FRAMESET ROWS="*,0">
     <FRAME SRC="entry.html" NAME="content" MARGINWIDTH=0 MARGINHEIGHT=0>
     <FRAME SRC="mindmap.html" NAME="mindmap" MARGINWIDTH=0 MARGINHEIGHT=0>  
   </FRAMESET>
```
An example for the HTML code (in mindmap.html in the example above) containing the APPLET tags is the following:
```
   <APPLET CODE="MMN" NAME="MMN" WIDTH=2 HEIGHT=2>
     <PARAM NAME="script" VALUE="Mindmap.script">
     <PARAM NAME="aswindow" VALUE="YES">
   </APPLET>
```
For details on all Mindmap Applet parameters see the description in the downloadable ZIP file (see above).

Java Media version or Standard Java version
The Mindmap Applet comes in two versions: A standard Java version and an enhanced Java Media version, which support Multimedia formats like videos (e.g. AVI, MPEG) and sound (e.g. WAV).
Choose the standard Java version (MMN*.class files) if you do not use special Multimedia files. Otherwise use the Java Media version (MMNMedia*.class), but keep in mind that all user must have installed the Java Media Runtime to see the Applet running. You can find the links to download it in the Download and Ordering section.

Customizing
Use the script file to create the Mindmap of your homepage. There are also a lot of script parameters and APPLET parameters to customize colors, font and much more. For details on all parameters see the description in the downloaded ZIP file.
Use the content frame as the target frame for your links ("target" parameter in the script file).

Test
You can test all the functionality on your local file system. Click on each item to verify that everything works correctly.

Upload
Upload all MMN*.class files (for the standard Java version) or all MMNMedia*.class files (for the Java Media version) from the "runtime" subdirectory, all MMN*.gif files, the script file and all image files that you use. And don't forget to upload the correct license file for your homepage.

Applet Parameter

Here is a list of the parameters of the Mindmap Applet:

Mandatory

<param name="script" value="[URL | file]">
Specifies the script describing the Mindmap. See below for details about the script file content.

Optional

<param name="designmode" value="[YES | NO]">
Use the design mode while you are developing your Mindmap. In this mode a black border is painted around all items, texts and images. Minimize the white space to save memory and to increase performance.
Default is "NO".
This parameter is not implemented in the "runtime" version.
<param name="helpdelay" value="[int]">
The time (in 0.5 seconds) until the help balloon is displayed. The lowest valid value is 1.
Default is "4" (2 seconds).
<param name="sounddelay" value="[int]">
The time (in 0.5 seconds) until the sound for the item the mouse is currently over is played. The lowest valid value is 1.
Default is "4" (2 seconds).
<param name="aswindow" value="[YES | NO}">
The applet can run within the browser or as seperate window. Set the value of this parameter to "YES" to run in a seperate window (which is recommended).
When the applet runs in a seperate window, set the width and height parameter of the applet tag to a minimum value (2) and use the "windowheight" and "windowwidth" parameters (see below).
Default is "NO".
<param name="windowx" value="[int]">
The x position of the seperate window (see above) in pixels. The parameter has no effect if the "aswindow" parameter is not set.
Default is "10".
<param name="windowy" value="[int]">
The y position of the seperate window (see above) in pixels. The parameter has no effect if the "aswindow" parameter is not set.
Default is "10".
<param name="windowwidth" value="[int]">
The width of the seperate window (see above) in pixels. The parameter has no effect if the "aswindow" parameter is not set.
Default is "500".
<param name="windowheight" value="[int]">
The height of the seperate window (see above). The parameter has no effect if the "aswindow" parameter is not set.
Default is "500".
<param name="windowtitle" value="[String]">
The title of the seperate window (see above). The parameter has no effect if the "aswindow" parameter is not set.
Default is "Mindmap".
<param name="bgcolor" value="[0-255],[0-255],[0-255]">
The background color of the whole applet area. The three values are the RGB (red,green,blue) amount of the color, each between 0 and 255.
Default is "255,255,255" (white).
<param name="statusbgcolor" value="[0-255],[0-255],[0-255]">
The background color of the status bar and tool bar. The three values are the RGB (red,green,blue) amount of the color, each between 0 and 255.
Default is "221,221,221" (light grey).
<param name="statustextcolor" value="[0-255],[0-255],[0-255]">
The text color of the status bar. The three values are the RGB (red,green,blue) amount of the color, each between 0 and 255.
Default is "0,0,0" (black).
<param name="animationinc" value="[int]">
The increment rate (in pixels) while the animation (moving to another center item) is running. Use this parameter to speed up the animation.
Default is "2".
<param name="compressedscript" value="[YES | NO]">
If you want to use a compressed script file, you have to set this parameter to "YES". This makes the file usually more than 50% smaller and the Applet loading faster.
The original (ASCII) script file must be compressed using the provided "Compress.class" Java application. The command goes like this:

java Compress <ascii-fn> <compress-fn>
where <ascii-fn> is the original file name and <compress-fn> is the file name of the compressed file. Use this second file in the "script" file parameter of the applet tag.

Script File

Here is a list of the keywords and parameters of the Mindmap Applet script file:

Introduction

The script file contains the description of the Mindmap.
First of all some general remarks about the script file:

Keywords of functions and parameters are NOT case sensitive.
All parameter values must be enclosed in double quotes.
If you need more than one line for a keyword, use the backslash (\) as the last character of a line for concatination.
If a value is invalid, it is ignored or the default is used.
The coordinate system has is origin in the upper left corner.

The general structure of the file is the following:


    Alias
    ...

    Mindmap
    ...

    Item
      Text
      ...
      Image
      ...
      Media (only Java Media version)
      ...
      Link
      ...
      Line

Take a look at the example script file (Mindmap.script). It is a good sample and shows most of the features of the applet.

Structure

The file starts with the Alias keywords. They define logical names e.g. for fonts and colors and minimize the update effort later.
After the alias definitons follow the Mindmap keywords. This is the list of Mindmaps that are displayed under the Open pulldown. It should also contain the actual Mindmap.
> After this first section, the file contains a list of Mindmap items. Each item can contain a any number of Texts, Images, Medias, Links and connecting Lines.

Keywords and Parameters

//

Comment.

Alias [name="String"] [value="String"]

Defines names to be replaced by other values. E.g. the Alias name "HeadingFont" could have the value "TimesRoman,24". This makes the file more readable and minimizes the update effort. Each value of the other keywords will be checked against the values. I recommend to use some special character here that is not used in the script elsewhere, e.g. an underscore as first character ("_HeadingFont").
- name
  
  A unique name of the Alias. Default is an empty string.
  This parameter is mandatory. If it is missing, the alias is ignored.
- value
  
  The String that will replace the alias name. Default is an empty string.
  This parameter is mandatory. If it is missing, the alias is ignored.
Mindmap [name="String"] [script="URL|file"] [image="URL|file"]

Defines an entry in the Open pulldown. These are Mindmaps that can be loaded from this Mindmap. It should also contain the actual Mindmap.
- name
  
  A unique name of the Mindmap. Default is an empty string.
  This parameter is mandatory. If it is missing or not unique, the script file reading stops.
- script
  
  Any valid URL or file name specifying the script file containing the Mindmap description.
  Default is no URL or file.
  This parameter is mandatory. If it is missing, the script file reading stops.
- image
  
  Any valid URL or file name specifying the image displayed in the Open pulldown before the Mindmap name.
  Default is no image.
Item [name="String"] [parent="String"] [x="int"] [y="int"] [w="int"] [h="int"] [url="URL|file"] [target="String"] [mindmap="String,String"] [bgcolor="int,int,int"] [sound="URL|file"]

Defines an item of the Mindmap.
- name
  
  A unique name of the Item. Default is an empty string.
  This parameter is mandatory. If it is missing or not unique, the script file reading stops.
- parent
  
  The name of the parent item. If the parent is missing, the root item is asumed.
  Default is no parent item.
  If there was another item without parent item before, the script file reading stops.
- x
  
  The x offset (in pixel) of the item from the parent item. For the root item, this parameter has no effect.
  Default is "100".
- y
  
  The y offset (in pixel) of the item from the parent item. For the root item, this parameter has no effect.
  Default is "100".
- w
  
  The width of the item (in pixel).
  Default is "100".
- h
  
  The height of the item (in pixel).
  Default is "100".
- url
  
  Any valid URL or file name specifying a document associated with the item. The document is opened when the user doubleclicks on the item.
  If this parameter is set, the mindmap parameter cannot be set additional. url and mindmap are exclusive.
  Default is no URL.
- target
  
  The name of the frame in which the associated document (see above) should be loaded. If the target frame name is not set, the document is loaded into the actual frame or into actual browser, if you do not use frames.
  Default is no target frame name.
- mindmap
  
  Another Mindmap that is associated with the item. The Mindmap is opened when the user doubleclicks on the item.
  The parameter consists of two string. The first is the name of the script file containing the Mindmap information, the second is the title of the seperate window (if there is one). Both strings are mandatory.
  If this parameter is set, the "url" parameter cannot be set additionally. "url" and "mindmap" are exclusive.
  Default is no Mindmap.
- bgcolor
  
  Color of the background of the item. If you do not specify a color, the item is transparent.
  The three values are the RGB (red,green,blue) amount (0-255 each) of the color.
  Default is transparent.
  Tip: The performance is better if you specify a background color.
- sound
  
  Any valid URL or file name specifying the sound clip played when the mouse pointer is more than 2 seconds over the item.
  Default is no sound clip.

Text [content="String"] [x="int"] [y="int"] [w="int"] [h="int"] [bgcolor="int,int,int"] [textcolor="int,int,int"] [textfont="String,int"]

Defines a text within an item.

content

The content of the text box. The text is formatted into several lines when a word does not fit into the actual line and the height is more than one line.
The text can contain the following HTML codes for formatting:

	<B>	The following text will be displayed bold.
	</B>	End of bold text.
	<I>	The following text will be displayed italic. You can combined bold and italic.
	</I>	End of italic text.
	<BR>	Line feed. The following text will start at the following line.
	&LT;	Lower than sign (<).
	&GT;	Greater than sign (>).

To display a double quote, write \".
Default is no content.

x

The x offset (in pixel) of the text within the item.
Default is "0".
y

The y offset (in pixel) of the text within the item.
Default is "0".
w

The width of the text (in pixel).
Default is "100".
h

The height of the text (in pixel).
Default is "100".
bgcolor

Color of the background of the text. If you do not specify a color, the text is transparent.
The three values are the RGB (red,green,blue) amount (0-255 each) of the color.
Default is "255,255,255" (white).
Tip: The performance of the better if you specify a background color.
textcolor

Color of the text.
The three values are the RGB (red,green,blue) amount (0-255 each) of the color.
Default is "0,0,0" (black).
textfont

The font of the text. The first value is the name of the font family, the second one the size of the font, seperated by a comma.
Default is "TimesRoman,18".

Image [src="URL|file"] [x="int"] [y="int"] [w="int"] [h="int"] [bgcolor="int,int,int"]

Defines an image within an item.
- src
  
  Any valid URL or file name specifying the image to be displayed within an image box. Animated images are not supported.
  Default is no image.
  This parameter is mandatory. If it is missing, the script file reading stops.
- x
  
  The x offset (in pixel) of the image within the item.
  Default is "0".
- y
  
  The y offset (in pixel) of the image within the item.
  Default is "0".
- w
  
  The width of the image (in pixel).
  Default is "100".
- h
  
  The height of the image (in pixel).
  Default is "100".
- bgcolor
  
  Color of the background of the image. If you do not specify a color, the image is transparent.
  The three values are the RGB (red,green,blue) amount (0-255 each) of the color.
  Default is transparent.
  Tip: The performance of the better if you specify a background color.
Media src="URL|file" [x="int"] [y="int"] [w="int"] [h="int"] [bgcolor="int,int,int"] [ctrlbgcolor="int,int,int"] [ctrlcolor="int,int,int"] [image="URL|file"]

Defines a media (video or sound) within an item. The media can only be played if the item is currently centered.
Note that you need 16 pixel below the media for displaying the media controls.
This keyword is only valid in the Java Media version.
- src
  
  Any valid URL or file name specifying the media to be presented within a media box.
  Default is no media.
  This parameter is mandatory. If it is missing, the script file reading stops.
- x
  
  The x offset (in pixel) of the media within the item.
  Default is "0".
- y
  
  The y offset (in pixel) of the media within the item.
  Default is "0".
- w
  
  The width of the media (in pixel).
  Default is "100".
- h
  
  The height of the media (in pixel).
  Default is "100".
- bgcolor
  
  Color of the background of the media. If you do not specify a color, the media is transparent.
  The three values are the red, green and blue amount (in this sequence) of the color.
  Default is transparent.
  Tip: The performance of the better if you specify a background color.
- ctrlbgcolor
  
  Color of the background of the media controls (play/stop). If you do not specify a color, the media is transparent.
  The three values are the RGB (red,green,blue) amount (0-255 each) of the color.
  Default is "221,221,221" (light gray).
- ctrlcolor
  
  Color of the media controls (play/stop).
  The three values are the RGB (red,green,blue) amount (0-255 each) of the color.
  Default is "0,0,0" (black).
- image
  
  Any valid URL or file name specifying an image to be displayed within the media box if the item is not centered or the media is not currently playing.
  Default is no media.
Line [target="String"] [xsource="int"] [ysource="int"] [xtarget="int"] [ytarget="int"] [linecolor="int,int,int"] [point="int,int"]

Defines a line between the item and another item (normally the parent item).
- target
  
  The name of the target item.
  Default is no target item.
  This parameter is mandatory. If it is missing, the script file reading stops.
- xsource
  
  The x offset (in pixel) of the line within the item.
  Default is "0".
- ysource
  
  The y offset (in pixel) of the line within the item.
  Default is "0".
- xtarget
  
  The x offset (in pixel) of the line within the target item.
  Default is "0".
- ytarget
  
  The y offset (in pixel) of the line within the target item.
  Default is "0".
- linecolor
  
  Color of the line.
  The three values are the red, green and blue amount (in this sequence) of the color.
  Default is "0,0,0" (black).
- point
  
  Additional point(s) that the line passes from the source to the target item. The two parameters are the x and y offset of the point from the source point. You can use multiple point parameters. The line is painted through each point in the given sequence.
  Default is "0,0".
Link [name="String"] [image="URL|file"] [url="URL|file"] [target="String"]

Defines an (external) link of the item. The links are shown in the link pulldown menu if the item is the centered item.
- name
  
  The name of the link.
  Default is no link.
  This parameter is mandatory. If it is missing, the link is ignored.
- image
  
  Any valid URL or file name specifying the image displayed in the Link pulldown before the link name.
  Default is no image.
- url
  
  Any valid URL or file name specifying a document associate with the item. The document is opened when the user clicks on the link in the Link pulldown menu.
  Default is no URL.
- target
  
  The name of the frame in which the associated document (see above) should be loaded. If the target frame name is not set, the document is loaded into the actual frame or into actual browser, if you do not use frames.
  Default is no target frame name.

FAQ / Problems

Here is a list of the most frequently asked questions and problems of the users of the Mindmap Applet.

error:java.lang.ClassFormatError

At least one of the .class files is corrupt. When you upload the Mindmap Applet to your homepage, make sure that
- you uploaded all the files (MMN*.class for the Standard Java version, MMNMedia*.class for the Java Media version)
- you uploaded the files with their long filenames
- you have the correct spelling (capital and small letters are important in Java)
- you have uploaded the files BINARY (not (!) ASCII)
No content or script parameters not recognized

In this case, check the script file and take a look at the Java Console. Check, that
- the keyword and parameter names are correct
- the values are in double quotes
Error when playing Java Media files

Make sure that the directory where the MMN*.class files are is part of the CLASSPATH enviroment setting.

Feedback

If you have a problem with the Applet, any comment, idea or requirement, please tell us so we can improve the Mindmap Applet.

E-Mail
Please contact us directly.