AutoHelp for Components
Version 2.02                                                dinobyte@aol.com
Copyright  1997 DinoByte Software                   dinobyte@compuserve.com
All Rights Reserved Worldwide                http://members.aol.com/dinobyte


For best results adjust this window wide enough to display the line below.
----------------------------------------------------------------------------


WHAT IS IT?
-----------
AutoHelp is a program that you use to create Help (.hlp) files for Delphi
components.  AutoHelp scans your source files, creates a database of all
objects found, and generates a series of topics for each object.  You then
edit the topics using a simple visual interface which closely mimics the
look of the actual help file.  AutoHelp then generates the necessary support
files and runs the Help Compiler to create your help file.


A FEW FEATURES:
---------------
+ Automatically Creates Topics for all Objects
   AutoHelp automatically generates complete topics for all Units,
   Components, Properties, Methods, Events, Constants, Routines, and Types
   found in one or more source files.
+ Automatically Creates Topic Links
   AutoHelp provides a function, similar to a spell checker, which checks
   every word in every topic for references to objects found in the source
   code.  It then gives you the option of converting these words into
   hyperlinks connecting to the objects topic.
+ Optionally Creates Registration Topics
   AutoHelp can optionally generate a series of Registration topics and a
   Registration button to make it easier for your customers to purchase your
   product.  It is also very easy to create a second help file for
   registered users which does not contain the registration information.
+ Simple Visual Interface
   The entire help building process is controlled from a simple visual
   interface.  Topics are displayed one at a time and closely mimic the look
   of the actual help file.  The current topic may be edited using standard
   word processor type functions.  Clicking any hyperlink will immediately
   display the topic associated with that hyperlink.
+ Topics Generated from Templates
   AutoHelp uses templates to determine how to build new topics.
   Templates control just about all aspects of the topic building process.
   The default templates generate topics which closely resemble those found
   in Delphis own help files.
+ Descriptions from Remarks
   AutoHelp is able to retrieve remarks from the source code and
   automatically use them as descriptions for objects in the project.
   This is a very powerful feature which reduces the time needed to create
   the help file and encourages heavily documented source code.


INSTALLATION:
-------------
1. Extract EVERYTHING in the AutoHlp2.zip into the directory you want
   AutoHelp installed to.
2. Run the executable (AutoHelp2.exe).  The first time it is run AutoHelp
   will perform all the necessary setup chores.
3. That's pretty much it.  There is no uninstall feature but AutoHelp does
   not copy any additional files or install any DLL's (pretty unusual for
   a Windows program, huh?).  It does add quite a few registry items under
   the key 'HKEY_CURRENT_USER\Software\DinoByte\AutoHelp'.


HOW TO REGISTER:
----------------
AutoHelp may be registered using: Visa, Discover, MasterCard, U.S. Check,
U.S. Money Order, or the CompuServe SWREG Forum.

+ Through NorthStar Solutions using a credit card the price is $65.00
  NorthStar Solutions takes orders Online, By Phone, FAX, or Email.

+ Using the CompuServe SWREG Forum the price is $69.00
  The cost is billed to your CIS account.

+ By U.S. Check or Money Order the price is $75.00
  Checks & Money Orders must be in U.S. currency drawn on a U.S. bank.


HELP COMPILER NOTE:
-------------------
This release of AutoHelp adds the ability to use the new 32 bit help compiler (HCW.EXE).
I highly suggest using this compiler.  It is much faster and less error prone than the DOS
versions.  If you have run a previous release of AutoHelp, you can change to this compiler by
displaying the "Options" dialog, "External" page.  Just click on the browse button to the
right of the "Help Compiler" field.  The file you're looking for is "HCP.EXE" and should be
located in the "\Help\Tools\" directory.


FILES INCLUDED:
---------------
AutoHelp2.exe - AutoHelp for Components
		Used to quickly and easily create help files for
		Delphi components.
AutoHelp2.hlp - Help file
		The main help file for AutoHelp.
defaults.tpl  - Default templates
		The default templates which generate topics very similar to
		those used by Delphi versions 1 & 2.
english.dct   - English Dictionary
		The English (American version) dictionary used by the
		internal spell checker.
Revision.txt  - Revision History
*.bmp         - Bitmap files
		These are the default bitmaps to use as the Key and Run-Time
		only images in Property, Method, and Event popup windows.
*.qdb	      - Database files
		Used by AutoHelp to store tables of information.
		AutoHelp uses the excellent Freeware QDB component by
		Robert Marsh (many thanks!)


REPORTING PROBLEMS:
-------------------
The DinoByte web page contains a link to a Known Bugs page.  Please look
there to see if the problem has already been reported, before notifying me.

When reporting errors, please be as detailed as possible:
 - What were you doing when it happened?
 - Were you able to duplicate the error?
 - What was the EXACT error message?
 - If it occurred during the scan, what scan options were set?

The other thing I have to know is which version of AutoHelp you are using.
You can find this information by selecting the 'Help >> About' menu item.


LEGAL STUFF:
------------
+ License Agreement
  You should carefully read the following terms and conditions before using
  this software.  Your use of this software indicates your acceptance of
  this license agreement and warranty.
  For information on distributing the shareware evaluation version of
  AutoHelp see the Shareware License section.

+ Registered Version
  One registered copy of AutoHelp may either be used by a single person who
  uses the software personally on one or more computers, or installed on a
  single workstation used nonsimultaneously by multiple people, but not both.
  You may access the registered version of AutoHelp through a network,
  provided that you have obtained individual licenses for the software
  covering all workstations which access the software through the network.

+ Disclaimer of Warranty
  THIS SOFTWARE AND THE ACCOMPANYING FILES ARE SOLD "AS IS" AND WITHOUT
  WARRANTIES AS TO PERFORMANCE OF MERCHANTABILITY OR ANY OTHER WARRANTIES
  WHETHER EXPRESSED OR IMPLIED.  Because of the various hardware and
  software environments into which AutoHelp may be put, NO WARRANTY OF
  FITNESS FOR A PARTICULAR PURPOSE IS OFFERED.
  Good data processing procedure dictates that any program be thoroughly
  tested with non-critical data before relying on it.  The user must assume
  the entire risk of using the program.  ANY LIABILITY OF THE SELLER WILL BE
  LIMITED EXCLUSIVELY TO PRODUCT REPLACEMENT OR REFUND OF PURCHASE PRICE.


SHAREWARE LICENSE:
------------------
+ Evaluation and Registration
  This is not free software.  You are hereby licensed to use this software
  for evaluation purposes without charge for a period of 30 days.  If you
  use this software after the 30 day evaluation period, a registration fee
  of $75 is required.  Details on registering this software are available in
  the Registering AutoHelp section.
  Unregistered use of AutoHelp after the 30-day evaluation period is in
  violation of U.S. and international copyright laws.

+ Distribution
  Provided you do not distribute a registration ID, you are hereby licensed
  to make as many copies of this software and documentation as you wish;
  give exact copies of the original version to anyone; and distribute the
  software and documentation in its unmodified form via electronic means.
  You are never authorized to provide your registration ID to another
  person.
  You are specifically prohibited from charging, or requesting donations,
  for any such copies, however made; and from distributing the software
  and/or documentation with other products (commercial or otherwise) without
  prior written permission.
