home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 11 Util / 11-Util.zip / forwrn10.zip / readme.txt < prev   
Text File  |  1993-06-11  |  7KB  |  159 lines
  1.                             ForeWarn version 1.0
  2.                              beta test version
  3.  
  4. Beta Version limitation:
  5.     MMPM is not supported in this release.  Selection of
  6.     sounds for a record will be stored but no sound will be
  7.     played.  The final release is anticipated to have this
  8.     feature completed.
  9.  
  10.     Like a publication for a conference, I have worked with
  11.     the text and code of this program for many late nights
  12.     and I know that I have overlooked numerous cosmetic
  13.     flaws in the program.  Spelling of various embedded messages
  14.     will probably be found to be in error.  After you stare
  15.     at a user interface for just so long, the errors cease to
  16.     exist.  Please report all cosmetic flaws to the author.
  17.  
  18. Installation:
  19.     To install the OS/2 version of ForeWarn you must have os/2
  20.     version 2.1 (beta or GA release) installed on the target
  21.     system.  The following system variables must be set:
  22.  
  23.     FOREWARN_INI
  24.     FOREWARN_DAT
  25.  
  26.     These two variables can be set in the system config.sys
  27.     so that they will be available to all OS/2 sessions by
  28.     adding the following lines:
  29.  
  30.     set FOREWARN_INI=d:\driectory\forewarn.ini
  31.     set FOREWARN_DAT=d:\directory\forewarn.dat
  32.  
  33.     and replace the "d:" with the drive to store the respective
  34.     files and "directory" with the target directory.  The file
  35.     referenced by the variable FOREWARN_INI is the file to store
  36.     initialization information between sessions.  The file
  37.     FOREWARN_DAT is used to store the data used by the program.
  38.     The names of the files can be anything legal to the file
  39.     system used on the particular disk.  If the file system is
  40.     of type FAT, the file name specification must be limited to
  41.     the 8.3 FAT format.  If the file is HPFS the filename can be
  42.     anything legal to OS/2 HPFS format.
  43.  
  44.     If the destination for the data file is on a FAT
  45.     formatted partition the file cannot have an extension if
  46.     the option for creating backup files is selected.
  47.     ForeWarn will not lose data, it will simply warn the
  48.     user of the problem and stop.  In this case, select the
  49.     Options dialog and turn off backups.
  50.  
  51. Starting ForeWarn:
  52.     Like its DOS counterpart, ForeWarn uses command line
  53.     options to tell it whether it should simply check the
  54.     dates or if it should enter the edit mode.  Unlike the
  55.     DOS version (which had a multitude of options) the OS/2
  56.     version has only two parameters:
  57.  
  58.     -e:     enter edit mode
  59.     -c:     check dates only (default)
  60.  
  61.     Forewarn does not run as a background task and only
  62.     checks the data at the time that the program starts.  It
  63.     is not meant to replace a pop-up calendar.  This may
  64.     change in future versions when the author learns how to
  65.     use threads.  It is easiest to simply add the following
  66.     line to the startup.cmd file:
  67.  
  68.     start d:\directory\forewarn.exe
  69.  
  70.     The ForeWarn.HLP file must be located in the help path
  71.     or an error will be displayed when the program starts.
  72.  
  73. Upgrading from the DOS version of ForeWarn
  74.     Some noticable differences will be found between
  75.     ForeWarn for OS/2 and DOS.  These are listed in the
  76.     following sections.
  77.  
  78.     Data File Format
  79.         In order to allow for selective sounds a new field
  80.         has been added to the ForeWarn data file.  This
  81.         field has been added just before the message text.
  82.         In the event that the DOS versio loads the data file
  83.         for the OS/2 version, this will simply appear as a
  84.         number before the text of each message.
  85.  
  86.         The data file can be maintained in the DOS format by
  87.         selecting the Options dialog and turning on the DOS
  88.         compatibility.  This will eliminate the additional
  89.         field but will force ForeWarn to ignore all sound
  90.         specifications in the Edit Dialog box.
  91.  
  92.     User Interface:
  93.         The DOS version of ForeWarn utilized a Text based
  94.         grouping of windows to allow for separation of
  95.         displayed data and edit fields.  This necessitated
  96.         doubling up the use of the function keys which
  97.         proved to be awkward.  To remedy this, the OS/2
  98.         version has a full edit dialog feature that leads
  99.         the user through the setting of dates.
  100.         Additionally, the edit dialog box has been set up to
  101.         be as close to the OS/2 Application Design Guide as
  102.         possible.
  103.  
  104.         To further enhance the user interface, Forewarn does
  105.         not go through normal checks to display the warnings
  106.         in dialog boxes when the edit mode is chosen.
  107.         ForeWarn now utilizes colors to indicate the status
  108.         of events.  There are three colors that are used:
  109.  
  110.         red:        Active dates which meet the criterion
  111.                     for advance notice (i.e. the current
  112.                     date plus the advance is greater than or
  113.                     equal to the target date)
  114.         blue:       Expired events.  If the option to delete
  115.                     expired events has been specified in the
  116.                     options dialog box, these lines will be
  117.                     deleted when the data is saved.  Expired
  118.                     events are events in which the deadline
  119.                     includes a specific year and that year
  120.                     or the actual date has passed.
  121.         black:      Normal data that meets neither of the
  122.                     above.
  123.  
  124. Future planned enhancements:
  125.     Sounds using MMPM or the DOSBEEP functions.
  126.     Multiple threads
  127.     User selectable colors for events
  128.     Window size and position recall
  129.  
  130.  
  131. Contacting the author:
  132.     This product has been developed in the author's spare
  133.     time and not as a result of any funding or cooperation
  134.     by the author's employer.  All tools (including the
  135.     compiler, development environment, and equipment)
  136.     necessary to develop this system were purchased by the
  137.     author.
  138.  
  139.     Comments for corrections and enhancements are welcomed
  140.     by the author and can be sent to:
  141.  
  142.         William Scott Hiles
  143.         2 Savannah St.
  144.         King George, VA 22485-9331
  145.  
  146.     or via email at:
  147.  
  148.         whiles@relay.nswc.navy.mil
  149.  
  150. Terms of agreement:
  151.     Like the DOS version of ForeWarn, the OS/2 version of
  152.     ForeWarn has been developed by WiSHware Inc. and may not
  153.     be distributed as part of another product without
  154.     written permission by the author.  This product is
  155.     distributed as FreeWare and the author does not expect
  156.     monetary compensation.  Donations are welcomed to
  157.     support the development of FreeWare products; but is not
  158.     required.
  159.