RWA_INSERT_CONV_ITEM

Purpose

Opens a Reality file and reads the specified item. Occurrences of tokens in the item are replaced with corresponding values taken from a list. A token consists of an identifier enclosed in delimiter characters.

The result is appended to the variable vString.

Syntax

RWA_INSERT_CONV_ITEM(vString, Filename, Itemid, aTokens, aValues, Delim)

Parameters

vString A variable containing the string to which the generated code is appended. On return, contains the modified string. If the string does not exist, it is created.

Filename The name of the Reality file to be opened.

Itemid The item-id of the item to be read.

aTokens A dynamic arrayClosed A multi-element string variable in which data is divided into elements by attribute marks, value marks and subvalue marks, matching the structure of a Reality file item. The entire array is referenced and stored as a single variable. For more information, refer to the Reality DataBasic Reference Manual.  containing a list of token identifiers to be substituted.

aValues A dynamic arrayClosed A multi-element string variable in which data is divided into elements by attribute marks, value marks and subvalue marks, matching the structure of a Reality file item. The entire array is referenced and stored as a single variable. For more information, refer to the Reality DataBasic Reference Manual.  containing values to replace occurrences of corresponding tokens.

Delim The delimiter character used to identify tokens in the item.

Comments

In the Reality item, each token must be enclosed in the specified delimiter character. For example, if the delimiter character is specified as "#", the text #value1# represents the token "value1".

If the dynamic arrays aTokens and aValues are non-null, the subroutine searches the item for occurrences of attributes in the aTokens array enclosed in the specified delimiter character. Each attribute in aTokens is replaced by the corresponding attribute in aValues - for example, the second attribute in aTokens is replaced by the second attribute in aValues.

Any attribute marks in the item are converted to linefeeds.

This subroutine can be used to insert Reality data into an HTML template on the host system, made available to Reality through a directory view. The template can therefore be created using a commercial HTML editor (such as Adobe DreamWeaver or Microsoft FrontPage) and then used as the basis of a web page generated using RealWeb. This is illustrated in Example 2.