Typographic Conventions

HydraExpress : HydraExpress User Guide : PART III Appendices : Appendix A, Documentation and Conventions : Documentation : Typographic Conventions

Typographic Conventions

The documentation for HydraExpress uses typographic conventions and pathname conventions similar to other Rogue Wave documentation. These conventions are summarized in the following tables:

Table 13 – Typographic conventions
Conventions	Purpose	Example
Courier	Function names, code, paths, directory and file names, URLs, operating system commands.	Config(const Config& config);www.roguewave.com rwsfserver start
italic	variables in code Conventional uses, such as new terms and titles.	<installdir>\docs The deployment descriptor provides… Reference Guide
bold italic	Class names and emphasis.	rwsf::Exception
bold	Conventional uses, such as emphasis. Commands from an interface.	You should always read the manual. Click the OK button
... (or vertical ellipses)	Indicates part of the code is missing from an example.	foo(){ ... // Something happens }

Table 14 – Pathname conventions
Convention	Purpose	Example
<installdir>	The directory where HydraExpress was installed.	<installdir>\docs\index.html
\	The Windows delimiter in a path name. If you use UNIX, replace \ with /.	For <installdir>\docs, a UNIX user enters <installdir>/docs.