BSCOutline DataFile/DataLines Descriptions

 
Tree Data Syntax Overview
The data defined for the outline is the information used to produce each node in the outline tree. For each node you must specify...
The Level of the node in the heirachy.
The Icon to use for the node.
The Title text to show for the node.
The destination URL for the browser to call when the node is clicked.

Additionally you *may* specify the following for each node. An ID (NodeID) The text for a Tooltip.
 
Data File Syntax
Note - This parameter will be overriden by any DataX parameters in the applet tag.
The datafile consists of an ASCII text file which can have any filename. You are not restricted to using .out as the extension for the main datafile.
Each node definition must be on a sepparate line.
Any line which consists of a "C" sytle comment is taken as a comment and ignored by the applet.
e.g.
/* Outline Data File - Simon Daykin */

Each node within the file must consist of at least 4 elements sepparated by one or more white spaces (tabs or spaces).
The elements must be in the following order...

Level Icon Title URL

Level - The level in the tree, ascending from 1. Icon - The number of the icon to show. Title - The description to show in the outline. Note:- MUST be enclosed in "Quotation" marks. URL - The destination document relative to the document carrying the applet. Note:- MUST be enclosed in "Quotation" marks. The URL can be a non-standard URL, the following describes the additional features...
 
ImageTitle Nodes
Any Title which starts with a hash character ("#") will not show text, instead it will show the TitleImage of the number which follows the #.
e.g. Title - "#2" Displays ImageTitle2 instead of text.
 
No Action Nodes
Any URL which starts with a space character will not open the URL specified. This is usefull to make folder nodes just act like folders without opening a destination URL.
e.g. URL - " " Does nothing when clicked.
 
URL Prefix Nodes
Any URL which starts with three periods (...) will have the value supplied in the URLPrefix parameter prefixed to the URL before it is opened.
e.g. URL - ".../Index.html" and URLPrefix = "http://www.byte-sized.com"
will open "http://www.byte-sized.com/Index.html"
 
Partial Population Nodes
Any URL which ends in "!" is treated as a partial population node. This will make the node appear to be a folder which fills from the data in the specified .out file. Note:Any partial population .out files MUST be root based, that is make each .out file as though they are the ONLY .out file and then just reference it in the master .out file.
You may specify both a URL *and* a .out file byt entering the URL before a space and then the .out file followed by the !
e.g. URL - "faq.htm outline.out!" will open the "faq.htm" in the browser and populate the node with the contents of "outline.out"
 
Different Target Nodes
Any URL which has an "@" in the URL will open the specified URL using the name after the "@" as the target irrespective of what the Target parameter is defined as.
e.g. URL - "faq.htm@_new" will open "faq.htm" in a new browser window.
 
Document Anchor Nodes
Any URL which has a "#" in the URL will open the specified URL using the name after the "#" as the anchor to move to in the document.
e.g. URL - "faq.htm#B" will open "faq.htm" and move to anchor B

Note: The Target and Anchor can be combined....
e.g. URL - "faq.htm#C@_new" will open "faq.htm" in a NEW window and move to anchor C.

 
DataLines Syntax
The DataX Lines used in the applet tag are an alternative method of defining the data for the outline.

Note - The use of *any* DataX parameters in the applet tag will override any OutlineFile Parameter and thus the outline data file will be ignored.
The Data lines must take the form of consecutive Data parameters in the applet tag.
Instead of delimiting the values with white spaces, the PIPE "|" character must be used.
e.g.

<PARAM NAME=Data1 VALUE="1|1|First Node|interest.htm|"> <PARAM NAME=Data2 VALUE="1|1|Second Node|second.htm|"> <PARAM NAME=Data3 VALUE="1|1|Third Node|second.htm|"> <PARAM NAME=Data4 VALUE="1|1|Forth Node|second.htm|MyNodeID|"> <PARAM NAME=Data5 VALUE="1|1|Fifth Node|second.htm|MYNODE|This Node has a tooltip|"> <PARAM NAME=Data6 VALUE="1|1|Sixth Node|second.htm| |Has Tooltip but no NodeID|"> Note: There MUST be a pipe character to terminate the URL and there must be no speech marks within the strings.