LaTeX2HTML Version 0.3.1 Wed Sep 1 1993: README  

Overview
********

The translator: 

 o breaks up a document into one or more components as specified by
   the user, 
 o provides an optional next, previous, and up navigation panel on every
   page, 
 o handles equations, tables, figures, and any arbitrary environment.  
   These are passed to
   [LaTeX] and then converted to images which are either included in
   the document or are made available through hypertext links, 
 o can produce output suitable for browsers that support inlined images
   or character based browsers (as specified by the user), 
 o handles definitions of new commands, environments, and theorems
   even when these are defined in external style files, 
 o handles footnotes, tables of contents, lists of figures and tables,
   bibliographies, and can generate an  index, 
 o translates cross-references into hyperlinks, 
 o extends the [LaTeX] cross-referencing mechanism to work not just
   within a document but between documents which may reside in
   remote locations, 
 o recognizes hypertext links (to sound/video/ftp/http/news etc.
   addresses) expressed as LaTeX commands, 
 o can deal sensibly at least with the Common [LaTeX] commands
   summarized at the back of the [LaTeX] blue book [1], 
 o will try and translate any document with embedded [LaTeX]
   commands irrespective of whether it is complete or syntactically
   legal.  

User Manual
***********

The latex2html program includes its own manual page. 
The manual page can be viewed by saying %nroff -man latex2html .  

See the online documentation or the <latex2htmldir>/doc/latex2html.ps 
file for more information and examples.
.sp 1.

Installing the Translator
*************************

You should already have the following files: 

 o A README file.   
 o A texexpand Perl program 
 o The latex2html Perl program (containing its own man page).  
 o The pstoxbm script for converting postscript files into the XBM
   format.  
 o The pstogif script for converting postscript files into the GIF
   format.  
 o The pstoppm.ps postscript program which is used by pstoxbm
   and pstogif.  
 o A sample intialization file ( dot.latex2html-init).  
 o A [LaTeX] style file ( html.sty).  
 o A subdirectory (icons) containing various navigation icons.  
 o A subdirectory (doc) containing some postscript documentation.  

To install the translator do the following: 

 o In the latex2html Perl progam, modify the second line according to
   where Perl is on your system.  If you have Perl installed as a shell you
   can replace the first three lines with #!<perl-directory>/perl.  
 o Do the same in the texexpand Perl program (i.e.  either modify the
   second line or replace the first three lines with
   #!<perl-directory>/perl).  
 o If possible please copy the icons subdirectory to a place under your
   WWW tree where they can be served by your server.
   If you cannot do that bear in mind that these icons will have to travel
   from Leeds !!!  Also, your documents will depend on our server being
   operational in the first place.  
 o In the file dot.latex2html-init: 
    o Modify the values of the variables TEXEXPAND, LATEX,
      DVIPS, PSTOXBM, and PSTOGIF according to where the
      corresponding executables and scripts can be found.  
    o Modify the values of the environment variables GS,
      PNMCROP, PPMTOXBM, and PSTOPPM, according to
      where the corresponding executables and scripts can be found.
      These variables are used by the pstoxbm and pstogif scripts.  
    o Set any variables that control the defaults of the command line
      options  to your preferred values.  
    o If you have copied the icons subdirectory (see above) then
      modify the value of the ICONSERVER variable accordingly.  
 o Move dot.latex2html-init to your home directory and rename it 
   .latex2html-init.  

The latex2html program should now be ready to run.  

Requirements
============

The translator makes use of the following public domain programs and
libraries: 

 o [LaTeX], dvips (version 5.512 or later).  These are part of the same
   distribution.  
 o Perl (version 4.0 - RCSfile: perl.c,v - Revision: 4.0.1.8 - Date:
   1993/02/05 19:39:30 - Patch level: 36) 
 o gs (Ghostscript version 2.6.1).  This is necessary for the conversion of
   postscript files to the XBM and GIF formats.  
 o The pbmplus library (distribution of 22nov89 or later).  From this, the
   utilities pnmcrop and ppmtoxbm are used during the postscript to
   XBM conversion.  

Because by default the translator makes use of inlined images in the final
HTML output, it would be better to have a viewer which supports the 
<IMG> tag, such as NCSA Mosaic. If only a character based browser is
available or if you want the generated documents to be more portable then
the translator can be used with the -ascii_mode.  

If ghostscipt or the pbmplus library are not available it is still possible
to use the translator with the -nolatex option.  In this way it
might still be possible to get acceptable output but without equations, 
figures, tables, special symbols and arbitrary environments.  

Earlier versions of Perl than that shown above have caused compilation
problems due to tighter control over syntax.  Also earlier versions of some of
the postscript to XBM filters cause parts of the borders of some images to
disappear.  

If you intend to use any of the special features of the translator
then you have to include the html.sty file in any [LaTeX] documents that
use them.  


[1] Leslie Lamport.  LATEX User's Guide & Reference Manual.
    Addison-Wesley Publishing Company, Inc., 1986.  


Nikos Drakos <nikos@cbl.leeds.ac.uk>
Computer Based Learning Unit
University of Leeds.