home *** CD-ROM | disk | FTP | other *** search
/ Share Gallery 1 / share_gal_1.zip / share_gal_1 / UT / UT125.ZIP / MANUAL.DOC < prev    next >
Text File  |  1990-09-21  |  22KB  |  487 lines

  1.                                   TABLE OF CONTENTS
  2.  
  3.  
  4.           1.  Introduction
  5.  
  6.           2.  System Requirements
  7.  
  8.           3.  Quick-Start (Installing BFMenu)
  9.  
  10.           4.  Experimenting with the Demonstration Menus
  11.  
  12.           5.  Creating Your Menu (.TXT) Files
  13.  
  14.           6.  Use of the optional 'BF.BAT' file
  15.  
  16.           7.  Customizing BFMenu's Colors
  17.  
  18.           8.  Trademark Acknowledgements
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.               Copyright August, 1990 by Aspire Software  Red Oak, Texas
  53.                                  All Rights Reserved
  54.  
  55.           1.  INTRODUCTION
  56.  
  57.           BFMenu is a fast, batch file menuing application.  Its appearance
  58.           is sophisticated and its operation simple.  Not only are the Menu
  59.           Options  determined by  you, but  the  Menu Titles,  too.  BFMenu
  60.           supports  up  to 18  Menu  Options  per menu,  with  your Options
  61.           appearing  in an  attractive framed  box  on a  pin-striped back-
  62.           ground.
  63.  
  64.           BFMenu's Menu Options are selected  using the arrow keys.  Press-
  65.           ing <Enter> causes the selected  Option's action to be performed.
  66.           A selection  bar moves from  Option to  Option, highlighting each
  67.           Menu Option as it is selected.  And, if you choose, a Description
  68.           Line styled by you  will appear below the  Menu Box for each Menu
  69.           Option, according to the Option selected.
  70.  
  71.           Accelerator Keys are also available  to make menu selections, and
  72.           require only  a single  keystroke.  These  keys are automatically
  73.           selected as  unique letters, one  from each  Menu Option.  (Where
  74.           possible, this is  always the first letter  of each Option.)  For
  75.           emphasis, that letter's display is highlighted (in white on color
  76.           monitors).  When the letter is  pressed on the keyboard, its Menu
  77.           Option is selected and the  Option's action performed.  (When the
  78.           first letter  of two Menu  Options are  alike,  alternate, unique
  79.           letters are automatically assigned.)
  80.  
  81.           BFMenu will operate  in monochrome or color.   If a color monitor
  82.           is used, you  can customize your menu's  colors.  If your monitor
  83.           is  a  color  VGA, BFMenu  provides  several  additional, unusual
  84.           custom color combinations.
  85.  
  86.           Should  you  create  multiple levels  of  menus,  each  menu will
  87.           cascade  across the  screen  as it  is  passed, creating  a clear
  88.           relational picture, displaying both  the current and prior menus.
  89.           Backing out of each level is intuitive, using <Esc> to follow the
  90.           menu path in reverse order.
  91.  
  92.           Now, let's take a quick look at the system requirements, then get
  93.           started!
  94.  
  95.           2.  SYSTEM REQUIREMENTS
  96.  
  97.           BFMenu runs on the IBM PC  family of computers, including the XT,
  98.           AT, and  the PS/2  series, as well  as true  IBM compatibles.  We
  99.           recommend  DOS 3.1  or higher  though  the older  versions should
  100.           work.   If older  DOS versions  are  used, we  recommend starting
  101.           BFMenu only when the default drive/directory is set to the drive/
  102.           directory where BFMenu resides.
  103.  
  104.           Although BFMenu will operate from any  disk drive, the speed of a
  105.           hard drive is definitely preferable.  The disk space required for
  106.           the BFMenu and related files is not substantial.
  107.  
  108.  
  109.           To create  your own menus,  you will  need a text  editor or word
  110.           processor capable of creating  ASCII-based text files.  The ASCII
  111.           format  is the  very  common file  format  used in  'batch (.BAT)
  112.           files' such  as the  'AUTOEXEC.BAT' file.   EDLIN can  be used to
  113.           create and maintain  the Menu Files though  there are many easier
  114.           text editors  with which to  work.  Most  popular word processors
  115.           can be used, then a text file created using an 'export' function.
  116.  
  117.           BFMenu  can  be adapted  by  experienced personnel  to  a network
  118.           system.  The current  release has not  been designed specifically
  119.           for such use, however.
  120.  
  121.  
  122.           3.  QUICK-START (Installing BFMenu)
  123.  
  124.           BFMenu does not use an installation program.  In fact, only three
  125.           files are needed to operate BFMenu:
  126.  
  127.               'BFMENU.EXE'    - BFMenu's executable file
  128.  
  129.               'BFMENU.TXT'    - Your ASCII-based  text file  used to define
  130.                                 the  Menu  Title,  Menu  Options,  and Menu
  131.                                 Option action commands.
  132.  
  133.               'BF.BAT'        - An  optional file  for starting  BFMenu and
  134.                                 for   performing  housekeeping   each  time
  135.                                 BFMenu starts.
  136.  
  137.           A  fourth  file,  'BFMENU$$.BAT'  is  created  by  BFMenu  in the
  138.           directory where 'BFMENU.EXE' resides.  Other files ('.TXT' files)
  139.           can be created by you for multiple level menus.
  140.  
  141.           Also included with BFMenu are:
  142.  
  143.               'REGISTER.FRM' and
  144.               'MANUAL.DOC'    - Text  files  used  by  BFMenu  to  print  a
  145.                                 registration form and BFMenu's Mini-Manual.
  146.  
  147.               'GAMEMENU.TXT'  - A text file used  to define the Menu Title,
  148.                                 Menu Options,  and Menu  Option action com-
  149.                                 mands  for the  SECOND  tier of  a multiple
  150.                                 level menu, for demonstration purposes.
  151.  
  152.               'CARS.TXT'      - A text file used  to define the Menu Title,
  153.                                 Menu Options,  and Menu  Option action com-
  154.                                 mands  for  the THIRD  tier  of  a multiple
  155.                                 level menu, for demonstration purposes.
  156.  
  157.  
  158.           BFMenu may be run from any  disk or hard drive.  However, it will
  159.           operate faster when stored on a hard drive.  You can start BFMenu
  160.           with the BFMENU.EXE program file  and BFMENU.TXT Menu File in the
  161.           default drive/directory,  or it may  be started  from a different
  162.           drive/directory  using the  path name.   For instance,  if BFMenu
  163.           resides on the  'C' drive, you  can start it  from the 'A' drive:
  164.           A:\>c:bfmenu /go.
  165.  
  166.           To 'install' BFMenu,  simply copy the files  from the floppy disk
  167.           or diskette  to a hard  drive.  We believe  in good housekeeping,
  168.           and so recommend you first make a directory for BFMenu and change
  169.           to that directory.  For example:
  170.  
  171.            C:\>md bfmenu    (then press <Enter>) (makes the directory)
  172.  
  173.            C:\>cd bfmenu    (then press <Enter>) (changes to the directory)
  174.  
  175.           Now copy the files.  For example, insert the BFMenu disk or disk-
  176.           ette in  Drive A (any  appropriate drive is  fine).  Assuming the
  177.           'A' drive is  used and you  are copying to  'C' Drive, type 'copy
  178.           a:*.* c:':
  179.  
  180.                          C:\BFMENU>copy a:*.* c:
  181.  
  182.           That's it!   Now, to  operate BFMenu's  demonstration menus, type
  183.           'bfmenu /go'.
  184.  
  185.           NOTE:  To disable  the preamble, 'Do  you want to  print a Regis-
  186.                  tration Form?',  that appears whenever  BFMenu is started,
  187.                  you must register BFMenu.  Your new copy will exclude this
  188.                  message.  If you register by phone, you may call technical
  189.                  support and  we will give  you over-the-phone instructions
  190.                  for disabling the registration offer message.
  191.  
  192.           4.  EXPERIMENTING WITH THE DEMONSTRATION MENUS
  193.  
  194.           To  give you  an understanding  of  BFMenu's features  before you
  195.           create  your  own  menus,  start  and  operate  BFMenu  using the
  196.           demonstration  menus.  Simply  type  'bfmenu /go'  in  the drive/
  197.           directory where BFMenu  resides, or type  the path name  + /go if
  198.           BFMenu is in a different drive/directory.
  199.  
  200.           Before the  menu operates,  an option  to print  the registration
  201.           form  appears.  After  registering BFMenu,  this message  will be
  202.           removed.  While experimenting, you will  find this message can be
  203.           passed-by almost  unnoticeably by pressing  'N' immediately after
  204.           starting BFMenu.
  205.  
  206.           When the  demonstration menu appears,  use the up  and down arrow
  207.           keys to  change selections.  Notice  that the  selection bar will
  208.           'roll' from  the last  selection to  the first  when pressing the
  209.           down  arrow  continuously.    Try  pressing  the   up  arrow  key
  210.           continuously also.
  211.  
  212.           Now, using the  arrow keys, move to  each Menu Option, hesitating
  213.           to look at  the Description Line  under the framed  box.  In YOUR
  214.           menus, both  the Menu Options  and the Description  Lines will be
  215.           designed by you.  While scanning the Options notice some Options
  216.           do not have Description Lines.  Their usage is optional.
  217.           After selecting an  Option, such as  Word Perfect, press <Enter>.
  218.           This  causes the  Option's action  to  be performed.   (Of course
  219.           these  demonstration Options  must all  end  with only  a message
  220.           since only you know what software products you own and where they
  221.           reside on your computer's drives and directories.)  On proceeding
  222.           from the demo message,  BFMenu is re-entered automatically (after
  223.           displaying the  pre-registration Registration  Form message).  To
  224.           exit from the menuing system, press <Esc>.
  225.  
  226.           Next,  select 'GAMES  MENU'  and press  <Enter>.   This selection
  227.           demonstrates  BFMenu's  multiple-level  menuing.   After scanning
  228.           this second tier  menu's selections using  the arrow keys, select
  229.           'BBALL' but do not press  <Enter>.  Instead, press the letter 'C'
  230.           for 'CARS  & RACING'.   This demonstrates  two features.   Cars &
  231.           Racing is a third tier menu, demonstrating the cascading of menus
  232.           from the upper left corner.  And 'C' is an Accelerator Key, which
  233.           can be used instead  of the arrow and  <Enter> keys to select and
  234.           proceed with  menu selections.   The use  of accelerator  keys is
  235.           very useful as you become familiar with your menu designs and are
  236.           moving quickly from using one application to another.
  237.  
  238.           The cascading  menus enable you  to maintain  your 'bearing' when
  239.           using  multiple-level menus.   To  back out  of  any one  tier to
  240.           earlier tiers,  press <Esc>.   When at  the first  tier, pressing
  241.           <Esc> will exit from BFMenu.
  242.  
  243.           Before leaving  the Demonstration  Menus, notice  the Menu Titles
  244.           for each menu.  These also are styled by you, in the '.TXT' files
  245.           such as 'BFMENU.TXT'.
  246.  
  247.  
  248.  
  249.           5.  CREATING YOUR MENU (.TXT) FILES
  250.  
  251.           For those  familiar with batch  file operations,  a comparison of
  252.           the  ASCII file,  'BFMENU.TXT',  to the  demonstration  menu will
  253.           answer most questions or confirm most guesses and assumptions.
  254.  
  255.           Whether familiar  with batch  files or  not, we  suggest creating
  256.           your own  Menu Files by  example.  So  use a text  editor or word
  257.           processor  to view  the  'BFMENU.TXT' file  while  reviewing this
  258.           section.  The  'BFMENU.TXT' file is  the file that  you will cus-
  259.           tomize to create your  own 'first tier' menu.   As quickly as you
  260.           understand the Menu File usage,  make modifications for YOUR Menu
  261.           Title, Menu Options, Description  Lines, and batch file commands.
  262.           It only takes a few moments  to discover and correct your errors!
  263.           Success through trial and error is easy, here.
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.           The  Menu Files  (such  as 'BFMENU.TXT')  are  used by  BFMenu to
  272.           generate your menus  and the related batch  files.  The format of
  273.           the Menu Files is as follows:
  274.  
  275.               Line 1             :  defines the Menu Title.
  276.  
  277.               Lines 2 through ?? :  define  the Menu  Options.  If  a comma
  278.                                     (,) is  present on  any line,  the text
  279.                                     following the comma  will appear in the
  280.                                     Description Line each  time that line's
  281.                                     Option is selected.   BFMenu accepts up
  282.                                     to 18 lines of Menu Options.
  283.  
  284.               A blank line       :  defines  the end  of the  Menu Options.
  285.                                     All subsequent lines are used to define
  286.                                     DOS commands to  be associated with the
  287.                                     Menu Options.
  288.  
  289.               Multiple series of
  290.                DOS commands with
  291.                each series sepa-
  292.                rated by a blank
  293.                line              :  each series  defines the  contents of a
  294.                                     batch  file, named  'BFMENU$$.BAT' that
  295.                                     will be  created and  run by  BFMenu if
  296.                                     the related Menu Option is selected and
  297.                                     <Enter>  pressed.    These  series  are
  298.                                     spatially related to  the Menu Options.
  299.                                     In other  words, the  first Menu Option
  300.                                     (Line 2) will cause the first series of
  301.                                     DOS  commands  to   be  performed,  the
  302.                                     second Menu Option,  the second series,
  303.                                     etc.
  304.  
  305.                                     Be  certain  that only  one  blank line
  306.                                     exists  between  each   series  of  DOS
  307.                                     commands.
  308.  
  309.           For multiple-level menuing:
  310.  
  311.           In lieu of any series of  DOS commands, you may substitute a file
  312.           name and  extension, preceded  by a  housetop (^).   The housetop
  313.           communicates  to  BFMenu that  an  ASCII-based text  file  of the
  314.           designated  file  name  exists  in  the  same  drive/directory as
  315.           BFMenu.  That file, created by you, is of the same file layout as
  316.           above, and will itself be the basis for another menu.
  317.  
  318.           When the  Menu Option associated  with this line  is selected and
  319.           <Enter> is  pressed, this  line will  direct BFMenu  to operate a
  320.           multiple-level menu,  using the  data in  the designated  file to
  321.           create the next  menu. BFMenu supports  up to 12  tiers of menus.
  322.           The first tier is  pre-set so that BFMenu  searches for the file,
  323.           'BFMENU.TXT'.  11  more such  tiers can  be operated  using files
  324.           created and named by you.
  325.           We recommend that,  for the benefits of  consistency, you use the
  326.           extension  '.TXT' for  all Menu  Files.   The use  of descriptive
  327.           names such as 'GAMEMENU', 'MODMMENU' or 'UTILMENU' will help make
  328.           menu maintenance  easy, too.   These files  should reside  in the
  329.           same directory as 'BFMENU.EXE'.
  330.  
  331.           While the demonstration Menu  Files don't start any applications,
  332.           here is  a sample  'BFMENU.TXT' Menu File  that could  be used to
  333.           start two application programs.  Line 1 begins with 'MAIN MENU':
  334.  
  335.               MAIN MENU
  336.               WORD PERFECT,For word processing and table-top pub.
  337.               QUATTRO PRO,Spreadsheet program with graphics
  338.  
  339.               echo off
  340.               cls
  341.               cd c:\word
  342.               wp
  343.               bf
  344.  
  345.               echo off
  346.               cls
  347.               cd c:\quattro
  348.               q
  349.               bf
  350.  
  351.           Whichever Menu  Option is  chosen in  this sample,  the screen is
  352.           cleared,  the default  drive/directory is  changed to  the drive/
  353.           directory  where  the  selected   application  resides,  and  the
  354.           application  is started.   When  the application  is  exited, the
  355.           'BF.BAT' batch  file is run  (see Item 6,  below), which performs
  356.           some housekeeping and restarts BFMenu.
  357.  
  358.           From here, customize 'BFMENU.TXT' for your system.  Start simple,
  359.           with single-tier menuing and with  few items.  Then test, correct
  360.           and build on the simple menu.
  361.  
  362.  
  363.           6.  USE OF THE OPTIONAL 'BF.BAT' FILE
  364.  
  365.           When  using a  computer,  it is  necessary  at times  to  use DOS
  366.           commands at  the 'DOS  prompt'.  When  using multiple  drives and
  367.           many directories, this means that,  at any particular moment, the
  368.           current default drive and  directory, and the default directories
  369.           of other drives may consist of any one of dozens of combinations.
  370.           For various reasons,  including file protection  and security and
  371.           convenience, it is often  best to reset all  hard drives to their
  372.           root directories when changing  applications.  It is often desir-
  373.           able, too, to maintain a path command allowing certain actions to
  374.           be taken regardless of which drive/directory is current.
  375.  
  376.  
  377.  
  378.  
  379.           It is for these reasons that we recommend the use of a batch file
  380.           such  as  'BF.BAT'.  Assuming  a  computer system  with  two hard
  381.           drives, C and D, here is  a 'BF.BAT' file that simply and quickly
  382.           takes care of some important housekeeping:
  383.  
  384.               echo off
  385.               cls
  386.               cd d:\
  387.               cd c:\
  388.               c:
  389.               path=c:\
  390.               c:\bfmenu\bfmenu go
  391.  
  392.           With this batch  file residing in  the root directory  of drive C
  393.           (C:\>), pressing 'bf'  and <Enter> will  clear the screen, change
  394.           both D and  C drives' directories to  their root directories, set
  395.           the current drive to drive C,  set the path to the root directory
  396.           of  drive  D,  and  start the  menuing  system  which  resides in
  397.           directory \BFMENU of drive  C.  If C:\ remains  in the path, 'bf'
  398.           can  subsequently  be run  from  any  drive and  directory  and a
  399.           significant amount of housekeeping will thereby be done for you.
  400.  
  401.           If, in addition, you  place the command 'bf'  as the last item in
  402.           your 'AUTOEXEC.BAT' file,  this housekeeping 'automatically' will
  403.           be done and your menu appear on 'boot-up'.
  404.  
  405.           Notice  that  the  demonstration files,  though  doing  no house-
  406.           keeping, rely on a  call to 'bf' to restart  BFMenu at the end of
  407.           running other DOS commands.
  408.  
  409.  
  410.           7.  CUSTOMIZING BFMENU'S COLORS
  411.  
  412.           Using command line codes you may modify BFMenu's color scheme:
  413.  
  414.                 Position          Command
  415.                 --------         --------------------
  416.                     1              start BFMenu (/go)
  417.                     2              color - background shading
  418.                     3              color - background
  419.                     4              color - foreground letters
  420.                     5              color - selection bar
  421.  
  422.           Code position 1 is  used to start BFMenu.   If no command code is
  423.           provided on  starting BFMenu,  options to  print this Mini-Manual
  424.           and the  Registration Form are  offered, as well  as very cursory
  425.           instructions.
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.           For code positions  2 through 5,  you may use  any combination of
  434.           the following codes:
  435.  
  436.                         wh  - WHite         ly  - Light graY
  437.                         dy  - Dark graY     bk  - BlacK
  438.                         bl  - BLue          lb  - Light Blue
  439.                         gr  - GReen         lg  - Light Green
  440.                         cy  - CYan          lc  - Light Cyan
  441.                         rd  - ReD           lr  - Light Red
  442.                         mg  - MaGenta       lm  - Light Magenta
  443.                         br  - BRown         yw  - YelloW
  444.  
  445.           For instance:   'bfmenu /go /cy  /dy'.  On a  color monitor, this
  446.           start-up results in a  cyan on dark gray  background.  You do not
  447.           need to fill all 5 code positions.
  448.  
  449.           If your system  uses a VGA  adapter with a  color monitor, rather
  450.           than using  positions 2  through 5  to set  colors for individual
  451.           menu areas, you may set an unusual color combination using one of
  452.           the following codes in position 2:
  453.  
  454.                     SONTAE  SOUTHWEST  NOUTISE  FOREST  REUBATELA
  455.  
  456.           For  instance:  'bfmenu  /go /sontae'.   With  a VGA  adapter and
  457.           color monitor,  this startup will  result in  a color combination
  458.           other than the sixteen standard  colors generally offered in text
  459.           mode.
  460.  
  461.           One other option  is available to  VGA users.  Instead  of one of
  462.           the  above  custom codes,  you  can use  'AUTOCOLOR'  (bfmenu /go
  463.           /autocolor).  This option  will randomly select  the color option
  464.           from the five custom codes above.
  465.  
  466.           8. TRADEMARK ACKNOWLEDGEMENTS
  467.  
  468.           Trademarks used in the demonstration  menus and or in this manual
  469.           include:
  470.  
  471.              Q&A, a trademark of Symantec Corporation
  472.              WordPerfect, a registered trademark of WordPerfect Corp.
  473.              Quattro, a registered trademark of Borland International, Inc.
  474.              Peachtree, a registered trademark of Peachtree Software
  475.              Test Drive & Test Drive II, trademarks of Accolade, Inc.
  476.              Reader Rabbit, a registered trademark of The Learning Company
  477.  
  478.                          ___________________________________
  479.  
  480.                            We hope you enjoy using BFMenu
  481.                           as much as we enjoyed writing it!
  482.  
  483.  
  484.                                   PLEASE REGISTER!
  485.  
  486.  
  487.