Contents
This page describes the features of the StreamBase Help and documentation system.
StreamBase Help and documentation is provided in two formats:
-
Eclipse Help, also known as Infocenter format
-
A website of HTML pages with a navigation bar
The two formats are distributed across five locations, local and online:
-
The Eclipse Help format is in three locations:
-
Online at http://docs.streambase.com.
-
Locally, on systems with StreamBase installed, as the StreamBase Studio Help system. Invoke → .
-
Locally, on systems with StreamBase installed, as the standalone Help Viewer or sbhelp utility:
-
For Windows, in the Start menu as → → .
-
For UNIX, invoked at the command line with
sbhelp &.
-
-
-
The website format is in two locations:
-
Online at http://streambase.com/developers/docs/sb73.
-
Locally, in the Start menu of Windows systems with StreamBase installed, as → → .
-
For each StreamBase release, the content of the Help system is identical in either format and all locations.
Tips:
-
The Help button in StreamBase Studio shows as a question mark in a circle:
-
In the Eclipse Help Search field, use quotes around an exact phrase to narrow your search results.
-
To search only within the current page, first sync the page to the Contents panel using the Show in Table of Contents button (
), then use the Search Topics button (
, in
the Contents pane's toolbar).
The features illustrated in the following figure are available in any version of StreamBase Help that displays a Contents panel on the left.
|
The following figure illustrates the search features of the Eclipse Help versions of StreamBase Help.
|
The Properties view in StreamBase Studio is keyed to the Help system. Click the circled-? Help button in the upper right of the view to open the Studio Help page appropriate for the current context.
In the Assistance Pane on the right, in the Functions tab, Details sub-tab, click the Show in Help link to open the Expressions page help for the current function.
|
See Properties View for further information on the developer assistance features of the Properties view, especially the Assistance Pane section of that page.
When using StreamBase Studio, the Help system includes basic Eclipse documentation in addition to StreamBase documentation. When searching for terms in Studio help, first set up a search scope to limit the search to StreamBase help pages.
-
Click the Search scope link.
-
In the Select Search Scope dialog, click .
-
In the Edit Search List dialog, select StreamBase Documentation, and provide a name for your scope.
-
Click twice.
You can set up as many search scopes as you need, restricting some scopes to individual books in the documentation set.
The same documentation that you install with StreamBase Studio is available at the StreamBase web site, at docs.streambase.com. As the following figure shows, the web version of the documentation is organized the same way as the installed version and has the most of the same features. In addition, documentation for all current releases is available on the Web. Choose the version you want by clicking the Studio release number in the upper right corner. The default version is the most recent one.
|