home *** CD-ROM | disk | FTP | other *** search
/ Shareware 1 2 the Maxx / sw_1.zip / sw_1 / COMM / SPHM10.ZIP / README next >
Text File  |  1992-01-05  |  12KB  |  323 lines
  1.  
  2.  
  3.  
  4.  
  5.               The SALT Programming HyperText Manual v1.0 (SPHM10)
  6.  
  7.                      Copyright 1991, 1992 Craig S. Miller
  8.  
  9.  
  10.                              Web-Man Applications
  11.                                 P.O. Box 60562
  12.                           Sacramento, CA  95860-0562
  13.  
  14.                        Phone (916) 486-0756 - Voice only
  15.  
  16.  
  17.                          Designed by: Craig S. Miller
  18.  
  19.  
  20.                  Text of SALT Manual Copyright 1991 Exis Inc.
  21.                               Used by permission.
  22.  
  23.  
  24.  
  25.  
  26.      Description
  27.      -----------
  28.  
  29.      The   SALT   Programming   HyperText   Manual   v1.0   SPHM10,   is  a
  30.      context-sensitive help system, pop-up manual,  and  tutorial  for  the
  31.      Script  Application  Language  for  Telix (SALT). It is designed to be
  32.      used as either a learning tool for SALT programming and/or  to  assist
  33.      in the programming of Telix SALT scripts.
  34.  
  35.      SPHM10  presents  the Telix v3.15 SALT Programming Manual in HyperText
  36.      format. HyperText is  text  with  embedded  cross  references,  called
  37.      HyperText  links.  These links allow the programmer to jump to related
  38.      reference material.  Thus, the SALT Programming  Manual  is  presented
  39.      'multi-dimensionally.'
  40.  
  41.      Features of SPHM10 include context-sensitive searching, stand alone or
  42.      TSR  (Terminate  &  Stay  Resident)  operation,  automatic screen mode
  43.      sensing, copy and paste, mouse support, place  marking,  backtracking,
  44.      topic searching, printing, and exporting.
  45.  
  46.      In   stand-alone  mode,  SPHM10  can  be  operated  as  an  intuitive,
  47.      interactive tutorial system for the beginner. The user (or reader) may
  48.      explore the SALT  Programming  Manual  in  any  direction  he  or  she
  49.      desires.
  50.  
  51.      When  used  in  TSR  mode, SPHM10 can be accessed from within any text
  52.      editor (such as QEDIT, TED, etc.) while programming a SALT script. The
  53.      context-sensitive nature of SPHM10 can bring  the  needed  information
  54.      directly onto the screen without searching.
  55.  
  56.      The  user  can  look  up information about commands, related commands,
  57.      SALT program structure, etc., and return directly to the script  being
  58.      edited.
  59.  
  60.  
  61.  
  62.  
  63.      The SALT Programming HyperText Manual v1.0 (SPHM10)        Page 2 of 7
  64.  
  65.      Registration & Distribution
  66.      ---------------------------
  67.  
  68.      SPHM10  is  distributed by Web-Man Applications as FREEWARE. It may be
  69.      distributed freely; no compensation of any kind is required or will be
  70.      accepted by Web-Man Applications. However, registration  of  Telix  is
  71.      encouraged by Web-Man Applications.
  72.  
  73.  
  74.      Disclaimer
  75.      ----------
  76.  
  77.      SPHM10,  the  SALT Programming HyperText Manual v1.0 is distributed as
  78.      is. There are no warranties, expressed or implied. In no  event  shall
  79.      Web-Man Applications or Exis, Inc. be held responsible for any direct,
  80.      indirect,  special,  incidental,  or  consequential damages or loss of
  81.      profits to users of this program regardless of the legal theory,  even
  82.      if advised of the possibility of such damage. The use of this software
  83.      states that the user has and will accept and acknowledge these terms.
  84.  
  85.  
  86.      File Included
  87.      -------------
  88.  
  89.      SPHM10.EXE   - The SALT Programming HyperText Manual, executable
  90.      README       - This file
  91.  
  92.  
  93.      System Requirements
  94.      -------------------
  95.  
  96.                - IBM PC or compatible
  97.                - DOS 2.1 or greater
  98.                - Monochrome or color monitor
  99.  
  100.  
  101.      Memory Requirements
  102.      -------------------
  103.  
  104.      SPHM10  uses  45-58K of conventional memory.  If installed in expanded
  105.      memory, it requires as little as 1K  (See the Command-Line  Options in
  106.      SPHM10 for further details).
  107.  
  108.  
  109.      Display Modes
  110.      -------------
  111.  
  112.      SPHM10  will operate in monochrome or color, and supports most display
  113.      sizes (80x25, 80x50, 40x25, etc.). Display size will be  automatically
  114.      detected,  and  can  be  resized  if desired.  Monochrome monitors are
  115.      automatically detected.
  116.  
  117.  
  118.  
  119.  
  120.      The SALT Programming HyperText Manual v1.0 (SPHM10)        Page 3 of 7
  121.  
  122.      Browser Features
  123.      ----------------
  124.  
  125.      ALL MODES
  126.  
  127.      SPHM10 has many different types of 'links' to other  cards.  Some  are
  128.      evident   by  their  color  (such  as  menu  selections),  others  are
  129.      invisible.  Position the cursor on any word and press enter; if  there
  130.      are cards associated with that word, they will be displayed.
  131.  
  132.  
  133.      CONTEXT-SENSITIVE BROWSING (TSR MODE)
  134.  
  135.      SPHM10  will  read  the  screen  at  the  current  cursor location and
  136.      determine which card to bring up.  For example, while looking  through
  137.      a sample SALT script, suppose an unfamiliar command is encountered, or
  138.      related  information  is  desired. With the SALT Programming HyperText
  139.      Manual in TSR mode, simply move the cursor to the command in  question
  140.      and press "CTRL - ." (press the CONTROL or CTRL key, then the period).
  141.      A  short  list of possible 'topic links' will appear; the user selects
  142.      the one desired. SPHM10 will pop up and display 'card' associated with
  143.      that topic, showing the exact text from the SALT Manual.  Alternately,
  144.      if  a  topic  has been selected for which there is only one associated
  145.      card, that card will be immediately displayed.
  146.  
  147.  
  148.      STAND-ALONE MODE
  149.  
  150.      SPHM10  can  be called up and the manual 'paged' through in any manner
  151.      desired  to  familiarize  the  reader  with  the  concepts   of   SALT
  152.      programming.  Place marking and backtracking features allow the reader
  153.      to come back to information already presented.
  154.  
  155.  
  156.  
  157.  
  158.      The SALT Programming HyperText Manual v1.0 (SPHM10)        Page 4 of 7
  159.  
  160.      Command Line Options
  161.      --------------------
  162.  
  163.      SPHM10  should  reside  in  the  same  directory  where the Telix SALT
  164.      scripts are edited and compiled.
  165.  
  166.      To use SPHM10, enter one of the following lines from DOS:
  167.  
  168.      sphm10 -tsr   -  Run SPHM10 Terminate & Stay Resident (TSR) mode
  169.      sphm10 -u     -  Unload SPHM10 TSR from memory
  170.      sphm10        -  Run SPHM10 stand-alone mode
  171.      sphm10 -h     -  Displays help screen with list of command line
  172.                       options available in the current browsing mode.
  173.                       This option varies depending on whether the
  174.                       browser is in memory.
  175.  
  176.      Note: Commands (such as -tsr, -u, -h) are CASE SENSITIVE. Be  sure  to
  177.            enter commands in lower-case.
  178.  
  179.      The user must enter the full DOS path name if SPHM10 is not located in
  180.      the same directory  where  the  SALT  scripts  are  being  edited  and
  181.      compiled.
  182.  
  183.              Example: c:\telix\sphm\sphm10 -tsr
  184.  
  185.  
  186.      For more command line options, see the SPHM10 Command-Line Options
  187.      in SPHM10.
  188.  
  189.  
  190.      Example Batch File
  191.      ------------------
  192.  
  193.      To  use  SPHM10  while editing a SALT script, the programmer may first
  194.      use the TSR mode command (see above) or use a batch file such as;
  195.  
  196.      EDIT.BAT
  197.  
  198.      sphm10 -tsr      <-- Use SPHM in the TSR mode
  199.      q myscript.slt   <-- Edit the script (using QEDIT in this example)
  200.      sphm10 -u        <-- Remove SPHM from memory (when editing has
  201.                           been completed)
  202.  
  203.  
  204.  
  205.  
  206.      The SALT Programming HyperText Manual v1.0 (SPHM10)        Page 5 of 7
  207.  
  208.      Basic SPHM10 Navigation
  209.      -----------------------
  210.  
  211.      The HELP section within SPHM10 will provide the user with an extensive
  212.      overview of the concepts of HyperText. Use the "ALT - H" command  from
  213.      within SPHM10.
  214.  
  215.  
  216.      Known Problems
  217.      --------------
  218.  
  219.      MOUSE DRIVERS
  220.  
  221.      If  you have a Logitech mouse with an old driver (pre-V5.0), the mouse
  222.      action will not work properly in SPHM10. Update to V5.0 or  higher  of
  223.      the driver to correct the problem.
  224.  
  225.      Also,  SPHM10  will  lock  up  if  you  are  using a TrueMouse driver,
  226.      (purportedly supplied  by  NorthGate.)  Even  though  this  driver  is
  227.      supposed  to  be  100%  Microsoft compatible, it apparently isn't! The
  228.      same symptoms occur with some Mouse System mouse drivers.
  229.  
  230.      Try to use the latest mouse driver you can, and if  at  all  possible,
  231.      use a true Microsoft mouse driver.
  232.  
  233.  
  234.      IMMEDIATE LOCKUP
  235.  
  236.      If SPHM10 locks up on you, here are two possible reasons:
  237.  
  238.      1) Your computer is non-standard in some way in the upper memory  area
  239.         (between  640K-1MB),  and  causes  SPHM10's  automatic scan of this
  240.         area to lock up.
  241.  
  242.          Solution: Try using the -xh option, which will prevent SPHM10
  243.          from  scanning the upper memory area. If you use this option,
  244.          then you may NOT load SPHM10 into the upper memory area using
  245.          the DOS loadhigh command.
  246.  
  247.      2) Your mouse driver is old, or is not  a  true  Microsoft  compatible
  248.         driver.
  249.  
  250.          Solution: Try using the -mo- option which turns of the use of
  251.          the mouse in SPHM10. (Notice the dash before AND after "mo".)
  252.          If this clears up the problem, then either  use  this  option
  253.          all  the  time,  or  try to update to the latest mouse driver
  254.          you can.
  255.  
  256.  
  257.  
  258.  
  259.      The SALT Programming HyperText Manual v1.0 (SPHM10)        Page 6 of 7
  260.  
  261.      About Telix
  262.      -----------
  263.  
  264.      Telix  v3.15 is a full-featured communications program for PCs running
  265.      the PC/MS-DOS operating system, that is able  to  meet  the  needs  of
  266.      almost any user.
  267.  
  268.      Telix's extensive Script Application Language for Telix (SALT) is used
  269.      to automatically perform needed tasks  or  functions.  The  tasks  can
  270.      range  from  the  very  simple to the very complicated. For example, a
  271.      SALT script can be linked to a dialing directory entry, so that when a
  272.      connection to that service  has  been  established,  it  automatically
  273.      sends the user's i.d. and password to the remote service.  A much more
  274.      complicated  SALT  script  is  used  as  the  basis  for the Host Mode
  275.      included with Telix.
  276.  
  277.      Telix
  278.      is Copyright (c) 1986,1987,1988,1989,1990,1991 by Exis Inc.
  279.  
  280.      SALT Programming Manual
  281.      is Copyright (C) 1986,1987,1988,1989,1990,1991 by Exis Inc.
  282.  
  283.      EXIS Inc., Post Office Box 130, West Hill, ON, Canada  M1E 4R4
  284.      Phone (416)-289-4641 voice, (416)-289-4645 FAX, (416)-439-9399 BBS
  285.  
  286.  
  287.      About HyperHelper
  288.      -----------------
  289.  
  290.      SPHM10, the SALT Programming HyperText Manual v1.0 was developed using
  291.      HyperHelper v3.03 by  Azarona  Software.   The  Trial  Kit  (Shareware
  292.      version)  of HyperHelper is available free on CompuServe in the IBMAPP
  293.      Forum, Word-Processing library as HHV30.EXE.
  294.  
  295.      Call or write to;
  296.  
  297.      Azarona Software, P.O. Box 13433, Denver, CO, 80301
  298.      Phone (303) 697-1088, CompuServe address 73057, 3172
  299.  
  300.  
  301.  
  302.  
  303.      The SALT Programming HyperText Manual v1.0 (SPHM10)        Page 7 of 7
  304.  
  305.      Feedback
  306.      --------
  307.  
  308.      No compensation will be accepted by Web-Man Applications  for  SPHM10,
  309.      the SALT Programming HyperText Manual v1.0; however, feedback would be
  310.      appreciated.
  311.  
  312.      Please mail comments, suggestion, etc, to:
  313.  
  314.                              Web-Man Applications
  315.                               c/o Craig S. Miller
  316.                                 P.O. Box 60562
  317.                            Sacramento, CA 95860-0562
  318.  
  319.                        Phone (916) 486-0756 - Voice only
  320.  
  321.      I can be reached also through the FidoNet Telix Support echo.
  322.  
  323.