home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 425.lha / HyperDialer / HDial.Doc < prev    next >
Encoding:
Text File  |  1990-09-30  |  7.6 KB  |  227 lines
  1.                   HYPER DIALER Version 1.0
  2.                     © 1989 David Plummer
  3. -----------------------------------------------------------
  4.  
  5. Firstly.... 
  6.  
  7. Hyper  Dialer is NOT Public Domain.  It IS shareware, and as
  8. such may be freely distributed with a shareware option, with
  9. a  suggested  contribution  of  $15.   Full  source  code is
  10. available for $25.  See the ABOUT menuitem for the address.
  11.  
  12. Permission is granted to copy Hyper Dialer provided that all
  13. copyright notices and credits are left intact, including but
  14. not  limited  to this documentation file.  Copies may not be
  15. distributed  for  profit,  although  a reasonable fee may be
  16. charged for on-line time or media costs.
  17.  
  18. Express permission is hereby granted to Fred Fish to include
  19. this program, documentation, and support files in his
  20. freely distributable software library.
  21.  
  22. It may only be uploaded to BBS systems or included on public
  23. domain distribution disks in the un-altered form with all
  24. files intact:
  25.  
  26. HDial
  27. HDial.doc
  28. HDial.config
  29. HDial.phones
  30. req.library
  31. Install
  32. DeInstall
  33.  
  34. The  requester library is copyrighted by Colin Fox and Bruce
  35. Dawson.  The library is a freely distributable, although not
  36. public  domain library.  Deepest appreciation is extended to
  37. these  authors  whose contribution to Amiga software authors
  38. is irreplaceable.  Thanks for the prop gadget sizer, of all 
  39. things!
  40.  
  41. Here's the quote from the req library docs:
  42.  
  43.  " Req.library was written by Colin Fox (of Pyramyd Designs)
  44. and Bruce Dawson (of CygnusSoft Software).  Req.library is a
  45. freely  distributable library that may be used in commercial
  46. products  without paying any royalties.  We encourage you to
  47. use  the  requester library in all of your programs, to make
  48. them easier to write, and to use.
  49.  
  50.     Req.library  is  not  public  domain.  The requester
  51. library  and  all documentation and example programs are all
  52. copyright 1989. "
  53.  
  54. ------------------------------------------------------------
  55.  
  56. What is Hyper Dialer?
  57.  
  58.    Hyper  Dialer  is  a "black-book" database for the names,
  59. addresses  and  phone  numbers  of all your best friends and
  60. worst  enemies.   It is completely Intuition-based, and will
  61. dial  your modem (if attatched) to initiate the call of your
  62. choice.  Other than to enter names, you need never hit a key
  63. (although  I  have  included  keyboard  equivalents for most
  64. functions).
  65.  
  66.  
  67. Installation
  68.  
  69. File        Directory
  70. ------          ---------
  71. HDial           (personal preference, usuallly C:)
  72. HDial.phones    S:
  73. HDial.config    S:
  74. req.library    LIBS:
  75.  
  76. The file Install handle all of this for you.
  77.  
  78. Starting Hyper-Dialer
  79.  
  80. Hyper  dialer takes only one command line option, that being
  81. the  ICON  option,  which  enables  you to have Hyper-Dialer
  82. begin  life  as  a  small  icon on your Workbench title bar.
  83. This is to enable you to place it in you startup-sequence if
  84. you so desire.  Other options are set with the config file.
  85.  
  86. Commands:       HDial      (start now)
  87.                 HDial ICON (start as an icon)
  88.  
  89.  
  90. Usage
  91.  
  92. To  use  Hyper-Dialer, hit the Insert icon to insert a blank
  93. entry,  which  will appear as 'Empty'.  Click on the 'Empty'
  94. and  edit  the  name,  address,  and  phone  number lines to
  95. reflect the data you require.
  96.  
  97. Delete will remove an entry, unless it is the last remaining
  98. entry.  In this case you must edit that entry to change it.
  99.  
  100. Search  will search for any substring in the entry list.  It
  101. looks  through  all  data  fields,  starting  at the current
  102. entry.   To  search  for the next occurance, click on Search
  103. again and simply select OK.
  104.  
  105. Sort  will  sort all entries according to their alphabetical
  106. order of the name field.
  107.  
  108. Load  will  load a HDPhones file.  It starts looking in your
  109. S:   directory.  Opon startup, the file always looks for the
  110. file  HDPhones,  although you are free to use any other name
  111. for alternate phone books.
  112.  
  113. Load will truncate a file if it is longer than your maximum
  114. number of entries.  It always leaves two open slots for you
  115. to work with, so if you have 100 as your maximum entries,
  116. only 98 can be loaded.  Memory is dynamically allocated from
  117. the public heap, so it will use fast memory and only as much
  118. as you require.
  119.  
  120. Save saves the file.  What more do you want?
  121.  
  122. Quit exits (wow!)
  123.  
  124. Shrink  closes  Hyper-Dialer down and places a small icon on
  125. your  workbench title-bar.  You can re-activate Hyper Dialer
  126. by  clicking on this icon, picking up exactly where you left
  127. off.
  128.  
  129. You  can  turn  off  all  the  Are  You  Sure?   prompts  by
  130. deselecting the Ok Prompt?  in the menu.
  131.  
  132. DIAL1 dials the first phone number, DIAL2 the second, and
  133. HangUp disconnects after you have picked up the phone.
  134.  
  135. HDial.Config
  136. ------------
  137.  
  138. There are several entries on this file which will enable you
  139. to  slightly  customize  Hyper Dialer.  The comments are not
  140. necessary, but you should keep them no further left than the
  141. 20th column (use spaces, not TABS!)
  142.  
  143. The file appears as follows:
  144.  
  145. HDial Configuration File
  146. ------------------------------------------------
  147. 532        | Icon X Co-ordinate
  148. 0        | Icon Y Co-ordinate
  149. 0        | 1 = expert mode
  150. 50        | Maximum number of entries
  151. 0        | Entry to auto-select    
  152. 2        | Icon Block Pen
  153. 3        | Icon Detail Pen
  154. ------------------------------------------------
  155.  
  156. There  is some limited error checking on the parameters, but
  157. if you want to be an idiot I'm sure you could probably crash
  158. your  system  with some wild entries.  Currently, I have set
  159. the  upper  limit  at 5000 entries (for no good reason).  If
  160. you have more than 5000 friends, give me a call.
  161.  
  162. The icon co-ordinates, predictably, refer to the position of
  163. the Dial icon.  Expert mode, if selected, will automatically
  164. disable all of the Are You Sure? prompts.
  165.  
  166. The entry to auto-select will automatically highlight your
  167. girlfriend (or whatever) on startup.
  168.  
  169. The two color options must be in the 0-3 range and specify
  170. what colors to use in drawing the icon.
  171.  
  172. Finally....
  173.  
  174.  
  175. This is my first Amiga program, so please excuse any gross
  176. shortcomings or problems.  The only way I have been able to
  177. crash the program is to go wild with the right mouse button
  178. while playing with the menu items, and my code for them is
  179. really straight-forward, so I have no idea why this can
  180. occur.  It's not something you should experience under
  181. normal usage.  I've done my best to try to crash it under
  182. almost every low memory condition possible, and it always 
  183. returns a pseudo-polite message, and no gurus!  
  184.  
  185. I have included the option (see above) for complete source
  186. code.  Although it is hardly elegant being my first attempt,
  187. it does serve as a good example of how to:
  188.  
  189.     - Deal with windows
  190.     - Deal with gadgets
  191.     - Deal with events
  192.     - Simple drawing and images
  193.     - A cute recursive quicksort
  194.     - Search routines
  195.     - Handle the mouse buttons
  196.     - Dynamically allocate memory for structures
  197.  
  198. ...and  everything  else  I had trouble learning from books.
  199. My  file-requester-type  listing  is  done totally manually,
  200. without every line being a gadget, and I find it quite fast.
  201. I  also allow you to just hold the button down on the arrows
  202. to scroll, instead of having to click repeatedly (I couldn't
  203. find  Intuition  support  for  this, so it's manual too).  I
  204. also  update  the  listing as you drag the scroll bar around
  205. instead  of  waiting  for you to release it.  All in all, if
  206. you're  trying  to  learn C on the Amiga, it might be a good
  207. thing to learn from.
  208.  
  209. I  realize  35K  is  a  bit  large, but over half of that is
  210. images  for  the gadgets and HyperDialer logo that I thought
  211. just made it look a little nicer.
  212.  
  213. Coming soon (or not).... the next release:
  214.  
  215.     - Optional toll-minding, keeping track of expenses
  216.     on long distance calls.
  217.  
  218.     - Optional seperate screen
  219.  
  220.     - Speaker tone dialing for those of you with no
  221.     modem?
  222.  
  223.     - Whatever else anyone thinks might be handy.
  224.  
  225.     - Smaller more efficient code!
  226.  
  227.