This is a list of the valid keywords and parameters in the script file.
For an example, look at the TOC.script file.
Note, that the keyword and all its parameters must be in one line.
- //
Comment.
- Menu [text=[string]]
The name of a pulldown in the menu bar.
- text
The text of the pulldown menu.
The default is an empty string.
- MenuItem [url=[URL|file][,string]] [text=[string]]
The name of an entry in the pulldown menu, associated with an URL.
You can create cascading submenu items using the "BeginSubMenu" and
"EndSubMenu" keywords (see below).
- text
The text of the pulldown menu. This parameter must be the last one in the line.
The default is an empty string.
- url
Any valid URL or file name. Either a complete URL (http://..) or a file
relative to the document's URL can be specified.
Divided by a comma, you can optionally specify a target frame name.
Default is null (no URL or file).
If it is not valid, the URL is set to null (no URL or file).
- BeginSubMenu
The begin of a new submenu. The block must end with an "EndSubMenu" function.
- EndSubMenu
The end of a submenu started with "BeginSubMenu".
- Item [level=[int]] [font=[string,int]] [color=[int,int,int]] [image=[file]]
[openimage=[file]] [sound=[file]] [url=[URL|file][,string]] [expanded=[YES|NO]] [expandonselect=[YES|NO]] [selected=[YES|NO]]
[infoscript=[URL|file]] [text=[string]]
An item within the TOC.
- level
The level of the item. The root level is 1, the first sublevel 2 and so on.
You can use this parameter alternatively to the "BeginSubTree" and "EndSubTree"
keywords (see below).
If one level is left out (e.g. 1, 3, 4), the script file processing ends with an error.
If the level is lower than 1, the parameter is ignored.
- font
The font for the item. The parameter has the format [FontFamily,size].
Default is TimesRoman,14.
If the size contains no number, the font parameter is ignored.
- color
The color of the item text. The parameter has the format [red,green,blue].
Each value must be is an integer between 0 and 255.
Default is the text color parameter from the applet tag, or black if the
parameter is not specified.
If any of the three integers contains a value <0, it is set to 0.
If any of the three integers contains a value >255, it is set to 255.
If any of the three integers contains no number, the whole parameter
is ignored.
- image
Any valid file name specifying the image before the item text. It must be
a file relative to the document's URL.
Default is null (no image).
- openimage
Any valid file name specifying the image before the item text. It must be
a file relative to the document's URL.
This image is shown when the item is selected. If an image is specified, but
no openimage, the image is also show when the item is selected.
Default is null (no image).
- sound
Any valid file name specifying the sound clip played when the mouse pointer
is more than 1 second over an item.
Default is null (no sound clip).
- url
Any valid URL or file name. Either a complete URL (http://..) or a file
relative to the document's URL can be specified.
Divided by a comma, you can optionally specify a target frame name.
Default is null (no URL or file).
If it is not valid, the URL is set to null (no URL or file).
- expanded
Specifies whether a subtree is initially expanded (YES).
Default is NO.
NO is set each value that is not YES.
If the item has no subtree, the parameter is set to NO.
- expandonselect
Specifies whether the subtree of the item automatically expands when the
item is selected (YES).
Default is NO.
NO is set each value that is not YES.
If the item has no subtree, the parameter is set to NO.
- selected
Specifies whether the item is initially selected (YES).
Default is NO.
NO is set each value that is not YES.
If there is already another item marked with YES, the parameter is set to NO.
if no item is marked selected, the first item is initially selected.
- infoscript
Any valid URL or file name containing the info scroller script file for this
item. If this item is set, it overwrites the applet parameter "infoscript".
If the item is not set, the default script file specified in the applet parameter
"infoscript" is used.
Default is null (no URL or file).
If it is not valid, the URL is set to null (no URL or file).
- inforeload
The time (in sec) until the info scroller script file is reloaded.
Set the value to "-1" for no reload.
Default is -1 (no reload).
- text
The text of the item. This parameter must be the last one in the line.
The default is an empty string.
- ItemHelp
Help for the Item of the line above.
- text
The help text of the item in the line above.
The default is an empty string.
- BeginSubTree
The begin of a new level within the TOC. The block must end with an "EndSubTree" function.
Alternatively you can use the "level" parameter if the "Item" (see above).
- EndSubTree
The end of a level within the TOC started with "BeginSubTree".
Alternatively you can use the "level" parameter if the "Item" (see below).