Command, Data, and Configuration File Syntax


The data in the configuration is collected into frames. A basic frame consists of the following characters. To be legitimate, all of these characters must be the first character, including white space, in a line.

{ The frame is opened with a '{' character. The frame will not open if another frame is open.

# The '#' precedes a data segment name. A data segment name begins a data segment. A data segment can't open when another data segment is already opened. A data segment can only be opened inside a frame.

* The '*' ends a data segment. If the data segment is not ended, all characters, except comments, are considered data. In other words, other frames or data segments would become data to the open data segment.

} The '}' character ends a frame, if a frame is open.

In addition to the required syntax which was just given, the following optional characters can be used.

~ The '~' character flags the frame. The flags are used to select or reject the frame using boolean logic (e.g., and AND, OR, and NOT). For example, the frame might be tagged as text. To be effective, the '~' character must be the first character in a new line including white space and a frame must be open.

||| Three vertical bars, "|||", can be used as an alternative for a line return. For example, "|||{|||~ Text|||# Data|||" could be the opening of a frame. In addition, if a single data segment contains multiple tables and the vertical bars are the first three characters of a line, including white space, they are considered to be a delimiter for an end of the table.

/* The opening of a comment which was borrowed from various programming languages in general and C in particular.

*/ The closing of a comment.

; The semicolon indicates that the rest of the line is a comment.

An example of a data frame can be found here.


Home

Table of Contents