home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Programming / Basic / OTL-BBU4.DMS / in.adf / TRI-ANALYSE / README.doc < prev    next >
Encoding:
Text File  |  1993-06-25  |  11.0 KB  |  288 lines

  1. Tri-Analyse... Documentation for the user.
  2.  
  3.  
  4. ------------------------------------------------------------------------
  5. ========================================================================
  6.  
  7.  
  8.                  I   M   P   O   R   T   A   N  T
  9.  
  10.  
  11. This is the documentation on how to USE Tri-Analyse, READ it as this
  12. programme has some peculiarities that you need to know about it. If
  13. you have recieved this programme as part of the Blitz User Magazine,
  14. then a description of the PROGRAMMING involved and Blitz techniques
  15. etc is printed in the magazine.
  16. ------------------------------------------------------------------------
  17.  
  18. This part of the documentation is for the Triathlete who wants to use
  19. the programme to monitor his training.
  20.  
  21. PART 1: System Requirements
  22.  
  23. Amiga 500/600/2000/3000/1200/4000 with 512k mem (1 meg recommended)
  24. A hard drive is also nice though not necessary.
  25.  
  26. PART 2: Making a Bootable floppy disk for Tri-Analyse
  27.  
  28. The Standard WBench 1.3 or 2.04 boot disk can be used, simply strip off
  29. all the utils you dont use, all the prefs etc, change the startup-sequence
  30. to a simple LoadWB, copy all the Tri-Analyse stuff to df0:, install a copy
  31. of your favourite text editor (one that does NOT run as a background task)
  32. make sure the fonts provided go into your FONTS: drawer, and you should be
  33. away, make sure you leave the Wbench libs and devs there, also makesure (if
  34. you are running 1.3) that you have the RUN command in your c: directory
  35.  
  36. I have tested Tri-Analyse under WB 3 / 2.1 / 2.04 / 1.3 and am 99.99% sure
  37. it will run ok under 1.2, so if you follow above directions you should be
  38. fine.
  39.  
  40. PART 3: Installing to a HDD
  41.  
  42. Assuming you have the standards libs: and devs etc on your bootable hardrive
  43. then simply copy the fonts supplied with Tri-Analyse to your FONTS: directory
  44. and Make a dir for Tri-Analyse somewhere on your HD and copy all the rest of
  45. the files in this archive to there.
  46.  
  47. PART 4: OK, what the hell is this programme.
  48.  
  49. This programme is something I knocked up for my self to allow me to easily
  50. set up/recall a Triathlon training system on a monthly basis, It also has
  51. a graphing facility so that I can save my resting heart-rate for the day
  52. and view it in a graphical form for the month.
  53.  
  54. WARNING: I knocked this up in a couple of days, therefore the way it does
  55. things is a trifle cheesy (I don't mean it does nasty things to your system
  56. simply that I took the lazy way of doing a couple of things. So the system
  57. is not SUPER FLASH, however it's the best thing Ive found for keeping a
  58. training diary (used to use WordPerfects Calender) and its quite reliable
  59. once you get used to it.
  60.  
  61. PART 5: MORE IMPORTANT STUFF
  62.  
  63. a) make sure when you start Tri-Analyse that you are IN the actual
  64.    directory it all resides in (opening wbench draws and starting it
  65.    from the WBench does it automatically) if you start from the CLI
  66.    and say Tri is in dh0:applications/databases/training/
  67.  
  68.    If you start Tri when you reside in dh0: you are going to have no
  69.    joy whatsoever, so CD to dh0:applications/databases/training/
  70.    and THEN start it
  71.  
  72. b) you need a RAM: disk called RAM:
  73.  
  74.    This is because I save temporary files there, if you dont have one
  75.  
  76.    a) Make one
  77.    b) assign ram: to somewhere on your system (it only ever creates one
  78.       temporary file and keeps on writing over it so it wont use much
  79.       space.
  80.  
  81. c) Make sure you installed the fonts supplied to FONTS:
  82.  
  83. d) Make sure the text editor you use does not run as a detached task
  84.  
  85.    As this was originally intended as my use only thats no probs, however
  86.    If you use Cygnus-Ed or similar either start it using your Tri-Analyse
  87.    prefs with a switch that makes it non background (if you can) or use
  88.    a non background editor like Blitz 2's TED or commordores ED (if you
  89.    have to.....)
  90.  
  91. e) if you run pre 2.04 OS then makesure RUN is in the C: directory
  92.  
  93. Phew now it should work
  94.  
  95. PART 6: How to use it
  96.  
  97. Assuming you have installed it correctly, when you either
  98.  
  99. a) click on the Tri ICON or
  100. b) execute the Tri programme from the CLI
  101.  
  102. you should be presented with a big screen full of gadgets and stuff
  103. this is the main Tri-Analyse screen. If this does not appear.. go to
  104. the OH GOD IT DONT WORK section.
  105.  
  106. If this is the first time you have run it, it will moan about to PREFS
  107. file for it, thats ok, you just need to set up your default text editor
  108. for it. more on that later
  109.  
  110. If you are used to Amiga applications everything should be very obvious
  111. if you are a seasoned Tri-Athlete, the terminology on some of the gadgets
  112. will be obvious too. Lets go through them all
  113.  
  114.  
  115. EDIT INFO. This gadget is used when you have selected a discipline and
  116.            a type of training and a valid date, then you click this button
  117.            to start your text editor of choice, and enter that training.
  118.  
  119. SAVE INFO. This saves a data file for the current open month.
  120.  
  121. QUIT       This quits Tri-Analyse, if you have a data file open, it will
  122.            ask you if you wish to save it before you quit.
  123.  
  124. EDITOR.    This is where you enter the command line prefs for your text
  125.            editor, simply if your editor was TED and it resided in
  126.            ROOT:blitz2/ you would enter in here.
  127.  
  128.            ROOT:blitz2/ted
  129.            Dont enter trailing spaces or a filename here or it will muck up
  130.  
  131. FONT.      This is disabled, its never been used and never will be :-)
  132.  
  133.  
  134. DATE.      If you want anything to work then this is the one you have to set
  135.            up, if you do not enter the date in DD/MM/YY format here none of
  136.            the other gadgets will do anything. The date automatically creates
  137.            training files for a new month, and if you change months, saves the
  138.            old month before loading a new one. ie: its automatic, however when
  139.            you quit out of the programme, choose to save the last month of data
  140.            as otherwise its gone.
  141.  
  142. RHR.       This is where you enter your resting heart rate in the morning, ie:
  143.            take your pulse for a minute when you first wake up and put it in
  144.            here. Your only allowed 3 numbers but that's ok cos if you had a
  145.            heartrate of 999 you'd be well and truly dead..... :-)
  146.  
  147.  
  148. DISCIPLINE Simply click on which discipline gadget you want to read/enter
  149.            training for.
  150.  
  151. TYPE.      Click on what type of training you are doing
  152.  
  153. READ TO... Click on read todays training to... DA DA DA read the training for
  154.            the specified discipline on the specified day
  155.  
  156. GRAPH MO.. Click on this to display a Graph of you resting heart rate over
  157.            the currently active month.
  158.  
  159.  
  160. Ok assuming you have followed me this far lets run through entering
  161. a training session
  162.  
  163.  
  164. First of all enter a date (ie 15/12/93) and press return
  165.  
  166. Now click on what discipline you are training (you can do all 3
  167. each day if you want) say CYCLING
  168.  
  169. Now click on what type of CYCLING training you are doing ie (SPRINT)
  170.  
  171. Now click on edit info to type in your training for the day and save
  172. it using your editors save command (should be called ram:temp if your
  173. editor takes filenames as command line arguments, if it doesn't, use
  174. a different editor, sorry.....
  175.  
  176. Now enter your resting heart rate for the day (say hmm... 38 nice and fit)
  177.  
  178. Ok now if you were also doing running that day then you could click on
  179. RUNNING and the type (say ENDURANCE) and go through and edit that type
  180. of training. Note you only do your heartrate once as you only have one
  181. resting heartrate.
  182.  
  183. Ok now click on save data (writes the info to disk)
  184.  
  185. Now if you click on CYCLING for that date the type of training will jump
  186. to SPRINT cos thats what you said you were doing, try Reading the days
  187. training, a nice little text reader should pop up and show you it.
  188.  
  189. Try graphing your resting heart rate for the month.
  190.  
  191. ---------------------------------------------------------------------
  192.  
  193. We've now covered all the features, although I'm sorry very briefly. You
  194. should now understand how to enter stuff for a month, you can change dates
  195. re-alter your training types, etc etc as many times as you like, just
  196. experiment and you'll soon have it sussed. Just one or two quick notes
  197. before I leave. (Ive just come off a 16 hour shift at work and its time to
  198. get some zzzzzzzzzz's)
  199.  
  200. a) when entering text you can put a backslash then a quick desc and when its
  201.    viewed back in the text editor that will pop up as a gadget down the bottom
  202.    where if you click on it you will be taken to that part of the text ie:
  203.  
  204.    \REMEMBER!
  205.    To put your shoes on when you go running
  206.  
  207.    Will put a REMEMBER! Gadget down the bottom that if you click on it will take
  208.    you to the 'To put your shoes...' part of the text. A little HyperText type
  209.    of thing.
  210.  
  211. b) If it looks like the wrong stuff is going in the wrong date remember when you
  212.    activate a string gadget. (A gadget you type into) you must finish your entry
  213.    by pressing RETURN, NOT JUST BY CLICKING THE MOUSE ON ANOTHER GADGET!!!!
  214.  
  215.    This is how the amiga handles string gadgets, if you dont press return then
  216.    its just like you have not entered the data. Therefore if you for example
  217.    correctly entered a date of 01/01/93 <RETURN> entered a heart rate of
  218.    50 <return> then entered 03/01/93 <FORGOT RETURN> and entered a heartrate
  219.    of 30<return> you would have actually altered the heartrate for the
  220.    01/01/93 so remember those returns....
  221.  
  222.  
  223. Ok by now, the way I've described this thing, you probably thing you don't
  224. want to even try it, however, if you have had a bit of amiga experience
  225. its a piece of cake to use, and dare I say it, actually quite nice to use too.
  226.  
  227. I am assuming you know what the use of monitoring your resting heart rate is
  228. (its the best indicator that you are getting fitter if it drops and that you
  229. are over-training or have a bug, if it suddenly rises. If you do find this
  230. programme usefull, dont send me money or anything (wouldn't be cheeky enough
  231. to expect any for it!!
  232.  
  233. But I would like.
  234.  
  235. a) Photocopies of any interesting Training articles, techniques, programmes
  236.    that have worked for you.
  237.  
  238. b) Someone to write some DECENT docs for this once they are familiar with it
  239.  
  240. ---------------------------------------------------------------------------
  241.  
  242. THE OH MY GOD IT DOESN'T WORK SECTION
  243.  
  244. a) Don't even see the initial screen
  245.  
  246.    - Moved your fonts to the right place?
  247.    - is diskfont.library in your libs: drawer?
  248.    - are you in the directory with all of tri's files
  249.  
  250. b) My text editor is not starting up
  251.  
  252.    - Make sure its NOT a background process one
  253.    - Make sure your prefs are set and correct
  254.    - Make sure your editor accepts a command line argument for the filename
  255.    - Make sure there are no trailing spaces or chars in you prefs string
  256.    - If pre 2.04 OS make sure RUN is in the c: directory
  257.  
  258. c) I cant get a graph up
  259.  
  260.    - is the file graftemplate in your current dir?
  261.  
  262. --------------------------------------------------------------------------
  263.  
  264. Credits/Abuse
  265.  
  266. Roger Lockerbie (ME) I wrote it, and I wrote this awfull documentation
  267.  
  268.  
  269. Send Training info, friendly letters, Cannondale 2.8 bycycles <GRIN> to
  270.  
  271. Roger Lockerbie
  272. 1/38 Rutland Rd
  273. Mt Wellington
  274. Auckland
  275. New Zealand
  276.  
  277. Send ABUSE to NIL:
  278.  
  279. Seeya.... and happy training.
  280.  
  281. Roger
  282.  
  283.  
  284. PS: Sorry about the spelling and punctuation, it's never been my strong point.
  285.  
  286.  
  287.  
  288.