home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / a / altmenu / ReadMe
Text File  |  1996-12-11  |  8KB  |  183 lines
  1. AltMenu
  2. ¨¨¨¨¨¨¨
  3. Hello and welcome to the wonderful world of AltMenu.
  4.  
  5. What does it do?
  6. ¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨
  7. It blatantly steals one of the good features of Guttorm Vik's text editor,
  8. !StrongEd.  That is you can define a menu which appears when you click menu
  9. anywhere on the screen with the left Alt key held down.  You can then set
  10. this menu up to list all your favourite applications and utilities, program
  11. files, C header files, assembly source code files etc. etc. for easy loading
  12. without having to mess about going through directory trees or finding the
  13. iconbar from under that sea of windows.
  14.  
  15. This may not seem to be that useful but trust me, it is.  Try it, you might
  16. like it.
  17.  
  18. How do I use it?
  19. ¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨
  20. You will find two applications within this directory, !AltMenu and !MakeMenu. 
  21. !AltMenu contains a small module which provides the low-level support and
  22. does all the dirty work.  You will need to run !AltMenu at some point, either
  23. from a filer window or in a hard-disc boot sequence.  The module accepts
  24. AltMenu files (type &2AB which I just plucked from thin air and which is not
  25. Acorn allocated) which you will need to create using !MakeMenu.  You can then
  26. load the AltMenu file by double-clicking or using the * command *AltMenu
  27. <filename>.
  28.  
  29. !MakeMenu
  30. ¨¨¨¨¨¨¨¨¨
  31. So it all comes down to the fact that to use AltMenu you will need to know
  32. how to use !MakeMenu, so here goes.
  33.  
  34. The basic principle of the program is that you can define a number of menus
  35. which can then be linked together as submenus if desired.  Each menu is
  36. identified by its title, and when you load the program you will find that a
  37. menu called 'AltMenu' has already been created; this is the root menu and
  38. will be what appears when you click MENU with the Alt key held down.
  39.  
  40. Editing menus
  41. ¨¨¨¨¨¨¨¨¨¨¨¨¨
  42. To edit a menu, you need to display it first.  This is done using the 'Show'
  43. option on the main iconbar menu; selecting one of the names listed on the
  44. submenu will display that menu.  You will then see a small window with a
  45. representation of the menu inside it.  Clicking MENU over this window
  46. displays a small menu with the options 'Add item' and 'Edit item'.  'Edit
  47. item' will be greyed out unless you call up the menu with the pointer over an
  48. item (like in a filer window).  Selecting either option will bring up the 'edit
  49. item' dialogue box.
  50.  
  51. The edit item dialogue box
  52. ¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨
  53. This is where you actually define what a menu item will look like.  Firstly,
  54. fill in the 'text' field with the item text.  You will then need to say what
  55. the item does; it can either execute a * command when selected or it can lead
  56. to a submenu.  For a * command, click on the 'Command' radio icon and then
  57. enter a valid * command into the writeable icon.  For a submenu, you need to
  58. click on the 'Submenu' radio icon and then choose a name off the menu which
  59. can be brought up by clicking on the menu icon to the right of the submenu
  60. icon.  Finally clicking OK will add or edit the item depending on which menu
  61. option you selected earlier on.
  62.  
  63. If you just want the item to run a file, you can drag the file onto the
  64. dialogue box.  Its leafname will be put in as the item text and the * command
  65. writeable icon will be filled with 'Filer_Run <filename>'.  Alternatively, if
  66. you drag a file onto the dialogue with Shift held down, the * command will be
  67. 'Edit <filename>' (see later).
  68.  
  69. Creating new menus
  70. ¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨
  71. Creating a new menu is done simply by choosing 'New menu...' on the iconbar
  72. menu.  This will open small dialogue box; enter a unique identifier into the
  73. 'Identifier' field and click OK.  After this you will need to show the menu,
  74. using the 'Show' option on the iconbar menu, before you can edit it.
  75.  
  76. Other iconbar menu options
  77. ¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨
  78. Info:  leads to a standard Info box.
  79. Save:  leads to a standard Save box from which you can save your menus. 
  80. After this simply double-clicking on the menu file will load the menu as the
  81. current AltMenu.
  82. Clear: this clears all the current menus (no confirmation, so be careful!)
  83. Quit : quits the program (again no confirmation)
  84.  
  85.  
  86. The Edit command
  87. ¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨
  88. As well as the *AltMenu command provided to load AltMenus, the module
  89. provides one other useful * command.  This is *Edit <filename> and it simply
  90. loads the named file into whatever text editor is loaded.  This is a handy
  91. command to use in menus as you can get it to load BASIC programs into an
  92. editor instead of running them.
  93.  
  94.  
  95. Very good, but the !MakeMenu program is useless
  96. ¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨
  97. Yes, I agree but I wrote it in a fairly short space of time when I was not
  98. feeling particularly inspired.  If you would like to write a better one
  99. please feel free to do so; the AltMenu file format is described below.  If
  100. you manage it PLEASE send me a copy!
  101.  
  102.  
  103. The AltMenu file format
  104. ¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨
  105. Yes, its illogical, yes it smacks of awful programming, but it works.
  106.  
  107. The file starts with the four characters ALTM to identify the file as an
  108. AltMenu file.  There then follows a series of blocks like this:
  109.  
  110. /-------------------------------------\
  111. | Standard Wimp_CreateMenu menu block |
  112. |-------------------------------------|
  113. | Command block                       |
  114. \-------------------------------------/
  115.  
  116. ie a standard Wimp menu block followed by a 'command block'.  This is simply
  117. a list of the * commands that will be called when each menu option is
  118. selected, terminated by any character lower than ASCII 32.  Note that a *
  119. command is searched for even when an option which has a submenu is selected
  120. so these options should have a command which does nothing, for example
  121. simply:
  122.  
  123. |
  124.  
  125. Note also that the end of the command block MUST be padded with null
  126. characters until it is word-aligned or some very strange things will happen.
  127.  
  128. Submenu pointers should be file offsets, taking the start of the file as
  129. being the first Wimp_CreateMenu block ie ignoring the 4-byte header.  Also
  130. the first menu in the file must be the root menu but after that the menus can
  131. appear in any order.
  132.  
  133.  
  134.  
  135. Credits
  136. ¨¨¨¨¨¨¨
  137. When programming I count three PD programs as essential; !Zap, by Dominic
  138. Symes, a truly marvellous text editor; !StrongHlp, by Guttorm Vik, a simply
  139. wonderful hyper-text system with a very useful section on loads of SWI calls
  140. that you can't otherwise use without (expensive) PRMs; and !TemplEd by Dick
  141. Alstein, a frankly miraculous template editor and the only decent one I have
  142. ever seen.  If you don't have these programs, get them.  I would personally
  143. like to thank all the programmers for their efforts and for giving their
  144. programs away.  (The !WordWorks thesaurus is also handy for finding all those
  145. superlatives that one needs to describe other people's programs!)
  146.  
  147. I would also like to thank those programmers who have unwittingly taught me
  148. to program RISC OS by allowing me (!) to peruse their code.
  149.  
  150.  
  151.  
  152. Legalities
  153. ¨¨¨¨¨¨¨¨¨¨
  154. !AltMenu, !MakeMenu and all supporting documentation is © Carl Hetherington. 
  155. Copyright remains with me at all times.  You may however copy the program
  156. provided that:
  157.   * the whole distribution remains complete and unaltered.
  158.   * no charge is made except to cover handling and postage costs (no more
  159. than £2).
  160. In other words, the program is Freeware.
  161.  
  162.  
  163. Contacting me
  164. ¨¨¨¨¨¨¨¨¨¨¨¨¨
  165. AltMenu was written by and is © Carl Hetherington.  I can be reached at the
  166. following addresses:
  167.  
  168. Holidays:            Term-time:
  169.  
  170. 31 Tamworth Road        Wentworth College
  171. Ashby-de-la-Zouch        The University of York
  172. Leicestershire            Heslington
  173. LE65 2PW            York
  174.                 YO1 5DD
  175.                 e-mail: cth103@york.ac.uk
  176.                 www: http://www.york.ac.uk/~cth103/
  177.                 
  178.                 
  179. Please write or e-mail if you find any bugs, have any suggestions for
  180. improvements, or just want to say hello.  A formatted disc and SAE will bring
  181. the latest version of the program, or you can just check my web page if you
  182. have access to the internet.
  183.