home *** CD-ROM | disk | FTP | other *** search
/ 17 Bit Software 4: Phase Four / 17Bit_Phase_Four.iso / files / 2873.dms / 2873.adf / MenuMaster.doc < prev    next >
Encoding:
Text File  |  1993-11-24  |  12.2 KB  |  287 lines
  1.         MenuMaster III (C) Dave Matthewson  1993
  2.         ========================================
  3.  
  4. The program in this final version is FreeWare and may be distributed in
  5. P.D. libraries and bulletin boards. The only stipulation is that this 
  6. document file accompanies all copies.
  7.  
  8. THE PROGRAM
  9. ===========
  10. The program has been thoroughly tested on most Amiga variants using both V1.2
  11. and V2.0 KickStart ROMS and is, as far as I know, completely bug free.
  12. MenuMaster is intended to be a friendly front end to a collection of programs
  13. assembled on a single disk, (or hard drive). It allows the user to select and
  14. start a program (or programs if multitasking) without ever needing to access
  15. the CLI at all.
  16. Any program or command that can be started from the CLI can be included in
  17. the menu, which has a total of 32 selection options.(or 24 in NTSC mode)
  18. There are several shareware/public domain programs similar to MenuMaster,
  19. but this one is, as far as I know still unique, in that it has its own
  20. built-in editor.
  21.  I was prompted to write this program because after making program additions
  22. or similar alterations to my own utility disks, I then had to use a separate
  23. menumaker program or text editor to modify the menu options. Now, with the
  24. built-in editor provided by MenuMaster, changes are quick and simple.
  25.  
  26. INSTALLATION
  27. ============
  28. To use MenuMaster on your own disks you must copy the file 'MenuMaster' into
  29. the root directory of your boot disk and  edit the file 's/startup-sequence'
  30. to include the command  'MenuMaster'.
  31. Also ensure that the 'Run' command is in the 'c' directory. If not, then copy
  32. it there from your Workbench disk.
  33.  
  34. MenuMaster III  creates its own process then detaches itself from the CLI.
  35. However, to guarantee somewhere to send its output, MenuMaster will retain a
  36. lock on this initial CLI window. Consequently the 'ENDCLI' command will not
  37. close this window until all MenuMaster processes have exited.
  38.  All that will happen is that the cursor will disappear and you will no 
  39. longer have input access to this CLI window.
  40. If you wish to retain access to the initial CLI window for command input,
  41. then just delete the 'ENDCLI' command from the startup-sequence and it will
  42. then become available to you as soon as the startup-sequence completes. 
  43.  
  44. When you first boot from the disk, MenuMaster will look for the file in the
  45. root directory called 'MenuMaster.dat1'. If it's not there an alert will
  46. appear informing you that it can't read the data file. After clearing this
  47. alert you will be presented with a menu screen which is completely blank.
  48. By using the edit facility a new data file can then be created.
  49.  
  50. Alternatively, the existing file 'MenuMaster.dat1' can also be copied to your
  51. disk, in which case the 'Can't read' alert will not appear.
  52. However, the data it contains will apply to the disk it came from and will
  53. have to be edited to suit. Use whichever method you find easier.
  54.  
  55. The default datafile number is 1, so Menumaster.dat1 will always be loaded,
  56. or created ,if no file number is specified. By specifying a datafile number
  57. of 1 to 9 after the command, you can cause MenuMaster to use, or create,
  58. another datafile instead. i.e. the command 'MenuMaster 2' will use or create
  59. the data file 'MenuMaster.dat2'.
  60. From this you can see that a total of 9 menus, each with 32 options, are
  61. possible. Thus giving a grand total of 288 options, which should be more
  62. than enough for most people.
  63.  
  64. North American users should find that MenuMaster will automatically
  65. detect NTSC format and set 24 option size accordingly.
  66. However, for compatibility, European users can force NTSC mode by using the
  67. command 'MenuMaster NTSC' instead.
  68.   
  69. Another new feature of MenuMaster III is that it can be started in the
  70. iconified mode by using the 'I' switch. i.e. 'MenuMaster I'
  71.  
  72. All of the above switches can be combined as long as they are used in the
  73. correct order, and separated by spaces. 
  74. (Characters can be entered in either upper or lower case.)
  75. Correct usage is:  MenuMaster [filenumber of 1-9] [I] [NTSC]
  76.  
  77. N.B.
  78. Because of data compression, earlier V1.0 data files are NOT compatible
  79. with MenuMaster III.
  80.  
  81. USE OF MAIN SCREEN GADGETS
  82. ==========================
  83.  
  84. BACK/FRONT GADGETS
  85. ------------------
  86. Normal screen depth arranging gadgets are in the top right corner.
  87.  
  88. DRAG BAR
  89. --------
  90. The whole of the title panel is an up/down drag bar which can be used in
  91. positioning the menu to reveal other screens beneath.
  92.  
  93. SELECTION GADGETS
  94. -----------------
  95. These are the 32 (or 24 in NTSC mode) possible program selection gadgets.
  96. An optional input requester can be also made to appear after a selection
  97. is made. Thus enabling command arguments or parameters to be passed to the
  98. command interactively.(Max. 127 characters can be entered using this option).  
  99.  
  100. MENU-BAR GADGET
  101. ---------------
  102. Holding down the right mouse button brings up the Options menu which gives
  103. three choices.
  104.  
  105. 1)Shrink.
  106. This causes Menumaster to close down to a small icon at the top right of
  107. the screen. This bar contains Drag,Depth and Close gadgets, and the title
  108. which includes the datafile number. If multiple menus have been shrunk
  109. they will arrange themselves so as not to obscure each other.
  110. Clicking the right mouse button when this bar is active causes MenuMaster
  111. to re-open its main window again.
  112.  
  113. 2)Edit.
  114. Enter edit mode. If the datafile was saved with the 'SECURE' option you will
  115. be prompted for a four digit security code number, prior to entry.
  116.  
  117. 3)Quit.
  118. Exits MenuMaster completely.
  119.  
  120.  
  121. USE OF THE EDITOR GADGETS
  122. =========================
  123.  
  124. UP/DOWN GADGETS
  125. ---------------
  126. Holding down the left mouse button on either of these gadgets causes
  127. MenuMaster to scroll through the 32 (or 24) selection options plus the
  128. menu title.
  129.  
  130. MENU TITLE/ITEM TEXT GADGET
  131. ---------------------------
  132. Enter the title, menu item text or comment text that you want displayed on
  133. the main screen menu panels. (Max. 35 characters)
  134.  
  135. MENU SELECTOR BUTTON ON/OFF GADGET
  136. ----------------------------------
  137. This gadget decides whether or not a selector button will appear with the
  138. above text on the main menu screen.  (Except for the main title of course).
  139. When this is 'ON' the item text will be displayed left justified, with a 
  140. selection button appearing at the right of the panel.
  141. When this is 'OFF', text only will be displayed, centre justified, in a
  142. different colour. This can be used for sub-titles or comment text.
  143.  
  144. EXECUTION MODE GADGET
  145. ---------------------
  146. This gadget will be 'ghosted' until the user toggles the selector button
  147. ON/OFF gadget to 'ON'.
  148. It is used to preselect the mode in which your program will start when
  149. chosen from the main screen. The three options are [E]xecute, [R]un and
  150. [L]aunch. The default will always be [E]xecute.
  151.  
  152. 1)Execute
  153. In this mode the menu window will close and your selected program will then
  154. be started. On exiting your program, the menu window will re-open ready for
  155. another selection to be made. There is an exception to this rule in that
  156. some programs, once started, create their own process and then detach
  157. themselves. This type of program will pass control back to the menu
  158. immediately after starting up, so you may need to then drag, or push, the 
  159. menu to the back to access your selected program.
  160. MenuMaster is itself such a program, so multiple menus can be started with
  161. the Execute command.
  162.  
  163. 2)Run (MultiTasking)
  164. In this mode the menu window will close and your selected program will be
  165. started. The menu window will then immediately re-open allowing further
  166. selections to be made.
  167.  
  168. 3)Launch
  169. In this mode the menu window will close and your selected program will be
  170. started. MenuMaster will then close down completely, leaving only your
  171. selected program running.
  172.  
  173.  
  174. COMMAND LINE TEXT GADGET
  175. ------------------------
  176. This too will be 'ghosted' until the user toggles the selector button ON/OFF
  177. gadget to 'ON'.
  178. Enter your command or program name here,just as you would at the CLI.
  179. It is best to specify the path if possible. Arguments or parameters to be
  180. passed to the command can also be included here, providing they are constant.
  181. i.e. 'LIST DF0:devs'
  182. If you wish to pass active arguments to the command then enter the
  183. command only here i.e 'DIR' and use the optional input requester to prompt
  184. you for, and collect your input at the time the command is executed.
  185. i.e. 'df0:c' is an argument which could be passed to the 'DIR' command.
  186. (See below for details on input requester)
  187.  
  188. Using Multiple Commands
  189. -----------------------
  190. MenuMaster will also accept multiple commands, separated by the '|' character
  191. (up to a maximum of 127 characters) to create pseudo batch files.
  192.   i.e.     DIR|ECHO "Click left mouse to continue"|RMOUSE.
  193. displays the current directory contents, prints a message, then uses a small
  194. utility program named RMOUSE to wait for a right mouse click, allowing the
  195. directory contents to be viewed prior to returning to the menu.
  196. Or......   CD dh0:Paint|PBrush
  197. will set the current directory to dh0:Paint, then run a program named PBrush.
  198. This is useful when programs need to be started from a certain directory so 
  199. that they can access their own files correctly.
  200. N.B. If an active input requester is selected with a multiple command list
  201. then this will apply only to the LAST command in the list.
  202. In the last example, an input requester could be used to prompt for the name
  203. of picture file used by the PBrush program.
  204.  
  205. INPUT REQUESTER ON/OFF GADGET
  206. -----------------------------
  207. This too will remain 'ghosted' until the user toggles the selector button
  208. ON/OFF gadget to 'ON'.
  209. This selects whether or not a requester for input will appear, directly after
  210. making a choice from the main menu.
  211.  
  212. INPUT REQUESTER PROMPT TEXT GADGET
  213. ----------------------------------
  214. This will remain 'ghosted' unless the user toggles the input requester
  215. ON/OFF gadget to 'ON'.
  216. A prompt can now be entered which will appear along with the input requester
  217. mentioned above.(Max. 71 characters)
  218.  
  219. RED/GREEN/BLUE SLIDER GADGETS
  220. -----------------------------
  221. Used to modify the colours of the screen and pointer.
  222.  
  223. SCREEN & POINTER COLOUR GADGETS
  224. -------------------------------
  225. The current selection is highlighted with a box. This is the colour
  226. which will be modified by the RGB sliders.
  227.  
  228. IMAGE GADGETS 
  229. -------------
  230. Selects which one of the four possible gadget images, is displayed on your
  231. main menu selection panel.
  232.  
  233. NORMAL SAVE GADGET
  234. ------------------
  235. Saves your menu data to the root directory as 'MenuMaster.datX', where
  236. X is the file number specified when you started MenuMaster.
  237. The main menu screen will then be updated with the changes.
  238.  
  239. SECURE SAVE GADGET
  240. ------------------
  241. This option will prompt you for a four digit security code prior to saving
  242. the data file. Remember it, as any future attempts at editing this data file
  243. will require entry of this code. 
  244.  
  245. CANCEL GADGET
  246. -------------
  247. All current edits are discarded and last saved items and colours are 
  248. re-displayed.
  249.  
  250.  
  251. USING MENUMASTER TO CREATE SUB-MENUS
  252. ====================================
  253. If you wish to create sub-menus then enter the command MenuMaster followed
  254. by a datafile number as one of your main menu options.
  255. i.e MenuMaster 2, or MenuMaster 2 NTSC.
  256. N.B. Unless you particularly want more than one menu open at the same
  257. time then you should always preselect the mode to 'LAUNCH', with a similar
  258. call from the sub-menu  (again using 'LAUNCH') to return to the main menu.
  259. This way one task is properly closed down before starting another.
  260. Should you require more than one menu open then set the preselect to
  261. 'EXECUTE' and the menus will be then stacked in front of each other.
  262.  
  263. That's it then. I hope you find this program as useful as I have.
  264. Thanks go out to the many people who have sent me PD disks, or written
  265. with suggestions for improvements, or just to say thank you for a nice
  266. utility. 
  267.                 
  268.                 Dave Matthewson.
  269.                 5, Sea View Villas,
  270.                 Mayfield Grange,
  271.                 Cramlington,
  272.                 Northumberland,
  273.                 ENGLAND
  274.                 NE239AD
  275.  
  276. P.S.
  277. ----
  278. As this is the final (and still absolutely free) version of this program 
  279. I am not providing any support for it. If you don't uderstand the docs then
  280. try putting down the joystick and reading the manual you got with this
  281. machine instead. Please don't call me !
  282. Hint: Try entering the command you wish to execute at the CLI prompt first.
  283. If it doesn't work from there then don't expect MenuMaster to run it either.
  284. Should you wish to show your appreciation for a useful program, and encourage
  285. PD writers to keep writing, then a copy of your latest amazing P.D. demo or
  286. utility disk is always welcome.
  287.