[<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
- Syntax Conventions -
------------------------------------------------------------------------
The follow are the syntax conventions used throughout the PROCLIP2
documentation.
[...] Indicates an optional parameter. Any parameter surrounded by
square brackets should be considered optional. All optional
parameters have a default.
'...' Indicates a parameter string. A parameter string is a word or
phrase used to inform the function of a certain request, as in
'on' or 'off'. All examples use lower case but case is not
sensitive in any of the PROCLIP2 functions which use a
parameter string.
| Indicates an exclusive or. In other words, multiple
parameters separated by the | character are mutually exclusive
and cannot be used in the same function call, as in 'on' |
'off'.
Example:
As this function employs all syntax possibilities, it is the best to
discuss in an example.
cursor(['std' | 'off' | 'half' | 'full'] | [start,end])
[...] The parameters surrounded by square brackets are optional in
that they are not necessary for the function to operate in
default mode. When two or more parameters are enclosed within
the same bracket pair they are dependent upon each other in
one way or another.
'std' This, and the other parameters specified in this fashion, are
string parameters informing the function of the action to
take. This mechanism makes reading the resulting source code
easier as no "cryptic" codes need to be interpreted.
| All parameters separated by the "|" character are mutually
exclusive in that they cannot be used in the same function
call. Notice how all of the "pre-programmed" cursor sizes in
the example are grouped in the square brackets, but are also
mutually exclusive. Further, the "pre-programmed" sizes are
exclusive from the programmable size specified in the
[start,end] group.
.
Online resources provided by: http://www.ClipX.Net --- NG 2 HTML conversion by Dave Pearson