HTML Services

The HTML services are tools to generate HTML tags and related functions. HTML tags are customized by the end user using the websage service editor. By abstracting them here, the users can customize much of the look of their WebSage based application.

Introduction
File Handling
Basic HTML Tag services
Form HTML tag services
Image services
Table Services
Link Services
Frame Services
Text Flow Serivces
Text Formatting Services
List Services

Introduction

Brief Overview
Invoking via URL
Format of a Web Object .p file

Overview of invocation processing

    {websage.i SET SERVICE serviceName}
    {websage.i SET STYLE styleName} 

    /* optional, if not using the primary style */
    {websage.i SET FONT fontName}

    /* optional, if not using the primary font */
    {websge.i SET FUNCTION functionName}
    X = {websage.i VALIDATE_LOGIN_ID} 

    /* and test the results and handle it */
    .....

Passing parameters via URL
Login/Session Management concepts

In order to do anything useful, you are eventually going to need to write text out to the client/browser. The identifier to support this is {&WRITE}. {&WRITE} preceeds a list of expressions that will be sent to the client browser. Each expression is seperated from the next by a space. You can have as many expressions as you want per line, though the total number of characters on a line can't exceed your -inp limit (usually 8192 characters).

You should break the line up with physical line breaks as well as line breaks in the actual written text/HTML. While a browser will easily handle a single continuous line of nearly any length and properly format it, it's very difficult from a debugging standpoint to use the "View Source" feature of most browsers if the source is on one big line. The {&SKIP} synbol can be inserted as logical places in the list of written expressions and has no affect on the final, formatted HTML - just the source.

A sample of writting HTML is:

{&WRITE}
  {html.i PAGE_HEADER "'My Page'"} {&SKIP}
  {html.i BODY_START} {&SKIP}
  {html.i PARA_START} {&SKIP}
  {html.i BOLD "'Here I am!'"} {&SKIP}
  {html.i BODY_END} {&SKIP}
  {html.i PAGE_FOOTER} {&SKIP}.

An older form of {&WRITE} is {&OUT}. {&OUT} is deprecated and has performance problems. All {&OUT} uses should be changed to {&WRITE}. You'll note that {&OUT} lines use a plain SKIP to break up lines and when converting to {&WRITE}, you'll need to convert all SKIP's to {&SKIP}.

Control Functions

DEFINE
Define the context needed for the HTML services. You must include this call at the start of each source module that uses the HTML services

File Processing

(returns LOGICAL) INCLUDE_HTML HTMLFile
Causes the supplied HTML file to be injected into the current web stream output. If the file is found, then the contents of that file (which must be a text/HTML file) are read and issued to the web browser and TRUE is returned. If the file cannot be accessed, FALSE is returned.

(returns LOGICAL) INCLUDE_TOKENIZED_HTML HTMLFile
Causes the supplied HTML file to be injected into the current web stream output after any tokens in the file have been replaced with matching token values. If the file is found, then the contents of that file (which must be a text/HTML file) are read, tokens are substituted and then issued to the web browser and TRUE is returned. If the file cannot be accessed, FALSE is returned. Note that if a token exists but there is no value for the token, the token is simply removed from the file before being sent to the browser. See the Token Processing section for more information on setting and using tokens.

(returns LOGICAL) INCLUDE_CUSTOM_HTML HTMLFile
Causes the supplied HTML file to be injected into the current web stream output. The passed file is first checked to see if it is in the DISTRICT_PATH. If not, then the file is checked to see if it is in the HTML_PATH. If in neither path, the file is opened with the unmodified file name being passed. If the file is found, then the contents of that file (which must be a text/HTML file) are read and issued to the web browser and TRUE is returned. If the file cannot be accessed, FALSE is returned.

(returns LOGICAL) INCLUDE_CUSTOM_TOKENIZED_HTML HTMLFile
Causes the supplied HTML file to be injected into the current web stream output after any tokens in the file have been replaced with the matching token values. The passed file is first checked to see if it is in the DISTRICT_PATH. If not, then the file is checked to see if it is in the HTML_PATH. If in neither path, the file is opened with the unmodified file name being passed. If the file is found, then the contents of that file (which must be a text/HTML file) are read, tokens are substituted and then issued to the web browser and TRUE is returned. If the file cannot be accessed, FALSE is returned. Note that if a token exists but there is no value for the token, the token is simply removed from the file before being sent to the browser. See the Token Processing section for more information on setting and using tokens.

HTML TAGS

All HTML tags return a character string that can be immediatly sent to the web browser or stored ina variable for additional processing. Most tags can accept an optional parameter that, if supplied, is inserted into the tag, allowing customized options to be met with.

HTML Tags are based on the current style (as last defined with SET STYLE). As such, if you find yourself overridding/suplementing tags often, consider instead creating a new style to use. Changing styles as needed is a very cheap operation. By default, the primary style for a servie is loaded when the service is set.

CONTENT_TYPE_HTML
Returns a string that needs to be sent out to the browser before any other HTML commands to instruct the browser that HTML is being sent (vs some other file form). This is normally NOT used as the PAGE_HEADER function provides the most common usage automatically.

HTML_START [optparm]
Returns a <HTML> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets). This tag is not normally needed as it's included in the prefered PAGE_HEADER tag.

HTML_END [optparm]
Returns a </HTML> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets). This tag is not normally needed as it's included in the prefered PAGE_FOOTER tag.

HEAD_START [optparm]
Returns a <HEAD> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets). This tag is not normally needed as it's included in the prefered PAGE_HEADER tag.

HEAD_END [optparm]
Returns a </HEAD> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets). This tag is not normally needed as it's included in the prefered PAGE_FOOTER tag.

NO_CACHE_TAGS [optparm]
Returns a set of tags that should come after the HEAD_START and before the HEAD_END and will cause the page to not be cached by most browsers. This means that if the user revisits the page later, instead of showing an old page, a fresh one should be fetched from the server.

You should only use this on pages that, for some reason, are likely to become "stale" over time. It puts a larger load on the server and not all browsers support it anyway. It's most often used in login pages.

TITLE_START [optparm]
Returns a <TITLE> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets). This tag is not normally needed as it's included in the prefered PAGE_HEADER tag.

TITLE_END [optparm]
Returns a </TITLE> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets). This tag is not normally needed as it's included in the prefered PAGE_FOOTER tag.

BODY_START [optparm]
Returns a <BODY> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

BODY_END [optparm]
Returns a </BODY> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets). You must include a BODY_END before the PAGE_FOOTER tag (if you have a BODY_START).

PAGE_HEADER title
Returns the page header for a standard HTML page. It include the content type, html start tag, header start tag, title tag, the supplied title text, the closing title tag and the closing header tag. Unless you have a rally good reason, you should always use this tag instead of the individual tags that make this up. As time goes forward, any changes needed to make our pages compatible with the latest browsers will be handled via this tag.

PAGE_FOOTER
Returns the html end tag, along with possible some other compatiblity tag. You should have correctly ended any open table, sections, forms and the body before using this tag. You should always use this tag instead of using the individual tags that make this up.

FORM Services

Forms allow the user to type information into fields and when the form is submitted, your WebSage program can extract what the user typed in. Generally, each tag that allows a user to enter data has a name. You use the GET WEB_FIELD function later to extract that value. In the case of MIME postings from the user (usually used by the FILE_FIELD), you also use the GET MIME_ELEMENT_INFO.

FORM_START form-program [optparm]
Returns a <FORM> tag as defined for the current style. form-program is the default WebSage program to be run when the user presses a submit button on the form. You do not need to include a path to the program as the passed program is suffixed to the result of GET PROG_PATH. If there is currently a login session active, a hidden field will automtically be written after the FORM_START tag to allow later identification of the session by the submit handling form-program. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

MIME_FORM_START form-program [optparm]
Returns a <FORM> tag as defined for the current style that can support MIME compatible browser postings. You generally do not need to use MIME forms unles you are expecting to use the FILE_FIELD input type. MIME encoding (used for this sort of form) is a bit bulkier than normal form encoding, so while you can use this even if not expecting a file from the user, you probably should use FORM_START in those cases. Everything else about this tag is identifcal to the FORM_START tag - please see it for more info.

FORM_END [optparm]
Returns a </FORM> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets). You must include a FORM_END tag before the BODY_END tag (if you have a FORM_START).

HIDDEN_FIELD name value [optparm]
Returns a hidden field to be included in the current form. Note that you must issue this only between a FORM_START and a FORM_END. name is the name for the hidden field and value is the value of the hidden field. The value will automatically be HTML encoded, if necessary.

TEXT_FIELD name value width maxchars [optparm]
Returns a text field to be included in the current form. Note that you must issue this only between a FORM_START and a FORM_END. name is the name for the text field and value is the intially displayed value of the field. The value will automatically be HTML encoded, if necessary. width is how many characters wide the field should appear on screen and maxchars is the maximum number of characters that can be typed in. If maxchars is greater than width, the field will scroll.

FILE_FIELD name width maxchars [optparm]
Returns a file upload field to be included in the current form. Note that to really get access to the uploaded file, you must issue this only between a MIME_FORM_START and FORM_END. name is the name of the field (not the file name). width is how many characters wide the field should appear on screen and maxchars is the maximum # of characters that can be typed in. The maximum # of characters should normally be specified as 0 (zero), allowing the field to be as large as necessary. Shortening this could compromise the ability for a user to enter a file name. If maxchars is greater than the width, the field will scroll.

On most browsers, a button will appear next to the file field that will invoke a file open dialog for the user. You don't seem to have any real control over whether it does or not and what the label is, but at least there is one.

PASSWORD_FIELD name value width maxchars [optparm]
Returns a password field to be included in the current form. Note that you must issue this only between a FORM_START and a FORM_END. name is the name for the password field and value is the intially displayed value of the field. The value will automatically be HTML encoded, if necessary. width is how many characters wide the field should appear on screen and maxchars is the maximum number of characters that can be typed in. If maxchars is greater than width, the field will scroll. Password fields echo all data (initial or user typed) as astericks to protect the content.

MEMO_FIELD name value width height [wordwrap [optparm]] Some interesting text here
Returns a memo field to be included in the current form. Note that you must issue this only between a FORM_START and a FORM_END. name is the name for the memo field and value is the intially displayed value of the field. The value will automatically be HTML encoded, if necessary. width is how many characters wide the field should appear on screen and height is the number of characters tall. wordwrap is a logical value and if passed true, word wrapping will occur. If passed false, the window will scroll but not word wrap the users text. Note that not all browsers support wordwrapping. If the 'wordwrap' parameter is omitted, the default is to enable word wrapping.

CHECK_BOX name value [checked? [optparm]]
Returns a check box field to be included in the current form. Note that you must issue this only between a FORM_START and a FORM_END. name is the name for the check box value is the value to be used if the check box is checked (if not checked, the fields field will be "" (empty string)). The value will automatically be HTML encoded, if necessary. checked? is optional and if provided, is a logical. If true, then the check box will initially appear checked on the screen. If false, the check box will initially appear unchecked. If the checked? parameter is omitted, then the check box will not be checked (by default).

RADIO_BUTTON name value [checked? [optparm]] Red Green Blue
Returns a radio button field to be included in the current form. Note that you must issue this only between a FORM_START and a FORM_END. name is the name for the radio button SET and value is the value to be used if the radio button is checked when the form is submitted. The value will automatically be HTML encoded, if necessary. checked? is optional and if provided, is a logical. If true, then the radio button will initially appear checked on the screen. If false, the radio button will initially appear unchecked. If the checked? parameter is omitted, then the radio button will not be checked (by default).

Radio buttons are meant to be used as an exclusive choice interface element. To provide that exclusivity, all radio buttons of a related set should have a common name. If they do, the browser will insure that only one radio button of a given common name/set will be checked at any one time. When the forms is submitted, the name will have the value of the radio button from the related name/set that was checked.

For example:


{www.i RADIO_BUTTON 'color' 'Red'}
{www.i RADIO_BUTTON 'color' 'Green'}
{www.i RADIO_BUTTON 'color' 'Blue Yes'}
{www.i RADIO_BUTTON 'taste' 'Sour'}

will create three radio buttons that are all linked together (because they all have the same name, color). When the user selects one button, any othe button of that set will be automatically cleared. By default, the Blue button appears initially selected. When the form is submitted, the 'color' symbol will have the text Red, Green or Blue. If no item is selected, the 'color' symbol will return an empty string. The radio button 'taste' stands by itself (since it has a different name) and is not affected by changes to the other three radio buttons. Note: it's really bad form to have only a sinlge radio button for a given set (like with 'taste' above). If you only have one item, use a check box instead.

COMBO_BOX name valuelist [delimspec [optparm]]
Returns a combo box field to be included in the current form. Note that you must issue this only between a FORM_START and a FORM_END. name is the name for the combo box valuelist is a list of possible values the combo box can support. Each item in the list is seperated from the next by a item delimiter (by default, a comma). Each item in the list can have a value and description. If only a description is given, it is both what the user sees and what is returned when the form is submitted (for the chosen item). If a value and description are given, they are delimited by a value delimiter (by default, a ^ (exponent character)) with the description first, followed by the value to return for the item. The valuelist will automatically be HTML encoded, if necessary. One item in the list can be marked as selected. This is done by prefixing that item with the selected item flag (by default, an asterisk (*)). delimspec is optional and if provided, is a string which overrides the default item delimiter, value delimiter and selected item indicator. The first character of delimspec is used a the seperator for extracting the values. That character can be any character not used as the item delimiter, value delimiter or selection indicator. If you supply an empty string to this parameter, the WWW serivces will provide the default delimSpec as if you hadn't even passed the parameter (this is done to allow easy access to optparm).

For Example:


  {www.i COMBO_BOX 'colorName' "'Red,*Green,Blue'"}
  {www.i COMBO_BOX 'colorID' "'Red^1,Green^2,*Blue^3'"}

will create two combo boxes. The first box will display the options Red, Green and Blue to the user (with "Green" selected by default) and when the form is submitted, 'colorName' will have the word Red, Green or Blue in it. The second box will also display the options Red, Green or Blue (with "Blue" selected by default), but when the form is submitted, 'colorID' will have the values 1, 2 or 3 in it.

PICK_LIST name valuelist height [multiSelect [delimspec [optparm]]]
Returns a pick list field to be included in the current form. Note that you must issue this only between a FORM_START and a FORM_END. name is the name for the pick list valuelist is a list of possible values the pick list will display. Each item in the list is seperated from the next by a item delimiter (by default, a comma). Each item in the list can have a value and description. If only a description is given, it is both what the user sees and what is returned when the form is submitted (for the chosen item). If a value and description are given, they are delimited by a value delimiter (by default, a ^ (exponent character)) with the description first, followed by the value to return for the item. The valuelist will automatically be HTML encoded, if necessary. One item in the list can be marked as selected. This is done by prefixing that item with the selected item flag (by default, an asterisk (*)) height is the number of characters tall the list should appear. If there are more items than will fit in the number provided, the list will be allowed to scroll. multiSelect is optional, a logical and, if provided, allows controlling if the user is allowed to select only one item from the pick list or if they can select multiple items. If not supplied, the default is not to allow multiple selections from the pick list. delimspec is optional and if provided, is a string which overrides the default item delimiter, value delimiter and selected item indicator. The first character of delimspec is used a the seperator for extracting the values. That character can be any character not used as the item delimiter, value delimiter or selection indicator. If you supply an empty string to this parameter, the WWW serivces will provide the default delimSpec as if you hadn't even passed the parameter (this is done to allow easy access to optparm).

For Example:


  {www.i PICK_LIST 'colorName' "'Red,Green,*Blue'" 3}
  {www.i PICK_LIST 'colorID' "'Red^1,Green^2,Blue^3'" 3}

will create two pick lists. The first list will display the options Red, Green and Blue (with "Blue" selected by default) to the user and when the form is submitted, 'colorName' will have the word Red, Green or Blue in it. The second list will also display the options Red, Green or Blue (with no item selected by default), but when the form is submitted, 'colorID' will have the values 1, 2 or 3 in it.

SUBMIT_BUTTON name value [optparm]
Returns a submit button to be included in the current form. Note that you must issue this only between a FORM_START and a FORM_END. name is the name for the submit button and value is the value and label for the button. The value will automatically be HTML encoded, if necessary. You can have multiple submit buttons on a form. If they all have different names and/or different values, your program can distinguish which the user pressed. Note you can have multiple submit buttons with the same name and different values, different names and same values or different names and different values. While you can have multiple submit buttons with the same name and value, you're program would not have any way to distinguish which button the user pressed.

RESET_BUTTON name value [optparm]
Returns a reset button to be included in the current form. Note that you must issue this only between a FORM_START and a FORM_END. name is the name for the reset button and value is the value and label for the button. The value will automatically be HTML encoded, if necessary. You can have multiple reset buttons on a form. Since the reset button will not, by default, cause a program to be invoked, it usually doesn't matter what the name is. However, by attaching JavaScript to the button, you could have it invoke anotehr program, but it'd probably just be as easy to use a real submit button or a plain button.

PLAIN_BUTTON name value [optparm]
Returns a plain (non submit, non reset) button to be included in the current form. Note that you must issue this only between a FORM_START and a FORM_END. name is the name for the button and value is the value and label for the button. The value will automatically be HTML encoded, if necessary. Plain buttons, by themselves, don't actually do anything. However, you can attach Javascript to have to execute various functions and/or execute another program. You can have multiple buttons on a form. If they all have different names and/or different values, your program can distinguish which the user pressed. Note you can have multiple buttons with the same name and different values, different names and same values or different names and different values. While you can have multiple buttons with the same name and value, you're program would not have any way to distinguish which button the user pressed.

Image Services

SERVICE_IMAGE imageFile [optparm]
Returns a <IMG%gt; tag as defined for the current style. imageFile is automatically included as the source for the image and the file is expected to exist in the IMAGE_PATH directory. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

DISTRICT_IMAGE imageFile [optparm]
Returns a <IMG%gt; tag as defined for the current style. imageFile is automatically included as the source for the image and the file is expected to exist in the DISTRICT_PATH directory. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

CUSTOM_IMAGE imageFile [optparm]
Returns a <IMG%gt; tag as defined for the current style. imageFile is automatically included as the source for the image and the file is expected to exist in either the DISTRICT_PATH directory or the IMAGE_PATH directory. DISTRICT_PATH is tried first, then the IMAGE_PATH. If the file is found in neither directory, the unmodified file name is used. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

URL_IMAGE imageURL [optparm]
Returns a <IMG%gt; tag as defined for the current style. imageURL is automatically included as the source for the image and can be a relative URL or an absolute URL. No processing is done to what is passed here - it's directly included, verbatim, in the source specification of the image. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

TABLE Services

TABLE_START [optparm]
Returns a <TABLE> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

TABLE_END [optparm]
Returns a </TABLE> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets). You must include a TABLE_END for every TABLE_START you include.

TABLE_ROW_START [optparm]
Returns a <TR> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

TABLE_ROW_END [optparm]
Returns a </TR> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets). You must include a TABLE_END for every TABLE_START you include.

TABLE_HEADER_START [optparm]
Returns a <TH> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

TABLE_HEADER_END [optparm]
Returns a </TH> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets). You must include a TABLE_HEADER_END for every TABLE_HEADER_START you include.

TABLE_HEADER headertext [optparm]
Returns a <TH> and </TH> pair with the passed headertext between them. This is a simple form that allows headers to be specified easily.

TABLE_ITEM_START [optparm]
Returns a <TD> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

TABLE_ITEM_END [optparm]
Returns a </TD> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets). You must include a TABLE_ITEM_END for every TABLE_ITEM_START you include.

TABLE_ITEM itemtext [optparm]
Returns a <TD> and </TD> pair with the passed itemtext between them. This is a simple form that allows items to be specified easily.

Link Services

LINK_START destination [optparm]
Returns a <A HREF=> tag as defined for the current style. destination is the URL to be embeded in the link as the destination of that link. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

PROG_LINK_START destination parameters [optparm]
Returns a <A HREF=> tag as defined for the current style. destination is the name of a WebSage program to be invoked when the link is selected. Note that the program path is prefixed to this automatically, so you should not include it again. parameters are optional parameters (name/value pairs) to be passed to the program. WWW will automatically attach a unique identifier to the parameters (to prevent browser caching) and will incldue the current login session ID (if any). Name/value pairs are passed along as "name=value". If the "value" portion includes spaces or ampersands, plus characters or question marks, you must first encode it for HTML transmission using the HTML_ENCODE option. If you have more than one name/value pair, use a ampersand to seperate them (i.e. name=bob&order=up). The parameter option is required, but can be an empty string. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

HTML_LINK_START destination [optparm]
Returns a <A HREF=> tag as defined for the current style. destination is the name of a HTML page from the services static HTML directory. The actual directory path will be prefixed to the passed destination, so it shouldn't be included in what you pass. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

DISTRICT_HTML_LINK_START destination [optparm]
Returns a <A HREF=> tag as defined for the current style. destination is the name of a HTML page from the services district specfic directory. The actual directory path will be prefixed to the passed destination, so it shouldn't be included in what you pass. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

LINK_END [optparm]
Returns a </A> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets). You must include a LINK_END for every LINK_START (or similar tag) you include.

ANCHOR name [optparm]
Returns a <A NAME=> tag as defined for the current style. Anchors are usually used for destination points within an HTML document. name is the name of the anchor and in most cases, should start with a hash mark character (#).If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

LINK destination markedtext [optparm]
Returns a LINK_START and LINK_END pair with the passed markedtext between them. This allows simple links to be created easily. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

PROG_LINK destination parameter markedtext [optparm]
Returns a PROG_LINK_START and LINK_END pair with the passed markedtext between them. This allows simple program links to be created easily. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

HTML_LINK destination markedtext [optparm]
Returns a HTML_LINK_START and LINK_END pair with the passed markedtext between them. This allows simple static HTML links to be created easily. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

DISTRICT_HTML_LINK destination markedtext [optparm]
Returns a DISTRICT_HTML_LINK_START and LINK_END pair with the passed markedtext between them. This allows simple district specific static HTML links to be created easily. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

FRAME Services

FRAMESET_START [optparm]
Returns a <frameset> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets). Note that a FRAMESET_START and FRAMESET_END must not occur between BODY_START and BODY_END tags or it may be ignored.

FRAMESET_END [optparm] Returns
Returns a </frameset> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets). Note that a FRAMESET_START and FRAMESET_END must not occur between BODY_START and BODY_END tags or it may be ignored.

FRAME name content [optparm]
Returns a <frame> tag as defined for the current style. name is the name of the frame (mostly used for links) and content is the URL of the HTML page to load into the frame. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets). Note that a FRAME or PROG_FRAME must occur between FRAMESET_START and FRAMESET_END tags or it may be ignored.

PROG_FRAME_START name content parm [optparm]
Returns a <frame> tag as defined for the current style. name is the name of the frame (mostly used for links) and content is a WebSage program that will be executed to fill the frames body. Note that the path to WebSage programs will be automatically prefixed to the passed program name, so you should not include it. parm is any name/value info that should be passed along to the program. See PROG_LINK_START for more information on this. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets). Note that a FRAME OR PROG_FRAME must occur between FRAMESET_START and FRAMESET_END tags or it may be ignored.

NOFRAMES_START [optparm]
Returns a <noframes> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets). NOFRAME_START is meant to show messages to users who attempt to work with a frames incapable browser. NOFRAMES_START and NOFRAMES_END must come after the last FRAMESET_START/FRAMESET_END tags.

NOFRAMES_END [optparm]
Returns a </noframes> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets). NOFRAME_START is meant to show messages to users who attempt to work with a frames incapable browser. NOFRAMES_START and NOFRAMES_END must come after the last FRAMESET_START/FRAMESET_END tags.

Text Flow Services

PARA_START [optparm]
Returns a <P> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

CENTERED_PARA_START [optparm]
Returns a <P ALIGN=CENTER> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

PARA_END [optparm]
Returns a </P> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

SECTION_START [optparm]
Returns a <DIV> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

CENTERED_SECTION_START [optparm]
Returns a <DIV ALIGN=CENTER> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

SECTION_END [optparm]
Returns a </DIV> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

LINE_BREAK [optparm]
Returns a <BR> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

HORIZ_RULE [optparm]
Returns a <HR> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

Text Formatting Services

BOLD_START [optparm]
Returns a <B> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

BOLD_END [optparm]
Returns a </B> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

BOLD text [optparm]
Returns a <B>..</B> tag pair as defined for the current style. 'text' is inserted between the start and end tags. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets). This tag provides a simple way to include bolded text easily.

ITALICS_START [optparm]
Returns a <I> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

ITALICS_END [optparm]
Returns a </I> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

ITALICS text [optparm]
Returns a <I>..</I> tag pair as defined for the current style. 'text' is inserted between the start and end tags. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets). This tag provides a simple way to include italicized text easily.

UNDERLINE_START [optparm]
Returns a <U> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

UNDERLINE_END [optparm]
Returns a </U> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

UNDERLINE text [optparm]
Returns a <U>..</U> tag pair as defined for the current style. 'text' is inserted between the start and end tags. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets). This tag provides a simple way to include underlined text easily.

BASE_FONT [optparm]
Returns a <BASEFONT> tag as defined for the current style. This is usually automatically included after the BODY_START tag - it's unusual that you would need to explicitly use this in a web page. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

FONT_START [optparm]
Returns a <FONT> tag as defined for the current style and most recently specified font (via SET FONT). If no font has been explicitly selected, the primary font for the style is selected. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

NAMED_FONT_START name [optparm]
Returns a <FONT> tag as defined for the current style. The font to be used is passed as name. This must be a font definition for the currently defined style. If the named font is not found for the currently defined style, the last font selected via SET FONT (or the styles primary font, if nothing has been explicitly selected) is used. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets). Note that if you need multiple NAMED_FONT_START tags to the same font, it will be much more efficiant to simple change the font using SET FONT and use the normal FONT tag.

FONT_END [optparm]
Returns a </FONT> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

FONT text [optparm]
Returns a <FONT>..</FONT> tag pair as defined for the current style and most recently specified font (via SET FONT). If no font has been explicitly selected, the primary font for the style is selected. 'text' is inserted between the start and end tags. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets). This tag provides a simple way to include fontified text easily.

NAMED_FONT name text [optparm]
Returns a <FONT>..</FONT> tag pair as defined for the current style. The font to be used is passed as name. This must be a font definition for the currently defined style. If the named font is not found for the currently defined style, the last font selected via SET FONT (or the styles primary font, if nothing has been explicitly selected) is used. 'text' is inserted between the start and end tags. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets). This tag provides a simple way to include fontified text easily. Note that if you need multiple NAMED_FONT_START tags to the same font, it will be much more efficiant to simple change the font using SET FONT and use the normal FONT tag.

List Services

ORDERED_LIST_START [optparm]
Returns a <OL> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

ORDERED_LIST_END [optparm]
Returns a </OL> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

UNORDERED_LIST_START [optparm]
Returns a <UL> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

UNORDERED_LIST_END [optparm]
Returns a </UL> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).

LIST_ITEM [optparm]
Returns a </LI> tag as defined for the current style. If 'optparm' is passed, it's included in the body of the HTML tag (i.e. within the angle brackets).