home *** CD-ROM | disk | FTP | other *** search
/ Groovy Bytes: Behind the Moon / groovybytes.iso / GROOVY / SND_TOOL / WM10.ZIP / DOC.DAT / customiz.txt < prev    next >
Encoding:
Text File  |  1995-08-30  |  9.5 KB  |  169 lines
  1.  Customizing WAVmaker              Everything should be as simple as possible -
  2.  ────────────────────              but not simpler.           - Albert Einstein 
  3.  
  4.  WAVmaker has been designed to be easily modified and extended, even by non-
  5.  programmers. There are several levels at which you can do this:
  6.  
  7.  (1) Edit the BAT files in WAVmaker's EXE\ directory. The execution of many
  8.      WAVmaker commands can be affected this way.
  9.  
  10.      Note in particular that BAT files can write new values to the public 
  11.      Function key file for inheritance by the calling program {FnKeys}. 
  12.      WMmain and WMmenu insert a "/TD <directory>" option before any other 
  13.      command line parameters when launching executables declared to implement 
  14.      Function key inheritance {Customiz 81}. Ignore the "/TD" preamble and 
  15.      read <directory> as parameter %2: that will give you the directory where 
  16.      WAVmaker keeps the public Function key file. The actual file is called 
  17.      FnDelta.TXT, so you want to write to %2FnDelta.TXT. Keep in mind that 
  18.      Function key title:value pairs are stored title first, with title and 
  19.      value on separate lines. See ASCIIMID.BAT for an example.
  20.  
  21.  (2) Edit the menu definition (MNU) files in WAVmaker's home directory. These
  22.      files describe the menus displayed by WMmain and WMmenu. The menu file
  23.      used by WMmain is called WMmain.MNU; the menu files used by WMmenu can
  24.      have any name. The file format is the same for both programs, with one
  25.      exception: 
  26.  
  27.      ■ WMmenu files have an extra line, the very first one, containing
  28.        the menu title string. WMmain.MNU does not need a menu title string
  29.        since the title is hardwired into the program WMmain.EXE.
  30.  
  31.      Apart from that, the formats are identical, and consist of
  32.  
  33.      (i)  A header, containing Function key titles and Help function 
  34.           information (see below), and
  35.  
  36.      (ii) A body, containing up to 21 menu entry descriptions.
  37.  
  38.      The header consists of 11 lines. 
  39.  
  40.      ■ The first 10 lines are the Function key titles assigned to keys F1 
  41.        through F10 {FnKeys}, in ascending order. 
  42.  
  43.      ■ The 11th line is the number of the Help entry, if any. Setting this 
  44.        number to zero disables the Alt-H (topic Help) function. Setting it 
  45.        to a valid entry number causes WMmain and WMmenu to execute that menu 
  46.        entry whenever Alt-H is pressed (passing along the Help line for the 
  47.        currently highlighted menu entry {Customiz 129}).
  48.  
  49.      Menu entries have the following components, line by line:
  50.  
  51.      ■ A title. This is the text displayed in the menu column.
  52.  
  53.      ■ A directory. At runtime, when the menu entry is highlighted by the 
  54.        user, this becomes the current DOS directory. It is displayed in white 
  55.        on the command line, first thing to the left, and can not be edited by
  56.        the user.
  57.  
  58.        You can specify either a full path or a relative path. In the latter 
  59.        case you should keep in mind that you are starting out from the 
  60.        directory in which WMmain/WMmenu were launched.
  61.  
  62.        The directory line may be left blank. WMmain/WMmenu will then use the
  63.        directory from which they were launched.
  64.  
  65.      ■ A command. This is the path to the actual executable to launch, i.e. 
  66.        to a COM, EXE or BAT file. At runtime, it is displayed in white on the 
  67.        WMmain/WMmenu command line, and can not be edited by the user.
  68.  
  69.        You can specify either a full path or a relative path. In the latter 
  70.        case you should keep in mind that you are starting out from the 
  71.        directory specified on the previous line (see above).
  72.  
  73.      ■ A screen saver directive. There is one recognized keyword: NSINHERIT.
  74.        If this keyword is used, and if the menu manager was started up with 
  75.        the /NS (No Saver) option, then so will the program being launched. If 
  76.        the program is being launched in a DOSbox {Customiz 95}, it is actually
  77.        the DOSbox that is passed a No Saver directive in its own (weird) format
  78.        {DOSbox}; otherwise, the string "/NS " is inserted before the other 
  79.        parameters being passed to the program.
  80.  
  81.      ■ A Temporary Directory (TD) directive. Also here, there is one recognized
  82.        keyword: TEMPINHERIT. This causes a "/TD <directory>" option to be 
  83.        inserted before any other command line parameters (/NS included - see
  84.        previous directive). The directory in question is the one used to store
  85.        private and public Function key files {FnKeys}. WMmain/WMmenu will read 
  86.        the public Function key file upon return from a program launched with 
  87.        this option, and inherit any Function key assignments with titles 
  88.        matching those declared in the menu definition file header 
  89.        {Customiz 38}.
  90.  
  91.      ■ A default parameter string. At runtime, it is displayed in black (after
  92.        the command string) on the WMmain/WMmenu command line, and may be edited
  93.        by the user.
  94.  
  95.      ■ A screen directive. There are two recognized keywords: CLEARSCR and
  96.        DOSBOX. CLEARSCR causes the screen to be blanked before control is
  97.        turned over to the program being launched, which is then free to write
  98.        whatever it likes wherever it likes. DOSBOX causes the program to be
  99.        launched in a DOS box {DOSbox}, which will try to restrict screen 
  100.        output to the comment window. Any other "keyword" causes the program
  101.        to be executed in full screen mode, without any preceding screen 
  102.        blanking. The screen is ALWAYS restored upon return to WMmain/WMmenu
  103.        (but see the pause directive described below {Customiz 116}).
  104.  
  105.      ■ A swap directive. Also here, there are two recognized keywords: DISK
  106.        and NOSWAP. DISK causes the menu manager to be swapped out to a disk 
  107.        file before the program is launched, leaving only a small stump in base
  108.        memory (10 kB or less, depending on memory fragmentation at run time). 
  109.        This is useful when launching memory-hungry programs. NOSWAP prevents 
  110.        all swapping, leaving the menu manager in memory; this has the advantage
  111.        of minimizing the time needed to launch the program, and may be used
  112.        for applications with modest memory requirements. Any other "keyword"
  113.        causes the menu manager to be swapped out to XMS, EMS, or disk, in that
  114.        order of preference.
  115.  
  116.      ■ A pause directive. There is one recognized keyword, PAUSE, which causes 
  117.        execution to be halted upon return from the application. This is useful 
  118.        when something needs to be kept on screen for a while after program 
  119.        termination (e.g. the output level data output by SBset {SBset}) before
  120.        the ordinary menu display is restored. WMmain/WMmenu will ALWAYS pause
  121.        if the application can not be run or if it returns a DOS error.
  122.  
  123.      ■ A beep directive. There is one recognized keyword, BEEP, which causes
  124.        three short notes to be played (on the PC speaker) upon program 
  125.        termination. Useful with computationally heavy applications which can 
  126.        run unattended; if you are in the room, you will know when they are 
  127.        finished!
  128.  
  129.      ■ A Help line. This is the string passed to the Help program (selected
  130.        with the Help entry number described above {Customiz 43}) when Alt-H 
  131.        is pressed. When using WM Help, this string should be the name of the
  132.        Help file (kept in WAVmaker's DOC\ subdirectory) for the menu entry;
  133.        the default extension is TXT {Help}.
  134.  
  135.      ■ Up to 22 lines of text to be displayed in the comment window. You can
  136.        put anything you like here; command descriptions, tips, jokes, whatever!
  137.        There is only one limitation: the character in the first column may not
  138.        be a backslash (\) (that terminates the entry). Keep your lines short 
  139.        enough to fit in the comment window. All text following the first 22 
  140.        lines is ignored.
  141.  
  142.      ■ An entry terminator, consisting of a backslash (\) in the first column.
  143.  
  144.  (3) Edit WM.BAT in WAVmaker's home directory. WM.BAT is used to set up and 
  145.      launch the whole system. By modifying WM.BAT you can change/remove the 
  146.      startup screen and jingle, change the drive & directory where private and 
  147.      public Function key files are read and written at runtime {FnKeys} (e.g. 
  148.      to a fast RAM disk), and permanently disable the built-in screen saver. 
  149.      If you install WAVmaker on a 386+ system without FPU and upgrade with a
  150.      FPU at a later time, you will also want to edit the SET GO32 statement
  151.      in WM.BAT in order to tell WM DFT2WAV {DFT2WAV} to stop using the EMU387 
  152.      emulator. See {WMstart} for details. KEEP A BACKUP COPY OF THE ORIGINAL 
  153.      WM.BAT if you plan to modify it extensively! It is also practical to REM 
  154.      out command lines rather than to delete them.
  155.  
  156.  (3) Write your own WAVmaker applications! Command line-driven applications are
  157.      quite easy to add, just make sure that they use standard DOS output and
  158.      put them in a DOS box {DOSbox}. Interactive applications may have to 
  159.      support the /NS (No Saver) and the "/TD <directory>" (Temporary Directory,
  160.      for the exchange of Function key assignments {FnKeys}) options; apart from
  161.      that, it's entirely up to you to give them a "look and feel" more or less
  162.      consistent with that of other interactive WAVmaker applications.
  163.  
  164.  I'd like to hear about all additions and improvements you make to WAVmaker. 
  165.  Contribute to its evolution! Click here to find out how to contact me: 
  166.  
  167.                                     {Contact}.
  168.  
  169.