DGL Statement Reference

DGL Statement Reference

 

Document Templatesprovides general information about the Document Generator Language (DGL), including its overall use, conventions, and a detailed description of the types of statements used in programming document templates. This section provides a comprehensive reference for the DGL statements.

This section presents the statements in alphabetical order by name or keyword. For each DGL statement, the following information is provided:

Name - The keywords used to write the statement.
Description - A detailed description of the statement and what it does.
Syntax - A general syntax description of the statement’s structure, including parameters, qualifiers, and options.

The syntax section uses the following conventions:

Except for literal strings, DGL statements are not case-sensitive, and your input can be in either upper- or lowercase. However, upper- and lowercase letter are used in the syntax section to indicate the following:

Keywords are shown using uppercase letters.

Words written entirely in lowercase indicate variable qualifiers or parameters.

Consider the following examples:

ALPHA beta [gamma]

ALPHA is a statement that takes a required qualifier beta, and might take an optional qualifier, gamma.

JUNK filename [,filename...]

JUNK is a statement that takes a file name as a parameter. You can specify multiple file names, separating them with commas.

Note: Each DGL statement must be concluded by a semicolon. This is shown in the statement syntax. Flow control and structure statements can contain a number of statements. Multiple statements can be contained on a single line, or a single statement can span several lines.
Notes - Special points of interest regarding the use of the statement.
Examples - Examples that illustrate how to use the statement.
See Also - This refers you to the section of this manual where the particular statement is explained.

The remainder of this section presents the DGL statements in alphabetical order.