Name.mac

Name, , , , , ,

- short description (erase red text when release)

Revision: (This refers to macro revision not help. Use numbers not letters.)

RevDate: (This refers to macro revision not help revision)

Help RevDate: March 2, 2001 (This refers to help revision not macro revision)

Maintainer: James Judd

Table of Contents (TOC):

Purpose Argument Description Examples

Variables: Internal Global Global Persist Assumed

Other Code Called Warnings To Be Done Commentary

Purpose:

(function of module with only general option categories listed) Return to TOC

Argument Description:

name, , , , ,

(Single quotes around descriptive name signifies character input required.) Return to TOC

Examples:

(examples of use, recommended uses, or pointers to example macro files) Return to TOC

Variables-Internal:

(list of variables internally created which will be reset at end of this macro.) Return to TOC

Variables-Global:

(list of variables internally created which will NOT be reset at end of this macro.) Return to TOC

Variables-Global Persist:

(Global Variables which will be always be available, e.g. not stored away in model files.) Return to TOC

Variables-Assumed:

(list of variables which must or should be defined prior to invoking this macro) Return to TOC

Other Code Called:

(macros or other code internally used that must be available) Return to TOC

Warnings:

(special warning notes, potential errors, settings when complete.) Return to TOC

To Be Done (TBD):

(Items planned for functional expansion or correction. Official list is in comments database.) Return to TOC

Commentary:

(Discussion of issues, points of interest, etc.) Return to TOC