home *** CD-ROM | disk | FTP | other *** search
/ Shareware 1 2 the Maxx / sw_1.zip / sw_1 / UTILS / MNUMTC10.ZIP / MNUMATIC.DOC < prev    next >
Text File  |  1992-01-22  |  16KB  |  607 lines
  1.  
  2.  
  3.                         MenuMatic 1.0
  4.                  (c) 1991   JKS Computing
  5.  
  6.  
  7. What is MenuMatic?
  8.  
  9.  
  10. MenuMatic is a character based menu system that utilizes pop-up menus that
  11. are configured by the user.
  12.  
  13. It doesn't have a lot of fancy options that add extra overhead. It is a menu
  14. system.  Period.
  15.  
  16. It was written as a general purpose menu system.  However, MenuMatic may
  17. even be used for a front end to an application composed of many EXE files.
  18.  
  19. ------------------------------------
  20.  
  21. Requirements:
  22.  
  23. 300K of free RAM to run.  MenuMatic will work on a floppy.
  24. The ability to write batch files.
  25.  
  26.  
  27.  
  28.  
  29.  
  30.                         MenuMatic 1.0
  31.                  (c) 1991   JKS Computing
  32.  
  33.  
  34.         Section 1 ............ Features
  35.         Section 2 ............ Limitations
  36.         Section 3 ............ Getting Started
  37.         Section 4 ............ Setting Up Menu Files
  38.         Section 5 ............ The Config File
  39.         Section 6 ............ Command Line Options
  40.         Section 7 ............ Keys Used In MenuMatic
  41.         Section 8 ............ Misc.
  42.  
  43.  
  44.  
  45.  
  46. Section 1
  47. FEATURES:
  48.  
  49. MenuMatic has many options that allow you to control how the screen looks.
  50. The foreground and background colors of the main screen, the menus, the
  51. top and bottom messages lines of the screen may all be configured.
  52.  
  53. You determine what kind of border the pop-up menus will have, or even IF they
  54. will have a border.  You also determine that placing of the pop-up menus.
  55.  
  56. The background pattern may be determined by you as well.  You may even have
  57. a phrase as the background pattern.
  58.  
  59. The screen saver will blank your crt after a number of seconds that you
  60. specify.
  61.  
  62. Password protect whole pop-up menus, or items in individual menus.
  63.  
  64. If you prefer, none of the above items require your intervention. The
  65. built-in defaults work on both color and monochrome monitors.
  66.  
  67. MenuMatic takes 0K of the memory used to run your
  68. applications.
  69.  
  70. ----------------------
  71.  
  72. Section 2
  73. LIMITATIONS:
  74.  
  75. MenuMatic allows 1000 lines per menu file.
  76.  
  77. A menu line must be no longer than 60 characters.  This does not include
  78. comment lines, or leading spaces in indented menu lines ( see mnumatic.mnu ).
  79.  
  80.  
  81.  
  82.  
  83.  
  84. Section 3
  85. GETTING STARTED:
  86.  
  87. Put the disk containing MenuMatic into Drive A: and type the following:
  88.  
  89. A:INSTALL C:
  90.  
  91. C: is the drive you want to install MenuMatic on.  A directory named
  92. MNUMATIC will be created on the drive you indicate.
  93.  
  94. You may of course, use any drive or directory name that you like.  Keep in
  95. mind that if you choose to use a drive other than C: you will to modify
  96. the file MATIC.BAT to reflect these changes.  More on that later.
  97.  
  98. The MenuMatic files will now be copied to your hard drive.
  99.  
  100. After this is done, you will need to do one of two things to insure that
  101. MenuMatic will work properly.
  102.  
  103. 1.
  104.  
  105.    Copy the file "MATIC.BAT" to your DOS directory or any directory that is
  106.    included in your PATH setting.  Do this while in the directory where
  107.    MenuMatic is installed.
  108.  
  109.    For instance, type:
  110.  
  111.    COPY MATIC.BAT C:\DOS
  112.  
  113.    To run MenuMatic, you would now simply type:
  114.  
  115.    MATIC
  116.  
  117.    Before doing that however, you will need to set up your menu file.
  118.    See SETTING UP MENU FILES below.
  119.  
  120.    If you want MenuMatic to run each time you boot your computer, you will
  121.    need to add MATIC to your AUTOEXEC.BAT file.
  122.  
  123.  
  124. 2.
  125.    If you prefer, simply add MenuMatic to your PATH setting.  You do this by
  126.    modifying the AUTOEXEC.BAT file.
  127.  
  128.    If, for instance, your PATH looks like this:
  129.  
  130.    PATH=C:\DOS;C:\;C:\WP
  131.  
  132.    Simply change it to look like this:
  133.  
  134.    PATH=C:\DOS;C:\;C:\WP;C:\MNUMATIC
  135.  
  136.    Now DOS will always be able to find MenuMatic.
  137.  
  138.  
  139.  
  140.  
  141. Section 4
  142. SETTING UP MENU FILES
  143.  
  144. You are allowed up 1000 lines in a menu file. In actual practice,
  145. 300 lines or less works better (faster).  Menu choices are virtually
  146. unlimited, as you may load other menu files from within the menu.
  147.  
  148. Menu files may be indented for easier reading, but it is not required.
  149.  
  150. Each pop up menu may have up to 26 choices.  This corresponds to the
  151. letters in the alphabet, as each item may be chosen simply by pressing
  152. the letter that precedes it.
  153.  
  154. An item on a menu can either be used to create the tmp batch file and run
  155. your program, pop up another menu, or load a new menu file.
  156.  
  157. Take a look at mnumatic.mnu.  The structure of the file is similar to a
  158. simple program. The mnemonic MB means 'menu begin'.  For each 'MB' there
  159. must be a corresponding 'ME'.  If there isn't, the program will abort with
  160. a message.
  161.  
  162. Lines in the file are limited to 60 characters.  However, the lines may be
  163. indented so that the structure of the menu file will be easy to follow.
  164. The 60 character limit does not include leading spaces.  They are removed
  165. internally at the time MenuMatic reads the menu file.
  166.  
  167. Before diving in to changing the menu, let's see it work.
  168.  
  169. From the directory that MenuMatic was installed in, type the following:
  170.  
  171. MNUMATIC
  172.  
  173. This is a simple example menu.  You may navigate through the menu by simply
  174. using the Arrow keys. The up-arrow and down-arrow will take you through the
  175. choices in the current menu.  The right-arrow will choose the option that
  176. the menu bar is currently on.  The left-arrow will exit to the previous menu.
  177. If you are already at the top menu, it will exit MenuMatic.
  178.  
  179. Try choosing one of the spread sheet options.  After exiting MenuMatic, type
  180. the following:
  181.  
  182. TYPE MNUTEMP.BAT
  183.  
  184. This is the batch file that would be used to run your application.  You can
  185. see that the batch file would automatically run MenuMatic when you are done
  186. with the application.  This is how MenuMatic avoids using any of your RAM
  187. when running an application.
  188.  
  189. There are 2 files that control MenuMatic. The menu file, and the
  190. configuration file.
  191.  
  192. Strictly speaking, the configuration file is not necessary, so we will
  193. consider the details of the menu file first.
  194.  
  195. First we will briefly look at the elements of the menu file.
  196.  
  197.  
  198.  
  199. Following are the mnemonics used in MenuMatic, with detailed explanations
  200. after that.
  201.  
  202. MB>                  - indicates beginning of a menu
  203.                      - coordinates for menu to appear after MB - required
  204.  
  205. O> ption             - identifies options on menus to appear on screen
  206. MS>                  - message to appear on bottom line of screen
  207.                      - appears immediately after 'O' mnemonic
  208. B> atch command      - command performed via batch
  209. P> assword           - self explanatory.
  210. C> omment            - ditto. may appear anywhere
  211. L> oad new menu      - load a new menu
  212. ME>                  - indicates end of a popup menu
  213.  
  214.  
  215. upper or lower case is acceptable. don't mix case on individial mnemonics
  216. however.
  217.  
  218. example: 'Mb' or 'mB' would be unacceptable
  219.  
  220.  
  221.  
  222. MB - Menu Begin. This will be the first line in any menu file.
  223.      ( excluding comments )
  224.      it will be followed by two numbers. one to specify the menu row, and
  225.      one to specify the menu column.
  226.  
  227.      Any value from 0 - 24 may be specified for the row. Any value from
  228.      0 - 79 may be specified for the colummn.
  229.  
  230.      These values refer to the upper left hand corner of the menu.
  231.  
  232.      MenuMatic will compensate for any values that would block the top
  233.      or bottom rows, or go off the edge of the screen.
  234.  
  235.      example: MB 10 30
  236.  
  237. O  - Option.  the items that will appear in the menu
  238.  
  239.      example: O Word Perfect
  240.  
  241. MS - Message Line. These will be used immediately after an 'O' option line.
  242.      The message will appear centered on the bottom line of the screen.
  243.      Lines that are too long will be truncated.
  244.  
  245.      example:  MS This Is Your Billing Program
  246.  
  247.  
  248.  
  249. P  - Password. up to 10 characters in password. case is unimportant, and
  250.      spaces are not allowed.  Passwords may be used to protect the
  251.      following options:
  252.  
  253.      O - the password line should appear after the 'O' line, and after the
  254.          'MS' line if there is one
  255.  
  256.          example:    O Word Perfect
  257.                         MS Write Your Letters Here
  258.                         P  foxtrot
  259.  
  260.      B - the password may appear anywhere in the lines that create the batch
  261.          file.  it would be a good practice to put them first, just for
  262.          ease of maintainence.
  263.  
  264.          example: P tenfour
  265.                   B c:
  266.                   B cd \lotus
  267.                   B 123
  268.                   B cd \
  269.                   B d:
  270.  
  271.  
  272. B  - Batch file lines. these lines are the ones that will be written out
  273.      to the temorary batch file used to run your program.
  274.      If a line is over 60 chrs, the program will abort and tell you the
  275.      line number to check in the file.
  276.  
  277.      example: O Tapcis ( Compuserv )
  278.               MS Use This For Use In The Forum's
  279.                  B e:
  280.                  B cd \tapcis
  281.                  B tapcis
  282.                  B cd \
  283.  
  284.  
  285. C  - Any line beginning with a 'C' is treated as a comment.
  286.  
  287. L  - Load another menu.  For instance:
  288.  
  289.                 L /mNEWMENU.MNU         ( the '/m' is required )
  290.  
  291. ME - Menu End.  See examples.
  292.  
  293.  
  294. The minimum menu file would be as follows
  295.  
  296.         MB 10 20
  297.            O This Is A Minimum Menu
  298.         ME
  299.  
  300. This doesn't do much, but it is the minimum required menu.
  301.  
  302.  
  303.  
  304. A menu that would be slightly more practical would look like this:
  305.  
  306.         MB 10 20
  307.            O Word Processor
  308.               B d:
  309.               B cd \wp
  310.               B wp
  311.               B cd\
  312.               B c:
  313.         ME
  314.  
  315. This menu only has one choice.  But you can clearly see how it works.
  316.  
  317. This is how is would look with a message line and a password
  318.  
  319.         MB 10 20
  320.            O Word Processor
  321.            MS This is where you write letters
  322.            P  gonefishin
  323.               B d:
  324.               B cd \wp
  325.               B wp
  326.               B cd\
  327.               B c:
  328.         ME
  329.  
  330.  
  331. Section 5
  332. CONFIGURATION FILE:
  333.  
  334. Strictly speaking, this file is not necessary.
  335.  
  336. MenuMatic program has internal defaults for all of these options.
  337. If this file is missing, it simply uses the internal defaults
  338.  
  339. Using this file will let you specify colors of menus, menu text,
  340. background and foreground.
  341.  
  342.  
  343.  
  344. The default colors will be sensitive to monochrome or color monitor
  345. adapters also.
  346.  
  347. The names are fairly descriptive, and defaults will be indicated
  348.  
  349. Legal colors - foreground, background, menubar and border
  350.               black
  351.               blue
  352.               green
  353.               cyan
  354.               red
  355.               magenta
  356.               brown
  357.               yellow
  358.               white
  359.  
  360. Foreground colors only
  361.               light_grey
  362.               dark_grey
  363.               light_blue
  364.               light_green
  365.               light_cyan
  366.               light_red
  367.               light_magenta
  368.  
  369. AUTORETURN will automatically add string contained
  370. in AUTOBATNAME if set to YES ( if you haven't already included "matic.bat" )
  371.  
  372. This makes it unnecessary for you to remember to add the line at the end
  373. of each batch file to re-call MenuMatic.  It does it for you.
  374.  
  375.  
  376. The name of the initial batch file to run MenuMatic
  377. eliminates need to MATIC.BAT in your menu files.
  378. This will cause MenuMatic to append the command line to re-run MATIC.BAT
  379. when leaving your application.  The default is YES
  380.  
  381. AUTO RETURN=yes
  382.  
  383.  
  384. The name of temporary batch file to create and run - this is default value
  385.  
  386. AUTO TEMP BAT=mnutemp.bat
  387.  
  388. The name of the batch file to start MenuMatic - This is default value
  389.  
  390. AUTO BAT NAME=matic.bat
  391.  
  392. Protect menu edit function
  393. Default is nothing
  394.  
  395. EDIT PASSWORD= edit
  396.  
  397.  
  398. No exit to DOS without password
  399. Default is nothing
  400.  
  401. EXIT PASSWORD= exit
  402.  
  403.  
  404.  
  405. Character for screen background - this is default
  406. This may be a phrase, or any character you like.
  407.  
  408. SCREENCHAR=<░>  or
  409. SCREENCHAR=<Mollies Cookie Cutters, Inc.   >
  410.  
  411. This is the text that will be displayed at the top of the screen
  412. Does not work in the shareware version
  413.  
  414. TOP BAR TEXT = "JKS Computing"
  415.  
  416. !! Monochrome monitors:
  417.    If using a monochrome monitor, don't specify any colors.
  418.    The defaults will work fine.
  419.  
  420.  
  421. Screen background
  422. Default is blue
  423.  
  424. SCREEN BACK COLOR = blue
  425.  
  426. Foreground color
  427. This is default
  428.  
  429. SCREEN FORE COLOR = light_grey
  430.  
  431. Menu text color
  432. This is default
  433.  
  434. MENU FORE COLOR = yellow
  435.  
  436. Menu background color
  437. This is default
  438.  
  439. MENU BACK COLOR = cyan
  440.  
  441. Menu frame color
  442. This is default
  443.  
  444. BOX FRAME COLOR = light_magenta
  445.  
  446. Menu frame background color
  447. This is default
  448.  
  449. BOX BACK COLOR = cyan
  450.  
  451. Menu bar text color
  452. c default is light_blue
  453.  
  454. MENU BAR FORE COLOR = light_green
  455.  
  456. Menu bar background color
  457. This is default
  458.  
  459. MENU BAR BACK COLOR = white
  460.  
  461. Frame type - panel, double, single
  462. This is default
  463.  
  464. FRAMETYPE=single
  465.  
  466.  
  467.  
  468. Text bar color at top of screen
  469. Default is cyan
  470.  
  471. TOP BAR COLOR = blue
  472.  
  473. Message row color
  474. Default is cyan
  475.  
  476. BOTTOM BAR COLOR = blue
  477.  
  478. Screen Border Color
  479. This is default
  480.  
  481. BORDER COLOR = cyan
  482.  
  483. Specify the editor to use when editing files
  484. If using 'edlin' don't specify a path
  485. Otherwise, specify drive and path
  486. Any ascii editor will work
  487.  
  488. EDITOR=c:\q\q.exe
  489.  
  490.  
  491. How many seconds before screen saver kicks in
  492. This is default
  493.  
  494. SAVE SCREEN TIME = 300
  495.  
  496. If you have video problems(your computer isn't a clone) , set
  497. to YES - default is NO
  498.  
  499. USE DOS VIDEO = NO
  500.  
  501.  
  502. Clear screen when when running batch file? - default is no
  503. If set to YES, MenuMatic will clear the screen when exiting.
  504.  
  505. EXIT CLEAR = NO
  506.  
  507. Use mouse?
  508. Default is no - however, MenuMatic will use the mouse if it finds one
  509. Unless you specify NO here
  510.  
  511. USE MOUSE = YES
  512.  
  513.  
  514.  
  515. Section 6
  516. COMMAND LINE OPTIONS
  517.  
  518. to run the program, use MATIC.BAT.  you may specify the /edit parameter
  519. when calling MATIC.BAT or just put it in the batch file
  520.  
  521. these may be changed in the batch file matic.bat
  522.  
  523. this program may be installed in any directory, with the following caveats:
  524.  
  525.         the file MATIC.BAT must be located in the PATH.
  526.  
  527.         MATIC.BAT must be modified to reflect the location of mnumatic
  528.  
  529.         For instance, if you installed MenuMatic on Drive D:, you must
  530.         change all references to drive 'C:' in MATIC.BAT to 'D:'.
  531.  
  532.  
  533. /m  the menu to load            EXAMPLE:    /mmnumatic.mnu
  534.  
  535. /c  the configuration file      EXAMPLE:    /cconfig.mnu
  536.  
  537. /edit  allows editing the menu and configuration files from within
  538.        MenuMatic
  539.  
  540. Section 7
  541. KEYSTROKES
  542.  
  543. A-z: choose option on menu
  544.  
  545. PageDown, PageUp, Down/Up Arrow, Home, End, Mouse:  scroll through menu
  546.  
  547. ENTER, Right Arrow, Left Button On Mouse: choose current item
  548.  
  549. ESC, Left Arrow, Right Button on Mouse: exit menu
  550.  
  551. ALT-Q : leave immediately
  552.  
  553. ALT-E : edit menu or configuration file. only works if /edit was
  554.         entered on command line
  555.  
  556. ALT-B : blank screen immediately
  557.  
  558. ALT-V : show version of MenuMatic
  559.  
  560.  
  561.  
  562. Section 8
  563. MISC.
  564.  
  565. What is shareware?
  566.  
  567. It is a try before you by arrangement.
  568.  
  569. You try MenuMatic for 30 days.  If you like it, and continue using it, please
  570. register it.  An order form is included for your convenience. It is called,
  571. appropriately enough, ORDER.FRM.
  572.  
  573. MenuMatic is reasonably priced at $20.  When you register, you will receive
  574. a copy of MenuMatic that doesn't always remind you that you haven't
  575. registered yet.
  576.  
  577. You will also be helping someone that is trying to making a living at writing
  578. software that works, and selling it for a reasonable price.
  579.  
  580. Consultants; if you like MenuMatic, and would like to install it on your
  581. customers machines, you may purchase 10 copies of MenuMatic for $100.
  582.  
  583. Any who are interested in a Site License agreement, please contact me by
  584. writing:
  585.  
  586.         JKS Computing
  587.         126 South Meridian
  588.         Fresno CA  93702
  589.  
  590. or calling:
  591.  
  592.         (209) 454-8803
  593.  
  594. or email:
  595.  
  596.         Compuserve:     73617,3036
  597.  
  598.         GENIE:          JSTILL2
  599.  
  600.  
  601. Bugs:
  602.         If you find a bug in MenuMatic, please notify me by filling out
  603.         BUG.FRM and mailing it to the above address.  Or email it.
  604.  
  605. Enjoy!
  606.  
  607.