HTML Conversion Utilities for CHARMM .doc Files
-----------------------------------------------------------------

The scripts and templates described below were developed at NIH to
quickly and automatically convert the CHARMM documentation files,
written in 'info' format, to HTML equivalents.  All of the
hypertext nature of original is maintained, including:

	- file references in the 'info' (chmdoc/*.doc) format
	- Menu: items, both file references and Node: references
	- Next: Previous: Up: references in File: Node: headers

The file conversion is fully automated, but installation of the
converted files onto a web server is not; I couldn't assume the CHARMM
dirs and the web server dirs were in the same file space, i.e. will
'cp' work or not.  The 'html' subdir is created at the CHARMM version
root, and the .html and image files are put there.  

Custom local site info is specified by editing a configuration
file (Local.Config); the CHARMM version and local HTML links are set
here, as well as image file names.

A new feature is the fully automated production of:

	- the table of .doc files on the main page (index.html)
	- composite menu items listing (Menu: items from all files)
	- composite listing of first 32 lines from each .doc file

The latter 2 were designed to facilitate within page searching over
information from all .doc files.

This is a complete replacement for the  support/htmldoc  subdir.

	Installation Instructions:
	--------------------------

The package is easily unwrapped in the CHARMM support subdir via

% gzip -dc doc2html.tar.gz | tar -xvf -

( When the doc2html.com script is run, it assumes the relative
../../doc path to the CHARMM .doc files, and the ../../html path
for the target. )

	In the new  support/doc2html  subdir just created:

(1) copy Local.Config.Orig to Local.Config and then edit Local.Config
    to customize it for your site (links, email support, images)

(2) run the script   doc2html.com

(3) copy the 'html' subdir (or contents) to a public file system
    or web server

	A working conversion is available at URL:

http://www.lobos.nih.gov/Charmm/

	Notices:
	----------

This package may be freely distributed, but only in it's unmodified,
intact form.

Please report all doc2html bugs to the author:

Rick Venable
FDA/CBER/OVRR Biophysics Lab
1401 Rockville Pike   HFM-419
Rockville, MD  20852-1448

Rick_Venable@nih.gov

No warranty expressed or implied, etc.

	File Manifest:
	--------------

File Name             Type                 Purpose
--------------------------------------------------------------------------
Local.Config.Orig   script        variable definitions for the local site
                                  All customization is done in a copy of
                                  this file (named Local.Config).

README              text          this minimal documentation file

doc2html.com        user script   main .doc to .html conversion script

Charmm1.Tplt        template      top level HTML file, index.html
Charmm2.Tplt        template      top level HTML file; part 2
MBCO.gif            GIF image     decoration; hydrated myoglobin postage stamp
Banner.gif          GIF image     decoration; DPPC lipid bilayer banner

	In the  Scripts  subdir:

fixdoc.sed          script        cleanup sloppy 'info', handles <>&"
hrefprep.sed        script        prepare headers
info2html.awk       script        processes File: Node: headers
--------------------------------------------------------------------------