home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 5 / FreshFish_July-August1994.bin / bbs / biz / butlerjames-3.2.lha / ButlerJames-3.2 / Docs / Butler.doc next >
Text File  |  1994-05-08  |  49KB  |  1,412 lines
  1.           Documentation of Butler V3.2  © 1992-1994 C&h-Software
  2.           ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  3.  
  4.                           C h a p t e r   1
  5.                          -------------------
  6.  
  7. Introduction
  8.  
  9. Gives you a brief overview of the basic functions and the intended use as
  10. well as some special aspects of using the program.
  11.  
  12.  
  13. 1.1) Recommended machine-configuration
  14.  
  15. Butler should run on almost any machine without problems, that is all
  16. functions are available with 512 KB RAM and one drive, but from now on
  17. (version 3.0 of the software) Kickstart 2.x or 3.x is required to run
  18. Butler. This was necessary to keep the program-size small (Butler V3.0 is
  19. nearly 50 % smaller than the previous version !) and to raise the comfort
  20. of the user-interface (ListViews, Commodity functions, AslRequester ect.).
  21. So run for your new KS-ROM, if you don´t already use 2.0 or higher versions
  22. of the system software ! As soon as your database has about 1000 entries,
  23. it is recommended to use a harddrive, because floppy-disks always have a
  24. very poor performance as far as data access is concerned. This is a
  25. well-known problem, which can not be solved by the software, although the
  26. disk-access of Butler is highly optimized for maximum speed. Running butler
  27. will need about 32K of RAM for every 100 entries in addition to the size of
  28. the program itself as the highest expected value. This will only be used
  29. during delete or insert operation and goes down to 6K for 100 entries if
  30. butler is resident and waits for the defined hotkey. So if you have to run
  31. other applications that need much RAM, you should have at least 1 MB to be
  32. safe of getting those ugly messages like: Your machine is out of memory...
  33. At this place some words about startup operation: When you start a program
  34. (for ex. Butler), the system loads code- and data-modules into memory.
  35. Butler checks these modules for itself before running, that is he
  36. calculates a checksum over program code and data to be sure everything has
  37. been loaded correctly and there will be no invalid data or program-code due
  38. to read-write- or RAM-errors. First of all this reduces the risk of sudden
  39. program-crashes that could have been detected and avoided and second there
  40. is no way to change  a n y t h i n g  within the program-code without
  41. butlers notice. So please keep away from the compiled program-code as it
  42. runs only in the original version. Changed versions will bring up a
  43. requester right after startup, saying that program-code or data sections
  44. are damaged and butler exits.
  45.  
  46.  
  47. 1.2) Basic Function
  48.  
  49. After starting butler, the program keeps resident in RAM until you press
  50. the hotkey defined in the tooltypes (CX_POPKEY). (Most likely the Help key)
  51. Now butler wakes up (until now he was asleep and did not use the CPU,
  52. except the small commodities input-handler that watches the input-stream)
  53. and tries to open a window on the foremost screen. If you set the SCREEN
  54. tooltype to YES, he will open a new screen. If he fails for low memory,
  55. you´ll get the appropriate error-message. When you are done with your work,
  56. you can reset butler to his resident state, or you can quit completely.
  57. Pressing the hotkey while butler has his window open on any screen will
  58. make him close the window and re-open it on the foremost screen again. For
  59. a detailed description of screen and window usage and some important facts
  60. you should keep in mind see chapter 5) Tooltype-processing under SCREEN.
  61. Butler was designed for address management, but can be used for other
  62. purposes, if the number of bytes (characters) per entry and the given
  63. number of input-fields are sufficient. A detailed description of each field
  64. is given below.
  65.  
  66. Field 1:   9 chars  to
  67. Field 2: 29 chars  firstname
  68. Field 3: 29 chars  lastname
  69. Field 4: 39 chars  extensions
  70. Field 5: 39 chars  street
  71. Field 6: 39 chars  place
  72. Field 7: 39 chars  telephone
  73. Field 8: 47 chars  comments
  74.  
  75. Further there are four input-fields for special purposes which will be
  76. named IF1 to IF4 in the following. Their position is shown below:
  77.  
  78. Bottom right:  UseFunc ,      IF3      , Select
  79.                UseJoker,      IF4      , DeSlct
  80.            Fix:    IF1 ,    Wait:    IF2
  81.  
  82. Data is sorted in alphabetical order using the text in field 3 (lastname)
  83. and displayed in a very handy scrollfield. Each entry has a specification,
  84. given by the user when adding new data, that relates each entry to one or
  85. more of 8 groups. By the use of 8 switches, positioned directly under the
  86. scrollfield, the user can select a specific combination of groups for being
  87. displayed. This function works in realtime, that is there are no delays
  88. between selecting groups and getting the result (even if there are 1000 or
  89. more entries). As Butler has a little function-parser, you can give your
  90. own very special display-function in IF3, which will replace the normally
  91. used switches, for ex.: (1 and 3) or (2 and not (6 and 7))... or something
  92. like that. In addition to that, you can provide a joker-text in IF4 to
  93. reduce the display to all entries which have a field 3 (lastname), that
  94. matches the joker.
  95.  
  96.  
  97. 1.3) Special aspects of the user-interface
  98.  
  99. As there are no pulldown menus, the right mousebutton can be used for other
  100. purposes, that make the program easy-to-use. The following actions are
  101. available:
  102.  
  103. 1) Pressing the right button  when the pointer is above or below the
  104. scrollfield: Leaf through the contents of the scrollfield (pagewise).
  105.  
  106. 2) Pressing the left button when the pointer is upon an entry of the
  107. scrollfield: ACTIVATES this entry, that means:
  108. ·) The complete contents of it are shown in the input-fields.
  109. ·) It changes the color.
  110. ·) Further operations like save, send, prtlab ect. take effect on this
  111. entry, if they were selected with the left button.
  112. Certainly only one entry can be active. Activating another will therefore
  113. deactivate the previous activated entry.
  114.  
  115. 3) Keeping the left button pressed, moving up and down the scrollfield:
  116. Butler keeps track of the pointer-position and activates the desired entry
  117. for you. If you move out of the scrollfield (over the top or the bottom
  118. border, the contents are scrolled up or down.
  119.  
  120. 4) Pressing the right button when the pointer is upon an entry of the
  121. scrollfield: SELECTS this entry, that means:
  122. ·) The display changes to inverse. (like a bar over the text)
  123. ·) Further actions (see 2) take effect on all selected entries if they are
  124. invoked with the right button.
  125. All entries can be selected at the same time and in 4 independent levels.
  126. (See 2.4.14 Cycle-gadgets, for details). The "selected"-state of an entry
  127. in any level does not depend on its display-state, that is if some entries
  128. are hidden by selecting new group-combinations, they keep their
  129. "selected"-state until they are displayed again and deselected. The actual
  130. state of all entries in all 4 levels can be saved using "store", if you
  131. need this state to appear the next time you run butler. Read chapter 2.3)
  132. for a detailed description of the available group- and display-functions.
  133.  
  134. 5) As 4, but moving up and down: If the first entry (the one you clicked
  135. on) was deselected up to now, this and all following entries you move on,
  136. will be selected. If the first entry was previously selected,this and all
  137. following entries you move on, will be deselected. Moving out of the
  138. scrollfield causes butler to scroll up/down, selecting/deselecting all new
  139. displayed entries.
  140.  
  141. 6) Security-checks (for ex. before delete), often use a different kind of
  142. communication than a requester. They print their message directly in the
  143. windows titlebar, waiting for the user to select the action again, or to
  144. cancel it by pressing the right button. This is very practical, because you
  145. don´t have to move your pointer to the O.K. gadget of the requester.
  146. Instead you select the function again, which leads into a kind of
  147. double-click.
  148.  
  149.  
  150.                           C h a p t e r   2
  151.                          -------------------
  152.  
  153.  
  154. Function description
  155.  
  156. This section gives you a detailed description of each gadget in the main
  157. window of butler, which functions are invoked through their selection and
  158. how to use them.
  159. l.M. stands before the function, invoked with the left mousebutton, r.M.
  160. stands before the