IIUG Software Repository Files

################################################################################
An Instant HTML Data Base Documentation Tool
Tim Schaefer, tim@datad.com

  ----------------------------------------------------------------------------
                               RCS Information
  ----------------------------------------------------------------------------
    $Revision: 1.5 $
      $Author: informix $
       $State: Exp $
        $Date: 1999/09/10 03:58:11 $
      $Locker:  $
         $Log: html_ec_desc.txt,v $
         Revision 1.5  1999/09/10 03:58:11  informix
         September Release - Additions and Corrections 1999-09-11

         Revision 1.4  1999/07/09 17:02:23  informix
         documentation changes

         Revision 1.3  1999/07/09 16:58:32  informix
         documentation changes

         Revision 1.2  1999/07/09 16:47:11  informix
         added chmod instructions

         Revision 1.1  1999/07/09 16:43:40  informix
         Initial revision

  ---------------------------------------------------------------------------
                         Copyright (C) 1999, Tim Schaefer 
  ----------------------------- All Rights Reserved -------------------------  


This is a September 1999 release of a tool that allows you to instantly document 
your data base(s) in HTML, and take advantage of the Frames capability in Netscape
and other browsers.  It was first released in 1996, and has been included as a
tool in several Informix Press Books.

This release is also different in that several changes and bugs have been 
fixed.  It has only been tested on SuSE 6.1 Linux 2.2.10 so I do not know how
good, or bad some of the bugs may be, if any.  There are always bugs.  This is
how life is.  If you discover a bug, please let me know.  

All the tools will work even if you see warnings about variables being redeclared 
elsewhere, especially on Linux.  This is not a problem, and the tools will work fine.  

Several recent bugs identified by some of the folks downloading have been fixed
and I've also replaced a couple of the tools with better versions that were
supposed to be in the July release.

Many of the boilerplates show an informix login in the RCS comments, this is
only a local login and is not to be construed as implying that these tools
came from Informix, they did not.  If you are like me, chances are you develop
tools or work with the Informix engine as the informix id, which is necessary
in many instances (but not always).  

Tim Schaefer
September 1999
--------------------------------------------------------------------------------

UNIX
====
      A master makefile is included:  make -f html_ec.mk  
      Requires Informix ESQL/C, and a standard C compiler

--------------------------------------------------------------------------------

WIN95/WINNT
===========

      UNTESTED FOR WINDOWS NT OR WINDOWS 95 OR WINDOWS 98

      A master makefile is included:  nmake -f html_ec.mak  
      Requires Informix ESQL/C, and a standard C compiler

      The previos release of this tool worked on Windows but there is no
      certainty that it works today the same.

--------------------------------------------------------------------------------

Any versions of source code found here that exist in any other reference are
obsolete.  These versions are the latest.

################################################################################
           Copyright Tim Schaefer 1999, 2000 All Rights Reserved 
################################################################################

html_ec.mk        - makefile for all the EC programs 

html_ccx.ec       - generates a cross-reference of columns to tables
html_ccx.mk       - makefile for html_ccx.ec

html_constr.ec    - generates constraint information about a data base
html_constr.mk    - makefile for html_constr.ec

html_index.ec     - generates index information about a data base
html_index.mk     - makefile for html_index.ec

html_lib.ec       - some common functions for all the html_*.ec programs
html_lib.h        - some common variables for all the html_*.ec programs

html_table.ec     - generates table information about a data base.
html_table.mk     - makefile for html_table.ec

html_idx_ccx.ec   - index xref report ordered by column names
html_idx_ccx.mk   - makefile for html_idx_ccx.ec

html_db_doc.sh    - THE MAIN SCRIPT TO RUN TO GENERATE DOCUMENTATION  

html_master.sh    - Called by html_db_doc.sh - Produces Master.database.html 
html_schema.sh    - Called by html_db_doc.sh - Produces all the html files 

################################################################################
INSTALLATION QUICK START
################################################################################

1.	Create a directory for this distribution, and untar these files.

	For example:

	mkdir /home/informix/html_ec
	cd /home/informix/html_ec
	tar xvf html_ec.tar

2.	Create a $HOME/bin directory.  Compiled binaries will go here 

	mkdir /home/informix/bin

	ADD THIS DIRECTORY TO YOUR PATH!

	PATH=$PATH:/home/informix/bin

	BE SURE TO ". .profile" BEFORE PROCEEDING.

3.	Compile the programs with html_ec.mk:

	make -f html_ec.mk

	To put them in your $HOME/bin:

	make -f html_ec.mk bin

	If you produce errors that prevent the program(s) from compiling
	please check to make sure you have esqlc installed, and that you
	have everything working.  If it is not a user problem, please
	contact me and I'll try to help you to make sure they compile.

4.	Copy the *.sh shell scripts to your $HOME/bin

	cd /home/informix/html_ec
	cp *.sh $HOME/bin
	chmod 755 html*.sh

5.	Edit the dbs.lst file and put any data bases you want to document
	in this list.  If you have none for now, fine, sysmaster and sysutils
	are the only ones that will be documented, if you are using 7.x.

	If you are not using 7.x, change this to reflect the correct data
	bases.

6.	Copy the dbs.lst to /home/informix/bin

	cp dbs.lst $HOME/bin

7.	Create a separate directory where generated HTML files will go:

	mkdir /home/informix/html

8.	cd to that directory:

	cd html

9.	Run the script html_db_doc.sh

	An HTML file for each table for the sysmaster and sysutils data base
	will be generated.

10.	With your favorite browser, open the Master.database.html file and
	voila you have instant documentation about your data bases and tables.