1LaTeX2HTML README 2================= 3 4Contents 5******** 6 7Overview 8Pointers to the User Manual 9Requirements 10Installation 11Troubleshooting 12Support and More Information 13 14Overview 15******** 16 17The LaTeX2HTML translator: 18 19 o breaks up a document into one or more components as specified by 20 the user, 21 o provides optional iconic navigation panels on every page which 22 contain links to other parts of the document, 23 o handles inlined equations, right-justified 24 numbered equations, tables, or figures and any arbitrary environment, 25 o can produce output suitable for browsers that support inlined images 26 or character based browsers (as specified by the user), 27 o handles definitions of new commands, environments, and theorems 28 even when these are defined in external style files, 29 o handles footnotes, tables of contents, lists of figures and tables, 30 bibliographies, and can generate an Index, 31 o translates cross-references into hyperlinks and extends the 32 LaTeX cross-referencing mechanism to work not just 33 within a document but between documents which may reside in 34 remote locations, 35 o translates accent and special character 36 commands to the equivalent ISO-LATIN-1 37 character set where possible, 38 o recognizes hypertext links (to multimedia resources or arbitrary 39 internet services such as sound/video/ftp/http/news) and links which 40 invoke arbitrary program scripts, all expressed as LaTeX commands, 41 o recognizes conditional text which is intended only for the hypertext 42 version, or only for the paper (DVI) version, 43 o can include raw HTML in a LaTeX document (e.g. in order to specify 44 interactive forms), 45 o can deal sensibly with all the commands and environments commonly used 46 with LaTeX as summarized at the back of the LaTeX blue book [1], 47 and many of the packages described in the LaTeX Companion, and others. 48 o will try to translate any document with embedded LaTeX commands 49 irrespective of whether it is complete or syntactically legal. 50 51Pointers to the User Manual 52*************************** 53 54The LaTeX2HTML program includes its own manual page. 55The manual page can be viewed by saying "perldoc latex2html" 56or "latex2html -help". 57 58See the online documentation at 59 http://www-texdev.ics.mq.edu.au/l2h/docs/manual/ 60for more information and examples. 61 62Other useful links can be found at: www.latex2html.org 63and at the mailing-list site: 64 http://tug.org/mailman/listinfo/latex2html 65 66In particular see the pages: 67 support.html , Snode1.html , Snode2.html , Snode3.html 68for instructions on how to install the program 69and make your own local copy of the manual in HTML. 70 71Requirements 72************ 73 74Please consult the section "Requirements" of the online manual at 75 76 http://www-texdev.ics.mq.edu.au/l2h/docs/manual/Snode2.html 77 78for more information as well as *active* links to any utilities 79that you may require. 80 81 82The requirements for using LaTeX2HTML depend on the kind of 83translation it is asked to perform as follows: 84 85 1. LaTeX commands but without equations, figures, tables, etc. 86 o Perl 5.003 (Perl5 Patch level 3) or higher. 87------^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 88 89 o DBM or NDBM, the Unix DataBase Management system. 90 Alternatively, Perl5's SDBM DataBase system. 91------^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 92 Do not care unless you get misconfiguration errors from LaTeX2HTML. 93 94 2. LaTeX commands with equations, figures, tables, etc. 95 As above plus 96 o latex (version 2e recommended but 2.09 acceptable), 97 o dvips (version 5.516 or later) or dvipsk. 98 Version 5.62 or higher enhances the performance of image creation 99 with a *significant* speed-up. See l2conf.pm for this 100 after you are done with the installation. 101 Do not use the 'dvips -E' feature unless you have 5.62, else you 102 will get broken images. 103------^^^^ 104 o gs (Ghostscript version 4.03 or later), 105------------------------------^^^^ 106 with the ppmraw device driver, or even better pnmraw. 107 Upgrade to 5.10 or later if you want to go sure about seldom problems 108 with 4.03 to avoid (yet unclarified). 109 o The netpbm library (ftp://ftp.x.org/R5contrib/). 110 Netpbm 1 March 1994 is recommended. Check with 'pnmcrop -version'. 111 Some of the filters in those libraries are used during the postscript 112 to image conversion. 113 o If you want PNG images, you need pnmtopng (current version is 2.31). 114 It is not part of netpbm and requires libpng (version 0.89c) and 115 libz (1.0.4). pnmtopng supports transparency and interlace mode. 116 Hurray!!! Netscape 4.04 has been reported to grok PNG images! 117------^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 118 That means your PNG option is not longer ahead of its time! 119 Unfortunately Netscape still does not make use of the alpha 120 channel... still not transparency. 121 122 3. Transparent inlined GIFs 123 If you dislike the gray background color of the generated inlined images 124 then the best thing you can do is get the netpbm library (instead of 125 the older pbmplus) OR install the giftrans filter by Andreas Ley 126 <ley@rz.uni-karlsruhe.de>. Version 1.10.2 is known to work without 127 problems but later versions should also be OK. 128 129 LaTeX2HTML also supports the shareware program giftool (by Home Pages, Inc., 130 version 1.0), too. It can also create interlaced GIFs. 131 132Because by default the translator makes use of inlined images in the final 133HTML output, it would be better to have a viewer which supports the <IMG> 134tag, such as NCSA Mosaic. If only a character based browser is available or 135if you want the generated documents to be more portable then the translator 136can be used with the -ascii_mode option. 137 138If ghostscript or netpbm library are not available 139it is still possible to use the translator with the -no_images option. 140 141If you intend to use any of the special features of the translator 142then you have to include the html.sty file in any LaTeX documents that 143use them. 144 145 146Installation 147************ 148 149Please consult the section "Installing LaTeX2HTML" of the online manual at 150 151 http://www-texdev.ics.mq.edu.au/l2h/docs/manual/Snode3.html 152 153Also consult the page at 154 155 http://tug.org/mailman/listinfo/latex2html 156 157for links to special instructions on some platforms. 158 159 160To install LaTeX2HTML please read the file INSTALL. 161 162Troubleshooting 163*************** 164 165Please refer to the FAQ file that came with your distribution. 166 167 168Support and More Information 169**************************** 170 171Announcements, discussion archives, bug reporting forms and 172more are kept at the LaTeX2HTML home at 173http://saftsack.fs.uni-bayreuth.de/~latex2ht/ 174or 175http://cbl.leeds.ac.uk/nikos/tex2html/doc/latex2html/latex2html.html. 176 177*** this site has not been updated since November 1996. 178Many of the links are still valid, leading to useful information. 179 180 181A LaTeX2HTML mailing list had been set up at the Argonne National Labs 182(thanks to Ian Foster <itf@mcs.anl.gov> and Bob Olson <olson@mcs.anl.gov>). 183 184*** This list is no longer functional; it has now been taken over by the 185 TeX User Group (TUG). Thank you Argonne, for the 5+ years of support. 186 187To join the list, visit the web-page at: 188 189 http://tug.org/mailman/listinfo/latex2html 190 191and follow the instructions found there. 192 193If this is not possible for some reason, then send a message to: 194 latex2html-request@tug.org 195with the contents 196 subscribe 197 198 199To be removed from the list follow the instructions at: 200 201 http://tug.org/mailman/listinfo/latex2html 202 203If this is not possible for some reason, then send a message to: 204 latex2html-request@tug.org 205with the contents 206 unsubscribe 207 208 209An archive of the mailing list, from 1999 onwards, 210can be browsed at: 211 212 http://tug.org/pipermail/latex2html/ 213 214This mailing list also has a searchable online archive, 215from 1994 up until 2003-08, at 216 217 http://www.xray.mpe.mpg.de/mailing-lists/latex2html/ 218 219 220Enjoy! 221 222 223Original Author: 224 Nikos Drakos <nikos@cbl.leeds.ac.uk> 225 Computer Based Learning Unit 226 University of Leeds. 227 228Most Recent Author: 229 Ross Moore <ross@maths.mq.edu.au> 230 Mathematics Department 231 Macquarie University, Sydney. 232 233Former Authors: 234 Marek Rouchal <marek@saftsack.fs.uni-bayreuth.de> 235 Infineon Technologies AG 236 Munich, Germany 237 238 Jens Lippmann <lippmann@rbg.informatik.tu-darmstadt.de> 239 Technische Universit"at Darmstadt. 240 241