IDLWAVE User Manual

IDLWAVE is a package which supports editing source code written in the Interactive Data Language (IDL), and running IDL as an inferior shell.


1. Introduction		What IDLWAVE is, and what it is not
2. IDLWAVE in a Nutshell		One page quick-start guide
3. Getting Started (Tutorial)		Tutorial
4. The IDLWAVE Major Mode		The mode for editing IDL programs
5. The IDLWAVE Shell		The mode for running IDL as an inferior program
6. Installation		How to Install or Upgrade
7. Acknowledgements		Who did what
A. Sources of Routine Info		How does IDLWAVE know about routine XYZ
B. HTML Help Browser Tips
C. Configuration Examples		The user is king
D. Windows and MacOS		What still works, and how
E. Troubleshooting		When good computers turn bad
Index		Fast access
-- The Detailed Node Listing ---

Getting Started (Tutorial)

3.1 Lesson I: Development Cycle
3.2 Lesson II: Customization
3.3 Lesson III: User and Library Catalogs

The IDLWAVE Major Mode

4.1 Code Formatting		Making code look nice
4.2 Routine Info		Calling Sequence and Keyword List
4.3 Online Help		One key press from source to help
4.4 Completion		Completing routine names and Keywords
4.5 Routine Source		Finding routines, the easy way
4.6 Resolving Routines		Force the Shell to compile a routine
4.7 Code Templates		Frequent code constructs
4.8 Abbreviations		Abbreviations for common commands
4.9 Actions		Changing case, Padding, End checking
4.10 Documentation Header		Inserting a standard header
4.11 Motion Commands		Moving through the structure of a program
4.12 Miscellaneous Options		Things that fit nowhere else

Code Formatting

4.1.1 Code Indentation		Reflecting the logical structure
4.1.2 Continued Statement Indentation
4.1.3 Comment Indentation		Special indentation for comment lines
4.1.4 Continuation Lines and Filling		Splitting statements over lines
4.1.5 Syntax Highlighting		Font-lock support
4.1.6 Octals and Highlighting		Why "123 causes problems

Online Help

4.3.1 Help with HTML Documentation
4.3.2 Help with Source

Completion

4.4.1 Case of Completed Words		CaseOFcomPletedWords
4.4.2 Object Method Completion and Class Ambiguity		obj->Method, what?
4.4.3 Object Method Completion in the Shell
4.4.4 Class and Keyword Inheritance		obj->Method, _EXTRA=e
4.4.5 Structure Tag Completion		Completing state.Tag

Actions

4.9.1 Block Boundary Check		Is the END statement correct?
4.9.2 Padding Operators		Enforcing space around `=' etc
4.9.3 Case Changes		Enforcing upper case keywords

The IDLWAVE Shell

5.1 Starting the Shell		How to launch IDL as a subprocess
5.2 Using the Shell		Interactively working with the Shell
5.3 Commands Sent to the Shell
5.4 Debugging IDL Programs
5.5 Examining Variables
5.6 Custom Expression Examination

Debugging IDL Programs

5.4.1 A Tale of Two Modes
5.4.2 Debug Key Bindings
5.4.3 Breakpoints and Stepping
5.4.4 Compiling Programs
5.4.5 Walking the Calling Stack
5.4.6 Electric Debug Mode

Installation

6.1 Installing IDLWAVE		How to install the distribution
6.2 Installing Online Help		Where to get the additional files needed

Sources of Routine Info

A.1 Routine Definitions		Where IDL Routines are defined.
A.2 Routine Information Sources		So how does IDLWAVE know about...
A.3 Catalogs
A.4 Load-Path Shadows		Routines defined in several places
A.5 Documentation Scan		Scanning the IDL Manuals

Catalogs

A.3.1 Library Catalogs
A.3.2 User Catalog

This document was generated by XEmacs shared group account on December, 19 2009 using texi2html 1.65.