General / Documentation conventions |
The term syntax is global and indicates the way to use a product function.
For example, it can be used to describe a language instruction or a command-line tool:
CALL function ( [ parameter [,...] ] ) [ RETURNING variable [,...] ]
Language keywords are written in uppercase.
Variable elements in a syntax definition are written in italic.
Wildcard characters in syntax definitions are marked with an underscore:
Wildcards | Description |
---|---|
[ e ] | Square braces indicate an optional element in the syntax. |
[ e1 | e2 ... ] | Square braces with pipe indicate an optional element to be selected from the list. |
{ e1 | e2 ... } | Curly braces with pipe separator indicate a mandatory element the be selected from the list. |
[...] | Indicates that the previous element can appear more than once. |
[,...] | Previous element can appear more than once, and must be separated by a comma. |