BSCOutline Tag Descriptions

Overview
The applet tag is the element in the HTML document used to embed the Java Applet.
Applet resources are loaded relative to the document URL. The CODEBASE = attribute is used to change this default behavior. If the CODEBASE= attribute is defined, it specifies a different location in which to find applet resources. The value can be an absolute or a relative URL. The absolute URL is used as is, without modification, and is not affected by the document's BASE element. When the CODEBASE= attribute is relative, it is relative to the document URL (or BASE tag, if defined).
The basic tag takes the following form...

<APPLET ALIGN = LEFT | CENTER | RIGHT | TOP | MIDDLE | BOTTOM ALT = alternateText CODE = appletFile CODEBASE = codebaseURL HEIGHT = pixels HSPACE = pixels NAME = appletInstanceName TITLE = text VSPACE = pixels WIDTH = pixels> <PARAM NAME=AttributeName ...> ... </APPLET> ALIGN = LEFT | CENTER | RIGHT | TOP | MIDDLE | BOTTOM - Describes the alignment of an object to text. The default is LEFT.

ALT = alternateText - Specifies alternate text for text-only browsers or browsers that do not support Java.

CODE = appletFile - Specifies the name of the Java applet.

CODEBASE = codebaseURL - Specifies the base URL of the applet (the directory in which the applet is located).

HEIGHT = pixels - Specifies the initial height of the applet display area.

HSPACE = pixels - Specifies the horizontal space in which the applet displays. NAME = appletInstanceName - Identifies an applet to other applets within the HTML page.

PARAM NAME=AttributeName - Passes applet-specific arguments in from an HTML page. There may be no, one, or any number of PARAM NAME= attributes present in the APPLET start-tag.

TITLE=text - Specifies an advisory title string.

VSPACE=pixels - Specifies the space in pixels above the applet.

WIDTH=pixels - Specifies the initial width of the applet display area.

Example Tag

<APPLET CODE = BSCOutline.class CODEBASE = http://www.byte-sized.com/applet/ ID = BSCOutline WIDTH = "200" HEIGHT = "400"> <PARAM NAME = Fold1C VALUE = "icons/folder-closed.gif"> <PARAM NAME = Fold1O VALUE = "icons/folder-open.gif"> <PARAM NAME = Fold2C VALUE = "icons/purple-book-closed.gif"> <PARAM NAME = Fold2O VALUE = "icons/purple-book-open.gif"> <PARAM NAME = Icon1 VALUE = "icons/doc1.gif"> <PARAM NAME = Icon2 VALUE = "icons/doc2.gif"> <PARAM NAME = Icon3 VALUE = "icons/doc3.gif"> <PARAM NAME = Icon4 VALUE = "icons/doc4.gif"> <PARAM NAME = OutlineFile VALUE = "help.out"> <PARAM NAME = FontFace VALUE = "Arial"> <PARAM NAME = FontStyle VALUE = 0> <PARAM NAME = FontSize VALUE = 15> <PARAM NAME = FontColour VALUE = "000066"> <PARAM NAME = BackColour VALUE = "FFFF99"> <PARAM NAME = SelectColour VALUE = "FF0000"> <PARAM NAME = Target VALUE = "contentframe"> <PARAM NAME = ShowLines VALUE = 1> <PARAM NAME = ShowIcons VALUE = 1> <PARAM NAME = License VALUE = 10293840> </APPLET>

FoldXC
This parameter is used to specify the filenames and locations of the images to use as the folder icons when the folders are in the closed state.
The X represents a consecutive number. e.g. Fold1C, Fold2C, Fold3C etc.
The URL can be either a fully qualified URL or relative to the applet location.
Note - Each FoldXC must have a matching FoldXO.

FoldXO
This parameter is used to specify the filenames and locations of the images to use as the folder icons when the folders are in the open state.
The X represents a consecutive number. e.g. Fold1O, Fold2O, Fold3O etc.
The URL can be either a fully qualified URL or relative to the applet location.
Note - Each FoldXO must have a matching FoldXC.

IconX
This parameter is used to specify the filenames and locations of the images to use for the child node icons.
The X represents a consecutive number. e.g. Icon1, Icon2, Icon3 etc.
The URL can be either a fully qualified URL or relative to the applet location.

OutlineFile
This parameter is used to specify the filename of a text file containing the data to display in the outline.
Default = outline.out
The URL can be either a fully qualified URL or relative to the applet location.
Note - This parameter will be overriden by any DataX parameters in the applet tag.
For Details of the syntax of the datafile see Datafile Syntax

DataX
This parameter is used to specify the actual lines of data to display in the outline.
The X represents a consecutive number. e.g. Data1, Data2, Data3 etc.
Note - The use of DataX parameters will override any OutlineFile Parameter.
For Details of the syntax of the datafile see DataLines Syntax

FontFace
This parameter is used to specify the typeface used in the outline.
Default = Arial
Note - Please be aware that due to the large number of different platforms and browsers that the outline is potentially viewed by, there will be times when the applet is being viewed on a system which does not have or support your chosen typeface.

FontSize
This parameter is used to specify the size of the lettering, in points, used in the outline.
Default = 12

FontStyle
This parameter is used to specify the stype of the lettering used in the outline.
The parameter can have one of the following values...
0 = Normal
1 = Bold
2 = Italic
3 = Bold + Italic
 Default = 0

FontColour
This parameter is used to specify the colour of the lettering used in the outline.
The parameter must be specified in hexidecimal in the form RRGGBB.
e.g. Red = FF0000; Green = 00FF00; Blue = 0000FF
Default = 000000 (Black)

SelectColour
This parameter is used to specify the colour of the lettering used for the last selected item in the outline.
The parameter must be specified in hexidecimal in the form RRGGBB.
e.g. Red = FF0000; Green = 00FF00; Blue = 0000FF
Default = FF0000 (Red)

BackColour
This parameter is used to specify the colour of the background of the outline.
The parameter must be specified in hexidecimal in the form RRGGBB.
e.g. Red = FF0000; Green = 00FF00; Blue = 0000FF
Default = FFFFFF (White)
Note - This parameter will be overridden if a background image is used.

Background
This parameter is used to specify the filename of the background image of the outline.
The URL can be either a fully qualified URL or relative to the applet location.
If the image is not large enough to completely cover the applet background, it will be tiled vertically and horizontally.
Note - This parameter will override any BackColour parameter.

BackgroundX
This parameter is used to specify the horizontal offset in pixels of the background image from the edge on the outline. This allows the image to be aligned with the background image on the page.

BackgroundY
This parameter is used to specify the vertical offset in pixels of the background image from the edge on the outline. This allows the image to be aligned with the background image on the page.

ShowLines
This parameter is used to specify whether or not to show lines going to each node in the outline.
The parameter can have one of the following values...

1 = Show Node Lines. 0 = Do NOT show Node Lines. Default = 1

ShowIcons
This parameter is used to specify whether or not to show icons for each node in the outline.
The parameter can have one of the following values...

1 = Show Icons. 0 = Do NOT Show Icons. Default = 1

Target
This parameter is used to specify the generic target frame for the links in the outline.
Note - This can be overridden for specific links, see Different Targets.

Licence
This parameter is used by registered users of BSCOutline to disable the top two "nag" lines.
To obtain a registration code, please register quoting the domain/subdomain on which you want the applet to work.
e.g. Quote www.byte-sized.com for any page within http://www.byte-sized.com