Product Documentation

Stingray Studio : Getting Started Guide : Chapter 1 Introduction to Stingray Studio : Product Documentation

Stingray Studio provides full documentation in HTML format, including a user guide for each individual product and a combined reference guide.

NOTE >>	Previously, Stingray Studio shipped with PDF documentation, but now all documentation is provided as HTML files only.

The documentation for Objective Grid for Microsoft .NET is provided separately, as this is not formally part of the Stingray Studio product, but is available by request.

The organization of the Docs directory is:

<stingray-installdir>

Docs\

index.html -- access to all HTML documentation

User Guides\

Stingray Studio

Reference Guides\

Chart

Edit

Foundation

Grid

Grid Designer

Toolkit

Views

Types of Documents

All documentation is accessed via the main index.html file in the Docs directory. You can also access the user guides through a shortcut in the Start menu and both the user guides and the combined reference guide from the Stingray Assistant.

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. They are separate parts of the user guides, not independent documents.

Class Reference Guide

This combined reference guide provides a detailed description of the properties, methods, and events in each component for each product, including a description for each public class and its methods. See “Navigating the Reference Guide” for details.

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 Studio <ver> Release Notes in the installer download and on the Perforce web site at help.perforce.com/stingray/.

Navigating the Reference Guide

While you can access the Class Reference Guide from links on the main index.html page, you can also open it directly in your browser using the hh_start.htm file in its subdirectory at <stingray-installdir>\Docs\Reference Guides. This subdirectory contains each product's class reference. In addition, you can also open the Reference Guide from the Stingray Assistant by selecting the button Reference.

Here, you can easily navigate through the reference guides, copy a page’s URL for later use, sync the entire TOC, and more.

Knowledge Base

The 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 Perforce Web site, and no login or registration is required. Go to https://rwkbp.makekb.com/1.

Type Conventions

The documentation for Stingray Studio uses typographic conventions and pathname conventions similar to other Perforce documentation. These conventions are summarized in the following table:

Table 1 – Type Conventions
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.