home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / bbs_ra / smenu110.arj / SMENU.DOC next >
Text File  |  1991-03-10  |  14KB  |  329 lines
  1.                      SMENU.EXE Version 1.10
  2.  
  3.                       Written by John Huls
  4.  
  5.  
  6.  
  7. Features:
  8. =========
  9.  
  10. -    Used for editing/creating menus used in SuperBBS
  11. -    Completely window driven
  12. -    Consequent use of keys throughout the whole program
  13. -    Completely mouse driven
  14. -    Includes all menu-types in SuperBBS
  15. -    Full color, although also usable on monochrome sets
  16. -    Intelligent asking for needed fields
  17.  
  18. New features for SMENU.EXE Version 1.10
  19.  
  20. -    Multilanguage Support built in
  21. -    Added support for multiline features new to SBBS 1.10
  22. -    Added help on the main-menu screen
  23. -    Added rudimentory show-feature
  24. -    Squashed some bugs in the previous version of SMENU
  25.  
  26. Introduction:
  27. =============
  28.  
  29. The program is used for creating and/or modifying menus used with
  30. SuperBBS version 1.10. This menu-editor was created because I
  31. missed some of the menutypes in current menu-editors. Besides that
  32. I disliked some features in other editors which I used to use while
  33. editing menus. After testing this program by various people I
  34. decided to donate this program to everybody, to be used and (I
  35. hope) appreciated...
  36.  
  37. Mouse Support:
  38. ==============
  39.  
  40. The complete program can be controlled by using a mouse. Menutypes
  41. can be selected by using the mouse to navigate between the various
  42. menutypes. You can also change color using the mouse and select all
  43. other options while in the Edit Window or on the Prompt Window. The
  44. only place where you cannot use the mouse is in fields which
  45. require manual input e.g. the User Display.
  46.  
  47. In this manual I will discuss the use of the menu's with use of the
  48. keyboard. However, on every place where you find the ENTER-key, you
  49. can also use the left mouse buttom. And whenever you see the use of
  50. the ESC key, you may use the right mouse button instead.
  51.  
  52. Environment:
  53. ============
  54.  
  55. SMENU.EXE can be started from anywhere on your system, as long as
  56. you set the environment variable SBBS to point to the directory
  57. where SuperBBS has stored it's system files. Enter in your
  58. AUTOEXEC.BAT something like:
  59.  
  60.      SET SBBS=C:\SUPERBBS[\]
  61.  
  62. Alternatively you can make the SuperBBS system directory the
  63. current one when you start up SMENU. The program will locate the
  64. file CONFIG.BBS and read it, to find out where the menu-files are
  65. stored on your system.
  66.  
  67. Usage:
  68. ======
  69.  
  70. By entering SMENU on the dos prompt you start up the program. It
  71. will show you an empty window which is titled NONAME.MNU. Also the
  72. path is given where the files will be saved after editing. You may
  73. also enter the name of a file which you want to edit on the
  74. commandline. Entering e.g. "SMENU FILES" will open the FILES.MNU
  75. file if it exists and display its contents on the screen. If the
  76. file does not exist, an empty screen will be displayed with the
  77. name given, ready to be edited.
  78.  
  79. Multilanguage Support:
  80. ======================
  81.  
  82. Whenever a file LANGUAGE.CTL is found in the system-directory of
  83. SuperBBS, the program will change to multilanguage support mode.
  84. You are presented with a screen which shows you all languages from
  85. which you can make you're choice. Selecting one will automatically
  86. select the corresponding menu-directory which you installed with
  87. LCONFIG.EXE from SuperBBS. After this you will end up in the SMENU
  88. main menu screen.
  89.  
  90. Screen display:
  91. ===============
  92.  
  93. When you start up SMENU you will be presented a window where the
  94. menulines used in your menu will be displayed. The screen is
  95. divided into several areas:
  96.  
  97. The top 24 lines form a window which displays as much lines as you
  98. have in your menu. If you have more than 22 lines, a bar will be
  99. displayed to the far right, showing the position of the cursor in
  100. the window.
  101.  
  102. Line 25 is a status and comment line. It shows the name and version
  103. of the program, a display with the cursor position and the total
  104. number of lines in the menu, a field which will indicate when a
  105. menu is changed and finally the name of the author. The cursor
  106. position will be something like 10/18. This means that the cursor
  107. is on position 10 and there are 18 menulines in this menu. If the
  108. "Changed" annunciator is present, any attempt to leave the program
  109. will ask you if you want to save the changes made.
  110.  
  111. The Menuline Wondow:
  112. ====================
  113.  
  114. Each line in the menu-window consists of the following parts:
  115.  
  116. The first field shows the User Display in the exact colors as it
  117. will appear later on the actual menu. The second field is the Key
  118. to be pressed for selecting that menu-option. The next field is an
  119. abbreviated description of the menu-type and the last field is the
  120. Optional Data field. In order not to disturb the actual color
  121. display, the cursor only consists of the last three columns. 
  122.  
  123. The cursor can be moved using the up and down keys or the mouse.
  124. Pressing ENTER (or left mouse-button) will select the highlighted
  125. option in the menu. The cursor can be moved one position farther
  126. than the actual number of menu-options. This is to allow the
  127. insertion of new menu-lines to the menu. The line will become
  128. active if it is actually selected. It will be marked on the status
  129. line in the cursor position field. The cursor position will be one
  130. more than the actual number of lines in the menu.
  131.  
  132. You can also insert a new line by moving the cursor to the desired
  133. position and hitting the INS-key. The menu-line under the cursor
  134. will be moved downwards thereby pushing all other lines one
  135. position further down.
  136.  
  137. A line can be deleted by selecting it with the cursor and pressing
  138. the DEL-key. A message will appear which asks it this is really
  139. what you want. Hitting any key but 'Y' will abort the delete
  140. function.
  141.  
  142. Main Menu Helpscreen:
  143. =====================
  144.  
  145. According to the SAA-standard, you should get help by hitting F1.
  146. This is true for the main menu. On the mainmenu you can get help by
  147. pressing ALT-H too (In fact any key that has no function on the
  148. main menu will provide you with the help screen. On this screen you
  149. can find options which are valid while working on the main menu.
  150. The helpscreen can be removed by hitting any key.
  151.  
  152. Editing a menu-line:
  153. ====================
  154.  
  155. When you have selected a menu line using the above method, you get
  156. a second window which is labelled -Menu Edit Window-. On this
  157. window you can edit any option of the menu. This can only be done
  158. when an option is actually valid for a chosen menu-type. E.g. the
  159. menu-type 0 (Display a textline) does NOT require a Hot- Key to be
  160. chosen, nor does it require Optional Data. Therefor you are not
  161. requested to fill in those options, because they do not even show
  162. on the Edit Window! This help you to find you're way in the
  163. multitude of functions offered by SuperBBS.
  164.  
  165. The Edit Window contains the following fields (if available).
  166. -    Prompt Text for editing the Overall Menu Options. We will come
  167.      to this later in detail.
  168.  
  169. -    Menu Type for selecting the desired menutypes.
  170. -    Security Level for selecting who may use the option.
  171. -    Text Color as shown on the previous menu for the User Text.
  172. -    Hot Key settings for selection of the key to select the menu.
  173. -    User Display which will be shown to your users.
  174. -    Optional Data which is required by some of the menus.
  175. -    A..D Flag Security for editing the flagpattern for access-   
  176.      control.
  177.  
  178. The first selection (Menu Type) is already highlighted and can be
  179. selected by pressing ENTER (or left mousebutton). The bar can be
  180. moved with the cursor up- and downkeys or with the mouse. You can
  181. also select one of the given options by pressing the highlighted
  182. first character of each option.
  183.  
  184. Menu Type:
  185. ==========
  186.  
  187. Selecting this option will open a pull-down menu, where you can
  188. select with mouse or cursor keys which type you need. The types are
  189. split up into 9 sections with types which are more or less related.
  190. Selection of one of the options can be done by pressing ENTER. If
  191. you press ESC, the previous menutype will be maintained. This kind
  192. of selections works throughout the whole program: Selection of an
  193. option by hitting ENTER, aborting a selection by hitting ESC. If
  194. for any reason you want to enter a new menutype which isn't used in
  195. the pull-down menu's yet (since they don't exist in this version of
  196. SuperBBS) you can select the Various pull-down, choose the Define
  197. Your Own Menu Type. You will then be asked to enter a two-digit
  198. number. If you enter a known type, it will be translated
  199. immediatelly to the known menutype and text.
  200.  
  201. Security Level:
  202. ===============
  203.  
  204. Here you can enter a number between 0 and 64000 for a security
  205. level to be used on this menu-option. Entering a value outside the
  206. bounds above will give an error-message on the 25th line. The error
  207. can be erased by hitting any key.
  208.  
  209. Text Color:
  210. ===========
  211.  
  212. Here you can select the User Displays normal color. The HighLight
  213. color can be set on the Prompt Menu. You see a box with all
  214. possible colors. With the help of the cursor-keys or the mouse you
  215. can select any color you like. During this selection the line
  216. "Color Example" will be shown in the selected color for better
  217. evaluation of it. Pressing ENTER will select this color, ESC will
  218. abort the option.
  219.  
  220. Hot Key:
  221. ========
  222.  
  223. Consists of two options. First you must choose whether or not you
  224. need automatic action of the menu-option. Selection can be done
  225. with the cursor-keys or the mouse. If you select Yes that's all
  226. there is .... If you select No, you are requested to enter the
  227. character that you want to use. You can use all standard characters
  228. here which can be printed from the keyboard. There is no difference
  229. between upper- and lower case. In fact Uppercase is the only
  230. possible option.
  231.  
  232. User Display:
  233. =============
  234.  
  235. Can be up to 75 characters wide. You can enter the text to be
  236. displayed to your users. Use of the character "^" for changing
  237. between highlight and normal color is the same as in the manual for
  238. SuperBBS is mentioned. You can also enter the characters ^F and ^K
  239. for displaying variables inside the menus. For more details see the
  240. manual of SuperBBS. The statusline gives information of special
  241. characters which can be used in the User Display line as well.
  242.  
  243. Optional Data:
  244. ==============
  245.  
  246. If the menu-option requires optional data this line is present.
  247. Else it will not be available. In that case it will be
  248. automatically set to an empty string. Again the statusline displays
  249. possible options which can be used on the line. For more details
  250. see SuperBBS manual.
  251.  
  252. Flags:
  253. ======
  254.  
  255. The display gives the flags as a string of "-" and "X". However,
  256. when entering the flag-mask, an "X" is used to set a flag, and any
  257. other character can be used to clear a flag. So entering "XZXCXXZQ"
  258. has the same result as entering "X-X-XX--". If you entered the
  259. wanted pattern you can keep it by hitting ENTER. Again ESC will
  260. abort the flag-setting. If you hit ENTER the new flags will be
  261. displayed with the usual characters ("-" and "X"), not in the
  262. actually entered characters. You can use the mouse or cursor keys
  263. to go to the place where you want the flag-bit changed. You don't
  264. need to type the whole string of flags if you only need to change
  265. one position.
  266.  
  267. General Menu Options:
  268. =====================
  269.  
  270. Selecting this option with the keyboard can be done by using the
  271. up- arrow when you are on the Menu-type prompt. You cannot get
  272. there by hitting the down-arrow when you are on the D-Flags
  273. settings. Of course you can hit 'P' to get there from any place in
  274. the Menu Edit Window.
  275.  
  276. If you select the Prompt Text option you will get another window
  277. which is labelled "Prompt Edit Window". On this window you can
  278. select options which apply to the complete menu. These include the
  279. HighLighted Color of the User Display, The Prompt Text and the
  280. PromptColor. The selection can be done in the same way as described
  281. above for the Menu Edit Window. Although this option appears on
  282. each menu-option line, you need only change it once for each menu.
  283. All changes will apply to the complete menu. You can leave the
  284. Prompt Edit Window by pressing ESC.
  285.  
  286. Pressing ESC (again) will save the changes you may have made to the
  287. current menu-line, and the window disappears. The Menu-line
  288. selection window will be updated if needed. If there was indeed a
  289. change in the menu-line, the "Changed"-annunciator will light up on
  290. the status-line, indicating that a change has occurred. 
  291.  
  292. Saving Menus:
  293. =============
  294.  
  295. If the Changed annunciator is present while pressing ESC once
  296. again, a question is asked if you want to save the changes made to
  297. the menu-file mentioned in the top-line. You are able to change the
  298. name of the file (ONLY the name need to be entered, NOT THE MNU-
  299. extension). If you press ESC once again, the file WILL NOT be
  300. saved. If you pressed ENTER the file will be saved, thereby
  301. overwriting an existing file.
  302.  
  303. Selecting a new File:
  304. =====================
  305.  
  306. If you choose to ESC from the Menu-line Selector Window you enter
  307. the File Selection Window. Here you can select a file to be edited
  308. or changed. By using the cursor keys or the mouse you can select
  309. the wanted file. The file can be selected by pressing ENTER when
  310. the cursor is on the wanted filename.
  311.  
  312. Quitting the program:
  313. =====================
  314.  
  315. If you are on the File Selection Window above, pressing ESC one
  316. more time will leave the program. The screen will be cleared and
  317. the program is terminated. 
  318.  
  319. That's All Folks:
  320.  
  321. If you have remarks, wishes or a contribution to make to the
  322. program, you can leave me a note on the following addresses:
  323.  
  324. FidoNet: 2:512/123
  325. SIGnet : 27:3331/1
  326. Snail  : Montgomerylaan 701, Eindhoven - Holland.
  327.  
  328. Any comments are welcome.
  329.