home *** CD-ROM | disk | FTP | other *** search
/ RISC DISC 1 / RISC_DISC_1.iso / pd_share / utilities / treemenu / !TreeMenu / !Help < prev    next >
Encoding:
Text File  |  1994-02-26  |  12.9 KB  |  322 lines

  1.  
  2.         TreeMenu 2.70 (14 Feb 1994)
  3.         ---------------------------
  4.  
  5.  
  6. Introduction
  7. ------------
  8.  
  9. (If you already use DirMenu/TreeMenu, look in 'History' to find a quick
  10. description of the changes since the last released version.)
  11.  
  12. This utility provides an easy way to access directories/files of your disc
  13. and resource filing systems without thrashing through endless filer windows.
  14.  
  15. It provides hierachical menus containing the tree structure of any of your
  16. filing systems. These menus can be opened either by clicking with <Select> on
  17. one of TreeMenu's icon-bar icons, or clicking with <Menu> on the title bar of
  18. *any* window whose title contains a filename. Alt-<Menu> clicks inside Filer
  19. windows are also detected.
  20.  
  21. Choosing an item in a menu will do exactly the same thing as double-clicking
  22. it in a normal Filer window - i.e. open directories, load files, or run
  23. applications. TreeMenu just does a '*Filer_Run ...' on whatever you clicked
  24. on, so hold down <shift> to open application directories / load files into
  25. your text editor, or <ctrl> to open a directory without booting applications.
  26. Choosing a menu item with <Adjust> will keep the menu open.
  27.  
  28.  
  29. If a window contains a valid filename in the title, clicking <Menu> on the
  30. title-bar of the window will bring up a menu containing all the parents of
  31. the filename, and also the contents of the parent directory. Try clicking
  32. on the title bar of this window to see the contents of the '!TreeMenu'
  33. application directory. This allows you to access the directory of a file, its
  34. sub-directories, or any of its parents very easily, and also to branch out
  35. into any other part of the directory's filing system.
  36.  
  37. Clicking <Menu> on the title bar of a Filer window works in a similar way.
  38. Also, TreeMenu responds to Alt-Menu clicks inside Filer windows only.
  39.  
  40. When a menu is brought up by clicking on a window, there will be an extra
  41. item 'Set CSD'. Choosing this will set the Currently Selected Directory (CSD)
  42. to the title of a Filer window, or the parent directory of, for example, an
  43. !Edit window.
  44.  
  45. TreeMenu comes set up to have one icon-bar icon. Clicking <Select> on it will
  46. bring up a menu containing the contents of ADFS::4 (your hard drive, if you
  47. have one), as well items leading to your Resource filing system, your scrap
  48. directory, the Currently Selected Directory (CSD) and whatever is in your
  49. floppy disc drive.
  50.  
  51. Clicking <Menu> on any TreeMenu bar-icon will bring up a conventional
  52. Info/Quit menu, with these other items:
  53.  
  54.  •      Help            loads this file into your text-editor.
  55.  •      Edit !Configs   loads '!Configs' into your text-editor for editing.
  56.  •      Update          re-scan '!Configs'. Do this if you change '!Configs'
  57.                         while TreeMenu is running.
  58.  
  59.  
  60.  
  61. Options.
  62. --------
  63.  
  64. All options are set in the file '!Configs' in !TreeMenu's directory. To
  65. change the options, you should edit the file using a text editor such as
  66. !Edit. If TreeMenu is running, you will need to choose 'Update' from the
  67. normal bar-icon menu after saving the new version of '!Configs'.
  68.  
  69. The file contains comments on how to specify the various parameters; it
  70. should be fairly clear how to change things, so this is just a brief guide:
  71.  
  72. Things that you can change:
  73.  
  74.  •      Menu colours.
  75.  •      Where to open iconbar menus on the screen.
  76.  •      Whether to expand paths containing system variables.
  77.  •      Whether to detect <Menu> clicks on window titlebars.
  78.  •      Whether to detect <Menu> clicks only on Filer titlebars.
  79.  •      Whether to have a 'Set CSD' item in window menus.
  80.  •      Whether to reverse Select/Menu response for iconbar clicks.
  81.  •      Whether to set the CSD to the chosen item if <Alt> is pressed.
  82.  •      Whether to make large menus auto-scrolling.
  83.  •      Number of iconbar icons.
  84.  •      The contents of each bar-icon.
  85.  
  86.  
  87.  
  88. Menu colours
  89. ------------
  90. These are in the following order: 
  91. Work foreground, Work background, Title foreground, Title background. 
  92. (Normal RISC OS menu colours are: 7 0 7 2. I find a white background a bit
  93. bright on large menus.)
  94.  
  95.  
  96.  
  97. Menu position (NORMAL, BOTTOMLEFT or TOPLEFT)
  98. --------------------------------------------
  99. This sets where menus are open in response to clicks on the iconbar.
  100. BOTTOMLEFT  - open normal height but on far left of screen
  101. TOPLEFT     - open in top left corner of screen
  102. NORMAL      - normal RISC OS position above the icon you clicked on.
  103.  
  104.  
  105.  
  106. Path expansion (EXPAND or PRESERVE)
  107. -----------------------------------
  108. If you have an iconbar menu specified like 'System:', any opened filer 
  109. windows will have titles starting with 'System:' rather than the full path 
  110. name. This can result in you having two filer windows open for the same 
  111. directory, which can be a bit confusing. To avoid this, use EXPAND, and any 
  112. filenames will be expanded before they are Filer_Run-ed.
  113.  
  114. NB, FilerPatch does this automatically, so if you use it, this option will 
  115. have no effect.
  116.  
  117.  
  118.  
  119. Always have a 'Set CSD' in window menus 
  120. ---------------------------------------
  121. If you turn this off (which saves a bit of space on window menus), you 
  122. can force it to appear by holding down <Shift> when you click on a window 
  123. titlebar.
  124.  
  125.  
  126.  
  127. Use reversed Menu/Select buttons for iconbar clicks ? (YES or NO)  
  128. -----------------------------------------------------------------
  129. This makes Select behave like Menu, and visa-versa, when you click on an 
  130. iconbar icon. This is so you can use the Menu button for both iconbar and 
  131. window titlebar menus. Note that using this option makes TreeMenu 
  132. inconsistant with the rest of RISC OS.
  133.  
  134.  
  135.  
  136. Set the CSD to the chosen item if <Alt> is pressed.
  137. ---------------------------------------------------
  138. If this option is YES, !TreeMenu will set the CSD to items chosen from 
  139. file/directory menus if you hold down the <Alt> key wjen you make the menu 
  140. choice. !TreeMenu will beep when you set the CSD in this way.
  141.  
  142.  
  143. Auto-scrolling menus.
  144. ---------------------
  145. If this option is YES, !TreeMenu will automatically scroll large menus when
  146. you move the pointer to the top or bottom of the menu. If you move the
  147. pointer to the very top or bottom of the menu, it will scroll down a page
  148. at a time (as though you clicked above or below the scroll bar), otherwise
  149. it will scroll more slowly, as though you clicked on one of the scroll
  150. arrows.
  151.  
  152.  
  153.  
  154.  
  155. The contents of each bar-icon menu are a series of file paths, e.g.
  156. 'ADFS::4.$' or 'Resources:'. TreeMenu will create a menu containing each of
  157. these paths separated by gaps. In addition, you can append a '*' to a path,
  158. which will make TreeMenu add the first-level contents underneath the path.
  159. i.e. 'ADFS::4.$*' will add the contents of the root directory of your hard
  160. disc to the menu, which saves you moving to a submenu, at the expense of
  161. making the root menu bigger.
  162.  
  163. You should change 'ADFS::4.$*' to contain whatever your hard disc is called,
  164. i.e. 'ADFS::<discname>.$*'.
  165.  
  166. Don't append a '.' to any item.
  167.  
  168. Making a separate bar-icon point to a very frequently used directory can be
  169. very convenient. This is made easier if the directory is an application which
  170. sets a system variable to its location. You can then use <...$Dir> in
  171. TreeMenu's '!Configs' file.
  172.  
  173. You can create a menu of *commands by creating an application directory that
  174. contains various Obey files, and then make a TreeMenu icon wich displays this
  175. directory.
  176.  
  177. Any system variables can be items in a TreeMenu menu, by specifying them in
  178. '!Configs', e.g. '@' to get at the CSD, or '<Wimp$ScrapDir>'.
  179.  
  180. Note that if an item that you specified looks like a floppy disc, the Wimp
  181. will ask you to insert it each time you go to that item in the menu tree.
  182.  
  183.  
  184.  
  185. Random nice features:
  186. ---------------------
  187.  
  188.  •      Configurable colours! Big white menus are a bit of an eye-sore. If
  189.         you don't like the colour scheme, just alter the '!Configs' file.
  190.  
  191.  •      Compatible with Jens Ovesen's FilerPatch. i.e. directories which have
  192.         been set to look like applications in Filer windows (bit 7 of Access
  193.         set) are detected, and displayed correctly by TreeMenu.
  194.  
  195.  •      Files/directories which are hidden by FilerPatch (bit 6 of Access
  196.         set) are displayed with fainter text, but are still selectable.
  197.  
  198.  •      You can go into the directory structure of image files just as though
  199.         they are directories.
  200.  
  201.  •      Text in the menus is padded with spaces so that the highlighting is
  202.         clear. I did this because the Wimp doesn't highlight text+sprite
  203.         menu-icons very well.
  204.  
  205.  •      Being able to bring up a menu for a Filer windor by clicking <Menu>
  206.         on the title bar means you can have fewer Filer windows open to save
  207.         desktop clutter, but still have easy access to all your files.
  208.  
  209.  •      You can set the number of icon-bar icons to be zero. This will save
  210.         space on the icon bar, but clicking on Filer windows will still work.
  211.         You will have to quit TreeMenu from the Task Manager window if you do
  212.         this.
  213.  
  214.  •      TreeMenu is set to expand pathnames prior to Filer_Run-ing them, i.e.
  215.         system variables and '@' (representing the CSD) in the path name are
  216.         expanded. This uses the SWI "OS_FSControl". You can turn this option
  217.         off by altering '!Configs'.
  218.  
  219.         NB. I think Jens Ovesen's FilerPatch 1.13 automaticaly expands
  220.         filenames in Filer_Run commands, so this option won't make any
  221.         difference if you use FilerPatch.
  222.  
  223.  •      You can turn off the 'Set CSD' item in window menus by altering 
  224.         '!Configs', but holding down <Shift> when clicking on the title bar
  225.         of a window will force this item to appear regardless of the
  226.         '!Configs' option. This is useful if you hardly ever use the CSD, so
  227.         don't need this item accept on rare occasions.
  228.  
  229.  •      The facility to open a menu by clicking on (for example) a text
  230.         editor window is dead useful - e.g. You're editing a file with the 
  231.         window full-size, and want to look at a second file in the same 
  232.         directory. Without TreeMenu, you have to move the window, find its 
  233.         Filer window, then double-click on the second file etc. With
  234.         TreeMenu, you simply click on the big window's title, and choose the
  235.         second file directly. This makes a big difference when programing in
  236.         C for example, where source files are typically in the same
  237.         directory.
  238.         
  239.         Another example: you might want to look at TreeMenu's 'History' file 
  240.         when viewing this !Help text, so just click <Menu> on the titlebar to 
  241.         bring up the !TreeMenu directory, and choose 'History'.
  242.  
  243.  •      Auto-scrolling of menus. This is a very useful option. I think that 
  244.         Acorn should have made menus auto-scrolling from the start - it is a 
  245.         real nuisance to have to drag the scrollbar of a menu in order to get 
  246.         to choose an item. Most menus on the Arc are small enough to fit on 
  247.         one screen, so I s'pose its not too much of a problem normally. 
  248.         !TreeMenu often has big menus, so Acorn's oversight is more telling.
  249.         I have had no problems with the autoscrolling, but it could conceivably 
  250.         cause problems, so I have allowed the user to turn it off.
  251.         The autoscrolling isn't particulaly smooth, but it's the best I can do!
  252.  
  253.  
  254.  
  255.  
  256. Problems:
  257. ---------
  258.  
  259. I've found that the text-editor !Zap only stores part of a window's title in
  260. the window definition, presumably to ensure that the right hand side of the
  261. title is always visible, regardless of window size. Unfortunately, this means
  262. that TreeMenu will not get the whole window title when Menu is clicked on a
  263. small Zap window. Hence the menu brought up will sometimes be incorrect if
  264. Zap's window titlebar doesn't have room for the complete path. I don't really
  265. know of a way of curing this, as there is no way for TreeMenu to find the
  266. full filename.
  267.  
  268. ------------------------------------------------------------------------------
  269.  
  270.  
  271. Other Stuff
  272. -----------
  273.  
  274. Special thanks are due to Steven Haslam and Denis Howe.
  275.  
  276.  
  277. Many thanks to Dominic Symes, for his superb text editor !Zap, and for
  278. telling me about Wimp_TransferBlock, which is used to get the title of
  279. windows.
  280.  
  281. Thanks also to Jason Williams et al for the equally superb Wimp C library,
  282. 'DeskLib'.
  283.  
  284. This program is freeware. It may NOT me used in connection with any profit-
  285. making activities. Please contact me if you want to distribute TreeMenu in a
  286. PD library.
  287.  
  288. TreeMenu is copyright Julian Smith 1993.
  289.  
  290. Feel free to distribute this program, but you may only distribute the
  291. ORIGINAL version, with all files present.
  292.  
  293. If you find this program useful, you might like to make a donation to Amnesty
  294. International, say £5, by sending me a cheque made out to them.
  295.  
  296. Can anybody tell me why TreeMenu needs more than a 32k wimpslot to run,
  297. despite having a 23K RunImage ????
  298.  
  299. Also, please let me know if you have any comments, problems, suggestions or
  300. praise, (or have found a bug!).
  301.  
  302.  
  303.  
  304.  
  305. - Julian Smith
  306.  
  307.  
  308.  ------------------------
  309.  julians@cogsci.ed.ac.uk
  310.  ------------------------
  311.  
  312.  or:
  313.  
  314.  ------------------------
  315.  Department of Psychology
  316.  University of Edinburgh
  317.  7 George Square
  318.  Edinburgh 
  319.  EH8 9JZ
  320.  UK
  321.  ------------------------
  322.