home *** CD-ROM | disk | FTP | other *** search
/ PSION CD 2 / PsionCDVol2.iso / Programs / 623 / BIKLOG5.TXT < prev    next >
Encoding:
Text File  |  2000-01-16  |  12.1 KB  |  315 lines

  1.             BIKLOG5    V 2.3
  2. ********************************************************
  3. *        For the Psion Series 5 and 5mx.               *
  4. ********************************************************
  5.  
  6. (Copyright, ╕ Jaap Laméris. Januari 2000)
  7.  
  8. INTRODUCTION
  9. ============
  10.  
  11. BIKLOG5 is a program made for bicyclists who like to keep
  12. track of their bicycle rides during time. It is not meant
  13. to be used during the ride as a cycle computer but as an
  14. extension of it to store the cycle computer data and as
  15. a tool to analyse the bicycle rides over time.
  16.  
  17. With some renaming of the definitions of the type of bicycles
  18. used and riding type, it may be used even for thriathletes by
  19. renaming the bicycle names in "swimming", "biking", and "running"
  20. and adapting the bicycle ride names into appropriate terms like
  21. "training", "race", "intervals" etc.
  22.  
  23. This program is based on the original program Biklog3,
  24. which was my first major attempt at programming in OPL.
  25. It was then completely developed on my Series 3a with the
  26. aid of the S3a emulator. When I later purchased a S5,
  27. I ported it to the Series 5 and extended it with the
  28. additional capabilities of the S5 (namely, pen operation,
  29. printing capabilities and a better database management).
  30. In version V2.1 I have included some more options,
  31. more statistical output and a way to keep track of the
  32. rides ridden versus a goal set for # of rides and bicycle
  33. distance set for the year.
  34.  
  35. I have tried to make the program to be user friendly as far
  36. as possible, and have released it after a long period of
  37. using it myself (during more than a year).
  38.  
  39. This program is freeware, not because I don't need the
  40. additional income or fancy the merits of this program, -
  41. I spent a large amount of time and effort in creating and
  42. debugging this program -, but charging for something I wrote
  43. as a hobby and for fun is not my style. Further by making it
  44. freeware (or better said postcardware, see the section
  45. REGISTERING) I will not be forced to spent considerable time
  46. in maintaining and supporting it just for the sake of getting
  47. a small additional income. That doesn't mean that I will not
  48. support it anymore. As an user of BIKLOG5 myself and as a
  49. perfectionist by nature I will keep improving the program and
  50. supporting any users of it. Another reason to release it as
  51. freeware are some bad experiences in the past with shareware
  52. (PSION and PC) programs for which I paid the registration,
  53. after which the author did not support it any more, released
  54. it as freeware or kept charging for updates despite his
  55. earlier promises... .
  56.  
  57.  
  58. INSTALLATION
  59. ============
  60. Below is a list if files supplied in the distribution ZIP
  61. file (The file biklg523.ZIP) and the directories
  62. they should be placed in after the installation.
  63.  
  64. biklog5.sis                         SIS installation file
  65. biklog5.txt                         this file
  66.  
  67. If using Psiwin 2.x within windows then just click on the biklog5.sis
  68. file. The program will appear in the "normal" Extras Bar after the
  69. installation. Alternatively, you may copy the BIKLOG5.SIS to your EPOC
  70. machine and double tab it. If installing from somewhere other than
  71. Windows then you will need to obtain INS_TE.EXE and install that on
  72. your EPOC32 machine. This will enable .SIS files to be decoded using
  73. the EPOC32 machine.
  74.  
  75. After installation you should have on your machine the following files:
  76. * = C or D
  77. *:\system\app\biklog5\biklog5.APP       Main application file.
  78. *:\system\app\biklog5\biklog5.AIF
  79. *:\system\app\biklog5\biklog5.MBM
  80. *:\system\app\biklog5\biklog5.HLP       BIKLOG help file.
  81. c:\system\app\biklog5\bike.ini          default configuration file
  82. *:\biklog\example                       example database
  83. c:\system\app\biklog5\example.ini       example configuration file
  84.  
  85. Except for the *.ini files, all other files may be located on the
  86. C or D drive. The database files may be located in any (sub)directory,
  87. (from V2.2 on). The directory "*:\biklog\ " is recommended to be the
  88. location for the database file.
  89.  
  90.  
  91. USAGE
  92. =====
  93.  
  94. Most of the information you may need on how to use
  95. BIKLOG5 is included on the on-line help.
  96.  
  97. Here is a short description of all hot-key presses
  98.  
  99. Ctl-O    Open existing file
  100.        - Always required, except when creating a new file. Enter
  101.        filename or use TAB or cursor to cycle through existing
  102.        files
  103.  
  104. Ctl-N    Create a new file
  105.         - After entering the name and location of the new file,
  106.        you will be asked to enter the names of up to four
  107.        bicycles in your household, and the type of bicycle rides
  108.        you want to tag to your rides (like commute, training,
  109.        race, clubride). Maximal five ride definitions are possible.
  110.  
  111. Ctl-C    Close the current file
  112.        - Only needed if you want to switch to another database file,
  113.        or to delete the current file.
  114.  
  115. Shft-Ctl-D    Delete a file
  116.  
  117. Shft-Ctl-S    Sort current file
  118.        - This will sort the records according to ascending date.
  119.        The plotting option assumes that the records are sorted by date!
  120.        If you get strange effects with the graphs, just do a sort.
  121.  
  122. Ctl-A    Add a record
  123.        - Here you enter the date, bicycle name, bicycle ride type, distance,
  124.        time or average speed and a short descriptions (max. 40 characters)
  125.        of the ride. By default the current date and the values of the last
  126.        entered record will be entered. You may choose to enter average speed
  127.        or time. Either one is sufficient.
  128.  
  129. Ctl-S    scan records
  130.        - Here you will see a listing of all rides present in the database,
  131.        according to the filter settings set after entering this mode
  132.        (time period and bicycle type).  All the filtered records will be
  133.        listed line by line. Use the cursor up, down, and the PgUp or PgDn
  134.        keys to move or scroll up or down, respectively.
  135.        HOME or END will move to the first or last record. ESC will exit the
  136.        scan mode, while "s" will present some statistics of the data
  137.        in the database. Any other key will invoke a listing of possible
  138.        actions.
  139.  
  140.  
  141. Shft-Ctl-A    Alter a record
  142.  
  143. Shft-Ctl-E    Erase a record
  144.  
  145. Ctl-F    Find a string in the records
  146.        -Use this option to find a string in the memo field of one or more
  147.        records
  148.  
  149. Ctl-G    Plot the (cum.) distances per bicycle or ride type
  150.        -You will be prompted to enter starting and ending date of the time
  151.        period, and the time unit along the x-axis (day, week or months).
  152.        By default the starting date will be January 1th of the year of the
  153.        first record, and the ending date will be the current date.
  154.        Cumulative distance plots will be presented for each of the available
  155.        bicycles (with more than 0 km) in the database plus all bicycles
  156.        together. Use the up and down cursor keys to cycle through the plots,
  157.        ESC will return to the menu. Each other key will invoke a listing
  158.        of possible actions.
  159.  
  160. Ctl-V    Preferences settings
  161.        -use this option to customise the bicycle names, ride definitions,
  162.        unit of distance (kilometer or mile), and the goals in terms of
  163.        number of kilometers or miles and the number of rides set in a year.
  164.        A message wil show up when each goal has been reached.
  165.  
  166. Ctl-I    Info on program
  167.  
  168. Shft-Ctl-H    Help function
  169.  
  170. Ctl-T    Statistical description of rides
  171.        -Four tables will show you some common statistics (# of rides,
  172.        cumulative and mean distances and duration for each bicycle and
  173.        ride type in the database, absolute and relative to the total
  174.        bike rides. Additionally the total distance ridden per month
  175.        and bicycle type is shown, while the last table will present
  176.        some statistics of the rides (longest, shortest, fastes and
  177.        slowest)
  178.  
  179. Ctl-E    Exit
  180.  
  181. Ctl-U    UPGRADE from older versions
  182.        From version 2.3 on the datafile created in BIKLOG5 is an
  183.        official BIKLOG5 document, enabling to immediately open
  184.        this file by double tabbing on the icon of the datafile.
  185.        UPGRADE will convert old datbasefiles, to be recognized by
  186.        a question mark, to BIKLOG5 documents. A backup file with
  187.        the extension ".bak" will be created in the original directory.
  188.  
  189. In addition the printing option lets you invoke the regular Psion 5
  190. printing mode. Please note that you must have invoked first the scan mode
  191. to be able to print the tabular data. At this moment only the tabular
  192. data of the scan option is possible to print. For printing the plots or
  193. the other statistics, use the print screen option: (Shft-Ctl-Alt-S) to make
  194. a regular MBM file.
  195.  
  196. I do recommend that you use the online help, at least until
  197. you become familiar BIKLOG5.
  198.  
  199.  
  200. Future Improvements
  201. ===================
  202.  
  203. -- The scroll bar feature is not really working well and needs some
  204.    improvement.
  205. -- More plotting options.
  206. -- Adaption for thriathletes (is already possible in rudimentory form by
  207.    renaming the bicycle names in "swimming", "biking", and "running" and
  208.    adapting the bicycle ride names into appropriate terms like "training",
  209.    "race", "intervals" etc.
  210. -- Anything you as user will suggest that is worthwhile and shared at least
  211.    by one other user!
  212.  
  213. ACKNOWLEDGEMENTS
  214. ================
  215.  
  216. Thanks to Jezar for providing the Help generator, Neil K Bee (neil@bee.net)
  217. for the use of one of his icons, and all other PSION programmers, especially
  218. Steve Litchfield and Al Richey with their RMREVENT program, who gave me
  219. examples of goord working programs.
  220.  
  221.  
  222.  
  223. REGISTRATION
  224. ============
  225.  
  226. WHY REGISTER ?
  227.  
  228. Although BIKLOG5 is freeware, I would be very happy if you let me know that
  229. you are going to use my programme. First of all to satisfy my curiosity, after
  230. putting numerous hours and effort in writing and debugging this program.
  231. Secondly it will encourage me to continue further with this program and
  232. extend it if you indicate a need for this. Thirdly I will be able to keep
  233. you informed on next releases of BIKLOG5, if you registrate it by me.
  234.  
  235.  
  236. HOW DO I REGISTER ?
  237. Preferably you can send your name, adress and/or Email adres
  238. by Email to:
  239.  
  240. Jaap Lameris
  241. lamerisj@hotmail.com
  242.  
  243. Else you can send a postcard to:
  244.  
  245. Jaap Lameris
  246. Richel 10
  247. 8303 KX EMMELOORD
  248. Netherlands.
  249.  
  250. Please include in your registration note,  the version number you got,
  251. your postal adress and Email adress.
  252.  
  253. Additional information on BIKLOG5 will be also available on my homepage:
  254.  
  255. http://Jaap_Lameris.tripod.com/mypsion.htm
  256.  
  257.  
  258. DISCLAIMER
  259. ==========
  260. Use this software at your own risk. I will not be held
  261. responsible for any loss of data and/or any damage caused
  262. to users or hardware caused by this software.
  263.  
  264.  
  265.  
  266. COPYRIGHT AND CONDITIONS
  267. ========================
  268. I reserve copyright on this material, any reproduction in
  269. part or whole is strictly prohibited. Additionally,
  270. reverse translation of any of files included in the file
  271. "BIKLG523.ZIP" is strictly prohibited.
  272.  
  273. You are permitted to distribute the file "BIKLG523.ZIP",
  274. as widely as you see fit, under one condition. That
  275. condition being; That the file is not in any way altered,
  276. and is sent on in an unchanged state.
  277.  
  278.  
  279.  
  280. FEEDBACK
  281. ========
  282. If you have any comments or suggestions for me I would be
  283. pleased to hear from you ! You can mail me at the above
  284. address or you can email me at these email addresses;
  285.  
  286.          lamerisj@hotmail.com
  287.               or
  288.            lameris-molhoek@hetnet.nl
  289.  
  290. Now get on and start bicycling !!!
  291.  
  292.  
  293. HISTORY
  294. =======
  295. Version 2.3 (Jan. 16, 2000):
  296. The duration of single rides in the SCAN and STATISTICS modes is now being
  297. expressed as hours:minutes format. The datafile generated by BIKLOG5 is now a
  298. BIKLOG5 document, e.g. the datafile can be opened automatically in BIKLOG5 by
  299. double tabbing on the icon of the database file. An upgrade module is provided
  300. in BIKLOG5 to convert databases generated with earlier versions to BIKLOG5
  301. document. A backup file with extension ".bak" will be generated.
  302.  
  303. Version 2.2.1 (Dec. 21, 1999):
  304. Minor bugs fixed. It is now possible to use any directory name to place your
  305. datafile. Also it is now possible to enter riding time in hours + minutes.
  306.  
  307. Version 2.1 (Nov. '99):
  308. Major upgrade from original version.
  309.  
  310. Version 2.0 (Aug. '99), original version, not published in public domain:
  311. Based on the original Series 3 version (Biklog3 V 1.1).
  312.  
  313.  
  314.  
  315.