Online documentation help

How to use this documentation

Rogue Wave online documentation is made up of three frames:

The left frame of the Home page displays the list of documentation items supplied with the product, including access to the samples. To view a document, click its name in the left frame of the Home page. Once the selected document is displayed, click the topic in which you are interested from its table of contents that appears in the left frame. If you click Samples, the left frame displays the list of samples.
The central frame displays the content of the current document. You can navigate within the current document using the Next and Previous buttons or the table of contents that is visible in the left frame.
The top frame lets you return to the Home page and to the list of items available in the documentation set.

Note

If JavaScript™ is not enabled in your browser, the table of contents does not synchronize automatically when you click a link to another item in the documentation set from the current document. In this case, click the name of the document in the bread crumbs in the top-left corner of the current document. Doing this will update the table of contents of the document and reload its first page.

Browser compatibility

Rogue Wave online documentation is designed to function properly on most common Web browser like Firefox®, Internet Explorer®, Google Chrome® and Safari® running on Microsoft® Windows®, Linux® and Mac OS X®.

Search applet

The search applet is based on the Lucene Project from Apache™ .

Note

In most browser, the search applet need to have:

Java applet fully functionnal and enable
Popup windows enable

The search applet is configured by default to search for partial words. It searches for partial words by adding an asterisk "*" to the search string. This is the reason why the string in the search applet text field changes when you press the "Enter" key or click the "Search" button. You can disable this behavior by selecting "Whole Word". In this case, the string is not modified before the search is run. Lucene accepts "*" and "?" as wildcards, but they must not be at the start of the string. For more information about what Lucene accepts, refer to the Lucene documentation. There is also a FAQ on the Lucene site that explains the syntax of queries.