home *** CD-ROM | disk | FTP | other *** search
/ Best Objectech Shareware Selections / UNTITLED.iso / boss / comm / misc / 008 / addendum.doc next >
Encoding:
Text File  |  1993-02-13  |  12.1 KB  |  358 lines
  1.  
  2.  
  3.  
  4.                            {COMMO} 5.41 Addendum
  5.                            _____________________
  6.  
  7.      This Addendum contains the major additions and/or changes to the
  8.      {COMMO} 5.4 documentation.  Print out this file and keep it with
  9.      your printed manual.  There is a complete list of changes (major
  10.      and minor) in the file HISTORY.
  11.  
  12.  
  13.      ===============================
  14.      In the User Guide and Reference
  15.      ===============================
  16.  
  17.      Setup File changes/additions
  18.      ----------------------------
  19.  
  20.      ______________________________________________________________
  21.  
  22.      {set z_prog,DSZC}   Zmodem driver program (DSZC/DSZE/GSZ/TXZM)
  23.      ______________________________________________________________
  24.  
  25.           This variable is used in macros that require a Zmodem
  26.           protocol driver program.  Just enter one of the four choices
  27.           shown and the macros (including the MOSTHOST) will use the
  28.           appropriate driver.  You must have the program file in your
  29.           DOS path as follows:
  30.  
  31.                     DSZC           DSZ.COM
  32.                     DSZE           DSZ.EXE
  33.                     GSZ            GSZ.EXE
  34.                     TXZM           TXZM.EXE
  35.  
  36.      _________________________________________________
  37.  
  38.      {sfi=no}       Speech Friendly Interface (yes/no) 
  39.      _________________________________________________
  40.  
  41.           If this is "yes" {COMMO} will be much friendlier to users
  42.           with speech synthesizer boards (these enable blind users to
  43.           read the computer display).  Major differences are:
  44.  
  45.           o    Terminal Screen data and many error and information
  46.                messages will be displayed using the BIOS.
  47.  
  48.           o    The up and down arrow keys move the cursor instead of
  49.                scrolling the screen in windows such as Online Help,
  50.                Scrollback and View String Variable Space.
  51.  
  52.           o    In the Dialing Directory window, {COMMO} will make
  53.                distinctive sounds when entries are marked or unmarked
  54.                for dialing.  The [T] and [R] keys will mark and unmark
  55.                entries without moving the Selector Bar.  If the entry
  56.                is already in the desired state, a special sound will
  57.                be made.
  58.  
  59.  
  60.  
  61.  
  62.      Under "Uploading and Downloading"
  63.      ---------------------------------
  64.  
  65.      Zmodem with DSZ or GSZ
  66.      ======================
  67.  
  68.      NOTE:  DSZ and GSZ are Shareware programs from Omen Technology. 
  69.      Like {COMMO}, they must be registered for continued use (be aware
  70.      that some features are not enabled in the unregistered versions). 
  71.  
  72.      DSZ may almost always be found where you obtained {COMMO} and is
  73.      usually archived as DSZmmdd.ZIP (mmdd is a release date).  DSZ
  74.      will transfer files using the popular Zmodem protocol.
  75.  
  76.      The executable file to install is DSZ.COM.  There is also a
  77.      DSZ.EXE version that works better on some systems.  Look for the
  78.      archive DSZmmddX.ZIP.
  79.  
  80.      GSZ is functionally equivalent to DSZ.  In addition GSZ provides
  81.      an attractive graphic display of the file transfer in progress.
  82.  
  83.      The executable file to install is GSZ.EXE.
  84.  
  85.      To use any of the Omen drivers, you need only change one item in
  86.      the Setup File:
  87.  
  88.           {set z_prog,DSZC}        for DSZ.COM
  89.           {set z_prog,DSZE}        for DSZ.EXE
  90.           {set z_prog,GSZ}         for GSZ.EXE
  91.  
  92.      Zmodem with TXZM
  93.      ================
  94.  
  95.      TXZM, Texas Zmodem, is an excellent Zmodem driver.  It combines
  96.      very fast execution speed with a good graphic display -- and TXZM
  97.      is free for personal use.
  98.  
  99.      The executable file to install is TXZM.EXE.
  100.  
  101.      To use Texas Zmodem, change the "set z_prog" item in the Setup
  102.      File:
  103.  
  104.           {set z_prog,TXZM}        for TXZM.EXE
  105.  
  106.  
  107.  
  108.      ==============================
  109.      In the Macro Programming Guide
  110.      ==============================
  111.  
  112.      ------------------------------------
  113.      New or changed function descriptions
  114.      ------------------------------------
  115.  
  116.      [The description of the MENU function has been re-written for
  117.      better clarity.]
  118.  
  119.      ____
  120.  
  121.      MENU
  122.      ____
  123.  
  124.      Default key:   none
  125.      Description:   Create a pop-up macro menu.
  126.  
  127.      General form:
  128.  
  129.           {SETV _menu1,text1}
  130.           {SETV _menu2,text2}
  131.                ...
  132.           {SETV _menuN,textN}
  133.  
  134.                text1          Text to be placed on first information
  135.                               line in the pop-up window (third line
  136.                               down, counting from the top border).
  137.  
  138.                               NOTE:  These text strings are simply
  139.                               information and have no effect on which
  140.                               macros will be executed.
  141.  
  142.                text2          Text to be placed on second information
  143.                               line.
  144.                ...            ...
  145.  
  146.                textN          Text to be placed on Nth information
  147.                               line.
  148.  
  149.           {SETV _mlabel,label1,label2,...}
  150.  
  151.                label1         Label to GOTO if F1, A or 1 is pressed. 
  152.                               Any of the three keys will activate the
  153.                               macro at the first label.
  154.  
  155.                label2         Label to GOTO if F2, B or 2 is pressed.
  156.  
  157.                               NOTE:  Labels are positional and may be
  158.                               omitted using null arguments for keys
  159.                               that aren't used.  See example 2 below.
  160.                ...            ...
  161.  
  162.           {SETV _mcolor,text,border}
  163.  
  164.  
  165.  
  166.  
  167.                text           Colors for the text area of the pop-up
  168.                               window.
  169.  
  170.                               NOTE:  The attributes are specified in
  171.                               the same manner as the colors in the
  172.                               Setup File (press F7 in the Internal
  173.                               Editor to display the Color Chart).  
  174.  
  175.                border         Colors for the window border.
  176.  
  177.           {MENU height,width,string}
  178.  
  179.                height         Total number of rows from top to bottom
  180.                               of pop-up window, including borders. 
  181.                               Minimum is 5.
  182.  
  183.                width          Total number of columns from left side
  184.                               to right side, including borders. 
  185.                               Minimum is 23.
  186.  
  187.                string         Title string that will appear in the top
  188.                               border.
  189.  
  190.      Example 1:
  191.  
  192.                {setv _menu1, F1  Call computer at work}
  193.                {setv _menu3, F2  Call E-mail service}
  194.                {setv _menu5, F3  Run offline mail reader}
  195.                {setv _mlabel,work,mail,reader}
  196.                {setv _mcolor,17,30}
  197.                {menu 9,32,Daily Activity Menu} {}
  198.  
  199.           {:work}   ... macro to call work computer.
  200.           {:mail}   ... macro to call E-mail service.
  201.           {:reader} ... macro to run offline reader.
  202.  
  203.           This menu specifies that function keys be pressed to
  204.           activate the macros.  You could also press A or 1 instead of
  205.           F1, B or 2 instead of F2, etc.  The macros may be as simple
  206.           or as complex as desired to complete the task.
  207.  
  208.      Example 2:
  209.  
  210.                {setv _menu1, D - Dialing Directory}
  211.                {setv _menu2, M - Macro File}
  212.                {setv _menu3, S - Shell to DOS (with swap)}
  213.                {setv _menu4, E - Edit a file}
  214.                {setv _mlabel,,,,ddir,edit,,,,,,,,mfile,,,,,,dos}
  215.                {setv _mcolor,03,47}
  216.                {menu 8,33,Common Commands} {}
  217.  
  218.           {:ddir}   {dial} {}
  219.           {:edit}   {input efile,Filename to Edit} {edit %efile} {}
  220.           {:mfile}  {macro}
  221.  
  222.  
  223.  
  224.           {:dos}    {shell-s} {}
  225.  
  226.           This menu uses "mnemonic" key labeling -- D for (D)ialing
  227.           Directory, etc.  Notice that there are three empty positions
  228.           in the "_mlabel" list prior to "ddir" and "edit".  These
  229.           correspond to A, B and C, which are not used in this menu. 
  230.           Then there are empty positions up to M and then up to S.
  231.  
  232.      TIPS on using MENU:
  233.  
  234.      >    The dimensions of the window are limited by the current size
  235.           of the Terminal Screen.
  236.  
  237.      >    The total number of displayable lines is "height" less 4. 
  238.           Lines in the window for which no "_menux" variable has been
  239.           defined will be left blank.
  240.  
  241.      >    Up to 26 labels can be specified in each menu.  These
  242.           correspond to pressing the letters A through Z.  The first
  243.           12 labels also correspond to pressing F1 through F12, while
  244.           the first 9 labels correspond to pressing 1 through 9.
  245.  
  246.      >    All variables used to create the menu are automatically
  247.           deleted from Variable Space after the menu is displayed. 
  248.  
  249.      >    The last colors used to display a menu will persist until
  250.           they are changed by setting the "_mcolor" variable.
  251.  
  252.      >    If Esc is pressed to exit the menu, macro processing
  253.           continues in sequence following the MENU function.
  254.  
  255.      See also MACRo.
  256.  
  257.  
  258.      [The actions of the READ function, when reading the end-of-file,
  259.      are now defined more precisely.]
  260.  
  261.      ____
  262.  
  263.      READ
  264.      ____
  265.  
  266.      Default key:   none
  267.      Description:   Read a line from the read file to a variable.
  268.  
  269.      Example:
  270.  
  271.           {read nextline}          Read the next line in the file into
  272.                                    the variable "nextline."
  273.  
  274.      TIPS on reading files:
  275.  
  276.      >    A file must be open for reading or a macro error will
  277.           result.  
  278.  
  279.  
  280.  
  281.      >    Each READ will get the next line in the file (lines are
  282.           terminated by carriage return and linefeed).
  283.  
  284.      >    When an attempt is made to read past the end of file,
  285.           control will GOTO the label specified in the ROPEn.  If no
  286.           label was specified or if the label was invalid, control
  287.           will continue in sequence.  In either case the file is
  288.           automatically closed and the variable is set to null.
  289.  
  290.      >    READ will set the Exit Code to 0 unless the end of file was
  291.           encountered, in which case it will be set to 1.  The Exit
  292.           Code is stored in the built-in variable "_err" and can be
  293.           tested with the IFERrorlevel function.
  294.  
  295.      >    ALL control characters (below ASCII 28) will be discarded,
  296.           including the carriage return/linefeed that terminates the
  297.           line.
  298.  
  299.      >    Lines longer than 240 characters will be truncated to a
  300.           length of 240.
  301.  
  302.      See also ROPEn, RCLOse
  303.  
  304.  
  305.      [The SSLOok function now has a switch "R" to append a carriage
  306.      return to the transmitted string.]
  307.  
  308.      ______
  309.  
  310.      SSLOok
  311.      ______
  312.  
  313.      Default key:   none
  314.      Description:   Set up an additional string to look for during a
  315.                     subsequent LOOKfor function.
  316.  
  317.      General form:
  318.  
  319.           {SSLOok name,target}
  320.  
  321.                name      The name of a string variable (MUST be a
  322.                          variable).
  323.  
  324.                target    The ASCII string to look for.  The string
  325.                          begins following the "," and is terminated by
  326.                          the "}".
  327.  
  328.      Switches:
  329.  
  330.                R or R1   Send a carriage return after sending the
  331.                          variable string to the serial port.
  332.  
  333.                R0        Do not send a carriage return (default).
  334.  
  335.      Example:
  336.  
  337.  
  338.  
  339.  
  340.           {setv ss_r,|} {setv ss_nr,n|}
  341.           ...
  342.           {sslo-r _pas,password:}
  343.           {sslo ss_r,Press enter to continue}
  344.           {sslo ss_nr,Do you want to log off?}
  345.           {look command?} ...
  346.  
  347.      SSLOok is used in conjunction with LOOKfor.  When the target
  348.      string appears, the string in the variable is sent to the serial
  349.      port.  The LOOKfor continues to look for all specified strings.
  350.  
  351.      See LOOKfor for details, examples and tips on using SSLOok.
  352.  
  353.      See also: CALOok, GOLOok, SETLook.
  354.  
  355.  
  356.                                   - end -
  357.  
  358.