Stylistic Conventions

The following stylistic conventions are used in this book.

 


Convention

Usage

Plain

Narrative text.

Bold

User-interface elements in narrative text:

Click Cancel to halt the operation.

Italics

Book titles and new terms:

For more information, see the Verity K2 Getting Started Guide.

An index is a Verity collection, parametric index, or recommendation index.

Monospace

File names, paths, and code:

The name.ext file is installed in:

C:\Verity\Data\

Monospace italic

Replaceable strings in file paths and code:

user username

Monospace bold

Data types and required user input:

SrvConnect A connection handle.

In the User Interface text box, type user1.


The following command-line syntax conventions are used in this book.

 


Convention

Usage

[ optional ]

Brackets describe optional syntax, as in [ -create ] to specify a non-required option.

|

Bars indicate “either | or” choices, as in

[ option1 ] | [ option2 ]

 

In this example, you must choose between option1 and option2.

{ required }

Braces describe required syntax in which you have a choice and that at least one choice is required, as in

{ [ option1 ] [ option2 ] }

 

In this example, you must choose option1, option2, or both options.

required

Absence of braces or brackets indicates required syntax in which there is no choice; you must enter the required syntax element.

variable

Italics specify variables to be replaced by actual values, as in

-merge filename1

...

Ellipses indicate repetition of the same pattern, as in

-merge filename1, filename2 [, filename3 ... ]

 

where the ellipses specify , filename4, and so on.


Use of punctuation—such as single and double quotes, commas, periods—indicates actual syntax; it is not part of the syntax definition.