Rogue Wave provides a comprehensive set of documents in a variety of formats in the Docs subdirectory of your installation directory. You can access it by selecting Documentation from the Stingray Studio submenu in your Windows Start |Programs menu.
The organization of the Docs directory is:
<stingray-installdir>
Docs
+-Copyright and 3rdParty Licenses
+-Help Integration -- MSHelp 2.0 and 3.0 files used in MSDN integration
+-Other Guides -- PDF-format guides on specific topics
*.chm/chi and *.pdf files -- Standalone documentation for each product
|
For immediate access to product documentation, open the appropriate CHM or PDF file in the top-level directory. Generally, you should not need to look in the Help Integration directory. This documentation should be integrated into MSDN during installation. If not, see Section 1.4.3.
To read a .pdf file, you must open it with Adobe Acrobat Reader, which you can download free of charge from the Adobe System Web site: http://www.adobe.com . All documents are located in the Docs subdirectory of your installation.
These are the types of documents provided with Stingray Studio:
Getting Started Guide
Provides an overview of Stingray Studio including instructions for installing, building libraries, migrating applications, and porting to Microsoft® .NET®.
User Guides
These documents are how-to manuals and provide an introduction to each component of Stingray Studio. There are several tutorials included to help you learn how to create applications quickly.
Programmer Guides
These documents are more advanced and include a discussion of the design and architecture of each component. There are several advanced tutorials to help you gain more proficiency with the product.
Class Reference Guides
These documents provide a detailed description of the properties, methods, and events in each component. There is an HTML document for each public class and its methods. These reference guides may be used as standalone (.chm only) or viewed through Microsoft's Help Collection in the compiler IDE or MSDN.
Readme Files
These documents offer the latest information about each component and are located in your Stingray Studio installation directory. The readme files are located at <stingray-installdir>\Readme\MFCReadme.htm. From this document you can access the readme files (listed as change logs) for all the Stingray Studio packages.
Release Notes
Release notes list the known issues at the time of release for Stingray Studio products. Release notes are provided as a PDF document Stingray <ver> Release Notes in the installer download and on the Rogue Wave web site at www.roguewave.com/support/product-documentation/stingray.aspx.
Here is the list of user, programming, and reference guides supplied with Stingray Studio:
Stingray Studio Getting Started Guide
Stingray Foundation Library (SFL) User's Guide
Stingray Foundation Library (SFL) Reference Guide
Objective Chart User's and Programmer's Guide
Objective Chart Reference Guide
Objective Edit User's Guide
Objective Edit Reference Guide
Objective Grid User's and Programmer's Guide
Objective Grid Reference Guide
Objective Toolkit User's Guide
Objective Toolkit Reference Guide
Objective Grid .NET User's Guide
Objective Grid .NET Reference Guide
Objective Views User's Guide
Objective Views Reference Guide
The Stingray Studio installer does its best to integrate the Getting Started User's Guide and each Stingray product's User's Guide and Reference Guide into either the user-specified MSDN Collection or the compiler-specific MS.VSCC+ Help Collection, but not both.
During the installation, you have the option to select between an MSDN or an MSHelp collection for each .NET compiler in which to integrate Stingray Studio online documentation. Below are some helpful MSHelp Integration tips.
If MSHelp integration fails after a successful installation of your Stingray products, or if you choose to switch from the MS.VSCC+ namespace to the MSDN namespace or vice verse, you can manually integrate the Stingray products Help Collection (StingrayStudio.HxC) by running the h2reg.exe utility from the command line. This utility and the h2regVC71MSHelp.ini, h2regVC71MSDN.ini, h2regVC8MSHelp.ini, h2regVC8MSDN.ini, h2regVC9MSHelp.ini, and h2regVC9MSDN.ini files are located in the <stingray-installdir>\Docs\Help Integration directory. You must first copy one of the above h2reg*.ini files and rename it to h2reg.ini before using the file with the h2reg.exe utility. Please refer to the comments in the renamed h2reg.ini file under the [Reg_Plugin] and [UnReg_Plugin] sections for simple instructions on how to integrate the Stingray products Help Collection into your MSDN Help Collection*. For more information on how to download and use the h2reg.exe .NET Help utility, please refer to the H2Reg Home Page at http://helpware.net/mshelp2/h2reg.htm.
* Be aware that all Help Collections with the MSDN namespace are also plugged into their respective MS.VSCC+ namespace(s).
It is recommended that you first unregister the Stingray Studio Help Collection from the MS.VSCC+ namespace(s), and then re-register the Stingray Studio Help Collection into your MSDN Help Collection.
We recommend using one of the following command line options when using the h2reg utility:
-–r Register Mode uses the command sections in the h2reg.ini file related to registering items. When using this option, we also recomment using the -m option, which performs a pre-merge of Index and Table of Contents (TOC) files.
-–u Unregister Mode uses the command sections in the h2reg.ini file related to unregistering items.
We have also noticed that some .NET compiler Help Content filters default to "Visual C++". To view the StingrayStudio.HxC MSHelp Collection in your IDE's Help Content, you will need to change your IDE's Help Content filter to "None".
To access the integrated Stingray Studio documentation, use the standard Microsoft Visual Studio Help Index.
The Rogue Wave Knowledge Base contains a large body of useful information created by the Support Services team. It has been created to provide our customers with easy access to technical information. Knowledge Base entries range from common programming problems to complete sample programs and are constantly being updated and expanded. This information is available to any user of the Rogue Wave Web site, and no login or registration is required.
kb.roguewave.com/kb/.
The documentation for Stingray Studio uses typographic conventions and pathname conventions similar to other Rogue Wave documentation. These conventions are summarized in the following table:
| Item | Example | Definition |
| Functions, Variables and Parameters | Myfunc() | Library functions are in courier font. |
| Class Name | CODModel | Class names are bold and italic. |
| Code | #include <io.h> | Code is in courier font. |
| Key names, key combinations and key sequences | CTRL+ALT+DEL | All Caps |
| Menus and menu commands | Select Edit from the File menu. | Menus and menu commands are bold. |
Copyright © Rogue Wave Software, Inc. All Rights Reserved.
The Rogue Wave name and logo, and Stingray, 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.