6.0 LAS User's Guides
6.1 Introduction
This section provides a general overview of the format of the user guide used in LAS. An alphabetical
listing of the currently released LAS modules is in Appendices D.
All LAS user guides are stored on-line and are accessible by typing help <modulename> at the LAS70 prompt. The only
information that will not be present is any graphics that an individual user guide might have. The other method to display the user guides is to type lasdoc at the UNIX prompt (%)
This method uses NCSA's Mosaic 2.0 Document Viewer. Graphics are included
within the user guides in this method.
6.2 User's Guide Format
Individual LAS User's Guides provide the following information:
- Module name and function. A general description of the module's function including references to all subcommands.
- Parameters: Parameters are listed in bold font, with default values in "()" next to the
parameter names. The parameters are listed in sequence as they would appear on the
tutor display screen. Where subcommands are used, they are indicated by the word
"Subcommand" followed by a dash (-) and the subcommand name. A description of the
subcommand is also given. Listed below the subcommand is the sequence of parameters
for that subcommand.
- Examples: At least one example and usually two or three are given for each module. An
example should be available for each subcommand, if the module has subcommands. The
example illustrates and explains the use of as many of the parameters as the user would
typically use.
- Description/Algorithm: A functional description of the algorithm used in the module is
given. This includes any formulas and constants used. Also, references should be
supplied.
- Error Messages: A list of the all fatal and nonfatal error messages output by the application
module and a brief description of subsequent user action is given. All error messages in
the user guides pertain just to the modules and not to TAE, the support libraries, or the
computer's operating system.
- User's Notes: These indicate or explain any conditions that the user should be aware of
when using the module. It may also provide a list of related modules.