Advanced Replication Guide : Advanced Replication User Guide : Conventions
  
Conventions
Typographic conventions
solidDB® documentation uses the following typographic conventions:
Format
Used for
Database table
This font is used for all ordinary text.
NOT NULL
Uppercase letters on this font indicate SQL keywords and macro names.
solid.ini
These fonts indicate file names and path expressions.
SET SYNC MASTER YES; COMMIT WORK;
This font is used for program code and program output. Example SQL statements also use this font.
run.sh
This font is used for sample command lines.
TRIG_COUNT()
This font is used for function names.
java.sql.Connection
This font is used for interface names.
LockHashSize
This font is used for parameter names, function arguments, and Windows registry entries.
argument
Words emphasized like this indicate information that the user or the application must provide.
Administrator Guide
This style is used for references to other documents. New terms and emphasized issues are also written like this.
File path presentation
Unless otherwise indicated, file paths are presented in the UNIX format. The slash (/) character represents the installation root directory.
Operating systems
If documentation contains differences between operating systems, the UNIX format is mentioned first. The Microsoft Windows format is mentioned in parentheses after the UNIX format. Other operating systems are separately mentioned. There may also be different sections for different operating systems.
Syntax notation conventions
solidDB® documentation uses the following syntax notation conventions:
Format
Used for
INSERT INTO table_name
Syntax descriptions are on this font.
Replaceable sections are on this font.
solid.ini
This font indicates file names and path expressions.
[ ]
Square brackets indicate optional items; if in bold text, brackets must be included in the syntax.
1
A vertical bar separates two mutually exclusive choices in a syntax line.
{ }
Curly brackets delimit a set of mutually exclusive choices in a syntax line; if in bold text, braces must be included in the syntax.
...
An ellipsis indicates that arguments can be repeated several times.
. . .
A column of three dots indicates continuation of previous lines of code.
See also
Advanced Replication User Guide