Notation Conventions

This document uses the following notation conventions:

{BX}

The syntax {BX} refers to the directory into which the Builder Xcessory is installed. The default directory is the following:

/usr/ics

Index

Most index entries are in lowercase:

fonts

fixed width 28

non-XLFD 228

Entries capitalized in Builder Xcessory are capitalized in the index:

Force To Selected 161

Force to Selected Tree 161

Languages

Because Builder Xcessory supports multiple programming languages, not all explanations or examples are applicable to all languages. The following icons indicate sections specific to particular languages:


Note: Information that applies to all Motif environments does not use icons. In text, Motif refers to C, C++, ViewKit, and UIL, but not Java.


Lists

The following two types of lists present procedures:

  1. Numbered lists present steps to perform in sequence.

  • Bulleted lists present alternate methods.

Objects

Objects are indicated as follows:

  • Palette collection names are capitalized words with intercaps:

    Form or PushButton

  • Instance names are lowercase words with intercaps:

    form or pushButton

  • Class names are capitalized words with intercaps:

    Test or MyClass

Menu Notation

To indicate menus and menu options, the following format is sometimes used:

BX_window_name:menu_name:menu_item(or dialog_selection)

For example, Browser:File:Exit is the Exit selection from the File menu of the Browser window.

Text

  • Literals such as file names, directory paths, code and text as typed on the command line are printed in Courier font:
    .bxrc
    /usr/ics
    -gen JAVA

  • Text preceded by a % denotes text to enter at the command line:
    % bx

  • Book titles, chapter names, and section names appear in italic:

    Builder Xcessory Reference Manual

    "Updating the Resource Editor"

  • The main windows of the Builder Xcessory are capitalized as follows:

    Palette

    Browser

    Resource Editor

Documentation: