Documentation Conventions

This section describes the types of conventions used throughout this guide.

General Conventions

The following general conventions are used in this guide:

• File and directory paths are given in UNIX® format (with forward slashes separating directory names). For Windows versions, the directory paths are the same, except that backslashes are used to separate directories.

• URLs are given in the following format:

  http:/server.domain/path/file.html

  In these URLs, server is the server name where applications are run; domain is your Internet domain name; path is the server’s directory structure; and file is an individual filename. Emphasis items in URLs are placeholders.

• Font conventions include the following:

  • The monospace font is used for sample code and code listings, API and language elements (such as function names and class names), file names, path names, directory names, and HTML tags.

  • Emphasis type is used for code variables.

  • Emphasis type is also used for book titles, emphasis, variables and placeholders, and words used in the literal sense.

  • Bold type is used as either a paragraph lead-in or to indicate words used in the literal sense.

• Installation root directories for most platforms are indicated by install-dir in this document.

  By default, the location of install-dir on most platforms is:

  • Solaris and Linux file-based installations, non-root user:

    user’s home directory/SUNWappserver

  • Solaris and Linux file-based installations, root user:

    /opt/SUNWappserver

  • Windows, all installations:

    system drive:\\Sun\\AppServer

• Domain root directories are indicated by domain-dir in this document, which by default is an abbreviation for the following:

  install-dir/domains/

  However, for package-based installations, the directory containing all the domains can be changed from install-dir/domains/ to another directory during installation. In configuration files, you may see domain-dir represented as follows:

  ${com.sun.aas.instanceRoot}