home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / SPITFIRE / SFMNUEXT.ZIP / SFMNUEXT.DOC < prev    next >
Text File  |  1994-01-26  |  19KB  |  395 lines
  1.                                   SFMNUEXT
  2.                            SPITFIRE MENU EXTENSION              
  3.                                Version 1.5a
  4.                    Copyright (C) By Mike Woltz 1989, 1994
  5.                            Buffalo Creek Software    
  6.  
  7.  
  8.     INTRODUCTION
  9.     ------------  
  10.      
  11.        SFMNUEXT is a utility written by Mike Woltz, author of SPITFIRE, to
  12.     expand the Sysop Configurable Menu options available from SPITFIRE's
  13.     Main, Message and File Menus.  SFMNUEXT will allow a menu to be created
  14.     from each of the existing Sysop Configurable command options which will 
  15.     allow up to 24 additional features per menu.  SFMNUEXT will also work 
  16.     from the SPITFIRE Door Menu but is not intended in any way to replace 
  17.     or substitute Wildfire.  Each SPITFIRE Menu Extension can also be used
  18.     to call another Menu Extension, so that the number of options which 
  19.     SFMNUEXT can expand to is unlimited.
  20.    
  21.    
  22.     HOW IT WORKS 
  23.     ------------
  24.     
  25.        It is recommended that SFMNUEXT.EXE be placed in a directory
  26.     made directly off your main SPITFIRE directory.  For the purpose
  27.     of explanation, this directory will be titled SFEXTEND.  If you need
  28.     additional information on making a directory, refer to your DOS
  29.     manual.  If you are running SPITFIRE from drive C:\ and your
  30.     main SPITFIRE directory is named SF and the directory created
  31.     for SFMNUEXT is named SFEXTEND it would look like this:
  32.     
  33.     C:\SF\SFEXTEND
  34.     
  35.        Place SFMNUEXT.EXE in this directory.  SFMNUEXT is designed so
  36.     it is NOT necessary to have multiple copies existing on the drive.  
  37.     One common file will work for each of the functions you wish to perform,
  38.     whether the menu you wish to extend is from the Main Menu, Message Menu, 
  39.     File Menu, Door Menu, or any combination of these.
  40.  
  41.        If you wish to use SFMNUEXT from the Main, Message or File Menu's
  42.     Sysop Configurable command, the appropriate .BAT file (SFMAIN.BAT,
  43.     SFMESS.BAT and/or SFFILE.BAT) should be replaced (or modified) with 
  44.     those included in the SFMNUEXT.ZIP file archive.  Similarly, if you
  45.     wish to use SFMNUEXT from the SPITFIRE Door Menu, the SF.BAT will
  46.     need to be modified to CALL the SFDOREXT.BAT included in the 
  47.     SFMNUEXT.ZIP file archive.  These batch files provide the necessary 
  48.     Errorlevel commands to execute a particular SFMNUEXT menu option.  
  49.     The(se) batch files must reside in the main SPITFIRE directory.
  50.     
  51.        To properly understand how all this ties together, a brief
  52.     description of what happens when using SFMNUEXT will be beneficial.
  53.     For purposes of explanation, let's assume SFMNUEXT is being run from
  54.     the Sysop configurable command of the Main Menu.  When the Sysop
  55.     Configurable option is selected, SPITFIRE shells to the SFMAIN.BAT
  56.     file.  The SFMAIN.BAT will copy the SFMAIN.DAT file to the directory
  57.     where SFMNUEXT resides (C:\SF\SFEXTEND) and change to the \SF\SFEXTEND
  58.     directory.  The SFMNEXT.MNU is displayed to the caller.  When an
  59.     option is selected from the Menu, the corresponding Errorlevel will
  60.     execute the appropriate commands (to enable program execution).  
  61.     During the execution of the program, SFMNUEXT will terminate from
  62.     memory.  When the selected program is terminated, the caller is
  63.     returned to the SFMNUEXT.  Here, another program may be selected
  64.     (if available), or the caller may opt to <G>oodbye & LogOff the BBS
  65.     or <Q>uit and return to SPITFIRE.  (NOTE:  The <G>oodbye & LogOff
  66.     option will not display when logged on locally.  It will only 
  67.     display to a remote caller.)
  68.  
  69.  
  70.  
  71.     SFMNUEXT MENU FILES
  72.     -------------------
  73.     
  74.        Regardless of whether, SFMNUEXT is run as one of the Sysop 
  75.     configurable command options or from the SPITFIRE Door Menu, a menu 
  76.     file must be created.  The extended menu can be created using your 
  77.     favorite text editor (as long as it saves in ASCII format) and should
  78.     describe the features you have available.  When SFMNUEXT is executed, 
  79.     depending on which data file is found (SFMAIN.DAT, SFMESS.DAT, SFFILE.DAT 
  80.     or SFDOORS.DAT), SFMNUEXT will look for the corresponding menu.  These
  81.     are SFMNEXT.MNU, SFMESEXT.MNU, SFILEEXT.MNU or SFDOREXT.MNU.  In other 
  82.     words, if you are using SFMNUEXT as a Sysop Configurable Command from 
  83.     the Main Menu, a SFMNEXT.MNU will need to be created, or from the 
  84.     SPITFIRE Door Menu, a SFDOREXT.MNU will need to be created, etc.  Sample
  85.     *.MNU files are included in the distribution package.
  86.        
  87.        Alphabetical characters are used to initiate the SFMNUEXT commands.
  88.     A through Z, with two exceptions.  The <G>oodbye is used to log the
  89.     remote caller off the BBS and the <Q>uit is used to return the caller to
  90.     the menu from which the SFMNUEXT is executed.  The menu files used by 
  91.     SFMNUEXT should be created using the following format:
  92.    
  93.     Program description,[xx],,[=]
  94.    
  95.     with each program listed on a separate line of the .MNU file.  Notice
  96.     each line begins with the description of the program to executed, 
  97.     followed by a comma, the security level required by the caller for
  98.     the program to be able to be accessed, followed by two commas, and
  99.     an equal to or greater than sign.  If the equal to sign is used the
  100.     caller's security must be equal to the security specified and if
  101.     the greater than sign is used the caller's security level must be
  102.     either equal to or greater than the security level specified.  The
  103.     program description must be no longer than 24 characters. Also
  104.     notice, it is not necessary to include the command character (A 
  105.     through Z) since these are automatically added by SFMNUEXT.  
  106.  
  107.        SFMNUEXT will also allow Sysop created RIP, Ansi and Non-Ansi
  108.     menu display files to be created.  These are MNEXT[x].BBS/CLR/RIP,
  109.     MSEXT[x].BBS/CLR/RIP, FEXT[x].BBS/CLR/RIP and DREXT[x].BBS/CLR/RIP
  110.     where [x] is equal to the security of the caller.  The [x] security
  111.     is used to insure the caller does not have options displayed that
  112.     are unavailable to their particular security level.  The 
  113.     MNEXT[x].BBS/CLR/RIP would be accessed from the Main Menu Sysop
  114.     Configurable command.  The MSEXT[x].BBS/CLR/RIP would be accessed
  115.     from the Message Menu Sysop Configurable command.  The FEXT[x].CLR/BBS/RIP
  116.     would be accessed from the File Menu Sysop Configurable command.
  117.     And the DREXT[x].BBS/CLR/RIP would be accessed from one of the SPITFIRE 
  118.     Door Menu options.  Sample MNEXT10.BBS/CLR/RIP, MSEXT10.BBS/CLR/RIP, 
  119.     FEXT10.BBS/CLR/RIP and DREXT10.BBS/CLR/RIP are included in SFMNUEXT's
  120.     distribution package.
  121.    
  122.    
  123.        
  124.     USING SFMNUEXT FROM A SPITFIRE MENU
  125.     -----------------------------------
  126.     
  127.        SPITFIRE has a Sysop configurable command for the Main, Message 
  128.     and File menus.  The Sysop configurable command is executed through 
  129.     a batch file which corresponds to the menu it is being run from.  In
  130.     other words, SFMAIN.BAT runs the Sysop configurable command from the
  131.     Main Menu, SFMESS.BAT runs the one from the Message Menu and SFFILE.BAT 
  132.     the one from the File Menu.  The commands necessary to execute SFMNUEXT
  133.     and enable the extended menus are set up in the batch file which 
  134.     corresponds to the menu you wish to have program run from.
  135.  
  136.        The first thing you will need to establish is which of these menus
  137.     you wish to use to run the SPITFIRE Menu Extension program.  For 
  138.     this purpose, let's assume that it is going to be set up so it can be 
  139.     run from the Main Menu.  (It should be noted the set up procedure will 
  140.     be the same regardless of which Menu you are running SFMNUEXT from.)
  141.  
  142.        Next, you will need to decide what you wish to name the command
  143.     option and establish what security level will be required for
  144.     users of your system to be able to access this option.  Once this
  145.     is determined you will need to modify the SFMAIN.MNU file using
  146.     your favorite text editor, as long as it saves in ASCII format.
  147.     (Refer to the SPITFIRE manual for further documentation on this
  148.     if needed.  It should also be noted that if SFMNUEXT were being
  149.     set up to run from the File Menu, you would need to modify the
  150.     SFFILE.MNU file and if it was being set up to be run from the
  151.     Message Menu you would need to modify the SFMSG.MNU file.)
  152.  
  153.        Examining the default SFMAIN.MNU file, you will notice the Sysop
  154.     configurable command appears as:
  155.  
  156.        <K>............. Main Menu Extension,,1000,@
  157.  
  158.        This will need to be replaced with a Command Character that will
  159.     be used to select the option from the menu.  It is ASOLUTELY IMPERATIVE
  160.     that the Command Character must not duplicate an existing Command
  161.     Character for another menu option.  You will then need to include
  162.     a brief description of the Extended Menu option you will be using, 
  163.     two commas, the security level required to access this feature, and 
  164.     another comma followed by the a @.  The @ must not be changed! (For 
  165.     more detailed information on modifying your SFMAIN.MNU, SFMSG.MNU or 
  166.     SFFILE.MNU refer to your SPITFIRE manual.)  When finished, your 
  167.     menu line should look something like this:
  168.     
  169.        <K>.... Brief Program Description,,10,@
  170.  
  171.        When this is completed, you will need to create a SFMNEXT.MNU file
  172.    as described earlier in this documentation (SFMNUEXT MENU FILES).
  173.  
  174.        Now you will need to modify the corresponding batch file, SFMAIN.BAT,
  175.     so that it can be executed from the Main Menu.  Do this using your
  176.     favorite text editor, as long as it saves in ASCII format.  (Again, it
  177.     should be noted that if SFMNUEXT were being set up to run from the File 
  178.     Menu, you would need to modify the SFFILE.BAT file and if it was being 
  179.     set up to be run from the Message Menu you would need to modify the 
  180.     SFMESS.BAT file.)
  181.  
  182.        Each of these .BAT files include the BRK OFF and BRK ON commands.
  183.     This is to prevent caller's from using CTRL BRK to break out of your 
  184.     batch files and gaining access to your system at the DOS level.  If 
  185.     you are not currently using BRK (have DEVICE=BRK.DRV in your CONFIG.SYS) 
  186.     it is strongly recommended that you do so before using SFMNUEXT.
  187.     (BRK is written and copyrighted by Solid Systems, 1985, but can 
  188.     be downloaded from Buffalo Creek's BBS as well as a number of other 
  189.     BBS systems.) 
  190.            
  191.        Notice the contents of the batch file provide the appropriate error
  192.     codes for the execution of each menu option.  Further down the batch
  193.     file you will see:   
  194.     
  195.        :EXTEND_A
  196.        REM Place EXTENSION A Commands Here
  197.        GOTO LOOP
  198.  
  199.        The commands you will need to run your desired option should be
  200.     placed between the :EXTEND_A and the GOTO LOOP statements in place
  201.     of the existing REM Place EXTENSION A Commands Here.   
  202.  
  203.        Once again, sample SFMAIN.BAT, SFMESS.BAT and SFFILE.BAT are included
  204.     in SFMNUEXT's distribution package.  It is strongly recommended these 
  205.     be modified and used in place of SPITFIRE's sample SFMAIN.BAT, SFMESS.BAT 
  206.     and SFFILE.BAT to insure the proper ERRORLEVEL codes and Extended options
  207.     be available.
  208.     
  209.     
  210.     
  211.     USING SFMNUEXT TO RUN A SPITFIRE DOOR
  212.     -------------------------------------
  213.        
  214.        The first thing you will need to be concerned with when using
  215.     SFMNUEXT to run a SPITFIRE door will be to create or modify an existing
  216.     SFDOOR.MNU.  Using your favorite text editor you will need to
  217.     include a line that contains a brief description of the extended menu
  218.     you intend to run, a comma, and the security level required by the
  219.     user to access this extended menu.  (The line number should correspond 
  220.     to the door number you are running your extended menu in.  In other
  221.     words, if the extended menu will be option A of your SPITFIRE Door
  222.     Menu then it should be on the first line of the SFDOOR.MNU file,
  223.     option B, the second line, etc.)
  224.     
  225.        A typical line of your SFDOOR.MNU might look like this:
  226.     
  227.     The Extended Menu Description,10
  228.     
  229.        If you are using SFDR[x].BBS/CLR Sysop created non-Ansi and Ansi
  230.     menus these will need to be modified also.
  231.     
  232.        Once this is completed, you will need to modify the SF.BAT using
  233.     your favorite text editor (as long as it saves in ASCII format) to
  234.     run SFMNUEXT from the SPITFIRE Door Menu.  Sysops using DOS Version
  235.     3.3 or higher can use DOS's CALL command to execute SFDOREXT.BAT
  236.     from the SF.BAT.  Sysops using DOS versions 3.2 or older may use
  237.     Buffalo Creek Software's "CALLBAT" utility to execute SFDOREXT.BAT
  238.     from the SF.BAT.
  239.  
  240.        DOS's CALL command and the CALLBAT utility allows one batch file
  241.     to be run from another batch file and then returns to the original
  242.     batch file when the called batch files execution is completed or
  243.     terminated.  Without using the CALL command or the CALLBAT utility, 
  244.     when the second batch file is completed or terminated, the caller 
  245.     would be returned to the DOS prompt.  For this set up, refer to the 
  246.     sample batch files which are included for reference.  These are 
  247.     SFBAT.SAM and SFDOREXT.BAT.
  248.  
  249.     **IMPORTANT NOTE**  If you have DOS version 3.3 or higher, Buffalo
  250.     Creek Software strongly recommends this be used rather than the 
  251.     CALLBAT utility.
  252.  
  253.     Using The CALL Command In SF.BAT For SMNUEXT 
  254.     --------------------------------------------
  255.        
  256.        The first thing you will need to do is modify your SF.BAT file 
  257.     with your favorite text editor.  Locate the line which contains 
  258.     :DOOR_A.  Your SF.BAT should look like this:
  259.  
  260.        :DOOR_A
  261.          CALL SFDOREXT
  262.          GOTO LOOP
  263.        :DOOR_B
  264.  
  265.        When this is completed, you will need to create a SFDOREXT.MNU file
  266.     as described earlier (in the SFMNUEXT MENU FILES section of this 
  267.     documentation).
  268.  
  269.        Next you will need to modify the included sample SFDOREXT.BAT to 
  270.     include the program(s) you wish to run with your extended menu.  
  271.       
  272.        Notice the contents of the batch file provide the appropriate error
  273.     codes for the execution of each menu option.  Further down the batch
  274.     file you will see:   
  275.     
  276.        :EXTEND_A
  277.        REM Place EXTENSION A Commands Here
  278.        GOTO LOOP
  279.  
  280.        The commands you will need to run your desired option should be
  281.     placed between the :EXTEND_A and the GOTO LOOP statements in place
  282.     of the existing REM Place EXTENSION A Commands Here.  These must be
  283.     valid DOS commands, program execution, etc.
  284.  
  285.    
  286.  
  287.     Using The CALLBAT Utility In SF.BAT For SMNUEXT 
  288.     -----------------------------------------------
  289.        
  290.        The first thing you will need to do is modify your SF.BAT file 
  291.     with your favorite text editor.  Locate the line which contains 
  292.     :DOOR_A.  Your SF.BAT should look like this:
  293.  
  294.        :DOOR_A
  295.          CALLBAT SFDOREXT
  296.          GOTO LOOP
  297.        :DOOR_B
  298.  
  299.        When this is completed, you will need to create a SFDOREXT.MNU file
  300.     as described earlier (in the SFMNUEXT MENU FILES section of this 
  301.     documentation).
  302.  
  303.        Next you will need to modify the included sample SFDOREXT.BAT to 
  304.     include the program(s) you wish to run with your extended menu.  
  305.       
  306.        Notice the contents of the batch file provide the appropriate error
  307.     codes for the execution of each menu option.  Further down the batch
  308.     file you will see:   
  309.     
  310.        :EXTEND_A
  311.        REM Place EXTENSION A Commands Here
  312.        GOTO LOOP
  313.  
  314.        The commands you will need to run your desired option should be
  315.     placed between the :EXTEND_A and the GOTO LOOP statements in place
  316.     of the existing REM Place EXTENSION A Commands Here.  These must be
  317.     valid DOS commands, program execution, etc.
  318.  
  319.     
  320.     Including SFDOREXT.BAT Within The SF.BAT
  321.     ----------------------------------------
  322.     
  323.        Although not recommended, the contents of the SFDOREXT.BAT could
  324.     be included in the SF.BAT.  To do this, simply copy the SFDOREXT.BAT
  325.     and place it between, for example, the :DOOR_A and GOTO LOOP command.
  326.     This however, greatly magnifies the size of the SF.BAT and using the
  327.     CALL command or CALLBAT utility is definately much preferred to 
  328.     using this option.  
  329.  
  330.  
  331.     Disabling the <G>oodbye Command
  332.     -------------------------------
  333.  
  334.        SFMNUEXT provides callers logged on from a remote location with
  335.     the ability to log off the by use of the <G>oodbye command.  The
  336.     <G>oodbye feature is ONLY available when someone is logged on from
  337.     a remote location.  The <G>oodbye feature can be disabled for remote
  338.     callers by the use of a command line parameter.  Executing SFMNUEXT
  339.     in the following manner will disable the <G>oodbye feature:
  340.  
  341.     SFMNUEXT /NG
  342.  
  343.        The /NG is derived from NoGoodbye.  This information is provided
  344.     just to help you remember /NG.  (smiling)
  345.  
  346.  
  347.     DISTRIBUTION
  348.     ------------
  349.  
  350.        SFMNUEXT is distributed under the shareware concept.  You are free 
  351.     to distribute the SFMNUEXT program as long as it remains unmodified and 
  352.     no fee is charged.  If you use this program and find it beneficial a 
  353.     fee is required.  A $1.00 fee is required of registered SPITFIRE Sysops 
  354.     and a $5.00 fee is required of all others.  
  355.     
  356.        The registration fee should be sent to:
  357.        
  358.                            Buffalo Creek Software
  359.                            Attn: Mike Woltz
  360.                            913 - 39th Street
  361.                            West Des Moines, Iowa  50265
  362.  
  363.     
  364.     DISCLAIMER
  365.     ----------
  366.         
  367.        Mike Woltz and/or Buffalo Creek Software shall in no way be held 
  368.     responsible for any damage incurred while operating SFMNUEXT.  All 
  369.     responsibility lies with the user of the software.
  370.  
  371.  
  372.  
  373.        The documentation for SFMNUEXT is contributed by Jacque Shipley and 
  374.     The Mother Board BBS.  The shareware version of SPITFIRE and other 
  375.     SPITFIRE utilities are available for download from:
  376.  
  377.          Buffalo Creek's BBS              The Mother Board BBS
  378.           Mike Woltz, Sysop               Jacque Shipley, Sysop
  379.            (515) 225-8496                    (515) 986-3464
  380.    38400/19200/9600/2400/1200 Baud      19200/9600/2400/1200 Baud
  381.  
  382.    REVISION: SFMNUEXT Version 1.3 - June 1, 1992
  383.       The ability to disable the <G>oodbye feature was added!
  384.  
  385.    REVISION: SFMNUEXT Version 1.4 - November 20, 1992
  386.       Previous versions of SFMNUEXT would not display the command lines
  387.       when a caller would break out of a menu display.  This has been
  388.       corrected.
  389.   
  390.    REVISION: SFMNUEXT Version 1.5 - October 15, 1993
  391.        Added support for RIP Graphic format.
  392.  
  393.    REVISION: SFMNUEXT Version 1.5a - January 26, 1994
  394.        SFMNUEXT was revised to recognize the use of an irregular IRQ
  395.