                      The Consulting Log TSR V1.8
                          Copyright (C) 1988
                      by The University of Kansas
                           Lawrence, Kansas
                         All Rights Reserved*

Consulting Log is a Terminate and Stay Resident (TSR) data collection
program which provides academic computer consultants a method of
tracking questions presented to them while working within another
application program.  A pop-up window appears above the other application
when a specific "hotkey" sequence is pressed (the default is <ALT>-F10).
The consultants then enter information into the relevent fields of the
window.  Automatic time and date functions are provided to increase the
efficency of use.  When the consultants have finished using the Consulting
Log, the press <ESC> or <F10> to return to their previous application.

The data created by this program is intended for statistical analysis
with any third-party software. The file organization is fixed-length,
columnar records delimited with a carriage-return/line-feed
sequence.

*See Software Agreement below for specifics.

Installation
-------------------------------------------------------------------------------

The syntax for installing the Consulting Log is as follows:

                  consult [<parameter>]*

where <parameter> is one or more of the following:

    quit        to remove the TSR from memory. Quit only
                works when there are no TSRs loaded after
                the TSR. If another TSR has control of an
                interrupt that the Consulting Log uses, then
                this parameter will simply put the TSR in
                suspend mode (see below).
    suspend     deactivate the hotkey and suspend execution
                of the TSR.  This is done when there is conflict
                with another program for control of the hot
                key.
    resume      activate the hotkey. The opposite of suspend.
    scancode= <number>
                change the hotkey assignment to <number>.
                Every key on the keyboard has a specific
                scancode.  If scancode equals zero (0), the
                keymask (seen below) is still active. The
                default is 68 ( F10 ). The scancode values
                appear below.
    keymask=<number>
                change the shift key specification to <number>
                Every shift key (alt, ctrl, shift, ins, caps lock,
                scroll lock, num lock) has a specific value.
                These values can be added together to specify
                multiple shift key sequences which are used
                to augment the scancode (e.g. <ctrl><alt>F10 ).
                Set scancode to zero (0) and keymask to
                twelve (12) to assign the SIDEKICK  <ctrl><alt>
                hotkey sequence. The default is 8 ( <alt> ). The
                keymask codes appear below.
    filename=[[<DRIVE>:][<DIRECTORY>]<FILENAME>[.<EXTENSION>]]
                specifies the data file that is opened each time
                the TSR is activated. The default is
                           "c:\consult\consult.XXX".
                where XXX is the first three letters of the current
                month according to DOS. Notice that if <EXTENSION>
                is not specified in the pathname, the current 'XXX'
                month will be appended as an extension and this
                extension will change automatically when the
                date changes.  However, if <EXTENSION> is
                specified, it will remain intact regardless of
                the DOS date.  Also, if <DRIVE> and/or <DIRECTORY>
                are not specified, then the current drive and/or
                directory are added to form a complete pathname.
                Finally, if the pathname is completely omitted
                ("consult filename="), the current pathname is given
                the 'XXX' month extension, overriding the specific
                <EXTENSION> that already exists.
    initials=XXX
                specifies the initials of the primary consultant
                using the Consulting Log.  Best used when
                installing the TSR from a batch file.

When consult is entered on the command line, the parameters are
processed and a status listing displays the current scancode,
keymask, and filename values, as well as the number of active
buffers (buffers with the timer running) and whether or not the TSR
has been suspended.  The Consulting Log is installed if it is not
already resident.

The parameters quit, suspend, and resume have no affect if the TSR
is not already resident.

Note that it is important to set the DOS Time and Date when using
the Consulting Log in order to take full advantage of the automatic
time and date functions.

Activation
-------------------------------------------------------------------------------

Activate the TSR by pressing the prescribed hotkey sequence (the
default it <alt>F10). If you are unsure of the hotkey sequence, type
consult at the command line to see the current values of scancode
and keymask, and reference these values in the tables below.


  Keyboard Status Mask     Function Keys         Keyboard Scan Codes
|----------------------|   |-----|-----| |-ESC|-1!-|-2@-|--------|-=+-|--BS--|
| Key            Value |   | 59  |  60 | |  1 |  2 |  3 |   ...  | 13 |  14  |
|----------------------|   |-----|-----| |-TAB|-qQ-|-wW-|--------|-]}-|RETURN|
| Ins             128  |   | 61  |  62 | | 15 | 16 | 17 |   ...  | 27 |      |
| Caps Lock       64   |   |-----|-----| |CTRL|-aA-|-sS-|------|-'"-|--  28  |
| Num Lock        32   |   | 63  |  64 | | 29 | 30 | 31 |  ... | 41 |        |
| Scroll Lock     16   |   |-----|-----| |SHFT|-zZ-|-xX-|-----|-/?-|SHFT|PrtS|
| Alt             8    |   | 65  |  66 | | 42 | 43 | 44 | ... | 53 | 54 | 55 |
| Ctrl            4    |   |-----|---- | |-ALT|--|-----SPACE------|--|CAPS|--|
| Left Shift      2    |   | 67  |  68 | | 56 |  |       57       |  | 58 |
| Right Shift     1    |   |-----|-----| |----|  |----------------|  |----|
|----------------------|

                                        Numeric Keypad Scan Codes
                                    |----Num Lock--|--Scroll Lock----|
                                    |      69      |      70         |
                                    |--7 HOME--|---8 UP---|--9 PGDN--|-MINUS-|
                                    |    71    |    72    |    73    |   55  |
                                    |--4 LEFT--|----5-----|--6 RIGHT-|--PLUS-|
                                    |    75    |    76    |    77    |   74  |
                                    |--1 END---|--2 DOWN--|--3 PGDN--|-ENTER-|
                                    |    79    |    80    |    81    |       |
                                  |----0 INS-----|-----1 DEL-----|---|   78  |
                                  |      82      |       83      |   |       |
                                  |--------------|---------------|   |-------|



A window will appear on the screen with one of the five Consulting
Log data buffers visible. The expected values of these buffers are as
follows:

Size    Cols    Name            Description
    8   0-7     System          VAX, IBM, IBMPC, MAC, CSVAX, HARRIS, etc.
    8   8-15    Department      As in the timetable, ENGL, CS, ECE,
                                PHSX, POLS, PSYC, MATH, HDFL, etc.
    3   16      Classno         If applicable, the undergraduate
                                class or the class number for the
                                graduate Master's Thesis or
                                Doctoral Dissertation.
    1   17      Classification  U (undergraduate),    G (graduate),
                                S (staff), F (faculty),  O (other)
                                A (administrative),
    1   18      Consulting Mode C (counter), P (phone), F (face-to-face)
                                D (dedicated consulting).
                                This code will carry over to the
                                other inactive buffers automatically.
   25   19-44   Problem         In twenty-five characters or less,
                                PASCAL, SPSS-X, LOTUS 1-2-3,
                                DBASE, etc.  Try to describe the
                                problem in a top-down hierarchical
                                structure. If there is room, expand on
                                the problem. (e.g. PASCAL; POINTERS)
   25   45-70   Comment         Another twenty-five characters
                                for use at the consultants
                                descretion. Use this field for
                                memos, phone numbers, or other
                                follow-up information.
    5   71-75   Start time      Automatically set when timer is
                                started (F1).
    8   76-83   Elapsed time    Start and stop timer with F1.
    8   84-91   Date            System date, automatically set.
    3   92-94   Initials        Consultant's initials. These initials
                                will carry over to the other
                                inactive buffers automatically.
    2   95-96   Carriage-Return
                Line-Feed


Find and Review
-------------------------------------------------------------------------------

Press F7 to toggle REVIEW MODE off and on. When entering REVIEW
MODE, the current buffer will display the last saved record in the
data file.  Navigate through the data file using CTRL-PGUP and CTRL-
PGDN. While in REVIEW MODE, the timer functions are inactive.
When exiting REVIEW MODE, information will be retained in the
buffer for use as a new record.

Modify the contents of a record by changing the buffer, then saving
the buffer with F2.  If the buffer has been modified, a warning
message will display "Save? (F2)" when CTRL-PGUP or CTRL-PGDN is
entered. Press F2 to save the record or press the CTRL key a second
time to override the warning.

Press F8 to display a special buffer for the FIND criterion. Explicit
characters entered in this buffer are used for the criterion. These
characters must match characters at the same location of a record in
the data file for the match to be successful. Blank characters in the
criterion buffer allow any character to appear at that location. Use an
asterisk (*) as an explicit blank when matching fields which contain
no information.

When the criterion has been specified, press F7 to execute the search.
If the current buffer is not already in REVIEW MODE, then the search
begins at the end of the file and works backward. That is, the most
recent records are looked at first.  If the buffer is in REVIEW MODE,
then the search begins at the current record number and works
backward.  Successive repetitions of F8 and F7 will display all the
records in the data file that match the specified criterion.

Cursor Movement
-------------------------------------------------------------------------------

    Up Arrow                   Previous field
    Down Arrow,   Return       Next field
    Left Arrow                 Previous Character
    Right Arrow                Next Character
    Home                       Beginning of field
    End                        End of field
    Page Up                    Previous buffer
    CTRL-Page Up               Previous record (when in review mode)
    Page Down                  Next buffer
    CTRL-Page Down             Next record (when in review mode)


Function Keys
-------------------------------------------------------------------------------

    F1                         Start and stop the Elapsed time clock. Sets
                               the Start time. Timer functions are inactive
                               in REVIEW MODE.
    F2                         Saves the current buffer to the file specified
                               by the parameter filename=. If the buffer
                               has not been activated with F1, then a
                               warning message displaying "ARE YOU SURE? (F2)"
                               will be issued. Press F2 again to override
                               the warning.
    F3                         Delete a field.
    F4                         Delete the information stored in a buffer. If
                               the buffer has been activated with F1 and has
                               not been saved with F2, a warning message
                               displaying "SAVE? (F2)" will be issued. Press
                               F4 again to override the warning.
    F7                         Toggles the current buffer in and out of
                               REVIEW MODE. See Review and Find for more
                               information.
    F8                         Toggles the current buffer in and out of FIND
                               MODE.  Once criterion has been entered, use
                               F7 to begin the search.  See Review and Find
                               for more information.
    F10, ESC                   Exit the TSR.



Further Inquiries
-------------------------------------------------------------------------------

The Consulting Log was written by Todd Gochenour at the University of Kansas
Academic Computing Center, Lawrence, KS 66045.  E-Mail can be sent to
TODD@UKANVAX (via BITNET) or TODD@kuhub.cc.ukans.edu (via internet).
His phone number is (913)864-0451. Questions concerning this program
will be gladly answered.

TSRs are known to be quirky, and The Consulting Log is no exception.
Although I have had no problems with it, unusual hardware and/or software
configurations may create random crashes. Especially look for problems
with unusual hardware connected to the disk controller (such as Matchpoint
PC), and device drivers attached to the keyboard interrupt (such as
WordPerfect's speed-key utility).

The Consulting Log occupies 27K of memory, which may conflict with the greed
of other software packages which want all the system memory. The Consulting
Log cooperates with Borland's SideKick perfectly if The Consulting Log is
installed first. However, both utilities combined occupy over 90k of memory
(see warning above).

If a compatibility problem occurs, please report it to the above address.

Customization of the database record structure for your organization's
specific needs can be made for a $30.00 processing fee. Contact the
University of Kansas at the address above for more information.

Coming Soon:

                        A MACINTOSH DA !!!

                              and

                     The Consulting Log V2.0

      Including
                   --  User defined record structures (modify and add to
                       the fields to meet your current needs, define other
                       records structures and load them on the fly)
                   --  Pop-up help windows (user-defined to meet your
                       current needs)
                   --  Pop-up field validation lists (allowing the user to
                       choose from a predefined list of values in order to
                       force conformity of data among all the consultants)

Contact the above address for more information.


Software License Agreement
-------------------------------------------------------------------------------

The University of Kansas retains the the copyright protection for
The Consulting Log. The executable binary file of The Consulting Log
is available free to all accredited colleges and universities and
may be distributed by any medium available, as long as this
notice accompanies the program. The executable file may not be sold
or bundled with another product as motivation to purchase the other
product.

Private and commercial organizations (those who are not directly
associated with an accredited college or university) may receive
free copies of the Consulting Log for review demonstration
purposes only. The University of Kansas requires a $100.00 usage
fee from private and commercial institutions before they place
this program into production.

The University of Kansas provides the executable and source code
versions of The Consulting Log "AS IS" without warranty of any kind,
either expressed or implied, including the implied warranties of
fitness for a particular purpose or merchantability and The
University of Kansas shall not be liable for any tort, indirect,
special or consequential damages such as loss of profits, or loss
of goodwill from the use or inability to use the software for any
purpose.