home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / database / joggr103.zip / JOGGER.DOC < prev    next >
Text File  |  1990-10-01  |  8KB  |  199 lines
  1.  
  2.  
  3.                 JOGGER
  4.  
  5.                   by
  6.  
  7.                   Mark Hobart
  8.  
  9.                   October 1990
  10.  
  11.  
  12.  
  13. Introduction
  14. ------------
  15.  
  16. This file contains instructions on installation and operation of JOGGER.
  17. To install and run JOGGER create a directory called jogger and copy all
  18. files in this posting to it. The manifest is
  19.  
  20.     jogger.exe         the binary
  21.     runs.dat        run database (sample)
  22.     courses.dat        courses database (sample)
  23.     README            overview and ShareWare details
  24.     CHANGES            list of changes made in past versions
  25.     CATALOG            list of software available from me.
  26.     jogger.doc        this file
  27.  
  28. Note, licensed users will also receive a file called "license.txt".
  29.  
  30. You should now change to the jogger directory and type "jogger". For subsequent
  31. use see the installation tip at the end of this file.
  32.  
  33. JOGGER now displays information on how to become a registered user and will do
  34. so every time you access the main menu screen.  To clear the screen and proceed
  35. each time it's displayed simply click the left mouse button or press the space
  36. bar.  When you become a registered user I'll send you instructions on how to
  37. stop it by return of post. 
  38.  
  39. Main Menu screen
  40. ----------------
  41.  
  42. This screen is a top level menu and allows you to select the action you wish to
  43. perform.  Simply click the left mouse button in the appropriate box or press
  44. the number of the action you desire and you'll see the action become
  45. highlighted (it's best in colour).  Repeat the selection and that action is
  46. then processed.  Selecting another box will highlight that option.  To exit the
  47. program at this point simply click in the "Quit" box or press the "Esc" key or
  48. the letter 'q'. 
  49.  
  50. Hot Keys
  51. --------
  52. As of version 1.03 there is support for hot key sequences. This enables systems
  53. without a mouse to use JOGGER. I'll explain here the simple conventions used.
  54.  
  55. Throughout the program "Esc" can be used as a hot key for "Quit" if the option
  56. box for "Quit" is displayed.  Other hot keys are often the first letter of an
  57. option eg.  "Cancel" would be 'c' or the uppercase letter highlighted eg. 
  58. "saVe" would be 'v'.  However, the exception is "Help".  Whenever this option
  59. is displayed the hot key "F1" should be used.  Of course if you have a mouse
  60. then you can use that to select any option as well. 
  61.  
  62. Screen 1 - Enter run data
  63. -------------------------
  64.  
  65. This screen allows you to enter details of a run.  Simply type in the details
  66. requested for each boxed field.  Clicking on "help" with the mouse or using the
  67. "F1" hot key will display a pop up window that contains a list of courses and
  68. course codes in case you can't remember the code.  Once you've entered the
  69. appropriate text you'll automatically be moved to the next field. 
  70. Alternatively, typing TAB or RETURN will move you to the next field (once
  71. sufficient data has been entered for the field).  Selecting "Quit" at anytime
  72. will abort the data entry and return you to the main screen (via the annoying
  73. box of course unless you're registered).  Once all data has been entered you'll
  74. be asked if it's ok.  Clicking in the "Ok" box or hitting the RETURN key
  75. accepts the entry and adds it to the database.  Clicking "Cancel" (or pressing
  76. the 'c' key) clears the fields and allows you to re-enter the data. 
  77.  
  78. Screen 2 - Display  runs
  79. ------------------------
  80.  
  81. This screen allows you to browse through the records of the run database in
  82. forward ( select "Fwd" box) and reverse directions (select "Back" box). 
  83. Selecting "1st" will take you to the first screen and "Last" will take you to
  84. the last screenful of data (unless you're already at the end of the data of
  85. course).  Selecting the sort box changes the way the records are sorted.  You
  86. can choose between "date" i.e.  chronological order or "course/time" where
  87. records are sorted in course alphabetical order with the best time at the top
  88. and the worst at the bottom.  Selecting "Quit" at anytime returns you to the
  89. main menu screen. 
  90.  
  91. Screen 3 - Display form graph
  92. -----------------------------
  93.  
  94. This screen displays a plot of form (y-axis) against date (x-axis).  Browsing
  95. of the graph is the same as for the screen 2 controls mentioned earlier. 
  96. Selecting "Last" will give a graphical view of current form.  
  97.  
  98. Form is calculated as follows
  99.  
  100.     form = 100 -    (time - best)
  101.               (  --------------  )  * 100
  102.                         (worst - best)
  103.  
  104. Screen 4 - Remove run data
  105. --------------------------
  106.  
  107. This screen is similiar to Screen 1 but this time a valid menu entry is used
  108. to delete ALL run database records matching the code and date supplied. The
  109. "Help" box displays a list of courses and dates attempted to help you fill in
  110. the fields.
  111.  
  112. Screen 5 - Display courses
  113. --------------------------
  114.  
  115. This screen allows browsing of the courses database. It displays course
  116. information as well as best and worst times for the course. Forward browsing
  117. only is allowed in this option.
  118.  
  119. Screen 6 - Enter course data
  120. ----------------------------
  121.  
  122. This screen is the screen 1 equivalent for the courses database.  You are
  123. invited to enter a name for the course (at most 20 characters) and the distance
  124. of the course in units of your own choosing.  However it's important to be
  125. consistent, ie. if you use miles enter the distance in miles for all courses as
  126. differing distance units cause the pace times to be wildly different for each
  127. course.  The course comment is an optional field for use if you want to say
  128. something about the course.  Eg.  "I'm never doing this again!". You've got 25
  129. characters. 
  130.  
  131.  
  132. Screen 7 - Edit/Delete course data
  133. ----------------------------------
  134.  
  135. This screen allows you to edit or delete data fields for a course database
  136. entry. You're invited to enter a course code and help is provided via the
  137. "help" box. Once the code is entered all the fields are filled in for the
  138. course and you're asked whether you want to "Edit" or "Delete" the
  139. entry. If you select "Delete" then the entry will be cleared and you'll be
  140. able to enter new course data for this code at a later date. (Note the course
  141. data will not be deleted if run database records exist that still use this
  142. codes course data. If this record is to be deleted then you'll need to
  143. remove all runs for the course using screen 4).
  144.  
  145. Selecting edit moves to the name field where you can either enter a new name or
  146. hit TAB or RETURN to accept the current field value.  This happens for
  147. subsequent fields until they're all completed.  At this point you'll be asked
  148. to accept what's been entered as the new record ("Ok" box) or reject it
  149. ("Cancel" box).  As with other screens selecting "Quit" terminates
  150. the screen and returns you to the main menu. 
  151.  
  152.  
  153. Screen 8 - Report generator
  154. ---------------------------
  155.  
  156. This screen allows you to browse and save to disk reports of the run and
  157. course data. You can generate two reports; one sorted by course/time and one
  158. in chronological order. The latter generates a monthly summary whereas the
  159. former generates a summary for each course. The generated report file
  160. "course.rep" or "date.rep" respectively can then be printed if required using
  161. the MS-DOS print command. The hot key letter for saving to disk is 'v'.
  162.  
  163. As of version 1.01 there is an enhanced browsing mechanism similiar to that
  164. used in screen 2 for displaying run records.
  165.  
  166.  
  167. Starting your own databases
  168. ---------------------------
  169.  
  170. Included in this posting are sample databases to help you evaluate the package. 
  171. If you're interested they're details of my runs! To start your own simply
  172. delete the "courses.dat" and "runs.dat" files and use JOGGER to enter new data. 
  173. The ".dat" files are binary files so don't try editing them! Remember to back
  174. up your database files from time to time. 
  175.  
  176.  
  177. Acknowledgements
  178. ----------------
  179.  
  180. Thanks to Alan Phillips for the mouse routines and interface suggestions.  Also
  181. Mark Anichebe for the form idea. 
  182.  
  183. Remember, "There's miles of miles!" so log 'em with JOGGER!
  184.  
  185.  
  186. Installation tip
  187. ----------------
  188. Create a jogger.bat file containing the following lines and put the file on
  189. your path. You'll then be able to run JOGGER from any directory.
  190.  
  191. cd <jogger-installation-directory>
  192. jogger
  193.  
  194.  
  195. My file contains:
  196.  
  197. cd \mark\jogger
  198. jogger
  199.