Contents
This page describes the features of the StreamBase Help and Documentation system.
StreamBase Help and Documentation is provided in two formats:
-
Eclipse Help
-
A website of HTML pages with a navigation bar
The two formats are distributed across four locations, local and online. For any one StreamBase release, the content of the Help system is identical in either format and all locations.
-
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.
-
Locally, on systems with StreamBase installed, as the standalone Help Viewer or sbhelp utility. For Windows, this is → → in the Start menu. For UNIX, this is invoked with
sbhelp &.
-
-
The website format is in one location:
-
Locally, on Windows systems with StreamBase installed, as → → in the Start menu.
-
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 features illustrated in the following figure are available in the Website version of the StreamBase Help system.
|