TekDoc 1.0 - README.TXT

-----------------------
The TekDoc utility extracts text from files to generate HTML documentation.
An alphabetical index and hierarchical document map are also generated. A
variety of options are available for controlling specific behaviors.

The script uses a simple tag extraction approach for extracting and formatting
text into HTML documentation.  It does not parse any specific programming
language syntax.  Therefore, any text input file may be processed such as
text files and C, C++, Perl or Java source code.

This monolithic script approach was used to make moving and using the
script as easy as possible.  Everything needed is in the source code
file TekDoc.pl.  The documentation may be generated into the directory
.\Doc by using:  perl TekDoc.pl -d Doc -f -l 1 TekDoc.pl
The documentation contains an example configuration file that may be
cut and pasted to create a new one.

This utility is written in Perl 5.

-----------------------
Files:
Doc directory   - Generated TekDoc documentation.

gTekDoc.bat     - PC batch file for (re)generating the TekDoc documentation.
TekDoc.bat      - PC babtch file shorthand for executing the TekDco script.
TekDoc.cfg      - TekDoc configuration for variables that do not change often.
TekDoc.pl       - The TekDoc script, written in Perl.
Readme.txt      - This file.

-----------------------
Platforms:
TekDoc has been tested on Windows 95, Windows NT and various UNIX operating
systems.

The line termination characters in the script and configuration file
may need to be translated for a particular platform; CR/LF on DOS and Windows
platforms, and LF on UNIX.

The directory separator character is set near the beginning of the script (code)
based on the values of some expected variables.  However, the local operating
system may also be hardcoded if necessary.

-----------------------
This script is hereby released into the PUBLIC DOMAIN.  Any use, modification,
derivative work or other use of this script is EXPRESSLY GRANTED by the author.
NO warrantee, guarantee, or fitness for any particular purpose is expressed or
implied.  If you break it, you own both parts.

This script was written because we needed the functionality, not as a Perl
programming exercise.  It is not necessarily the most elegant or efficient
way to implement this functionality, but it works.

Written at:
   GrayHill Systems, Inc.
   by Todd R. Hill, todd.hill@grayhillsys.com
