[Kst] Rough Outline for Kst Documentation
Rick Chern
rchern at interchange.ubc.ca
Tue May 25 19:51:42 CEST 2004
Revision - Usage sections should be separate chapters.
User Manual
===========
1. Introduction to Kst
- What is Kst?
- Uses of Kst
- Starting Kst
- Command-line options
2. Working with Data
- Supported File Formats
- Creating ASCII Data Files
- The Data Wizard
- The Data Manager
- Creating New Data Types
- Editing and Deleting Existing Data Types
- Data Types
- Vectors
- Curves
- Equations
- Histograms
- Power Spectra
- Plugins
3. Working with Plots and Windows
- Manipulating Plot Layout
- Zooming and Scrolling
- XY Mouse Zoom
- X Mouse Zoom
- Y Mouse Zoom
- Tied Zoom
- Scrolling
- Viewing Live Data
- Fitting Curves
- Label Editor
- Creating Labels
- Working with Windows
- MDI Modes
- Creating and Deleting Windows
- Adding and Removing Plots from Windows
4. Saving and Exporting
- Saving Plot Definitions
- Exporting Vectors
- Exporting Graphics
- Automatic Export
5. Event Monitoring
- ELog
6. Menu Bar and Miscellaneous Features
-Menu Bar
- File Menu
- Edit Menu
- Data Menu
- Range Menu
- Plots Menu
- Settings Menu
- Help Menu
- Tool Bar
(duplicates features in Menu Bar - just have a table
here mapping buttons to menu functions)
- Key Mapping and Shortcuts
7. Plugins and Filters
- Adding and Removing Plugins
- Built-in Plugins
(for each plugin, describe what it does, what formulas/algorithms it
uses,
and list inputs/outputs (units if appropriate)
- Autocorrelation
- Chop
- Crosscorrelation
- ... and so on for all 25+ plugins
- Creating New Plugins
8. Extensions
9. Questions and Answers
- Question 1
- Question 2
...
A. Supporting Additional File Formats
B. Installation
- Obtaining Kst
- Installing Kst from Source
- Requirements
- Optional Libraries and Packages
- Compiling and Installing
More information about the Kst
mailing list