Command descriptions, Command descriptions -18, Conventions – Xerox -05W User Manual

Page 222

Advertising
background image

12-18

Creating A Script File

Command Descriptions

The commands that can be used in the script file are described in alphabetical order on
the following pages.

Conventions

Character Case

Each command description begins by showing the basic command followed by the
command format with any parameters. The command itself is shown in uppercase
though it is not case sensitive. Commands referred to within the main text, and
program examples, are generally shown in lowercase.

Parameters

If a command requires one or more parameters then an indication of the entry
required is enclosed in angle brackets. For example:

DIALOGUE <title> <caption> <variable>

Each parameter indicator must be substituted with the relevant information as
specified by the description for the command. So for the example above you could
enter the following:

DIALOGUE "Name" "Please enter your name here" name

If a command includes parameters that may be omitted, these will be enclosed by
square brackets. For example:

HCMP,<time> <string1> [<string2>...]

where <string2> is optional.

Do not include the angle or square brackets as part of the command unless you are
specifically told to do so in the command description.

Boolean Values

When a command requires a boolean value, this can be any of the following where
the value may be abbreviated to the UPPERCASE characters: 0 or 1, No or Yes,
False or True, OFF or ON.

Advertising
This manual is related to the following products: