home *** CD-ROM | disk | FTP | other *** search
/ RISC DISC 1 / RISC_DISC_1.iso / pd_share / utilities / memorizer / !Memorizer / !Help < prev    next >
Encoding:
Text File  |  1993-08-10  |  10.1 KB  |  273 lines
  1. Memorizer v1.00
  2. © Ben Summers 1993
  3.  
  4. See notes at the end of this file for conditions of use and distribution.
  5.  
  6.  
  7. RISC OS version
  8. ~~~~~~~~~~~~~~~
  9. Memorizer only works under RISC OS 3.10 and later. Sorry. If you attempt to
  10. load it under an earlier version of RISC OS, it will complain and urge you
  11. to upgrade. This restriction is necessary as Memorizer uses several features
  12. new to RISC OS 3.10 to allow it to work.
  13.  
  14.  
  15. What does Memorizer do?
  16. ~~~~~~~~~~~~~~~~~~~~~~~
  17. Memorizer sits in the background, and listens out for directories being
  18. opened, applications being run and files being opened. When it hears one
  19. being used, it keeps a record of it. When you press a user defined hotkey
  20. (initially Shift-Ctrl-Tab), a window will pop up allowing you to run the
  21. last 8 (this number can be changed) directories, applications or files
  22. again.
  23.  
  24.  
  25. Er... why is that useful?
  26. ~~~~~~~~~~~~~~~~~~~~~~~~~
  27. If for example, you close a directory or file, or quit an application and
  28. then suddenly decide that, after all, you didn't want to close it, you
  29. would normally have to go though lots of directory windows to find it again.
  30. However, with Memorizer, you don't. Just press the hotkey, select the list
  31. the object will be in, and double click on it.
  32.  
  33. Much quicker.
  34.  
  35. You could also use it as an instantly available list of useful directories,
  36. applications and files by running them and then locking their entries so
  37. they do not get lost.
  38.  
  39.  
  40. How can I get it to run on my machine?
  41. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  42. Simply install Memorizer in your !Boot file. If you use the Task Manager to
  43. create one while Memorizer is loaded, then Memorizer will be included.
  44. Otherwise, just edit it in as you would any other application.
  45.  
  46. You can, of course, run it at any time just as you would any other
  47. application.
  48.  
  49.  
  50. How do I use Memorizer?
  51. ~~~~~~~~~~~~~~~~~~~~~~~
  52. Once Memorizer is loaded, either in your !Boot file or by double clicking on
  53. it's icon in the directory viewer, all you need to do is to press the hotkey
  54. when you want to run a file again. A window will appear near the mouse
  55. pointer.
  56.  
  57. On the top line of the window, there are three icons representing
  58. directories, applications and files. Clicking on one of the icons changes
  59. the currently displayed list to that containing the appropriate type of
  60. object. The colour of the blob beside the icon indicates which list is
  61. currently selected.
  62.  
  63. The white strip down the right hand side of the window headed by a small
  64. picture of a key needs more explanation. It allows you to 'lock' an object
  65. in the list to stop it from disappearing when the list is full and another
  66. object is about to be added. To lock an object, click on the white strip
  67. opposite the icon of the object. This will toggle the lock on and off. When
  68. the object is locked, the blob is black, otherwise it is light grey.
  69.  
  70.  
  71. The Memorizer menu
  72. ~~~~~~~~~~~~~~~~~~
  73. Clicking menu on the Memorizer window or on the iconbar icon (if you have
  74. chosen to have one), produces the following menu:
  75.  
  76.   Info      ⇨        Info window as expected
  77.   Options...         Open the options window
  78.   Remove             Remove the selected object from the list
  79.   Save list ⇨        Save an object file containing the entries
  80.                        in the current list
  81.   Save all  ⇨        Save an object file containing the entries
  82.                        in all the lists
  83.   Quit               Quits the Memorizer task and removes the module
  84.                        from memory.
  85.  
  86. The save options can be used to save object files which can be loaded in the
  87. normal way.
  88.  
  89.  
  90. Options
  91. ~~~~~~~
  92. Choosing 'Options...' from the Memorizer menu displays the options window.
  93. Your disc will be accessed before the window is displayed as the code to
  94. handle changing the options is not within the main Memorizer code as it is
  95. rather large and is not frequently used.
  96.  
  97. The window which appears has the following options, explained below. The
  98. default state (the one you should have received the program in) is shown in
  99. brackets after the option name.
  100.  
  101. * Hotkey                              (Shift-Ctrl-Tab)
  102.    The hotkey used to open the Memorizer window. To change it, make sure
  103.    that the caret is in the icon, and press the hotkey you want to use.
  104.    If the hotkey is allowed (some aren't), the contents of the icon will
  105.    change to reflect the new hotkey.
  106.  
  107. * Number of entries in lists          (8)
  108.    This is the number of entries in each of the lists kept by Memorizer.
  109.  
  110. * Object memory chunk size            (1K)
  111.    The names of the objects stored are kept in chunks of memory within
  112.    the RMA. This is the size of each of the chunks. Setting this to a
  113.    low value will save memory when it is not necessary, and setting this
  114.    to a higher value will avoid problems with objects not being added to
  115.    the lists because of lack of memory. I would recommend sticking to the
  116.    default 1K.
  117.  
  118. * Display icon on iconbar             (on)
  119.    Whether or not to put an icon on the iconbar. I don't really think it
  120.    is necessary as Memorizer is the sort of utility you want to hide away
  121.    until you want to use it, and the hotkey is a much quicker way of
  122.    getting at the Memorizer window.
  123.  
  124. * Stay open after running object      (off)
  125.    If this is unselected then the Memorizer window will be closed after an
  126.    object is run by double clicking on it. However, double clicking with
  127.    ADJUST instead of SELECT always does the opposite of what you choose
  128.    here.
  129.  
  130. * Reorder when object is used again   (on)
  131.    If this is selected then if an object is used again, it will be brought
  132.    to the top of the list. Otherwise, it stays where it is.
  133.  
  134. * Store file                          (none set)
  135.    Drag a object file saved by Memorizer to the options window to change
  136.    this option. Click on None to set no Store file. See below for an
  137.    explanation of store files. You will need to save an list file using
  138.    the Memorizer menu before you can use this option.
  139.  
  140. The window contains the following action icons.
  141.  
  142. * OK
  143.    Close the options window and change the options within the loaded copy
  144.    of Memorizer. The options are not saved, and so will be reset when
  145.    Memorizer is next loaded.
  146.  
  147. * Cancel
  148.    Close the options window, and forget all changes made.
  149.  
  150. * OK & Save
  151.    Same as OK, except that the options are saved to disc so that next time
  152.    Memorizer is loaded they will be as you set them in this window.
  153.  
  154.  
  155. Store files
  156. ~~~~~~~~~~~
  157. If you set up a store file using the Memorizer options window, it will be
  158. used to save all the objects Memorizer has in the lists when Memorizer quits
  159. (using the menu option or in the desktop shutdown sequence). This file will
  160. then be loaded when Memorizer is next used so that your list of objects is
  161. not lost when you switch off.
  162.  
  163.  
  164. Limitations
  165. ~~~~~~~~~~~
  166. Memorizer has a few limitations. These are due to a requirement to use as
  167. little memory as possible, to be as quick as possible to avoid slowing the
  168. computer down, and in some cases just because of the way RISC OS works.
  169.  
  170. Multiple file drags
  171. ```````````````````
  172. If you drag more than one file to an application, you may find that only the
  173. first few, usually four, appear in the Memorizer window.
  174.  
  175. Impression files
  176. ````````````````
  177. Programs such as Impression use application directories as files. Memorizer
  178. will recognise this and place these in the files list. However, this will
  179. only work if the parent application is loaded when one of these files is
  180. opened. If the parent application is started up by opening this file, it
  181. will be placed in the applications list.
  182.  
  183.  
  184. *commands
  185. ~~~~~~~~~
  186. Memorizer provides 3 *commands:
  187.  
  188.   Desktop_Memorizer
  189.   Memorizer_AddDirFileType
  190.   Memorizer_AddIgnoreFileType
  191.  
  192. Desktop_Memorizer is used internally. Do not use it.
  193.  
  194.  
  195. Memorizer_AddDirFileType
  196. ~~~~~~~~~~~~~~~~~~~~~~~~
  197. This command adds the filetype specified to the list of those which will be
  198. treated as directories when deciding which list to add them to. By
  199. default, archives (type &DDC) and PC partitions (type &FC8) are in this
  200. list.
  201.  
  202. Syntax: Memorizer_AddDirFileType <filetype>
  203.  
  204. The filetype is in hexadecimal. For example,
  205.  
  206. Memorizer_AddDirFileType DDC
  207.  
  208. adds type &DDC (archives) to the list of filetypes to treat as directories.
  209.  
  210.  
  211. Memorizer_AddIgnoreFileType
  212. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  213. This command adds the filetype specified to the list of those which will
  214. not be added to any lists. By default, no filetypes are in the lists.
  215.  
  216. Syntax: Memorizer_AddIgnoreFileType <filetype>
  217.  
  218. The filetype is in hexadecimal. For example,
  219.  
  220. Memorizer_AddIgnoreFileType 0FF
  221.  
  222. adds type &0FF to the list of filetypes to ignore.
  223.  
  224.  
  225. Using these commands
  226. ~~~~~~~~~~~~~~~~~~~~
  227. These two commands can be used at any time after Memorizer has been loaded.
  228. You could include extra commands after the command to load Memorizer in your
  229. !Boot file. If you do include commands in your !Boot file, then you must use
  230. the 'Run' command rather than the 'Filer_Run' command to load Memorizer.
  231.  
  232.  
  233. Changing the defaults
  234. ~~~~~~~~~~~~~~~~~~~~~
  235. The defaults for these two lists of filetypes are set in the file
  236. 'SetFTypes' in the Memorizer application directory. You can add more
  237. commands to this to file, but you must not distribute copies of Memorizer
  238. in which this file is modified.
  239.  
  240.  
  241. Conditions of use
  242. ~~~~~~~~~~~~~~~~~
  243. This application is freeware, that is, it can be distributed freely as long
  244. as only reasonable charges are made for media and distribution. I retain
  245. copyright on all program code and documentation. You may only distribute
  246. copies of Memorizer which have all options set to the defaults, and the
  247. SetFType file unmodified.
  248.  
  249. If you use Memorizer, please write and tell me, preferably enclosing a disc
  250. of PD and return postage. Letters encourage me to keep developing free
  251. software, and upgrade my programs. I mean, if nobody uses the programs, I
  252. need not bother writing them, and if no one writes to tell me that they do,
  253. how am I to know? I reply to all letters I receive (eventually) as long as
  254. you send return postage, and am very happy to upgrade your copy to the very
  255. latest version.
  256.  
  257.  
  258. The author
  259. ~~~~~~~~~~
  260. Memorizer was written by Ben Summers. Please send any letters, tokens of
  261. appreciation, comments and suggestions for improvements, large sums of money
  262. and discs of incredibly wonderful PD to the address below...
  263.  
  264.   Ben Summers
  265.   1 St Clements Hill
  266.   Norwich
  267.   NR3 4DE
  268.  
  269.  
  270.  
  271.  
  272.  
  273.