Conventions

Evaluating SourcePro C++
Rogue Wave web site: Home Page | Main Documentation Page

1.5 Conventions

Rogue Wave documentation uses the following conventions.

1.5.1 Pathname Conventions

The Rogue Wave SourcePro C++ products use special pathname conventions. These are summarized in Table 3:

Table 3: Pathname conventions

Convention	Purpose	Example
`<buildspace>`	The name you gave the directory where your Rogue Wave components are installed.	`<buildspace>\docs\index.html`
`<mnemonic>`	A placeholder for a module mnemonic in documentation paths and directory structure. The mnemonics are:	`<buildspace>\docs\html\<mnemonic>ug`
`<mnemonic>`	Essential Tools Module: `tools` Threads Module: `threads` Advanced Tools Module: `advtools` Internationalization Module `i18n` XML Streams Module: `xmlstreams` DB Interface Module: `dbcore` DB Access Module for ODBC: `odbc` DB Access Module for Microsoft SQL Server: `mssql` DB Access Module for MySQL: `mysql` DB Access Module for Oracle OCI: `oracleoci` or `oraoci` DB Access Module for PostgreSQL: `pgs` (for docs: `postgresql`) Essential Networking Module: `networking` Internet Protocols Module: `protocols` Secure Communication Module: `security` Essential Math Module: `math` Linear Algebra Module: `lapack` Business Analysis Module: `analytics` Currency Module: `currency` Note: The identifying strings used in the `source`, `example`, and `rw` (header file) directory structures do not necessarily match the mnemonics given above. For example, the Threads Module code and examples are installed per package, not per module, under directory names such as `sync` and `functor`.

1.5.2 Typographic Conventions

Documentation for the SourcePro C++ products uses special typographic conventions. These conventions are summarized in Table 4:

Table 4: Typographic conventions

Conventions	Purpose	Example
`courier`	Function names, code, directories, file names, examples, operating system commands, URLs.	`RWWinSockInfo info`; `cout << "Error Processing:"` Visit us at `www.roguewave.com`
italic	Conventional uses, such as new terms and titles.	Functors, or function objects Essential Tools Module Reference Guide
*bold italic*	Class names, emphasis, and some subheads.	*RWCollectable*
bold	Conventional uses, such as emphasis. Commands from an interface.	You should always read the manual. Click the OK button
ellipsis	Indicates part of the code is missing from an example.	`foo(){` `... //something happens` `}`
pathnames `/` or `\`	When the context for a pathname could be either Windows or UNIX, the path is written with a Windows "`\`" separator.	Windows path: `buildspace\sproenv_vars.bat` UNIX path: `buildspace/sproenv_vars.sh` OS-neutral path: `<buildspace>\docs\index.html`

The Rogue Wave name and logo, and SourcePro, are registered trademarks of Rogue Wave Software. All other trademarks are the property of their respective owners.
Provide feedback to Rogue Wave about its documentation.