1.3 Documentation

Rogue Wave offers a range of product documentation for Money.h++, including:

A build guide
This manual (the user's guide)
A class reference
Java component API documentation
A readme file

The user's guide and class reference are provided in HTML format and are also available for purchase as a combined printed manual. The Java component API docs are provided only in HTML format. The build guide is also provided in HTML format, and as a PDF file for ease of printing.

On the Visual Studio Edition CD, all HTML-formatted documents are also provided as Microsoft HTML Help documents, which are integrated into the MSDN Library.

The locations of the online documentation are listed in Section 1.3.3, "Location of Online Documentation."

1.3.1 Assumptions

Money.h++ documentation assumes that:

You are familiar with C++ programming and object-oriented technology. If you are not, please consult the bibliography in the Tools.h++ User's Guide.
You have set up your environment for your compiler. If you need assistance with this step, please consult your compiler documentation.

In addition, this manual assumes that you have installed and built Money.h++ and the required software listed in Section Section 1.2, "Software Requirements." If you need help performing this step, refer to the installation and build documentation.

1.3.2 Conventions

Money.h++ documentation uses the following conventions:

Table 1 -- Typographic conventions

Convention	Purpose	Example
`Courier`	Function names, code, directories, file names, examples, and operating system commands.	`RWDecimal<T>::isNumber()`
italic	Conventional uses, such as new terms.	A multiplicative conversion factor is...
bold	Conventional uses such as emphasis Commands from an interface. Rogue Wave product names	Always read the manual. Click on the OK button Money.h++
*bold italic*	Class names.	*RWMoney, BigDecimalValue*

Table 2 -- Pathname conventions

Convention	Purpose	Examples
<rw_root>	The name you gave your Rogue Wave root directory.	`/usr/local/rwav` `c:\Rogue`
`<os>`	Your platform. Replace `<os>` with either `u` for Unix or `w` for Windows.	For `parts\mny200<os>`, a Windows user would type `parts\mny200w`.
/	A delimiter in a path name. If you use Windows, replace / with `\`.	For `parts/htmldocs`, a Windows user enters `parts\htmldocs`.

1.3.3 Location of Online Documentation

Links to all installed Rogue Wave documentation are available in the following HTML file:

<rw_root>\htmldocs\index.html

Online documentation for Money.h++ is available at these locations:

Table 3 -- Documentation locations

Resource	Location	Format
Build information: PDF format Money-specific general guide	`<rw_root>/htmldocs/pdf/mny200bd.pdf`	PDF
	`<rw_root>/htmldocs/mny<ver>bd/index.html`	HTML
	<rw_root>/htmldocs/genbd/index.html	HTML
Money.h++ User's Guide	<rw_root>/htmldocs/mnyug/index.html	HTML
Money.h++ C++ Class Reference	<rw_root>/htmldocs/mnyref/index.html	HTML
Money Java Library API documentation	<rw_root>/htmldocs/mnyapi/packages.html	HTML
Java API documentation provided by Sun	http://java.sun.com/products/jdk/1.1/docs/api/packages.html	HTML
readme	`<rw_root>/parts/mny200<os>/docs/mnyread.doc`	text

1.3.4 Organization of this Manual

The Money.h++ User's Guide and Class Reference documentation is organized as follows:

This first chapter introduces you to Money.h++, lists software requirements, and highlights the various ways to learn about Money.h++.
Chapter 2 provides an overview of key features in Money.h++, including a list of classes and brief descriptions of the examples.
Chapter 3 describes the Money.h++ currency classes.
Chapter 4 describes how Money.h++ handles mapping between currencies and money and how to perform monetary calculations
Chapter 5 describes the Money.h++ currency conversion classes.
Chapter 6 describes the Money.h++ decimal classes.
Chapter 7 describes techniques for formatting numbers using Money.h++.
Chapter 8 describes error-handling features provided in Money.h++.
Chapter 9 contains information on base two representation of numbers, the grammar used for input formats, and multithread safety.
The Class Reference describes the functionality of the public Money.h++ classes.
Appendix A provides information about compatibility with previous versions of Money.h++
Appendix B lists the currencies available in file currency_book.in, which Money.h++ provides to initialize an RWCurrencyBook.