Document Conventions

To aid in reader understanding, this document uses specific formatting and typographical techniques to represent different types of data. This page describes those conventions below:

Typographical Conventions

bold - bold text is used to represent keywords and text that would be used within an SCL file within normal descriptive text.

italics - italicized text is used to represent: (1) certain concepts, or (2) parts within SCL that you need to replace with your own values.

UPPERCASE - SCL is not case sensitive but within this document SCL keywords are all used in full uppercase (capital) letter form to emphasize them within descriptive text. You may use character case for these keywords as you wish in your own scripts.

Command Definition Syntax

Each SCL command and statement has its format defined in this document using a simple syntax. Definitions will appear in this form:

COMMAND [OPTION1|OPTION2] param1
	{WITH param2}

A command's definition may be split over multiple lines, this is only done for legibility and splitting an actual command over multiple lines requires use of the continuation character.

Within the definition the SCL keywords are all listed in uppercase. SCL is not case sensitive in its keyword use though, the keywords used in actual Scripts can have any use of case.

The syntax [OPTION1|OPTION2] means that either OPTION1 or OPTION2 but not both should be given. Any number of options may be given surrounded by square brackets and seperated by the vertical bar symbol.

The syntax {optional} means that the items enclosed in the curly brackets are optional.

Items in italics are parts of the command that are replaced when used - what they can be replaced with is described following the definition.

In the definition Ellipsis (...) or {s} can be used in combintation with optional section brackets to define where parts of the command can be repeated.

If square brackets or other characters that may be used in the definition syntax are actually required as part of the command then they will be shown in bold.

Example Format

SCL usage examples will appear in this form:

COMMAND "Quoted string" ON Variable-Name &
	WITH Another-Var

Within all examples, the SCL keywords are listed in uppercase. SCL is not case sensitive in its keyword use though, the keywords used in actual Scripts can have any use of case. The variable names will all be given with words capitalized and seperated by dashes (-), in real use these are case independent as well.

Hexadecimal values

The integer values that ASCII characters are traditionally represented using hexadecimal (base 16), this document and SCL follow this convention. Within this document, descriptive text hexadecimal integers are preceded by the 2 characters 0x, so decimal 255 would be 0xFF.