Introduction to the Reference Manual

Most classes (or related sets of classes) have a Reference Manual, which is an alphabetical listing of members. This document can be viewed on its own, or accessed via the index in the left-hand pane.

Each class (or related set of classes) also has a User's Guide, which is a less technical description of what a class is and how it should be used. You can access the User's Guide from the index in the left pane, too. Some simple classes don't have a separate Reference Manual, but have a single document describing its usage and technical details.

Getting Started

If you have no idea what this library is all about, start with the Project Description.

If you are looking for documentation on something in particular, the [classes] glossary is the place to start.

For any documentation that is not filed under a specific class, use the [Repertoire intro] button, which puts a documentation index into the left pane.

If you want to read up on one of the individual libraries, use the blue buttons in the top pane.

Getting Around

The top pane is a perminant navigation bar (if you are viewing this page alone without frames, click here to bring up the whole thing). The blue buttons bring up a top-level list of classes (or other subcomponents) in one library. The red buttons are more general information or links to other places. Of particular note, the red "Classes" button brings up a hyperlinked glossary of all the classes in the system.

Blue Buttons

Classics goes to the Classics library manual. RatWin goes to the RatWin library manual. Tomahawk goes to the Tomahawk library manual. (Conquer is not yet available.)

Red Buttons

[Repertoire intro] brings up information about the complete collection, and about this manual. Use that at any time if the left pane shows something different and you want to browse the documentation. This is the primary way to view all the available documentation that is not filed under a specific class.

[classes] brings up a hyperlinked glossary of all classes in the system, across all libraries.

[download] goes to the download page.

[home] goes to my home page.