The hevea command has two operating modes, normal mode and filter mode. Operating mode is determined by the nature of the last command-line argument.
The hevea command interprets its arguments as names of files and attempts to process them. Given an argument filename there are two cases:
In all attempts, implicit filenames are searched along hevea search path, which consist in:
The hevea library directory is fixed at compile-time
(this is where hevea library files are installed)
and typically is /usr/local/lib/hevea.
However, this compile-time value can be overridden
by setting the HEVEADIR shell environment variable.
In all cases, the value of hevea library directory can
be accessed from the processed document as the value of the command
\@hevealibdir
.
If the last argument has an extension that is different from
.hva or has no extension,
then it is interpreted as the name of the main input file.
The main input file is the document to be translated and normally
contains the \documentclass
command.
In that case two basenames are defined:
-o
option (see the section on options below).
HEVEA will attempt to load the main input file.
Ancillary files from a previous run of LATEX
(i.e., .aux, .bll and .idx files)
will be searched as basein.
ext.
The output base name governs all files produced by HEVEA.
That is, HTML output of HEVEA normally goes to the file
baseout.html,
while cross-referencing information goes into
baseout.haux. Furthemore,
if an image file is generated (cf. section 6), its
name will be baseout.image.tex.
Thus, in the simple case where the hevea command is invoked as:
# hevea file.tex
The input basename is file and the output basename also is file. The main input file is searched once along hevea search path as file.tex. HTML output goes into file file.html, in the current directory.
In the more complicated case where the hevea command is invoked as:
# hevea ./dir/file
The input base name is ./dir/file and the output basename is file. The main input file is loaded by first attempting to open file ./dir/file.tex, then file ./dir/file. HTML output goes into file file.html, in the current directory.
The article.hva, seminar.hva, book.hva and
report.hva
base style files from HEVEA library are special.
Only the first base style file is loaded and the
\documentclass
command has no effect when a base style file is
already loaded. This feature allows to override the document base style.
Thus, a document file.tex can be translated using the
article base style as follows:
# hevea article.hva file.tex
If there is no command-line argument, or if the last command-line
argument has the extension .hva, then
there is neither input base name nor output base name,
the standard input is read and
output normally goes to the standard output.
Output starts immediately, whithout waiting for \begin{document}
.
In other words hevea acts as a filter.
Please note that this operating mode is just for translating
isolated LATEX constructs.
The normal way to translate a full document file.tex
being
“hevea
file.tex
” and not
“hevea <
file.tex >
file.html
”.
The hevea command recognizes the following options:
DIV
and P
are bordered,
while the structure of displayed material is also shown.
The following options control the HTML code produced by hevea. By default, hevea outputs a page encoded in iso-latin1, with most symbols rendered as HTML or numerical Unicode entities. To our knowledge, this behavior is satisfactory only if the input file is encoded in iso-latin1 or in plain ascii.
<PRE>
… </PRE>
, which are otherwise performed.
The following options select and control alternative output formats (see section 11):
Part A of this document is a tutorial introduction to HEVEA, while HEVEA reference manual is part B.
The hacha command interprets its argument base.html as the name of a HTML source file to cut into pieces.
It also recognizes the following options:
\t
file” line per anchor.
This information may be needed by other tools.
Section 7 of the user manual explains how to alter HACHA default behavior.
The program esponja is part of HEVEA and is designed to optimize hevea output. However, esponja can also be used alone to optimize text-level elements in HTML files. Since esponja fails to operate when it detects incorrect HTML, it can be used as a partial HTML validator.
With no argument, esponja acts as a filter, it reads the standard input and writes on the standard output. Otherwise, esponja interprets its arguments as names of files and attempt to process them. It is important to notice that esponja will replace files by their optimized versions.
Hence, to optimize file foo.html into foo_opt.html, one should invoke esponja as follows.
# esponja < foo.html > foo_opt.html
By contrast, invoking esponja as
# esponja foo.html
will alter foo.html. Of course, if esponja does not succeed in making foo.html any smaller or if esponja fails, the original foo.html is left unchanged. Note that this feature allows to optimize all HTML files in a given directory by:
# esponja *.html
The command esponja recognizes the following options:
The program bibhva is a simple wrapper, which basically forces bibtex into accepting a .haux file as input and producing a .hbbl file as output. Usage is bibhva bibtex-options basename.
The command imagen is a simple shell script that translates a LATEX document into many .gif images. The imagen script relies on much software to be installed on your computer, see Section C.4.1.
It is a companion program of HEVEA, which must have been previously run as:
(In both cases, base is HEVEA output basename.) When told to do so (see section 6) HEVEA echoes part of its input into the base.image.tex file.
The imagen script should then be run as:
The imagen script produces one basennn.gif image file per page in the base.image.tex file.
This is done by first calling latex on base.image.tex, yielding one dvi file. Then, dvips translates this file into one single Postscript file that contains all the images, or into one Postscript file per image, depending upon your version of dvips. Postscript files are interpreted by ghostscript (gs) that outputs ppm images, which are then fed into a series of transformations that change them into .gif files.
The imagen script recognizes the following options:
The first three options enable users to correct some misbehaviors. For instance, when the document base style is seminar, image orientation may be wrong and the images are too small. This can be cured by invoking imagen as:
Notice that hevea calls imagen by itself,
when given the command-line option -fix.
In that situation, the command-line options of imagen can
be controled from source file by using the
command \@addimagenopt
(see Section 10.7).
Here is a typical Makefile for translating a doc.tex source file into HTML. The file is first translated into doc.html by hevea, which also reads the specific style file macros.hva. Then, hacha cuts doc.html into several, doc001.html, doc002.html, etc. also producing the table of links file index.html.
HEVEA=hevea HEVEAOPTS=-fix HACHA=hacha #document base name DOC=doc index.html: $(DOC).html $(HACHA) -o index.html $(DOC).html $(DOC).html: macros.hva $(DOC).tex $(HEVEA) $(HEVEAOPTS) macros.hva $(DOC).tex clean: rm -f $(DOC).html $(DOC).htoc $(DOC).haux rm -f index.html $(DOC)[0-9][0-9][0-9].html $(DOC).css
First, thanks to the -fix
options, hevea will run the
appropriate number of times automatically.
Note that the clean rule removes all the doc001.html,
doc002.html, etc. and doc.css files produced by
hacha.
Also note that make clean also removes the
doc.haux and doc.htoc files, which are HEVEA
auxiliary files.
When the image file feature is used, one can use the following, extended, Makefile:
HEVEA=hevea HEVEAOPTS=-fix HACHA=hacha IMAGEN=imagen #document base name DOC=doc index.html: $(DOC).html $(HACHA) -o index.html $(DOC).html $(DOC).html: macros.hva $(DOC).tex $(HEVEA) $(HEVEAOPTS) macros.hva $(DOC).tex clean: rm -f $(DOC).html $(DOC).htoc $(DOC).haux rm -f index.html $(DOC)[0-9][0-9][0-9].html $(DOC).css rm -f $(DOC).image.* $(DOC)[0-9][0-9][0-9].gif
Observe that the clean rule now also gets rid of
doc.image.tex and of the various files produced by
imagen. Note the following, useful feature:
when given the -fix
option, hevea will run
imagen, if needed.