home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / busi / usafcald.zip / CALENDAR.DOC next >
Text File  |  1987-10-12  |  20KB  |  552 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.                                      CALENDAR
  23.  
  24.                                   User's  Manual
  25.  
  26.                             Version 1.5,  October 1987
  27.  
  28.  
  29.  
  30.  
  31.  
  32.                                         by
  33.  
  34.                               Major John D. Shewchuk
  35.  
  36.                              USAF Air Weather Service
  37.  
  38.                              MILITARY AIRLIFT COMMAND
  39.  
  40.  
  41.  
  42.  
  43.  
  44.                                 TABLE OF CONTENTS
  45.                                 _________________
  46.  
  47.  
  48.          1.0  GENERAL DESCRIPTION  . . . . . . . . . . . . . . .  1
  49.               1.1  Purpose . . . . . . . . . . . . . . . . . . .  1
  50.               1.2  Overview  . . . . . . . . . . . . . . . . . .  1
  51.  
  52.          2.0  SYSTEM REQUIREMENTS  . . . . . . . . . . . . . . .  2
  53.               2.1  Hardware  . . . . . . . . . . . . . . . . . .  2
  54.               2.2  Software  . . . . . . . . . . . . . . . . . .  2
  55.               2.3  Capacity  . . . . . . . . . . . . . . . . . .  2
  56.  
  57.          3.0  GETTING STARTED  . . . . . . . . . . . . . . . . .  3
  58.               3.1  Title Screen  . . . . . . . . . . . . . . . .  3
  59.               3.2  Display Screen  . . . . . . . . . . . . . . .  3
  60.               3.3  Operation . . . . . . . . . . . . . . . . . .  3
  61.  
  62.          4.0  PROGRAM FUNCTIONS  . . . . . . . . . . . . . . . .  4
  63.               4.1  (E)vents  . . . . . . . . . . . . . . . . . .  4
  64.                    4.1.1  <A>dd  . . . . . . . . . . . . . . . .  4
  65.                    4.1.2  (L)ist . . . . . . . . . . . . . . . .  5
  66.                    4.1.3  (P)rint  . . . . . . . . . . . . . . .  5
  67.                    4.1.4  (D)elete . . . . . . . . . . . . . . .  5
  68.               4.2  (J)ump  . . . . . . . . . . . . . . . . . . .  6
  69.               4.3  (A)larm . . . . . . . . . . . . . . . . . . .  6
  70.               4.4  (D)ate/Time . . . . . . . . . . . . . . . . .  6
  71.               4.5  (C)onfigure . . . . . . . . . . . . . . . . .  6
  72.               4.6  (H)elp  . . . . . . . . . . . . . . . . . . .  6
  73.               4.7  (Q)uit  . . . . . . . . . . . . . . . . . . .  6
  74.  
  75.          MODIFICATIONS TO VERSION 1.0  . . . . . . . . . . . . .  7 
  76.  
  77.          ACKNOWLEDGMENTS   . . . . . . . . . . . . . . . . . . .  8
  78.  
  79.  
  80.  
  81.  
  82.   
  83.          1.0  GENERAL DESCRIPTION.
  84.  
  85.               1.1  Purpose.  The CALENDAR program is designed to provide a 
  86.          flexible, interactive method to easily monitor a variety of 
  87.          suspense items, activities, and special dates--collectively 
  88.          referred to as EVENTS.  CALENDAR will quickly display and/or print 
  89.          daily events, and can also provide other information useful to 
  90.          office environments. 
  91.  
  92.               1.2  Overview.  CALENDAR allows entry, deletion, listing, and 
  93.          printing of event data from 10 categories, of which 4 categories 
  94.          are user-definable.  The user can input and store a maximum of 
  95.          2,050 events.  The program also allows instant access to calendar 
  96.          information over calendar years 1600 to 2500, two types of 
  97.          audio/visual alarm settings, host computer date/time alterations, 
  98.          configuration of 8 program attributes, and limited on-line help 
  99.          information.  CALENDAR additionally displays the current system 
  100.          date and time, Julian Day, and a user-defined clock time to monitor 
  101.          another time zone.  The program also has a screen-saver function. 
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.                                        
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.                                                              
  134.  
  135.                                        1  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.          2.0  SYSTEM REQUIREMENTS.
  142.  
  143.               2.1  Hardware.  CALENDAR requires an IBM-compatible 
  144.          microcomputer with at least one floppy disk drive.  A second floppy 
  145.          disk (or harddrive) is desirable for data storage.  The program 
  146.          allows configuration for a color, black & white, or graphics 
  147.          monochrome monitor.  Most IBM or Epson emulated printers (and the 
  148.          Okidata 83 series printers) can be used. 
  149.  
  150.               2.2  Software.  CALENDAR requires MS-DOS 2.11 or greater.  The 
  151.          CALENDAR program only requires the CALENDAR.EXE file to initially 
  152.          operate. 
  153.  
  154.               2.3  Capacity.  CALENDAR requires 64K of system memory to
  155.          operate.  It will also generate up to 42 data files on disk.  The
  156.          data files all have a CALENDAT.XXX format for standardization and
  157.          files transfer convenience.   The file types are: 
  158.  
  159.                    CALENDAT.SYS - Program configuration information.
  160.  
  161.                    CALENDAT.SUN-SAT - Data files for events pertaining
  162.                                       to `days-of-the-week'.
  163.  
  164.                    CALENDAT.001-031 - Data files for events pertaining
  165.                                       to `dates'.
  166.  
  167.                    CALENDAT.TRP - Data files for TRIP events.
  168.  
  169.                    CALENDAT.LEV - Data files for LEAVE events.
  170.  
  171.                    CALENDAT.SPL - Special data file for user-defined
  172.                                   extended events.
  173.  
  174.          All data files are generated and deleted as needed.  Except for the 
  175.          8 configuration items listed in the CALENDAT.SYS file, each of the 
  176.          events data files can hold a maximum of 50 events for a total of 
  177.          2,050 possible events.  In the extreme case where all 41 data files 
  178.          contain the maximum 50 events each, a total disk space of 192K will 
  179.          be required. 
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.          
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.         
  194.                                        2
  195.  
  196.  
  197.  
  198.  
  199.  
  200.          3.0  GETTING STARTED.  CALENDAR is directly executable from MS-DOS.  
  201.          Once the computer system is in the MS-DOS environment, the program 
  202.          is activated by typing CALENDAR and then pressing the <ENTER> key.  
  203.  
  204.               3.1  Title Screen.  CALENDAR initially displays a Title Screen 
  205.          and prompts the user to identify a drive (A, B, C, etc.) for data 
  206.          file use.  If the <ENTER> key used, CALENDAR will then identify the 
  207.          default drive for data file use.  Once the data drive is selected, 
  208.          CALENDAR then searches that data drive for the CALENDAT.SYS 
  209.          Configuration File to define 8 program attributes.  (See Section 
  210.          4.5 for discussion on Configuration.)  If the program cannot find 
  211.          the Configuration File, 8 default attributes are used.  The program 
  212.          next enters the Display Screen.  Note: if CALENDAR detects a 
  213.          configuration file from an older version of CALENDAR, a notice will 
  214.          be displayed on the Display Screen requesting the user to re-
  215.          configure for the newer version. 
  216.  
  217.               3.2  Display Screen.  CALENDAR's Display Screen initializes 
  218.          its date/time information from the computer's system clock.  A 
  219.          current Calendar is displayed in the upper-left corner and the 
  220.          current day is highlighted, including the corresponding Julian Day.  
  221.          The highlighted day can be changed using the up and down (cursor) 
  222.          arrow keys.  These keys and the PGUP and PGDN keys can also change 
  223.          the display month.  The current date and time information is 
  224.          continuously updated in the Display Screen's CURRENT DATE/TIME 
  225.          section located center-left.  The optional user-defined time zone, 
  226.          which defaults to `Other Time', is located just below the `Current 
  227.          Time' and is defined through the Configure function.  The 
  228.          CALENDAR's Alarm status is displayed immediately below the current 
  229.          date/time section.  The Alarm status will always be initially `Off' 
  230.          unless a Preset Alarm time is identified through the Configuration 
  231.          function.  The CALENDAR's 7 main functions are listed along the 
  232.          bottom of the Display Screen.  
  233.  
  234.               3.3  Operation.  CALENDAR operates with a combination of user 
  235.          prompts and menu options.  All program prompts and data file 
  236.          interactions have error-detection and recovery logic.  However, the 
  237.          program will lock-up if the command to `print' is executed and the 
  238.          printer is `off'.  If the program does lock-up, a system reboot 
  239.          will be necessary.  The user can terminate any program activity 
  240.          with the use of the `ESC' key.  All `time' entries require use of 
  241.          the military 24-hour format with no colon (i.e., 1730). 
  242.  
  243.  
  244.  
  245.          
  246.  
  247.  
  248.  
  249.         
  250.  
  251.  
  252.  
  253.                                        3
  254.  
  255.  
  256.  
  257.  
  258.  
  259.          4.0  PROGRAM FUNCTIONS.  CALENDAR's main menu functions are listed 
  260.          along the bottom of the Display Screen.  Each function is activated 
  261.          by pressing the first letter (lower or upper case), which is 
  262.          located within brackets or parentheses.  For example, pressing an 
  263.          `H' or `h' will activate the `(H)elp' function.  For convenience, 
  264.          program options with the first letter located within brackets 
  265.          (e.g., <A>dd) are the default options, and will be activated by 
  266.          just pressing the <ENTER> key.  Day/Month/Year entries are 
  267.          automatically entered during some data entry options for user 
  268.          convenience.  These automatic entries can be edited through use of 
  269.          the BackSpace or Left-Arrow keys. 
  270.  
  271.               4.1  (E)vents.  Activation of this function will display an 
  272.          Events sub-menu with 4 sub-functions: Add, List, Print, and Delete. 
  273.  
  274.                    4.1.1  <A>dd.  The Add sub-function is the default 
  275.          option.  This option allows entry of events data into 10 possible 
  276.          event categories.  Depending on the event category chosen, a pre-
  277.          defined interactive sequence of questions prompts the user to 
  278.          define the event so the program can save the event in one of 41 
  279.          possible data files.  The first prompt, TYPE, allows the user to 
  280.          group events into sub-categories, and is most useful when the user 
  281.          needs to separate multiple individual or office-related events 
  282.          which reside on the same data disk.  Use of event TYPE 
  283.          identification allows the user to select sub-categories of events 
  284.          during the listing and printing options.  For example, suspense 
  285.          events can be `type' identified by office or person, such as HOME 
  286.          or JACK, which then can be selectively recalled for display or 
  287.          print.  Entry of the event TYPE is optional during data input.  The 
  288.          next prompt asks if the event has a specific suspense time or not.  
  289.          The next line of prompts is most important, since this line of 
  290.          information will be the only data displayed during the list and 
  291.          print output.  If the user indicates that the event is `time' 
  292.          specific, then the data line will have 3 fields of data, otherwise, 
  293.          the data line will have 2 fields of data.  Example formats follow: 
  294.  
  295.                1>  A Time specific event (3 fields).
  296.  
  297.                    TIME_EVENT....._DESCRIPTION..................
  298.  
  299.                2>  A non-Time specific event (2 fields).
  300.  
  301.                    EVENT..........._DESCRIPTION.................. 
  302.  
  303.          In the first case, the first field records the TIME which the 
  304.          particular event is associated with.  In the second case, there is 
  305.          no event TIME entry.  However, in this second case the EVENT field 
  306.          is larger, since space for a time entry is not needed.  Use of 
  307.          event DESCRIPTION is always optional.                       
  308.                                                          
  309.                               
  310.                     
  311.  
  312.                                          
  313.                                        4
  314.  
  315.          
  316.          
  317.          
  318.          
  319.                    4.1.2  (L)ist.  The List sub-function allows screen 
  320.          display of all or selected events previously stored to disk files 
  321.          through the Add sub-function.  The program only collects those 
  322.          events for display which match the day highlighted on the display 
  323.          Calendar.  Events from any date can be listed, but only after the 
  324.          desired calendar day is highlighted on the display Calendar.  
  325.          Activation of the List option begins a sequence of 2 prompts.  The 
  326.          first prompt allows event selection of up to any combination of 7 
  327.          event categories or groups of categories, or selection of all event 
  328.          categories (the default option).  The second prompt allows 
  329.          selection of either only one TYPE of events, or all TYPEs.  
  330.          Selection of all TYPEs is the default option.  (Event TYPES are 
  331.          defined during entry of event data--see the Add sub-function.)  
  332.          Once the event categories and types are selected, the program 
  333.          searches all pertinent available data files and retrieves only 
  334.          those events that match the day highlighted on the display 
  335.          Calendar.  These selected events are then sorted in one of two 
  336.          ways.  For the events that have a suspense time defined, they are 
  337.          grouped and sorted chronologically.  For the events with no 
  338.          suspense time, they are grouped and sorted based on the EVENT 
  339.          field.  Events with suspense times are listed first.  The CALENDAR 
  340.          program is only designed to collect a maximum of 75 events from the 
  341.          data files for display purposes.  If the program tries to select 
  342.          more than 75 events, a warning will be displayed, including which 
  343.          data file caused the excess condition.  After the user presses the 
  344.          letter `C', the program will then continue to process only the 
  345.          first 75 events collected. 
  346.  
  347.                    4.1.3  (P)rint.  The Print sub-function allows transfer 
  348.          of all selected events to a printer.  Selected events are matched 
  349.          against the display calendar's highlighted day, similar to the List 
  350.          sub-function discussed above.  Activation of the Print option also 
  351.          begins the same sequence of 2 prompts presented during the List 
  352.          option.  The printed events are grouped and sorted in the same 
  353.          fashion as discussed in the List option, and the 75 event maximum 
  354.          also applies to Print processing as it does during List processing. 
  355.         
  356.                    4.1.4  (D)elete.  The Delete sub-function allows deletion 
  357.          of events data automatically or manually.  The automatic, or Purge, 
  358.          option deletes all events having dates older than the Calendar's 
  359.          highlighted DAY.  The manual option permits individual event 
  360.          deletion from selected data files.  During manual deletions, the 
  361.          deletion instructions are displayed on the screen, but it is 
  362.          important to note that the `DEL' key only deletes events from the 
  363.          display screen.  The events are physically erased from the disk 
  364.          file only after the `END' key is pressed.  Use of the `ESC' key 
  365.          will cancel the deletion process and restore any events marked for 
  366.          deletion. 
  367.  
  368.          
  369.          
  370.              
  371.  
  372.                                        5
  373.  
  374.          
  375.          
  376.          
  377.  
  378.               4.2  (J)ump.  This function allows the user to rapidly `jump' 
  379.          to any calendar date within the years 1600 to 2500. 
  380.  
  381.               4.3  (A)larm.  This function allows the user to set an alarm 
  382.          which will activate an audio/visual signal, even when the screen-
  383.          save feature is active.  The Alarm will sound when the designated 
  384.          system time is reached.  The Alarm will also sound within the 5 
  385.          minutes after the designated setting if CALENDAR is initially 
  386.          activated within that period.  The Alarm signals can be stopped by 
  387.          pressing any key.  The Alarm setting can be turned off by entering 
  388.          `0000'.  This Alarm setting will override any Preset Alarm setting 
  389.          identified during program configuration.  
  390.          
  391.               4.4  (D)ate/Time.  This function allows the user to reset the 
  392.          host computer's date and/or time settings.  Any changes will be 
  393.          reflected in the Display Screen's CURRENT DATE/TIME section. 
  394.  
  395.               4.5  (C)onfigure.  This function allows the user to define 8 
  396.          program attributes.  These 8 attributes are stored in the 
  397.          CALENDAT.SYS file and are retrieved during program initialization.  
  398.          If the CALENDAT.SYS file is not available, or for those attributes 
  399.          not defined, the following default attributes are used:
  400.          
  401.                    1  Video Screen - Color
  402.                    2  Printer Mode - Regular, Pica (10 cpi)
  403.                    3  Preset Alarm - Off
  404.                    4  Time Zone - Other Time  /  Time Factor - Off
  405.                      
  406.                   {4 User-Defined Files - initially `not defined'}
  407.  
  408.                    5  `Daily Events #1'
  409.                    6  `Daily Events #2'
  410.                    7  `Extended Events'
  411.                    8  `Annual Events'
  412.            
  413.                    The purpose of allowing 4 user-defined categories is for 
  414.          specific user applications.  For example, `Daily Events' categories 
  415.          1 and 2 could be defined as `Performance Reports' and `Luncheons'.  
  416.          The `Extended Events' category could labelled `Notes' or 
  417.          `Visitors'.  The `Annual Events' category can be used to track 
  418.          `Anniversaries'. 
  419.  
  420.               4.6  (H)elp.  This function allows the user to display one page 
  421.          of program information. 
  422.  
  423.               4.7  (Q)uit.  This function allows the user to exit the 
  424.          CALENDAR program and return to MS-DOS. 
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.                                        6
  432.  
  433.  
  434.  
  435.  
  436.  
  437.                          MODIFICATIONS TO VERSION 1.0   
  438.                          ____________________________
  439.  
  440.          SCREEN-SAVE function now activates from any screen within the 
  441.          CALENDAR program. 
  442.  
  443.          MAIN MENU default option was changed from `<E>vents' to `List All 
  444.          Events For The Calendar's Highlighted DAY' by pressing the <ENTER> 
  445.          key. 
  446.  
  447.          DAY/MONTH/YEAR data is automatically presented as input during 
  448.          addition of new Events data. 
  449.  
  450.          PURGE has been added to the Event's Delete option.  Purge 
  451.          automatically searches all event data files and deletes events 
  452.          having dates older than the Calendar's highlighted DAY. 
  453.  
  454.          ZULU time display is now a user option.  This optional time display 
  455.          can be labelled by the user through the Configure command to 
  456.          indicate any desired time zone. 
  457.  
  458.          CURSOR indication has been added during data entry operations.
  459.  
  460.          TYPE data for events is no longer listed or printed in column form 
  461.          along with the TIME/EVENT and DESCRIPTION information, however, the 
  462.          TYPE information is instead displayed in the title line.  This was 
  463.          done for two reasons.  First, this freed extra space for data 
  464.          listings, which gave 5 extra characters to the DESCRIPTION line.  
  465.          Second, this eliminated redundant listing of TYPE data when a 
  466.          specific event TYPE was requested.  
  467.  
  468.          DELETE operation errors were corrected.  
  469.  
  470.          ERROR detection and recovery operations were enhanced.
  471.  
  472.  
  473.  
  474.  
  475.  
  476.  
  477.  
  478.  
  479.  
  480.  
  481.  
  482.  
  483.  
  484.  
  485.  
  486.  
  487.  
  488.  
  489.  
  490.                                        7
  491.  
  492.          
  493.          
  494.          
  495.            
  496.                                ACKNOWLEDGMENTS
  497.                                _______________
  498.  
  499.  
  500.          Special thanks are extended to the following people:
  501.  
  502.          TSgt John Spaller, for his technical consultation.
  503.  
  504.          Mr Mike Howland, for his evaluations and suggestions.
  505.  
  506.          All, who helped test and evaluate CALENDAR.
  507.  
  508.  
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.  
  533.  
  534.  
  535.  
  536.  
  537.  
  538.  
  539.  
  540.  
  541.  
  542.  
  543.  
  544.                                      
  545.  
  546.  
  547.  
  548.                                        8
  549.  
  550. 
  551.  
  552.