This README file describes the lemacs lisp package hm--html-3.6.
The package provides various pupop and pulldown menus and functions for
the html-mode from Marc Andreessen, and support for the w3-package
from William M. Perry and the file html-view.el from Ron Tapia.

Look at the file NEWS, to see what is new in this release. 

There is also a file in this package, which provides the posibility 
to scroll a buffer by clicking with the mouse on the modeline. But you
need some files from the package hm--lemacs-menus-1.0 to use it. You
can get this package from one of the following sites:
 ftp.rrzn.uni-hannover.de:/pub/unix/editors/lemacs/contrib
 sunsite.unc.edu:/pub/Linux/Incoming
The filename of the package is hm--lemacs-menus-1.0.tar.gz. 
This feature is only for the lemacs.

You should (but must not) also get the w3 package from:
 cs.indiana.edu:/pub/elisp/w3/w3.tar.z
which provides an world wide web mode for the lemacs, emacs and epoch.


This package is tested with the lemacs 19.4 and 19.8 on Suns with SunOS 4.1.3 
and on PC's with linux. But it should work also on other (only UNIX ?) 
plattforms.

The package will be fully ported to the GNU Emacs 19 in the future. Most of
the work is done allready. Read the file README-EMACS-19, if you want to
use this package with GNU Emacs 19.
Thanks to Richard Stallman, who has supported me to port this package to the 
Emacs 19.


The package consists of the following files:

README				: this file;
README-EMACS-19			: only for Emacs 19 user;
ANNOUNCEMENT			: Text of the announcement of this package;
LSM				: Entry for the Linux Software Map;
NEWS				: Change logfile;
adapt.el			: provides functions to use the package also
				  with the GNU Emacs 19
hm--html.el			: provides functions to write html pages;
				  some of these functions are similar to
				  functions of the html-mode.el;
hm--html-menu.el		: provides the menus; this is the main file;
hm--html-configuration.el	: configuration file for the html mode;
				  choose this as system configuration file
.hm--html-configuration.el	: configuration file for the html mode;
				  choose this as user configuration file;
				  (it is only an example);
hm--date.el			: Defines the function hm--date, which returns
 				  the date in the format "day-month-year" 
				  like "30-Jun-1993".
hm--mouse-on-modeline.el	: provides functions for scrolling html
				  buffers by clicking on a modeline;
				  look at this file, if you want to add
				  the mouse scrolling feature to the
				  html-mode in the lemacs; it must be
				  loaded after the other html files;

html-mode.el			: Marc Andreessen's html-mode file; use this
				  one, if your html-mode.el is older or doesn't
				  work together with my files;
html-view.el			: Ron Tapia's html-view.el to view html-pages
				  in the Xmosaic; it is patched for the use
				  with the lemacs;
templates-syntax.doc		: descibes the syntax of the templates provided
				  by the file tmpl-minor-mode.el
tmpl-minor-mode.el		: provides functions for the tmpl-minor-mode;
				  with this mode you can expand templates,
				  which are described in the file
				  templates-syntax.doc (look at the file
				  command-description-template-2.html for
				  an example);
				  templates can be expanded automaticly, if
				  you include a file with templates via the
				  html pulldown menu item "Templates ...";
command-description-template.html
				: Templatefile;
command-description-template-2.html
				: Templatefile, similar to the file
				  command-description-template.html, but with
				  the use of templates;
emacs-19/*			: only for emacs 19 user;


INSTALLATION:
=============
1.	Put all the *.el files (except .hm--html-configuration.el and
	the files in the subdirectory emacs-19)
	in one of your lemacs (or emacs) lisp load directories 
	(i.e. lisp/packages).

2.	Put the following in your .emacs (or default.el or site-init.el):
	(autoload 'html-mode "hm--html-menu" "HTML major mode." t)
	  (or (assoc "\\.html$" auto-mode-alist)
            (setq auto-mode-alist (cons '("\\.html$" . html-mode) 
				        auto-mode-alist)))
	
	The above lines assume, that you have not installed the html-mode.el.
	You should remove the appropriate (old) lines, if that isn't true.

3.	Set the environment variable HTML_CONFIG_FILE to the html system 
	configuration file i.e.:	
	setenv HTML_CONFIG_FILE /usr/lemacs/lisp/hm--html-configuration.el

4.	Set (if you want) the environment variabe HTML_USER_CONFIG_FILE to 
	the html user configuration file i.e.:
	setenv HTML_USER_CONFIG_FILE ~/.hm--html-configuration.el
	And put the file .hm--html-configuration.el in your Homedirectory.

5.	Check the files hm--html-configuration.el and 
	.hm--html-configuration.el, if all variables are set suitable for 
	you and your site. You can make changes in both of these files.
	But .hm--html-configuration.el preceeds the settings in
	hm--html-configuration.el, because it is the user specific
	configuration file. So you should made site specific changes in 
	hm--html-configuartion.el.
	Look at first at the following variables:
		hm--html-signaturefile
		hm--html-username
		hm--html-template-dir
		html-document-previewer
		html-view-html-document-previewermosaic-command
		w3-default-homepage

6.	If you want to use templatefiles, you should put these files
	in the directory on which 'hm--html-template-dir' pointed.
	You can use the file command-description-template.html as
	an example.

7.	Look at the installation part of the file hm--mouse-on-modeline.el,
	if you want to have the capability to scroll the buffer by mouseclick.


Every hm--*.el file has a description and installation part. Look at first
at these parts, if you have any questions.

Look at first at the configuration files, if you've problems with this package!


Sorry, I know that the documentation of this package isn't so good as it
should be, but at the moment I've not the time to make a better one.



Please send any bug reports, fixes or comments to 
		muenkel@daedalus.tnt.uni-hannover.de


I hope these files will be usefull,

Heiko

