Next: 7 Style Guide Up: LaTeX2HTML Authors' Guide Previous: 5 General Practice

6 html.sty: hypertext extensions to LaTeX

LATEX2HTML provides the file html.sty which defines extensions to standard LATEX that are important when co-mastering Postscript and HTML documents.

html.sty provides three new environments, invoked by

   \begin{environment_name}
....
\end{environment_name}


htmlonly
An environment within which LATEX commands will be interpreted only when producing the HTML output with LATEX2HTML. Its contents are ignored by LaTeX2e when generating the .dvi, hence PostScript, output.

latexonly
An environment within which LATEX commands will be interpreted only when producing the .dvi output. Its contents are ignored when generating the .html output with LATEX2HTML.

rawhtml
An environment within which you can insert HTML commands directly for processing when LATEX2HTML generates the .html output. Its contents are ignore by t LaTeX2e when generating the .dvi output.

html.sty also provides eight new commands:

htmlref
A direct way to make an internal hypertext link to a LATEX \label{reference} statement. The syntax is \htmlref{text}{reference}. The .dvi output will show only the text string. The .html will highlight text as a internal hypertext link to the place in the document where \label{reference} marked a section, equation, table, etc.

As above, except that the hypertext link is to an external URL, e.g. to:
http://www.cv.nrao.edu/cv-home.html.

As above, except that in the .dvi output the URL of the link is displayed as a footnote.
hyperref
A conditional text command. \hyperref{text1}{text2}{text3}{reference} displays text1 as the highlit text in the .html output, with an internal hypertext link to the reference label. In the .dvi output, text2 is the prefix text for, and text3 the suffix text to, the counter value corresponding to reference. For example,
\hyperref{Style Guide}{Style Guide (see Section}{below)}{sec:style}

produces the text
Style Guide (see Section 7 below)

in the .dvi output and a Style Guide hyperlink in the .html output.

htmlimage
Used inside any environment that is converted into an inlined image (e.g., a figure environment) to control how the image will be translated when LATEX2HTML is run. The arguments are a string of options separated by commas:
[scale=<scale factor>],[external],[thumbnail=<reduction factor>].
The scale option controls the size of the final image. The external causes the image not to be inlined (the default), but instead to be made accessible via a hypertext link. The thumbnail option causes a small inlined image to be placed in the caption; the thumbnail size depends on the reduction factor (use of thumbnail implies use of external). For example: \htmlimage{scale=1.5,external,thumbnail=0.2} causes a thumbnail image 1/5th of the original size to be placed in the document, pointing to an external image 1.5 times bigger than the original.

The syntax is \htmladdimg{URL}, where the single argument URL specifies the URL of an image that will be inserted only in the .html output.

htmlcite
provides a reference in the HTML version only. First argument is text for both versions, second is citation for use in the HTML version.

htmlrule
Adds a horizontal rule, valid even within a figure caption.

Next: 7 Style Guide Up: LaTeX2HTML Authors' Guide Previous: 5 General Practice

Home | Contact Us | Directories | Site Map | Help | Search

2001-06-08