home *** CD-ROM | disk | FTP | other *** search
/ Computerworld 1996 March / Computerworld_1996-03_cd.bin / idg_cd3 / utility / minimnu2 / minimenu.doc < prev    next >
Encoding:
Text File  |  1996-02-14  |  11.9 KB  |  250 lines
  1.                               MiniMenu 2.0
  2.     Easy menu shell for children and anyone else who cannot (yet) read
  3.                   (C) 1993-1995 SichemSoft Netherlands
  4.  
  5. Introduction
  6. ------------
  7. This package was originally developed by us for our then 4 year old daughter.
  8. We wanted her to be able to start any program herself. Since she couldn't yet
  9. read, this was not possible without our help. We tried several shareware or
  10. public domain "easy" menu shell systems, but all required the user to be able
  11. to read. So, we wrote MiniMenu.
  12. Since then, MiniMenu has found use at private homes, elementary schools, and
  13. at institutions for mentally and/or physically handicapped people.
  14. The user only has to point to a picture button with the arrow keys or by
  15. repeatedly pressing Tab and then press Enter or click on it with the mouse.
  16. After the chosen program finishes, MiniMenu appears again, ready for the
  17. next choice. Submenu's are also possible.
  18. MiniMenu comes in versions for both MS-DOS and MS Windows. The parent or
  19. instructor only has to add one line to a text file and design or obtain
  20. an icon file and a just installed new game or educational program is
  21. instantly accessible for the user.
  22.  
  23. Important notice
  24. ----------------
  25. Please note that this package is for NON-PROFIT use only. Any commercial
  26. usage is STRICTLY prohibited. Neither the package, nor any part of it, may be
  27. sold. If you'd like to pass it on, you MUST include all original files in
  28. unmodified form.
  29. The MiniMenu package is provided as is. There are NO WARRANTIES expressed or
  30. implied. By using it you agree not to hold SichemSoft liable for any damages
  31. resulting from the use of or inability to use this software.
  32. MiniMenu is SHAREWARE. This means that when you have tried it out and
  33. decide to use it on a regular basis you are REQUIRED to register. This can
  34. be done at no charge at all, simply by sending us a picture postcard from
  35. where you live or work. On the back, please describe what you use MiniMenu
  36. for. The address is:
  37.  
  38.    Carel & Anneke Sicherer-Roetman
  39.    SichemSoft VoF
  40.    Roghorst 160
  41.    6708 KS Wageningen
  42.    Netherlands
  43.  
  44. If you have any questions or suggestions please send them to this address
  45. or email them to: anneke@chem.ruu.nl
  46.  
  47. > Although SichemSoft is a commercial software company, we have decided   <
  48. > to make MiniMenu available without any charge. Please keep your part of <
  49. > the bargain and DO register when you decide to use it!                  <
  50.  
  51. System requirements
  52. -------------------
  53. This program should run on any IBM-PC AT compatible computer with at least
  54. 512KB memory and running under DOS 5.x or later. It requires an EGA, VGA or
  55. Hercules graphics adapter or MS Windows 3.1. A mouse is recommended but not
  56. required. Many Super VGA adapters are supported.
  57.  
  58. Installation
  59. ------------
  60. Just copy all files to a directory, e.g. c:\minimenu.
  61. The package consists of the following files:
  62.  
  63. MINIMENU.DOC       You're reading it now
  64. MENU.EXE           MS-DOS executable
  65. WMENU.EXE          MS Windows executable
  66. XEXEC.DLL          DLL for spawning (MS Windows version)
  67. XADOS.EXE          DOS spawning engine (MS Windows Version)
  68. XAWIN16.EXE        Windows spawning engine (MS Windows version)
  69. BASIC.DAT          Basic data file
  70. MENU.CMD           Command file (example)
  71. MENU.DAT           Data file (example)
  72. GAMES.CMD          Second command file (example)
  73. GAMES.DAT          Second data file (example)
  74. TEST.BAT           Batch file for example
  75.  
  76. Copyrights
  77. ----------
  78. MiniMenu is (C) SichemSoft, Roghorst 160, 6708 KS Wageningen, Netherlands.
  79. MiniMenu was written in Borland C++ 4.0 and uses Zinc Application Framework
  80. 4.0 for it's GUI.
  81. MiniMenu's MS-DOS version uses the SPAWNO routines by Ralf Brown to minimize
  82. memory use while running other programs. It also uses a Super VGA driver by
  83. Jordan P.Hargrave.
  84. MiniMenu's MS Windows version uses the XSPAWN routines by Golan Yaniv to
  85. spawn child programs in MS Windows and wait for their completion.
  86.  
  87. Usage
  88. -----
  89. After installation, type "menu" at the prompt to see an example of how it
  90. works. If you have a mouse and use the MS-DOS version, load it's driver first!
  91. Use Tab and Enter or point and click to select your program. The button
  92. marked Games opens a submenu. Click on Stop or press Alt-F4 to quit.
  93.  
  94. The complete command line for starting MiniMenu is:
  95.  
  96. C> menu [ command file ] [ x ]
  97.  
  98. The command file name is optional. The default name is menu[.cmd].
  99. For a given set of programs, a command file must be prepared. When MiniMenu
  100. first starts up with a new or modified command file, it automatically
  101. generates a new data file (see below). On the user's computer only (w)menu.exe
  102. and these command and data files must be present. Both files are always
  103. expected to be in the current directory when (w)menu.exe starts. (w)menu.exe
  104. should be started from the autoexec.bat. If you have a mouse, be sure to
  105. precede this command by a command to load the mouse driver.
  106. In MS-DOS, generally 24 buttons can be displayed at once on VGA, 21 on Hercules
  107. and 16 on EGA. In MS Windows this depends on the installed graphics driver
  108. and font. If you need more buttons, use a submenu (see below).
  109. The second parameter is only useful if you have a Super VGA adapter and use
  110. the MS-DOS version. This gives you an 800x600 screen.
  111.  
  112. Command file
  113. ------------
  114. The command file is a plain text file that can be created with any text
  115. editor. It consists of comment lines, a header line and command lines.
  116. An example is given here:
  117.  
  118. * example MiniMenu command file
  119. * header line:
  120. &Quit     ; Games menu
  121. * program lines:
  122. * Captain Comic
  123. Comic     ; comic    ; c:\games\comic  ; comic.bat
  124. * Commander Keen
  125. Keen      ; keen     ; c:\games\keen   ; keen1.exe
  126. * Test program (blank icon)
  127. &Test     ; -        ; .               ; test.com 1 2 3
  128. * Shooting gallery
  129. Shootout  ; gun      ; d:\wargames     ; shoot.exe /l apple
  130. * Submenu
  131. Numbers   ; numbers  ; c:\education    ; @edu
  132. * (end)
  133.  
  134. Comment lines have a * at the very first position.
  135. The first non-comment line is the header. This line consists of two items
  136. that must be separated by a semicolon. The first item is the text that is
  137. to be displayed on the exit button. An ampersand can be used to designate
  138. a hot key. Hot keys are used by pressing Alt-(key) and shown on the button by
  139. underlining the 'hot' character. The second item is the text to be displayed
  140. in the title bar of the menu window. If you do not want to have an exit
  141. button, use - for it's text. The menu can still be exited with Alt-F4.
  142. The other non-comment lines each consist of four items, also separated by
  143. semicolons. The first item is the name of the program to be displayed on its
  144. button in the menu window. Here too, a hot key can be designated by preceding
  145. the chosen character with an ampersand. The second item is the name of the
  146. icon to be displayed on the button. This icon must reside in a data file, see
  147. below. A - indicates that no icon is present. The third item represents the
  148. complete drive+path where the program can be found (its home directory), this
  149. may also be just one dot to designate the current directory. The fourth item
  150. consists of the command to start the program from its home directory. This
  151. command should always include a .com, .exe. or .bat extension.
  152. If the command is prepended by a '@', it is taken as the filename of a
  153. new command file (without the .cmd extension!). This gives MiniMenu the
  154. possiblitity of using submenu's. In this case the home directory should
  155. contain both the icon file and the command file for the submenu. A submenu
  156. should always have an exit button to be able to revert to the previous menu.
  157.  
  158. Data file
  159. ---------
  160. The data file contains the icons in an internal format and is created and
  161. maintained automatically by MiniMenu when it detects a command file change.
  162. You will only notice a longer startup time after a command file change.
  163. MiniMenu then reads and converts all necessary icon files and creates
  164. a new data file. For this, it also needs BASIC.DAT in the current directory.
  165. Icons can be obtained from various sources. Many can be found on BBS's,
  166. simtel or garbo on Internet or can be obtained from user groups.
  167. You can also create your own with an icon editor like Ike (for Windows).
  168. The icons should be of the Windows 3.x .ico format. For an icon file to
  169. be valid for MiniMenu use, it must contain precisely one icon of 32x32
  170. pixels and a maximum of 16 colors. For the automatic maintanance feature it
  171. is required that an icon file resides in the home directory of the program
  172. to which it belongs.
  173.  
  174. Getting started
  175. ---------------
  176. To begin using MiniMenu in your situation follow the steps below. In this
  177. example it is assumed that the first program you want to add to MiniMenu
  178. is called prelude.exe and resides in the directory d:\apps\prelude.
  179.  
  180. 0. Install the prelude program package in d:\apps\prelude.
  181. 1. Design or obtain a suitable icon (32x32,16 colors) for the program.
  182. 2. Store this in an MS Windows .ico file and call it e.g. prelude.ico.
  183. 3. Put the .ico file in the home directory of the program (d:\apps\prelude).
  184. 4. Create a file menu.cmd in any text editor, like this:
  185.    * MiniMenu command file
  186.    * header:
  187.    &Quit    ; Make your choice:
  188.    * programs:
  189.    * Prelude music program
  190.    Prelude  ; prelude   ; d:\apps\prelude   ; prelude.exe
  191.    * (end)
  192. 5. Run MiniMenu from the directory where menu.cmd resides:
  193.    C> menu
  194. 6. If all goes well, two buttons will show up, the first being the button
  195.    with your icon for prelude, the second being the Quit button.
  196. 7. Test the first button and exit MiniMenu with the second after that.
  197. 8. To add further programs to MiniMenu, repeat the steps above. In step 4
  198.    just add one extra line for each new program.
  199.  
  200. Note for MS-DOS users
  201. ---------------------
  202. If you use the MS-DOS version of MiniMenu, it is important that you designate
  203. a swap directory. MiniMenu swaps itself out of the conventional memory to
  204. make room for the chosen program. If there is no extended memory, it will
  205. swap itself to disk. When the user turns the computer off during the chosen
  206. program, a hidden file, containing the swapped MiniMenu program, is left
  207. on disk. To ensure that the disk is not slowly filled up because of this,
  208. you must do the following:
  209. - make a swap directory e.g.: mkdir c:\minimenu\swap
  210. - add the following lines to your autoexec.bat file:
  211.   set SWAPDIR=c:\minimenu\swap
  212.   attrib c:\minimenu\swap\*. -h
  213.   del c:\minimenu\swap\*.
  214.  
  215. Note for upgraders from version 1.0/1.1 to version 2.0
  216. ------------------------------------------------------
  217. - In your command file(s) you have to add semicolons to separate the items
  218.   on the non-comment lines. This was necessary, because on some systems the
  219.   รก did not show up correctly as a space character in the name on a button.
  220. - The utilities addicon.exe , listicon.exe, delicon.exe and icon2dat.exe
  221.   can be deleted; MiniMenu now automatically takes care of the data file(s).
  222. - Submenu's should not be done anymore by recursively calling (w)menu.exe.
  223.   Use the '@'-trick (see above) instead.
  224.  
  225. Version history
  226. ---------------
  227. 1.0 (930112) : - initial release
  228. 1.1 (940919) : - added possibility to omit exit button in window
  229.                - added SWAPDIR environment variable for MS-DOS version
  230.                - improved error handling in MS Windows version
  231. 2.0 (950630)   - added automatic (re)generation facility for data files
  232.                - added Super VGA support in the MS-DOS version
  233.                - improved submenu facility
  234.                - improved placement of buttons in window
  235.                - improved button handling in MS Windows version
  236.                - made menu window full screen to keep the user from
  237.                  accidentally clicking outside the window
  238.                - iconified menu window in MS Windows version while a
  239.                  chosen application is running
  240.  
  241.  
  242. WE HOPE YOU AND YOUR CHILDREN/PUPILS/PATIENTS WILL ENJOY USING MINIMENU !!!
  243.  
  244. Carel & Anneke Sicherer-Roetman
  245. SichemSoft VoF
  246. Roghorst 160
  247. 6708 KS Wageningen
  248. Netherlands
  249.  
  250.