The following typographical styles are used:

  • Monospace text indicates file system paths or file names.
  • <Monospace text in angle brackets> indicates any part of text that you type in which must be replaced with something else, for example, file system paths or file names, to match your configuration or your preference.
  • Bold monospace text indicates a command that you need to type on the command line or a system path or file name that needs to be replaced. Command line arguments for which you need to substitute a value are surrounded by angle brackets. For long commands you might see a caret symbol (^ Windows) or a backslash symbol (\ Linux) dividing lines of the command. This allows the command to be cut and pasted across multiple rows. An operating system icon is used to distinguish between the two.

For example,
java -cp <classpath> edu.mayo.uima.Class <arg1> <arg2>
<classpath> is the absolute path to the class being executed
<arg1> is an argument
<arg2> is another argument

Other conventions

Monospace text enclosed in a box of this style
indicates contents in a file.

A box like this provides additional information or remarks.

A box like this denotes an important part of the steps not to miss.

A box like this denotes additional tips and tricks to make usage easy.

  • No labels