WaveWarp Users' Guide: last updated 28 February 2002

2.17-- Using the "Help"

All the "help" functionality in WaveWarp is based on the HyperText Markup Language (HTML). To view the help files and to take advantage of the full text-based search across the entire documentation set, you require a Java-enabled HTML Browser to be installed on your computer.

Although the help files are viewed via an HTML Browser, all the files are stored locally on your hard-disk, so the Browser does not need to be connected to the internet when using the WaveWarp help.

The WaveWarp help files can be accessed in a number of ways. For specific help on a component on the DrawingBoard, click on the component to select it (or click on its Parameter Window), then press the "F1" key. This will automatically activate your default HTML Browser and display the corresponding help page which contains a functional description of the component, an explanation of its adjustable parameters (sliders, buttons, etc), a description of the underlying algorithm, and a summary of all the available signal implementations for the component. (The help page can also be opened by right-clicking on the component, and selecting the "Help..." menu option.)

Hint: the same help page can also be opened before the component has been placed on the DrawingBoard. To do so, right-click on the component listing in the Component Library. This will activate a "help" pop-up button, which, when pressed, will open the help corresponding help page. This enables you to read about a component before using it!

In addition to providing help on all the components, there are help files for all the Example DrawingBoards (based on the contents of their Description Windows). Additionally, the Users' Guide (this document) can also be accessed from within WaveWarp.

For convenience, all these various help pages can be accessed using the respective "Help" toolbar buttons, as shown in Figure 10 (or, equivalently, via the main "Help" menu on the toolbar).

Figure 10 Annotated screenshot of the help buttons for accessing WaveWarp's (HTML-based) help files.

Important note: all the "help" functionality of WaveWarp is disabled in the demo version. You must purchase a registered version to be able to access it.