6.3 Format for describing the definition file syntax

This chapter describes the syntax of definition files coded hereafter in the following format. Note that not all the files are coded in the following format. In addition to the following items, the information specific to individual files might also be provided.

Format
Indicates the format for describing a file.
Function
Describes the functionality of a file.
DTD
Describes Document Type Definition (DTD) of a file.
File storage location
Indicates the location where a file is stored.
Specifiable elements
Describes the XML elements that can be specified in a file.
Specifiable parameters
Describes the parameters that can be specified in a file.
Specifiable properties
Describes the properties that can be specified in a file.
Example of coding
Indicates a coding example for the file contents.
Usage
Describes how to use a file.
Notes
Provides notes on setting up and using a file.

The following table lists and describes the symbols used for syntax explanations in this chapter:

SymbolMeaning
|In syntax explanations, a vertical bar separates multiple items, and has the meaning of OR.
For example: A|B means A or B.
{ }In syntax explanations, curly brackets indicate that only one of the enclosed items is to be selected. If the items are arranged horizontally and separated by a vertical bar (|), select one of the items.
For example: {A|B|C} means only one of A, or B, or C.
[ ]In syntax explanations, square brackets indicate that the enclosed item or items are optional.
For example: [A] means that you can specify A or nothing.
...In coding, an ellipsis (...) indicates that one or more lines of coding have been omitted.
For example: ABC... means that the coding after ABC has been omitted.
~In syntax explanations, a swung dash ( ~) indicates that the items preceding the swung dash comply with the rules mentioned in < >, (()), and << >> following the swung dash.
< >In syntax explanations, angle brackets indicate the syntax elements that must be complied with when the items are coded. For details on syntax elements, see the following table.
(())In syntax explanations, double parentheses indicate the range of values that you can specify for an item.
<< >>In syntax explanations, double angle brackets indicate the default value that the system assumes when an item is omitted.

The following table lists the types and definitions of the syntax elements used in this chapter:

TypeDefinition
Alphabetic charactersA to Z, a to z
Lowercase alphabetic charactersa to z
Uppercase alphabetic charactersA to Z
Numeric characters0 to 9
Alphanumeric charactersA to Z, a to z, 0 to 9
Symbols_, ., -
Character stringAn array of strings