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