home *** CD-ROM | disk | FTP | other *** search
/ AMOS PD CD / amospdcd.iso / 351-375 / apd358 / address.doc < prev    next >
Text File  |  1991-10-06  |  7KB  |  128 lines

  1.  
  2.         Documentation for ADDRESS.AMOS - Written by Kevin E.A. Hall
  3.         ===========================================================
  4.                   (With assistance from Peter Cartwright)
  5.  
  6. This was written purely because I kept losing my fellow AMOS hacker Peter 
  7. Cartwright's address, and was getting fed up with it. I had an old routine 
  8. that 'pressed' graphic buttons in when clicked on and Pete had very kindly 
  9. helped me out with a bug I'd had with it, so I decided to use it in an 
  10. address book program.
  11.  
  12. This program is PD, all I ask is the usual waffle of 'Leave my name in as 
  13. original author if you change the program' and also leave the documentation 
  14. complete if you should upload this program into a BBS.
  15.  
  16. How to use it
  17. =============
  18.  
  19. I've implemented mouse use as much as possible. The only essential keyboard 
  20. input needed is for the actual data entry and the need to press a key after 
  21. using the mouse to select a record to jump to. Due to suggestions by Pete
  22. Cartwright V1.2b onwards have an extended keyboard option. (EKO)
  23.  
  24. I have written the data entry so that moving the mouse off a button will 
  25. automatically end your input (But will retain input so far - not clear it) 
  26. There is no need to hit return, but you can if you want. 
  27. When you've finished filling up a field you can move the mouse pointer onto 
  28. the next field to finish input and press the left mouse button to select that
  29. new field. The current selected field will also automatically cut input if 
  30. you have filled it with the maximum allowed number of characters. 
  31. EKO is brought in by selecting a field with the mouse, and then using purely
  32. the keyboard to enter records. You hit either the RETURN key or fill the field
  33. with data and the program will automatically select the next field and 'move'
  34. the cursor into it ready for data input. 
  35. The option to move the mouse off the field and enter data into other fields
  36. first is always available for data entry. (As is EKO)
  37.  
  38. After you have filled all the fields you want to on a record, you must click
  39. on the ADD button at the bottom of the screen, unless you are using EKO
  40. whereas ADD will be selected for you when you finish with the last field.
  41. The first field of the next record will now become active.
  42.  
  43. Using the mouse on the ADD button also applies if you are altering a record, 
  44. only more so. A very quick and dirty way I found to stop a bug that kept 
  45. happening when altering records was to turn off both the menus and EKO until
  46. ADD had been selected. Therefore if you select ALTER from the menu, you have
  47. to click the mouse on each field you wish to change. (Sorry, but i've always
  48. been a hacker and no doubt always will!)
  49.  
  50. For V1.2a, I added the ability to enter phone numbers, however due to the
  51. screen size I didn't have enough room left on screen to fit a nice graphic
  52. phone number button. (Unless I did a major rewrite and I ask you honestly 
  53. would it be worth it?!) So the result was an extra menu option that lets you
  54. enter phone numbers. The plus side of doing it from menus means that phone
  55. numbers can be changed at almost any time. The minus is that you can't change
  56. them when you have chosen 'ALTER' from the records menu! 
  57. Yeah I know, I'm weird - But what the hell!
  58.  
  59. If you totally fill up the address book (Set to 100) a window will open
  60. telling you so and then the save data file requester will come up.
  61. After the file has saved, the program will give you the choice to reset.
  62. for you to continue with a new book, or to leave it, enabling you to look
  63. through your book. And although data can be typed into record 101 it
  64. cannot be added to the address book and the record will revert back to record
  65. 100 after each attempt to add data to record 101. I put that in to get the
  66. fact across that when I say your book is full I really mean it is FULL!
  67. If you need to change entries in a full book, it can be loaded as normal
  68. and you will have access to everything except the option to ADD it.
  69. (Unless you are either using ALTER then add will work for those records only
  70.  or if you first delete some records - You can then add back to 100 again)
  71.  
  72. The records menu allows full control over selecting or changing records. 
  73. (and it was the easiest to write so it's the bit i'm happiest with!)
  74. You can also, by using the left and right arrow keys, quickly advance
  75. or go back a record. By keeping the key pressed you can rapidly skip
  76. though a database.
  77.  
  78. The search option has been upgraded a lot from V1.1. Before it used to stop
  79. at the first matched string and then show that record. Now it displays all 
  80. matched strings found in a window, along with the record number and after
  81. you have pressed the left mouse button will display the first record found.
  82. All subsequent left button presses will show the next record found. This 
  83. continues until it has displayed all matched records, or you attempt to 
  84. select a menu option. 
  85. V1.2b onwards will find all matched strings regardless of case.
  86.  
  87. Good ol' Pete came back with some suggestions after using V1.2a and I have
  88. implemented all of them. 
  89. Pete had pointed out the iffy case coding in the search, and as mentioned 
  90. above it has been corrected.
  91. He also pointed out a flaw in record entry. It would allow you to enter blank 
  92. records - It now needs a minimum of forename, surname and address line 1. 
  93. Pete also wanted to see a cursor when entering data, this has been included 
  94. (Mainly 'cos it was so easy to do - And not a Curs On in sight!)
  95. The biggest request that Pete made, and caused me the most hassle, was EKO.
  96.  
  97. Also thanks must go to Pete for solving a Load/Save problem I'd had, by 
  98. writing the routine that the ADDRESS.AMOS program uses.
  99. I have also added a short line that will add a .DAT onto the end of the file
  100. if a file extension is not put in your save filename. All saves and loads
  101. expect the filename to have a .DAT extension, so they're set to only show
  102. you files that have a .DAT extension. It's a good habit to get into!
  103. One point - Do not include commas into your data you input into a record.
  104. Because of the way Pete's routine works, a comma will confuse it no end.
  105.  
  106. This program took about ten evenings (off and on) to write.
  107.  
  108. This should be the final version. I really do have better things to do in an 
  109. evening you know!!
  110.  
  111. I can be contacted at this address:
  112.  
  113. 127 Buckingham Road
  114. Norwich, Norfolk
  115. NR4 7DF
  116.  
  117. Or by Email on CIX :  kevinhall
  118.  
  119. Kevin Eric Anthony Hall (Laugh and die!)
  120. Irrelevant Software
  121. (We're not just irrelevant - We're useless too.)
  122. 19th September 1991
  123.  
  124. Irrelevant Software - Writers of all things irrelevant on : 
  125. DEC VAX, IBM PC, C= Amiga, Sinclair Spectrum, Amstrad CPC. 
  126.  
  127. Shut up Ken, I'm not going to tell them about your Oric 1...
  128.