1.02 Documentation Syntax

How to read the syntax

  • Anything written inside [] characters is optional.
  • Anything written inside {} characters means that there is a choice and you must select one of them.
  • The symbol | means OR.
  • Where a choice of options is shown, an underlined value is the default if no choice is made.
  • The symbols … means you can repeat the previous syntax.
  • The keywords are written in bold type.
  • The parameters are written in italic type.
  • The keywords with suffix ( ) are functions.
  • The parameters with suffix ( ) are arrays.

Example 1

This is a keyword
This is a function
This is a parameter
This is a variable
This is an array
This means that you must specify A or B
This means that you must select A or B or may select nothing
This means that you must select A or B. If you select nothing A is the default.

Example 2

get a[, x]

You must provide the first parameter (a) but but the second (x) is optional. If you do provide (x) you must separate it from (a) with a comma.

Example 3

get value[, value] […]

You must provide the first parameter. You can also provide the second parameter but you must separate it with a comma (,). You can also repeat the value any many times as necessary.

The following code examples all follow this syntax:

put a
put a, b
put a, b, c

Example 4

// Syntax: TEST {1|2}
test 1
test 2

// Syntax: TEST [HI]
test HI

lynplex/lp0102.txt · Last modified: 2011/09/08 16:06 (external edit)