[Kst] Rough Outline for Kst Documentation

Rick Chern rchern at interchange.ubc.ca
Tue May 25 19:38:09 CEST 2004


The following is a rough outline of Kst documentation to be written - 
comments, additions, etc. are welcome.
Many of these sections have been committed to CVS under 
kdeextragear-2/doc/kst.

Thanks.

Rough outline for Kst Documentation
===================================

User manual will be written as docbooks, so they will be viewable by 
KHelpCenter.

User Manual
===========

1. Introduction to Kst
   - What is Kst?
   - Uses of Kst

2. Using Kst
   - Starting Kst
       - Command-line options
   - Working with Data
       - Supported File Formats
       - 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
   - 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
       - Windows
           - MDI Modes
           - Adding and Removing Plots from Windows
   - Menu Bar
       - File Menu
       - Edit Menu
       - Data Menu
       - Range Menu
       - Plots Menu
       - Settings Menu
       - Help Menu
   - Tool Bar

3. Plugins and Filters
   - Built-in Plugins
       - Autocorrelation
       - Chop
       - Crosscorrelation
       - ... and so on for all 25+ plugins
   - Creating New Plugins

4. Event Monitoring (subsections undecided)

5. Menu Bar and Miscellaneous Features
    - Menu Bar
          - File Menu
          - Edit Menu
          - Data Menu
          - Range Menu
          - Plots Menu
          - Settings Menu
          - Help Menu
      - Tool Bar (have a table here mapping buttons to menu functions)
      - Key Mappings / Shortcuts

6. Questions and Answers
   - Question 1
   - Question 2
   ...

A. Installation
   - Obtaining Kst
   - Installing Kst from Source
       - Requirements
       - Compiling and Installing
   - Contributing to Kst

B. Supporting Additional File Formats

C. Extensions




More information about the Kst mailing list