home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 5 / FreshFish_July-August1994.bin / bbs / util / magicword-1.0.lha / MagicWord-1.0 / MagicWord.doc < prev    next >
Encoding:
Text File  |  1994-05-15  |  8.0 KB  |  164 lines
  1. Documentation for MagicWord 1.0
  2. -------------------------------
  3.  
  4. (c) 1992/93
  5.  
  6. Author: Urs Fleisch
  7.         Leimatstr. 38
  8.         CH-9000 St. Gallen
  9. E-mail: ufleisch@stud.ee.ethz.ch
  10.  
  11. This program is PUBLIC DOMAIN, and may be freely distributed, however
  12. always together with this documentation!
  13.  
  14. MagicWord is a universal utility for word replacement and macros. Other
  15. than special solutions in editors and wordprocessors, MagicWord works with
  16. nearly every wordprocessor, editor and any other utility. Instead of
  17. recording macros for every application, it is easier to record the macros
  18. once with MagicWord for you'll be able to use them with future applications
  19. too. The use of MagicWord is only limited by the ideas of the user.
  20. This versatility can be used especially by replacing words. So you can let
  21. MagicWord type your address simply by typing \adr in any application.
  22. MagicWord can also be used as a little data base because you get access to
  23. information by typing keywords. The access is done rather quick by hashing.
  24.  
  25. You can start MagicWord from Shell or Workbench. From Shell you can provide
  26. MagicWord with the name of a macro file, which will be loaded
  27. automatically. MagicWord doesn't need any library to run, but it is able to
  28. use the ARP and ASL-Requesters. So arp.library is recommended for Kickstart
  29. 1.3, asl.library for Kickstart 2.0 and 3.0.
  30. After loading MagicWord opens a window with half height of the actual
  31. default public screen. A cursor indicates that you can edit in this window.
  32. The program offers the following menu items:
  33.  
  34. Project/Load: Load a macro file
  35. Project/Save as: Store the macros in memory
  36. Project/Quit: Quit program
  37. Macros/New: Record a new macro
  38. Macros/Delete: Delete an existing macro
  39. Macros/Delete all: Delete all macros in memory
  40. Macros/Show: Show all macros in memory
  41.  
  42. Here comes a more detailed description of the menu functions:
  43.  
  44. Macros/New: This function may be used first. It enables you to record
  45. keypresses for a new macro. First it requests the name of the macro. This
  46. name can contain letters, numbers and symbols, but no spaces or backslash
  47. "\" for this character marks the begin of a macro name. The program won't
  48. distinguish between upper and lower case. The macro name can be deleted by
  49. typing Backspace or Del, input is finished by typing Return or Enter. From
  50. now on, MagicWord records your keypresses until you select the menu
  51. Record/finished. Now the macro is stored in memory and may be used by
  52. typing a backslash "\" follow by the defined macro name.
  53. Example: Select Macros/New, the message "Input new word!" will appear. Now
  54. we type "adr" followed by Return. Now the program tells you that it is
  55. recording all keypresses. You can type your text in any application, e.g.
  56. in the wordprocessor to use this text with. So we change to our application
  57. an type our address: "Hermann User<RETURN>Bitstreet 256<RETURN>1024
  58. Bytetown<RETURN>. Now we return to MagicWord and select the menu
  59. Record/finished, MagicWord confirms that it has stopped recording
  60. keypresses. You can also type the text to record in the MagicWord-window
  61. which offers you a simple editor.
  62. A macro can contain 2000 keypresses. Be aware the the typing of the
  63. Backspace or Delete-Key won't edit the macro data. The keypress will be
  64. recorded and later reproduced like every other key.
  65. Now we type "\adr" in any application or in MagicWord, and \adr is being
  66. deleted and replaced by the recorded text. Be sure that you typed in the
  67. macro name correctly, or you've got to retype the whole text (with
  68. preceding backslash "\"!). Finish by typing Space or Return. It is
  69. important that you start the macro name with a backslash, so MagicWord
  70. recognizes the macro without checking every word and slowing down your
  71. machine.
  72. Macros are stored in memory dynamically. MagicWord compares every
  73. word which starts with a backslash with the macros in memory by calculating
  74. the position by hashing (just like the AmigaDOS file system). So access
  75. should be pretty quick. The number of macros isn't limited, so you could
  76. fill all RAM with macros.
  77.  
  78. Macros/Delete: Deletes a macro from memory. You've got to type in the macro
  79. name. Notice that memory won't be freed until you select "Macros/Delete
  80. all" or quit the program.
  81.  
  82. Macros/Delete all: This function deletes all macros in memory and frees the
  83. used memory.
  84.  
  85. Macros/Show: Prints out all macro names in order of their appearance in the
  86. hash table. The associated text can be displayed by typing the macro name
  87. with preceding backslash.
  88.  
  89. Project/Save as: By choosing this function you can save all macros in
  90. memory to disk. While saving, MagicWord prints out the name of the macro
  91. currently saved. If available, the filename can be chosen using the ARP- or
  92. ASL-Filerequester. Otherwise, you'll have to put up with a simple
  93. requester.
  94.  
  95. Project/Load: Allows you to load a MagicWord file. Again, you may find an
  96. ARP- or ASL-Requester and the names of the loaded macros are being
  97. displayed. The macros from the chosen file are loaded to the ones already
  98. in memory. Existing macros with the same name will be overwritten. This
  99. function is also invoked when MagicWord has been started with a filename as
  100. an argument.
  101.  
  102. Project/Quit: You can leave the program by selecting this menu item or by
  103. clicking the close gadget. No more macros will be available to other
  104. applications.
  105.  
  106. That's all. Now I want to add some hints.
  107.  
  108. When you use MagicWord to replace words, nearly every application (DTP,
  109. wordprocessors, editors...) can take advantage from its word replacement
  110. faculty. From the many tested programs, only "Beckertext I" and "SuperED C"
  111. don't work with MagicWord. The problem may be their key processing over
  112. Intuition, which remembers only four keypresses. This limits also the
  113. recording of short cut keys to select menu functions from macros. If an
  114. application uses it's own menu keyboard handling (e.g. WordPerfect),
  115. there's no problem.
  116. Because you can move and click the mouse by keypresses, MagicWord can also
  117. guide the mouse. But you must look out for some things:
  118.  
  119. * The mouse pointer can be moved by holding an Amiga key and pressing the
  120. cursor keys. By holding down a cursor key, the pointer moves quickly,
  121. single keypresses move it with little steps. If you hold down a shift key,
  122. the pointer takes larger steps.
  123. MagicWord generates only single keypresses. You should only (even to
  124. simulate the right mouse button) use the left Amiga key (lAmiga), for the
  125. right one generates repeated keypresses. To move the pointer faster, you
  126. may hold down shift.
  127. Before moving the mouse pointer, it should be positioned. E.g. you can move
  128. it with the mouse to the lower right corner; while recording, you can move
  129. it to the upper left corner by pressing lAmiga-Shift-Left and
  130. lAmiga-Shift-Up. So you can be sure that the pointer will get to the upper
  131. left corner from every position. Now you can move the pointer to the
  132. desired position.
  133. => Move pointer: Place pointer and move it with lAmiga-Shift-Cursor keys or
  134.    lAmiga-Cursor keys with single keypresses.
  135.  
  136. * To simulate the left mouse button, it's not sufficient to press
  137. lAmiga-lAlt for both of them are qualifier keys. In addition, you've got to
  138. press a normal key without function, e.g. F1. To simulate a double
  139. clicking, you should press a normal key alone between the mouse clicks.
  140. => left mouse button: press lAlt-lAmiga-F1.
  141.    double click:      press lAlt-lAmiga-F1, F1, lAlt-lAmiga-F1.
  142.  
  143. * To select a menu, you may want to simulate the right mouse button. Move
  144. the pointer and hold down the right Alt key. When you're over the menu
  145. item, release all keys. Again: record single keypresses, use shift for fast
  146. movement.
  147. => Select menu: move pointer with lAmiga-rAlt-Cursor keys to the menu item,
  148.    then release the keys.
  149.  
  150. That's for the mouse simulation. Now other hints:
  151.  
  152. * In the Shell, a macro may replace a batch file. Simply record some often
  153. used commands.
  154.  
  155. * You don't need an editor to invoke a macro. You may also type blindly on
  156. the Workbench screen.
  157.  
  158. * You can get often used addresses or your own letterhead simply by typing
  159. one name.
  160.  
  161. * You can record phrases like Hello, Yours sincerly, Greetings...
  162.  
  163. * Programmers may record frames for their programmes, titles, comments...
  164.