Syntax Descriptions Legend
In Lion the command syntax descriptions will always have the same structure following the rules described below.
Command
The command itself will always be displayed in blue and can either be a direct Lion command or a subroutine or function. Subroutines and functions are recognizable by the parenthesis '()' following the command.
Examples
EXIT
IF boolean expression
code
ENDIF
REFRESH ()
Parameters
In Lion parameters can be assigned values to by regular expression, variables or literal values, or they can assigned values to by using predefined Lion keywords. In the syntax description the parameters will always be placed between less than, greater than signs '<>' with the one exception of a single Lion keyword which will be in capital. When parameters or keywords are optional they will be placed between square brackets '[]'.
Multiple parameters will be delimited by a comma ','.
The function of the parameters and possible values will always be described in the Parameters section of each command description.
Colors
To enhance readability the different parameter categories will be displayed with their own color following the legend below.
- <Mandatory parameter> in black/white
- [<Optional parameter>] in green
- <Mandatory keyword> in red
- [<Optional keyword>] in orange
Examples
COPY (<Item>, <Position>[, <Length>])
COUNTING (<Result>, <Option>[, <Search> | <Search array>][, <Condition>, <Value>])
Choice between Parameters
Sometimes a choice between to different parameters has to be made. These parameters will then both be displaced with a vertical OR bar '|' between them as shown in the third example above between <Search> and <Search array>.