User Guide Conventions

This page describes the common conventions used throughout this user guide.

The following abbreviations are used:

• OGSA-DAI refers to the base directory of the OGSA-DAI distribution.
• CONTAINER refers to the path where the webapps directory in a Web Services container is located.
• GT refers to the base directory of a Globus Toolkit installation.

Text formatting is used to highlight:

• The introduction of a new term.
• Information that is considered important.
• Java classes, objects and variables, for example:
  • some.class.org.Class
  • someMethod()
  • mVariable
• XML elements, attributes, values and other content, for example:
  • <someElement>
  • someAttribute
• Command-line commands and arguments, for example:
  • ant
  • some/file/name
• PortType names and operation names for example:
  • MyPortType
  • MyPortType::MyOperation
• SQL commands and arguments, for example:
  • SELECT
• GUI widgets, for example:
  • Command, indicates a menu item or button.
  • <Ctrl-R>, indicates a shortcut.
  • "Title", indicates a labelled part of an interface.
  • "Information", indicates information you must enter into an interface or information within an interface that you can edit.

Java, XML and command-line excerpts are also shown using special formatting. For example:

import package.class.Class;

public class SomeClass {

  public void someMethod() {

    . . .
  }
}

<someElement someAttr="someValue">
  <someOtherElement>
    someContent
  </someOtherElement>
</someElement>

$ java -classpath .:$CLASSPATH some/java/Class.java