Home

The LATEX2HTML Translator

1. 75 BOTTOM NAVIGATION when set a navigation panel is placed at the bottom of every HTML page unless overridden by NO_NAVIGATION being set also 70 CHARSET specifies the character set used within the HTML pages currently this defaults to iso 8859 1 ISO Latin 1 oo olan Band wedr eens od ii 2en45843 esas 74 CHILDLINE has piece of HTML code to be inserted between the child links table and page CONCEDES 4 2 844 2854 4 AAA PAG ORE PEG RRA Owe La ade a ee eed 75 CONTENTS when navigation panels are created this holds a hyperlink to the HTML file that has the Table of Contents 0 0 00 00 000 cece ee eee 79 CONTENTS_IN_NAVIGATION when set an iconic link to the Table of Contents is placed in Navigation panels wi ccna eee ad ee PNR ORE bee Eee Oe ee 70 CRAYOLAFILE when color perl has been loaded holds the name of the file which con tains named color specifications for crayon colors 1 2 0 0 000 eee eee 74 CUSTOM_BUTTONS variable available to link to customised buttons in navigation panels 80 CUSTOM_TITLES when set a customised subroutine is used to determine the filename for each HIML page 4 gens hae kiaiii a HEME awe RAY eo Ee ee Cees 63 DEBUG when non zero JATRX2HTML shows messages that would otherwise be ignored 71 DESTDIR specifies the directory into which all the generated files will be placed 63 DISCARD_PS when set specifies that the temporary PostScript files created by dvips be discarded imm
2. split lt num gt Same as setting MAX_SPLIT_DEPTH lt num gt default is 8 Stop splitting sections into separate files at this depth Specifying split 0 will put the entire document into a single HTML file See below for the different levels of sectioning Also see the next item for how to set a relative depth for splitting split lt num gt Same as setting MAX_SPLIT_DEPTH lt num gt default is 8 The level at which to stop splitting sections is calculated relative to the shallowest level of sectioning that occurs within the document For example if the document contains section commands but no part or chapter commands then split 1 will cause splitting at each section but not at any deeper level whereas split 2 or split 3 also split down to subsection and subsubsection commands respectively Specifying split 0 puts the entire document into a single HTML file link lt num gt Same as setting MAX_LINK_ DEPTH lt num gt default is 4 For each node create links to child nodes down to this much deeper than the node s sectioning level Specifying link 0 will show no links to child nodes from that page link 1 will show only the immediate descendents etc A value at least as big as that of the split lt num gt depth will produce a mini table of contents when not empty on each page for the tree structure rooted at that node When the
3. per eval exec perl S 0 0 if running_under_some_shell1 2 Copy the files to the destination directory Copy the contents of the texinputs directory to a place where they will be found by FTRX or set up your TEXINPUTS variable to point to that directory 3 Run install test This Per script will make some changes in the latex2html1 file and then check whether the path names to any external utilities required by latex2htm1 are correct It will not actually install the external utilities install test asks you whether to configure for GIF or PNG image generation Finally it creates the file local pm which houses pathnames for the external utilities determined earlier You might need to make install test executable before using it Use chmod x install test to do this You may also need to make the files pstogif texexpand configure pstoimg and latex2htm1 executable if install test fails to do it for you 4 If you like so copy or move the latex2htm1 executable script to some location outside the LATEX2HTMLDIR directory 5 You might want to edit latex2html config to reflect your needs Read the instruc tions about ICONSERVER carefully to make sure your HTML documents will be displayed right via the Web server While you re at it you may want to change some of the default options in this file If you do a system installation for many users only cope with general aspects let the user override these with HOME late
4. Developments late 1996 to mid 1997 During the latter part of 1996 there was much work on improving the capabilities of IATRX2HTML Some of this was due to the World Wide Web Consortium s proposals for HTML 3 2 becoming a formal recommendation in November 1996 and their subsequent ac ceptance in January 1997 Existing TFX markup for effects such as centering left or right justification of paragraphs flow of text around images table layout with formal cap tions etc could now be given a safe translation into HTML 3 2 compliant with a standard that would guarantee that browsers would be available to view such effects At the same time developers were exploring ways to enhance the overall performance of ATRX2HTML As a result the current v97 1 release has significant improvements in the following areas image generation is much faster requires less memory and inline images are aligned more accurately image quality is greatly improved by the use of anti aliasing effects for on screen clarity in particular with mathematics text and line drawings memory requirements are much reduced particularly with image generation mathematics can now be handled using a separate parsing procedure images of sub parts of expressions can be created rather than using a single image for the whole formula macro definitions having a more complicated structure than previously allowed can now be successfully expanded counters and numbering ar
5. blurred printing 69 comparison 19 in figures 69 in math and text 69 override defaults 23 requires Ghostscript 4 03 20 turned off 69 arbitrary environments 2 26 Arena math mark up 15 Arseneau Donald iii ascii mode 68 auxiliary file 62 which to read 66 B babel package 29 backdrop tiled with an image 3 Abegin latexonly 46 Belinfante Axel ii bibliography 3 49 50 62 bibliographic database 49 example using URLs 49 Harvard style 49 100 natbib package 49 string commands 49 string commands 49 using bib file 49 bodytext 53 no checking for valid attributes 54 Bohnet Achim vii Braams Johannes iii browser NCSA Mosaic 9 Netscape Navigator 9 Arena 15 character based 3 9 68 lynx 9 NCSA Mosaic 61 Netscape Navigator 61 supports images 9 browser 61 supports images 3 bugs 81 bug reports 13 C Cailliau Robert ii Carroll Eric ii CERN ii Arena 15 image map server 11 55 Michel Goossens iii change bars iii 31 different versions 31 changebar package 29 character tilde in URLs 41 character set 74 dtd isolanguage 67 ISO 10646 Unicode 3 14 ISO 8879 ISO Latin 1 3 14 iso_8859_1 74 character set 3 chemical markup CML ix chemsym package 29 child links table 64 at bottom of page 64 at top of page 64 tableofchildlinks 64 citations harvard package 29 Harvard style 49 handled by natbib 49 natbib package 30 49
6. 85 PBMMAKE contains the command to call the pbmmake utility used by pstoimg 76 PBMPLUSDIR when set contains where to find the pbmplus graphics utilities no longer meeded sgire Yan ghee ee Cag Gee oe Ree ees Be ee aes ee 76 PK_GENERATION when set automatic font generation is enabled for low res bitmapped fonts not needed with anti aliasing of hi res bitmaps or PostScript outlines 11 66 73 PNMCAT contains the command to call the pnmcat utility used by pstoimg 76 PNMCROP contains the command to call the pnmcrop utility used by pstoimg 76 PNMFILE contains the command to call the pnmfile utility used by pstoimg 76 PNMFLIP contains the command to call the pnmflip utility used by pstoimg 76 PPMQUANT contains the command to call the ppmquant utility used by pstoimg 76 PPMTOGIF contains the command to call the ppmtogif utility used by pstoimg 76 PREFIX contains the filename prefix to prepend to all HTML image and data files created for the current document osceda a trecea a i a cee ee ee 63 64 PREVIOUS when navigation panels are created this holds a hyperlink to the previous HIME POGOe Sc hag Woche RG a aay oad ante aie ele ails aba ahe ala Selo ed aca Ge Be ah 79 PREVIOUS_GROUP when navigation panels are created this holds a hyperlink to the HTML page starting the previous section at the same level or shallower 79 PREVIOUS_GROUP_TITLE when navigation panels are created this h
7. Do not use the dvips E feature unless you have 5 62 else you will get broken images gs Ghostscript version 4 03 or later with the ppmraw device driver or even better pnmraw Upgrade to 5 10 or later if you want to go sure about seldom problems with 4 03 to avoid yet unclarified The netpbm library of graphics utilities netpbm dated 1 March 1994 is required else part of the image creation process will fail Check with pnmcrop version Several of the filters in those libraries are used during the PostScript to GIF conversion If you want PNG images you need pnmtopng current version is 2 31 It is not part of netpbm and requires libpng 0 89c tar gz and libz 1 0 4 or later versions pnmtopng supports transparency and interlace mode Hooray Netscape Navigator v4 04 has been reported to grok PNG images This means that the PNG option is no longer ahead of its time 3 Segmentation of large documents If you wish to use this feature you will have to upgrade your ATRX to ATRX 2e Some other hyperlinking features also require ATEX 2e 4 Transparent inlined images 0 If you dislike the white background color of the generated inlined images then you should get either the netpbm library instead of the older pbmplus or install the giftrans filter by Andreas Ley ley rz uni karlsruhe de ATRX2HTML now sup ports the shareware program giftool by Home Pages Inc version 1 0 too It can also create inter
8. PNMCAT usr local bin pnmcat PPMQUANT usr local bin ppmquant PNMFLIP usr local bin pnmflip PPMTOGIF usr local bin ppmtogif HOWTO_TRANSPARENT GIF netpbm GS_DEVICE pnmraw GS usr local bin gs PNMFILE usr local bin pnmfile HOWTO_INTERLACE_GIF netpbm PBMMAKE usr local bin pbmmake PNMCROP gt usr local bin pnmcrop TMP usr var tmp The following variables are no longer needed having been replaced by the more specific information obtained using the Perl script configure pstoimg USENETPBM 1 PBMPLUSDIR usr local bin 76 5 3 Extending the Translator In Section 3 7 is was seen how the capabilities of XTRX2HTML can be extended to cope with ATFX commands defined in packages and style files This is in addition to defining simple macros and environments using newcommand and newenvironment The problem however is that writing such extensions for packages requires an understanding of Perl programming and of the way the processing in ATRX2HTML is organised The default behaviour for unrecognised commands is for their arguments to remain in the HTML text whereas the commands themselves are passed on to ATX in an attempt to generate an image This is far from ideal for it is quite likely to lead to an error in ATRX due to not having appropriate arguments for the command Currently t
9. This error should no longer occur with v97 1 Please report it on the mailing list if it does e More likely is that some inappropriate ATFX code has caused an error resulting in an extra page or pages being generated Examine the images 1log file to see if it reports any 4TRX errors e A much rarer reason is that by default the dvips program reverses the PostScript pages it generates If your dvips program behaves in this way try changing the line DVIPS dvips to DVIPS dvips r0 within the file latex2html config e Yet another reason for images appearing out of place especially while developing a document is that the browser s image cache is providing out of date versions rather than getting the latest version afresh When this occurs there will often 85 be images stretched or shrunk to fit the wrong sized imaging area this symptom is browser dependent Flushing the cache then reloading the HTML document should clear up the problem Unacceptable quality of converted images Try changing the size of the image see Section 3 4 The bibliographic references are missing Run latex and then bibtex on the origi nal source file in order to generate a bb1 file IATBX2HTML may need the bb1 file in order to generate the references The labels of figures tables or equations are wrong This can happen if you have used any figures tables equations or any counters inside conditional text i e in a latexonly or a
10. by applying emph to the text of the generated hyperlink lt style gt where lt style gt is the name of ATEX style changing command without the initial V e g emph textbf textit etc The corresponding ATFX command is applied to the text of the generated hyperlink blank lines and alphabetization Having precisely a single space character after the e g index A places a blank line before the index entry and omits the hyperlink This is used mainly for visual formatting it allows a break before the entries starting with each letter say Using a printable key as in index Q Q R is appropriate when there are no indexed words starting with Q say quoted delimiters The three special delimiters can be used within the printable por tion if preceded by the double quote character and also for the quote character itself Also produces an umlaut accent on the following character when appropriate else is ignored Furthermore the printable part of an index entry can contain HTML anchors that is hyper links and or label s This allows index entries to contain cross links to other entries for example as well as allowing index entries to be the target of hyperlinks from elsewhere within the document The next section describes how this feature is used within this manual to create a Glos sary containing a short description of all filenames configuration variables and applicat
11. e FATRX2HTML is actively supported by the international TEX Users Group TUG All users are encouraged to join TUG to keep up to date with the latest development in TEX ATRX ATRX2HTML and related programs Consult the TUG Web pages at http www tug org 2 2 Getting Support and More Information A ATRX2HTML mailing list is managed by the international T X User Group TUG This mailing used was originally established at the Argonne National Labs where it was based for several years Thanks to Ian Foster and Bob Olson and others Since February 1999 it has been run by TUG thanks to Art Ogawa and Ross Moore To join send a message to latex2html request tug org with the contents subscribe To be removed from the list send a message to latex2html request tug org with the contents unsubscribe The mailing list also has a searchable online archive It is recommended to start with this to become familiar with the topics actually discussed and to search for articles related to your own interests An older archive may still be accessible but is no longer actively maintained Enjoy 32http www rosat mpe garching mpg de mailing lists LaTeX2HTML 33nttp cbl leeds ac uk nikos tex2html doc mail mail html 13 3 Environments and Special Features This section describes major features available for processing documents using HTRX2HTML Firstly the means whereby ATEX2HTML can be configured to produce output fo
12. lt IMG gt of HEIGHT and WIDTH indicating the unscaled size A browser is supposed to display the image at the requested size by scaling the actual image to fit effectively imposing its own anti aliasing Some examples of this effect are show later in Section 3 4 3 This effect can be applied to all images in a document by setting the EXTRA_IMAGE_SCALE variable However it may be desirable to also turn off anti aliasing as these effects serve similar purposes but need not work well to gether Furthermore different browsers may give results of different quality It may be necessary to experiment a little in order to find the combination that works best at your site height lt dimen gt and width lt dimen gt are used to specify exactly the size to be occupied by the image on the HTML page The value s given this way overrides the natural size of the image and forces the browser to shrink or stretch the image to fit the specified size The lt dimen gt can be given as either i a number of points or ii with any of the units of cm mm in pt or iii fraction of hsize or textwidth to become a percentage of the browser window s width or of vsize or textheight for a percentage height Note images whose sizes are modified in this way may not be acceptable for image recycling see page 3 4 2 Instead they may need to be generated afresh on each run of ATEX2HTML through the same source document In order to be e
13. on the spot or a stop fix restart AT X2HTML does not stop when it detects an error in TEX syntax Useful messages are given concerning missing or unmatched braces but other apparent anomalies generate only warning messages which are saved to the end Some warnings are also shown imme diately when the VERBOSITY variable is set to at least 3 In practice it can be much quicker to test for invalid syntax using ATEX before attempting to use the MTRX2HTML translator Furthermore ATEX warns of cross reference labels that have not been defined This is useful to help avoid having hyperlinks which point to nowhere The case of missing braces or an unmatched opening brace is an error that ETEX2HTML actually handles better than ATX or rather the underlying TREX pro cessor Whereas TEX only detects an error when something else goes wrong later in the processing ATRX2HTML shows where the unmatched brace itself occurs auxiliary file Some information that ATFX2HTML might need is normally read from the aux file for the document being processed or perhaps from the aux file of a different document of which the current document is just a portion Clearly a valid TFX run is required to produce the aux file Of course if no information in the aux file is actually used then this T X run can be neglected Also if the aux file has already been created and edits are made on the source which do not alter the information stored within
14. version V97 1 it is possible to use this command to insert extra section headings for use in the HTML version only htmlnohead When placed at the top of the preamble of a document segment the htmlnohead command discards everything from the current page that has been placed already Usually this will be just the section head from the htmlhead command in the ptr file Numbering and color information is unaffected This allows an alter native heading to be specified or no heading at all in special circumstances e g the page contains a single large table with a caption 57 segmentcolor lt model gt lt color gt This command is generated automatically by a segment command It is not normally placed in the document at all instead it facilitates information being passed from parent to child via the lt file gt ptr file It specifies to ATR X2HTML that text in the document should have the color lt color gt segmentpagecolor lt model gt lt color gt This command is generated automatically by a segment command It is not normally placed in the document at all instead it facilitates information being passed from parent to child via the lt file gt ptr file It specifies to ATFX2HTML that the background of in the document should have the color lt color gt The use of the segmenting commands is best illustrated by the example below You might want to check your segmented document for consistency using the unsegment command l
15. versions 2 0 3 2 and 4 0 are available and also 2 1 2 2 3 0 and 3 1 for hoistorical reasons The extensions i18n tables math correspond roughly to what used to be called versions 2 1 2 2 3 1 respectively in releases of JATRX2HTML up to 1996 Now these extensions can be loaded with any of 2 0 3 2 or 4 0 as the specified standard The default version is usually set to be 3 2 within latex2html config 65 no_tex_defs Same as setting TEXDEFS 0 default is 1 When TEXDEFS is set default the file texdefs perl will be read This provides code to allow common TFX commands like def newbox newdimen and others to be recognised especially within the document preamble In the case of def the definition may even be fully interpreted but this requires the pattern matching to be not too complicated If TEXDEFS is 0 or empty then texdefs per1 will not be loaded the translator will make no attempt to interpret any raw TREX commands This feature is intended to enable sophisticated authors the ability to insert arbitrary TEX commands in environ ments that are destined to be processed by JATRX anyway e g figures pictures etc However this should rarely be needed as now there is better support for these types of environment There are now other methods to specify which chunks of code are to be passed to JATRX for explicit image generation see the discussion o
16. 2 provides the full capabilities of this model Note that current browsers may not correctly interpret all the features of tables constructed using this extension Tables will be constructed perhaps with some cells mis aligned or without the desired merging of adjacent cells etc This feature was already available in many HTML browsers including Netscape Navigator V1 2 so should be still available with later versions of these browsers 3 0 This version of HTML was never accepted to become a recognised standard perhaps because some of its models were too advanced at the time notably the HTML Math and the Table Model The proposed HTML 3 0 standard was withdrawn and re drafted to create the HTML 3 2 standard which is in current use Standard textual formatting features including centering flush right flush left and underlining are among the features retained math HTML3 model This extension formerly referred to as HTML version 3 1 adds support for the HTML Math model originally part of the proposed HTML 3 0 stan dard see above The only available browser which can display this mark up is Arena Originally developed by the World Wide Web Consortium as a test bed browser it is no longer supported by them There has been a recent proposal for a Mathematical Markup Language MathML from the W3C Math Working Group This would suggest that the HTML Math model is unlikely ever to be adopted better things being expected in t
17. 32 33 81 alphabetization 32 blank lines 32 codified links 33 67 for easier browsing 33 top most node 33 cross link 32 33 cross link incorrect 33 cumbersome 33 57 data from other segments 57 emph 32 hierarchical 32 integrated with Glossary 33 labelled entries 32 33 page ranges 32 quoted delimiters 32 section names 32 33 see 32 short prefixes preferred 57 lt style gt 32 styled entries 32 with lt prefiz gt 33 initialisation init_file 67 initialisation file specified 67 initialization file incompatible with early versions 11 per directory 11 per user 11 install 6 installation 9 change configuration 10 change defaults 10 check path names 10 create manual 12 environment variable 10 filename prefix 11 fonts path variable 11 graphics utilities 10 icons subdirectory 11 initialization files 11 input path variable 10 LaTeX packages 10 local icons 11 makemap script 11 system installation 10 without Perl shell scripts 10 installation variables checked by install test 72 inserted by install test 72 internal 57 internals labels from other segments 57 105 Isani Sidik iii ISO 10646 see character set bidirectional languages 14 Unicode 14 ISO 8859 1 no longer used 14 ISO 8879 see character set ISO Latin 1 see character set J justify package 29 L labels external 51 internal 51 symbolic 50 languages 15 dtd isolanguage 67 english 15 fi
18. 38 Internet services 3 multi media resources 3 news sound video 3 I i18n 65 icons ix alternative set 67 copied to local directory 66 customised images 67 image backdrop 3 image conversion PostScript to GIF 9 PostScript to PNG 9 image files not recycled 68 not reused 69 recycled 68 reuse option 68 shared by default 68 image generation using htmlimage 19 image map CERN server 55 example 55 map file 55 NCSA server 55 user map file 55 image reuse interactive 68 69 104 images alignment 22 anti alias 23 anti aliasing 69 attributes for the lt IMG gt tag 41 client side image map 22 disabled 68 discard PostScript files 68 display scale factor 21 embedded image 24 equations 8 external 22 extra scaling 22 23 figure scale factor 21 figures 8 21 flip option 22 generated off line 68 hypertext link 22 image map 22 image maps 25 55 56 improved print quality 22 inlined by default 22 latex dump 69 links to PostScript 68 math scale factor 21 no anti aliasing 69 options 22 order insensitive 25 order sensitive 25 recycling 25 scale 22 scale factor default 1 6 21 server side image map 22 sharing 25 small images 21 25 specified width or height 23 strange accents 74 tables 3 8 thumbnail 22 25 transparent 9 23 via hypertext links 68 white background 69 images equations 3 images 21 imagesonly environment 47 index 3
19. Ae d wee eRe eee ee i PNG Portable Network Graphics format devised as an alternative to GIF with extra capabilities 2 cgedcahgedia ae heat lard he Ms Goole SD age oh wd ese aoa ee v 10 98 pnmcat Unix graphics utility which concatenates several bitmapped graphics to produce a single bitmapped graphic 2 0 0 nee eee 92 pnmcrop Unix graphics utility which crops whole rows and or columns of a single color from specified edges of a bitmapped graphic 20 5 8 9 92 pumfile Unix graphics utility which reads a graphic in one of a large range of formats creating a bitmap suitable for input to other utilities 92 pnmflip Unix graphics utility which rotates and reflects through multiples of 90 22 92 pnmtopng Unix graphics utility which converts to PNG format 000 9 PostScript graphics programming language used in printers interpreted by Ghostscript bai ian ii 9 11 12 21 62 66 68 69 73 83 85 89 92 93 95 98 104 ppmquant Unix graphics utility used to limit the number of distinct colours in a single IMAGE dee A OG hd Eo ea BONE ee AN ah a Rk ane 9 92 ppmtogif Unix graphics utility used to convert a bitmapped graphic in ppm format into GIF formats oo 5 4 eka hee oe hid wee hae eee a ee Re ed 92 problems tex input file for the ATfX2HTML manual contains a description of known problems with JATRX2HTML and how best to avoid or deal with them 12 psfiles sub directory of do
20. and ATEX Graphics Companion e g Xy pic htmlcite Analogous to htmlref is the htmlcite command which creates a textual hyperlink to a place on the document s bibliography page but without displaying any ref erence marker in the ATEX typeset version See above for an example The externalcite command described on page 51 provides a similar facility when the bibliography page is external that is not part of the current document 4 7 Symbolic References between Living Documents The method of the previous section to generated symbolic hyperized links can easily be extended to external documents processed by ATRX2HTML When TRX2HTML processes a document it generates a Perl file named lt prefix gt labels pl which contains a list of all the symbolic labels that were defined along with their locations The lt prefiz gt is empty unless otherwise specified to allow different document segments to share the same directory externallabels Links to an external document are then possible once a connection is established to that document s labels pl file This connection is established by the externallabels command externallabels lt URL to directory of external document gt lt local copy of external document labels pl file gt The first argument to externallabels should be a URL to the directory containing the external document The second argument should be the full path name to the labels pl file belonging to the e
21. be replaced by customised versions provided this information is correctly updated and the location of the customised images specified as the value of ICONSERVER When the local_icons switch is used so that a copy of the icons is placed with the HTML files and other generated images the value of ICONSERVER is not needed within the HTML files themselves However it is needed to find the original icons to be copied to the local directory NAV_BORDER lt num gt The value given here results in a border measured in points around each icon A value of 0 is common to maintain strict alignment of inac tive and active buttons in the control panels LINKNAME index EXTN This is used when the NO_AUTO_LINK variable is empty to allow a URL to the working directory to be sufficient to reach the main page of the completed document It specifies the name of the HTML file which will be automatically linked to the directory name The value of EXTN is html unless SHORTEXTN is set in which case it is htm LINKPOINT FILE EXTN This specifies the name of the HTML file to be duplicated or symbolically linked with the name specified in LINKNAME At the appropriate time the value of FILE is the document name which usually coincides with the name of the working directory CHARSET iso_8859_1 This specifies the character set used within the HTML pages produced by ATEX2HTML If no value is set in a config
22. captions and alignment of rows and columns variable sizes and colors for text and color or patterns for the background as well as images server side image maps interactive forms and the minimal typographic elements bold italic and teletype that were supported already in HTML version 2 0 Furthermore HTML version 3 2 adheres to the ISO Latin 1 ISO 8879 character set Note Although many people still use old browsers that implement only features available with HTML 2 0 this is not a good reason to limit translation of documents to using only these effects Most of the translation done by ATRX2HTML will still give acceptable results on older browsers The deficiencies due to lack of super subscripts tables and some alignment effects should eventually convince such users to overcome the inertia and update their browsers to later versions that correctly support these effects Sometimes it is known that the audience for which a specific document is intended has limited browser capabilities Or perhaps special extended capabilities are known to be available The ATFX2HTML translation may be customised to suit the available functionality Other HTML versions and extensions supported by JATRX2HTML are described below See the description of the html_version command line option switch on page 65 Version 2 0 This provides only the functionality of the HTML 2 0 standard There is little provision for aligning headings paragraphs o
23. changes and the date of those changes e Any work distributed or published that in whole or in part contains or is a derivative of this software or any part thereof is subject to the terms of this agreement The aggregation of another unrelated program with this software or its derivative on a volume of storage or distribution medium does not bring the other program under the scope of these terms This software is made available as is and is distributed without warranty of any kind either expressed or implied In no event will the author s or their institutions be liable to you for damages including lost profits lost monies or other special incidental or consequential damages arising out of or in connection with the use or inability to use including but not limited to loss of data or data being rendered inaccurate or losses sustained by third parties or a failure of the program to operate as documented the program even if you have been advised of the possibility of such damages or for any claim by any other party whether in an action of contract negligence or other tortuous action The ATRX2HTML translator is written by Nikos Drakos Computer Based Learning Unit University of Leeds Leeds LS2 9JT Copyright 1993 1997 All rights reserved The v97 1 v98 1 v98 2 and v99 1 revisions of the ATRX2HTML translator and this manual were prepared by Ross Moore Mathematics Department Macquarie University Sydney 2109 Australia Copyrig
24. configuration file 12hglo ist is included along with this manual It contains a portion that inserts tricky T X code at the beginning of manual gls This code ex tracts from 12hfiles dat that line corresponding to each glossary entry then typesets it itemized within an environment called theglossary newenvironment theglossary begin list setlength labelwidth 20pt setlength leftmargin labelwidth setlength itemindent labelwidth setlength itemsep 0pt setlength parsep Opt rmfamily end list Currently searching within 12hfiles dat is only done sequentially stopping at the end of the file If an entry is not found then it is skipped and a message printed to the log the next entry will search from the top of the file If all entries are included and maintained in strict order there will be no skipping and each line of 12hfiles dat is read exactly once e Within 12hfiles dat the data lines look like item gn french perl adds Perl code to be compatible with the item gn textsl ftp File Transfer Protocols network item gn german perl adds Perl code to be compatible with the For the ATEX version the item gn is only used for pattern matching to find the correct data entry All typesetting is controlled from within manual g1s However the HTML version requires the following definition 35 newcommand gn 1 texttt 1 label GGG 1 htmlref III 1 which
25. csep1 phy ornl gov csep html An Overview Of Computational Science Copyright C October 1991 Computational Science Education Project Figure 2 A sample figure showing part of a page generated by JATRX2HTML containing a customised navigation panel from the CSEP project The htmlimage command is also often useful to cancel out the effect of the configuration variable F IGURE_SCALE_FACTOR For example to avoid resizing a color screen snap despite the value of F IGURE_SCALE_FACTOR it is possible to use htmlimage scale 0 87http csep1 phy ornl gov csep html 24 3 4 2 Image Sharing and Recycling It is not hard too see how reasonably sized papers especially scientific articles can require the use of many hundreds of external images For this reason image sharing and recycling is of critical importance In this context sharing refers to the use of one image in more than one place in an article Recycling refers to the use of an image left over from a previous run of ATRX2HTML Without this ability every instance of an image would have to be regenerated each time even the slightest change were made to the document All types of images can be shared These include small images and figures with or without thumbnails and image maps Furthermore most images can also be reused The only exception are those which are order sensitive meaning that their content depends upon their location Examples of order sensi
26. defaults for other users or doc uments processed from other directories dd holds the string to be used in file names to delimit directories it is set internally to unless the variable has already been given a value within latex2html config Note This value cannot be set within a latex2html init initialisation file since its value needs to be known in order to find such a file LATEX2HTMLDIR Read by the install test script from latex2html config its value is inserted into the latex2htm1 Perl script as part of the installation process LATEX2HTMLSTYLES LATEX2HTMLDIR styles Read from the latex2html config file by install test its value is checked to locate the styles directory LATEX2HTMLVERSIONS LATEX2HTMLDIR versions The value of this variable should be set within latex2htm1 config to specify the directory path where the version and extension files can be found ALTERNATIVE_ICONS This may contain the relative directory path to a set of cus tomised icons to be used in conjunction with the local_icons switch 72 TEXEXPAND LATEX2HTMLDIR texexpand Read by the install test Perl script from latex2html config its value is used to locate the texexpand Perl script PSTOIMG LATEX2HTMLDIR pstoimg Read by the install test Perl script from latex2html config its value is used to locate the pstoimg Perl script IMAGE_TYPE lt image type gt Set in latex2html config th
27. described here can be used to change the default behaviour of EXTRX2HTML Alternatively often there is a corresponding environment variable whose value may be set or changed within a latex2html init initialisation file in order to achieve 62 the same result There are so many options that they are listed here in groups according to the nature of the effects they control When a large number of such options are required for the processing of a document it is usual to store the switches and their desired settings within a Makefile for use with the Unix make utility Now a simple command such as make mydocument can initiate a call to latex2htm1 that would otherwise take many lines of typing Indeed it could instigate several such calls to ATRX2HTML or to other programs such as ATFX and BibT X dvips and others The document segmentation feature discussed in Section 4 10 uses this technique extensively 5 2 1 Options controlling Titles File Names and Sectioning t lt top page title gt Same as setting TITLE lt top page title gt Name the document using this title short extn Same as setting SHORTEXTN 1 Use a filename prefix of htm for the produced HTML files This is particularly useful for creating pages to be stored on CD ROM or other media to be used with operating systems that require a 3 character extension long_titles lt num gt Same as setting LONG_TITLES lt num gt Instead of the standard n
28. document preamble Show substitutions of new environments Show the contents of all recognised environments both before and after processing Show the cached encoded information for the image keys allowing two images to be tested for equality 6 Show replacements of new commands accents and wrapped commands 7 Trace the processing of commands in math mode both before and after 8 Trace the processing of all commands both before and after The command line option sets an initial value only During processing the value of VERBOSITY can be set dynamically using the htmltracing command whose argument is the desired value or by using the more general HTMLset command as follows HTMLset VERBOSITY lt num gt 5 2 7 Other Configuration Variables without switches The configuration variables described here do not warrant having a command line switch to assign values Either they represent aspects of ATRX2HTML that are specific to the local site or they govern properties that should apply to all documents rather than something that typically would change for the different documents within a particular sub directory Normally these variables have their value set within the latex2html config file In the following listing the defaults are shown as the lines of Perl code used to establish these values If a different value is required then these can be assigned from a local latex2html init initialisation file without affecting the
29. else like a styled version of the HTML acronym So in version 98 1 the name has been changed to HTMLcode If no other definition of HTML exists then this command will be defined to work the same as HTMLcode An important aspect of this is that any of the lt tag gt lt attribs gt and lt contents gt may be given wholly by expanding a JATRX macro or may contain arbitrary macros perhaps including other HTMLcode commands The contents of Figure 6 was constructed using this feature its ATX source follows The following table has been specified using HTML commands a simple test of bold face using lt B gt 3 stage fast of yaltes using lt I gt a simple test of teletype text using lt TT gt asimple test of underlining using lt U gt Satri H using lt STRIKE gt 3 side lesi or amphacts sive using lt EM gt a simple test of strong style using lt STRONG gt a simple test of code style using lt CODE gt a aie fast of crtetton sivie using lt CITE gt a simple test of definition style using lt DFN gt a simple test of sample style using lt SAMP a simple test of keyboard style using lt KBD gt 32 stile test of yvarraide sizle using lt VAR gt A listing of the different text styles available in HTML 3 2 Figure 6 Example use of macros for raw HTML code newcommand myalign center newcommand mylist UL
30. enable the initial interactive session during which the user is asked whether to reuse the old directory delete its contents or quit antialias Same as setting ANTI_ ALIAS 1 Default is 0 Generated images of figure environments and external PostScript files should use anti aliasing By default anti aliasing is not used with these images since this may interfere with the contents of the images themselves antialias_text Same as setting ANTILALIAS_TEXT 1 Default is 1 Generated images of typeset material such as text mathematical formulas tables and the content of makeimage environments should use anti aliasing effects The default is normally to use anti aliasing for text since the resulting images are much clearer on screen However the default may have been changed locally no_antialias Same as setting ANTI_ALIAS 0 Default is 0 Generated images of figure environments and external PostScript files should not use anti aliasing with images though the local default may have been changed to use it no_antialias_text Same as setting ANTI_LALIAS_TEXT 0 Default is 1 Generated images of typeset material should not use anti aliasing effects Although on screen images of text are definitely improved using anti aliasing printed images can be badly blurred even at 300dpi Higher resolution printers do a much better job with the resulting grey scale images white Same as setting WHITE BACKGROUND 1
31. for translating IndicTRX documents see README file docs subdirectory containing the files needed to create a version of this manual styles subdirectory containing Perl code for handling some style files tests contains some test documents for ATRX2HTML 27Initially written by Robert S Thau completely rewritten by Marek Rouchal and Jens Lippmann 2 1 1 Requirements The translator makes use of several utilities all of which are freely available on most plat forms You may use Archie or other Web searching tools such as FTP search to find the source code of any utilities you might need For the best use of ATRX2HTML you want to get the latest versions of all the utilities that it uses It will still work with earlier versions but some special effects may not be possible The specific requirements are discussed below e Perl version 5 002 or later check with perl v Perl should be compiled to use the csh or tcsh shell though ATRX2HTML can also work with the bash shell if Perl is recompiled to use it as full csh Don t worry about this any missing programs should be reported by install test upon installation e DTFX meaning ATEX 2e dated lt 1995 06 01 gt or later e dvips or dvipsk at version 5 58 or later e Ghostscript at version 4 02 or later e netpbm library of graphics utilities version 1 MAR 94 check with pnmcrop version More specific requirements for using EXTRX2HTML depend on th
32. given as an optional parameter see example below The images distributed with ATEX2HTML for this purpose are listed with the description of the htmlitemmark command which provides an alternative means of choosing the item mark and allows the image to be changed for different items in the list The mark is determined by the htmlitemmark lt item mark gt command This com mand accepts either a mnemonic name for the lt item mark gt from a list of icons estab lished at installation or the URL of a mark not in the installation list The command htmlitemmark must be used inside the htmllist environment in order to be effective and it may be used more than once to change the mark within the list The item marks supplied with ATRX2HTML are BlueBall RedBall OrangeBall GreenBall PinkBall PurpleBall WhiteBall and YellowBall The htmllist environment is identical to the description envi ronment in the printed version An example of its usage is beginfhtmllist WhiteBal1 item Item 1 This will have a white ball item Item 2 This will also have a white ball htmlitemmark RedBall item Item 3 This will have a red ball end htmllist This will produce Item 1 This will have a white ball 30 Item 2 This will also have a white ball Item 3 This will have a red ball One can also obtain T EX 2e style files floatfig sty and wrapfig sty which provide support for the floatingfigure and wrapfigure environments
33. heqn sty empty ETRX package to force loading of heqn perl moves equation numbering to the left of images 2 1 2 eee ee 21 HTML Hyper Text Markup Language as used by Web browsers i vii 7 10 html perl adds Perl code to be compatible with html sty TFX package 37 38 52 html sty symbolic link see below to a ATRX package allowing HTML links and conditional COdE rors ede ae caye tga dea tears 1 9 10 12 22 26 37 38 49 52 86 95 htmllist perl contains Perl code to implement the htmllist environment 37 htmllist sty TEX package for the htmllist environment which uses special icons in the HTML WOrSiON 448 4 intai i Gade ard iandr aw bok adh gPhcd A A A a ete a amp 12 30 37 hypextra tex input file for a section of the ATRX2HTML manual describes hypertext extensions esme cave eit eka eee hee Dh EPES a es oe new eet adhe 12 icons gif subdirectory of LATEX2HTMLDIR containing GIF format versions of the de fault icons used for navigation buttons and other purposes T icons png subdirectory of LATEX2HTMLDIR containing PNG format versions of the default icons used for navigation buttons and other purposes 7 icons subdirectory of LATEX2HTMLDIR containing the default GIF icons used for navi gation buttons no longer used from v97 1 onwards 22 0005 11 95 images dvi_ the dvi file created by running A TRX on images tex for creating images of mathematic
34. hm n v 4 Figure 1 Images of equation displays at normal screen resolution These images of the whole environment were created using the htmlimage command to suppress the extended parsing that usually occurs when the math extension is loaded viz begin equation htmlimage no_antialias Phi_ 1 1 m n Bigl Phith frac partial Phi partial x end equation begin eqnarray htmlimage frac Phi_ 1 1 m n 2 Phi_ 1 m n Phi_ 1 1 m n h 2 end eqnarray Further aspects of the options available when generating images are discussed in the next section in particular with regard to the quality of printed images The mbox command Another way to force an image to be created of a mathematical expression when global settings are not such as to do this anyway is via the mbox command having math delimiters within its argument Normally mbox is used to set a piece of ordinary text within a mathematics environment It is not usual to have math delimiters or within the argument of an mbox Whereas earlier versions of ATFX2HTML simply ignored the mbox command treating its argument as normal text the presence of such delimiters now results in an image being generated of the entire contents of the mbox It is not necessary for there to be any actual 20 mathematics inside the mbox s contents e g mbox some text will cause an image to be created of the given text The p
35. it use the command line option switches no_math html_version 3 2 math This is what was used when creating the HTML version of this manual For a more detailed discussion of processing mathematics using this strategy see the online document by the present author entitled Mathematics with ATf X2HTML Examples below show how to generate an image of a whole environment even with these options in force Since the HTML 2 0 standard does not include superscripts and subscripts via the lt SUP gt and lt SUB gt tags the options are more limited In this case creating images of sub expressions is 18 strategy adopted not loaded textual representation where possible else image of whole expressions not loaded no_math always generates an image of the whole expression or environment loaded entities and lt MATH gt tags for HTML Math loaded no math always generates an image of the whole expression or environment Table 3 Mathematics translation strategies for HTML version 2 0 not so attractive since virtually the whole expression would consist of images in all but the simplest of cases Here are some examples of mathematical expressions and environments processed by BETEX2HTML using different strategies They are automatically numbered 1 0 6 1 0 O I m n ee a SW tah a ae Ox Ox 6 r 9 with some gratuitously c nted text in between Pisemna 28
36. know how to do either of these things copy or link html sty to the directory of your TATRX document 86 Nesting of font changing commands is now handled correctly Such problems should no longer occur though it always helps to use explicitly delimited pseudo environments eg bf or EATRX s commands requiring an explicit argument such as textbf Cannot get it to generate inlined images Run TpX2HTML on your document using the debug switch Look in the directory where the HTML files are generated for two files named images tex and images log Examine their contents Do you notice anything unusual in them Copy images tex into the directory of your original TeX file and run latex on images tex Can you see any errors in images log If so can you fix images tex to get rid of the errors After fixing images tex you can put it back in the directory of HTML then run FATRX2HTML on the original document using the images_only switch However if you make changes or additions to the original source then the same problems may occur again Thus it is better to understand why the changes were required and alter your document s source code appropriately If you get into a mess delete all the image files and run ATRX2HTML again Often it is sufficient to just delete the file images p1 If you still get into a mess try running AT fX2HTML with the options no_reuse and no_images e g cblipcay lat
37. most easily done using the local_icons command line switch or by setting LOCAL_ICONS to 1 in latex2html config or within an initialization file as de scribed above Warnings If you cannot do that bear in mind that these icons will have to travel from Livermore California Also note that several more icons were added in V96 1 that were not present in earlier versions of BTEX2HTML To make your own local copy of the ATfX2HTML documentation This will also be a good test of your installation Firstly to obtain the dvi version for printing from within the docs directory it is sufficient to type make manual dvi This initiates the following sequence of commands latex manual tex makeindex s 12hidx ist manual idx makeindex s 12hglo ist o manual gls manual glo latex manual tex latex manual tex in which the two configuration files 12hidx ist and 12hglo ist for the makeindex program are used to create the index and glossary respectively The 2nd run of latex is needed to assimilate references etc and include the index and glossary In case makeindex is not available a copy of its outputs manual ind and manual g1s are included in the docs subdirectory along with manual aux The 3rd run of latex is needed to adjust page numbering for the Index and Glossary within the Table of Contents Next the HTML version is obtained by typing make manual html This initiates a series of calls to MTRX2HTML on the se
38. newcommand myitem 2 HTMLcode disc LI simpletest 1 2 43 newcommand simpletest 2 HTMLcode 1 a simple test of 2 using HTMLcode CODE lt 1 gt newcommand tableopts 10 border 5 newcommand tablelist 4 left HTMLcode 1 DIV HTMLcode tableopts TABLE HTMLcode bottom CAPTION 3 HTMLcode TR HTMLcode TD HTMLcode 2 4 HTMLcode a11 BR tablelist myalign mylist textbf A listing of the different text styles available in HTML 3 2 myitem B bold face myitem I italics myitem TT teletype text myitem U underlining HTMLcode circle LI simpletest STRIKE strikeout myitem EM emphasis style myitem STRONG strong style myitem CODE code style myitem CITE citation style myitem DFN definition style HTMLcode square LI simpletest SAMP sample style HTMLcode square LI simpletest KBD keyboard style myitem VAR variable style The above code demonstrates many aspects of the way HTML commands can be used nesting HTML commands can be nested to arbitrary depth macros Macros can be used to specify all or part of each argument within macros HTMLcode commands work correctly within the expansions of other macros attribute values Information within lt attribs gt can be specified in a very loose way as a comma separated list of key value pairs or as single values Not even
39. nharvard package 30 within external bibliographies 51 class foils 29 class option loads file 28 specific file 28 CML chemical markup ix color colordvi package 29 coloured background 3 coloured text 3 color package 29 columns multicol package 30 comment environment 42 Common ETRX Commands BTEX blue book 3 Companion see The ATFX Companion components specify depth 2 64 Computer Based Learning Unit Ana Maria Paiva ii Andrew Cole ii CBLU ii Jamil Sawar ii Roderick Williams ii Computer Science Education Project CSEP ii Computer Based Learning Unit University of Leeds ii 1 Computer Science Education Project CSEP 24 conditional text 3 47 avoid using counters 47 example 46 HTML or ETRX version 37 scoped variant 45 shorthand notation 46 without scope 46 contents from other segments 57 copyright Leeds x Macquarie x counter automatic 3 dependency 3 cross references see references CTAN 6 current version of ATRX2HTML 71 customised layout 61 D Daly Patrick iii 49 DANTE vi Praesidium vi Darmstadt Fachbereich Informatik vi debugging 71 81 Perl debugger 71 depth child nodes revealed 64 diagnostic information 71 directory delimiter 72 discussion group 13 document illustrative examples 3 segments 56 title 63 document class 28 loads file 28 loads a perl file 28 options 28 document segmentation 62 documentation auxiliaries 12 Changes section 13 dv
40. not the special math extension has been loaded 3 whether the no_math command line option has been specified or equivalently the NO_SIMPLE_MATH variable has been set in an initialisation file The strategies used to translate math expressions are summarised in Table 2 for HTML 3 0 and Table 3 for HTML 2 0 not loaded textual representation where possible faa el else image of whole expressions not loaded no_math always generates an image of the whole PDL prelo environment o o n loaded uses entities and lt MATH gt tags e g for ee i HTML Math or MathML in future loaded no_math textual representation where possible PUM Leer iting ofmabexresiont o Table 2 Mathematics translation strategies for HTML versions 3 0 and 3 2 using lt SUP gt and lt SUB gt tags and lt TABLE gt s Using the no_ math switch is best for having a consistent style used for all mathematical expressions whether inline or in displays The images are of especially good quality when anti aliasing is being used see page 69 provided the browser is set to have a light background colour When set against a gray or dark background these images can become rather faint and hard to read The final strategy in Table 2 using no_math is the preferred method for good quality mathematics with HTML version 3 2 It combines the browser s built in fonts with the best quality images when needed To obtain
41. of FoilT X 28 31 90 french perl adds Perl code to be compatible with the french sty ATRX package 29 french sty TEX package for documents written in French 95 ftp File Transfer Protocols network utility for transferring files 6 FTP search modern Web based search utility 2 2 0 0 0 0 00 0 000005 6 8 GDBM GNU Database Management utility 0 0 02 00 0 00008 8 83 german perl adds Perl code to be compatible with german sty EXTRX package 29 german sty IATEX package for documents written in German 28 91 95 Ghostscript program to render graphics written in the PostScript language or minor variations thereof acesse esasda kiana aaa ia gaia nani eis v x 8 9 20 100 ghostscript Unix command to launch the Ghostscript program 95 giftool utility to make transparent the backgrounds of GIF images or to create inter laced GIF images sopar rotere heed tae eek Pee ee eee oa 9 grep standard Unix utility useful for finding specific strings within groups of files 84 gs commonly used shortening of the ghostscript command 9 11 GS Preview dvi viewer using Ghostscript 0 00 00000 ee eee 11 gs_fonts ps read by Ghostscript to locate the PostScript fonts available on the local SYSTEM en ee a ee ee a 11 heqn perl package adding code to ATPX2HTML for placing equation numbering at the left OLAMAPES ETTE ESA ea Grae ek eth Oa Se Ot wae end hy ae E 95
42. of a multi media resource in the paper version of a document Such a description would be redundant in the electronic version as the user can have direct access to this resource Here is an example of the use of the latexonly environment used on page 41 of this manual begin latexonly begin figure begin center fbox includegraphics width 4in psfiles eform ps end center caption An electronic form Of course in the online version of this document the form above would be active end figure end latexonly 45 Note the warning at the bottom of page 37 concerning how the environment delimiters should be used in the A TRX source code htmlonly endhtmlonly This is an alternative way to specify a chunk of material intended for the HTML version only using the old A S style of delimiting environments Use of this style is discouraged the htmlonly environment is preferred latexonly endlatexonly This is an alternative way to specify a chunk of material intended for the PTEX typeset version only using the old A S style of delimiting en vironments Use of this style is discouraged the latexonly environment or the unscoped Zbegin latexonly construction are preferred Note the warning at the bottom of page 37 concerning how the environment delimiters should be used in the ETRX source code latex html and latexhtml There are also shorthand notations to accomplish the same thing as in the latexonly environment an
43. page has a sectioning level less than the split depth so that the a mini table of contents has links to other HTML pages this table is located at the bottom of the page unless placed elsewhere using the tableofchildlinks command On pages having a sectioning level just less than the split depth the mini table of contents contains links to subsections etc occurring on the same HTML page Now the table is located at the top of this page unless placed elsewhere using the tableofchildlinks command toc_depth lt num gt Same as setting TOC_DEPTH lt num gt default is 4 Sectioning levels down to lt num gt are to be included within the Table of Contents tree toc_stars Same as setting TOC_STARS 1 Sections created using the starred form of sectioning commands are included within the Table of Contents As with ATFX normally such sections are not listed 64 show section_numbers Same as setting SHOW SECTION_NUMBERS 1 Show section numbers By default section numbers are not shown so as to encourage the use of particular sections as stand alone documents unsegment Same as setting UNSEGMENT 1 Treat a segmented document see the section about document segmentation like it were not segmented This will cause the translator to concatenate all segments and process them as a whole You might find this useful to check a segmented document for consistency For all documents the sectioning levels ref
44. the aux file then there is no need for a fresh ATRX run except for the purposes of error checking bibliography Suppose the document requires a bibliography or list of references which is to be prepared using BibTeX ATRX2HTML reads citation information from the aux file and can import the bibliography itself from the bb1 file However these must first be created using ATEX document segmentation With the document segmentation technique discussed fully in Section 4 10 it is vitally important that the full document processes correctly in BETEX The desired effect is that of a single large document whereas the pieces will actually be processed separately To achieve this ATX writes vital information into special ptr files Like the aux file these files are read by ATRX2HTML to get section numbering and other information to be used while processing each segment print quality When a document contains automatically generate images these images are usually bitmaps designed for viewing on screen In general the resolution of these is too poor to give a good result when printed on a high resolution laser printer Thus if it is likely that the reader will want to obtain a printed version of your document then it is best to include a hyperlink to the typeset dvi version or to a PostScript conversion of the dvi file In either case a link to a compressed version is even better 5 2 Command Line Options The command line options
45. the warning at the bottom of page 37 concerning how the environment delimiters should be used in the E TRX source code Warning Be careful when using TFX commands which alter the values of counters e g numbered figures or equations in conditional text because this may cause the counter values in the electronic version to lose synchronisation with the values of the corresponding counters in the ATEX version begin imagesonly This environment is used to put TEX code into the images tex file to be used when generating images Typically this is used to add commands to the preamble of images tex such as setting the text or background color However code can be added at any other point as well e g to change the background color of all images after a certain point in the document Note the warning at the bottom of page 37 concerning how the environment delimiters should be used in the TFX source code begin makeimage This is a special environment which forces an image to be made of its contents That is one gets effectively a snapshot of a portion of a page that has been typeset using BTEX Within the normal ETRX typeset version of the document this environment is completely transparent adding its contents to the page as usual One further important use of the makeimage environment is as follows If a makeimage environment occurs as a sub environment within a figure environment then an image will not be made of the figure s contents
46. 5 http www tex ac uk tex archive support latex2html 6ftp ftp dante de tex archive support latex2html Warning Use the files from this site at your own risk Having obtained a compressed tar version save it into a file latex2htm1 98 1 tar gz say then extract its contents with 4 gzip d latex2html 98 1 tar gz tar xvf latex2html 98 1 tar You should then have the following README file Changes index with latest changes no longer supplied latex2htm1 Perl script texexpand Perl script latex2htm1 config configuration file install test Perl script for installation and testing dot latex2html init sample initialisation file texinputs subdirectory containing various ATFX style files versions subdirectory containing code for specific HTML versions makemap Per script example subdirectory containing the segmentation example described in detail in Section 4 10 dvipsrc file pstoimg Perl script for image conversion replaces pstogif configure pstoimg Perl script for installation local pm Per input file icons gif subdirectory containing icons in GIF format icons png subdirectory containing icons in PNG format makeseg Perl script and examples to handle segmented documents via a generated Makefile see makeseg tex docs foilhtm1 contains TFX package and Perl implementation by Boris Veytsman to support FoilTfX to HTML translation IndicTeX HTML package that contains Perl and E TpX code
47. BTEX and the result is included in the document as one or more inlined images There are very few standard ATRX commands that are not recognised Many common TEX commands are recognised also even though not explicitly mentioned in the ATEX blue book 1 Any aberrant commands should be reported to the IXATRX2HTML mailing list see Section 2 2 Index The translator generates its own index by saving the arguments of the index command The contents of the theindex environment are ignored When using the makeidx package very sophisticated Indexes can be built automatically The Index for this manual is a good example New Definitions New definitions newcommand newenvironment newtheorem and def will not work as expected if they are defined more than once Only the last definition will be used throughout the document Stylistically it is bad to declare new environments or theorems outside of the document preamble so this should not cause any real problems Changes to commands using def or renewcommand should usually be made only locally within special environments to set a needed parameter e g a basic length in a picture environment But when such environments force an image to be generated then BTFX will make the correct redefinition Scope of declarations and environments Ifthe scope of a declaration or environment crosses section boundaries then the output may not be as expected because each section is processed independently T
48. Default is 1 Ensures that images of figure environments have a white background Otherwise trans parency effects may not work correctly no_white Same as setting WHITE BACKGROUND Default is 1 Cancels the requirement that figure environments have a white background ldump Same as setting LATEX_DUMP 1 Default is 0 Use this if you want to speed up image processing during the 2nd and subsequent runs of IATRX2HTML on the same document The translator now produces a ATEX format dump of the preamble to images tex which is used on subsequent runs This significantly reduces the startup time when PTFX reads the images tex file for image generation This process actually consumes additional time on the first run since ATRX is called twice once to create the format dump then again to load and use it The pay off comes with the faster loading on subsequent runs Approximately 1 Meg of disk space is consumed by the dump file 5 2 4 Switches controlling Navigation Panels The following switches govern whether to include one or more navigation panels on each HTML page also which buttons to include within such a panel 69 no_navigation Same as setting NO_NAVIGATION 1 Disable the mechanism for putting navigation links in each page This overrides any settings of the TOP_NAVIGATION BOTTOMNAVIGATION and AUTO_NAVIGATION variables top_navigation Same as setting TOP_NAVIGATION 1 Put navigation links
49. IMAGES_ONLY if set this run simply processes the images tex file generated on an earlier TUM 28s Gas bw Ra ee OG Oba bs bee ae Reb Bae aes 68 IMAGE_TYPE specifies the graphics format for the images that may be generated currently 90 elther gif OF Ps cs ade aw ee OA wee ade Bae ae Na A Cae hie kala 8 73 INDEX when navigation panels are created this holds a hyperlink to the HTML file that hids the Index isas 4 a ee dead Bw HOS PERE Ce hae Rd he ata aad 79 INDEX_IN_NAVIGATION when set an iconic link to the Index is placed in navigation PAMICI Sai tote ce Gases OE E ENT Sens ead ene Mat bags aS 2 tens ae A ak Soe ae dey 70 INFO when set contains Perl code to produce a replacement for the standard About this document information avsies i ossidi eaba eee 53 68 INTERLACE if set this specifies that any generated images should be interlaced 75 LANGUAGE_TITLES contains the titles for chapters sections etc in the chosen language default English 2 22624 ter pipe Daaa ae ee hee ae Ak eae Pao 15 LATEX holds the command to be used to invoke ATEX on the images tex file for type setting the contents of images ssssicsesrrtrrrr ridar eee 73 LATEX2HTMLDIR directory where JATRX2HTML is installed 10 67 72 82 91 94 96 98 99 LATEX2HTMLDIR latex2html config configuration file for the local setup this file is read before any latex2html init files 22 2 ee eee eee 77 79 LATEX2HTMLDIR local pm created by c
50. Instead the contents are treated as normal text each part being handled as if there were no figure at all except that everything is placed within a single cell of a lt TABLE gt lt TABLE gt construction in HTML 3 2 The contents of any caption commands are placed between lt CAPTION gt lt CAPTION gt tags for the lt TABLE gt Normally an image of the entire contents of the figure would be placed within the single cell of the lt TABLE gt Now images are made of any subparts of those figure s contents that really need it in particular the makeimage sub environments An empty makeimage sub environment does not generate an image of itself yet still it inhibits an image being made of the whole figure These comments apply also to table environments 4 5 Symbolic References shown as Hyperized Text In printed documents cross references are shown through a numeric or symbolic indirection e g see Figure 1 numeric indirection or see section Changes symbolic indirection BETEX2HTML can mirror this mechanism using the same numeric or symbolic references or when these are not appropriate by using iconic references In a hypertext document however cross references can be shown without any indirection just by highlighting a relevant piece of text This can make a document more readable as it removes unnecessary information hyperref A single new TFX command hyperref can be used for specifying how a cross referen
51. R set within latex2html config An alternative set of icons can be used by specifying a relative directory path in ALTERNATIVE_ICONS to where the customised images can be found init_file lt file gt Load the specified initialisation file This Perl file will be loaded after loading HOME latex2html init or latex2html init in the local directory if either file exists It is read at the time the switch is processed so the contents of the file may change any of the values of any of the variables that were previously established as well as any default options More than one initialisation file can be read in this way no_fork Same as setting NOFORK 1 When set this disables a feature in the early part of the processing whereby some memory intensive operations are performed by forked child processes Some single task operating systems such as DOS do not support this feature Having NOFORK set then ensures that unnecessary file handles that are needed with the forked processes are not consumed unnecessarily perhaps resulting in a fatal Per error iso_language lt type gt This enables you to specify a different language type than EN to be used in the DTD entries of the HTML document e g EN US short_index Same as setting SHORT_INDEX 1 Creates shorter Index listings using codified links this is fully compatible with the makeidx package no_footnode Same as setting NO FOOTNODE 1 Suppresses us
52. The ETRX2HTML Translator Nikos Drakos Computer Based Learning Unit University of Leeds March 26 1999 Documentation revised and updated for v97 1 and HTML 3 2 and further revisions for V98 1 and later and for HTML 4 0 by Ross Moore Mathematics Department Macquarie University Sydney This document accompanies ISTRX2HTML version 99 1 beta This manual differs from earlier versions by updates to the section Installation and Further Support a few small changes in other sections and a shortening of Known Problems by removing references to old problems that no longer occur Not all of the newer features of JATRX2HTML v99 1 are described yet A fully updated manual is underway and will be released when completed History Nikos Drakos original manuscript was updated for version v96 1 by Herb Swan and converted for ATEX 2e by Michel Goossens Extensive revisions were made by Ross Moore for v96 1 rev f incorporating also suggestions from Michel Goossens Another major revision was required to adequately describe the new features made possible with HTML 3 2 and recent developments in image generation and macro handling This work was done by Ross Moore as were most of the revisions for V98 1 V98 2 and v99 1 Portability for non Unix systems has been achieved due to work done mainly by Marek Rouchal Uli Wortmann Fabrice Popineau and Daniel Taupin Changes for the v98 1 revision are indicated with narrow change
53. The first three forms are equivalent ATRX uses cite lt opt LaTeX gt lt label gt after plac ing the lt LaTeX text gt Note that lt opt LaTeX gt must be specified even if empty Similarly the latter three forms are equivalent with AATRX using nocite lt label gt to force the particular reference to appear on the bibliography page even though no ex plicit marker is placed at this point Thus there is no need for an optional lt opt LaTeXx gt argument Within the HTML version a hyperlink is produced when the lt HTML tezt gt is not empty External label files are also searched in order to match the symbolic lt label gt see also externalcite on page 51 Earlier in this manual the following source code was used commands described in the LaTeX htmlcite blue book lamp latex as well as many other LaTeX constructions such as are described in the LaTeX hypercite emph Companion emph Companion goossens latex and LaTeX hypercite emph Graphics Companion e g Xy pic emph Graphics Companion Xy pich goossens latexGraphics which produces commands described in the ATEX blue book as well as many other AT FX constructions such as are described in the ATEX Companion 2 and ETEX Graphics Companion 3 Xy pic whereas in the HTML version one sees commands described in the A TRX blue book as well as many other ATX constructions such as are described in the ATEX Companion
54. These coordinates can be obtained with the aid of a program such as xv If the user clicks in the first rectangle it will cause a branch to the URL associated with symbolic label label1 defined in the labels p1 file found in directory report The single active region in the flow chart figure is a circle centred at 150 100 and passing through point 200 100 Clicking in this region will cause a branch to symbolic label labe13 Labels label12 and label4 will be visited if the user clicks anywhere outside of the explicit regions If any labels are not defined in any of the labels p1 files mentioned they will be interpreted as URLs without translation The HTML image maps are generated and placed in directory report by invoking the command makemap report map report 4 10 Document Segmentation One of the greatest appeals of the World Wide Web is its high connectivity through hyper links As we have seen the JATRX author can provide these links either manually or sym bolically Manual links are more tedious because a URL must be provided by the author for every link and updated every time the target documents change Symbolic links are more convenient because the translator keeps track of the URLs Earlier releases of ATRX2HTML required the entire document to be processed together if it was to be linked symbolically However it was easy for large documents to overwhelm the memory capacities of moderate sized computers Furthermore proces
55. This is to coax browsers into scaling the usually larger images to fit the desired size when printed a better quality can be obtained Values of 1 5 and 2 give good print quality at 600dpi 79 PAPERSIZE a5 Specifies the size of a page for typesetting figures or displayed math when an image is to be generated This affects the lengths of lines of text within images Since images of text or math ematics should use larger sizes than when printed else clarity is lost at screen reso lutions then a smaller paper size is generally advisable This is especially so if both the MATH_SCALE_FACTOR and DISP_SCALE_FACTOR scaling factors are being used else some images may become excessively large including a lot of blank space LINE_WIDTH 500 Formerly specified the width of an image when the contents were to be right or center justified No longer used The following variables are used to access the utilities required during image generation File and program locations on the local system are established by the configure pstoimg Perl script and stored within LATEX2HTMLDIR local pm as Perl code to be read by pstoimg when required After running the configure pstoimg Perl script it should not be necessary to alter the values obtained Those shown below are what happens on the author s system they are for illustration only and do not represent default values GS_LIB usr local share ghostscript 4 02
56. Use links to external PostScript files rather than inlined images in the chosen graphics format discard Same as setting DISCARD_PS 1 The temporary PostScript files are discarded immediately after they have been used to create the image in the desired graphics format no_images Same as setting NO_IMAGES 1 Do not attempt to produce any inlined images The missing images can be generated off line by restarting ATRX2HTML with the option images_only images_only Same as setting IMAGES_ONLY 1 Try to convert any inlined images that were left over from previous runs of TX 2HTML reuse lt reuse_option gt Same as setting REUSE lt reuse_option gt This switch specifies the extent to which image files are to be shared or recycled There are three valid options 0 Do not ever share or recycle image files This choice also invokes an interactive session prompting the user about what to do about a pre existing HTML directory if it exists 1 Recycle image files from a previous run if they are available but do not share identical images that must be created in this run 68 2 Recycle image files from a previous run and share identical images from this run This is the default Section 3 4 2 provides additional information about image reuse no_reuse Same as setting REUSE 0 Do not share or recycle images generated during previous translations This is equiv alent to reuse 0 This will
57. abel gt hyperref page lt HTML text gt lt LaTeX text gt lt post LaTeX gt lt label gt hyperref noref lt HTML text gt lt LaTeX text gt lt label gt hyperref no lt HTML text gt lt LaTeX text gt lt label gt The first two are the defaults where ATEX uses ref lt label gt With the next two ATpxX uses pageref lt label gt while with the final two TEX completely ignores the lt label gt setting just the lt LaTeX tezt gt For creating hyperlinks to other documents using symbolic reference lt label gt s see also the externalref command described on page 51 The preceding paragraph is an example of the use of the hyperref page option Its source code is For creating hyperlinks to other documents using symbolic reference Meta label s see also the Lc externalref hyperref page command command described on page externref which appears in the HTML version as For creating hyperlinks to other documents using symbolic reference lt label gt s see also the externalref command with the command being an active hyperlink In fact both hyperref and the htmlref command to be described next permit textual hyperlinks based on symbolic lt label gt s from external files 48 htmlref Another command also defined in html sty is htmlref which has the same effect as hyperref during the conversion to HTML It takes two arguments some text and a label In t
58. abel occurred When processed by the translator each ref is replaced by a hypertext link to the place where the corresponding label occurred externalref This mechanism can be extended to external documents externalref lt symbolic label in remote document gt The argument to externalref may be any symbolic label defined in the labels p1 file of any of the external documents Such references to external symbolic labels are then translated into hyper links pointing to the external document externalcite Analogous to externalref the externalcite command is used to create a citation link where the bibliography page is not part of the current document As with externalref symbolic labels for the bibliography page must have been loaded using externallabels A particularly important use for this is in allowing multiple documents to access infor mation in a common bibliographic listing For example all of an author s publications a comprehensive listing of publications in a particular field the perhaps yearly output of publications from a particular organisation or institution Thanks to Uffe Engberg for suggesting this feature 41 Care must be taken to ensure that critical symbolic references are unique across related documents 42 http www brics dk engberg 51 4 7 1 Cross Referencing Example To understand this mechanism better consider how you would maintain a link to this section of the hypertext version of
59. ages tex file when using FoilT X default is article 2 2 eee 31 FOILHEADLEVEL holds the sectioning level for the pages containing FoilTpX foils gener ated using foilhtml sty and foils perl 00 00 0000 31 FOILOPTIONS Options for images tex obtained from processing a FoilT X source by default TOPi 4200005 eo8e KOR rt EOE EE hE eda eee EE 31 FONT_SIZE gives font size used with images of math and other environments 66 GS contains the command to call the Ghostscript program used by pstoimg 76 GS_DEVICE contains the name of the device driver for the Ghostscript program used by PStOIME 2 cc boae thie a taee bed eho ee bias hk Bee od 76 GS_LIB contains the directory path prefix to the Ghostscript program s library of special input ileg 0354284 Gooey aha eek Gok be a ee ee ee be oe eek ees 76 HOME latex2html init user s default initialisation file for ATfX2HTML if present it will be read unless another has already been found 11 67 77 79 82 HOWTO_INTERLACE_GIF contains the name of the graphics utility package to use for cre ating interlaced GIF images 2 0 0 00 e eee eee 76 HOWTO_TRANSPARENT_GIF contains the name of the graphics utility package to use for creating transparent GIF images 0 ee eee 76 HTML_VERSION specifies the version of HTML code to be generated 65 ICONSERVER contains the URL where icon images are to be found 10 11 74
60. ames node1l html node2 html the filenames for each HTML page are constructed from the first lt num gt words of the section heading for that page separated by the character Commas and common short words a an to by of and for the are omitted from both title and word count Warning Use this switch with great caution Currently there are no checks for uniqueness of names or overall length Very long names can easily result from using this feature custom titles Same as setting CUSTOM_TITLES 1 Instead of the standard names nodel html node2 html1 the filenames for each HTML page are constructed using a Perl subroutine named custom_title_hook The user may define his her own version of this subroutine within a latex2html init file say to override the default which uses the standard names This subroutine takes the section heading as a parameter and must return the required name or the empty string default dir lt output directory gt Same as setting DESTDIR lt output directory gt Redirect the output to the specified directory The default behaviour is to create or reuse a directory having the same name as the prefix of the document being processed no subdir Same as setting NO_SUBDIR 1 Place the generated HTML files into the current directory This overrides any DESTDIR setting prefix lt filename prefixz gt Same as setting PREFIX lt filename prefiz gt The lt filename
61. an alternative language can be expected to change the value of this variable See also the TITLES_LANGUAGE variable described next TITLES_LANGUAGE english This variable is used to specify the actual strings used for standard document sections such as Contents References Table of Con tents etc Support for French and German titles is available in corresponding pack ages Loading such a package will normally alter the value of this variable as well as the default_language variable described above WORDS_IN_NAVIGATION_PANEL_TITLES 4 Specifies how many words to use from section titles within the textual hyperlinks which accompany the navigation buttons WORDS_IN_ PAGE 450 Specifies the minimum page length required before a navigation panel is placed at the bottom of a page when the AUTO_NAVIGATION variable is set CHILDLINE lt BR gt lt HR gt n This gives the HTML code to be placed between the child links table and the ordinary contents of the page on which it occurs NETSCAPE_HTML 0 When set this variable specifies that HTML code may be present which does not conform to any official standard This restricts the contents of any lt DOCTYPE gt tag which may be placed at the beginning of the HTML pages produced BODYTEXT The value of this variable is used within the lt BODY gt tag e g to set text and or background colors It s value is overridden by the bodytext com
62. and Options In general the standard TeX document classes article report book letter slides are translated by JATRX2HTML in the same way Currently the only real difference is with the display of section numbering when the show_section_numbers switch is used and when numbering of theorem like environments is linked to section numbering These differences are achieved using a mechanism that automatically loads a file article perl report perl book perl letter perl slides perl according to the re quested document class These files contain Perl code and are located in the styles directory If a file of the same name exists in the working directory this will be loaded instead Typically such files lt class gt perl contain code to define subroutines or sets values for variables that will affect how certain translations are performed There can be code that is executed only when specific class options are specified along with the chosen document class For example the foils perl implementation of FoilT X s foils class defines code create a new sub section for each foil It also has code which allows JATRX2HTML to ignore those of FoilT X s special formatting commands that have no relevance when constructing an HTML page Any options given on the documentclass or documentstyle line may also cause a file containing Perl code to be loaded Such a file is named lt option gt per1 for the appropriate lt option gt When suc
63. ant Furthermore the optional argument lt attribs gt can be used to specify attributes for both the lt HR gt and lt BR gt tags More specifically lt attribs gt should be a list of attribute names and or key value pairs lt key gt lt value gt separated by spaces or commas This list is parsed to extract those attributes applicable to the lt HR gt tag and those applicable to the lt BR gt with the unstarred variant Using HTML 3 2 this allows variations to be specified for e the vertical thickness of the horizontal line in pixels SIZE lt num gt e the horizontal width of the line in pixels or points WIDTH lt width gt e alignment WIDTH taking left right or center e removal of the shadowed effect NOSHADE e positioning of the rule with respect to text flows CLEAR taking left all right or none Some examples of these effects appear on the HTML version of this page strikeout lt texzt gt With this command the lt tezt gt is processed as normal in the HTML version then placed between lt STRIKE gt lt STRIKE gt tags Thus a horizontal line should be drawn through the middle of the lt text gt Currently the command and the lt tezt gt are ignored in the ATRX version tableofchildlinks Asan extra aid to navigation within a long page containing several sub subsections or deeper levels of sectioning there is the tableofchildlinks command This does not generate anything new for a table o
64. arbox command The parbox lt align gt lt width gt lt text gt command also generates an image of its contents except when used within a tabular environment or other similar table making environment Here the important aspect is the width specified for the given piece of text and any special line breaks or alignments that this may imply Hence to get the best effect ATRX is used to typeset the complete parbox with its specified width alignment and contents resulting in an image The heqn package If you need HTML 2 0 compatible Web pages and have a document with a great many displayed equations then you might try using the heqn package Inclusion of the heqn sty file has absolutely no effect on the printed version of the article but it does change the way in which ATFX2HTML translates displayed equations and equation arrays It causes the equation numbers of the equation environment to be moved outside of the images themselves so that they become order independent and hence recyclable Images that result from the eqnarray environment are also recyclable so long as their equation numbers remain unchanged from the previous run The nonumber command is recognised in each line of the equation array to suppress the equation number A side effect of this approach is that equation numbers will appear on the left side of the page The heqn package requires the html package Using HTML Version 3 2 the heqn package is quite redundant since
65. as also been processed by ATRX2HTML ignored in JATRX externalcite creates a textual hyperlink to where a reference occurs in a bibliography page from a different document that has also been processed by ATRX2HTML ignored in ATpx externallabels allows hypertext links to a different document ignored in ATEX The following commands also defined for ATFX in html sty are normally used only when creating segmented documents see Section 4 10 segment directs that an input file lt file gt should be regarded as a separate segment of a larger JATRX2HTML document In F4TpX the file is input as usual after counter values have first been written to a file named lt file gt ptr startdocument tells ATRX2HTML where the end of the preamble occurs for a document segment ignored in ATpx A segment cannot have a begin document command unless it is shielded from TEX within an htmlonly environment internal reads internal information from another document so that symbolic references can be treated as if part of the current document ignored in ATEX htmlhead places a sectional heading on a HTML page used mainly with the document segmentation feature It is ignored in ATEX htmlnohead suppresses the section heading for a document segment ignored in ATFX segmentcolor read from the ptr file this sets the text color for a document segment ignored in ATPX 38 segmentpagecolor read from the ptr file this sets the bac
66. as contributed enormously to helping make FATRX2HTML the easy to use versatile program that it has now become Keep the ideas coming 1st BTRX2HTML Workshop Darmstadt 15 February 1997 Thanks again to Jens Lippmann and members of the LiPS Design Team for organising this meeting also to the Fachbereich Informatik at Darmstadt for use of their facilities This was an opportunity for many of the current JATRX2HTML developers to actually meet for the first time rather than communication by exchange of electronic mail messages e Nikos Drakos talked about the early development of ATFX2HTML while e Ross Moore Jens Lippmann and Marek Rouchal described recent improvements e Michel Goossens presented a list of difficulties encountered with earlier versions of ETEX2HTML and aspects requiring improvement Almost all of these now have been addressed in the v97 1 release so far as is possible within the bounds inherent in the HTML 3 2 standard Kristoffer Rose showed how it is possible to create GIF89 animations from pictures gen erated by TeX or ATEX using the Xy pic graphics package and extensions developed by himself and Ross Moore Also present were representatives from the DANTE e V Praesidium and members of the FATRX3 development team In all it was a very pleasant and constructive meeting TUG 97 Workshop on PTRFX2HTML University of San Francisco 28 July 1997 On the Sunday afternoon 2 00pm 5 00pm immediately prio
67. at the top of each page bottom_navigation Same as setting BOTTOMNAVIGATION 1 Put navigation links at the bottom of each page as well as the top auto_navigation Same as setting AUTO_NAVIGATION 1 Put navigation links at the top of each page Also put one at the bottom of the page if the page exceeds WORDS_IN_PAGE number of words default 450 next_page_in_navigation Same as setting NEXT_PAGE_IN_NAVIGATION 1 Put a link to the next logical page in the navigation panel previous_page _in_navigation Same as setting PREVIOUS_PAGE_IN_NAVIGATION 1 Put a link to the previous logical page in the navigation panel contents_in_navigation Same as setting CONTENTS_IN_NAVIGATION 1 Put a link to the table of contents in the navigation panel if there is one index_in_navigation Same as setting INDEX_IN_NAVIGATION 1 Put a link to the index page in the navigation panel if there is an index 5 2 5 Switches for Linking to other documents When processing a single stand alone document the switches described in this section should not be needed at all since the automatically generated navigation panels described in Section 5 2 4 should generate all the required navigation links However if a document is to be regarded as part of a much larger document then links from its first and final pages to locations in other parts of the larger virtual document need to be provided explicitly for some of the butt
68. ay not always work in the best way with this alternative style of environment delimiter These comments apply to both the ETFX and ETRX2HTML processing rawhtml endrawhtml old A S style variant of rawhtml environment htmlonly endhtmlonly old AMS style variant of htmlonly environment latexonly endlatexonly old A jS style variant of latexonly environment imagesonly endimagesonly old A S style variant of imagesonly environment comment endcomment old A S style variant of comment environment Warning These pseudo environments are not as reliable as their ATEX counterparts In particular the begin lt enu name gt and end lt env name gt commands should appear on lines by themselves preferably with no preceding spaces or lt tab gt characters This requirement is analogous to the warning at the bottom of page 37 for conditional environments 4 1 Hyper links in PT X Arbitrary hypertext references are created using the htmladdnormallink and htmladdimg commands These have syntax htmladdnormallink lt tezxt gt lt URL gt htmladdnormallink lt name gt lt text gt lt URL gt htmladdimg lt URL gt htmladdimg lt align gt lt URL gt htmladdnormallinkfoot lt tezt gt lt URL gt htmladdnormallinkfoot lt name gt lt text gt lt URL gt htmladdnormallink The htmladdnormallink command expects some text as the first argument and a URL as the second argument Whe
69. bars Wider change bars indicate where the most recent changes and features added in v99 1 are described 1This is a preliminary document for ATPX2HTML 99 1 Abstract TFATRX2HTML is a conversion tool that allows documents written in AXTRX to become part of the World Wide Web In addition it offers an easy migration path towards authoring complex hyper media documents using familiar word processing concepts including the power of a PT X like macro language capable of producing correctly structured HTML tags TATRX2HTML replicates the basic structure of a AXTFX document as a set of inter connected HTML files which can be explored using automatically generated navigation panels The cross references citations footnotes the table of contents and the lists of figures and tables are also translated into hypertext links Formatting information which has equivalent tags in HTML lists quotes paragraph breaks type styles etc is also converted appropriately The remaining heavily formatted items such as mathe matical equations pictures etc are converted to images which are placed automatically at the correct position in the final HTML document FATRX2HTML extends TEX by supporting arbitrary hypertext links and symbolic cross references between evolving remote documents It also allows the specification of conditional text and the inclusion of raw HTML commands These hyper media exten sions to TFX are available as new commands and e
70. ble for image generation It has the effect of setting PK_GENERATION to 1 and DVIPS_MODE to be empty overriding any previous settings for these variables no_math Same as setting NO_SIMPLE_MATH 1 Ordinarily simple mathematical expressions are set using the ordinary text font but italiced When part of the expression can not be represented this way an image is made of the whole formula This is called simple math When NO_SIMPLE_MATH is set then all mathematics is made into images whether simple or not However if the math extension is loaded using the html_version switch de scribed earlier then specifying no math produces a quite different effect Now it is the special lt MATH gt tags and entities which are cancelled In their place a sophisti cated scheme for parsing mathematical expressions is used Images are made of those sub parts of a formula which cannot be adequately expressed using italiced text characters and lt SUB gt and lt SUP gt tags See Section 3 3 for more details 66 local_icons Same as setting LOCAL_ICONS 1 A copy of each of the icons actually used within the document is placed in the directory along with the HTML files and generated images This allows the whole document to be fully self contained within this directory otherwise the icons must be retrieved from a perhaps remote server The icons are normally copied from a subdirectory of the LATEX2HTMLDI
71. ce should appear both in the printed document and in the hypertext version For example assuming that the label sec cond is defined somewhere within a document the command hyperref taking 4 arguments can be used in that document as follows emph Is the concept of hyperref 47 4 This will be highlighted in the hypertext version conditional text 4 argument 1 4 This will be shown in the printed version followed by a numeric reference conditional text see Section 4 argument 2 4 followed by this text for more information 4 argument 3 This is the common label sec cond 4 argument 4 a good idea Here is how it will be shown Is the concept of conditional text see Section 4 5 for more information a good idea In the hypertext version what would appear is Is the concept of conditional text a good idea Of course conditional text would be an active hypertext link An extended syntax for hyperref uses an optional argument which determines what information is to be placed in the BTFX version of the document The value of this optional argument can also affect the number of required arguments These forms are recognised hyperref ref lt HTML text gt lt LaTeX teaxt gt lt post LaTeX gt lt label gt hyperref lt HIML teat gt lt LaTeX text gt lt post LaTeX gt lt label gt hyperref pageref lt HTML teat gt lt LaTex text gt lt post LaTeX gt lt l
72. cifying large or small sections of the text which are appropriate to only one version of the document either the HTML or the TFX typeset version Their use is discussed in Sections 4 2 and 4 4 begin rawhtm1 for including raw HTML tags and SGML like markup begin htmlonly for material intended for the HTML pages only begin latexonly for material intended for the BTFX version only Note that any macro definitions or changes to counter values are local to within this environment Zbegin latexonly for material intended for the ATRX version only Macro definitions and changes to counter values are retained outside of this pseudo environment begin imagesonly for material intended to be used in the images tex file only begin comment for user comments only currently ignored in both the HTML and TEX versions To put HTML comments into the HTML files use the rawhtml environment begin makeimage creates an image of its contents as typeset by TEX This is also used to prevent an image being made of the complete contents of a figure environment allowing more natural processing begin htmllist defined in htmllist sty and htmllist perl this produces coloured balls tagging the items in a descriptive list as used throughout the HTML version of this manual Warning When using these environments it is important that the closing delimiter end htmlonly say occurs on a line by itself with no preceding spaces lt tab gt s o
73. cing to work a relative path must be included as part of the lt prefiz gt with each internal command e g internal figure sect1 si 60 5 Customising the Layout of HTML pages ETEX2HTML is a program for creating hyperlinked sets of HTML pages from a document marked up using ATFX commands Previous sections have discussed the results of specific BETEX commands In this section we discuss instead the extensive range of command line switches and options and other aspects of Perl code that affect the way the translation is performed To use ATRX2HTML to translate a file lt file gt tex containing TFX commands type latex2html lt fzle gt tex This will create a new directory called lt file gt which will contain the generated HTML files some log files and possibly some images To view the result use an HTML browser such as NCSA Mosaic or Netscape Navigator on the main HTML file which is lt file gt lt file gt html The file will contain navigation links to the other parts of the generated document The tex suffix is optional and will be supplied by the program if it is omitted by the user Other suffixes are acceptable also such as doc It is possible to customise the output from MTFX2HTML using a number of command line options see Section 5 2 with which you can specify e how to break up the document e where to put the generated files and what are their names e the title for the whole document e the sig
74. cle document CASS 3 24 2S SP ee a d S556 ee BORER a beat eta bi dee E A 28 bash a unix shell does not directly support use of ATPX2HTML 8 bibtex bibliography data base program used with BTPX 86 book perl implements section numbering conventions etc for the book document class ee ee ee ee ee 28 CERN originally named Conseil Europeen pour la Recherche Nucleaire now known as the European Laboratory for Particle Physics located near Geneva also where the World Wide Web was originally conceived 0 000 c ce cee een eens 55 changebar sty TEX 2e package to mark changes in documentation this supercedes an earlier package cacas ecu be deia dan da k eaaa E Ea ee eS iii 12 31 Changes text file recording the changes made to ATFX2HTML since it was first released in July 1993 until V96 1 and revisions during 1996 7 13 chmod Unix command for changing the access privileges on files 82 color perl contains Per code to implement all the features of IATFX s color package and loads a list of named colors 2 2 0 00 ee ee 54 74 89 93 configure pstoimg Perl script to locate which Unix utilities are available on the local system for use in generating images 2 2 4 v 7 10 76 91 96 credits tex input file for the ATRX2HTML manual acknowledges the multitude of con tributors to the development of PTRX2HTML 2 00 0000 12 csh a u
75. clo files TFX simply notes the existence of unusupported options processing is not interrupted 3 7 Packages and Style Files Similar to the document class mechanism described in Section3 6 IATRX2HTML provides a mechanism whereby the code to translate specific packages and style files is automatically loaded if such code is available For example when use of a style such as german sty is detected in a ATRX source document either by 28 e a usepackage command of TFX 2e e an option to the documentstyle command of ETRX 2 09 e an explicit input or include command the translator looks for a corresponding per1 file having the same file name prefix e g the file LATEX2HTMLDIR styles german perl If such a perl file is found then its code will be incorporated with the main script to be used as required This mechanism helps to keep the core script smaller as well as making it easier for others to contribute and share solutions on how to translate specific style files The current distribution includes the files to support the styles listed in Table 6 These provide good examples of how you can create further extensions to ATRX2HTML Table 6 Supported A4TRX2HTML packages and style files peri file alltt Supports the ATEX 2 s alltt package amsfonts provides recognition of the special AMS font symbols amsmath same as amstex perl amssymb same as amsfonts perl amstex Supports much of the AMS ETFX package not yet com
76. cs containing PostScript graphics used in the printed ver sion of the ATRX2HTML manual 1 eee 12 pstogif Perl script which controls the conversion of images from PostScript to GIF bitmaps replaced by pstoimg for V97 1 0 000000000 ii v 7 10 pstoimg Per script which controls the conversion of images from PostScript to a chosen graphics format 00 v 7 10 73 76 81 82 90 92 93 96 98 pstoppm ps contains PostScript code needed for image conversion with versions of Ghostscript earlier than 3 0 2 0 0 cee ee ee ii README found in LATEX2HTMLDIR this file contains simple information concerning the latest releasG 14 4a 0 44 Kane ba adia eat Ee Oo be eee eae pes bed be aS 7 report map example data file used as input for makemap to produce an image map 55 report perl implements section numbering conventions etc for the report document CLASS i e 6 be aca ioe Sa cn Rb dd a Gee Ad ee as chal ack dee he alae access 28 report ps PostScript version produced by E TRX for the report tex example of a seg mented dociment gor adra koa on Via eee EE ee Dae Ao ee ee a ek ee 59 report tex example source for a segmented document 58 60 98 report subdirectory created when processing the example segmented document 60 SDBM Unix Database Management utility distributed with Perl5 83 seci tex one section of the example segmented document 58 60 sec2 html one HTML page
77. ctory of LATEX2HTMLDIR containing the ATEX packages needed to successfully typeset its manual 0 0 000002 eee eee 7 10 31 toshiba Metafont mode recommended for setting mathematics and text included within automatically generated images 2 1 0 ee eee eee 11 up gif image of a small upward turning arrow 0 00000 eee ee eee 12 url sty BIFX 2 package for typesetting URLs across multiple lines ili 12 urls bib suggested name for a BibTRX input file containing string definitions for URLs to be used within bibliographic references 002000005 49 userman tex input file for the main section of the ATRX2HTML user manual 12 versions subdirectory of LATEX2HTMLDIR containing files to adapt to different versions O ATM 2 453 p E eee to LY eee hPa Ga Hy ook ee oA me Lie ane Ee 7 65 91 wrapfig st TATRX 2e package for wrapping text around non floating figures 31 piig y eP g pping 8 ug xv useful Unix graphics utility allows interactive manipulation and format conversion of bitmapped images 0 0 eee ee eee 56 99 Index Symbols TeX Users Group TUG 13 A About this document 67 accents 3 foreign ii address signature 67 using a subroutine 67 alltt environment 29 AMS ETEX amsfonts package 29 amsmath package 29 amssymb package 29 amstex package 29 AyyS style environments listed 40 old use discouraged 40 anchor tag NAME attribute 40 anti aliasing 23
78. d htmlonly environment but with less typing e The latex command causes everything within the braces to be processed by BTEX but ignored by ATRX2HTML e Conversely the html command causes everything within the braces to be ig nored by ATEX and processed by ATRX2HTML e Finally the command latexhtml causes everything within the first set of braces to be processed exclusively by PTFX with the contents of the second set of braces processed solely by ATRX2HTML Warning Only small pieces of text work reliably in this way With whole paragraphs or contained sub environments the conditional environments should be used instead begin latexonly Another variant of the latexonly environment is available in which everything between begin latexonly and Zend latexonly is ignored by ATRX2HTML The difference is that the latexonly environment puts the contents into a group in which all definitions are local There is no such scoping with the begin end variant since ATRX sees the initial s simply as starting comments The following example should clarify what happens newcommand A The letter A newcommand B The letter B begin latexonly renewcommand A Not the letter A end latexonly dAbegin latexonly renewcommand B Not the letter B end latexonly begin document A B end document 46 If you process this with BTFX the result is The letter A Not the letter B Note
79. e If the section corresponding to a textual link does not exist then the link will be empty The next group and previous group are rarely used since it is usually possible to determine which are the next previous logical pages in a document However these may be 79 needed occasionally with segmented documents when the segments have been created with different values for the MAX_SPLIT_DEPTH variable This is quite distinct from the segmented document effect in which the first page of one segment may have its PREVIOUS button artificially linked to the first page of the previous segment rather than the last page The number of words that appears in each textual link is controlled by the variable WORDS_IN_NAVIGATION_PANEL_TITLES which may also be changed in the configuration files Below is an example of a navigation panel for the bottom of HTML pages Note that the is Perl s string concatenation operator and signifies a comment sub bot_navigation_panel Start with a horizontal rule and descriptive comment lt HR gt n lt Navigation Panel gt Now add a few buttons with a space between them NEXT UP PREVIOUS CONTENTS INDEX CUSTOM_BUTTONS Line break n lt BR gt If next section exists add its title to the navigation panel NEXT_TITLE n lt B gt Next lt B gt NEXT_TITLE undef Similarly with the up title UP_TITLE n lt B gt Up
80. e basic mechanism for handling foreign accents Todd Little The auto_navigation option was based on an idea by Todd Axel Belinfante provided the Perl code in the makeidx perl1 file as well as numerous suggestions and bug reports Verena Umar from the Computer Science Education Project has been a very patient tester of some early versions of XTRX2HTML and many of the current features are a result of her suggestions Ian Foster and Bob Olson Thanks to Ian Foster and Bob Olson at the Argonne Na tional Labs for setting up the ATRX2HTML mailing list http cbl leeds ac uk www home html Shttp csep1 phy ornl gov csep html http cbl leeds ac uk nikos tex2html doc mail mail html ii Later Developments 1995 1996 Since 1995 the power and usefulness of IATRX2HTML has been enhanced significantly The revisions later than V95 1 have been largely due to the combined efforts of many people other than the original author Interested users have supplied patches to fix a fault or implement a feature that previously was not supported Often a question or complaint to the discussion group see Section 2 2 has spurred someone else to provide the necessary patch Arising from this work special credit is due to Marcus Hennecke for his many extensive revisions Mark Noworolski for coordinating V95 3 Sidik Isani for his improvement in GIF quality Michel Goossens was the driving force behind the upgrade to ATX 2e compat
81. e best way of describing how this works is by example Suppose a document has two figures designated to become active image maps The first figure includes a statement like begin figure htmlimage map cgi bin imagemap BlockDiagram map end figure The second figure has a line like begin figure htmlimage map cgi bin imagemap FlowChart map end figure A typical user map file named report map might contain the following information Define the location s of the labels pl file s report lt URL gt Define map 1 BlockDiagram map labeli rect 288 145 397 189 label2 rect 307 225 377 252 label2 default Define map 2 FlowChart map label3 circle 150 100 200 100 label4 default In this file comments are denoted by a sign in column 1 The line beginning with report states that the symbolic labels are to be found in the labels p1 contained in the directory report and that its associated URL is as stated Any number of external labels p1 files 45 This file is designed for an NCSA server CERN servers use rect instead of rectangle radius instead of an outer point in the circle and enclose point coordinates by parentheses specify a 55 may be so specified The block diagram image has two active regions The first is a rectangle bounded by corners 288 145 and 397 189 while the second is a rectangle bounded by corners 307 225 and 377 252
82. e currently supported lt image type gt s are gif and png DVIPS dvips Read from latex2html config by install test its value is checked to locate the dvips program or script There could be several reasons to change the value here e add a switch P lt printer gt to load a specific configuration file e g to use a specific set of PostScript fonts for improved image generation e to prepend a path to a different version of dvips than normally available as the system default e g the printing requirements are different e to append debugging switches in case of poor quality images one can see which paths are being searched for fonts and other resources e to prepend commands for setting path variables that dvips may need in order to locate fonts or other resources If automatic generation of fonts is required using Metafont the following configuration variables are important PK_GENERATION 1 This variable must be set to initiate font generation otherwise fonts will be scaled from existing resources on the local system In particular this variable must not be set if one wishes to use PostScript fonts or other scalable font resources see the scalable_fonts switch DVIPS_MODE toshiba The mode given here must be available in the modes mf file located with the Metafont resource files perhaps in the misc subdirectory METAFONT_DPI 180 The required resolution in dots per inch should be l
83. e kepa nae AW eae dee 2 Oe Waa dae Rear 9 licence tex input file for the MTR X2HTML manual contains the licence statement and COPyHEht NOCE 6 eared erie ees Sada Ge lad dew Pdierbeve herd bens 12 local pm written by configure pstoimg this Perl file records the locations of the graph ics utilities on the local system used by pstoimg 0 7 10 93 lslide sty JATRX package for producing colour separations 88 lynx character based Web browser available for DOS and Unix systems 9 68 make Unix utility used to track the time dependency of multiple files in the development of a document or computing project 1 6 ee ee 59 60 63 97 Makefile contains the time dependency data used by the make utility 59 63 70 71 94 108 makeidx perl adds Perl code to interpret index entries otherwise intended for the makeindex program 1 eee ii 34 makeindex utility for sorting and filtering textual data used primarily for making the indek or lOSSATY lt ava dace d eee ee ea Be he dad 12 35 96 97 makemap Perl script to generate image maps 7 10 11 55 98 makeseg Perl script to generate Makefiles for segmented documents so that you can initiate the translation with a single make call 0 000 0000 iii 7 MakeTeXPK script used by dvips and other dvi drivers controlling generation of missing FONTS seeda hen tengd ed neded pode oud Se eden ee eed hed nee EE 11 73 manh
84. e kind of translation you would like to perform as follows 1 BTeX commands but without equations figures tables etc e Perl Note PTFX2HTML requires Perl 5 to operate Warning 1 You really do need Perl 5 Versions of ATRX2HTML up to v96 1h work both with Perl 4 at patch level 36 and Perl 5 though some of the packages may only work with Perl 5 Warning 2 Various aspects of Perl which are used by JATRX2HTML assume certain system commands to be provided by the operating system shell If csh or tcsh is used to invoke JATFX2HTML then everything should work properly Perl 5 eliminates this requirement on the shell e DBM or NDBM the Unix DataBase Management system or GDBM the GNU database manager Note Some systems lack any DBM support Perl 5 comes with its own database system SDBM but it is sometimes not part of some Perl distributions The installation script install test will check that for you If no database system is found you will have to install Perl properly 2 ATEX commands with equations figures tables etc As above plus e latex version 2e recommended but 2 09 will work with reduced ability to support styles and packages 8http www pvv unit no archie http ftpsearch ntnu no ftpsearch dvips version 5 516 or later or dvipsk Version 5 62 or higher enhances the performance of image creation with a sig nificant speed up See latex2html config for this after you are done with the installation
85. e no longer entirely dependent on the aux file generated by ET RX decisions about which environments to include or exclude can now be made HTML effects for which there is no direct ATRX counterpart can be requested in a variety of new ways HTML code produced by the translator is much neater and more easily readable con taining more comments and fewer redundant breaks and lt P gt tags error detection of simple TFX errors such as missing or unmatched braces is now performed a warning message shows a line or two of the source code where the error has apparently occurred For these developments thanks goes especially to Jens Lippmann for creating and maintaining the CVS repository at http saftsack fs uni bayreuth de latex2ht user This has made it much easier for the con tributions from different developers to be collected and maintained as a development version which is kept up to date and available at all times Together with Marek Rouchal he produced an extensive rewrite of the texexpand utility Shttp www w3c org iv Ross Moore for extensive work on almost all aspects of the ETFX2HTML source and doc umentation combining code for BTFX Perl HTML and other utilities Most of the coding for the new features based on HTML 3 2 many of the new packages faster image generation and the improved support for mathematics and other environments is his work Marek Rouchal for extending the former pstogif utili
86. e of a separate file for footnotes instead these are placed at the bottom of the HTML pages where the references occur When this option is used it is frequently desirable to change the style of the marker used to indicate the presence of a footnote This is done as in ATRX using code such as follows renewcommand thefootnote arabic footnote All the styles arabic alph roman Alph and Roman are available numbered_footnotes Same as setting NUMBERED_FOOTNOTES 1 If this is set you will get every footnote applied with a subsequent number to ease readability address lt author address gt Same as setting ADDRESS lt author address gt Sign each page with this address See latex2html config for an example using Perl code to automatically include the date A user defined Per subroutine called amp custom_address can be used instead if defined it takes the value of ADDRESS as a parameter which may be used or ignored as desired At the time when this subroutine will be called variables named depth title file hold the sectioning level title and filename of the HTML page being produced F ILE holds the name of the filename for the title page of the whole document 67 info lt string gt Same as setting INFO lt string gt Generate a new section About this document containing information about the document being translated The default is to generate such a section with information on th
87. e original document the date the user and the translator An empty string or the value 0 disables the creation of this extra section If a non empty string is given it will be placed as the contents of the About this document page instead of the default information 5 2 3 Switches controlling Image Generation These switches affect whether images are created at all whether old images are reused on subsequent runs or new ones created afresh and whether anti aliasing effects are used within the images themselves ascii mode Same as setting ASCII MODE EXTERNAL_IMAGES 1 Use only ASCII characters and do not include any images in the final output With ascii_mode the output of the translator can be used on character based browsers such as lynx which do not support inlined images via the lt IMG gt tag nolatex Same as setting NOLATEX 1 Disable the mechanism for passing unknown environments to IATFX for processing This can be thought of as draft mode which allows faster translation of the basic document structure and text without fancy figures equations or tables This option has been superseded by the no_images option see below g external_images Same as setting EXTERNAL IMAGES 1 Instead of including any generated images inside the document leave them outside the document and provide hypertext links to them ps_images Same as setting PS_IMAGES EXTERNAL_IMAGES 1
88. e paper dvi version of a document the rawhtml environment is ignored Here is an example begin rawhtml lt HR gt lt FORM ACTION http cbl leeds ac uk nikos doc error html gt lt OL gt lt LI gt lt INPUT TYPE checkbox NAME wp VALUE word gt Word for Windows lt LI gt lt INPUT TYPE checkbox NAME wp VALUE wp gt Word Perfect 41 lt LI gt lt INPUT TYPE checkbox NAME wp VALUE latex gt LaTeX lt LI gt Plain Text Editors Please Specify lt INPUT TYPE text NAME other_ed gt lt OL gt So what do think comments please lt BR gt lt INPUT TYPE text SIZE 45 NAME other_wp gt lt INPUT TYPE submit VALUE submit this form but don t expect much gt lt FORM gt lt HR gt end rawhtml The result is shown in Figure 5 1 O Word for Windows 2 O Word Perfect 3 K LaTeX 4 Plain Text Editors Please Specify emacs So what do think comments please submit this form but don t expect much Figure 5 An electronic form In the online version the form would be active beginrawhtml endrawhtml This is an alternative way to specify a chunk of raw HTML code using the old A yS style of delimiting environments Use of this style is discouraged the rawhtml environment is preferred begin comment This environment is simple for the convenience of commenting out large sections of source code The contents of this environment is completely igno
89. e this command at your own risk latextohtml expands to the name ATRX2HTML of this translator Commands for parts of names of important 4TRX packages are also included with ATRX2HTML e g TeX ATRX AMS Xy This is to make it easy to refer to these products in a consistent way within the HTML pages you may still need TFX definitions for the typeset version 54 4 9 Active Image Maps Image maps are images with active regions in which a Web surfer can click to send him off to another sector of cyberspace BTEX2HTML can design either inline figures or external ones with or without a thumbnail version to be image maps However HTML requires a URL of a HTML map file which associates the coordinates of each active region in the map with a destination URL Usually this map file is kept on the server machine however HTML 3 2 also allows it to reside on the client side for faster response Both configurations are supported by ETeX2HTML through the htmlimage options map and usemap respectively Keeping such a map file up to date manually can be tedious especially with dynamic documents under revision An experimental program makemap helps automate this process This program which is really a Perl script takes one mandatory argument and an optional argument The mandatory argument is the name of a user map file defined below The optional argument is the name of the directory where the HTML map file s are to be placed Th
90. e to loading of extensions say then an image will indeed be created Any effects requested in the lt options gt argument will be used Having empty lt options gt still causes the image to be generated This ability has been used within this manual for example with the mathematics images in Figure 1 The lt options gt argument is a string separated by commas Allowable options are e scale lt scale factor gt allows control over the size of the final image e external will cause the image not to be inlined instead it will be accessible via a hyperlink e thumbnail lt scale factor gt will cause a small inlined image to be placed in the caption The size of the thumbnail depends on the lt scale factor gt as a factor of the natural size of the image ignoring any FIGURE_SCALE_FACTOR or MATH SCALE_FACTOR etc which may be applicable to the full sized version of the image Use of the thumbnail option implies the external option e map lt server side image map URL gt specifies that the image is to be made into an active image map See Section 4 9 for more information e usemap lt client side image map URL gt same as previous item but with the image map processed by the client See Section 4 9 for more information e flip lt flzp_option gt specifies a change of orientation of the electronic image relative to the printed version The lt flip_option gt is any single command recognised by the pnmf
91. e using It is possible that you are using a style file which contains raw TeX commands In such a case start ATRX2HTML with the option dont_include lt style file name gt Alternatively add the name of the style to the variable DONT_INCLUDE in your HOME 1latex2html init file If you don t have such a file then create one and add the lines DONT_INCLUDE DONT_INCLUDE lt style file name gt is This must be the last line Another reason why ATEX2HTML might stop is that the ATRX source file itself contains raw TeX commands In this case you may put such commands inside a latexonly environment see Section 4 4 The VERBOSITY variable can be used to create tracing messages which may help to locate which command or environment was being processed when everything stopped It appears to be doing nothing Perhaps the processor has fallen into an unending loop Usually there will be a bad definition or other faulty source code which has caused this The VERBOSITY variable see page 71 can be set to generate tracing messages which may help to locate which command or environment is being processed repeat edly Try setting a value of 3 e g using the commandline switch verbosity 3 This will print command and environment names as thaey are processed It should soon become apparent where any such looping occurs It just fills the endlessly with dots No perhaps here the processor has definitely fallen in
92. eading nor the INFO contents appears in the ATRX typeset version bodytext lt options gt The text and background colors and colors for the text of hyper text links can be set on an HTML page by giving appropriate attributes with the lt BODY gt tag This is particularly easy to do using the bodytext command which simply inserts the lt code gt as the desired list of attributes Warning Any previous settings for the lt BODY gt tag are discarded Furthermore no checking is done to verify whether the given lt options gt indeed contains a list of attributes and values valid for the lt BODY gt tag When using bodytext you are assumed to know precisely what you are doing Other packages contain commands which alter the contents of the lt BODY gt tag notably the color perl implementation of ATfX s color package and the prototype frames pack age by Martin Wilck and Ross Moore In both these packages the requested information is checked for validity as an attribute within the lt BODY gt tag htmlbody lt options gt This is similar to the bodytext command except that it adds the value of an attribute or allows an existing value to be changed Thus it can be used to alter just a single one of the text and background colors colors for the text of hypertext links or add a background pattern The lt options gt are given as key value pairs some checking is done to ensure the validity of the attributes whose
93. ec1 ptr end htmlonly internal s2 startdocument Here is some text subsection First subsection Here is subsection 1 label first begin figure colorbox red Some red text index Color text caption List of figure caption Figure 1 caption end figure Reference index Reference to ref second The first thing this child segment does is establish the TFX packages it requires then loads the counter information that was written by the segment command that invoked it Since this segment contains a symbolic reference second to the second segment it must load the internal labels from that segment The final segment sec2 tex is as follows begin htmlonly documentclass article usepackagefhtml makeidx input sec2 ptr end htmlonly internal s1 startdocument Here is another section label second Plus another index Reference another reference ref first begin figure fbox The figure caption The caption end figure This segment needs to load internal labels from the first one because of the reference to first These circular dependencies two segments referencing each other are either not allowed or handled incorrectly by the Unix utility make without resorting to time stamps and some trickery A time stamp is a zero length file whose only purpose is to record its creation time Besides evaluating segment interdependence another function of make is to provide inter segment navigatio
94. ediately after use 2 eee 68 DISP_SCALE_FACTOR extra magnification for images of displayed math environments mul tiplies the MATH_SCALE_FACTOR to give the total scaling 19 22 66 75 76 DONT_INCLUDE holds a list of filenames and filename extensions to not include even if requested filenames ending with sty are automatically excluded 73 74 82 89 DO_INCLUDE holds a list of filenames and filename extensions to be included even when the DONT_INCLUDE variable would normally exclude them 74 DVIPS contains the command to be used when the dvips program processes images dvi to create PostScript files describing the required images 73 DVIPS_MODE contains the Metafont mode to be used when the dvips program supports 89 automatic font generation 2 0 eee 11 66 73 EXTERNAL_BIBLIO specifies the URL for a bibliography page external to the current GOCUMENE sh hak we pach ak eek Bo aes ble bd wo od eh he ORO wa AR 71 EXTERNAL_CONTENTS specifies the URL for the CONTENTS button in the navigation panel erene Pesta E ees Gave aces Geta execs hehe Se a ae Nase deseo E S ee ee Ceca 71 EXTERNAL_DOWN_LINK specifies the URL for the NEXT button in the navigation panel 71 EXTERNALDOWN_TITLE specifies the text for the NEXT button hyperlink in the navigation panel axes hk oe KH NE oo we PA ae ee EA eee a oe ee 71 EXTERNALFILE prefix of a aux file to be read for numbering and other informatio
95. efreshening discussions about that Override pm loading scheme which finally made its way after enough chickens and eggs chased one another to death and to Daniel Taupin for his successful efforts to get BTEX2HTML running on DOS Thanks go also to Fabrice Popineau for his port to Windows NT and Nikos Drakos for a Windows 95 port based on v96 1h which is mentioned here at last but not least We want to take the opportunity to thank Scott Nelson and the people at Lawrence Liver more National Laboratory who help to keep up the ATFX2HTML main archive and the mailing list and to Achim Bohnet at the Max Planck Institut fuer extraterrestrische Physik Garch ing for maintaining the list s online archive Finally thanks and greetings to all people that contributed to this release and have not been mentioned here You all showed spirit and favour Thank you for your efforts Shttp www unicode org http www texdev mpce mq edu au 12h indic IndicHTML lOCTAN tex archive systems win32 web2c 12h win32 tar gz ll tp ftp mpn com pub nikos latex2htm196 1 h win32 tar gz vil and don t forget Jens and the LiPS team at Darmstadt viii Proposals for Future Development PT RX 2HTML NG Developed by Marcus Hennecke this is a version of ATR X2HTML that addresses various issues not currently handled in the best way by version v97 1 These include e validating the HTML output so that only correctly nested tags and th
96. eidx provides more sophisticated indexing 29 Table 6 Supported ATRX2HTML packages and style files multicol suppresses requests for multi columns natbib Supports many different styles for citations and bibliographies nharvard Supports harvard style citations using natbib seminar for creation of overhead presentation slides spanish Support for the Spanish language supertabular supports use super tables as an ordinary table texdefs Supports some raw TFX commands verbatim Supports verbatim input of files verbatimfiles Supports verbatim input of files also with line numbering wrapfig Supports wrapped figures xspace Supports use of the xspace package and xspace command xy Supports use of the Xy pic graphics package The problem however is that writing such extensions requires an understanding of Perl programming and of the way the processing in AATRX2HTML is organised Interfaces that are more user friendly are being investigated Some of the techniques currently used are explained in Section 5 3 3 7 1 Fancy List Markers An optional style file htmllist sty has been provided which produces fancier lists in the electronic version of the documentsuch as this This file defines a new ATEX environment htmllist which causes a user defined item mark to be placed at each new item of the list and which causes the optional description to be displayed in bold letters The filename prefix for the item mark image can be
97. eir contents can be produced by the translator e more T X like order of macro expansion so that macros and their expansions will produce exactly the results expected from the TeX implementation of ATEX e faster processing by streamlining some of the current Per code and allowing shorter strings to be handled at any given time e customisation issues allowing easier portability to Unix like environments on other platforms Many of these features have been the inspiration for new code written for ATEX2HTML v98 1 The current version of JATRX2HTML NG can be obtained from the developer s repository see page 6 in the directory http saftsack fs uni bayreuth de latex2ht ng user Beware that the files there are not compatible with those of the same name that come with the current version of ATRX2HTML Extended Capabilities in Web browsers The following areas are the subject of active development within the Web community Limited support is available within TFX2HTML for some of these features using the html_version 4 0 command line switch style sheets proposals for a flexible mechanism to allow cascading CSS and DSSSL within HTML 4 012 XML eXtensible Markup Language MathML Mathematical Markup Language CML Chemical Markup Language Fonts further support for non standard font encodings Icons Alternative sets of icons for navigation buttons and other purposes For some background on these technologi
98. elative path 60 requires book keeping 56 same sub directory 60 shared references 56 starting a segment 57 symbolic links 56 time stamps 59 unsegment 65 use of Makefile 59 segmentcolor 57 segmentpagecolor 58 seminar package 30 simple math cancelled 66 source code 6 compressed 7 developer s repository 6 for Windows NT platform 6 from CTAN 6 home site 6 listing 7 patches 6 using Archie 6 using FTP search 6 spanish package 30 special 37 characters see character set features 9 special considerations 14 special features 14 startdocument 57 strikeout 53 style sheets 108 CSS ix DSSSL ix style files 29 support 13 for german language 28 for specific style files 28 mailing list 13 Swan Herb 1 switches see options symbolic labels 47 52 55 see also references symbolic 50 T table environment 26 table environment 26 table of contents 3 depth 64 star sections not listed 64 star sections shown 64 tableofchildlinks 53 tables 2 26 arbitrarily scaled 2 as HTML mark up 3 as HTML mark up 15 as images 3 8 captions 25 from other segments 57 longtablelongtable package 29 oriented 2 22 supertabular package 30 tables 65 Taupin Daniel vii 1 temporary files 63 texdefs package 30 Thau Robert S ii 7 The ATEX Companion Goossens Mittelbach Samarin 88 The BTEX Graphics Companion Goossens Rahtz Mittelbach 88 The ATEX Web Companion Rahtz Goossen
99. equation numbers are placed in a separate lt TABLE gt cell to the mathematical expressions themselves It is not required and should not be requested since this will override some of the improved func tionality already available 3 4 Figures and Image Conversion IATRX2HTML converts equations special accents external PostScript files and ATRX envi ronments it cannot directly translate into inlined images This section describes how it is possible to control the final appearance of such images For purposes of discussion e small images refers to inline math expressions special accents and any other ATRX command which causes an image to be generated while e figures applies to image generating TEX environments e g makeimage figure table with HTML 2 0 and displayed math environments when required to generate images etc The size of all small images depends on a configuration variable MATH_SCALE_FACTOR which specifies how much to enlarge or reduce them in relation to their original size in the PostScript version of the document For example a scale factor of 0 5 will make all images half as big while a scale factor of 2 will make them twice as big Larger scale factors result in longer processing times and larger intermediate image files A scale factor will only be effective if it is greater than 0 The configuration variable F IGURE_SCALE_FACTOR performs a similar function for figures Both of the
100. er to be displayed at the end of the minipage s contents none none Jacobi m step Jacobi iteration SSOR m step SSOR iteration IC Incomplete Cholesky factorization ILU Incomplete LU factorization aone footnote banother footnote The code used for this example was as follows begin minipage 9 textwidth renewcommand thempfootnote alph mpfootnote begin tabular 1 1 hline textbf Variable amp textbf Meaning hline none amp none Jacobi amp m step Jacobi iteration footnote 1 one footnote SSOR amp m step SSOR iteration footnotemark 1 Ic amp Incomplete Cholesky factorization footnote 2 another footnote ILU amp Incomplete LU factorization footnotemark 2 hline end tabular end minipage Warning With some figures especially when containing graphics imported using includegraphics or other special macros the background color may come out as a shade of grey rather than white or transparent This is due to a setting designed to enhance anti aliasing of text within images e g for mathematics To alleviate this possible problem the white command line option can be used to ensure a white background for images of figure environments Alternatively set the WHITE_BACKGROUND variable see section 5 2 3 39Thanks to John Turner turner lanl gov for this example which was used in developing code to handle minipage environments correctly 27 3 6 Document Classes
101. erlink The former having name III will ultimately reside on the Index page while the latter will point to an anchor named GGG on the Glossary page These names must be distinct from any other names used with labels elsewhere in the document hence the use of prefixes III and GGG A short string G is used for the text of the hyperlink in the Index 34 e The text descriptions of the glossary items are stored in a file called 12hfiles dat with one description per line For the HTML version this file is actually read as input section Glossary of variables and file names label Glossary begin htmllist htmlitemmark OrangeBal1 input 12hfiles dat end htmllist For this reason alone it is desirable to have 12hfiles dat sorted alphabetically e The mechanism used for the TEX version also requires the file to be sorted strictly alphabetically according to the sort keys associated to each glossary entry This requirement could be relaxed but only with a loss in efficiency see below BTEX constructs its Glossary by running the makeindex utility on the file manual glo using the following command makeindex o manual gls s 12hglo ist manual glo Its output which includes page numbering for an index is stored in manual gls and subsequently read by TFX using InputIfFileExists manual gls clearpage typeout Jcreating Glossary typeout JNo Glossary since manual gls could not be found J The
102. erred to above are document part chapter section subsection subsubsection paragraph subparagraph subsubparagraph ONOI AUUN e These levels apply even when the document contains no sectioning for the shallower levels e g no part or chapter commands is most common especially when using PT X s article document class 5 2 2 Options controlling Extensions and Special Features The switches described here govern the type of HTML code that can be generated and how to choose between the available options when there are alternative strategies for implementing portions of EA TRX code html_version 2 0 3 0 3 2 math ii8n table Same as setting HTML_VERSION This specifies both the HTML version to generate and any extra non standard HTML features that may be required The version number corresponds to a published DTD for an HTML standard although 3 0 was never accepted and subsequently withdrawn A corresponding Perl file in the versions subdirectory is loaded these files are named html lt num gt pl Following the version number a comma separated list of extensions can be given Each corresponds to a file lt name gt p1 also located in the versions subdirectory When such a file is loaded the resulting HTML code can no longer be expected to validate with the specified DTD An exception is math when the no_math switch is also used which should still validate Currently
103. es read Michel Goossens survey article Hyper activity in the Web world in CERN Computer Newsletter No 22716 and browse Axel Ramge s site for ideas on how they could be used with ATpX2HTML http www w3 org pub Markup 13http www w3 org pub WWW TR WD xml html Mhttp www w3 org pub WWW TR WD math 970515 15 http www venus co uk omf cml 16http wwwinfo cern ch cnls 227 art_ xml html Thttp www ramge de ax latex2html latex2html html ix General License Agreement and Lack of Warranty This software is distributed in the hope that it will be useful but without any warranty The author s do not accept responsibility to anyone for the consequences of using it or for whether it serves any particular purpose or works at all No warranty is made about the software or its performance Use and copying of this software and the preparation of derivative works based on this software are permitted so long as the following conditions are met e The copyright notice and this entire notice are included intact and prominently carried on all copies and supporting documentation e No fees or compensation are charged for use copies or access to this software You may charge a nominal distribution fee for the physical act of transferring a copy but you may not charge for the program itself e If you modify this software you must cause the modified file s to carry prominent notices a ChangeLog describing the changes who made the
104. es that the background of generated images should be made transparent s asussa ee eee ee 75 UNSEGMENT when set BTEX2HTML translates a segmented document as a whole rather than a single segment use this for testing your segmented document 65 UP when navigation panels are created this holds a hyperlink to the parent HTML page 79 UP_TITLE when navigation panels are created this holds a title of the parent HTML PARE ine nk dates Ha PA ek ak ae Wd gate Aa ke adda OS edd x 79 USENETPBM when set indicates that the netpbm graphics utilities are available no longer needed gere 4 bit fie E tepecen deere a ee hehe EE aan Pee de aa taatate 6 ee 76 VERBOSITY has a numerical value which determines the messages to be printed on screen as FATRX2HTML processes a document 22 02005 62 71 72 82 83 WHITE_BACKGROUND when set ensures that images of figure environments have a white backeround esr c2056 tei Cena ede be eho T cara de he eas bE oes we 27 69 WORDS_IN_NAVIGATION_PANEL_TITLES used to limit the number of words shown with the navigation panel buttons 2 0 0 0 0 2 ee eee 75 80 WORDS_IN_PAGE contains the number of words required before a navigation panel is placed also at the bottom of a page 2 eee ee 70 75 cb_version when using the changebar package this holds a version identifier set by the cbversion command s cras ssaa 06 4 Gee ae eee Reda eee eee ee 31 dd directory delimiter set automatically
105. establishes the hyperlink to the Index marked by and provides the label to create the target in the Glossary for any glossary command having the corresponding argument 36 4 Hypertext Extensions to BTpxX This section describes how you can define hypertext entries in your HTML documents from within your BTFX source as well as other effects available in HTML for which there need be no direct TFX analog for a printed document These are implemented as new PTFX commands which have special meaning during the translation by JATRX2HTML into HTML but are mostly ignored when processed by ATEX The new commands described in the sections below are defined mainly in the html pack age with PT EX definitions in the file html sty which is part of the ATRX2HTML distribution It must be included in any IATRX document using these features by one of the following methods e including html as an optional argument to documentstyle in E TRX 2 09 e including html1 in a TFX 2 usepackage command It is not sufficient to load the style file via an input or include command such as input html sty This will load the required definitions for AT X but will not load the html perl1 package file for BTFX2HTML Warning Some of these features but not all are also available with TFX 2 09 Users of FATRX2HTML are strongly advised to upgrade their ATEX installations to ATEX 2e Several new environments are defined in particular for spe
106. ex2html no_reuse no_images test tex This is LaTeX2HTML Version 95 Tue Nov 29 1994 by Nikos Drakos Computer Based Learning Unit University of Leeds OPENING tmp_mnt home cblelca nikos tmp test tex Cannot create directory usr cblelca nikos tmp test File exists r Reuse the images in the old directory OR d DELETE usr cblelca nikos tmp test AND ITS CONTENTS OR q Quit id Reading Processing macros Reading test aux 2 eee eee eee eee Translating 0 1 a alee Writing image file Doing section links Fo WARNINGS RRR Rx If you are having problems displaying the correct images with Mosaic try selecting Flush Image Cache from Options in the menu bar and then reload the HTML file Done Then try to have a look in the file images tex as described earlier and perhaps fix it Once you are happy that images tex is OK run ATPX2HTML again with the option images_only 87 Some problems in displaying the correct inlined images may be due to the image caching mechanisms of your browser With some browsers a simple Reload Current Document will be enough to refresh the images but with others e g Mosaic you may need to request for the cache to be refreshed With Mosaic try selecting Flush Image Cache from Options in the menu bar and then reload the HTML file It cannot do slides memos etc If you use SliT X you can go a long way just by replacing
107. f tables from other segments are to be read index Index information from other segments is to be read images Allows images generated in other segments to be reused with the current segment Note If extensive indexing is to be used then it is advisable to keep each lt prefiz gt quite short This is because the hyper links in the index have text strings constructed from this lt prefix gt when using the makeidx package Having long names with multiply indexed items results in an extremely inelegant cumbersome index See Section 3 8 for more details startdocument The begin document and end document statements are contained in the parent segment only It follows that the child segments cannot be processed separately by ATRX without modification However they can be processed separately by IATRX2HTML provided it is told where the end of the ATRX preamble is this is the function of the startdocument directive It substitutes for begin document in child segments but is otherwise ignored by both A TpX and ET RX2HTML htmlhead lt sec type gt lt heading gt This command is generated automatically by a segment command It is not normally placed in the document at all instead it facilitates information being passed from parent to child via the lt file gt ptr file It identifies to ATRX2HTML that the current segment is a JATPX sectional unit of type lt sec type gt with the specified heading This command is ignored by TEX From
108. f the child links on or from a page is generated automatically by ATR X2HTML However if this command or its variant tableofchildlinks occurs within the source code to appear on a particular HTML page then the child links table will be placed at that point where the command occurs Normally a break tag lt BR gt is inserted to separate the table of child links from the surrounding text The tableofchildlinks omits this extra break when it would result in too much space above the table For example throughout this section of the HTML version of the manual all subsections in which several explicit commands have been discussed have their child links table placed at the top of the page using tableofchildlinks This helps to quickly find the description of how the commands are used htmlinfo Normally an About this document page is created at the end of the HTML document containing technical information about how the document was created by whom or any other information contained in the INFO variable This information can be made to appear at any other place within the document by specifying htmlinfo at the desired place in the source For example the information may be best suited for the title page The variant htmlinfo places the information but leaves out the standard About this document header Instead the htmlhead command can be used to place an alternative heading prior to the htmlinfo command Neither this h
109. f the makeimage environment on page 47 external_file lt filename gt Same as setting EXTERNALFILE lt filename gt Specifies the prefix of the aux file that this document should read The aux extension will be appended to this prefix to get the complete filename with directory path if needed This file could contain necessary information regarding citations figure table and section numbers from BT X and perhaps other information also Use of this switch is vital for document segments processed separately and linked to appear as if generated from a single ATEX document font_size lt size gt Same as setting FONT_SIZE lt size gt This option provides better control over the font size of environments made into images using ATEX lt size gt must be one of the font sizes that ATPX recognizes i e 10pt 11ipt 12pt etc Default is 10pt or whatever option may have been specified on the documentclass or documentstyle line Whatever size is selected it will be magnified by the installation variables MATH_SCALE_FACTOR F IGURE_SCALE_FACTOR and DISP_SCALE_FACTOR as appropriate Note This switch provides no control over the size of text on the HTML pages Such control is subject entirely to the user s choices of settings for the browser windows scalable_fonts Same as setting SCALABLE FONTS 1 This is used when scalable fonts such as PostScript versions of the TeX fonts are availa
110. feature is provided to obtain a more compact Index Use of the command line option short_index causes a codified representation of the sectioning to be used rather than the full section name The differences are as follows e For example 2 1 means sub node 1 of node 2 viewing the entire document as a tree like structure e The top most node is simply denoted e With a segmented document each segment is codified separately using the lt prefiz gt supplied for that segment The Index includes a legend of these prefixes each giving the title of the leading page from the segment as a hyperlink to the place on that page where its child links are displayed e Hyperlinks start on the same line as the index key rather than the next line separated by This gives further compactification for easier browsing e If prefix lt prefix gt has been specified then the lt prefiz gt is prepended to the codified form This is most useful for segmented documents Now the top most node is indicated by the bare lt prefiz gt These features can also be obtained by setting the variable SHORT_INDEX to have value 1 in a configuration or initialisation file provided of course that the document loads the makeidx package 3 8 1 Integrated Glossary and Index A large number of different pieces of software are required to make JATRX2HTML work effec tively as well as many files containing data or code to wo
111. fect as htmladdnormallink However when processed by TFX it places the URL as a footnote Warning The tilde character is commonly used within hyperlink URLs It is a quirk of TFX and FTRX that it must be generated via else the will be interpreted as an accent on the following character 4 2 Including Arbitrary HTML Mark up and Comments BETEX2HTML provides the ability to include raw HTML tags and text within the HTML version of a document without requiring corresponding material for the ATEX typeset version This ability can be used to e include HTML markup for effects that have no corresponding concept within a ATEX typeset document see the following example e take advantage of new HTML facilities as soon as they become available and there are browsers capable of displaying them e include arbitrary SGML like markup for use with special browsers that know how to sensibly handle the resulting files begin rawhtml The simplest way to include raw HTML tags and or text is by using the rawhtml environment An alternative way is to use the HTML command described in Section 4 3 which allows macros to be expanded to give the required tags attributes and contents Note the warning on page 37 concerning how the environment delimiters should be used in the JATFX source code A particularly good use of the rawhtml environment is in the creation of interactive electronic forms from within a ATEX document When producing th
112. ffective the htmlimage command and its options must be placed inside the environment on which it will operate Environments for alignment and changing the font size do not generate images of their contents Any htmlimage command may affect the surrounding environment instead e g within a table or figure environment but does not apply to a minipage When the htmlimage command occurs in an inappropriate place the following message is printed among the warnings at the end of processing The actual command is shown with its argument also the environment name and identifying number if there is one 23 The command htmlimage is only effective inside an environment which may generate an image e g figure equation center92 htmlimage 3 4 1 An Embedded Image Example The effect of the HTRX commands below can be seen in the thumbnail sketch of Figure 2 A 5pt border has also been added around the thumbnail using htmlborder command this gives a pseudo 3D effect in some browsers begin figure htmlimage thumbnail 0 5 htmlborder 5 centering includegraphics width 5in psfiles figure ps latex addtocounter footnote 1 caption A sample figure showing part of a page generated by latextohtml containing a customised navigation panel from the htmladdnormallink CSEP project latex protect footnotemark http csep1 phy ornl gov csep html label fig example end figure latex footnotetext http
113. finition which is ignored by ATEX e Next the words phrases or technical terms to be included in the Glossary are marked in the main text using the glossary command used indirectly via other macros For example file names are inserted via fn html sty fn dvips appl dvips etc which both insert the text and create the glossary entry viz newcommand fn 1 htmlref texttt 1 GGG 1 glossary 1 newcommand app1 1 htmlref texts1 1 GGG 1 Glossary 1 texts1 1 e The expansions of glossary and the slightly more general Glossary are different for the printed and HTML versions For the HTML version the following definitions occur within an htmlonly environment def glossary 1 index 1 texttt 1 label II1 1 htmlref G GGG 1 def Glossary 1 2 index 10 2 label II1 1 htmlref G GGG 1 def makeglossary while in TEX we need only newcommand Glossary 2 glossary 1 2 Notice how the feature of makeidx allowing the printable portion to be separate from the sorting key is used to allow text styles to be included within both index entries and glossary entries Indeed the purpose of Glossary is to allow deviations from a fixed style e g newcommand MF htmlref textsl1 Metafont GGGmetafont Glossary metafont textsl Metafont Also notice that in the HTML version an index entry is created that includes within its printable portion both a label and a hyp
114. h a file exists in the local directory or in the styles directory it typically contains Perl code to define subroutines or set values for variables that will affect how certain translations are performed There can be code that is executed only for specific document classes Since the files for class options are loaded after those for the document class it is pos sible for the lt option gt per1 file to contain code that overrides settings made within the document class file If a file named lt class gt _ lt option gt perl happens to exist for a given combination of document class lt class gt and class option lt option gt then this will be loaded When such a file exists reading and executing its contents is done rather than executing any lt class gt _ lt option gt specific information that may be contained in lt class gt perl or lt option gt perl Currently there are no special option or class option files provided with the ATRX2HTML distribution It is hoped that users will identify ways that specific features can be improved or adapted to specific classes of documents and will write such files themselves perhaps submitting them for general distribution Note This mechanism for handling code specific to different document classes and class options is more general than that employed by ATEX 2e New options can be defined for document classes generally or for specific classes without the need to have corresponding sty or
115. h environments sasits urrad eiii cee ee eee 19 22 66 75 76 89 MAX_LINK DEPTH number of depth levels for which child links are displayed within the mini table of contents on each page 2 eee 64 MAX_SPLIT DEPTH sectioning level at and below which creating a new HTML page ceases tO OGGUN e e4 54 44 e8 eee edad he oe ead obese he ad ak eee eed 64 80 METAFONTDPI dots per inch required when Metafont is called to generate a font 73 NAV_BORDER when set holds the width in pt of a border for navigation buttons 74 NETSCAPE_HTML when set will allow HTML extensions understood by Netscape to be used GG TADES p hua kee ution base als ee a hee Read Goin eee gee oko Sade BES 75 NEXT when navigation panels are created this holds a hyperlink to the next HTML page 79 NEXT_GROUP when navigation panels are created this holds a hyperlink to the next HTML page at the same level or shallower 200000 cece eee 79 NEXT_GROUP_TITLE when navigation panels are created this holds the title of the next HTML page at the same section level or shallower 1 0 0 0 0 00 eee ue 79 91 NEXT_PAGE_IN_NAVIGATION when set an iconic link to the next logical page is placed in navigation panels unless overridden by NO_NAVIGATION being set also 70 NEXT_TITLE when navigation panels are created this holds the title of the next HTML DOBRO ses 6 p6ece Sin hae aoa hd eae oe Sad Dei ee Reb en eS ee ae 79 NOFORK when set prevent t
116. hangebar sty package written by Johannes Braams JLBraams cistron nl for inserting change bars in a document in order to indicate differ ences from previous versions This is a very primitive form of version control and there is much scope for improvement Within the EATRX version of this manual two thicknesses of change bar have been used Thicker bars indicate changes introduced with version v97 1 while thinner bars indicate earlier additions since v96 1 Within the HTML version the change bars clearly indicate the different revisions with explicit numbering Within the HTML version the graphic icons representing the changebars can be followed by some text indicating the new version This is used repeatedly throughout the online version of this manual It is achieved using the command cbversion lt version gt immediately following the begin changebar This sets a variable cb_version to be used both at the beginning and end of the environment The value of this variable is retained to be used with other changebar environments unless changed explicitly by another occurrence of cb_version Warning FTRX2HTML will not correctly process changebar environments that contain sectioning commands even when the sub sections or sub paragraphs are to occur on the same HTML page If this is required use a separate changebar environment within each sub section or sub paragraph 31 3 8 Indexing ETEX2HTML automatically produces an Index consist
117. he latex2html init file as input to the process_commands_in_tex subroutine The format is the same as that for specifying com mands to be ignored Here is an example amp process_commands_in_tex lt lt _RAW_ARG_CMDS_ fbox framebox lt add your commands here gt _RAW_ARG_CMDS_ 5 3 3 Handling order sensitive Commands Some commands need to be passed to ATEX but using the amp sprocess_commands_in_tex sub routine gives incorrect results This may occur when the command is order sensitive using information such as the value of a counter or a boolean expression or perhaps requiring a box to have been constructed and saved Try using the amp process_commands_inline_in_tex subroutine instead Commands declared this way are first wrapped within a dummy environment which ensures that they are later processed in correct order with other envi ronments and order sensitive commands Other commands may need to be passed to ATEX not to create an image themselves but to affect the way subsequent images are created For example a color command such as color red should set the text colour to red for all subsequent text and images This must be sent to ATEX so that it is processed at exactly the right time i e before the first image required to be red but following any images that are not intended to be affected by this colour change The subroutine process_commands_nowrap_in_tex is designed
118. he HTML version the text will be hyperized pointing to the label In the paper version the text will be shown as it is and the label will be ignored e g With verb htmlref htmlref it s easy to make links fig example which produces With htmlref it s easy to make links In the HTML version it is shown as With htmlref it s easy to make links 4 6 Hypertext Links in Bibliographic References Citations If a report or a book that is cited using the cite command is available or there is information about it on the World Wide Web then it is possible to add the appropriate hypertext links in your bibliographic database the bib file Here is an example of a bibliographic entry for the original TRX 1 blue book string tugURL htmladdnormallink http www tug org http www tug org string danteURL htmladdnormallink http www dante de http www dante de book lamp latex title LaTeX User s Guide amp Reference Manual 2nd edition year 1994 author Leslie Lamport Publisher Addison Wesley Publishing Company Inc note Online information on TeX and LaTeX is available at tugURL and danteURL See the bibliography for how this will appear No other modifications are required ATEX and BibT X should work as normal Note that it would be sensible to put the string commands into a separate file urls bib say loaded with the main file via bibl
119. he message should contain the name of environment which caused the problem along with an identifying number e g eqnarray268 To find which exact piece of code this represents run A TRX2HTML again using the debug switch Then look at the files in the TMP subdirectory of the working directory named TMP part001 TMP part002 etc Use the unix grep command grep 268 lt dir gt TMP part to find that number in these files This should enable you to locate exactly where the problem occurs One solution may be to wrap the whole environment within begin makeimage and end makeimage This will still cause the image to be created but uses just the environment name and number as the database key The verb ABC command doesn t work This is an unfortunate bug which can be avoided by using any character other than quotes e g verbt ABC Cannot get the tilde to show The trick here is to use V Alternatively try using something like htmladdnormallink mylink http host 7Eme path file html Warning Some browsers may not be able to interpret the 47E as a tilde character Try using char126 In any case tildes within htmladdnormallink and similar commands should be handled correctly Macro definitions don t work correctly As mentioned in other places not all plain TEX def initions can be converted But you may also have problems even when using FATpX definitions with newcommand and newenvironment if s
120. he near future using MathML See also Section 3 3 for a discussion the the mechanisms available with ATRX2HTML for handling mathematical equations and expressions Internationalisation LANGUAGE_TITLES french will cause ATRX2HTML to produce Table des mati res instead of Table of Contents Furthermore the value of the today command is presented in a format customary in that language 15 Languages currently supported are finnish french english german and spanish It is trivial to add support for another language by creating a file in the styles subdirectory or by adding to the file latex2html config As a guide here is the entry for French titles sub french_titles toc_title Table des mati eres lof_title Liste des figures lot_title Liste des tableaux idx_title Index ref_title R ef erences bib_title R ef erences abs_title R esum e app_title Annexe pre_title Pr eface fig_name Figure tab_name Tableau part_name Partie prf_name Preuve child_name Sous sections info_title Apropos de ce document Month janvier f evrier mars avril mai juin juillet ao ut septembre octobre novembre d ecembre GENERIC_WORDS alau aux mais oulet donc or nil car 1 lalle les lclcelceslun u
121. he specified sectioning command is executed 2 EXTRX will write its section and equation counters into an auxiliary file named lt file gt ptr It will also write an htmlhead command to this file This informa tion will tell AT X2HTML how to initialise itself for the new document segment 46This feature is supported only for users of IATFX 2e 56 3 ETRX will then proceed to input and process the file lt file gt tex The segment and segment commands are ignored by AATRX2HTML internal lt type gt lt prefiz gt This command directs TeX 2HTML to load inter segment information of type lt type gt from the file lt prefix gt lt type gt pl Each program seg ment must be associated with a unique filename prefix specified either through a command line option or through the installation variable AUTO_PREFIX The infor mation lt type gt must be one of the following internals This is the default type which need not be given It specifies that the internal labels from the designated segment are to be input and made available to the current segment contents The table of contents information from designated segment are to be made available to the current segment sections Sectioning information is to be read in Note that the segment contain ing the table of contents requires both contents and sections information from all other program segments figure Lists of figures from other segments are to be read table Lists o
122. he tedium of repetitious use of tags and ensure that all ap propriate tags are correctly closed e What determines the amount of information that goes onto a single HTML page How are different pages linked The HTML pages can contain whole chapters sections sub subsections or sub paragraphs This is fully customisable using the command line options discussed in detail in Section 5 2 of this manual e Does the original document have to be a valid ATRX document typesetting without errors If not does it help if it is In fact any document can be fed to the ATFX2HTML processor but it is designed specifically to recognise and sensibly translate the intentions expressed by ATfX markup commands Although sensible results can be obtained even when the ATX source is not valid the most reliable translations are obtained when it is Relevant issues are discussed in Section 5 1 e When developing a document which contains special HTML features is it best to regularly test it in BATpX or with FATRX2HTML The answer to such a question changes as the developer gains more experience with the available tools Some aspects to be considered are discussed in Section 5 1 of this manual Information relevant to obtaining the latest version of AXTRX2HTML installation within the local environment and where to look for help when things do not go as expected can be found in Section 2 1 What follows next is a brief summary of the features supported
123. he translator to crash if your operating system does not support forking a saa ede edani ede te ede mdaewe decides dehaakes as A 67 NOLATEX when set no image generation is performed but a text string is placed this is no longer needed a sawa aTa KEE ee ek eee Re ee Oe 68 NO_AUTO_LINK if set the second copy of the HTML file specified in LINKPOINT is not created with the name given in LINKNAME this allows a URL to a directory name to reach the main HTML page tetada tir eee eee eee 64 74 NO_FOOTNODE if set footnotes will appear at the bottom of the current HTML page rather than on a separate page for footnotes only 2 0 0 0 eee eee 67 NO_IMAGES if set the images tex file is generated but not processed to create images 68 NO_NAVIGATION when set no navigation panels are placed on HTML pages 70 89 92 93 NO_SIMPLE_MATH when set inhibits the use of simple math unless the math exten sion is loaded in which case TpXlike parsing is used creating images of sub parts of expressions as needed 1 0 ee eee ee 18 66 NO_SUBDIR when set the HTML files and images will be placed in the current directory rather than a sub directory reis 0 0 00 ee ee eee 63 NUMBERED_FOOTNOTES numbers your footnotes when defined 67 PAPERSIZE controls the maximum size for large images constructed by TFX on a single PAGE sb Slat tastes wash de ar te wae ees de ee RG aoe ae fees ek Gang Ge nde ee ae ed 76
124. here are several related mechanisms whereby a user can ask for particular commands and their arguments to be either e ignored via amp ignore_commands e passed on to JATRX for processing as an image via amp process_commands_in_tex passed to ATEX for processing as an image as if an environment via amp process_commands_inline_in_tex e passed on to FATRX setting parameters to be used in subsequent images via amp process_commands_nowrap _in_tex e processed as order sensitive as if an environment rather than a command via amp process_commands_wrap_deferred The string beginning amp is the name of the Perl subroutine that controls how the ETFX commands are to be subsequently treated during processing by ATfX2HTML Towards the end of the latex2htm1 script one finds a list of ATFX commands to be handled by each of these subroutines These lists even include some common TEX commands Analogous lists occur in most of the package extension files In many cases the com mands are for fine tuning the layout on a printed page They should simply be ignored but any parameters must not be allowed to cause unwanted characters to appear on the HTML pages Customised extensions using these mechanisms may be included in the LATEX2HTMLDIR latex2html config file or in a personal HOME latex2html init ini tialisation file as described next 5 3 1 Asking the Translator to Ignore Commands Commands that should be
125. his is inherent to the way FXTRX2HTML does its processing It will not be different unless later versions change this strategy e g if IATEX2HTML NG ever becomes fully integrated Math mode font size changes Math mode font changes made outside the math mode are not honoured Thus the two equations in a_b and LARGE a_b would come out looking the same The trick is to write a_b and mbox LARGE a_b 6 1 Troubleshooting Here are some curable symptoms Cannot run any of the Perl programs If your Per installation is such that Perl pro grams are not allowed to run as shell scripts you may be unable to run latex2htm1 texexpand pstoimg and install test In this case change the first line in each of these programs from usr local bin perl 81 to per eval exec perl S 0 0 if running_under_some_shell The install test script gives uninformative error messages If for any reason you have trouble running install test do not despair Most of what it does is to do with checking your installation rather than actually installing anything To doa manual installation just change the variable LATEX2HTMLDIR in the beginning of the file latex2html to point to the directory where the ATFX2HTML files can be found Also make sure that the files pstoimg texexpand and latex2htm1 are executable if necessary use the Unix chmod command to make them executable It just stops Check the style files that you ar
126. ht 1996 1999 All rights reserved Year 2000 compliance TATRX2HTML contains no executable software per se It consists entirely of scripts to run other pieces of software Perl BTEX Ghostscript netpbm etc and standard Unix utilities e g cp rm make 1n as well as the operating system shell These other pieces of software are to be obtained and installed independent from the ETEX2HTML scripts ETFX2HTML makes no reference to dates apart from reading the current date from the operating system and converting the resulting string data into a standard form This may result in 00 appearing in the year 2000 However this representation of the date is used for display only it does not control any further processing Contents 1 Overview 1 1 1 2 List of Features y sa 4 SA ee he awe we Sk eee he wae BES Exemplary Documents ecciesia i arge e e E E E e ak a Y e a a i 2 Installation and Further Support 2 1 2 2 3 1 3 2 3 3 3 4 3 5 3 7 3 8 4 1 4 2 4 3 4 4 4 5 4 6 4 7 4 8 4 9 4 10 Getting BTEX2HTML a bf eae od eA ka eee ea E EES 2 1 1 Requirements sana vane ee ee a Pe ee ee ae a a 2 1 2 Installing BTRXQHTML i aa gokke es Getting Support and More Information 04 Environments and Special Features Variation with HTML Versions 0 0 00 0000 00000000084 Internationalisation s toi aose ga opp a ee 3 2 1 Alternate Font Encodings o oaoa a 3 2 2 Mul
127. htmlonly environment Problems after changing the configuration files Please make sure that the last line in the configuration files i e latex2html init and latex2htm1 config is 1 This is the last line This is a Perl quirk Problems when producing the dvi version If you are using any of the new PT X commands which are defined in the html sty file make sure that html sty is included e g as one of the optional arguments to the documentclass command Of course you also have to make sure that TFX knows where the htm1 sty file is either by putting it in the same place as the other style files on your system or by changing your TEXINPUTS shell environment variable 4 Some of the fonts are translated incorrectly There is a fault in way the DTRX scop ing rules have been interpreted in ATRX2HTML Consider this ttfamily fixed width font begin something nothing here end something default font When processed by ATEX the effect of the tt command is delimited by the beginning of the environment something so that default font will appear in the default font But ETRX2HTML will not recognise something as a delimiter and default font will appear in the wrong font To avoid this problem until it is fixed you may delimit the scope of some commands explicitly using s i e texttt fixed width font begin something nothing here end something default font 49Tf you don t
128. i version 12 filename data 12 graphics 12 images 12 index and glossary 12 input files 12 requirements 12 style files 12 test of installation 12 using makeindex 12 without makeindex 12 draft mode 68 Drakos Nikos vi vii 1 88 dvips version 8 101 E electronic forms 41 Zend latexonly 46 enumerate package 29 environment equation 25 alltt 29 arbitrary 26 comment 42 eqnarray 25 figure 24 floatingfigure 31 hthtml 29 htmllist 29 30 htmlonly 45 imagesonly 47 latexonly 45 makeimage 47 minipage 27 rawhtml 41 table 26 table 26 theorem like 3 wrapfigure 31 environments 14 old A yS style use discouraged 40 epsbox package 29 epsfig package 29 eqnarray environment 21 25 example 19 equation environment 21 equations alignment 2 22 array 19 25 inlined 2 numbered 2 19 right justified 2 19 error checking missing braces 62 unmatched brace 62 using ATEX 61 extended markup XML ix extension options 16 extensions 65 80 definitions 81 disabled 65 examples 29 hypertext 37 102 in initialisation file 77 in style files 3 languages 15 new environments 3 new theorems 3 require understanding of Perl 30 TeXdefinitions 65 extensions new commands 3 external references 50 51 externalcite 51 externallabels 50 externalref 50 51 extra scaling of images 22 F Fachbereich Informatik Darmstadt vi featu
129. ibility and other features developed at CERN Herb Swan for coordinating v96 1 of ATRX2HTML including much of the Perl code for the new features that were introduced and for providing a series of bug fix revisions prior to v96 1 rev f Ross Moore who has revised and extended this manual helped design and test the seg mentation strategy and later revisions of v96 1 Ross organised the release of v96 1 rev g and provided many of the improvements incorporated into v96 1 rev h Martin Wilck for the initial work on implementation of frames Also Martin did most of the work implementing the extensive citation and bibliographic features of the natbib package written by Patrick Daly He also provided the makeseg Per script to create Makefiles for segmented documents Jens Lippmann for organising the releases V96 1 rev h to v98 1 Jens made significant contributions to the internal workings of ATRX2HTML as well as cleaning up much of its source code Many others too many to mention contributed bug reports fixes and other suggestions Thanks also to Donald Arseneau for allowing his url sty to be distributed with this manual Similarly thanks to Johannes Braams for changebar sty Both of these are useful utilities which enhance the appearance of the printed manual In particular changes introduced with v98 1 and its revisions are denoted by thin change bars while thicker bars denote changes introduced with v98 2 and later releases iii
130. igation appends a button to the navigation panels ignored in ATEX bodytext allows the contents of the lt BODY gt tag to be set explicitly for the current and subsequent HTML pages ignored in ATEX htmlbody allows an attribute to be added or changed within the lt BODY gt tag of HTML ignored in PTX htmlbase Allows a URL to be specified within the lt BASE gt tag for all the HTML pages produced ignored in BTEX htmltracing lt level gt specifies that extra tracing messages be generated according to the lt level gt ignored in ATX See page 71 for levels of verbosity htmltracenv lt level gt same as htmltracing except that this command is evaluated in sequence with environments ignored in ATRX See also page 71 HTMLset programmer s device allowing an arbitrary Perl variable to be set or changed dynamically during the ATEX2HTML processing ignored in ATEX 39 HTMLsetenv Same as the preceding HTMLset command except that this one is processed in order as if it were an environment ignored in ATEX Most of the new environments listed above can also be used with delimiter macros lt enu name gt end lt enu name gt This alternative style which is common with AMS TX is discouraged for general JATRX usage even by the AMS itself in favour of the usual begin lt enu name gt end lt enu name gt markup notation Safety features that are available with the usual begin end mechanism m
131. ignored may be specified in the latex2html init file as input to the amp ignore_commands subroutine Each command which is to be ignored should be on a separate line followed by compulsory or optional argument markers separated by s e g 4 lt cmd_name1 gt O 1 O lt cmd_name2 gt lt lt pattern gt gt 4TTt is possible to add arbitrary Perl code between any of the argument markers which will be executed when the command is processed For this however a basic understanding of how the translator works and of course Per is required 77 s mark compulsory arguments and s optional ones while lt lt pattern gt gt denotes match ing everything up to the indicated string pattern given literally e g endarray spaces are ignored Special characters such as amp itself and perhaps some others need to be escaped with a preceding Some commands may have arguments which should be left as text even though the command should be ignored e g hbox center etc In these cases arguments should be left unspecified Here is an example of how this mechanism may be used amp ignore_commands lt lt _IGNORED_CMDS_ documentstyle linebreak mbox lt add your commands here gt _IGNORED_CMDS_ 5 3 2 Asking the Translator to Pass Commands to ATEX Commands that should be passed on to EXTRX for processing because there is no di rect translation to HTML may be specified in t
132. ikos Drakos What is ATPX2HTML with Xy pic diagrams http www maths mq edu au texdev Xypic L2Htalk German specials in T X http www maths mq edu au texdev tests harn node1 htm1 Crayola Colours http www maths mq edu au ross latex crayola crayola html Manuals Computing Resources Xy pic User s Guide accessible from the Xy pic Home Page or down under 1 LiPS A System for Distributed Processing on Workstations Manual Lecture Notes and various theses LINUX Documentation Project http linuxwww db erau edu ldp linux htm1 Getting Started The LINUX Kernel Network Administrator s Guide Programmer s Guide System Administrator s Guide ECLiPSE The ECRC Constraint Logic Parallel System User Manual Extensions User Manual MPQC Massively Parallel Quantum Chemistry Program User Guide Scientific Computing library Xgraphics http www theorie physik uni wuerzburg de lueders Xgraphics Glish 2 6 User Manual http aips2 nrao edu aipst docs html aips html UTCC University of Tennessee Computing Center 10http cbl leeds ac uk nikos tex2html doc latex2html latex2html html http www brics dk krisrose Xy pic html http www maths mq edu au texdev xyguide html 3http cde server cdc informatik tu darmstadt de M4http www ecrc de eclipse eclipse html 15 http midway ca sandia gov cljanss mpqc html 6http midway ca sandia gov cljanss mpqc prog prog html Thttp ww
133. ine option 4 10 1 A Segmentation Example The best way to illustrate document segmentation is through a simple example Suppose that a document is to be segmented into one parent and two child segments Let the parent segment be report tex and the the two child segments be sec1 tex and sec2 tex The latter are translated with filename prefixes of si and s2 respectively This example is included with recent distributions of ATRX2HTML having more prolific comments than are shown here The text of report tex is as follows documentclass article Must use LaTeX 2e usepackagefhtml makeidx color internal figure s1 Include internal information internal figure s2 4 from children internal sections si internal sections s2 internal contents si internal contents s2 internal index si internal index s2 begin document 4 The start of the document title A Segmentation Example date today maketitle tableofcontents listoffigures Process the child segments segment seci section Section 1 title segment sec2 section Section 2 title printindex end document This file obtains the information necessary to build an index a table of contents and a list of figures from the child segments It then proceeds to typeset these The first child segment seci1 tex is as follows begin htmlonly documentclass article usepackagefhtml color makeidx input s
134. ing of the arguments to all index commands encountered if there are any A hyperlink is created to that point in the text where the index command occurred More sophisticated indexing is available by loading the makeidx package Most of the features described in 1 Appendix A become available This includes styled entries using Entries of the form index lt sort key gt lt styled text gt produce lt styled tezt gt as the entry but sorted according to lt sort key gt hierarchical entries using Entries of the form index lt item gt lt sub item gt set the lt sub item gt indented below the lt item gt Unlimited levels of hierarchy are possi ble even though EXTRX is limited to only 3 levels The lt sort key gt lt styled tezxt gt can be used at each level explicit ranges using C and This is perhaps more useful in the JATRX version In the HTML version these simply insert words from and to respectively prior to the hyperlink to where the index entry occurs see lt indexz entry gt provides a textual reference to another indexed word or phrase by inserting the word see This can be used in conjunction with htmlref to create a hyperlink to the lt index entry gt viz index latexe LaTeXe see htmlref LaTeX IIIlatex where a label has been specified in some other index entry as follows index latex LaTeX label IIIlatex lemph is handled correctly
135. ink to table of contents 70 next logical page 70 106 number of words 80 optional 2 order of buttons 79 Perl subroutines 79 previous logical page 70 section titles 79 textual links 79 NCSA image map server 11 55 NCSA Mosaic see browser Nelson Scott vii Netscape Navigator see browser HTML3 Tables 15 new commands arguments remain 77 78 command ignored 77 ignore arguments 77 order sensitive 78 processed in TEX 78 processed in ATEX 78 order sensitive 78 nonumber 21 Noworolski Mark iii numbered equations 19 O Ogawa Art 13 Olson Bob ii 13 options 62 72 command line options 61 defining temp directory 71 environment variables 62 extensions 65 file names 63 print option listing 71 sectioning 63 set in initialisation file 62 special features 65 titles 63 options 62 order sensitive setting parameters 78 wrap deferred 78 output default directory 63 in current directory 63 redirect to directory 63 overview 1 P portability package Unix systems v amsfonts 29 printing 62 amsmath 29 hyperlink to typeset version 62 amssymb 29 problems 81 88 amstex 29 babel 29 R changebar 29 Ramge Axel v vii ix chemsym 29 rawhtml 42 color 29 rawhtml environment 41 colordvi 29 rawhtml environment enumerate 29 example 41 epsbox 29 references epsfig 29 between documents 3 finnish 29 bibliographic 49 floatfig 29 collaboration required 52 floatflt 29 document
136. iography urls For those who use the Harvard style for references there exists a special conversion add on package The natbib package written for TFX by Patrick Daly provides even more flexibility in the way a reference may be cited All the features of this package are implemented for BETFX2HTML via the natbib perl file Indeed there is even a mode whereby natbib handles the Harvard style of citation This requires loading also the nharvard package Thanks to Martin Wilck for the bulk of the work in producing this extension and to Ross Moore for necessary adjustments to allow it to work correctly with the document segmentation strategy 40http www arch su edu au peterw latex harvard 49 hypercite Analogous to hyperref is the hypercite command which allows a free form textual hyperlink to the bibliography whereas the BTFX typeset version contains the usual citation code The allowed syntax is as follows hypercite int lt HITML text gt lt LaTeX text gt lt opt LaTeX gt lt label gt hypercite cite lt HIML teat gt lt LaTeX text gt lt opt LaTeX gt lt label gt hypercite lt HIML text gt lt LaTeX text gt lt opt LaTeX gt lt label gt hypercite nocite lt HTML teat gt lt LaTex text gt lt label gt hypercite no lt HIML tezrt gt lt LaTeX tezxt gt lt label gt hypercite ext lt HITML text gt lt LaTeX texrt gt lt label gt
137. ion 32 software mentioned within the manual integrated with the Index All occurrences of the technical names can be easily found starting from any other When a single item is indexed many times it is sufficient to have a label command appearing within the printable portion of the first instance of an index command for that item within a single document segment If the index entries are in different segments of a segmented document it is sufficient to have the index label appearing within that segment in which the item is indexed whose indexing information is loaded earliest via a internal index command When in doubt include one index label per segment in which the item is indexed For cross links to work effectively within segmented documents the indexing command index label must occur earlier in the same segment than any use of index htmlref intended to create a link to that label If the label occurs in a different segment then a internal index command for that segment may be needed at the beginning of the segment with the htmlref When this is done incorrectly the resulting link will be to the segment where the indexed item occurred rather than staying within the Index Since use of section names as the text for hyperlinks can lead to a very long and cumber some Index especially when single items have been indexed many times a further
138. isted specifically within the MakeTeXPK script called by dvips to invoke Metafont with the correct parameters for the required fonts LATEX latex Read from latex2html config by install test its value is checked to locate the latex program or script If ATRX is having trouble finding style files and or packages then the default com mand can be prepended with other commands to set environment variables intended to resolve these difficulties e g LATEX setenv TEXINPUTS lt path to search gt latex There are several variables to help control exactly which files are read by TRX2HTML and by PTFX when processing images TEXINPUTS This is normally set from the environment variable of the same name If difficulties occur so that styles and packages are not being found then extra paths can be specified here to resolve these difficulties DONT_INCLUDE This provides a list of filenames and extensions to not include even if requested to do so by an input or include command Consult latex2html config for the default list 73 DO_INCLUDE List of exceptions within the DONT_INCLUDE list These files are to be read if requested by an input or include command ICONSERVER lt URL gt This is used to specify a URL to find the standard icons as used for the navigation buttons Names for the specific images size as well as size informa tion can be found in latex2html config The icons themselves can
139. kground color for a document segment ignored in ATRX The following commands are shorthand forms for some of the conditional environments listed above html for putting small pieces of text into the HTML version only latex for putting small pieces of text into the TEX version only latexhtml puts one piece of text into the ATFX version another into the HTML version The following commands implement effects on the HTML pages for which there is no direct ETEX counterpart Most of these commands are discussed in detail in Section 4 8 HTMLcode a general command for placing raw HTML tags with attributes and contents tags and attributes are ignored in TEX but not the contents See Section 43 htmlrule places a perhaps styled horizontal line on the HTML page ignored in IATRX strikeout places text between lt STRIKE gt lt STRIKE gt tags ignored in JATRX htmlimage used for fine control over the size of individual images and other graphics effects e g making a thumbnail version ignored in BTRX See page 22 for details htmlborder places a border around the contents of an environment but placing the environment as a cell inside a lt TABLE gt ignored in JATRX tableofchildlinks determines where the table of childlinks should be placed on the HTML page ignored in ATEX htmlinfo determines where the About this document ignored in ATEX information should be placed htmladdtonav
140. l not show in your documents If you are getting File Not Found errors then reprocess your job using the debug switch to see what options are passed to dvips If there is a in some parts of any directory name then look above that directory to see if files are being generated there One obvious fix is to rename the offending directory to remove the from its name If that is not possible then define an alternative location for image generation to take place set TMP to contain the name for this location Typically TMP usr tmp This use of TMP is a good thing to do anyway especially if your Unix account is subject to quota limitations It stops after having run PTpX displaying a message about dvips See the pre vious item for the reason and fix This version of ATFX2HTML detects the problem and will not allow images to be generated in the wrong place dvips complains about incorrect arguments Please use a version which supports the command line options M S o and i Recent versions at least after 5 516 do support them It gives an Out of memory message and dies Try splitting your source file into more than one file using the BTFX commands input or include Also try us ing the no_images option Perhaps the processor has fallen into an infinite loop Usually there will be a bad definition or other faulty source code which has caused
141. laced GIFs If Ghostscript or the netpbm library are not available it is still possible to use the translator with the no_images option If you intend to use any of the special features of the translator see page 37 then you have to include the html sty file in any BTRX documents that use them Since 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 lt IMG gt tag such as NCSA Mosaicor Netscape Navigator Any browser which claims to be compatible with HTML 3 2 should meet this requirement If only a character based browser such as lynx is available or if you want the generated documents to be more portable then the translator can be used with the ascii mode option see Section 5 2 3 2 1 2 Installing ATX 2HTML To install ATRX2HTML you MUST do the following 30http melmac corp harris com transparent_images html Sletp ftp uni stuttgart de pub comm infosystems www tools imaging giftrans giftrans 1 11 1 tar gz 1 Specify where Per is on your system In each of the files latex2html texexpand pstoimg install test and makemap modify the first line saying where Per is on your system Some system administrators do not allow Perl programs to run as shell scripts This means that you may not be able to run any of the above programs In this case change the first line in each of these programs from usr local bin perl to
142. le styles for CitatiOns 4 41 ww ata a hee EA PO eed aye Cee Ra ee a awa eae 49 NCSA National Center for Supercomputing Applications located at University of Illinois at Urbana Champaign c0 004 ete ae eee bee dee hee eee 55 NCSA Mosaic Web browser freely available for most platforms 61 NDBM alternative Database Management utility for Unix 8 83 84 netpbm suite of Unix graphics utilities alternative to pbmplus x 8 9 Netscape Navigator popular Web browser commercially available for most platforms and free to academic institutions 0 00000 eee 9 15 61 Override pm Perl input file for operating system specific constructs like directory delim iter getenv setenv and other system calls and quirks vii 93 overview tex input file for a section of the ATRX2HTML manual contains a brief summary of FAT RX2HTML s capabilities 2 2 diray dries enata da dieedid 12 pbmmake Unix graphics utility which creates rectangles of a single color as a bitmapped CRAPNIC gone esia i gob sew ase eda A el Gee s a ge eg ae C9 Bek Gee eS 92 http www ncsa uiuc edu SDG Software Mosaic Docs help about html 56 ftp ftp x org contrib utilities 57 http home netscape com 97 pbmplus suite of Unix graphics utilities 0 ees 9 97 Perl the Unix program which interprets ATBX2HTML and orchestrates the whole con VETSION protes sroda nEri hoa aa eked Pek
143. lip graphics utility The most useful of these include rotate90 or r90 This will rotate the image clockwise by 90 rotate270 or r270 This will rotate the image counterclockwise by 90 leftright This will flip the image around a vertical axis of rotation topbottom This will flip the image around a horizontal axis of rotation 22 align lt alignment gt specifies how the figure will be aligned The choices are top bottom middle left right and center The middle option specifies that the image is to be left justified in the line but centered vertically The center option specifies that it should also be centered hor izontally This option is valid only if the HTML version is 3 0 or higher The default alignment is bottom transparent no_transparent or notransparent specify that a transparent background should not be used with this image regardless of the normal behaviour for similar images antialias no_antialias or noantialias specify that anti aliasing should not be used with this image regardless of the normal behaviour for similar images extrascale lt scale factor gt is used mainly used with a lt scale factor gt of 1 5 or 2 when it is important to get printed versions of the completed HTML pages The image is created scaled by the amount specified but it is embedded in the HTML page with attributes to the
144. lt B gt UP_TITLE n undef and the previous title PREVIOUS_TITLE n lt B gt Previous lt B gt PREVIOUS_TITLE n undef Note that extra buttons may be included by defining suitable code for the container CUSTOM BUTTONS The use of explicit newline n characters is not necessary for the on screen appearance of the navigation panel within a browser window However it main tains an orderly organisation within the htm1 files themselves which is helpful if any hand editing is later required or simply to read their contents The corresponding sub routine for a navigation panel at the top of a page need not use the rule lt HR gt and would require a break lt BR gt or two at the end to give some visual separation from the following material 80 6 Known Problems Here are some of the problems that were known to exist with previous versions of ETEX2HTML Most of those that were real errors are either fixed completely in more re cent versions v98 1 and later or are much less likely to occur within correct ATEX source Some are not really errors but indications of poor style in the user s choices among vari ous ways to organise their source code Several are indeed limitations inherent in the way BETEX2HTML currently performs its processing Unrecognised Commands and Environments Unrecognised commands are ignored and any arguments are left in the text Unrecognised environments are passed to
145. mages which are included in the ATFX file It is likely that the macros you are using for including PostScript files e g epsffile are not understood by ATRX2HTML To avoid this problem enclose them in an envi ronment which will be passed to ATRX anyway e g begin figure epsffile lt PostScript file name gt end figure Another reason why this might happen is that your shell environment variable TEXINPUTS may be undefined This is not always fatal but if you have problems you can use full path names for included PostScript files even when the PostScript files are in the same directory as the FTpX source file Alternatively try setting TEXINPUTS to With some TFX and FATRX installations setting TEXINPUTS to may cause problems in the normal operation of MTpxX If you get errors such as ATEX complaining that it can no longer find any style files then you must set TEXINPUTS to lt path to your LaTeX installation gt if you want to use both FATRX and ET RX2HTML Some of the inlined images are in the wrong places There are several known ways that this may occur e Perhaps one of the inlined images is more than a page paper page long This is sometimes the case with very large tables or large PostScript images In this case you can try specifying a larger paper size e g a4 a3 or even a0 instead of the default a5 using the ATRX2HTML variable PAPERSIZE in the file latex2html config
146. mand and can be added to or parts changed using the htmlbody command or color and pagecolor from the color package INTERLACE 1 When set interlaced images should be produced This requires graphics utilities to be available to perform the interlacing operation TRANSPARENTFIGURES 1 When set the background of images should be made trans parent otherwise it is white This requires graphics utilities to be available which can specify the color to be made transparent FIGURE_SCALE FACTOR 1 6 Scale factor applied to all images of figure and other envi ronments when being made into an image Note that this does not apply to recognised mathematics environments which instead use the contents of MATH_SCALE_FACTOR and DISP_SCALE_FACTOR to specify scaling MATH_SCALE_FACTOR 1 6 Scale factor applied to all images of mathematics both inline and displayed A value of 1 4 is a good alternative with anti aliased images DISP_SCALE_FACTOR 1 Extra scale factor applied to images of displayed math environ ments When set this value multiplies MATH_ SCALE_FACTOR to give the total scaling A value of 1 2 is a good choice to accompany MATH_SCALE_FACTOR 1 4 EXTRA_IMAGE_SCALE This may hold an extra scale factor that can be applied to all gener ated images When set it specifies that a scaling of EXTRA_IMAGE_SCALE be applied when images are created but to have their height and width recorded as the un scaled size
147. mn T Pi imn i m iyn T 29 m n ole Oi m 1 n 2 nn en 20 a l m n 1 a l m n 1 Ii mnv 2 The latter example uses an eqnarray environment and the nonumber command to suppress the equation number on the upper line In the on screen version of these equations simple alphabetic characters that are not part of fractions appear in the italiced text font selected using the browser s controls This may appear slightly different from the same symbol being used within a fraction or other mathematical construction requiring an image to be generated This is most apparent with the letter h in the first equation and the subscripts at the end of the second equation By inserting an htmlimage command into a math equation or displaymath environ ment a single image will be created for the whole environment For an eqnarray environment this will lead to having a single separate image for each of the aligned portions The ar gument to htmlimage need not be empty but may contain information which is used to affect characteristics of the resulting image An example of how this is used is given below and a fuller discussion of the allowable options is given in Section 3 4 Scale factors for Mathematics When an image is to be made of a mathematical for mula or expression it is generally made at a larger size than is normally required on a printed page This is to compensate for the reduced resolution of a computer screen com pa
148. n provided py DIRX igea e080 044 2 be ee oa pee ee Se Gaba dee Rhee 66 EXTERNAL_IMAGES when set hyperlinks to the generated images are included on the HTML pages not lt IMG gt tags asc bhai ee be ae Ged de PS ee ee hey 68 EXTERNAL_INDEX specifies the URL for the INDEX button in the navigation panel 71 EXTERNAL_PREV_LINK specifies the URL for the PREVIOUS button in the navigation panel ga herce bb bp eedesd digs oobied doh dseed pb eee eee bed beet ees 70 EXTERNAL_PREV_TITLE specifies the text for the PREVIOUS button hyperlink in the Navigation Panel vo vay ate yw Pee PA ay oA Ro ae Eek AES ae ee 70 EXTERNAL_UP_LINK specifies the URL for the UP button in the navigation panel 70 EXTERNAL_UP_TITLE specifies the text for the UP button hyperlink in the navigation panel i2nervederadhedenedae 2 Gaeeedaectigergiadee gs bbe ei gees 70 EXTN holds the filname suffix for the HTML files to be produced either html or htm 74 EXTRA_IMAGE SCALE when set specifies that images should be created at one size but displayed at another it provides the ratio between these sizes 22 23 75 FIGURE_SCALE FACTOR magnification factor to be used with images of whole figure and table environments 0000 cece eee 21 22 24 66 75 FILE holds the name of the HTML output of the top most page in a document when vital links are to be established 20 annaa aaa 67 74 FOILCLASS The document class that is substituted for foils in the im
149. n information A sample Makefile is included in the distribution This correctly generates the fully linked document The first time it is invoked it runs e latex on report tex twice e dvips to generate report ps e latex2html on seci tex e latex2html on sec2 tex At this point sec2 html is completely linked since the labels from the sec1 were available e latex2html on sec1 tex to pick up the labels from sec2 e latex2html on report tex Proper operation of make depends on the fact that ATRX2HTML updates its own internal label file only if something in its current program segment causes the labels to change from the previous run This ensures that MTRX2HTML is not run unnecessarily It is also usual for the information page to be suppressed by specifying info 0 for all but the top level document In the above example all segments are built within the same sub directory report of the directory containing the AATRX source files This is achieved simply by using the option dir report with each All the images and lt prefix gt lt type gt pl files are created and stored within this directory Sometimes it is desirable to build one or more segments within separate sub directories This is especially so when a segment has a large number of images or if it is required to be part of more than one combined document In this case the dir lt dir gt options can be different or omitted entirely For inter segment referen
150. n processed by AT FX i e in the dvi or ps output files the URL will have no effect But when processed by the translator the URL will be used to provide an active hypertext link to another file picture sound file movie etc e g htmladdnormallink lt JURL gt http www ncsa uiuc edu demoweb url primer html The optional argument to htmladdnormallink allows a name to be specified for the place in the document where the hyperlink occurs This is done via the NAME lt name gt attribute for the lt A gt anchor tag in HTML Such a name can be used as the target for a hyperlink using the htmlref command described in Section 4 5 40 htmladdimg In a similar way the argument of the htmladdimg command should be a URL pointing to an image This URL is ignored in the BT X hard copy output The optional argument to htmladdinmg allows an alignment for the image to be given center right or left In the latter cases the image is bound to the specified side of the browser s window Subsequent text paragraphs flow around the other side of the image In fact any valid set of attributes for the lt IMG gt tag in HTML can be specified as the optional lt align gt parameter In particular the WIDTH HEIGHT and BORDER attributes can be set perhaps overriding the natural size of the image htmladdnormallinkfoot The htmladdnormallinkfoot command takes the same argu ments and when generating HTML has the same ef
151. nature at the end of each page is e how many navigation panels to provide what links to put in them e what other documents this one links to e extra information to include about the document e whether to retain the original JATRX section numbering scheme e and many other things that affect how the information is obtained processed or dis played in the resulting htm1 files and images The ETRX2HTML script includes a short manual which can be viewed with the command nroff man latex2html 5 1 Developing Documents using BTRX2HTML Although any document containing ATEX commands can be translated by the ATRX2HTML translator the best results are obtained when that document is itself a valid ATEX document Indeed it is generally a good idea to develop documents so that they produce good readable results in both the JATRX typeset version as well as a set of HTML pages This is not just a nicety there are several good practical reasons for doing this BTEX macros The macro commands that ATEX2HTML recognises are based upon corre sponding commands for ATEX If one tries to use syntax that is incorrect for ATEX then there is no reason why XT FX2HTML should be able to get it right by somehow recognising the true intent 61 error checking Processing the document first using TRX is the easiest and quickest way to check for valid syntax Whereas TFX stops at each error when run in interac tive mode allowing a fix to be made
152. neld delduldes Notice how the backslash needs to be doubled when a macro is needed for accented charac ters say Also the GENERIC_WORDS are a list of short words to be excluded when filenames are specially requested to be created from section headings In order to provide full sup port for another language you may also replace the navigation buttons which come with FATRX2HTML by default in English with your own As long as the new buttons have the same file names as the old ones there should not be a problem 3 2 1 Alternate Font Encodings ETEX2HTML can interpret input using 8 bit fonts provided it is told which font encoding is being used This can be done by appending an extension option to the html_version command line switch e g latex2html html_version 3 2 latin2 myfile doc declares that any 8 bit characters in the JATRX source within the file myfile doc are to be interpreted according to the ISO 8859 2 ISO Latin2 font encoding rather than the default of ISO 8859 1 ISO Latin1 Furthermore ISO 10646 Unicode entities can be embedded within the output produced by ETpX2HTML For this a further extension option is appended viz latex2html html_version 3 2 latin2 unicode myfile doc declares that the input is ISO Latin2 but that 8 bit characters be output as the correspond ing Unicode number For example e g the Polish L would become amp 321 Otherwise the browser might render
153. nix shell provides support for MTRX2HTML 1 0 2 ee ee 8 DBM Unix Database Management utility 2 0 eee 8 84 dn gif image of a small downward turning arrow 000000055 12 docs subdirectory of LATEX2HTMLDIR containing the ATfX2HTML documentation and a Makefile to control its processing 0 0 eee 7 12 98 docs foilhtml subdirectory of LATEX2HTMLDIR containing an implementation for the FolTEX SySteMt 260444048 Ss Gon duals ak BS eee ee oe eS 7 31 dot latex2html init example initialisation file for ATFX2HTML usually to be found inthe LATEXQHTMLDIR lt 2 sas ce cca onka teeta teioe eave nadawewdeaes 7 41 5lhttp www pvv unit no archie 2 http www w3 org hypertext WWW Arena 3http www cern ch Welcome html 4http www w3 org hypertext WWW TheProject html 94 dvips dvi to PostScript conversion program 8 11 59 63 73 83 85 89 95 97 dvipsk avariantof dvips praias cerae i Ee E A bee a ba baw e a os 8 9 example subdirectory of LATEX2HTMLDIR containing an example illustrating the docu ment segmentation technique 0 0 ce ee 7 features tex input file for a section of the ATRX2HTML manual describes special features available with PTBX2HTML 2 2 eee 12 floatfig sty PATRX 2e package for floating figures with text flowing around 31 foilhtml sty a BT X package that adds structural markup to FoilT X 31 90 foils perl adds Perl code to implement the foils document class
154. nly for users of IATRX 2e xi 14 14 15 16 17 17 24 25 25 26 28 28 30 31 31 32 33 37 40 41 43 45 47 49 50 52 52 55 56 58 5 Customising the Layout of HTML pages 5 1 Developing Documents using ATRX2HTML auaa aa 5 2 Command Line Options secs aqo soa i aa a wae ee 5 2 1 Options controlling Titles File Names and Sectioning 5 2 2 Options controlling Extensions and Special Features 5 2 3 Switches controlling Image Generation 0 5 2 4 Switches controlling Navigation Panels 0 5 2 5 Switches for Linking to other documents 0 5 2 6 Switches for Help and Tracing 2 00 0 5 2 7 Other Configuration Variables without switches 5 3 Extending the Translator 0 0 000 0 02 00 0000 0000 5 3 1 Asking the Translator to Ignore Commands 5 3 2 Asking the Translator to Pass Commands to BTEX 5 3 3 Handling order sensitive Commands 5 4 Customising the 6 Known Problems 6 1 Troubleshooting Navigation Panels 2 00 000 000200 000 Glossary of variables and file names Index xii List of Figures N QD ove w Images of equation displays at normal screen resolution 20 A sample figure showing part of a page generated by ATFX2HTML containing a customised navigation panel from the CSEP project 24 Displayed math environments with e
155. nnsh 15 french 15 german 15 spanish 15 EXTEX FATRX3 vi latex 46 PTFX blue book 3 49 Leslie Lamport 88 EATRX commands 3 embedded 3 not syntactically legal 3 BTEX Companion see The BTRX Companion ETEX Graphics Companion see The ETEX Graphics Companion ETEX Web Companion see The BETEX Web Companion TAT EX 2HTML command for its name 54 latex2html NG v latexhtm1 46 latexonly 42 46 latexonly environment 45 latexsym package 29 latextohtml1 gives JATRX2HTML 54 levels sectioning 65 Igrind package 29 link validation done by hand 52 symbolic labels 52 Lippmann Jens ili iv vi vil 7 LiPS Design Team vi list of figures 3 57 list of tables 3 57 Little Todd ii Livermore California 12 looping endlessly 82 M mailing list Argonne National Labs ii 13 subscribe 13 unsubscribe 13 makeidx package 29 makeimage environment 47 empty sub environment 47 inside a figure 47 makemap 55 manual short on line 61 math 65 66 mathematics markup MathML ix MathML 15 MathML mathematics markup ix mbox command with math generates an image 20 minipage environment 27 Moore Ross iii v vii 1 13 49 54 Mosaic see browser N names of important packages 54 navigation panel 79 80 according to number of words 70 at bottom of page 70 at top of page 70 buttons 79 customisable 2 79 customised buttons 79 disabled 69 example 80 iconic links 79 link to index 70 l
156. nual using BTRX 12 labels pl data file containing symbolic labels for references to locations within a HTML document produced by ATBX2HTML nananana naaa 50 52 55 56 latex command to run to BTPX 8 11 12 59 73 86 87 WRX the markup language interpreted by ATRX2HTML images are processed by the ATRX PIOSTAM feck bedava eda oe ae ee eas ete a Ep ep ahea e a ald oo i BX 2 the current version of BT EX first introduced in 1993 00 1 latex2html Unix command to execute the ATFX2HTML script for generating HTML pages from a ATRX document 7 10 38 59 60 63 71 72 77 81 82 84 WIEX2HTML Perl script to convert ATEX documents into web pages by Nikos Drakos with updates and extensions by others 0 0 00 0 cc eee es 1 latex2htm1 98 1 tar gz compressed archive of the latest since Feb 1998 A T X2HTML Gistributiom x2i44decitea gard ote SA ed BOOS ba pee ee ew eee hs 7 latex2html config configuration file for BTEX2HTML normally to be found in the LATEX2HTMLDIR directory 7 10 12 16 19 64 65 67 72 74 85 86 letter perl implements section numbering conventions etc for the letter document ClaSS vice teen navy doi PaE a D E sea ee eG oe ee HER ea eee eo 28 libpng 0 89c tar gz implements the PNG image format routines available via Archie 9 libz implements data compression routines should be part of your operating system if NOU Seb At Via Archie s lee es wee di
157. nvironments from within a ATRxX document This document presents the main features of JATRX2HTML and describes how to obtain and install it and how to use it effectively Credits 1993 1994 Several people have contributed suggestions ideas solutions support and encouragement Some of these are Roderick Williams Ana Maria Paiva Jamil Sawar and Andrew Cole at the Computer Based Learning Unit CERN The idea of splitting ETPX files into more than one component connected via hyperlinks was first implemented in Perl by Toni Lantunen at CERN Thanks to Robert Cailliau of the World Wide Web Project also at CERN for providing access to the source code and documentation although no part of the original design or the actual code has been used Robert S Thau has contributed the new version of texexpand Also in order to trans late the document from hell 1 he has extended the translator to handle def commands nested math mode commands and has fixed several bugs Phillip Conrad and L Peter Deutsch The pstogif Perl script uses the pstoppm ps PostScript program originally written by Phillip Conrad Perfect Byte Inc and modified by L Peter Deutsch Aladdin Enterprises Roderick Williams The idea of using existing symbolic labels to provide cross references between documents was first conceived during discussions with Roderick Eric Carroll who first suggested providing a command like hyperref Franz Vojik provided th
158. olds the title of the previous HTML page at the same section level or shallower 79 PREVIQUS_PAGE_IN_NAVIGATION when set an iconic link to the previous logical page is placed in navigation panels unless overridden by NO_NAVIGATION being set also 70 PREVIOUS_TITLE when navigation panels are created this holds the title of the previous HIME Page 0c neria naer ode by ine ePbe Gta cd ate date dave waa et 79 PSTOIMG contains the command to run the pstoimg utility to convert PostScript files into images in the required graphics format 000000000 eee eee 73 PS_IMAGES when set hyperlinks to PostScript files are included on the HTML pages not lt IMG gt taGs acceso ha eo ig eee ear waa ba nina Peewee 4 68 REUSE settings affect whether images constructed on a previous run of JATRX2HTML are re used on the next run of the same document 0 000002 e eee 68 69 RGBCOLORFILE when color perl has been loaded holds the name of the file which contains color specifications and names 0000 ee eee 74 SCALABLEFONTS used when scalable fonts e g PostScript are available for use with image generatio ecreis rese kta sed Bee Peas os ated eee beats 66 SERVER used in conjunction with image maps to specify the type of web server which will interpret the map s lt c 4 2 eusa ee Sa eas Wee ee ee eee 11 SHORTEXTN when set uses htm as the filename suffix rather than html 63 74 SHORT_INDEX when set result
159. onfigure pstoimg this file holds information about what graphics utilities are available on the local system 76 LATEX2HTMLDIR styles german perl adds Perl code to establish compatibility with the german sty ATEX 2e package 1 ee 29 LATEX2HTMLSTYLES contains the directory path to find the styles directory usually a subdirectory of LATEX2HTMLDIR 2 2 ee eee 72 74 LATEX2HTMLVERSIONS contains the directory path to find the versions directory usu ally a subdirectory of LATEX2QHTMLDIR 2 0 20 0 eee eee 72 LATEX_DUMP if set speeds up image processing during subsequent runs on your document A Mae ates eae A A es lee dG 69 LINE WIDTH holds the width of displayed equations used for right justification 76 LINKNAME name for the duplicate HTML file which enables automatic browser linking from A directory NaMe verdee neradaee se ae Ea RCRD oe cd wesewan es eed 64 74 92 LINKPOINT specifies the name for the HTML file to be duplicated to enable automatic browser linking from a directory name 000000 ee eee 64 74 92 LOCAL_ICONS when non zero causes a copy of the icons used to be placed within the directory along with the HTML files and generated images 12 67 LONG_TITLES when non zero specifies how many words from the section title are used to determine the filename for each HTML page 0 0 63 MATH_SCALE_FACTOR magnification factor for images of inlined equations and displayed mat
160. ons in the navigation panel The following switches allow for such links to other documents by providing the title and URL for navigation panel hyperlinks In particular the Document Segmentation feature of Section 4 10 necessarily makes great use of these switches It is usual for the text and targets of these navigation hyperlinks to be recorded in a Makefile to avoid tedious typing of long command lines having many switches up_url lt URL gt Same as setting EXTERNAL_UP_LINK lt URL gt Specifies a universal resource locator URL to associate with the UP button in the navigation panel s up _title lt string gt Same as setting EXTERNAL_UP_TITLE lt string gt Specifies a title associated with this URL prev_url lt URL gt Same as setting EXTERNAL_PREV_LINK lt URL gt Specifies a URL to associate with the PREVIOUS button in the navigation panel s prev _title lt string gt Same as setting EXTERNALPREV_TITLE lt string gt Specifies a title associated with this URL 70 down_url lt URL gt Same as setting EXTERNALDOWN_LINK lt URL gt Specifies a URL for the NEXT button in the navigation panel s down_title lt string gt Same as setting EXTERNALDOWN_TITLE lt string gt Specifies a title associated with this URL contents lt URL gt Same as setting EXTERNAL_CONTENTS lt URL gt Specifies a URL for the CONTENTS button for doc
161. opriate value then the tag is ignored Any lt contents gt are included in the document as ordinary character data valid HTML Currently there is no checking that the lt contents gt of a lt tag gt contains only data perhaps including other tags allowed by the DTD for HTML 3 2 The requirement to produce valid HTML currently rests with the user This issue will be addressed in forthcoming revisions of ATRX2HTML extra attributes and values The list of attributes for a lt tag gt can include key value pairs whose keys do not match any valid attribute for the lt tag gt Such key value pairs are simply ignored Similarly extra data values are ignored as are values that do not match the requirements for any valid attribute attributes with similar data types Several attributes to a lt tag gt may use values hav ing the same or similar data types First any key value pairs are processed Remaining values are allocated to those attributes which do not already have a value An order ing of the attributes is used based on a perceived likelihood of each attribute being required to be changed from its default setting 4 4 Conditional Text begin latexonly and begin htmlonly Conditional text can be specified using the environments latexonly and htmlonly These allow writing parts of a document which are intended only for electronic delivery or only for paper based delivery This would be useful for example in adding a long description
162. oss references between different documents Using symbolic labels makes this a lot easier especially for documents written by the same author 4 8 Miscellaneous commands for HTML effects The html package through the TFX input file html sty and its Perl counterpart html per1 implements several new commands that are intended entirely for effects within the produced HTML files In MATRX these commands their arguments and any optional arguments are completely ignored htmlrule and htmlrule One such device provided by html sty is the htmlrule command This puts a horizontal rule into the HTML file only being ignored in the dvi version It is useful to provide extra visual separation between paragraphs without creating a new HTML page such as might warrant extra vertical space within the printed version Much variation can be obtained in the horizontal rule that is produced using extended forms of the htmlrule command htmlrule htmlrule htmlrule lt attribs gt htmlrulex lt attribs gt 431 ink validation can be done automatically but the updating must be done manually when filenames have changed assuming no other symbolic label mechanism is available 44You either have to guess the role of each label by looking at the labels p1 file or by asking the author 52 Whereas a break tag lt BR gt normally precedes the lt HR gt generated by the htmlrule command this break is omitted when using the htmlrule vari
163. ossary of variables and file names dvipsre initialisation file for dvips 1 0 cee eee ee nee 7 11 latex2html init initialisation file for ATPX2HTML 11 62 63 67 72 74 77 78 86 91 ACCENT_IMAGES holds the ATRX style to be used when making images of accented char acters which are not present in the character encoding being used 74 ADDRESS contains information to be included as a signature at the bottom of each HTML PACE ing fot a fs Wowk igang Aaaa Sa Boece Sate dee E Sack doa aia Ske Ee 4 67 ALTERNATIVE_ICONS contains the location of special icons other than the standard ones ade Ba Dewar a aaa ah pew ed 67 72 ANTI_ALIAS when set specifies that anti aliasing be used with generated images of figures and included images daad an saaa eee 69 ANTI_ALIAS_TEXT when set the default specifies that anti aliasing be used with gener ated images of maths and typeset text asusunu eee 69 ASCII MODE when set all icons and images are replaced with text strings suitable for text only browsers oce 6054 a ca ceed eRe eee ee eee eee ee ee es 68 AUTO_NAVIGATION when set a navigation panel is placed at the bottom of long pages unless overridden by NO_NAVIGATION being set also 70 75 AUTO_PREFIX if set all files produced have a filename prefix using the name of the MTRX file being processed 1 0 0 0 00 eee 11 57 64 BODYTEXT string to be used within the lt BODY gt tag on HTML pages
164. parate segments of the manual the full manual is thus created as a segmented document see Section 4 10 The whole process may take quite some time as each segment needs to be processed at least twice to collect the cross references from other segments The files necessary for correct typesetting of the manual to be found within the docs subdirectory They are as follows style files 12hman sty html sty htmllist sty justify sty changebar sty and url sty inputs credits tex features tex hypextra tex licence tex manhtml tex manual tex overview tex problems tex support tex and userman tex sub directory psfiles containing PostScript graphics used in the printed ver sion of this manual images of small curved arrows up gif dn gif filename data 12hfiles dat auxiliaries manual aux manual ind manual gls 12 The last three can be derived from the others but are included for convenience e To get a printed version of the Changes section Due to the burgeoning size of the Changes file with successive revisions of TR X2HTML the Changes section is no longer supported for the manual Please refer to text file Changes instead which is part of the distribution e To join the community of BTp X2HTML users More information on a mailing list discussion archives bug reporting forms and more is available at http cbl leeds ac uk nikos tex2html doc latex2html1 latex2html html
165. plete babel Interface to german per1 via the babel package changebar Provides rudimentary change bar support chemsym defines the standard atomic symbols color Causes colored text to be processed as ordinary text by ATRX2HTML colordvi supports the Crayola colors enumerate supports structured labels for enumerate environments epsbox Processes embedded figures not enclosed in a figure environment epsfig Processes embedded figures not enclosed in a figure environment finnish Support for the Finnish language floatfig Processes floating figures floatfit Processes floating figures and tables foils Supports FoilTfX system frames Provides separate frames for navigation and footnotes francais Support for the French language same as french perl french Support for the French language german Support for the German language germanb Support for the German language same as german perl graphics Supports commands in the graphics package graphicx Supports the alternate syntax of graphics commands harvard Supports the harvard style of citation same as fnnharvard per l heqn Alters the way displayed equations are processed hthtml gives an alternative syntax for specifying hyperlinks etc htmllist Provides support for fancy lists justify supports paragraph alignment no longer needed latexsym supports the TFX symbol font lgrind macros for nice layout of computer program code longtable supports use of long tables as a single table mak
166. prefiz gt will be prepended to all gif pl and htm1 files produced except for the top level htm1 file it may include a relative directory path This will enable multiple products of ATRX2HTML to peacefully coexist in the same directory However do not attempt to simultaneously run multiple instances of HTRX2HTML using the same output directory else various temporary files will overwrite each other 63 auto_prefix Same as setting AUTO_PREFIX 1 Constructs the prefix as lt t7tle gt to be prepended to all the files produced where lt title gt is the name of the TFX file being processed Note the in this prefix This overrides any PREFIX setting no_auto_link Same as setting NO_AUTO_LINK 1 If NO_AUTO_LINK is empty and variables LINKPOINT and LINKNAME are defined ap propriately as is the default in the latex2html config file then a hard link to the main HTML page is produced using the name supplied in LINKNAME Typically this is index html on many systems a file of this name will be used if it exists when a browser tries to view a URL which points to a directory On other systems a different value for LINKNAME may be appropriate Typically LINKPOINT has value FILE html but this may also be changed to match whichever HTML page is to become the target of the automatic link Use of the no_auto_link switch cancels this automatic linking facility when not required for a particular document
167. present the required information Generation of an image is done only when there is no adequate textual construction with the required version of HTML or when specifically requested to do so Various extensions to cope with the different HTML versions and extra features are discussed in Section 3 That describes what to expect on the HTML pages with little or no changes required to the ATRxX source Just as TFX has various packages which can be used to present specific types of in formation in appropriate ways so is IATFX2HTML capable of handling the commands from many of these packages See Table 6 for a listing of those packages which currently have special support e Some features of HTML have no direct counterpart in a ATRX typeset document Can such features be used with IATRX2HTML Any effect currently available with any version of the HTML standard can be specified for a document processed by ATRX2HTML New ATEX commands are defined in the html sty package the features that these commands allow are the subject of Section 4 in this manual Some of the new commands provide improved strategies for effects already existing in Tpx e g cross references and citations To use these effectively requires only small changes to the JATRX source Other commands define new environments which are completely ignored when processed by TFX Indeed the full scope of HTML 3 2 is available using ATRX like macros to help structure the source reduce t
168. produced with the example segmented document 59 sec2 tex another section of the example segmented document 58 59 slides perl implements section numbering conventions etc for the slides document ClaSSas cs ed Pa ERS LA eae ae a AE Ve eae ne aware ye aes 28 styles subdirectory of LATEX2HTMLDIR containing lt file gt per1 files corresponding to TATRX PACKAGES cio bebe a Pena Rade eee ae oe eee a ee a 7 16 28 72 91 58ftp ftp x org contrib utilities 59ftp ftp uu net languages perl 98 support tex input file for a section of the ATRX2HTML manual details installation and some technical aspectS misaada eera ee eee eee nes 12 tar utility for creating and extracting files from archives 6 7 tcsh a unix shell provides support for MTRX2HTML 1 02 ee ee 8 tests subdirectory of LATEX2HTMLDIR with various test documents in particular you might be interested in running pages tex to check the image generation 7 texdefs perl package providing ability to recognise and process some common TFX macro constructions 4 2 4 bese pin ee eae ae ed de ee ea es 66 93 texexpand Perl script used with ATPX2HTML for combining the required portions of all input files into a single document ii iv v 7 10 73 81 82 93 TEXINPUTS shell variable which contains the usual paths used by TRX to find packages and other input filles 2 0 0 0 0002 eee eee 10 85 86 texinputs subdire
169. propriate to an HTML document Also many other JATFX constructions are handled including many de scribed in the BTEX Companion 2 and ETRX Graphics Companion 3 Xy pic e can be configured to translate equations either as GIF images or as HTML 3 0 mark up as browsers become available which are suitable for the task or by making images of subparts of equations as required e links symbolic references across document segments which have been independently processed e will try to translate any document with embedded ATEX commands irrespective of whether it is complete or syntactically legal 8This allows the definition of HTML macros in IATFX 9Like this 1 2 Exemplary Documents Here is a selection of documents illustrating different contexts in which TRX2HTML has been used This list is by no means exhaustive but all links were valid as of June 1997 An earlier listing of converted documents can be found at http cbl leeds ac uk nikos tex2html doc latex2html node6 html sample However some of the links are no longer valid PTEX2HTML documentation and usage Software The EATEX2HTML Translator User Manual http www texdev mpce mq edu au 12h docs manual http www dsed 1ln1 gov files programs unix latex2html1 manual Mathematics with ATRX2HTML http www texdev mpce mq edu au 12h mathdocs amsmath2 EXTRX2HTML Style Sheets XML http www ramge de ax latex2html latex2html html All about IAT RX2HTML by N
170. r any other characters Otherwise ATEX will not recognise the intended end of the environment when processing for the dvi version Similarly there should be nothing on the same line after the opening environment delimiter begin htmlon1ly say 37 The following commands are defined for ATRX in html sty Corresponding Per implemen tations are either in html per1 or in the latex2htm1 script itself latextohtml expands to the name JATRX2HTML of this translator htmladdnormallink creates a perhaps named textual hyperlink to a specified lt URL gt htmladdnormallinkfoot same as htmladdnormallink but AT X also prints the lt URL gt in a footnote htmladdimg places an image perhaps aligned on the HTML page ignored by ATEX hyperref creates a textual hyperlink to where a label command occurred within the same document This is the recommended substitute for DTRX s ref command htmlref creates a textual hyperlink to the place where a label command occurred no reference is printed in the ATRX version hypercite creates a textual hyperlink to the bibliography page where citation details are shown This is the recommended substitute for AT X s cite command htmlcite creates a textual hyperlink to the bibliography page where citation details are shown no citation marker is printed in the AATRX version externalref creates a textual hyperlink to where a label command occurred within a different document that h
171. r images nor for super sub scripts to be generated Images are created for tables and other environments that use lt TABLE gt tags with HTML 3 2 e g eqnarray and equation with equation numbering 14 3 2 A special variable LANGUAGE_TITLES in the initialisation or configuration files determines the language in which some section titles will appear For example setting it to i18n internationalised fonts This extension formerly known as HTML version 2 1 provides extensions for internationalisation Most importantly the default charac ter set is no longer ISO 8859 1 but ISO 10646 Unicode This is a 16 bit character set and can thus display a much larger set of characters There are also provisions for bidirectional languages e g in Arabic the text is written from right to left but numerals from left to right and provisions in HTML to determine the character set and the language used Not all of the symbols are available in TEX TRX2HTML or any browser yet avail able However the i18n extension to HXTRX2HTML is in preparation for when such browsers do become available and such characters will be required in Web accessible documents tables HTML3 model Although HTML 3 2 implements tables using lt TABLE gt tags the HTML capabilities available to specify details of the table layout are not as extensive as were originally proposed in the HTML3 Table Model This extension formerly referred to as HTML version 2
172. r the different versions of HTML is discussed in Section 3 1 Following this is a description in Section 3 2 of how to use languages other than English The options available with the creation and reuse of images are presented in Section 3 4 for those situations where a textual representation is inadequate or undesirable There are several strategies available for the presentation of mathematics according to the desired version of HTML These are discussed in some detail in Section 3 3 Environ ments such as figure table tabular and minipage have special features which are discussed in Section 3 5 Other supported packages are listed in Table 6 3 1 Variation with HTML Versions The Hypertext Mark up Language HTML is an evolving standard with different versions supporting different features In order to make your documents viewable by the widest possible audience you should use the most advanced HTML version with widely accepted usage Currently the most advanced is HTML 4 0 However this has only recently become an officially recommended version Not all of its features are fully implemented in popular browsers and the level of usage is unclear Hence the default version for ATRX2HTML version 98 1 remains at HTML 3 2 Further work is required before ATRX2HTML can fully exploit the features available using HTML 4 0 This provides support for alignment of headings images and text including text flow around images tables with separate
173. r to the TUG meeting there will be a workshop on ATRX2HTML conducted by Ross Moore Admission 50 includes a printed copy of the latest JATRX2HTML manual TeX Northeast TUG Conference TEX BTRX Now March 22 24 1998 New York City Includes a workshop presentation by Ross Moore Euro TrX 98 10th European TFX Conference St Malo France 29 31 March 1998 Several of the HTRX2HTML developers will be present All European and other ATRX2HTML users are encouraged to attend 6Mathematics Department Macquarie University Sydney Australia 7 Mathematics Department Macquarie University Sydney Australia vi Developments late 1997 to early 1998 Much of the work contributed to ATRX2HTML during this time was related to bug fixing and maintaining the 97 1 release in order to reach a more stable and reliable version which produces HTML code conforming to the W3C standards drafts To keep in context with this view support for HTML 4 has been incorporated into the translator There have been improvements to the way math code is handled as well as font changing and numbering commands These now are expected to work much closer to the way that BTEX handles them Furthermore missing TFX style translations for basic BTFX and AMS T X docu ment classes were added to the distribution book perl report perl article perl letter perl amsbook perl and amsart perl New styles implementing A TRX packages include seminar pe
174. ractice the contents of the figure environment are usually represented by generating an image This is frequently exactly what is required but not always On page 47 it is described how to use the makeimage environment defined in the html sty package to determine just which parts if any of a figure environment s contents should be made into images the remainder being treated as ordinary text etc table and tabular environments Similarly the makeimage environment can be used within a table though usually this is used with a tabular or other table making environment such as tabbing or longtable or supertabular Here is a simple example from the ATEX blue book gnats gram 13 65 reach Or stuffed 92 50 Lemur armadillo frozen Table 4 A sample table taken from 1 Table 5 is a screen shot of how the resulting table appears on screen using a typical browser supporting HTML 3 2 Here it is scaled down by 70 to compensate for the 14 pt fonts being used when the screen shot was taken 26 gnats gram 13 65 each 01 gnu stuffed 92 50 lemur 33 33 armadillo frozen 8 99 Table 5 Alternate view of the table from 1 minipage environments The special feature of minipage environments is in the way footnote and footnotemark commands are handled These are numbered separately from the rest of the footnotes throughout the document and the notes themselves are collected togeth
175. raphics Laboratory Publications Web Visualization in Hyperbolic Space Topology of the MBONE Complex Mod els from Range Images Optical Triangulation Metamorphosis The RGO Worldwide Guide to Public Videoconference Centers http www ast cam ac uk ralf vcguide 18http www astro virginia edu eww6n TreasureTroves 1http www maths mq edu au ross index html courses 0http fas sfu ca ensc people Faculty jones personal ensc100 lhttp bonk ethz ch papers diss main node78 html 2 http bonk ethz ch papers lecture notes 97 1n97 node10 html 3 http www graphics stanford edu papers 2 Installation and Further Support 2 1 Getting PTEX2HTML One way ETRX2HTMLmay be obtained is through one of the three Comprehensive TEX Archive Network CTAN sites They are located at US United States http ctan tug org ctan UK United Kingdom http www tex ac uk DE Germany ftp ftp dante de In the directory tex archive support latex2html1 should be the latest version as a compressed archive There are also many mirrors To find the nearest to you get a listing via the command finger ctan www tug org The site at http saftsack fs uni bayreuth de latex2ht is a convenient alterna tive for European users This is connected to the developer s repository so should always have the most recent release Alternatively a compressed tar file of the source and related files may be obtained via anony mous ftp to h
176. red both in the TEX and HTML versions Such an environment is already used in AMS BTFX and perhaps with other packages It is defined here for its general utility To insert SGML style comments into the HTML files use the rawhtml environment as follows begin rawhtml lt this text is treated as a comment perhaps extending over several lines gt end rawhtml Note the warning on page 37 concerning how the environment delimiters should be used in the ATRX source code comment endcomment This is an alternative way to specify a chunk of material in tended to be ignored in both the MTRX and HTML versions using the old A yS style of delimiting environments Use of this style though convenient for typing is discouraged since it is not as reliable as using the comment environment 42 4 3 Arbitrary Tags and Attributes For version 97 1 of ATRX2HTML there is a new command which provides an extremely flexible way to include HTML 3 2 tags along with any values for the attributes of that tag if desired HTMLcode lt attribs gt lt tag gt HTMLcode lt attribs gt lt tag gt lt contents gt When the lt tag gt also needs a closing tag e g lt I gt lt I gt the lt contents gt must be given enclosed in braces Both the opening and closing tags then will be placed correctly Warning In version 97 1 this command was actually called HTML However style files may well define HTML to mean something
177. red with laser print The amount of this scaling is given by the value of a configuration variable MATH SCALE FACTOR by default set to 1 6 in latex2html config A further vari able DISP_SCALE_FACTOR is used with displayed math equations and formulas This value multiplies the MATH_SCALE_FACTOR to give the actual scaling to be used The main purpose of this extra scaling is to allow some clarity in super subscripts etc 36http www texdev mpce mq edu au 12h mathdocs 19 Anti aliased Images Figure 1 shows the same equations as previously this time as images of the complete contents of the equation environment and complete aligned parts of rows in an eqnarray These are images as they would appear if the HTML page were to be printed from the browser A scaling of 60 has been applied to counteract the combined effects of the MATH_SCALE_FACTOR of 1 4 and DISP_SCALE_FACTOR of 1 2 used for the HTML version of this manual For a comparison the second group of images use anti aliasing effects whereas the first image does not a 600dpi printing is probably necessary to appreciate the difference in quality Compare these images with those in Section 3 4 3 Note To generate anti aliased images using Ghostscript requires version 4 03 or later od Ditimn o h gt ah ao Or 2 a r 3 car aii 3 Fo r T aha Di44 mn a 29 mn IN Diim n Di m4l n 29 min F Dim 1 n ie H aad mnt 29 min T Dim n 1
178. res listing 2 figure environment 24 figures 2 24 arbitrarily scaled 2 22 captions 25 fine control 22 from other segments 57 oriented 2 22 wrapfig package 30 file suffix tex or doc 61 optional 61 filenames htm extension 63 auto prefix 63 automatic link to directory name 64 custom_title_hook 63 customised 63 index html 64 long names 63 prefix 63 finnish finnish package 29 fixes 81 floatfig package 29 floatingfigure environment 31 floatflt package 29 foils class 29 31 FoilT X 29 31 font size for image generation 66 scalable 66 font size in environments 66 magnification 66 fonts non standard encodings ix footnotes 3 marker style 67 numbering 67 on same page 67 on separate page 67 forking prevent 67 Foster Ian ii 13 frames package 29 french francais package 29 french package 29 G german germanb package 29 german package 29 getting started 61 Ghostscript version 9 GIF see images image conversion 9 Glossary HTML version 33 integrated with Index 33 printed version 33 Goossens Michel iii vi ix 1 graphics graphicx package 29 Xy pic package 30 graphics package 29 Graphics Companion see The ATpx Graphics Companion H Hennecke Marcus iii v vii ix heqn package 21 29 heqn sty style file 21 hthtml environment 29 HTML an evolving standard 14 arbitrary markup 41 basic version 2 0 14 current version 3 2 14 future ver
179. respectively These environments allow text to wrap around a figure in the printed version but are treated exactly as an ordinary figures in the electronic version They are described in The ATRX Companion 2 3 7 2 Support for FoilTpxX The FoilTfX system presents some additional problems for JATRX2HTML e It has additional commands like foilhead and rotatefoilhead that roughly cor respond to sectioning commands e The images are produced at the sizes suitable for large screen presentation but not for the HTML The package foils perl deals with these problems It treats foils as starred subsections and ignores FoilTp amp X specific commands that have no meaning for HTML like LogoOn The header documentclass options foils in the images tex file is substituted by the header documentclass FOILOPTIONS FOILCLASS where the variables FOILOPTIONS and FOILCLASS can be set in the configuration file by default they are 10pt and article correspondingly A further variable FOILHEADLEVEL holds the level of sec tioning at which a foil is to correspond the default level is 4 sub section The FTpX style file foilhtml sty in the texinputs directory provides some addi tional features for FoilT X It implements structural markup commands like section tableofcontents for foils See the directory docs foilhtm1 for the details 3 7 3 Indicating Differences between Document Versions BETEX2HTML supports the ATpX2 c
180. rk with parts of this software For this reason a Glossary is included with this manual It contains the names of all files config uration variables application software and related technical terms with a short description of what it is or does and perhaps a URL for further reference 33 In the printed version each item in the Glossary is accompanied by the page numbers on which the item is mentioned somewhat like in the Index For the HTML version each glossary item contains a hyperlink to an index entry which then has links to each occurrence These extra index entries do not appear in the printed version indeed they also contain a hyperlink back to the corresponding glossary entry This feature is currently available only when using the makeidx package and needs also the html and htmllist packages It was developed for version 96 1f by Ross Moore incorporating an extensive revision of makeidx perl as well as additions to MTR X2HTML so that all aspects of indexing work correctly with segmented documents Since ATEX provides no guidelines for how a Glossary should be constructed the technique used here will be explained in detail for both the printed and HTML versions e Firstly the makeglossary command which is similar to makeindex must appear in the document preamble so that TEX will record uses of the glossary command within a file manual glo This command is redundant in the HTML version so is given a trivial de
181. rl inputenc perl and chemsym perl naming but a few The aim is ultimately to support all YTRX A jS TEX etc packages in the standard FATRX distribution or for which there is published documentation At the time of writing this aim has not quite been reached To support internationalisation Perl extensions were provided for HTML output conforming to ISO Latin 1 2 3 4 5 6 and Unicode encodings All of the above work was done by Ross Moore Additional document formats are now supported these are IndicT X FoilT X and CWEB documents You may use any of these packages to translate such documents together with ETEX2HTML refer to the instructions in the various README files Thanks go to Ross Moore for IndicTgX HTML to Boris Veytsman for FoilT X HTML and to Jens Lippmann for the CWEB to HTML translator Numerous discussions and efforts have been undertaken to get AT FX2HTML working in dependent from the underlying operating system Yet all obstacles are not quite taken but it is forseeable that we are OS independent very soon This release has been reported to run on OS 2 DOS and MacOS besides Unix like operating systems A former version has also been ported to Amiga OS but that results still need to be re integrated into the source Ports for Windows 95 and Windows NT exist but are not yet integrated with the main distribution Thanks go to Marcus Hennecke Axel Ramge Marek Rouchal and Uli Wortmann for fruitful and r
182. s markup instructions or as macros expanding into more text or markup commands Where such markup corresponds to the intended use for markup tags in the HTML language a direct translation is made If there is no natural way to present the information using simple text embellished with HTML markup tags then an image is generated using TFX itself to interpret the portion of code Of course this is a drastically over simplified description of what ATFX2HTML actually does Many questions spring readily to mind The answers to these and the options available to handle particular situations are discussed elsewhere in this manual e What does natural way to present the information really mean Text and paragraphing clearly should appear as such whether printed or on screen Differ ent font sizes and styles such as bold face or italic are generally rendered accordingly However whereas TFX has access to appropriate fonts for specialised purposes such as mathematical symbols these cannot be guaranteed to be available with all Web browsers So for information requiring such things BTEX2HTML will generally resort to making an image using ATEX itself to typeset the material required for that image Section 1 1 contains a brief overview of how IATFX s standard environments are handled within ATPX2HTML It also mentions some of the extra features that are available In general BETEX2HTML attempts to use textual constructions to re
183. s and other awkward environments 00 0 0 eee 89 images log the log file produced by running BTFX on images tex 85 87 images pl data file produced by TRX2HTML contains information about the images in your document used for cyclic image generation 00000005 87 images tex file created by ATPX2HTML which is passed to ATRX to typeset complicated environments for conversion to images 31 37 47 69 87 90 92 96 index html on many systems a file of this name will be sent to the browser when a URL to its parent directory has been specified 202020 2000 64 102 IndicTeX HTML subdirectory of LATEX2HTMLDIR containing IATFX and Perl extensions to handle IndicTeX documents 000000 cette eee T install test tests the JATPX2HTML installation 7 8 10 72 73 81 84 105 justify perl package defining HTML 3 2 markup for left right center justified para graphs interpreting the standard TEX environments flushleft flushright center 96 justify sty PTX package which does nothing other than force loading of justify perl DY LTEX2HTM 22 be cee eae ea ees ae ee oh ete E a 12 12hfiles dat contains the descriptive data appearing in this glossary 12 35 12hglo ist configuration for makeindex to construct this glossary 12 35 97 12hidx ist configuration for makeindex to construct the index 12 97 12hman sty style file needed for typesetting the JATRX2HTML ma
184. s et al 88 theorems theorem like environments 3 thumbnail 2 22 24 25 55 ignores scale factors 22 implies external 22 tilde in URL 41 time stamp used with segmentation 59 transparent images override defaults 23 TUG TUG TEX Users Group 13 U Uffe Engberg 51 Umar Verena ii unending loop 82 Unicode see character set unrecognised commands 81 URL for CONTENTS button 71 for external Bibliography 71 for INDEX button 71 for NEXT button 70 for PREVIOUS button 70 for UP button 70 universal resource locator 70 url package iii usemap 55 V verbatim verbatimfiles package 30 verbatim package 30 verbosity level 71 Veytsman Boris vii 7 viewer see browser visual separation using htmlrule 52 Vojik Franz ii W Web Companion see The PT EX Web Companion Wilck Martin iii 49 54 Wortmann Uli v vii 1 5 wrapfigure environment 31 x XML extended markup ix xspace package 30 Xy pic package 30 109
185. s in a more compact Index being produced 33 67 SHOW_SECTION NUMBERS when set ATRX s section numbering is included with section HIGGS wh i dlaviteed th hee koed ede heb e REE aoe ee ae baa matin Sf 65 TEXDEFS when set the texdefs perl1 file is read allowing some TFX constructions to einterpreted e seae died ki aana Pw dre Soke OE ha Og Beane bo ee Sv eed a 66 TEXEXPAND contains the command to run the texexpand utility which combines all re quired portions of input files for a ATRX2HTML document 73 TEXINPUTS contains the paths for ATX to search for styles and input files when making IMAGES is heeled Cake Adee Reads E RG eee be eae Ghee eS eh hes 10 11 73 TITLE initially can be set to hold a title for the document as a whole 63 TITLES_LANGUAGE specifies the collection of strings to use as titles for special document SCCLIONS atu de ooR APE EAs BS Sa Be PRA ee Sees 75 TMP when set in local pm used by pstoimg as a temporary directory for image generatigi avsak atua i oaea ai E ee cake ek Bake yok Soca Hate a a he athe de 76 TOC_DEPTH sectioning level down to which links occur on the Table of Contents page 64 TOC_STARS when set star sections are listed linked on the Table of Contents page 64 TOP_NAVIGATION when set a navigation panel is placed at the top of every HTML page unless overridden by NO_NAVIGATION being set also 02 400 70 TRANSPARENT FIGURES when set this specifi
186. se variables are initially set to have value 1 6 A further variable DISP_SCALE_FACTOR is used with displayed math equations and formulas this value multiplies the MATH SCALE_FACTOR to give the actual scaling used With the improved clarity of anti aliased images a scaling of 1 6 may be a little excessive for inline images Accordingly this manual actually uses values of 1 4 and 1 2 respectively 21 for MATH_SCALE_FACTOR and DISP_SCALE_FACTOR These go well with the browser s text font set at 14 pt The next larger size of 17 pt is then used for the lt LARGE gt tags in displayed equations A further variable EXTRA_IMAGE_SCALE allows images to be created at a larger size than intended for display The browser itself scales them down to the intended size but has the extra information available for a better quality print This feature is also available with single images It is discussed with examples in Section 3 4 3 htmlimage lt options gt For finer control several parameters affecting the conversion of a single image can be controlled with the command htmlimage which is defined in html sty With version v97 1 use of this command has been extended to allow it to control whether an image is generated or not for some environments as well as specifying effects to be used when creating this image If an htmlimage command appears within any environment for which creating an image is a possible strategy though not usual du
187. segments 3 frames 29 highlighted text 47 francais 29 iconic 47 french 29 numeric 47 german 29 symbolic 3 50 germanb 29 symbolic 47 graphics 29 to external documents 50 51 graphicx 29 without indirection 47 harvard 29 references heqn 21 29 hyper links 3 html 21 references 47 justify 29 requirements 8 9 latexsym 29 DataBase Management system 8 Igrind 29 for full graphics 8 longtable 29 for segmentation feature 9 makeidx 29 for special features 9 multicol 30 for transparent images 9 natbib 30 minimal 8 nharvard 30 Unix shell 8 seminar 30 without images 9 spanish 30 Rose Kristoffer vi supertabular 30 Rouchal Marek iv vii 1 7 texdefs 30 verbatim 30 S verbatimfiles 30 scale factors wrapfig 30 for math images 19 xspace 30 sectioning levels 65 Xpic 30 sections from other segments 57 parbox command in separate files 64 generates an image 21 numbers not shown 64 PNG show section numbers 64 segment 56 segmentation 56 60 packages 29 image conversion 9 Popineau Fabrice v vii 1 6 107 child segments 56 58 59 child links 33 circular dependency 59 codified index 33 data about contents 57 data about figures 57 data about labels 57 data about sections 57 data about tables 57 data for the index 57 different sub directories 60 document segments 56 example 58 internal labels 59 list of commands 38 needs TFX 2e 9 parent segment 56 58 r
188. sing time could become prohibitively high if even a small change required the entire document to be reprocessed For these reasons program segmentation was developed This feature enables the author to subdivide his document into multiple segments Each segment can be processed indepen dently by ATFX2HTML Hypertext links between segments can be made symbolically with references shared through auxiliary files If a single segment changes only that segment needs to be reprocessed unless a label is changed that another segment requires Further more the entire document can be processed without modification by TFX to obtain the printed version The top level segment that TFX reads is called the parent segment The others are called child segments Document segmentation does require a little more work on the part of the author who will now have to undertake some of the book keeping formerly performed by EXTRX2HTML The following four PTFX extensions carry out segmentation segment lt file gt lt sec type gt lt heading gt This command indicates the start of a new program segment The segment resides in lt fzale gt tex represents the start of a new TFX sectional unit of type lt sec type gt e g section chapter etc and has a heading of lt heading gt A variation segment of this command is provided for segments that are not to appear in the table of contents These commands perform the following operations in TFX 1 T
189. sion 4 0 14 HTML3 Table Model 15 103 image maps 14 interactive forms 3 14 new HTML tags 41 non standard extensions 65 raw HTML commands 3 41 SGML like markup 41 Version 2 0 14 Version 2 1 3 Version 2 1 now il8n extension 14 Version 2 2 now table extension 15 Version 3 0 3 15 22 Version 3 0 HTML Math model 15 Version 3 1 now math extension 15 Version 3 2 55 html 46 html package 21 HTML version 65 html sty new commands defined 38 new environments defined 37 html sty package how to load it 37 html sty style file 12 22 37 48 52 location 10 needed for special features 9 htmladdinmg 40 htmladdnormallink 40 htmladdnormallinkfoot 41 htmladdtonavigation 79 htmlbase 54 htmlbody 54 htmlcite 50 example 50 htmlhead 57 htmlimage 22 overrides configuration 24 htmlinfo 53 htmlitemmark 30 htmllist example 30 item marks 30 prints as description 30 htmllist environment 29 30 htmlnohead 57 htmlonly 46 htmlonly environment 45 htmlref 48 easy to make links 49 htmlrule attributes to the lt HR gt tag 52 htmlrule 52 variants 52 htmlrule 52 HTMLsetenv alters a Perl variable 54 HTMLset alters a Perl variable 54 hyper links 40 hypercite 49 example 50 hyperref 47 pageref example 48 hypertext active link 40 arbitrary references 40 extensions 37 URL as footnote 41 hypertext links 3 commands to create
190. specifically to meet such requirements Commands can be order sensitive without having to be passed to ATg X Indeed even if a Perl subroutine has been carefully written to process the command it may still give wrong results if it is order sensitive depending on the values of counters say To handle such cases there is the amp sprocess_commands_wrap_deferred subroutine This also wraps the command within a dummy environment but when that environment is processed the contents are not sent to ATFX as in the previous case All of the standard TFX commands to change set or read the values of counters are handled in this way 78 5 4 Customising the Navigation Panels The navigation panels are the strips containing buttons and text that appears at the top and perhaps at the bottom of each generated page and provides hypertext links to other sections of a document Some of the options and variables that control whether and where it should appear are presented in Section 5 2 4 A simple mechanism for appending customised buttons to the navigation panel is pro vided by the command htmladdtonavigation This takes one argument which ATRX2HTML appends to the navigation panel For example htmladdtonavigation htmladdnormallink htmladdimg http server mybutton gif http server link will add an active button mybutton gif pointing to the specified location Apart from these facilities it is also possible to specify completely
191. the slides argument of the documentclass command with something like article just before using ATRX2HTML One problem may be that all your slides will end up in the same HTML file If you use lslide sty you may get much better results use Archie to find this or any other style files References 1 Leslie Lamport FTEX A Document Preparation System User s Guide amp Reference Manual 2nd edition ISBN 0 201 52983 1 Paperback 256 pages Addison Wesley 1994 Online information on TeX and FATRX is available at http www tug org and http waw dante de Michel Goossens Frank Mittelbach Alexander Samarin The ATRX Companion ISBN 0 201 54199 8 Paperback 530 pages Addison Wesley 1994 Michel Goossens Sebastian Rahtz and Frank Mittelbach The ATEX Graphics Compan ion ISBN 0 201 85469 4 Softcover 608 pages Addison Wesley 1997 Sebastian Rahtz and Michel Goossens with E Gurari R Moore amp R Sutor The ATEX Web Companion to appear in 1999 Addison Wesley Nikos Drakos Text to Hypertext conversion with IATFX2HTML Baskerville Decem ber 1993 Vol 3 No 2 pp 12 15 http cbl leeds ac uk nikos doc www94 www94 html Nikos Drakos From Text to Hypertext A Post Hoc Rationalisation of MTRX2HTML Published in Proceedings of the 1st World Wide Web Conference May 1994 CERN Geneva Switzerland http cbl leeds ac uk nikos doc www94 www94 html Ohttp www pvv unit no archie 88 Gl
192. the character as which is the character in the corresponding place for ISO Latinl The input encodings that are recognised are listed in Table 1 16 extension notes encoding unicode partial ISO 10646 Unicode latin1 default ISO 8859 1 ISO Latin 1 latin2 ISO 8859 2 ISO Latin 2 latin3 ISO 8859 3 ISO Latin 3 latin4 ISO 8859 4 ISO Latin 4 latin5 ISO 8859 9 ISO Latin 5 latin6 ISO 8859 10 ISO Latin 6 Table 1 Supported Font encodings If multiple extension options are requested then later ones override earlier ones Only in rare circumstances should it be necessary to do this For example if the latter encoding does not define characters in certain places but an earlier encoding does so and these characters occur within the source In this case the unicode extension ought to be loaded also else browsers may get quite confused about what to render 3 2 2 Multi lingual documents using Images Some multi lingual documents can be constructed when all the languages can be presented using characters from a single font encoding as discussed in the Section 3 2 1 Another way to present multiple languages within a Web document is to create images of individual letters words sentences paragraphs or even larger portions of text which cannot be displayed within the chosen font encoding This is a technique that is used with IndicTEX HTML for presenting traditional Indic language scripts within Web pages For
193. the commas are necessary space s lt tab gt s or newlines are equally effective Indeed the horizontal rules preceding and following the table were specified by HTMLcode 50 3 noshade center HR attribute names Usually it is not necessary to know the names of the attributes to the tags that are to be used It is sufficient just to give the values these will be matched to the appropriate attribute according to the type of data required If names are given these are case insensitive newlines Although IATPX ignores linebreaks within the source code this is not so with EXTRX2HTML The strange spreading out of the definition of the tablelist command above was done with the purpose solely of making the code in the resulting HTML files more easily readable to a human As most browsers ignore those newlines anyway more compact code would have rendered the same on screen 44 Some further aspects of the use of this HTML command are not apparent from the above example invalid lt tag gt Ifa lt tag gt is specified that is not part of the HTML 3 2 specifications then it and its attributes are not placed into the HTML document created by ATRX2HTML Any lt contents gt is included as ordinary data i e as text in paragraphs etc required attributes Some tags have attributes which are required to have values if that tag is to be included in an HTML document Using the HTML command if any such attribute is not given an appr
194. these the ETRX source that is to be presented as an image needs special treatment using a pre processor For the special styles defined in IndicT amp X HTML running the preprocessor is fully automated so that it becomes just another step within the entire image generation process The technique of using images can be used with any font whose glyphs can be typeset using TeX or ATEX Using TEX s font command a macro is defined to declare the special font required e g for Cyrillic characters using the Univ of Washington font font wncyr wncyri0 Now use this font switch immediately surrounded by braces published by wncyr Rus ski char26 char23zyk to get published by Pyccxkuit 3p 3 3 Mathematics There are various different ways in which ATRX2HTML can handle mathematical expressions and formulas e give a textual representation simple math 34http www texdev mpce mq edu au 12h indic IndicHTML 35 http www texdev mpce mq edu au 12h indic IndicHTML 17 e make an image of the complete formula or expression e combination of textual representation and images of sub expressions e SGML like representation built using abstract entities e g for the HTML Math model or for MathML Which is the most appropriate normally depends on the context or importance of the mathematics within the entire document What ATFX2HTML will produce depends upon 1 the version of HTML requested 2 whether or
195. this See an earlier problem for how to set the VERBOSITY variable to help locate the bad code leading to this memory exhaustion As a last resort you may consider increasing the virtual memory swap space of your machine install test issues dbm related error messages FATRX2HTML requires a DataBase Management system NDBM GDBM or SDBM in order to run This is usually part of each Unix like operating system and SDBM is part of Perl 5 but sometimes this is either missing on your operating system or left out in a binary Perl distribution Use Archie to find one or better update to a complete Perl 5 distribution 48http www pvv unit no archie 83 latex2html issues dbm related error messages If you get warnings like ndbm store returned 1 errno 28 key xyz at latex2html line 123 this is related to an overflow of IATFX2HTML internals You will need help from the list here If you get real error messages which cause IATRX2HTML to abort run install test to check if your DataBase management works You will probably need to re install Perl 5 see above topic This can happen when an image is being created from a large piece of ATFX source code The image reuse mechanism uses the code itself to construct a database key If too long the key is invalid and may crash DBM or NDBM In fact this error should no longer occur in v97 1 so please advise the JATRX2HTML developers if you get error messages of this kind T
196. this document from one of your documents without using labels Sure enough you can get the name of the physical file that this section is in This however is quite likely to change and any links to it would become invalid To update your link the name of the new file must be found and your link changed by hand Also there is no general updating mechanism so the only way to find out if your document is pointing to the right place is by actually following the link then doing a manual update Next consider how it could be done with symbolic labels First you have to import the labels used in this document by copying the file labels pl saving it in tmp labels pl say then adding anywhere in your document externallabels http cbl leeds ac uk nikos tex2html doc manual tmp labels p1l After that you can use the label crossrefs defined at the beginning of this section as follows externalref crossrefs This will be translated into the appropriate hyper link to this page If there are any changes in this document and you would like to bring your document up to date you have to copy labels pl again and rerun the translator on your document Of course if I move the directory containing the HTML files for this document somewhere else then you would have to make a change in the argument of the externallabels command to reflect this It is obvious that some level of collaboration is required between authors trying to maintain cr
197. ti lingual documents using Images ooa a a Mathematics e sssi a Soos a noka i a a OA a a a R ER oe ae a Figures and Image Conversion aooaa a e a 3 4 1 An Embedded Image Example o noaoo a 3 4 2 Image Sharing and Recycling ooa a 3 4 3 Quality of Printed Images aaau a a Figures Tables and Arbitrary Images aoaaa a Document Classes and Options aooaa a Packages and Style Files oo csasuaanruanraa ee 3 7 1 Fancy List Markers 2 2 0 0 0 000 2 eee eee 3 7 2 Support for FoilTpX lt c neces sc maseda naires ee 3 7 3 Indicating Differences between Document Versions Indexing a as Ge ae ew ee Pe ee a a eee Ee 3 8 1 Integrated Glossary and Index 000 a Hypertext Extensions to ATEX Hyper links in ATEX aoaaa ee Including Arbitrary HTML Mark up and Comments Arbitrary Tags and Attributes 0 002 200222005 Conditional Text lt a o e a 6 6586 6 bP eR REA ee ee Symbolic References shown as Hyperized Text 0 0 0040 Hypertext Links in Bibliographic References Citations Symbolic References between Living Documents 4 7 1 Cross Referencing Example 0 0 0 00 2000000005 Miscellaneous commands for HTML effects 0 00 0 000 Active Image Maps 1 aasa ks SETE Document Segmentation c ee nea arme wena eee beet eew ena s 4 10 1 A Segmentation Example 2 000000 ee eee 18This feature is supported o
198. tive images are equation and eqnarray environments when html_version 2 0 has been specified this is because their figure numbers are part of the image Figures and tables with captions on the other hand are order insensitive because the figure numbers are not part of the image itself Similarly when HTML 3 2 code is being pro duced equation numbers are no longer part of the image Instead they are placed in a separate cell of a lt TABLE gt So most images of mathematical formulas can be reused also 3 4 3 Quality of Printed Images 8b 1 28 1 8p mn T h p 73 aera 5 Pha al Ox 2 Ox ji 6 z3 i Pi41myn a 2D min 1 mn m i n 2D min Pi m 1 n eS ge 2 9 Bimari innt Binn nali 6 Figure 3 Displayed math environments with eztra scale of 1 5 Since it is often desirable to get a good quality print on paper directly from the browser Figure 3 shows the same equations as on page 20 This time the extrascale 1 5 option has been used This value of 1 5 means that more than twice the number of pixels are available for a cost of approximately 1 7 times the disk space 8 On screen these images appear slightly blurred or indistinct However there can be marked improvement in the print quality when printed from some browsers others may show no improvement at all The anti aliasing helps on screen In the printed version jagged edges are indeed softened but leave an o
199. tml tex input file containing definitions needed for segments of the HTML version of the IATPX2HTML manual 1 eee 12 manual aux auxiliary file created by running ATEX on the ATPX2HTML manual 12 manual glo collects unsorted glossary entries for the ATpX version of the AT X2HTML THOMA fg cat utes ee Gece alee glial least Ra E eg aes ele le ae eat 34 35 97 manual gls file containing the sorted entries for the glossary in the HTRX2HTML manual created by running makeindex on manual glo using 12hglo ist 12 35 manual idx collects unsorted index entries for the BTFX version of the ATRX2HTML Manual i022 eee dee 8b eed bee Pewee ote ew deeds Rew hed ee bee 97 manual ind file containing the sorted entries for the index in the ATRX2HTML manual created by running makeindex on manual idx using 12hidx ist 12 manual tex main FATRX source for the ATPX2HTML manual 12 Metafont generates bitmapped fonts for TeX and PTRX 73 89 91 97 99 misc subdirectory containing miscellaneous files used by Metafont often the location for modes M 2 vo ee ye eee Ra eA ea ea we OE eee ees i es 73 modes mf used by Metafont to customise font bitmaps for different printers 11 73 97 Mosaic commonly used Web browser see NCSA Mosaic below 88 mybutton gif file name used in example code for an image as a button to a hyperlink 79 natbib perl implements the commands in the natbib package allowing flexib
200. to in Override pm for Unix systems and to whatever else is appropriate on other platforms 04 72 default_language specifies the language whose international code should be specified within th lt DOCTYPE ae 403d bw eee eed wae haday GEA a eens 9 75 depth holds the value of the sectioning depth when the lt ADDRESS gt tag of an HTML page is being created sav caheodbre dere ee de a eae de baa bee ahaa hha 67 file holds the name of the HTML page when its lt ADDRESS gt tag is being created 67 title holds the title of the current section when the lt ADDRESS gt tag of an HTML is being CECADC Ue oy heat ot e dt braves Enema tet A EE ete ENE aE eases Mr nec lane CGAL beta 67 amsfonts perl contains code to recognise or implement features of the amsfonts package oA i a4 tees ooh ged aa hat bas va ae eae ee 29 amstex perl contains code to recognise or implement features of the amstex package for PIFS ergas eB ghee le Poa Bie os a Ee a sala ed eae J 29 anonymous ftp pseudonym for use of the ftp program as the anonymous user for file CPansfers pecori e p seaedaae ge Sa PEE ER gang cease e EE E ah BA owned dss 6 Archie publicly accessible database of files and programs available via anonymous ftp or using the Web aega ee t pri by biana Ra eR en 6 8 83 88 Arena Web browser currently the only one which displays HTML 3 1 math markup 15 article perl implements section numbering conventions etc for the arti
201. to an unending loop See the previous item for how to detect which com mand or environment is causing the problem Perl cannot parse the latex2html1 script If Perl refuses to start T X2HTML and is sues errors your Perl version is not up to date Update your Perl to 5 003 or later You can check which version of Perl you are using by invoking Perl with the v option If Perl issues errors during runtime this is most probably related to bugs within FXTRX2HTML or one of its modules In this case you will need help from the developers or experienced users this can be obtained via the discussion list It crashes dumps core as soon as it starts Update your Perl to 5 003 or later 82 It does not show any of your images You can t run TRX2HTML in a subdirectory that contains a dot within the directory name such as latex2htm1 98 1 or in name of any higher directory This is because dvips s o option will change 98 1 into 98 001 and use that as the resulting output file instead of image001 The PostScript files will be placed higher up in the directory tree For instance if pwd returns something like usr people nelson files latex2html1 98 1 work tests and you run JATRX2HTML then dvips will generate image output files here usr people nelson files called latex2htm1 98 001 latex2htm1 98 002 instead of image001 image002 image003 in the subdirectory where your html files were created As a result the images wil
202. to be used as those for the default printer Because they were designed for a printer of much greater resolution than the screen equations will generally appear to be of a lower quality than is otherwise possible To cause ATRX2HTML to dynamically generate fonts that are de signed specifically for the screen you should specify a value of 1 for this variable If you do then check to see whether your version of dvips supports the command line option mode If it does then also set the installation variable DVIPS_MODE to a low resolution entry from modes mf such as toshiba It may also be necessary to edit the MakeTeXPK script to recognise this mode at the appropriate resolution If you have PostScript fonts available for use with TFX and dvips then you can probably ignore the above complications and simply set PK GENERATION to 0 and DVIPS_MODE to the empty string You must also make sure that gs has the locations of the fonts recorded in its gs_fonts ps file This should already be the case where GS Preview is installed as the viewer for dvi files using the PostScript fonts If dvips does not support the mode switch then leave DVIPS_MODE undefined and verify that the dvipsrc file points to the correct screen device and its resolution e The installation variable AUTO_PREFIX allows the filename prefix to be automatically set to the base filename prefix of the document being translated This can be especiall
203. ttp www dsed 11n1 gov files programs unix latex2html sources Two other ftp sites are e http ctan tug org ctan tex archive support latex2html e http ftp rzg mpg de pub software latex2html sources Other ftp sites nearer to you can be found using Archie at http hoohoo ncsa uiuc edu archie html or http www pvv unit no archie faster or more recent Web searching tools such as FTP search in Norway Warning Some ftp sites may not carry the latest version Updates and patches are posted on the ATRX2HTML server at http www dsed 11ln1 gov files programs unix latex2html1 For users of Windows NT there is a port of TEX2HTML obtainable from ftp ftp ese metz fr pub TeX win32 Obtain the release from this site and follow the instructions in the accompanying file README win32 Thanks to Fabrice Popineau for this work In future it is planned to merge this code with the main distribution Finally there is the MTRX2HTML developers CVS repository at http saftsack fs uni bayreuth de latex2ht user The files to be found here are the most up to date with current developments but they cannot be guaranteed to be fully reliable New features may be still under development and not yet sufficiently tested for release A daily updated compressed archive of the develop ers work may be downloaded from http saftsack fs uni bayreuth de latex2ht 12h latest tar gz 4nttp ctan tug org ctan tex archive support latex2html
204. ty transforming it into pstoimg which now allows for alternative image formats such as PNG Also he produced the neat configure pstoimg script which eases 4TR X2HTML installation and a rewrite of texexpand Marcus Hennecke who has always been there up to date with developments in HTML and related matters concerning Web publishing and tackling the issues involved with portability of IATRX2HTML to Unix systems on various platforms Furthermore Marcus has produced IATRX2HTML NG a version of EATEX2HTML which handles expansion of macros in a more TFX like fashion This should lead to further improvements in speed and efficiency while allowing complicated macro definitions to work as would be expected from their expansions under ATRX This requires Perl 5 using some programming features not available with Perl 4 Fabrice Popineau has produced an adaptation for the Windows NT platform of LTFX2HTML v97 1 Uli Wortmann showed how to configure Ghostscript to produce anti aliasing effects within images Axel Ramge for various suggestions and examples of enhancements and the code to avoid a problem with Ghostscript Thanks also to all those who have made bug reports supplied fixes or offered suggestions as to features that might allow JATRX2HTML to be used more efficiently in particular circum stances Most of these have been incorporated into this new version v97 1 though perhaps not in the form originally envisaged Such feedback h
205. uch definitions make use of sectioning or verbatim commands These are handled in a special way by BETEX2HTML and cannot be used in macro definitions input commands There is a bug in the expansion of input commands which may cause a problem when more than one input command appears on the same line There is no quick fix other than suggesting that you put each input command on a line by itself in the IJATRX source files input commands in verbatim environments These should no longer cause problems actually since 97 1 input commands are also handled correctly within comment environments declared using excludecomment and when loading multiple aux files due to use of the include command Alternatively you might want to use either the verbatim or the verbatimfiles package 84 Optional arguments in description environments If you have optional arguments for the item command in a description environment containing nested characters then these may not show up correctly To avoid the problem enclose them in s e g item mested angle brackets are ok PTRX2HTML behaves differently even when you run it on the same file If you notice any strange side effects from previous runs of ATRX2HTML try using the option no_reuse and choose d when prompted This will clear any intermediate files generated during previous runs Note that this option will disable the image reuse mechanism Cannot convert PostScript i
206. ument segments that would not otherwise have one index lt URL gt Same as setting EXTERNAL_INDEX lt URL gt Specifies a URL for the INDEX button for document segments that otherwise would not have an index biblio lt URL gt Same as setting EXTERNAL_BIBLIO lt URL gt Specifies the URL for the bibliography page to be used when not explicitly part of the document itself Warning On some systems it is difficult to give text strings lt string gt containing space characters on the command line or via a Makefile One way to overcome this is to use the corresponding variable Another way is to replace the spaces with underscores _ 5 2 6 Switches for Help and Tracing The first two of the following switches are self explanatory When problems arise in process ing a document the switches debug and verbosity will each cause TRX2HTML to generate more output to the screen These extra messages should help to locate the cause of the problem tmp lt path gt Define a temporary directory to use for image generation If lt path gt is 0 the standard temporary directory tmp is used h elp Print out the list of all command line options v Print the current version of YTRX2HTML debug Same as setting DEBUG 1 Run in debug mode displaying messages and or diagnostic information about files read and utilities called by ATRX2HTML Shows any messages produced by these calls More extensi
207. uration or initialisation file the default value will be assumed The lowercase form charset is also recognised but this is overridden by the uppercase form ACCENT_IMAGES large Accented characters that are not part of the ISO Latin fonts can be generated by making an image using TpX This variable contains a comma separated list of TFX commands for setting the style to be used when these images are made If the value of this variable is empty then the accent is simply ignored using an un accented font character not an image instead Within the color perl package the following variables are used to identify the names of files containing specifications for named colors Files having these names are provided in the LATEX2HTMLSTYLES directory but they could be moved elsewhere or replaced by alternative files having different names In such a case the values of these variables should be altered accordingly RGBCOLORFILE rgb txt CRAYOLAFILE crayola txt The following variables may well be altered from the system defaults but this is best done using a local latex2html init initialisation file for overall consistency of style within documents located at the same site or sites in close proximity 74 default_language english This establishes which language code is to be placed within the lt DOCTYPE gt tag that may appear at the beginning of the HTML pages produced Loading a package for
208. values are being set htmlbase lt URL gt This specifies that the given lt URL gt be included in the lt HEAD gt section of each HTML page via a tag lt BASE HREF lt URL gt Such a feature is particularly useful e when preparing a document whose final location may be different from where it was created By making all internal references be relative to the the provided lt URL gt a whole directory tree containing the document and all its subparts can be moved to elsewhere A single edit in each HTML file produces the complete document intact at the new location e by allowing just single page to be copied to another location but act as if it were part of the original document provided this is accessible across the Web Relative URLs within the copied page are relative to the base lt URL gt rather than relative to the new location e Other uses for this feature are likely to become apparent HTMLset lt which gt lt value gt and HTMLsetenv lt which gt lt value gt The HTMLset command provides a mechanism whereby an arbitrary Perl variable can be assigned a value dynamically during the ATRX2HTML processing A variable having name lt which gt is assigned the specified lt value gt overwriting any value that may exist already The HTMLsetenv is for the same purpose but it is expanded in order as if it were an envi ronment rather than a command Warning This is intended for Perl programmers only Us
209. ve diagnostics from the Perl debugger can be obtained by appending the string w to the 1st line of the latex2html and other Per script s verbosity lt num gt Same as setting VERBOSITY lt num gt Display messages revealing certain aspects of the processing performed by ATRX2HTML on the provided input file s The lt num gt parameter can be an integer in the range 0 to 8 Each higher value adds to the messages produced 0 No special tracing as for versions of BTEX2HTML prior to v97 1 This is the default Show section headings and the corresponding HTML file names and indicators that major stages in the processing have been completed 2 Print environment names and identifier numbers and new theorem types Show warnings as they occur and indicators for more stages of processing Print names of files for storing auxiliary data arrays 71 3 Print command names as they are encountered and processed also any unknown commands encountered while pre processing Show names of new commands environments theorems counters and counter dependencies for each document partition 4 Indicate command substitution the pre process of math environments Print the contents of unknown environments for processing in BTFX both before and after reverting to TEX source Show all operations affecting the values of counters Also show links labels and sectioning keys at the stages of processing 5 Detail the processing in the
210. verall fuzziness Figure 4 shows the same equations yet again this time with extrascale 2 0 Now there are 4 times the pixels at a cost of roughly 2 45 times the disk space Compared with the previous images having 1 5 times extra scaling there is little difference in the on screen images Printing at 300 dpi shows only a marginal improvement but at 600 dpi the results 38This figure varies with the graphics format used and the complexity of the actual image 25 are most satisfying especially when scaled to be comparable with normal 10 pt type as here Drima h SPI ows o dd 1 06 1 0 6 7 Ox 2 Ox 6 r Jimm Diim n 291 m n Pi1 m n Ea Pim in aad 2D m n i m 1 n h h Pim nti 291 myn P mjn 1 72 Limn v 8 Figure 4 Displayed math environments with eztra scale of 2 0 3 5 Figures Tables and Arbitrary Images This section is to explain how the translator handles figures tables and other environments Compare the paper with the online version When the common version of HTML was only 2 0 then almost all complicated environ ments were represented using images However with HTML 3 2 there is scope for sensible layout of tables and proper facilities for associating a caption with a figure or table To take advantage of this the figure environment now has its contents placed within lt TABLE gt tags any caption is placed as its lt CAPTION gt For consistency with former p
211. w utcc utk edu utcc docs Facilities and Services GNU Emacs Help Sheet Intro to Unix vi editor Software Support Journals Conference Proceedings Newsletters CERN Computer Newsletter http consult cern ch cnls issues 214 224 National Symposium in Mathematics http www maths mq edu au texdev MathSymp American Mathematical Society AMS http www ams org journals Articles in the following electronic journals use a variant of ATRX2HTML Bulletin of the AMS Conformal Geometry and Dynamics Electronic Research Announcements Other AMS journals are available only to subscribers Journal of the AMS Mathematics of Computation Representation Theory Proceedings of the AMS Transactions of the AMS Encyclopedic Reference Material Eric s Treasure Troves of Science Astronomy Chemistry Math Music Physics Rocket History Scientific Books Scientific Biographies Resources for Economists on the Internet http wueconb wustl edu EconFAQ Les math mes de Lacan by Jacques Siboni http www shef ac uk psysc thesaur3 index html Course Materials Mathematics Courses at Macquarie University MATH130 MATH132 MATH233 MATH300 MATH337 Engineering Science 1007 Simon Fraser University Other Interesting Sites relQX http www ramge de ax ax htm1 Uli Wortmann s thesis and Geological papers use anti aliased images Die untere und mittlere Kreide The Barium Problem Stanford Computer G
212. what appears in the nav igation panels and in what order As each section is processed HTRX2HTML assigns relevant information to a number of global variables These variables are used by the subroutines top_navigation_panel and bottom navigation_panel where the navigation panel is con structed as a string consisting of these variables and some formatting information These subroutines can be redefined in a system or user configuration file respectively LATEX2HTMLDIR latex2html config and HOME latex2html init Any combination of text HTML tags and the variables mentioned below is acceptable The control panel variables are Iconic links buttons UP Points up to the parent section NEXT Points to the next section NEXT_GROUP Points to the next group section PREVIOUS Points to the previous section PREVIOUS_GROUP Points to the previous group section CONTENTS Points to the contents page if there is one INDEX Points to the index page if there is one Textual links section titles UP_TITLE Points up to the parent section NEXT_TITLE Points to the next section NEXT_GROUP_TITLE Points to the next group section PREVIOQUS_TITLE Points to the previous section PREVIOUS_GROUP_TITLE Points to the previous group section If the corresponding section exists each iconic button will contain an active link to that section If the corresponding section does not exist the button will be inactiv
213. within JATRX2HTML 1 1 List of Features Following is a listing of the main features of the translator more specific details on these is given elsewhere in this manual The EATRX2HTML translator e breaks up a document into one or more components as specified by the user e provides optional customisable iconic navigation panels on every page which contain links to other parts of the document or other documents e handles inlined equations X i i f handles equation alignment ABo4p right justified numbered equations see equation 1 tables see Table 4 figures see Figure 2 and any arbitrary environment Either the complete environment or sub parts thereof are passed to ATRX for conversion to images which are then either included in the document or are made available through hypertext links The user can specify the depth at which the document should not be broken up any further e figures or tables can be arbitrarily scaled and oriented and shown either as inlined images or thumbnail sketches or their contents displayed within a table constructed using the lt TABLE gt tags of HTML 3 2 e theorem like environments are supported along with automatic numbering and counter dependencies e can produce output suitable for browsers that support inlined images or character based browsers as specified by the user In particular the T X or TFX code for mathematical expressions and formulas will be displa
214. x2html init Note that you must run install test now formerly you could manage without If you want to reconfigure ATEX2HTML for GIF PNG image generation or because some of the external tools changed the location simply rerun configure pstoing This is usually enough for the main installation but you may also want to do some of the following to ensure that advanced features of MTRX2HTML work correctly on your system e To use the new PTF X commands which are defined in html sty Make sure that ATEX knows where the html sty file is either by putting it in the same place as the other style files on your system or by changing your TEXINPUTS shell environment variable or by copying html sty into the same directory as your BTFX source file The environment variable TEXINPUTS is not to be confused with the ATFX2HTML in stallation variable TEXINPUTS described next 10 e There is an installation variable in latex2html config called TEXINPUTS which tells BTEX2HTML where to look for ATFX style files to process It can also affect the input path of ATX when called by ATRX2HTML unless the command latex is really a script which overwrites the TEXINPUTS variable prior to calling the real latex This variable is overridden by the environment variable of the same name if it is set e The installation variable PK_GENERATION specifies which fonts are used in the gener ation of mathematical equations A value of 0 causes the same fonts
215. xternal document Note that for remote external documents it is necessary to copy the labels pl file locally so that it can be read when processing a local document that uses it The command externallabels can be used once for each external document in order to import the external labels into the current document A warning is given if labels pl cannot be found If a symbolic reference made in either of the commands described in Section 4 5 is not defined within the document itself ATRX2HTML will look for that reference in one of the external files After any modifications in an external document sections added deleted segmentation into different physical parts etc a new labels pl will be generated If the externallabels command in another document contains the correct address to an updated copy of the labels p1 file then the cross references will be re aligned after running the local document through the translator There is also a mechanism analogous to the label ref pairs of BTFX which can be used only within a single document These labels are called internal labels as opposed to the external labels defined above They are used extensively with the document segmentation strategy described in Section 4 10 Either type of label is defined with a JATRX label command Labels can be referenced within a document using a ref command When processed by E TRX each ref command is replaced by the section number in which the corresponding l
216. y useful for multiple segment documents e The makemap script also has a configuration variable SERVER which must be set to either CERN or NCSA depending on the type of Web server you are using e To set up different initialization files For a per user initialization file copy the file dot latex2html init in the home directory of any user that wants it modify it according to her preferences and re name it as latex2html init At runtime both the latex2html config file and HOME latex2html init file will be loaded but the latter will take precedence You can also set up a per directory initialization file by copying a version of latex2html init in each directory you would like it to be effective An initialization file X Y Z latex2html init will take precedence over all other initialization files if X Y Z is the current directory when JATRX2HTML is invoked Warning This initialization file is incompatible with any version of ETEX2HTML prior to v96 1 Users must either update this file in their home directory or delete it altogether e To make your own local copies of the AT X2HTML icons Please copy the icons subdirectory to a place under your WWW tree where they can be served by your server Then modify the value of the ICONSERVER variable in latex2html config accordingly Alternatively a local copy of the icons can be 11 included within the subdirectory containing your completed HTML documents This is
217. yed in character based browsers such as lynx e coloured text and or background is fully supported as is the ability to use an image to create a tiled backdrop e handles definitions of new commands environments and counters even when these are defined in external files for input e handles footnotes tables of contents lists of figures and tables bibliographies and can generate an index By including hyperlinks between index entries simple navigation aids can be built into the index for easy browsing e automatically translates cross references and citations into hyper links and extends the ATpX cross referencing mechanism to work not just within a document but between documents which may reside in remote locations e translates ESTEX accent and special character commands e g A 6 F to the equivalent ISO Latin 1 or Unicode character set else an image can be created e recognises hypertext links to multi media resources or arbitrary Internet services such as sound video ftp http news and links which invoke arbitrary program scripts all expressed as ATFX commands e recognises conditional text which is intended only for the hypertext version or only for the paper dvi version e can include raw HTML in a ATRX document e g in order to specify interactive forms e can deal sensibly with virtually all of the concepts and commands described in the BTEX blue book where there is a meaningful interpretation ap
218. ztra scale of 1 5 0 0 0 002 25 Displayed math environments with ertra scale of 2 0 0 26 An electronic form In the online version the form would be active 42 Example use of macros for raw HTML code oaaae a 43 List of Tables N AMONA O Supported Font encodings aooaa a 17 Mathematics translation strategies for HTML versions 3 0 and 3 2 using lt SUP gt and lt SUB gt tags and lt TABLE gt s aaau a 18 Mathematics translation strategies for HTML version 2 0 19 A sample table taken from 1 ooo aaa 26 Alternate view of the table from 1 o oaa a 27 Supported ATRX2HTML packages and style files 2 a aaa a 29 Supported JATRX2HTML packages and style files 2 0 00 30 Snttp csep1 phy ornl gov csep html xiii 1 Overview This manual describes the ETFX2HTML translator which is used to create Web pages from document source written for the JATRX typesetting system or simply containing MTRX commands To use JATRX2HTML to translate a file lt file gt tex containing ATfX commands simply type latex2html lt fzle gt tex This will create a new directory called lt file gt which will contain the generated HTML files some log files and possibly some images Basically the translator reads the source document and creates a linked set of HTML pages displaying the information it contains The ETRX commands and environments that are found are interpreted either a

The LATEX2HTML Translator

Contents

Download Pdf Manuals

Related Search

Related Contents