Web Blaze Command Reference
These are the default commands built into the Web Blaze application. (Provided by Web Blaze object connector "default".)
Link, /cmd="link"
Inserts a formatted link in the document.
Requires 'imagesite' to specify where images are located in the config.txt file. This location needs 2 sub folders: common and links. 1ptrans.gif is required in common. All images to be specified in the image command must be present in 'links'.
The CSS must specify the following used class names:
- spacebar = specifies color to use for the bar
- link = specifies color and font to use for the link
Link Parameters:
| attribute | value | description |
| image | {user defined} | the image to use to display the link. the image must be stored in the links folder as a .gif file. However, do not specify path or extension in this parameter. |
| bar (optional) | {none} | If specified a bar will be drawn. This indicates to the object that multiple links need to be displayed in the same grouping. If not specified a bar will be drawn above and below the link. |
| offsite (optional) | {none} | Will append (links offsite) to the end of the link text and open the link in a new target pane. The default is 'newwindow' unless target specifies a different pane. |
| text | {user defined} | This is the text that will be used to display the link to the user. |
| href | {user defined} | The destination URL that the browser should navigate to when the user selects the link. |
| target (optional) | {user defined} | When panes are used to render a page the target command specifies which pane the link should be displayed in. |
Menu, /cmd="menu"
Draw a menu in the document. This object waits for all previous objects to finish execution before being performed, this way menu commands can be embedded as the results of other commands. See the action parameters as several specify how menus should be rendered.
The CSS must specify the following used class names:
- menuid# where # is a number that will be specified in the classid parameter to control the menu item's appearance
Menu Parameters:
| attribute | value | description |
| action | mainstart mainend mainadd substart subend subadd drawmain drawsub |
Xstart and Xend specify the text or image to display (if
any) at the start and end of the menu.
Xadd adds a menu item to the menu. drawX states where the menu should be rendered in the document. |
| value | {user defined} | required for Xstart and Xend actions. {user defined} is the text/image that will be used at that menu position. |
| caption | {user defined} | requried for Xadd actions. This is the text that will be used in the menu. |
| link | {user defined} | required for Xadd actions. the destination link that will be used when the menu item is selected |
| classid | {number} | required for Xadd actions. a number that represents the class id in the CSS to use to render this menu. |
| vertical (optional) | {none} | If present in drawX actions the menu will be drawn vertically. |
Popup, /cmd="popup"
Displays a URL in a popup window such as a help window
Popup Parameters:
| attribute | value | description |
| height (optional) | {number} | Set the height of the popup window if 600 is not desired. |
| width (optional) | {number} | Set the width of the popup window if 800 is not desired. |
| href | {user defined} | Displays the link set in {user defined} in the popup window |
| text | {user defined} | The caption used for the popup link in the document |
Image, /cmd="image"
Inserts a URL specified image into the document. To set the default width and height to use for images set environment parameters imgwidth and imgheight.
Image Parameters:
| attribute | values | description |
| embed | {user defined} | places an image tag in the document setting the image src tag to {user defined} |
| text (optional) | {user defined} | will place the text specified in {user defined} under the image. |
| popup (optional) | {user defined} | If specified will add a pop up for view larger image (at 800x600 resolution) after the text or under the image if no text is specified. |
File, /cmd="file"
Inserts the contents of a static file. All HTML files must be stored off the 'htmlroot' parameter set in the config.txt file.
File Parameters:
| attribute | values | decription |
| embed | {user defined} | opens the HTML file specified by user defined and inserts the files body contents. |
| id | {user defined} | Performs the same as embed however will add in document title info, modified date and set the result page title to be this title. |
Env, /cmd="env"
Adds the specified attribute value pair to the environment variables.
Env Parameters:
| attribute | values | description |
| get | {attribute} | returns the value of the attribute specified by {attribute} |
| set | {user defined} | adds an environment attribute {user defined} to the environment variables list. |
| value | {user defined} | associates the {user defined} field with the attribute. |
Date, /cmd="date"
Returns the date of the system running the Web Blaze application or service.
Date Parameters:
| attribute | values | description |
| month | short {none} |
Specify short to have 3 character month codes used. |
| date | {none} | return the current date |
| year | {none} | return the current year |
| sunup | {none} | returns a d if it is daytime hours or n if it is night time hours (approximate) |
