Documentation conventions

The Borland documentation for JBuilder uses the typefaces and symbols described in the table below to indicate special text.

Typeface and symbol conventions

Typeface Meaning
Monospace type Monospaced type represents the following:
  • text as it appears onscreen
  • anything you must type, such as "Enter Hello World in the Title field of the Application wizard."
  • a key on your keyboard, such as "Press Esc to exit a menu."
  • file names
  • path names
  • directory and folder names
  • commands, such as SET PATH, CLASSPATH
  • Java code
  • Java identifiers, such as names of variables, classes, interfaces, components, properties, methods, and events
  • package names
  • argument names
  • field names
  • Java keywords, such as void and static
Bold Bold is used for java tools, bmj (Borland Make for Java), bcj (Borland Compiler for Java), and compiler options. For example: javac, bmj, -classpath.
Italics Italicized words are used for new terms being defined and for book titles.
[ ] Square brackets in text or syntax listings enclose optional items. Do not type the brackets.
< > Angle brackets in text or syntax listings indicate a variable string; type in a string appropriate for your code. Do not type the angle brackets. Angle brackets are also used for HTML tags.
... An ellipsis in syntax listing indicates code that is missing from the example.

JBuilder is available on multiple platforms. See the table below for a description of platform and directory conventions used in the documentation.

Platform conventions and directories

Item Meaning
Paths All paths in the documentation are indicated with a forward slash (/).
For the Windows platform, use a backslash (\).
Home directory The location of the home directory varies by platform.
  • For UNIX and Linux, the home directory can vary. For example, it could be /user/[username] or /home/[username]
  • For Windows 95/98, the home directory is C:\Windows
  • For Windows NT, the home directory is C:\Winnt\Profiles\[username]
  • For Windows 2000, the home directory is C:\Documents and Settings\[username]
.jbuilder directory The .jbuilder directory, where JBuilder settings are stored, is located in the home directory.
jbproject directory The jbproject directory, which contains project, class, and source files, is located in the home directory. JBuilder saves files to this default path.
Screen shots Screen shots reflect JBuilder's Metal Look & Feel on various platforms.