home *** CD-ROM | disk | FTP | other *** search
/ C!T ROM 5 / ctrom5b.zip / ctrom5b / DOS / UTILITY / BATCH / M_CHUZ02 / M-CHUZE.DOC < prev    next >
Text File  |  1994-10-15  |  10KB  |  199 lines
  1.  
  2.                             M-Chuze DOCUMENTATION
  3.                            ~~~~~~~~~~~~~~~~~~~~~~
  4.     'M-Chuze' was designed to meet two particular needs - provide a pleasant
  5.    user interface for batch programmes and, hand in hand with this, reclaim
  6.    half a meg of hard disk space a duff text-mode menu system was using up.
  7.  
  8.     'M-Chuze' is freeware but contributions are gleefully accepted, :-).
  9.    Please see the end of this file for all the legal stuff and contact
  10.    details for complaints & suggestions.
  11.  
  12.     As you will see it only uses around 36kb making it quite acceptable for
  13.    even distribution disks where often disk space is at a premium.
  14.  
  15.     'M-Chuze' will auto-detect what video card is present in the host PC
  16.    and switch it into the highest resolution mode available (up to 640x480),
  17.    cards detectable being either CGA, MCGA , EGA, EGA64, EGAMono, or VGA.
  18.    At present Hercules is not supported as the mouse cursor disappears!??
  19.  
  20.     Up to one hundred user-selectable buttons can be displayed complete with
  21.    a descriptive headline or question and because all this text is definable
  22.    from a plain ASCII text file ; an infinite number of nested menus can be
  23.    created with only one copy of M-Chuze.EXE.
  24.     Ten patterns are available to select between including solid colour
  25.    ( i.e. no pattern ) - two appearing on screen at once within concentric
  26.    rectangular areas of the screen. Colours for both these patterns and
  27.    the overlayed lines and text are also definable should the defaults not
  28.    be to your taste.
  29.  
  30.     'M-Chuze' terminates when a button is clicked on by the user and sets
  31.    its "exit code" , readable by DOS, to a value of 100 more than the
  32.    button selected. Thus if an array of 5 rows by 3 columns of buttons
  33.    are defined and displayed ; were the user to click on the button in
  34.    the centre of the top row 'M-Chuze' would terminate with an "exit code"
  35.    of  106  - as buttons are assigned their numbers descending columns,
  36.    row by row, left to right.
  37.  
  38.     To see how to use this "exit code" if you are not familiar with the
  39.    DOS 'IF ERRORLEVEL .....' statement, study the *.BAT and *.TXT files
  40.    you received with 'M-Chuze'.
  41.  
  42.                             M-Chuze IMPLEMENTATION
  43.                            ~~~~~~~~~~~~~~~~~~~~~~~
  44.    The minimum command line is :-
  45.  
  46.                        M-Chuze <buttdata> <row> <column>
  47.  
  48.    Where <buttdata> is an unformatted ASCII text file containing lines of
  49.    text, of maximum length 64 characters, that are the desired button labels.
  50.    The file must be in the current directory and of a maximum of 100 lines.
  51.  
  52.    <row> is the number of rows of buttons and <column> is the number of
  53.    buttons occuring in each row (horizontally).
  54.  
  55.    The enhanced command line is :-
  56.  
  57.    M-Chuze <buttdata> <row> <column> <ipatt> <opatt> <icol> <ocol> <lcol>
  58.  
  59.    Where the additional parameters are to select respectively ;
  60.    inner-area pattern, outer area pattern, inner area pattern colour,
  61.    outer-area pattern colour and line/title text colour.
  62.  
  63.    DO NOT TYPE THE  '<' , '>'  BRACKETS AROUND THE PARAMETERS -
  64.    JUST LEAVE A SINGLE SPACE BETWEEN EACH PARAMETER
  65.  
  66.    Valid values for parameters are outlined below :-
  67.  
  68.    buttdata            must be a valid DOS filename of a plain ASCII text
  69.                        file located in the current directory.(  \M-Chuze )
  70.  
  71.    row  &  column      must be integers with the result of multiplying
  72.                        them together being equal or less than  100 .
  73.  
  74.    ipatt  &  opatt     must be integers in the range of  0 to 9  inclusive
  75.                        these numbers representing the following patterns
  76.  
  77.                        0  Full - solid colour (no pattern)
  78.                        1  Weave
  79.                        2  Flower
  80.                        3  Cross
  81.                        4  Stripe  (vertical)
  82.                        5  Swan
  83.                        6  Brick
  84.                        7  Chain
  85.                        8  Stars
  86.                        9  Bats  (a tiled bat-shape)
  87.  
  88.    icol & ocol & lcol  must be integers in the range of  0 to 15  inclusive
  89.                        these numbers representing the default sixteen colour
  90.                        palette for all modes as outlined below
  91.  
  92.                        0   Black
  93.                        1   Blue
  94.                        2   Green
  95.                        3   Cyan
  96.                        4   Red
  97.                        5   Magenta
  98.                        6   Brown
  99.                        7   Light Grey
  100.                        8   Dark Grey
  101.                        9   Light Blue
  102.                        10  Light Green
  103.                        11  Light Cyan
  104.                        12  Light Red
  105.                        13  Light Magenta
  106.                        14  Yellow
  107.                        15  White
  108.  
  109.    To keep command lines manageable further enhancements have been
  110.    implemented by providing optional codes for the first line of the
  111.    nominated text file (<buttdata>).
  112.  
  113.    The first three characters of the first line are checked to see if
  114.    they match a code and if not they are treated like any other text
  115.    required to appear on a button , however , if they match codes as
  116.    outlined below a particular program feature is implemented and the
  117.    three characters discarded so that they do not appear on the screen.
  118.  
  119.    $#@Mark's Main Menu       this first line will result in the screen
  120.    ..............            having a headline area clear of buttons
  121.    .........                 with the text "Mark's Main Menu" centred
  122.    ...                       above the buttons.
  123.  
  124.    #@@Mildred's Recipe       this first line will result in the screen
  125.    ..............            having NO headline and "Mildred's Recipe"
  126.    .........                 appearing on the top-left (first) button
  127.    ...                       as usual but the screen will have a
  128.                              monochrome colour scheme to suit high
  129.                              resolution CGA card modes and some
  130.                              grey-scale monitors not able to display
  131.                              sixteen distinct shades.
  132.                              (experiment with this-you may not need it)
  133.  
  134.    $@@Which drive?           this first line will result in both of the
  135.    ............              features outlined above being implimented;
  136.    .........                 i.e. A monochrome colour scheme will be
  137.    ...                       instigated with the question "Which drive?"
  138.                              appearing as a centred headline above the
  139.                              array of buttons.
  140.  
  141.    ##@Display Solutions      this first line will result in the smallest
  142.    .............             font being selected (normally 'M-Chuze' will
  143.    .........                 increment the font size as the number of
  144.    ....                      button rows fall) and the top-left (first)
  145.                              button will have the text "Display Solutions"
  146.                              displayed upon it.
  147.  
  148.    $##Choose 'M-Chuze'        this first line will result in the smallest
  149.    .............             font being selected and "Choose 'M-Chuze'"
  150.    .........                 being displayed as a headline above the array
  151.    ....                      of buttons.
  152.  
  153.                           M-Chuze CONTACT INFORMATION
  154.                          ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  155.     'M-Chuze' was written using Turbo Pascal (thank you Borland) and shows
  156.    that perhaps 'C' isn't the only half-useful language on the planet
  157.    after all, and is a first try at useful graphics programming.
  158.     The author Mark Allen provides a computer-based art, animation and
  159.    computer aided draughting service and is available for both DOS and
  160.    Windows training at all levels with emphasis on _real_ productivity.
  161.  
  162.                      Telling-bone :  +61  9  336  2653
  163.                      InterNet     : markalln@omen.it.com.au
  164.                      FidoNet      : Mark J. Allen@3:690/660
  165.  
  166.                              OR  Snail Mail
  167.  
  168.                            Display Solutions(tm)
  169.                            P.O. Box 330
  170.                            South Fremantle, 6162
  171.                            Western Australia
  172.  
  173.                              M-Chuze LEGAL DOGMA
  174.                             ~~~~~~~~~~~~~~~~~~~~
  175.                      'M-Chuze' is Copyright 1991-1992 by
  176.                 Mark J. Allen trading as Display Solutions(tm)
  177.                             All Rights Reserved.
  178.  
  179.           You are free to redistribute this package in its entirety.
  180.     In doing so you may charge no more than a nominal fee for duplication.
  181.     No part of this package may be included as part of a commercial package
  182.     without explicit written permission.
  183.  
  184.     'M-Chuze' should work quite happily on the vast majority of IBM clones;
  185.     however, it is only guaranteed to work on my 386SX clone - that is the
  186.                        extent of my legal commitment !
  187.     If your modem explodes or your hair falls out that is a shame but I
  188.     accept no responsibility - I will happily commiserate with you but my
  189.      wallet will remain tightly closed ( It's virtually empty anyway ).
  190.  
  191.     P.S.
  192.       I Hope 'M-Chuze' proves to be of as much use to you as it has to me -
  193.       Just using it for a menu system for my children and has given them
  194.         back nearly 400K of disk space with no loss of 'functionality'
  195.         and where as before every additional submenu cost nearly 125K
  196.         now the only cost is a couple of K for a text and batch file.
  197.  
  198.                                                                           MJA
  199.