Introduction

1.4 Documentation Guide

The WindView documentation consists of the WindView Release Notes, the WindView User's Guide (this document), and the WindView online help. Each component of the documentation is designed to serve a specific purpose, and will serve you best if you take that purpose into account.

About This Document

This user's guide is an introduction to using the WindView tool. It provides information on installing WindView, using the default configuration, and customizing the tool to solve specific types of problems. The appendices are sources of detailed information and context. They discuss the WindView architecture and application programming interfaces (APIs). The appendices also contain detailed reference material on the VxWorks routines that are specific to WindView, but you may find it is easier to locate this information in the online help.

The chapters provide the following types of information about WindView:

2. Getting Started takes you through the steps required to get WindView running with Tornado and your target, gives you an overview of collecting data, and introduces you to the view graph display.

3. Configuring Data Collection, 4. Configuring Data Upload, and 5. Data Display provide information on configuring and using WindView for your specific needs.

7. Data Collection and 8. Data Upload provide background and explanatory information about the collection and upload functions.

6. Triggering provides both configuration and background information for the new triggering facility.

Figure 1-2: Relationship and Level of Detail of Chapters

The appendices provide the following types of information about WindView:

A. WindView Architecture provides an overview of the underlying WindView architecture.

B. Event Dictionary, C. Library and Subroutine Reference, and H. Glossary provide reference information on WindView event information, commands, libraries, and terminology.

D. Event-Base API, E. Triggering API, and F. Customizing WindView and User Applications provide details of the various user-configurable APIs and functions.

G. Creating a VxWorks Timestamp Driver provides information on how to write a timestamp driver for your BSP if one is not already available.

Release Notes

The Release Notes contain release-specific information, including information detailing the changes between previous versions of WindView and this release.

Online Help

The online help includes context sensitive help for the GUI. It also includes a detailed table of contents and index with an extensive list of "How Do I...?" questions. One of these methods can take you directly to the information you need to complete a specific task. In many cases, the short answers in the online help contain links to the online version of the WindView User's Guide to provide in-depth information not contained in the help references. Access to the complete text of the User's Guide is also provided through the Contents tab.

Help Menu

When WindView is installed, the entry WindView Help appears in the main Help menu. When you point to this entry, the following commands appear in a submenu: Help Topics, Search for Help on, and Legend. The first two commands are typical Windows help commands which take you to the WindView help window.

Legend

This command displays a window that summarizes the meaning of every WindView event icon and stipple, and also provides links to the full description of each event in the online event dictionary. See The Legend Window for more discussion of this window.

Online Help Contents

How to Use Online Documentation

User Interface Commands

Frequently Asked Questions

Event Dictionary

WindView Glossary

Legend

Other Resources

For information related to WindView, you may wish to refer to the following:

Tornado User's Guide, for information on Tornado in general and on the tools included in the standard Tornado release.

VxWorks Programmer's Guide, VxWorks Reference Manual, and Tornado Online Manuals for information on VxWorks.

Tcl and the Tk Toolkit, by John K. Ousterhout, published by Addison-Wesley Publishing Company, for information on Tcl, the Tool command language.