home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / progm / hyperhlp.zip / README < prev    next >
Text File  |  1989-06-21  |  7KB  |  193 lines
  1.                                HyperHelper 1.5
  2.  
  3.                           Another ShareWare Product:
  4.                    Inexpensive software for the rest of us!
  5.                                      by
  6.                                 Bryan Flamig
  7.  
  8.  
  9.     HyperHelper is a ShareWare utility that enables you to construct
  10.     custom hypertext help and readme systems.
  11.  
  12.     Files you should have:
  13.     
  14.         readme       -- This file.
  15.         update       -- Summary of new features
  16.         hh.exe       -- The hypertext browser.
  17.         hc.exe       -- The hypertext compiler.
  18.         hyperhlp.htx -- A sample hypertext file that briefly explains
  19.                         what HyperHelper is and how to use it.
  20.         sample.txt   -- A sample text file that illustrates how
  21.                         hypertext cards are created in HyperHelper.
  22.  
  23.     
  24.     A Brief Description
  25.  
  26.     HyperHelper is a ShareWare utility that is ideal for creating
  27.     custom hypertext help and readme systems on IBM PC's and
  28.     compatibles. HyperHelper differs from other help utilities
  29.     in that it is simple, inexpensive, and takes a minimum of
  30.     resources, yet at the same time provides a way to incorporate
  31.     hypertext into help systems.
  32.  
  33.     You can use HyperHelper to build your own:
  34.  
  35.              o hypertext "readme" files
  36.              o hypertext help for application programs
  37.              o hypertext help for programming libraries
  38.          o hypertext references for just about anything!
  39.  
  40.     HyperHelper consists of a hypertext compiler and browser which
  41.     enable you to create and view hypertext files. A hypertext help
  42.     system begins as a text file that contains the information that
  43.     is to be displayed by the browser. In addition, special link
  44.     commands are embedded into this text which specify how you will
  45.     be able to move about the information. The compiler then reads
  46.     this file and translates it into a special hypertext format that
  47.     you can view with the browser. That's all there is to it!
  48.  
  49.  
  50.     Getting Started
  51.     
  52.     If you want to begin learning how HyperHelper works, try running
  53.     the hypertext browser by typing:
  54.     
  55.                               hh hyperhlp
  56.     
  57.     at the DOS prompt. This will invoke the HyperHelper browser and
  58.     display the contents of the hyperhlp.htx file-- a hypertext
  59.     file which explains how to use HyperHelper and briefly tells you
  60.     how you can go about building your own hypertext cards.
  61.     
  62.     
  63.     Try Out the HyperHelper Compiler
  64.     
  65.     After you get a feel for the HyperHelper browser, you'll probably
  66.     want to try out the HyperHelper compiler. For your convenience
  67.     the distribution disk includes a very simple hypertext file,
  68.     called sample.txt, that you can try compiling. You can edit this
  69.     file with your favorite text editor; however, make sure your editor
  70.     has formatting turned off.
  71.     
  72.     To compile sample.txt into a hypertext file that is readable by the
  73.     HyperHelper browser use:
  74.     
  75.                               hc sample
  76.     
  77.     Note that the .txt extension of the filename is not used. The
  78.     compiler will translate the .txt file into a special format that
  79.     is only readable by the HyperHelper browser. This compiled file
  80.     will be called sample.htx.
  81.     
  82.     Now try browsing through the file sample.htx with the HyperHelper
  83.     browser by typing:
  84.     
  85.                               hh sample
  86.     
  87.     You'll probably want to look at sample.txt to see how the various
  88.     HyperHelper commands are used. In addition, you might want to try
  89.     modifying the file in order to try out the commands on your own.
  90.     
  91.     
  92.     Tips on Using HyperHelper
  93.     
  94.     Although space does not allow a full description of the features in
  95.     HyperHelper, the following tips may prove useful while you are
  96.     learning how to use HyperHelper:
  97.     
  98.     1. If you encounter problems reading the screen with your monochrome
  99.        monitor, try the following option which forces HyperHelper to
  100.        use monochrome attributes:
  101.                 
  102.                             hh -m <hypertext_file>
  103.     
  104.     2. You can move the HyperHelper window on the screen by holding
  105.        down the Shift key while using the arrow keys. If snow appears
  106.        on the screen when moving the window, try invoking HyperHelper
  107.        with the -s switch at the command-line. This will prevent most
  108.        of the snow. Therefore, if snow appears on the screen use:
  109.     
  110.                             hh -s <hypertext_file>
  111.     
  112.     3. HyperHelper is designed to work in text mode only.
  113.  
  114.     4. For best performance locate your hypertext files on a hard disk.
  115.        
  116.       
  117.     A Word of Caution
  118.     
  119.     This version of HyperHelper is fully operational, but it DOES NOT
  120.     contain a comprehensive user's guide. Nonetheless, the files
  121.     sample.txt and hyperhlp.htx should give you an adequate idea of
  122.     how HyperHelper works and how to make your own hypertext system.
  123.     If you find HyperHelper useful and decide to register your copy
  124.     of HyperHelper, you will receive the complete printed documentation.
  125.     
  126.  
  127.     Registering HyperHelper!
  128.     
  129.     Since HyperHelper is a ShareWare product, you are encouraged to
  130.     experiment with it and share it with your friends as long as the
  131.     following provisions are met:
  132.     
  133.        1) It is distributed ONLY in its original, unmodified form.
  134.        2) No fee is charged for copying or distribution without
  135.           permission by the author.
  136.     
  137.     If you find HyperHelper useful, you may register your copy for $20
  138.     in which case you will receive:
  139.     
  140.        1) The latest version of HyperHelper.
  141.        2) A printed user's guide that explains how to use the
  142.           HyperHelper browser and how to create your own
  143.           hypertext files.
  144.        3) A memory-resident, context sensitive version of the
  145.           HyperHelper browser.
  146.        4) An install program which allows you to change the
  147.           colors used by HyperHelper.
  148.     
  149.     To register HyperHelper, fill out the form below and send it along
  150.     with $20 in check, money order, or Visa/MasterCard. Or for
  151.     immediate processing, call the number below and place your order
  152.     using your Visa or MasterCard.
  153.  
  154.  
  155.                           Ein Stein's Computers,
  156.                           750 Bridge Street
  157.                           Yuba City, CA  95991
  158.                           (916) 671-7444
  159.  
  160.  
  161.     __________________________________________________________________
  162.     Name
  163.  
  164.     __________________________________________________________________
  165.     Company Name
  166.  
  167.     __________________________________________________________________
  168.     Address
  169.  
  170.     __________________________________________________________________
  171.     City                         State                 Zip
  172.  
  173.     __________________________________________________________________
  174.     Telephone
  175.  
  176.  
  177.     Registration Fee:  $ _____________
  178.  
  179.     Tax (CA only)   :  $ _____________
  180.  
  181.     Total Enclosed  :  $ _____________
  182.  
  183.  
  184.     Method of payment:  Check ______   Visa ______   MasterCard ______
  185.  
  186.     Credit Card Number: ______________________________________________
  187.  
  188.     Expiration Date: _________________________________________________
  189.  
  190.     Signature:________________________________________________________
  191.  
  192.     [107]
  193.