home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / busi / promn162.zip / PROMAN.DOC < prev    next >
Text File  |  1989-12-23  |  17KB  |  393 lines
  1. ProMan Project Manager/Scheduler
  2. Version 1.62
  3. December 18, 1989
  4.  
  5. PURPOSE
  6.    The ProMan project manager was developed as an easy-to-use alternative to
  7.    the many "To Do" list programs available in the shareware market.
  8.    It can keep track of an unlimited number of projects, and an unlimited
  9.    number of events within each project.  Each record can have an optional
  10.    note of over 800 characters in length.  The system is very intuitive, but
  11.    a brief overview of the various options are presented below.
  12.  
  13.  
  14. FILES
  15.  
  16.    ProMan is distributed as a self-extracting archive containing the
  17.    following files:
  18.  
  19.       PROMAN.EXE: The main executable program.
  20.       NEW.DAT:    An empty data file used by PROMAN to create new databases.
  21.       PROMAN.DOC: The documentation file.
  22.  
  23.  
  24. CREDITS 
  25.  
  26.    Turbo Pascal is the trademark of Borland International.  The kernel
  27.    of ProMan is derived from the NetDemo.Pas program from TurboPower
  28.    Software, and is used with permission.
  29.  
  30.  
  31. DISTRIBUTION RIGHTS
  32.  
  33.    This program is distributed as shareware.  The author retains
  34.    exclusive copyright to all the material.  Users may freely copy
  35.    and distribute the software and documentation in it's original
  36.    unmodified state.   Other than reasonable copying and shipping
  37.    and handling charges, no renumeration may be accepted by any
  38.    party other than the copyright holder.  As a shareware program,
  39.    if you believe that the program is worthwhile, please consider a
  40.    donation of $15 to the author.  Please direct all inquiries
  41.    and comments about ProMan to:
  42.  
  43.       Dean A. Madar
  44.       720 #5 Tramway Lane NE
  45.       Albuquerque, NM  87122
  46.  
  47.           or to
  48.  
  49.       Dean Madar, CIS,
  50.       73210,2741
  51.  
  52.  
  53. DISCLAIMER
  54.  
  55.    ProMan is distributed as is, without warranty of any kind, expressed or
  56.    implied.  The author will not be liable for any damage arising out of
  57.    its use.
  58.  
  59.  
  60. SYSTEM REQUIREMENTS
  61.  
  62.    ProMan will run on any IBM or close compatible.  The minimum system
  63.    requirements are 256 kilobytes of free memory, MS-DOS or PC-DOS 2.0
  64.    or greater, and 1 diskette drive  and a color or monochrome monitor.
  65.    A printer is optional, and a hard disk is recommended for performance
  66.    reasons.
  67.  
  68.  
  69. LANGUAGE
  70.  
  71.    ProMan is written in Turbo Pascal 5.5, using many UNITS from the
  72.    Turbo Professional package of TurboPower software.  The data and index
  73.    files use the TurboPower B-Tree Filer package.
  74.  
  75.  
  76. GETTING STARTED
  77.  
  78.    DUAL FLOPPY DISK SYSTEM
  79.  
  80.       If you'll be running ProMan from a dual floppy system, the program
  81.       disk will be in drive A, and the data disk will also be drive A.
  82.       Place a newly formatted system disk in drive A and copy the
  83.       following files from your distribution disk to your new system
  84.       disk:  PROMAN.EXE, NEW.DAT.  You will have approximately 100 Kbytes
  85.       of space remaining on this disk.
  86.  
  87.  
  88.    HARD DISK SYSTEM
  89.  
  90.       Create a new subdirectory of your choice and copy all of the
  91.       files from the distribution disk into the newly created
  92.       subdirectory.  Type PROMAN16 at the DOS command line, and the ProMan
  93.       files will be expanded.
  94.  
  95.  
  96. GENERAL FEATURES
  97.  
  98.    ProMan has a variety of options that are initated with the function
  99.    keys.  The list of active keys is always displayed on the last line of
  100.    the CRT to allow easy access.  The function key options include:
  101.  
  102.       <F1>  Mod   - Modify the highlighted record
  103.       <F2>  Add   - Add a new record
  104.       <F3>  Del   - Delete the highlighted record
  105.       <F4>  DB's  - Change the database in use
  106.       <F5>  Key   - Change the key used to sort the displayed records
  107.       <F7>  Copy  - Copy the highlighted record to another database
  108.       <F8>  Prn   - Print some or all of the records
  109.       <Alt> Opts  - Other options; displayed when the <Alt> key is pressed
  110.       <Esc> Quit  - Quit ProMan
  111.  
  112.    Pressing the <Alt> key will show the following options:
  113.       <AltF7>  New Deadline    - Enter a new deadline to be used by <AltF8>
  114.       <AltF8>  Change Deadline - Change the deadline of the highlighted record
  115.       <AltF9>  Info            - Display database information
  116.       <AltF10> Purge           - Purge deleted records or rebuild indexes
  117.  
  118.    Each of these options will be discussed below.
  119.  
  120.    Records in the database are displayed in groups of 20.  Records can
  121.    be viewed by moving the light bar with the arrow keys, or the <PgUp>
  122.    and <PgDn> keys.  The note field can be displayed and/or edited by
  123.    pressing <ENTER> on a highlighted record.
  124.  
  125.    Status messages are displayed on line 25 of the display, as are
  126.    certain verification messages such as asking for permission to create
  127.    files, or delete records.
  128.  
  129.    The display window is greater than 80 characters in width.  The
  130.    remaining fields (date and time of last modification) can be
  131.    displayed by using the right and left arrow keys to scroll the screen
  132.    sideways.
  133.  
  134.    In any data entry field except Notes, entering any character in the
  135.    first position will clear the entire field contents.  This usually
  136.    saves keystrokes, but can occasionally cause trouble to the unwary.
  137.  
  138.  
  139. STARTING PROMAN
  140.  
  141.    Change to the subdirectory containing ProMan.  From the DOS command line,
  142.    type PROMAN and press <ENTER>.  The available databases will be
  143.    displayed in a pick window.  Move to the database of choice with the
  144.    arrow keys and press <Enter>.  Select the NEW database to create
  145.    another database.
  146.  
  147.  
  148. MAKING A NEW DATABASE
  149.  
  150.    Whenever ProMan is started, or when the "<F4> DB's" key is pressed during
  151.    operation, a pick window of all available databases will appear.
  152.    Select the NEW database and press <Enter>.  A second window will open
  153.    asking for the name of the new database.  Type any legal DOS file
  154.    name and press <Enter>.  A blank display screen will appear with a
  155.    verification message on line 25 asking if the new database should be
  156.    created.  Press "Y" and <Enter>.  A status message notifying you that
  157.    there are no records will appear, asking if you want to enter one at
  158.    this time.  Press "Y" and <Enter>.  Entering a data record is discussed
  159.    below.
  160.  
  161.    This process will create 2 files on your disk.  The first, with an
  162.    extension of .DAT contains the data records.  The second with an
  163.    extension of .IX contains all index information for the corresponding
  164.    data file.  The index file preallocates a certain amount of space and
  165.    will be 13Kbytes before any records are added.  It will remain at
  166.    this size for some time, even after records are added.
  167.  
  168.  
  169. PICKING A DATABASE
  170.  
  171.    Start ProMan by typing PROMAN at the DOS command line.  A pick window of
  172.    available databases will appear.  Move to the desired database with
  173.    the arrow keys and press <Enter>.  The screen will display a list of
  174.    the first 20 records in the database and wait for further keystrokes.
  175.  
  176.    During operation of ProMan, you can select another database by using
  177.    the "<F4> DB's" option.  Pressing the <F4> key will cause the current
  178.    database to be saved, and the pick window of databases to be
  179.    displayed.  You can switch databases, or create a NEW one at this
  180.    time.
  181.  
  182.  
  183. ADDING A NEW RECORD <F2>
  184.  
  185.    With the light bar anywhere in a database, press <F2> to add a new
  186.    record.  The data entry window will appear with the cursor in the
  187.    first field.  The fields are: Project; Priority; Deadline Date and
  188.    Time; Event Summary; Notes; and Date and Time of last modification.
  189.  
  190.    Type a project name and press <Enter>.  Any character string up to 22
  191.    characters in length is acceptable.
  192.  
  193.    The priority field defaults to 0, but can be changed to any
  194.    alphanumeric character.  The numbers 0 through 9 are the most
  195.    intuitive with 0 being low priority and 9 being high, but A..Z and
  196.    a..z can also be used.  The priority is sorted in ASCII sequence,
  197.    that is, is order 0..9, A..Z, a..z, with "z" having the highest
  198.    value.
  199.  
  200.    Deadline date defaults to 1 month beyond when the entry is being mad
  201.    at 08:00.  Only valid dates and times can be entered, and the cursor
  202.    will move from field to field within the date.  Leading zeroes are
  203.    recommended during date and time entry.
  204.  
  205.    The summary field is a brief description of the event (or may be the
  206.    entire description, depending on the event).  Any alphanumeric
  207.    character can be entered.  The summary field is informational only,
  208.    and is not used for any indexing.
  209.  
  210.    The Project, Deadline and Summary fields are required.
  211.  
  212.    The Notes field is optional.  Pressing <Enter> with the cursor in
  213.    this field will move the cursor to the Notes window.  This is a small
  214.    text editor, allowing notes up to 850 characters in length.  The
  215.    commands available for used in this editor are given in appendix A.
  216.    Press <Ctrl Enter> to leave the note field.
  217.  
  218.    After completing the record (with or without a note field), press
  219.    <Ctrl Enter> to file the record.  Four indexes are created for the
  220.    record: Deadline, Priority, Project+Deadline, and Project+Priority.
  221.    These indexes are used to sort the records prior to display or
  222.    printing.  See <F5> Displaying records and <F8> Printing records,
  223.    below.
  224.  
  225.    The Date and Time of last modification are automatically updated from
  226.    the system date and time.  These fields cannot be changed manually.
  227.  
  228.  
  229. MODIFYING A RECORD - <F1>  Mod
  230.  
  231.    Any existing record can be modified by highlighting the record and
  232.    pressing <F1> or <Enter>.  The entire record, icnluding the note
  233.    field will be displayed in the same format used to add the record
  234.    originally.  Any field can be changed as desired.  Press <Ctrl Enter>
  235.    when the modifications are completed.  All indexes are updated
  236.    accordingly if the Project, Priority, or Deadline is changed.
  237.  
  238.  
  239. DELETING A RECORD - <F3> Del
  240.  
  241.    When a deadline has passed and the event has been completed, the
  242.    record can be deleted by highlighting it and pressing <F3>.  The
  243.    entire record will be displayed, and you will be asked to verify that
  244.    the record should be deleted.  The default answer is <N>o.  Press Y
  245.    and <Enter> to delete the record.  All index references will also be
  246.    deleted.
  247.  
  248.    The database will reuse records that have been deleted to minimize
  249.    the expansion of the file sizes.
  250.  
  251.  
  252. CHANGING THE DATABASE IN USE - <F4> DB's
  253.  
  254.    At any time that the record display screen is shown, the database can
  255.    be changed by pressing <F4>.  The current data files will be saved,
  256.    and the pick window of available databases will be displayed.  Select
  257.    the new database with the arrow keys and press <Enter>, or create a
  258.    NEW database if needed.
  259.  
  260.  
  261. CHANGING THE DISPLAY ORDER OF RECORDS - <F5> Key
  262.  
  263.    The order in which the records are displayed to the screen can be
  264.    alternated between any of the 4 keys by pressing "<F5> Key".  The
  265.    default sort order is by Deadline.  Pressing <F5> will rotate
  266.    between Priority, Project+Deadline, and Project+Priority display
  267.    orders.  Pressing <F5> again will return you to Deadline order.
  268.  
  269.    Records can be entered or altered no matter what sort order is in
  270.    use.  Any record added or changed will be placed in the display in
  271.    the correct location for the current sort order.
  272.  
  273.  
  274. COPYING A RECORD TO ANOTHER DATABASE - <F7> Copy
  275.  
  276.    It is sometimes desireable to have the same record in more than one
  277.    database.  For example, one database may be a "Master", listing all
  278.    events, and other databases may contain a more detailed separation of
  279.    Projects.  The <F7> Copy function is provided to make this an easy
  280.    process.
  281.  
  282.    Highlight the record to be copied with the arrow keys and press <F7>.
  283.    The pick window of available databases will be displayed, allowing
  284.    you to choose the destination database.  A NEW database can also be
  285.    created at this time if needed.  Select the destination database with
  286.    the arrow keys and press <Enter>.  Another window will appear giving
  287.    you the opportunity to change the Project name of the record before
  288.    it is copied to the new database.  The default Project name is the
  289.    same as it is in the source database.
  290.  
  291.    Complete the copy by pressing <Enter>.  The record and any notes will
  292.    be copied to the destination database and you will be returned to the
  293.    original screen of records.
  294.  
  295.  
  296. PRINTING RECORDS - <F8> Prn
  297.  
  298.    Some or all of the records in a database can be printed by pressing
  299.    the <F8> key.  A selection criteria window will appear, allowing you
  300.    to limit the search to one database, and/or a restricted range of
  301.    deadline dates.  Accepting the defaults (no database, and the
  302.    displayed beginning and ending deadlines) will cause ALL records to
  303.    print.
  304.  
  305.  
  306. ENTERING A NEW DEADLINE - <Alt F7> New Deadline;
  307.                           <Alt F8> Change Deadline
  308.  
  309.    It is frequently desireable to change a deadline after a record has
  310.    been entered.  This can be done in one of two ways.
  311.  
  312.    The first way requires that you highlight the record and modify it
  313.    by pressing <F1> or <Enter>, moving to the deadline field, changing
  314.    it and refiling the record.  This works well if you are changing the
  315.    deadline of only a single or a few records.
  316.  
  317.    The second method allows you to change the deadline of many records
  318.    with a single keystroke.  First, press <AltF7> to enter the new
  319.    desired deadline.  An entry window allowing for a new date and time
  320.    will be displayed.  Fill in the fields and press <Ctrl Enter>.  The
  321.    records will then be displayed.  Highlight the record whose deadline
  322.    is to be changed and press <AltF8>.  The deadline that was entered
  323.    with <AltF7> will automatically be entered into the highlighted
  324.    record, reindexed and refiled.
  325.  
  326.    In truth, the <AltF7> step, above, is needed only if you are using
  327.    <AltF8> for more than one changed deadline.  If there is no new
  328.    deadline defined when you first press <AltF8>, you will be given a
  329.    chance to enter the new deadline without explicitly first using
  330.    <AltF7>.
  331.  
  332.  
  333. DISPLAYING DATABASE INFORMATION - <AltF9>
  334.  
  335.    The number of records in use, the number of deleted records and a few
  336.    other statistics of the database in use can be displayed by pressing
  337.    <AltF9>.  The display is informational only, and cannot be changed.
  338.  
  339.  
  340. PURGING DELETED RECORDS - <AltF10>
  341. REBUILDING INDICES      - <AltF10>
  342.  
  343.    In an active database on a disk that is pressed for space, it will be
  344.    necessary to compress the datafile by removing deleted records.  This
  345.    can be done by pressing <AltF10>.  The remainder of the steps are
  346.    automatic, with the system first reading the database, then rewriting
  347.    it without the deleted records.
  348.  
  349.    Recovering from corrupted indices should also be automatic, but it
  350.    may be necessary to initiate this manually under some circumstances
  351.    such as a program upgrade.  The <AltF10> function will provide this
  352.    function as it rereads the datafile.
  353.  
  354. Appendix A
  355.  
  356. Summary of the Editor Commands.          
  357.  
  358.    Cursor left one character:                      <Left>, <CtrlS>
  359.    Cursor right one character.                     <Right>, <CtrlD>
  360.    Cursor left one word.                           <CtrlLeft>, <CtrlA>
  361.    Cursor right one word.                          <CtrlRight>, <CtrlF>
  362.    Cursor to beginning of line.                    <Home>, <CtrlQ><S>
  363.    Cursor to end of line.                          <End>, <CtrlQ><D>
  364.    Cursor up one line.                             <Up>, <CtrlE>
  365.    Cursor down one line.                           <Down>, <CtrlX>
  366.    Cursor to top of edit window.                   <CtrlHome>, <CtrlQ><E>
  367.    Cursor to bottom of edit window.                <CtrlEnd>, <CtrlQ><X>
  368.    Cursor to beginning of file.                    <CtrlPgUp>, <CtrlQ><R>
  369.    Cursor to end of file.                          <CtrlPgDn>, <CtrlQ><C>
  370.    Delete character at cursor.                     <Del>, <CtrlG>
  371.    Delete character to left of cursor.             <Bksp>,
  372.                                                    <CtrlH>,
  373.                                                    <CtrlBksp>
  374.    Delete current line.                            <CtrlY>
  375.    Delete to end of line.                          <CtrlQ><Y>
  376.    Delete word to right of cursor.                 <CtrlT>
  377.    Start a new line.                               <Enter>, <CtrlM>
  378.    Move to the next tab stop.                      <Tab>, <CtrlI>
  379.    Insert control character.                       <CtrlP>
  380.    Scroll display up one line.                     <CtrlW>
  381.    Scroll display down one line.                   <CtrlZ>
  382.    Scroll display up one page.                     <PgUp>, <CtrlR>
  383.    Scroll display down one page.                   <PgDn>, <CtrlC>
  384.    Toggle insert mode                              <Ins>, <CtrlV>
  385.    Toggle auto-indent mode                         <CtrlO><I>
  386.    Toggle word wrap                                <CtrlO><W>
  387.    Reformat current paragraph.                     <CtrlB>
  388.    Reformat the entire file.                       <AltR>
  389.    Restore original contents of the current line.  <CtrlQ><L>
  390.    Quit editing.                                   <Esc>, <CtrlBreak>
  391.  
  392.  
  393.