Notational Conventions

Convention

Explanation

Example

Italic

Italic is used for

  • emphasis

  • the introduction of new terms

  • denotation of terms

  • placeholders

  • titles of manuals

Do not close the project without saving.

The filename consists of the basename and the extension.

The expression and/or denotes an inclusive choice between two or more items.

The bitmap is width pixels wide and len pixels high.

For more information, refer to the Intel® Debugger Online Help.

Bold

Text in boldface denotes elements of the graphical user interface.

The Cancel button of the Start dialog box

Monospace

Monospace indicates

  • filenames, directory names and pathnames

  • commands and command-line options

  • function names, methods, classes, data structures in body text

  • source code

  • ippsapi.h \alt\include ecl-O2
  • Use the CreateObj()function to

  • printf("hello, world\n");

Monospace italic

Italic monospace indicates source code parameters, arguments, or other placeholders.

ippiMalloc( int width, int* pStep);

Monospace bold

Bold monospace indicates what you type as input on a command line or emphasizes parts of source code.

  • [c:] dir

  • x = ( h > 0 ? sizeof(m) : 0xF ) + min;

[ ]

Items enclosed in brackets are optional.

Fa[c]

Indicates Fa or Fac.

{ | }

Braces and vertical bars indicate the choice of one item from a selection of two or more items.

X{A | B | C}

Indicates one of XA, XB, and XC.

"[" "]" "{"

"}" "|"

Writing a metacharacter in quotation marks negates the syntactical meaning stated above; the character is taken as a literal.

"[" X "]" [ Y ]

denotes the letter X enclosed in brackets, optionally followed by the letter Y.

The ellipsis indicates that the previous item can be repeated several times.

filename

Indicates that one or more filenames can be specified.

,…

The ellipsis preceded by a comma indicates that the previous item can be repeated several times, separated by commas.

word ,…

Indicates that one or more words can be specified. If more than one word is specified, the words are comma-separated.

>

Indicates a menu item inside a menu.

File > Close

indicates to select the Close item from the File menu.


Submit feedback on this help topic