B.11 Moving Information Around
B.11.1 Files
HEVEA can use some of the ancillary files generated by LATEX in
order to output better looking cross-references.
In practice, while processing file mydoc.tex, the following
files may be read:
- .aux
- The file mydoc.aux contains
cross-referencing informations, such as figure or section numbers.
If this file is present, HEVEA reads it and put such numbers (or
labels) inside
the links generated by the
\ref
command. If the .aux
file is not present, all such numbers are
replaced by ``X''.
- .bbl
- The file mydoc.bbl is generated by
BibTeX. It is read by the
\bibliography
command.
- .idx
- The file mydoc.idx is
normally not
read by HEVEA, which does its own index computations.
Some user modify .idx files before running
makeindex
, for instance to sort index entries taking
non-English diacritics into account.
HEVEA can read such files and use the index entry labels they define,
provided it is given the -idx
option.
Thus, if you follow such a scheme on mydoc.tex, first run
LATEX, process mydoc.idx and invoke HEVEA with the
-idx
option set.
HEVEA does not fail when it cannot find an auxiliary file.
B.11.2 Cross-References
The LATEX \label
and \ref
are changed by HEVEA
into HTML anchors and local links.
Additionally, numerical references to sectional units, figures,
tables, etc. are shown, as they would appear in the .dvi file,
provided a .aux file exists.
Numerical references to pages (such as generated by \pageref
)
are not shown; only an link is generated.
Thus, to get the cross references right in a document,
mydoc.tex, you should first generate an
up-to-date mydoc.aux file by running LATEX as many times
as necessary.
If no mydoc.aux exists, all references are shown as
``X''.
If a non-correct mydoc.aux file is present, then cross
references will apparently be wrong. However the links are correct in
both cases.
B.11.3 Bibliography and Citations
The \cite
macro is supported. Its optional argument is
correctly handled. Citation labels are extracted from the
.aux file, if present. Otherwise the argument to
cite
is used.
The \bibliography
command is
recognized, it loads the .bbl file which should thus
have been generated before, using the appropriate combination of
LATEX and BibTeX runs.
The thebibliography
environment is recognized.
The \nocite
and \bibliographystyle
macros exist and do
nothing.
B.11.4 Splitting the Input
The \input
and \include
commands exist and they perform
exactly the same operation of searching a file.
Given filename, an the argument to \input
or
\include
,
a file is searched as follows:
- If filename is an absolute path, then HEVEA
attempt to open a file with this name exactly.
- Otherwise, HEVEA searches a file with name
filename in all the directories in its search path.
Additionally, if filename
does not have an
extension and that a first attempt to find it fails, then a second
attempt is made, looking for file filename.tex.
The search path starts with the current directory ``.'' and
ends with HEVEA installation directory.
Users can modify the search path by using command lines options and
the HEVEADIR shell variable, see section C.1.1.
The \includeonly
command is supported, while the
\listfiles
command is a null command.
B.11.5 Index and Glossary
HEVEA supports several simultaneous indexes, following the scheme
of the
index style,
which is present in modern LATEX distributions.
This scheme is backward compatible with the standard indexing scheme
of LATEX.
Observe that HEVEA does its own index computation and does not need
makeindex
.
More precisely, HEVEA knows the following commands:
- \newindex{tag}{ext}{ignored}{indexname}
-
Declare an index.
The first argument tag is a tag to select this index in other
commands; ext is the extension of the index information file
generated by LATEX (e.g., idx); ignored is ignored by
HEVEA; and indexname is the title of the index.
If given the
idx
option. HEVEA attempts to read file
mydoc.ext. There also exists a
\renewindex
commands that takes the same arguments and that can be
used to redefine previously declared indexes.
- \makeindex
- Perform
\newindex{default}{idx}{ind}{Index}
.
- \index[tag]{arg}
-
Act as the LATEX
\index
command except that the information
extracted from arg goes to the tag index.
The tag argument defaults to default
, thereby yielding
standard LATEX behavior for the \index
command without an
optional argument.
There also exists a stared-variant \index*
that Additionally
typesets arg.
Glossaries are not handled (who uses them ?) and the theindex
environment does not
exist (since HEVEA computes its own indexes).
B.11.6 Terminal Input and Output
The \typeout
command echos its argument verbatim on the
terminal.
The \typein
command is not supported.