Preface

This section contains the following topics:

  • Conventions

  • Related Documentation

Conventions

The following conventions are used in this document.

Notational conventions

This help uses the following conventions:

Convention

Usage

Bold

User-interface elements such as a menu item or button. For example:
Select Cancel to halt the operation.

Italics

Document titles and new terms. For example,

  • For more information, refer to iManage Work Server Administration Guide.

  • An action command is a request, such as a query or indexing instruction, sent to iManage Work Server.

monospace font

File names, paths, and code. For example: The FileSystemConnector.cfg file is installed in C:\iManage\FileSystemConnector\

monospace bold

Data typed by the user. For example:

  • Type run at the command prompt.

  • In the User Name field, type: Admin

monospace italics

Replaceable strings in file paths and code. For example: UserName

Command-line syntax conventions

This guide uses the following command-line syntax conventions:

Convention

Usage

[optional]

Brackets describe optional syntax. For example:
[-create]

|

Bars indicate “either | or” choices. For example:
[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.
For example:
{ [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 type the required syntax element.

variable
<variable>

Italics specify items to be replaced by actual values. For example:
-merge filename1
(In some documents, angle brackets are used to denote these items.)

...

Ellipses indicate repetition of the same pattern. For example:
-merge filename1, filename2, [filename3 ...]
where the ellipses specify, filename4, and so on.

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

Notices

NOTE:

A note provides information that emphasizes or supplements important points of the main text. A note supplies information that may apply only in special cases—for example, memory limitations, equipment configurations, or details that apply to specific versions of the software.

CAUTION:

A caution indicates an action can result in the loss of data.

TIP:

A tip provides additional information that makes a task easier or more productive.

Related documentation

The following documents provide more details about iManage Work: