This manual documents the Eplain macros, version 3.0, September 2005. Eplain provides functionality for plain TeX that is intended to be useful regardless of how your document is actually formatted.
Most of this manual is in the public domain, like most of the Eplain code. It was mostly written by Karl Berry, starting in 1989. Steven Smith wrote the documentation for the commutative diagram macros; this chapter is under the GNU General Public License. Oleg Katsitadze and Adam Lewenberg have made additions and corrections.
--- The Detailed Node Listing ---
User definitions
Citations
Displays
Lists
Cross-references
Equation references
Indexing
Indexing terms
Hyperlinks
Implicit hyperlinks
Index hyperlinks
Hyperlink drivers
Hyperlink drivers pdftex and dvipdfm::
Setting hyperlink types and options
Turning hyperlinks on/off
Arrow theoretic diagrams
Commutative diagrams
Programming definitions
Expansion
The Eplain macro package expands on and extends the definitions in plain TeX. This manual describes the definitions that you, as either an author or a macro writer, might like to use. It doesn't discuss the implementation; see comments in the source code (xeplain.tex) for that.
Eplain is not intended to provide “generic” typesetting capabilities, as do LaTeX (written by Leslie Lamport) or Texinfo (written by Richard Stallman and others). Instead, it provides definitions that are intended to be useful regardless of the high-level commands that you use when you actually prepare your manuscript.
For example, Eplain does not have a command \section
, which
would format section headings in an “appropriate” way, such as
LaTeX's \section
. The philosophy of Eplain is
that some people will always need or want to go beyond the macro
designer's idea of “appropriate”. Such canned macros are
fine—as long as you are willing to accept the resulting output. If
you don't like the results, or if you are trying to match a different
format, you are out of luck.
On the other hand, almost everyone would like capabilities such as cross-referencing by labels, so that you don't have to put actual page numbers in the manuscript. The author of Eplain is not aware of any generally available macro packages that (1) do not force their typographic style on an author, and yet (2) provide such capabilities.
Besides such generic macros as cross-referencing, Eplain contains another set of definitions: ones that change the conventions of plain TeX's output. For example, math displays in TeX are, by default, centered. If you want your displays to come out left-justified, you have to plow through The TeXbook to find some way to do it, and then adapt the code to your own needs. Eplain tries to take care of the messy details of such things, while still leaving the detailed appearance of the output up to you.
Finally, numerous definitions turned out to be useful as Eplain was developed. They are also documented in this manual, on the chance that people writing other macros will be able to use them.
You can send bug reports or suggestions to
tex-eplain@tug.org. The current version number of Eplain is
defined as the macro \fmtversion
at the end of the source file eplain.tex. When corresponding,
please refer to it.
To get on this mailing list yourself, email tex-eplain-request@tug.org with a message whose body contains a line
subscribe you@your.preferred.address
The simplest way to install Eplain is simply to install the file eplain.tex in a directory where TeX will find it. What that directory is obviously depends on your operating system and TeX installation. I personally install eplain.tex in a directory /usr/local/lib/texmf/tex/plain.
If you want, you can also create a format (.fmt)
file for Eplain, which will eliminate the time spent reading the macro
source file with \input
. You do this by issuing a sequence of
Unix commands something like this:
prompt$ touch eplain.aux prompt$ initex This is TeX, ... **&plain eplain (eplain.tex) *\dump ... messages ...
You must make sure that eplain.aux exists before you run initex; otherwise, warning messages about undefined labels will never be issued.
You then have to install the resulting eplain.fmt in some system
directory or set an environment variable to tell TeX how to find it.
I install the format files in /usr/local/lib/texmf/ini; the
environment variable for the Web2C port of TeX to Unix is
TEXFORMATS
.
Some implementations of TeX (including Web2C) use the name by which TeX is invoked to determine what format to read. For them, you should make a link to the virtex program named etex, and then install the format file with the name etex.fmt. This lets users invoke TeX as etex and get the format file read automatically, without having to say `&eplain'.
For convenience, the file etex.tex in the distribution directory
does \input eplain
and then \dump
, so that if you replace
`eplain' with `etex' in the example above, the format file
will end up with the right name.
The install
target in the Makefile does all this properly
for Unix systems and Web2C. You may have to change the pathnames.
Under emtex, `eaj@acpub.duke.edu' says that
tex386 -i ^&plain eplain \dump
produces a format file.
The simplest way to use Eplain is simply to put:
\input eplain
at the beginning of your input file. The macro file is small enough that reading it does not take an unbearably long time—at least on contemporary machines.
In addition, if a format (.fmt)
file has been created for Eplain (see the previous section), you can
eliminate the time spent reading the macro source file. You do this
by responding &eplain
to TeX's `**' prompt. For
example:
initex This is TeX, ... **&eplain myfile
Depending on the implementation of TeX which you are using, you might also be able to invoke TeX as eplain and have the format file automatically read.
If you write something which you will be distributing to others, you
won't know if the Eplain format will be loaded already. If it is, then
doing \input eplain
will waste time; if it isn't, then you must
load it. To solve this, Eplain defines the control sequence
\eplain
to be the letter t
(a convention borrowed from Lisp; it doesn't
actually matter what the definition is, only that the definition
exists). Therefore, you can do the following:
\ifx\eplain\undefined \input eplain \fi
where \undefined
must never acquire a definition.
Eplain consists of several source files:
\ifpdf
, which can be used to
detect pdfTeX in PDF mode (see Checking for PDF output), written
by Heiko Oberdiek;
The file eplain.tex is all of these files merged together, with comments removed.
All of these files except xeplain.tex can be input individually, if all you want are the definitions in that file.
Also, since the bibliography macros are fairly extensive, you might not
want to load them, to conserve TeX's memory. Therefore, if the
control sequence \nobibtex
is defined, then the bibliography definitions are skipped. You must set
\nobibtex
before eplain.tex is read, naturally. For
example, you could start your input file like this:
\let\nobibtex = t \input eplain
By default, \nobibtex
is undefined, and so the bibliography
definitions are made.
Likewise, define \noarrow
if you don't want to include the
commutative diagram macros from arrow.tex, perhaps because you
already have conflicting ones.
If you don't want to read or write an aux file at all, for any
kind of cross-referencing, define \noauxfile
before reading eplain.tex. This also turns off all warnings
about undefined labels.
Eplain conflicts with AMSTeX (to be precise, with amsppt.sty):
the macros \cite
and \ref
are defined by both.
If you want to use AMSTeX's \cite
, the solution is to define
\nobibtex
before reading Eplain, as described above.
If you have amsppt.sty loaded and use \ref
, Eplain writes
a warning on your terminal. If you want to use the AMSTeX
\ref
, do \let\ref = \amsref
after reading Eplain.
To avoid the warning, do \let\ref = \eplainref
after reading
Eplain and before using \ref
.
Sometimes you may need to run TeX more then once on your .tex file in order to produce and typeset indexes, resolve undefined cross-references and/or citations. The shell script texi2dvi from the Texinfo documentation system (see http://www.gnu.org/software/texinfo/) can automate this process: it runs BibTeX, MakeIndex and TeX as many times as needed to complete the compilation process. You will need to set the LATEX environment variable to `tex'. For example, in a Bourne-compatible shell, the following command will do all the work:
prompt$ LATEX=tex texi2dvi file.tex
(Despite the name, texi2dvi can also produce .pdf files; just set `LATEX=pdftex'.) See the output from the command texi2dvi --help for invoking information and a full list of options.
This chapter describes definitions that are meant to be used directly in a document. When appropriate, ways to change the default formatting are described in subsections.
Plain TeX provides the \tracingall
command, to turn on the
maximum amount of tracing possible in TeX. The (usually voluminous)
output from \tracingall
goes both on the terminal and into the
transcript file.
It is sometimes easier to have the output go only to the transcript
file, so you can peruse it at your leisure and not obscure other output
to the terminal. So, Eplain provides the command \loggingall
.
(For some reason, this command is available in Metafont, but not in
TeX.)
It is also sometimes useful to see the complete contents of boxes.
\tracingboxes
does this. (It doesn't affect whether or not the
contents
are shown on the terminal.)
You can turn off all tracing with \tracingoff
.
You can also turn logging on and off globally, so you don't have to
worry about whether or not you're inside a group at the time of command.
These variants are named \gloggingall
and \gtracingall
.
Finally, if you write your own help messages (see \newhelp
in The TeXbook), you want a convenient way to break lines in
them. This is what TeX's \newlinechar
parameter is for;
however, plain TeX doesn't set \newlinechar
. Therefore,
Eplain defines it to be the character ^^J
.
For example, one of Eplain's own error messages is defined as follows:
\newhelp\envhelp{Perhaps you forgot to end the previous^^J% environment? I'm finishing off the current group,^^J% hoping that will fix it.}%
The default dimensions of rules are defined in chapter 21 of the
The TeXbook. To sum up what is given there, the “thickness”
of rules is
0.4pt by default. Eplain defines three parameters that let you change
this dimension: \hruledefaultheight
, \hruledefaultdepth
,
and \vruledefaultwidth
. By default, they are defined as
The TeXbook describes.
But it would be wrong to redefine \hrule
and \vrule
. For
one thing, some macros in plain TeX depend on the default dimensions
being used; for another, rules are used quite heavily, and the
performance impact of making it a macro can be noticeable. Therefore,
to take advantage of the default rule parameters, you must use
\ehrule
and \evrule
.
Bibliographies are part of almost every technical document. To handle them easily, you need two things: a program to do the tedious formatting, and a way to cite references by labels, rather than by numbers. The BibTeX program, written by Oren Patashnik, takes care of the first item; the citation commands in LaTeX, written to be used with BibTeX, take care of the second. Therefore, Eplain adopts the use of BibTeX, and virtually the same interface as LaTeX.
The general idea is that you put citation commands in the text of your document, and commands saying where the bibliography data is. When you run TeX, these commands produce output on the file with the same root name as your document (by default) and the extension .aux. BibTeX reads this file. You should put the bibliography data in a file or files with the extension .bib. BibTeX writes out a file with the same root name as your document and extension .bbl. Eplain reads this file the next time you run your document through TeX. (It takes multiple passes to get everything straight, because usually after seeing your bibliography typeset, you want to make changes in the .bib file, which means you have to run BibTeX again, which means you have to run TeX again...) An annotated example of the whole process is given below.
If your document has more than one bibliography—for example, if it
is a collection of papers—you can tell Eplain to use a different root
name for the .bbl file by defining the control sequence
\bblfilebasename
.
The default definition is simply \jobname
.
See the document BibTeXing (whose text is in the file btxdoc.tex, which should be in the Eplain distribution you got) for information on how to write your .bib files. Both the BibTeX and the Eplain distributions contain several examples, also.
The \cite
command produces a citation in the text of your document. The exact
printed form the citation will take is under your control;
see Formatting citations. \cite
takes one
required argument, a comma-separated list of cross-reference labels
(see Cross-references, for exactly what characters are allowed in
such labels). Warning: spaces in this list are taken as part of the
following label name, which is probably not what you expect.
The \cite
command also produces a command
in the .aux file that tells BibTeX to retrieve the given reference(s)
from the .bib file. \cite
also takes one optional argument,
which you specify within square brackets, as in LaTeX. This text is
simply typeset after the citations. (See the example below.)
Eplain can create hypertext links for citations pointing to the relevant bibliography entries; see Citation hyperlinks.
Another command, \nocite
,
puts the given reference(s) into the bibliography, but produces nothing
in the text.
The \bibliography
command is next. It serves two purposes: producing the typeset
bibliography, and telling BibTeX the root names of the .bib
files. Therefore, the argument to \bibliography
is a comma
separated list of the .bib files (without the `.bib'). Again,
spaces in this list are significant.
You tell BibTeX the particular style in which you want your
bibliography typeset with one more command:
\bibliographystyle
.
The argument to this is a single filename style, which tells
BibTeX to look for a file style.bst.
See the document Designing BibTeX styles (whose text is in the
btxhak.tex) for information on how to write your own styles.
Eplain automatically reads the citations from the .aux file when your job starts.
If you don't want to see the messages about undefined citations, you
can say \xrefwarningfalse
before making any citations.
Eplain automatically does this if the .aux file does not exist.
You can restore the default by saying \xrefwarningtrue
.
Here is a TeX input file that illustrates the various commands.
\input eplain % Reads the .aux file. Two citations to Knuthian works: \cite[note]{surreal,concrete-math}. \beginsection{References.}\par % Title for the bibliography. \bibliography{knuth} % Use knuth.bib for the labels. \bibliographystyle{plain} % Number the references. \end % End of the document.
If we suppose that this file was named citex.tex and that the
bibliography data is in knuth.bib (as the \bibliography
command says), the following commands do what's required. (`$ '
represents the shell prompt.)
$ tex citex (produces undefined citation messages) $ bibtex citex (read knuth.bib and citex.aux, write citex.bbl) $ tex citex (read citex.bbl, still have undefined citations) $ tex citex (one more time, to resolve the references)
(The texi2dvi program can help you automate this process, see Invoking Eplain.)
The output looks something like (because we used the plain bibliography style):
Two citations to Knuthian works: [2,1 note].References
[1] Ronald L. Graham, Donald E. Knuth, and Oren Patashnik. Concrete Mathematics. Addison-Wesley, Reading, Massachusetts, 1989.
[2] Donald E. Knuth. Surreal Numbers. Addison-Wesley, Reading, Massachusetts, 1974.
See the BibTeX documentation for information on how to write the
bibliography databases, and the bibliography styles that are available.
(If you want your references printed with names, as in [Knu74], instead
of numbered, the bibliography style is alpha
.)
You may wish to change Eplain's formatting of citations; i.e., the
result of your \cite
commands. By default, the citation labels
are printed one after another, separated by commas and enclosed in
brackets, using the main text font. Some formats require other styles,
such as superscripted labels. You can accomodate such formats by
redefining the following macros.
\printcitestart
\printcitefinish
\cite
command. By default, they produce a
`[' and `]', respectively.
\printbetweencitations
\cite
command has multiple citations, as in
\cite{acp,texbook}
, Eplain expands this macro in between each
pair of citations. By default, it produces a comma followed by a space.
\printcitenote
\cite
command. If the \cite
command had no note, this
macro isn't used. Otherwise, it should print the note. By default, the
note is preceded with a comma and a space.
Here is an example, showing you could produce citations as superscripted labels, with the optional notes in parentheses.
\def\printcitestart{\unskip $^\bgroup} \def\printbetweencitations{,} \def\printcitefinish{\egroup$} \def\printcitenote#1{\hbox{\sevenrm\space (#1)}}
You may wish to change Eplain's formatting of the bibliography, especially with respect to the fonts that are used. Therefore, Eplain provides the following control sequences:
\biblabelwidth
\dimen
register, and its value
is the width of the widest label in the bibliography. Although it is
unlikely you will ever want to redefine it, you might want
to use it if you redefine \biblabelprint
, below.
\biblabelprint
\biblabelwidth
, and is followed by
an enspace. When you want to change the spacing around the labels, this
is the right macro to redefine.
\biblabelcontents
\bblrm
(below), and enclosed in
brackets. When you want to change the appearance of the label, but not
the spacing around it, this is the right macro to redefine.
\bblrm
\bblem
\bblsc
\bblnewblock
\biblabelextraspace
\biblabelwidth
plus this. The default is .5em
, where the
em width is taken from the \bblrm
font. If you want to change
this, you should do it inside \bblhook
.
\bblhook
\bblhook
:
\parskip
, which produces extra space between the items; and
\biblabelextraspace
, which is described above.
(By the way, \hookappend
won't work with \bblhook
, despite
the names. Just use \def
.)
If you are really desperate, you can also hand-edit the .bbl file that BibTeX produces to do anything you wish.
By default, TeX centers displayed material. (Displayed material is
just whatever you put between $$
's—it's not necessarily
mathematics.) Many layouts would be better served if the displayed
material was left-justified. Therefore, Eplain provides the command
\leftdisplays
,
which indents displayed material by \parindent
plus
\leftskip
, plus \leftdisplayindent
.
You can go back to centering displays with \centereddisplays
.
(It is usually poor typography to have both centered and left-justified
displays in a single publication, though.)
\leftdisplays
also changes the plain TeX commands that deal
with alignments inside math displays,
\displaylines
,
\eqalignno
,
and \leqalignno
,
to produce left-justified text. You can still override this formatting
by inserting \hfill
glue, as explained in The TeXbook.
If you want some other kind of formatting, you can write a definition
of your own, analogous to \leftdisplays
. You need only make sure
that \leftdisplaysetup
is called at the beginning of every display (presumably by invoking it
in TeX's \everydisplay
parameter), and to define
\generaldisplay
.
\leftdisplays
expands the old value of \everydisplay
before calling \leftdisplaysetup
, so that any changes you have made
to it won't be lost. That old token list as available as the value of
the token register \previouseverydisplay
.
TeX provides the day, month, and year as numeric quantities (unless your TeX implementation is woefully deficient). Eplain provides some control sequences to make them a little more friendly to humans.
\monthname
produces the name of the current month, abbreviated to three letters.
\fullmonthname
produces the name of the current month, unabbreviated (in English).
\timestring
produces the current time, as in `1:14 p.m.'
\timestamp
produces the current date and time, as in `23 Apr 64 1:14 p.m.'.
(Except the spacing is slightly different.)
\today
produces the current date, as in `23 April 1964'.
Many documents require lists of items, either numbered or simply
enumerated. Plain TeX defines one macro to help with creating lists,
\item
, but that is insufficient in many cases. Therefore,
Eplain provides two pairs of commands:
\numberedlist ... \endnumberedlist
\orderedlist ... \endorderedlist
\numberedlist
labels the items with lowercase letters, starting with `a'. Another
nested \numberedlist
labels the items with roman numerals. Yet
more deeply nested numbered lists label items with `*'.
\unorderedlist ... \endunorderedlist
\unorderedlist
labels items with
em-dashes. Doubly (and deeper) nested unordered lists label items with
`*'s.
The two kinds of lists can be nested within each other, as well.
In both kinds of lists, you begin an item with \li
.
An item may continue for several paragraphs. Each item starts a
paragraph.
You can give \li
an optional argument, a cross-reference label.
It's defined to be the “marker” for the current item. This is useful
if the list items are numbered. You can produce the value of the label
with \xrefn
. See Cross-references.
Eplain can create hypertext links for the markers produced by
\xrefn
pointing to the relevant list item; see List hyperlinks.
You can also say \listcompact
right after \numberedlist
or \unorderedlist
. The items in
the list will then not have any extra space between them
(see Formatting lists). You might want to do this if the items in
this particular list are short.
Here is an example:
\numberedlist\listcompact \li The first item. \li The second item. The second paragraph of the second item. \endnumberedlist
Several registers define the spacing associated with lists. It is likely that their default values won't suit your particular layout.
\abovelistskipamount, \belowlistskipamount
\interitemskipamount
\listcompact
resets this to zero, as mentioned above.
\listleftindent, \listrightindent
\listrightindent
is the amount of space by which the list is
indented on the right; i.e., it is added to \rightskip
.
\listleftindent
is the amount of space, relative to
\parindent
, by which the list is indented on the left. Why treat
the two parameters differently? Because (a) it is more useful to
make the list indentation depend on the paragraph indentation;
(b) footnotes aren't formatted right if \parindent
is reset
to zero.
The three vertical glues are inserted by macros, and preceded by
penalties: \abovelistskip
does \vpenalty\abovelistpenalty
and then \vskip\abovelistskip
. \belowlistskip
and \interitemskip
are analogous.
In addition, the macro \listmarkerspace
is called to separate the item label from the item text. This is set to
\enspace
by default.
If you want to change the labels on the items, you can redefine these
macros:
\numberedmarker
or \unorderedmarker
.
The following registers might be useful if you do:
\numberedlistdepth, \unorderedlistdepth
\itemnumber, \itemletter
\itemnumber
starts at one, and \itemletter
starts at 97,
i.e., lowercase `a'.
You can also redefine the control sequences that are used internally,
if you want to do something radically different: \beginlist
is invoked to begin both kinds of lists; \printitem
is invoked to print the label (and space following the label) for each
item; and \endlist
is invoked to end both kinds of
lists.
It is sometimes useful to include a file verbatim in your document;
for example, part of a computer program. The \listing
command is given one argument, a filename, and produces the contents of
that file in your document. \listing
expands \listingfont
to set the current font. The default value of \listingfont
is \tt
.
You can take arbitrary actions before reading the file by defining the macro
\setuplistinghook
.
This is expanded just before the file is input.
If you want to have line numbers on the output, you can say
\let\setuplistinghook = \linenumberedlisting
.
The line numbers are stored in the count register \lineno
while
the file is being read. You can redefine the macro
\printlistinglineno
to change how they are printed.
You can produce in-line verbatim text in your document with \verbatim
.
End the text with |endverbatim
. If you need a `|' in the text,
double it. If the first character of the verbatim text is a space, use
|
. (|
will work elsewhere in the argument, too, but
isn't necessary.)
For example:
\verbatim| ||\#%&!|endverbatim
produces |\#%&!
.
Line breaks and spaces in the verbatim text are preserved.
You can change the verbatim escape character from the default `|'
with \verbatimescapechar
char; for example, this changes
it to `@'.
\verbatimescapechar \@
The backslash is not necessary in some cases, but is in
others, depending on the catcode of the character. The argument to
\verbatimescapechar
is used as \catcode `
char, so
the exact rules follow that for \catcode
.
Because \verbatim
must change the category code of special
characters, calling inside a macro definition of your own does not work
properly. For example:
\def\mymacro{\verbatim &#%|endverbatim}% Doesn't work!
To accomplish this, you must change the category codes yourself before
making the macro definition. Perhaps \uncatcodespecials
will
help you (see Category codes).
Producing a table of contents that is both useful and aesthetic is one of the most difficult design problems in any work. Naturally, Eplain does not pretend to solve the design problem. Collecting the raw data for a table of contents, however, is much the same across documents. Eplain uses an auxiliary file with extension .toc (and the same root name as your document) to save the information.
To write an entry for the table of contents, you say
\writetocentry{
part}{
text}
,
where part is the type of part this entry is, e.g.,
`chapter', and text is the text of the title.
\writetocentry
puts an entry into the .toc file that looks
like \toc
partentry{
text}{
page number}
. The
text is written unexpanded.
A related command, \writenumberedtocentry
, takes one additional
argument, the first token of which is expanded at the point of the
\writenumberedtocentry
, but the rest of the argument is not
expanded. The usual application is when the parts of the document are
numbered. On the other hand, the one-level expansion allows you to use
the argument for other things as well (author's names in a proceedings,
say), and not have accents or other control sequences expanded. The
downside is that if you want full expansion of the third
argument, you don't get it—you must expand it yourself, before you
call \writenumberedtocentry
.
For example:
\writenumberedtocentry{chapter}{A $\sin$ wave}{\the\chapno} \writetocentry{section}{A section title}
Supposing \the\chapno
expanded to `3' and that the
\write
's occurred on pages eight and nine, respectively, the
above writes the following to the .toc file:
\tocchapterentry{A $\sin$ wave}{3}{8} \tocsectionentry{A section title}{9}
You read the .toc file with the command \readtocfile
.
Naturally, whatever \toc... entry
commands that were written
to the file must be defined when \readtocfile
is invoked. Eplain
has minimal definitions for \tocchapterentry
,
\tocsectionentry
, and \tocsubsectionentry
, just to prevent
undefined control sequence errors in common cases. They aren't suitable
for anything but preliminary proofs.
Each of \writetocentry
and \writenumberedtocentry
opens
the .toc file for writing, thereby deleting the information from the
previous run. You should therefore arrange that \readtocfile
be
called before the first call to a \writetoc...
macro.
\readtocfile
does not itself delete the information
from the .toc file, so that you can call it several times,
e.g., to create both a short
and normal table of contents. (To produce this in particular, define
\tocsectionentry
to produce nothing while you are reading
.toc file for a short table of contents (see Macro arguments).)
On the other hand, if you don't want to rewrite the .toc file at
all, perhaps because you are only running TeX on part of your
manuscript, you can set \rewritetocfilefalse
.
By default, the .toc file has the root \jobname
. If your
document has more than one contents—for example, if it is a collection
of papers, some of which have their own contents—you can tell Eplain
to use a different root name by defining the control sequence
\tocfilebasename
.
In addition to the usual table of contents, you may want to have a list
of figures, list of tables, or other such contents-like list. You can do
this with \definecontentsfile{
abbrev}
. All of the
above commands are actually a special case that Eplain predefines with
\definecontentsfile{toc}
The abbrev is used both for the file extension and in the control sequence names.
It is often useful to refer the reader to other parts of your document; but putting literal page, section, equation, or whatever numbers in the text is certainly a bad thing.
Eplain therefore provides commands for symbolic cross-references. It uses an auxiliary file with extension .aux (and the same root name as your document) to keep track of the information. Therefore, it takes two passes to get the cross-references right—one to write them out, and one to read them in. Eplain automatically reads the .aux file at the first reference; after reading it, Eplain reopens it for writing.
You can control whether or not Eplain warns you about undefined labels. See Citations.
Labels in Eplain's cross-reference commands can use characters of category code eleven (letter), twelve (other), ten (space), three (math shift), four (alignment tab), seven (superscript), or eight (subscript). For example, `(a1 $&^_' is a valid label (assuming the category codes of plain TeX), but `%#\{' has no valid characters.
You can also do symbolic cross-references for bibliographic citations and list items. See Citations, and Lists.
Eplain can create hypertext links for the cross-references; see Cross-reference hyperlinks.
Eplain provides the command \definexref
for general
cross-references. It takes three arguments: the name of the label (see
section above for valid label names), the value of the label (which can
be anything), and the “class” of the reference—whether it's a
section, or theorem, or what. For example:
\definexref{sec-intro}{3.1}{section}
Of course, the label value is usually generated by another macro using TeX count registers or some such.
\definexref
doesn't actually define label; instead, it
writes out the definition to the .aux file, where Eplain will read
it on the next TeX run.
The class argument is used by the \ref
and \refs
commands. See the next section.
To retrieve the value of the label defined via \definexref
(see
the previous section), Eplain provides the following macros:
\refn{
label}
\xrefn{
label}
\refn
and \xrefn
(they are synonyms) produce the bare
definition of label. If label isn't defined, issue a
warning, and produce label itself instead, in typewriter. (The
warning isn't given if \xrefwarningfalse
.)
\ref{
label}
\definexref
in the previous section), expand the control sequence
\
c word
(if it's defined) followed by a tie. Then call
\refn
on label. (Example below.)
\refs{
label}
\ref
, but append the letter `s' to the
\...word
.
The purpose of the \...word
macro is to produce the word
`Section' or `Figure' or whatever that usually precedes the actual
reference number.
Here is an example:
\def\sectionword{Section} \definexref{sec-intro}{3.1}{section} \definexref{sec-next}{3.2}{section} See \refs{sec-intro} and \refn{sec-next} ...
This produces `See Sections 3.1 and 3.2 ...'
Eplain provides two commands for handling references to page numbers, one for definition and one for use.
\xrdef{
label}
\xref{
label}
\xrefpageword
.
Its default definition is p.\thinspace
.
Eplain can create hypertext links for the page references; see Page reference hyperlinks.
Instead of referring to pages, it's most useful if equation labels
refer to equation numbers. Therefore, Eplain reserves a \count
register, \eqnumber
,
for the current equation number, and increments it at each
numbered equation.
Here are the commands to define equation labels and then refer to them:
\eqdef{
label}
\eqnumber
,
and, if the current context is not inner, then produces a \eqno
command. (The condition makes it possible to use \eqdef
in an
\eqalignno
construction, for example.) The text of the equation
number is produced using \eqprint
. See Formatting equation references.
If label is empty, you still get an equation number (although naturally you can't reliably refer to it). This is useful if you want to put numbers on all equations in your document, and you don't want to think up unique labels.
To refer to the last equation with the empty label, you just use the
empty label in one of the equation reference macros (see below). This
can be handy when you want to refer to an equation shortly after its
definition, say, in the sentence following the displayed equation, and
do not intend to refer to the equation later. But use this trick with
extreme caution: if later you change the text and insert another
empty definition between the original definition and the reference,
the reference will start to refer to the new empty-labeled equation.
\eqdefn{
label}
\eqdef
, except it always omits the \eqno
command. It can therefore be used in places where \eqdef
can't;
for example, in a non-displayed equation. The text of the equation
number is not produced, so you can also use it in the (admittedly
unusual) circumstance when you want to define an equation label but not
print that label.
\eqref{
label}
\eqprint
.
\eqrefn{
label}
\eqref
, except it doesn't call \eqprint
.
Equation labels can contain the same characters that are valid in general cross-references.
Eplain can create hypertext links for the equation references; see Equation reference hyperlinks.
Both defining an equation label and referring to it should usually
produce output. This output is produced with the \eqprint
macro,
which takes one argument, the equation number being defined or referred
to. By default, this just produces `(number)', where
number is the equation number. To produce the equation number in
a different font, or with different surrounding symbols, or whatever,
you can redefine \eqprint
.
For example, the following definition would print all equation numbers
in italics. (The extra braces define a group, to keep the font change
from affecting surrounding text.)
\def\eqprint#1{{\it (#1)}}
In addition to changing the formatting of equation numbers, you might
to add more structure to the equation number; for example, you might
want to include the chapter number, to get equation numbers like
`(1.2)'. To achieve this, you redefine \eqconstruct
.
For example:
\def\eqconstruct#1{\the\chapternumber.#1}
(If you are keeping the chapter number in a count register named
\chapternumber
, naturally.)
The reason for having both \eqconstruct
and \eqprint
may
not be immediately apparent. The difference is that \eqconstruct
affects the text that cross-reference label is defined to be, while
\eqprint
affects only what is typeset on the page. The example
just below might help.
Usually, you want equation labels to refer to equation numbers. But sometimes you might want a more complicated text. For example, you might have an equation `(1)', and then have a variation several pages later which you want to refer to as `(1*)'.
Therefore, Eplain allows you to give an optional argument (i.e., arbitrary text in square brackets) before the cross-reference label to \eqdef. Then, when you refer to the equation, that text is produced. Here's how to get the example just mentioned:
$$...\eqdef{a-eq}$$ ... $$...\eqdef[\eqrefn{a-eq}*]{a-eq-var}$$ In \eqref{a-eq-var}, we expand on \eqref{a-eq}, ...
We use \eqrefn
in the cross-reference text, not
\eqref
, so that \eqprint
is called only once.
Eplain also provides for one level of substructure for equations. That is, you might want to define a related group of equations with numbers like `2.1' and `2.2', and then be able to refer to the group as a whole: “... in the system of equations (2)...”.
The commands to do this are \eqsubdef
and
\eqsubdefn
.
They take one label argument like their counterparts above,
and generally behave in the same way. The difference is in how they
construct the equation number: instead of using just \eqnumber
,
they also use another counter, \subeqnumber
.
This counter is advanced by one at every \eqsubdef
or
\eqsubdefn
, and reset to zero at every \eqdef
or
\eqdefn
.
You use \eqref
to refer to subequations as well as main
equations.
To put the two together to construct the text that the label will
produce, they use a macro \eqsubreftext
.
This macros takes two arguments, the “main” equation number (which,
because the equation label can be defined as arbitrary text, as
described in the previous section, might be anything at all) and the
“sub” equation number (which is always just a number). Eplain's
default definition just puts a period between them:
\def\eqsubreftext#1#2{#1.#2}%
You can redefine \eqsubreftext
to print however you
like. For example, this definition makes the labels print as `2a',
`2b', and so on.
\newcount\subref \def\eqsubreftext#1#2{% \subref = #2 % The space stops a <number>. \advance\subref by 96 % `a' is character code 97. #1\char\subref }
Sadly, we must define a new count register, \subref
,
instead of using the scratch count register \count255
, because
`#1' might include other macro calls which use \count255
.
Eplain provides support for generating raw material for an index, and for typesetting a sorted index. A separate program must do the actual collection and sorting of terms, because TeX itself has no support for sorting.
Eplain can create hypertext links pointing from the index to the index terms; see Index hyperlinks.
Eplain's indexing commands were designed to work with the program MakeIndex, available from CTAN hosts in tex-archive/indexing/makeindex; MakeIndex is also commonly included in prepackaged TeX distributions. It is beyond the scope of this manual to explain how to run MakeIndex, and all of its many options. See http://www.ctan.org/tex-archive/indexing/makeindex/
The basic strategy for indexing works like this:
\idx
; see the section `Indexing terms' below) write the raw index
material to foo.idx.
The texi2dvi program can help you automate this process, see Invoking Eplain.
If your document needs more than one index, each must have its own
file. Therefore, Eplain provides the command \defineindex
, which
takes an argument that is a single letter, which replaces `i' in
the filenames and in the indexing command names described below. For
example,
\defineindex{m}
defines the command \mdx
to write to the file
foo.mdx. Eplain simply does \defineindex{i}
to define
the default commands.
Indexing commands in Eplain come in pairs: one command that only writes the index entry to the `.idx' file (see above section), and one that also typesets the term being indexed. The former always starts with `s' (for “silent”). In either case, the name always includes `Idx', where I is the index letter, also described above. Eplain defines the index `i' itself, so that's what we'll use in the names below.
The silent form of the commands take a subterm as a trailing optional
argument. For example, \sidx{truth}[definition of]
on page 75
makes an index entry that will eventually be typeset (by default) as
truth definition of, 75
Also, the silent commands ignore trailing spaces. The non-silent ones do not.
\sidx{
term}[
subterm]
makes an index entry for
term, optionally with subterm subterm.
\idx{
term}
also produces term as output. Example:
\sidx{truth}[beauty of] The beauty of truth is \idx{death}.
Subterms at the second and further levels can also be
specified in subterm, using the
\idxsubentryseparator
character to separate
them. This character is by default `!'.
\sidxname{
First M.}{
von Last}[
subterm]
makes an index
entry for `von Last, First M.'. You can change the
`, ' by redefining \idxnameseparator
.
\idxname{
First M.}{
von Last}
also produces First M. von
Last as output. (These commands are useful special cases of \idx
and \sidx
.) Example:
\sidxname{Richard}{Stark} \idxname{Donald}{Westlake} has written many kinds of novels, under almost as many names.
\sidxmarked\
cs{
term}[
subterm]
makes an index
entry for term[
subterm]
, but term will be put
in the index as \
cs{term}
, but still sorted as just
term. \idxmarked\
cs{
term}
also typesets
\
cs{term}
. This provides for the usual ways of changing
the typesetting of index entries. Example:
\def\article#1{``#1''} \sidxmarked\article{Miss Elsa and Aunt Sophie} Peter Drucker's \idxmarked\article{The Polanyis} is a remarkable essay about a remarkable family.
\sidxsubmarked{
term}\
cs{subterm}
makes an index
entry for term, subterm as usual, but also puts subterm in
the index as \
cs{term}
.
\idxsubmarked{
term}\
cs{subterm}
also typesets
term \
cs{subterm}
, in the unlikely event that your
syntax is convoluted enough to make this useful. Example:
\def\title#1{{\sl #1}} \sidxsubmarked{Anderson, Laurie}\title{Strange Angels} The \idxsubmarked{Anderson}\title{Carmen} is a strange twist.
The commands above rely on MakeIndex's feature for separating sorting of
an index entry's from its typesetting. You can use this directly by
specifying an index entry as sort@
typeset. For
example:
\sidx{Ap-weight@$A_\pi$-weight}
will sort as Ap-weight
, but print with the proper math.
The @
here is MakeIndex's default character for this purpose.
See http://www.ctan.org/tex-archive/indexing/makeindex/. To make an index
entry with an @
in it, you have to escape it with a backslash;
Eplain provides no macros for doing this.
After any index command, Eplain runs
\hookaction{afterindexterm}
. Because the index commands always
add a whatsit item to the current list, you may wish to preserve a
penalty or space past the new item. For example, given a conditional
\if@aftersctnhead
set true when you're at a section heading, you
could do:
\hookaction{afterindexterm}{\if@aftersctnhead \nobreak \fi}
All the index commands described in the previous section take an initial
optional argument before the index term, which modify the index entry's
meaning in various ways. You can specify only one of the following in
any given command, except that begin
and end
can be
specified together with pagemarkup=
cs (separate them with
a comma without a following space, like this:
[begin,pagemarkup=defn]
).
These work via MakeIndex's “encapsulation” feature. See Customizing indexing, if you're not using the default characters for the MakeIndex operators. The other optional argument (specifying a subterm) is independent of these.
Here are the possibilities:
begin
end
\sidx[begin]{future}[Cohen, Leonard] ... \sidx[end]{future}[Cohen, Leonard]
will typeset as something like
future, Cohen, Leonard, 65–94
see
\sidx[see]{analysis}[archetypal]{archetypal criticism}
becomes
analysis, archetypal, see archetypal criticism
seealso
see
(the previous item), but also allows for normal
index entries of the referencing term. Example:
\sidx[seealso]{archetypal criticism}[elements of]{dichotomies}
becomes
archetypal criticism, elements of, 75, 97, 114, see also dichotomies
(Aside for the academically curious: The archetypally critical book I
took these dichotomous examples from is Laurence Berman's The
Musical Image, which I happened to co-design and typeset.)
pagemarkup=
cs\
cs before the page number in the typeset index,
thus allowing you to underline definitive entries, italicize examples,
and the like. You do not precede the control sequence cs
with a backslash. (That just leads to expansive difficulties.) Naturally
it is up to you to define the control sequences you want to use. Example:
\def\defn#1{{\sl #1}} \sidx[pagemarkeup=defn]{indexing}
becomes something like
indexing, \defn{75}
As you are reading through a manuscript, it is helpful to see what terms have been indexed, so you can add others, catch miscellaneous errors, etc. (Speaking from bitter experience, I can say it is extremely error-prone to leave all indexing to the end of the writing, since it involves adding many TeX commands to the source files.)
So Eplain puts index terms in the margin of each page, if you
set \indexproofingtrue
. It is false
by default. The terms
are typeset by the macro \indexproofterm
, which takes a single
argument, the term to be typeset. Eplain's definition of
\indexproofterm
just puts it into an \hbox
, first doing
\indexprooffont
, which Eplain defines to select the font
cmtt8
. With this definition long terms run off the page, but
since this is just for proofreading anyway, it seems acceptable.
On the other hand, we certainly don't want the index term to run into
the text of the page, so Eplain uses the right-hand side of the page
rather than the left-hand page (assuming a language read left to right
here). So \ifodd\pageno
, Eplain kerns by \outsidemargin
,
otherwise by \insidemargin
. If those macros are undefined,
\indexsetmargins
defines them to be one inch plus \hoffset
.
To get the proofing index entries on the proper page, Eplain defines a new
insertion class \@indexproof
. To unbox any index proofing
material, Eplain redefines \makeheadline
to call
\indexproofunbox
before the original \makeheadline
. Thus,
if you have your own output routine, that redefines or doesn't use
\makeheadline
, it's up to you to call \indexproofunbox
at
the appropriate time.
The command \readindexfile{i}
reads and typesets the
.ind file that MakeIndex outputs (from the .idx file which
the indexing commands in the previous sections write). Eplain defines a
number of commands that support the default MakeIndex output.
More precisely, \readindexfile
reads
\indexfilebasename.
index-letternd
, where the
index-letter is the argument. \indexfilebasename
is
\jobname
by default, but if you have different indexes in
different parts of a book, you may wish to change it, just as with
bibliographies (see Citations).
MakeIndex was designed to work with LaTeX; therefore, by default the
.ind file starts with \begin{theindex}
and ends with
\end{theindex}
. If no \begin
has been defined, Eplain
defines one to ignore its argument and set up for typesetting the index
(see below), and also defines a \end
to ignore its argument. (In
a group, naturally, since there is a primitive \end
).
Eplain calls \indexfonts
, sets \parindent = 0pt
, and does
\doublecolumns
(see Multiple columns) at the
\begin{theindex}
. \indexfonts
does nothing by default;
it's just there for you to override. (Indexes are usually typeset in
smaller type than the main text.)
It ends the setup with \hookrun{beginindex}
, so you can
override anything you like in that hook (see Hooks). For example:
\hookaction{beginindex}{\triplecolumns}
MakeIndex turns each main index entry into an \item
, subentries
into \subitem
, and subsubentries into \subsubitem
. By
default, the first line of main entries are not indented, and subentries
are indented 1em per level. Main entries are preceded by a \vskip
of \aboveitemskipamount
, 0pt plus2pt
by default. Page
breaks are encouraged before main entries (\penalty -100
), but
prohibited afterwards—Eplain has no provision for “continued”
index entries.
All levels do the following:
\hangindent = 1em \raggedright \hyphenpenalty = 10000
Each entry ends with \hookrun{indexitem}
, so you can change any
of this. For example, to increase the allowable rag:
\hookaction{indexitem}{\advance\rightskip by 2em}
Finally, MakeIndex outputs \indexspace
between each group of
entries in the .ind file. Eplain makes this equivalent to
\bigbreak
.
By default, MakeIndex outputs `, ' after each term in the index. To change this, you can add the following to your MakeIndex style (.ist) file:
delim_0 "\\afterindexterm " delim_1 "\\afterindexterm " delim_2 "\\afterindexterm "
Eplain makes \afterindexterm
equivalent to
\quad
.
You can also change the keywords Eplain recognizes (see Modifying index entries):
\idxrangebeginword
\idxrangeendword
\idxseecmdword
\idxseealsocmdword
You can also change the magic characters Eplain puts into the
.idx file, in case you've changed them in the .ist
file:
\idxsubentryseparator
\idxencapoperator
\idxbeginrangemark
\idxendrangemark
There is no macro for the actual
(`@' by default)
character, because it's impossible to make it expand properly.
You can change the (imaginary) page number that “see also”
entries sort as by redefining \idxmaxpagenum
. This is 99999 by
default, which is one digit too many for old versions of MakeIndex.
The words output by Eplain for “see” and “see also” index entries
are defined by \indexseeword
and \indexseealsowords
respectively. You can change the typeface used for these words by
redefining \seevariant
. And finally, the macros
\indexsee
and \indexseealso
actually produce the “see
...” entries, so you can redefine them if you want something
entirely different. If you do redefine them, make them take two
parameters, the term being referenced and the \idxmaxpagenum
(the latter should normally be ignored). See the example below.
Unfortunately, it is impossible to reliably control the commas produced by MakeIndex in front of “see ...” entries in the .ind file, either at MakeIndex level or at Eplain level. However, the sed script named trimsee distributed with Eplain in the test directory can be used to filter out these commas from the output of MakeIndex. For example, suppose you want the following style for your “see ...” entries:
analysis, archetypal (see archetypal criticism) archetypal criticism, elements of, 75, 97, 114 (see also dichotomies)
You would need to redefine these macros in your TeX file:
\def\indexsee#1#2{({\seevariant \indexseeword\/ }#1)} \def\indexseealso#1#2{({\seevariant \indexseealsowords\/ }#1)}
and then filter out the commas in front of the “see ...” entries by running the following command to produce the .ind file (assuming the name of the .idx file is myfile.idx and the trimsee script is placed in the current directory):
prompt$ cat myfile.idx | makeindex | ./trimsee > myfile.ind
By default, trimsee uses default page list separators and
default “see ...” command names. If you set up MakeIndex to use
different page list separator or change the names of \indexsee
and \indexseealso
commands, it is possible to adjust the
trimsee script through its command line options, which are the
following:
trimsee reads input from the standard input, and directs its output to the standard output.
Eplain defines three commands to conveniently justify multiple
lines of text: \flushright
, \flushleft
, and
\center
.
They all work in the same way; let's take \center
as the
example. To start centering lines, you say \center
inside a
group; to stop, you end the group. Between the two commands, each
end-of-line in the input file also starts a new line in the output file.
The entire block of text is broken into paragraphs at blank lines,
so all the TeX paragraph-shaping parameters apply in the usual way.
This is convenient, but it implies something else that isn't so
convenient: changes to any linespacing parameters, such as
\baselineskip
, will have no effect on the paragraph in
which they are changed. TeX does not handle linespacing changes
within a paragraph (because it doesn't know where the line breaks are
until the end of the paragraph).
The space between paragraphs is by default one blank line's worth.
You can adjust this space by assigning to \blanklineskipamount
;
this (vertical) glue is inserted after each blank line.
Here is an example:
{\center First line. Second line, with a blank line before. }
This produces:
You may wish to use the justification macros inside of your own macros. Just be sure to put them in a group. For example, here is how a title macro might be defined:
\def\title{\begingroup\titlefont\center} \def\endtitle{\endgroup}
Eplain provides a single command, \makecolumns
,
to make generating one particular kind of table easier. More ambitious
macro packages might be helpful to you for more difficult applications.
The files ruled.tex and TXSruled.tex, available from
`lifshitz.ph.utexas.edu' in texis/tables, is the only one I
know of.
Many tables are homogenous, i.e., all the entries are semantically the same. The arrangement into columns is to save space on the page, not to encode different meanings. In this kind of the table, it is useful to have the column breaks chosen automatically, so that you can add or delete entries without worrying about the column breaks.
\makecolumns
takes two arguments: the number of entries in the
table, and the number of columns to break them into. As you can see
from the example below, the first argument is delimited by a slash, and
the second by a colon and a space (or end-of-line). The entries for the
table then follow, one per line (not including the line with the
\makecolumns
command itself).
\parindent
defines the space to the left of the
table. \hsize
defines the width of the table.
So you can adjust the position of the table on the page by assignments
to these parameters, probably inside a group.
You can also control the penalty at a page break before the
\makecolumns
by setting the parameter
\abovecolumnspenalty
.
Usually, the table is preceded by some explanatory text. You wouldn't
want a page break to occur after the text and before the table, so
Eplain sets it to 10000
. But if the table produced by
\makecolumns
is standing on its own, \abovecolumnspenalty
should be decreased.
If you happen to give \makecolumns
a smaller number of entries
than you really have, some text beyond the (intended) end of the table
will be incorporated into the table, probably producing an error
message, or at least some strange looking entries. And if you give
\makecolumns
a larger number of entries than you really have,
some of the entries will be typeset as straight text, probably also
looking somewhat out of place.
Here is an example:
% Arrange 6 entries into 2 columns: \makecolumns 6/2: % This line doesn't have an entry. one two three four five six Text after the table.
This produces `one', `two', and `three' in the first column, and `four', `five', and `six' in the second.
TeX's primitives describe the type area in terms of an offset from the upper left corner, and the width and height of the type. Some people prefer to think in terms of the margins at the top, bottom, left, and right of the page, and most composition systems other than TeX conceive of the page laid out in this way. Therefore, Eplain provides commands to directly assign and increment the margins.
\topmargin =
dimen\bottommargin =
dimen\leftmargin =
dimen\rightmargin =
dimen=
and the spaces around it are optional. The control
sequences here are not TeX registers, despite appearances;
therefore, commands like \showthe\topmargin
will not do what you
expect.
\advancetopmargin by
dimen\advancebottommargin by
dimen\advanceleftmargin by
dimen\advancerightmargin by
dimenRegardless of whether you use the assignment or the advance commands,
Eplain always changes the type area in response, not the other margins.
For example, when TeX starts, the left and right margins are both one
inch. If you then say \leftmargin = 2in
, the right margin will
remain at one inch, and the width of the lines (i.e., \hsize
)
will decrease by one inch.
When you use any of these commands, Eplain computes the old value of the particular margin, by how much you want to change it, and then resets the values of TeX's primitive parameters to correspond. Unfortunately, Eplain cannot compute the right or bottom margin without help: you must tell it the full width and height of the final output page. It defines two new parameters for this:
\paperheight
\paperwidth
If your output page has different dimensions than this, you must reassign to these parameters, as in
\paperheight = 11truein \paperwidth = 17truein
Eplain provides for double, triple, and quadruple column output: say
\doublecolumns
,
\triplecolumns
,
or \quadcolumns
,
and from that point on, the manuscript will be
set in columns. To go back to one column, say
\singlecolumn
.
You may need to invoke \singlecolumn
to balance the columns
on the last page of output.
To do a “column eject”, i.e., move to the top of the next column, do
\columnfill
. This does not actually force an eject, however: it
merely inserts a kern of size \@normalvsize
minus
\pagetotal
(\@normalvsize
being the usual height of the
page; to implement multicolumns, Eplain multiplies \vsize
itself
by the number of columns). In most circumstances, a column break will be
forced after this kern (during the column splitting operation when the
whole page is output), as desired.
The columns are separated by the value of the dimen parameter
\gutter
. Default value is two picas.
If you want to add vertical material between the columns, use
\gutterbox
. For example, to put a vertical line between columns,
define
\gutterbox
as
\def\gutterbox{\vbox to \dimen0{\vfil\hbox{\vrule height\dimen0}\vfil}}%
The dimension counter
\dimen0
contains the height of the column.
All the \...columns
macros insert the value of the glue parameter
\abovecolumnskip
before the multicolumn text, and the value of the glue parameter
\belowcolumnskip
after it. The default value for both of these parameters is
\bigskipamount
, i.e., one linespace in plain TeX.
The macros take into account only the insertion classes
defined by plain TeX; namely, footnotes and \topinsert
s. If
you have additional insertion classes, you will need to change
the implementation.
Also, Eplain makes insertions the full page width. There is no provision for column-width insertions.
The most common reference mark for footnotes is a raised number,
incremented on each footnote. The \numberedfootnote
macro provides this. It takes one argument, the footnote text.
If your document uses only numbered footnotes, you could make typing
\numberedfootnote
more convenient with a command such as:
\let\footnote = \numberedfootnote
After doing this, you can type your footnotes as
\footnote{
footnote text}
, instead of as
\numberedfootnote{
footnote text}
.
Eplain keeps the current footnote number in the count register
\footnotenumber
. So, to reset the footnote number to zero,
as you might want to do at, for example, the beginning of a chapter, you
could say \footnotenumber=0
.
Plain TeX separates the footnote marker from the footnote text by
an en space (it uses the \textindent
macro). In Eplain, you can
change this space by setting the dimension register
\footnotemarkseparation
.
The default is still an en.
You can produce a space between footenotes by setting the glue
register \interfootnoteskip
.
The default is zero.
\parskip
is also set to zero by default before the beginning of
each footnote (but not for the text of the footnote).
You can also control footnote formatting in a more general way:
Eplain expands the token register \everyfootnote
before a footnote is typeset, but after the default values for all the
parameters have been established. For example, if you want your
footnotes to be printed in seven-point type, indented by one inch, you
could say:
\everyfootnote = {\sevenrm \leftskip = 1in}
By default, an \hrule
is typeset above each group of footnotes
on a page. You can control the dimensions of this rule by setting
the dimension registers \footnoterulewidth
and \footnoteruleheight
.
The space between the rule and the first footnote on the page is
determined by the dimension register \belowfootnoterulespace
.
If you don't want any rule at all, set \footenoteruleheight=0pt
,
and, most likely, \belowfootnoterulespace=0pt
. The defaults for
these parameters typeset the rule in the same way as plain TeX: the
rule is 0.4 points high, 2 true inches wide, with 2.6 points below it.
The space above the rule and below the text on the page is controlled
by the glue register \skip\footins
. The default is a plain TeX
\bigskip
.
Eplain can create hypertext links for the footnote marks; see Footnote hyperlinks.
Exercise 11.6 of The TeXbook describes a macro \frac
for setting fractions, but \frac
never made it into plain TeX.
So Eplain includes it.
\frac
typesets the numerator and denominator in
\scriptfont0
, slightly raised and lowered. The numerator and
denominator are separated by a slash. The denominator must be enclosed
in braces if it's more than one token long, but the numerator need not
be. (This is a consequence of \frac
taking delimited arguments;
see page 203 of The TeXbook for an explanation of
delimited macro arguments.)
For example, \frac 23/{64}
turns `23/64' into
.
When you typeset long pathnames, electronic mail addresses, or other
such “computer” names, you would like TeX to break lines at
punctuation characters within the name, rather than trying to find
hyphenation points within the words. For example, it would be better to
break the email address letters@alpha.gnu.ai.mit.edu
at the
`@' or a `.', rather than at the hyphenation points in
`letters' and `alpha'.
If you use the \path
macro to typeset the names, TeX will find
these good breakpoints. The argument to \path
is delimited by
any character other other than `\' which does not appear in the
name itself.
`|' is often a good choice, as in:
\path|letters@alpha.gnu.ai.mit.edu|
You can control the exact set of characters at which breakpoints will be
allowed by calling \discretionaries
. This takes the same sort of
delimited argument; any character in the argument will henceforth be a valid
breakpoint within \path
. The default set is essentially all the
punctuation characters:
\discretionaries |~!@$%^&*()_+`-=#{}[]:";'<>,.?\/|
If for some reason you absolutely must use \
as the delimiter
character for \path
, you can set
\specialpathdelimiterstrue
. (Other delimiter characters can
still be used.) TeX then processes the \path
argument
about four times more slowly.
The \path
macro comes from path.sty, written by Nelson
Beebe and Philip Taylor and available at
http://www.ctan.org/tex-archive/macros/latex/contrib/misc/path.sty.
Eplain redefines the \TeX
macro of plain TeX to end with \null
, so that the proper
spacing is produced when \TeX
is used at the end of a sentence.
The other ...TeX macros listed here do this, also.
Eplain defines
\AMSTeX
,
\BibTeX
\AMSLaTeX
,
\LAMSTeX
,
\LaTeX
\MF
,
and \SLiTeX
to produce their respective logos. (Sorry, the logos are not shown
here.) Some spelling variants of these are also supported.
All these macros come from texnames.sty, compiled by Nelson Beebe and available at http://www.ctan.org/tex-archive/info/biblio/texnames.sty.
The solid rectangle that Eplain uses as a marker in unordered lists
(see Lists) is available by itself: just say \blackbox
.
You can create black boxes of arbitrary size with \hrule
or
\vrule
.
You can also get unfilled rectangles with \makeblankbox
.
This takes two explicit arguments: the height and depth of the rules that
define the top and bottom of the rectangle. (The two arguments are
added to get the width of the left and right borders, so that the
thickness of the border is the same on all four sides.) It also uses,
as implicit arguments, the dimensions of \box0
to define the
dimensions of the rectangle it produces. (The contents of \box0
are ignored.)
Here is an example. This small raised open box is suitable for putting next to numbers in, e.g., a table of contents.
\def\openbox{% \ht0 = 1.75pt \dp0 = 1.75pt \wd0 = 3.5pt \raise 2.75pt \makeblankbox{.2pt}{.2pt} }
Finally, you can put a box around arbitrary text with \boxit
.
This takes one argument, which must itself be a (TeX) box, and puts a
printed box around it, separated by \boxitspace
white space (3 points by default) on all four sides. For example:
\boxit{\hbox{This text is boxed.}}
The reason that the argument must be a box is that when the text is
more than one line long, TeX cannot figure out the line length for
itself. Eplain does set \parindent
to zero inside \boxit
,
since it is very unlikely you would want indentation there. (If you do,
you can always reset it yourself.)
\boxit
uses \ehrule
and \evrule
so that you can
easily adjust the thicknesses of the box rules. See Rules.
pdfTeX is a TeX variant that can output both .dvi and
.pdf (Adobe's Portable Document Format) files (see
http://www.ctan.org/tex-archive/systems/pdftex/). You might
sometimes want to know whether the target format is .pdf or
.dvi. The \ifpdf
switch can be used to detect pdfTeX in PDF mode:
\ifpdf This text is produced when pdfTeX is in PDF mode. \else This text is produced when pdfTeX is in DVI mode, or when some program other than pdfTeX is used. \fi
Keep in mind that \ifpdf
is set based on the value of the
\pdfoutput
primitive of pdfTeX at the time Eplain is loaded. If you change
the value of \pdfoutput
after you load Eplain, \ifpdf
will not reflect the change.
Eplain defines \ifpdf
by incorporating Heiko Oberdiek's
ifpdf.sty, which is available at
http://www.ctan.org/tex-archive/macros/latex/contrib/oberdiek/ifpdf.sty.
Eplain provides a limited support for loading LaTeX packages (.sty files—not .cls). This will mostly work for packages which were designed with plain TeX compatibility in mind, which means that most LaTeX packages cannot be loaded. The packages which are known to work are listed below (see Packages known to work). If you discover a working package which is not in the list, please report it to the Eplain mailing list (see Introduction).
To set up a pseudo-LaTeX environment for the packages, Eplain uses miniltx.tex (http://www.ctan.org/tex-archive/macros/plain/graphics/miniltx.tex) from the LaTeX graphics collection, written by David Carlisle and Sebastian Rahtz (the collection is available at http://www.ctan.org/tex-archive/macros/latex/required/graphics/). Eplain extends miniltx.tex to provide some additional features, e.g., support for package options.
\usepackage
command\usepackage
loads a LaTeX package. Its syntax is similar to
that of LaTeX's \usepackage
command:
\usepackage[options]{packages}[version]
where options is a comma-separated list of package
options, packages is a comma-separated list of packages to load
(without the .sty suffix), and version is a package
version number given as a date in the format `YYYY/MM/DD'. If an
older version of the package is found, a warning is issued. If
several packages are loaded within a single \usepackage
command, the options will be applied to each of the packages.
As usual, parameters in square brackets are optional and can be
omitted (together with the square brackets).
For example:
\usepackage[foo,bar]{pack1,pack2}[2005/08/29]
will load packages `pack1' and `pack2', each with the options `foo' and `bar', and will check that each of the packages are dated 2005/08/29 or newer.
Some packages request that certain commands are executed after all
packages have been loaded. In LaTeX, this means that the commands
are executed at the beginning of the document, after the so-called
preamble. Neither plain TeX nor Eplain have any kind of
preamble; therefore, Eplain requires that all packages be loaded inside
a \beginpackages...\endpackages
block, for example:
\beginpackages \usepackage[foo,bar]{pack1} \usepackage{pack2} \endpackages
This requirement enables Eplain to execute the “delayed”
commands at the end of the \beginpackages...\endpackages
block.
For the same reason, it is advisable to specify only one such block per document, just like there is only one preamble in LaTeX.
The following table lists packages that had been tested and are known to work with Eplain, and locations where you can find manuals for these packages. Some of the short descriptions of the packages were taken from the documentation for those packages.
This is the LaTeX “picture mode”, started by
\begin{picture}
and ended by \end{picture}
(in
LaTeX, this package is not explicitly loaded since it is part of
the LaTeX kernel). It provides commands to draw simple figures
inside your document without resorting to any external tools.
These packages are from the LaTeX graphics collection. They
provide commands for changing text/page colors, text rotation and
scaling, and much more.
PSfrag allows the user to precisely overlay Encapsulated PostScript
(EPS) files with arbitrary (La)TeX constructions. In order to
accomplish this, the user places a simple text “tag” in the graphics
file, as a “position marker” of sorts. Then, using simple
(La)TeX commands, the user instructs PSfrag to remove that tag from
the figure, and replace it with a properly sized, aligned, and rotated
(La)TeX equation.
This package provides a form of \verbatim
that allows
line breaks at certain characters or combinations of characters,
accepts reconfiguration, and can usually be used in the argument to
another command. It is intended for email addresses, hypertext links,
directories/paths, etc., which normally have no spaces.
Eplain can create hypertext links with the \url
command;
see URL hyperlinks.
The following packages are known not to work with Eplain:
This chapter describes the support which Eplain provides for hypertext links (hyperlinks for short). Hyperlinks can be created implicitly by the cross-reference, indexing and other macros in Eplain. Macros for constructing explicit hyperlinks are also provided.
The original TeX engine has no built-in support for hyperlinks.
Many of the present-day file formats with hyperlinking capabilities
did not even exist at the time TeX was written. However, TeX's
\special
primitive can be used to instruct TeX to write
special directives into its .dvi output file. These directives
are not interpreted by TeX in any way; they are intended for programs
which process the .dvi files produced by TeX, be it printing
or converting to other formats, such as
.ps or .pdf.
Another approach is to extend the original TeX engine with the ability to generate one of the hyperlinking formats; TeX's set of primitives can be extended to include hyperlink commands. This is the approach used by the pdfTeX engine, which is capable of producing .pdf files directly from the TeX source, skipping the .dvi generation and processing step.
It turns out that the sets of commands for different formats are mostly not interchangeable, as each of the file formats has its own quirks and capabilities. And this is where Eplain hyperlink drivers come into play.
In order for Eplain to generate proper commands, Eplain has to know two things: which engine or .dvi processor you are using, and the set of commands it understands.
The knowledge about the commands that the various processors
understand is programmed into Eplain's hyperlink drivers. Eplain
provides two drivers, pdftex
and dvipdfm
, named after
the programs which process the hyperlink commands,
pdfTeX and
dvipdfm. Therefore, Eplain can only produce hyperlink commands for one
of these two programs—except that the extended dvipdfmx
program
can be used as well as the original dvipdfm
, since they are
compatible.
To tell Eplain which .dvi processor or extended TeX engine you
are using, use the command
\enablehyperlinks
.
For example:
\enablehyperlinks
instructs Eplain to attempt to automatically detect which
driver to use, as follows: if it detects pdfTeX in PDF mode, it
loads the pdftex
driver. If it does not detect pdfTeX in
PDF mode, the dvipdfm
driver is loaded. The detection is based
on the
\ifpdf
switch (see Checking for PDF output).
If necessary, you can explicitly specify the driver name:
\enablehyperlinks[pdftex]
will start producing hyperlinks under the assumption that you are using pdfTeX.
Eplain does not produce any hyperlinks until you explicitly enable
them with \enablehyperlinks
. For one thing, this keeps Eplain
backward-compatible with previous releases without hyperlink support.
For another, you may be using a program other than pdfTeX or
dvipdfm
, which does not understand their hyperlink commands.
In general, hyperlinks work as follows. You mark some place in your document as a hyperlink destination, associating a hyperlink label with that destination. Next, somewhere within your document, you create a hyperlink, using a label to identify the destination you want this link to point to. A hyperlink is a region in the document (which can take many forms, for example, text or a picture); when a user clicks on that region, they will be taken to a place in the document marked by the corresponding destination. The following two sections (Explicit hyperlinks, and Implicit hyperlinks) describe the macros you can use to define destinations and create links pointing to those destinations.
In the rest of this chapter, we will often need to refer to links and destinations jointly, in which case we will use the term hyperlinks. We will use the terms links and destinations in cases when we need to refer specifically to links or destinations.
Hyperlink drivers provide several kinds of links and destinations. We will refer to them as link types and destination types.
For example, one of the destination types that the pdftex
driver provides is the `xyz' type; when the user follows a link
pointing to an `xyz' destination, the exact location marked by
that destination is displayed. Another destination type provided by
the pdftex
driver is the `fit' type; when the user follows
a link pointing to a `fit' destination, the page containing that
destination is zoomed to fit into the window in which the document is
displayed.
Similarly, drivers support various link types. For example, with the
pdftex
driver, the usual link type used to refer to
destinations in the current document is called `name'. You can
also create a link pointing to another local document (by using the
`filename' link type) or to a URL (by using the `url' link
type).
In addition, each hyperlink driver supports a number of destination and link options. By setting these options you can customize hyperlink parameters (e.g., the thickness of the border drawn around a hyperlink) or pass information to hyperlinks (for example, file name of a document, for a link pointing to a destination in another document).
See Hyperlink drivers, for the description of hyperlink types and options supported by the drivers. See Setting hyperlink types and options, for the information on how to set hyperlink options.
Explicit hyperlinks are created by you, in the source of your
document. The simplest command is \hldest
, which marks the
current position in your document as a destination:
\hldest{type}{options}{label}
Here type is one of the destination types supported by
the hyperlink driver (see Hyperlink drivers), options is a
comma-separated list of option assignments, and label is the
hyperlink label to associate with this destination. This label will
identify the destination when creating links pointing to this
destination. For example, with the pdftex
driver, the command
\hldest{xyz}{zoom=2000}{index}
creates a destination of type `xyz' (“the current
position”), sets the magnification ratio for this destination to be
200%, and associates the label index
with the destination.
Another command, \hlstart
, paired with \hlend
, turns all
intervening material into a link:
\hlstart{type}{options}{label} ... \hlend
Here type, options and label have the same
meaning as for \hldest
. Continuing the previous example,
\hlstart{name}{bstyle=U,bwidth=2}{index} Index\hlend
typesets the word `Index' as a link with underline border of
width 2 PostScript points, pointing to the named destination
index
defined in the previous example. (The other options, like
highlight mode and border color, are determined by the defaults,
see Setting default types and options).
Both \hldest
and \hlstart
ignore following spaces.
Both \hldest
and \hlstart
expand the first token of
options once, so you can save a list of options in a macro and
pass it for the options. For example:
\def\linkopts{bstyle=U,bwidth=2} \hlstart{name}{\linkopts}{index}Index\hlend
is functionally equivalent to the previous example.
Implicit hyperlinks are hyperlinks created implicitly by various Eplain macros, such as the macros for citations, cross-references, indexing, etc.
All such macros are divided into link groups and destination groups (or linkgroups and destgroups for short) so that parameters can be set individually for each group. For example, all equation macros which define a destination are assigned to the `eq' destgroup; equation macros which create a link are assigned to the `eq' linkgroup. By setting parameters for the `eq' linkgroup (destgroup), you can uniformly customize all links (destinations) related to equation references, without interfering with settings for the other groups.
See Setting hyperlink types and options, for information on how to set parameters for a group.
Here is the list of the linkgroups:
cite, ref, xref, eq, idx, foot, footback, url.
And here are the destgroups:
bib, li, definexref, xrdef, eq, idx, foot, footback.
The following subsections describe each of the linkgroups and destgroups and the hyperlink support provided.
The `url' linkgroup covers the
\url
command from the LaTeX package
url (see Packages known to work), as well as any new
\url
-like commands you define. The type for this linkgroup is
set to `url' by the drivers which support this link type.
`url' links use the parameter to the \url
command as the URL
to point to.
You may be using the \url
command to typeset something other than
a URL, e.g., a path, for which you do not want a link to be created; in
that case, you can disable the `url' linkgroup with the command
\hloff[url]
(see Turning hyperlinks on/off for a group).
The `cite' linkgroup includes only the \cite
command
(see Citations). \cite
turns each of the references in the
list into a link pointing to the respective bibliography entry
produced by the \bibliography
command.
The `bib' destgroup includes the macros related to the
\bibliography
command (see Citations). \bibliography
inputs a .bbl file, which contains a list of bibliography
entries. For each of the entries, a destination is defined.
Both commands use the citation label as the hyperlink label.
The `li' destgroup consists of the \li
command (see Lists),
which defines a destination if you supply the optional argument
(cross-reference label). This label is also used as the hyperlink
label.
The `definexref' destgroup is for the \definexref
command
(see Defining generic references). \definexref
defines a
destination using the cross-reference label (the first argument) as the
hyperlink label.
The `ref' linkgroup includes \refn
and \xrefn
(they are
synonyms), \ref
, and \refs
(see Using generic references).
\refn
turns the cross-reference it produces into a link, using
the cross-reference label as the hyperlink label. If an optional
argument is present, it is tied by
\reftie
to the reference and become part of the link.
\ref
works similarly to \refn
. It takes an optional
argument, which is treated the same way as the optional argument to
\refn
. In addition, \ref
can produce a “class word”.
Both the optional argument and the class word become part of the link,
when present. The cross-reference is tied by
\reftie
to the preceding word. The optional argument is
separated from the class word by
\refspace
.
Unlike \ref
, \refs
does not take an optional argument and
does not make the class word part of the link, which is appropriate for
its intended use.
The `xrdef' destgroup is for \xrdef
(see Page references).
\xrdef
defines a destination using cross-reference label as the
hyperlink label.
The `xref' linkgroup includes the \xref
command (see Page references). \xref
turns its optional argument (followed by
\refspace
), \xrefpageword
and the cross-reference (page
number) into a link, using the cross-reference label as the hyperlink
label.
All commands that define equation labels are part of the `eq' destgroup.
These are \eqdef
, \eqdefn
, \eqsubdef
and
\eqsubdefn
(see Equation references). All these commands use
the equation label as the hyperlink label. However, if the equation
label is empty, they make up a (hopefully) unique hyperlink label for
the destination. This label will be used for the link when you refer to
this empty-labeled equation with one of the equation reference macros.
The command \phantomeqlabel
is called to generate hyperlink
labels for the empty-labeled equations. By default, it produces the
labels in the format `PHEQnumber', where number comes
from the count register \phantomeqnumber
; this count register is
incremented at every empty-labeled equation definition.
The commands \eqref
and \eqrefn
(see Equation references) form the `eq' linkgroup. These commands take an optional
argument, which, when present, is tied with \reftie
to the
equation reference and becomes part of the link. The equation label is
used for the hyperlink label; if the label is empty, the link is for the
label generated for the last empty-labeled equation.
All indexing commands (\idx
, \idxname
, \idxmarked
,
\idxsubmarked
and their silent equivalents, see Indexing commands) form the `idx' destgroup. The `idx' linkgroup consists of
the macros which are used to typeset the index when you say
\readindexfile{
index-letter}
(see Typesetting an index).
To create the links in index entries, Eplain uses MakeIndex's “encapsulation” feature. When you use an indexing macro to mark an index term, Eplain writes out a line to the .idx file of the following general form:
\indexentry{entry|pagemarkup}{pageno}
where entry is the index entry (converted into the
internal format that MakeIndex understands), cs is the markup
command you specified with the pagemarkup=
cs optional
argument to the indexing commands (see Modifying index entries),
and pageno is the page number on which the term appeared. When
processing the .idx file, MakeIndex makes the page number an
argument to the page markup command (“encapsulates” the page
number), so the page number in the
.ind file appears as \
cs{
pageno}
. Eplain
internally replaces the cs command name with its own command,
which, in addition to calling the original \
cs
encapsulator, turns the page number into a link.
Eplain provides two approaches to linking page numbers in the index to locations of index terms in the text.
In this approach, each command that marks an index term defines a unique
destination and passes its label on to the .idx file as part of
the \indexentry
command. The \indexentry
line that Eplain
writes to the .idx file becomes
\indexentry{entry|hlidx{label}{cs}}{pageno}
where \hlidx
is the command that is defined by Eplain
to take three arguments: a hyperlink label (label), a name of
page number encapsulator (cs) and a page number (pageno).
In the .ind file that MakeIndex will generate, the page number
will now appear as
\hlidx{label}{cs}{pageno}
The result of this command is
\
cs{
pageno}
, wrapped up into a link pointing to
label destination.
The hyperlink labels for the index terms are generated by the
\hlidxlabel
command, by default in the format
`IDXnumber', where number is the value of the count
register
\hlidxlabelnumber
. This count register is incremented at each
index term.
The advantage of this approach, as compared to the second approach
described below, is that links in the index point to exact locations of
the indexed terms on the page. The disadvantage of this approach is
that MakeIndex will regard all index entries as distinct, because
each one contains a (unique) hyperlink label. This disadvantage can be
partially overcome by the script
idxuniq distributed with Eplain in the util directory.
This script filters out \indexentry
lines differing only in the
hyperlink label but identical otherwise. You should process the
.idx with this script before passing it on to MakeIndex. For
example:
prompt$ ./idxuniq file.idx | makeindex > file.ind
Still, this solution is not ideal, as the page-range formation ability of MakeIndex will not work, and there will be problems of apparently identical index entries clashing (e.g., when a range-end entry appears on the same page as another entry with the same definition; idxuniq will not filter out the second entry).
In the second approach, Eplain does not write out any destination labels
for the index terms. Instead, Eplain writes out a wrapper for page
number encapsulator which can parse the page number and generate a link
pointing to the page on which the term appeared. On top of each
page containing an index term, Eplain defines a destination with label
produced by
\hlidxpagelabel
. The \hlidxpagelabel
command takes a
single argument (page number number) and by default produces the
label in the format `IDXPGnumber'.
With this approach, the \indexentry
line which Eplain writes to
the .idx
file looks like this:
\indexentry{entry|hlidxpage{cs}}{pageno}
where \hlidxpage
is the command that is defined by Eplain
to take two arguments: a name of page number encapsulator (cs)
and a page number (pageno). In the .ind file that
MakeIndex will generate, the page number will appear as
\hlidxpage{cs}{pageno}
The advantage of this approach is that all features of MakeIndex are intact. The drawback is that links in the index do not point to exact locations of indexed terms on a page, but to the top of a page on which the term appears.
Another disadvantage is that this approach depends on the page range and
page list separators which MakeIndex was configured to output.
\hlidxpage
must be able to parse the first page number in a page
range like `1--4'. In addition, page list parsing is needed
because MakeIndex combines two consecutive page numbers in one call to
the page number encapsulator, so \hlidxpage
can be passed, e.g.,
`1, 2' for the pageno. In this last case, \hlidxpage
splits the two page numbers, applies \
cs to each of them,
and makes each of the page numbers a link to the appropriate page. Note
that this will alter typesetting slightly, because now the page list
separator (a comma followed by a space, by default) is not typeset using
the page number encapsulator (\
cs).
Eplain's defaults for the page list and page number delimiters are the same as those in MakeIndex, a comma followed by a space (`, ') and two dashes (`--'), respectively. If you customize MakeIndex to use different delimiters, you must not forget to let Eplain know about them with the commands
\setidxpagelistdelimiter{list-delim} \setidxpagerangedelimiter{page-delim}
(see Page list and page range parsers).
The approach that Eplain should use for the index terms can be
selected in the
\enablehyperlinks
command. The optional argument it accepts is
a comma-separated list of options. The
idxexact
option selects the first approach,
idxpage
the second, and
idxnone
disables hyperlink support for the index terms
altogether, in case you want to stop Eplain from writing its link
wrappers into the .idx file. The default is idxpage
.
For example:
\enablehyperlinks[idxexact]
selects the first approach (“exact index links”).
The macros that Eplain uses to parse page lists and page ranges,
\idxparselist
and \idxparserange
, can sometimes be useful
when defining page number encapsulators. See Page list and page range parsers, for the description of these commands and an example of their
usage.
There is no automatic support for hyperlinks with “see” and “see
also” index entries, as there is not enough information to trace the
parameters of
\indexsee
and
\indexseealso
to corresponding index entries. But if desired,
this can be implemented with \hldest
and \hlstart
(see Explicit hyperlinks); for example:
\sidx{semantic theory of truth@% \leavevmode\hldest{}{}{idx:theo truth}semantic theory of truth} ... \sidx[seealso]{truth}[definition of]% {\hlstart{}{}{idx:theo truth}semantic theory of truth\hlend}
The `foot' link and destination groups include the
\numberedfootnote
and
\footnote
macros (see Footnotes). The `footback' groups
include the same macros, but control parameters for links and
destinations created inside the footnote to point back to the footnote
mark within the text body.
The macros use hyperlink labels generated by
\hlfootlabel
and
\hlfootbacklabel
. The default formats for the labels are
`FOOTnumber' and `FOOTBnumber', respectively,
where number is the value of the count register
\hlfootlabelnumber
. This register is incremented at every
footnote.
There is currently no special support for hyperlinks in the table of
contents (see Contents), but implementing them with the
\hldest
and \hlstart ... \hlend
commands
(see Explicit hyperlinks) should be possible.
This section describes the hyperlink drivers: the types of hyperlinks they support, and the options they accept. During the first reading, you may only want to skim through this section.
Some of the descriptions below come from Portable Document Format Reference Manual Version 1.3, March 11, 1999.
This subsection describes the destination and link options which are supported by all hyperlink drivers.
raise
It is usually convenient to set this option to some variable parameter,
so that the height to which destinations are raised is automatically
adjusted according to the current context. For example, setting it to
\normalbaselineskip
(or some fraction of it, like
1.7\normalbaselineskip
) makes the setting appropriate for
different point sizes, in case your document uses more than one.
The default setting is \normalbaselineskip
. Initially, the
destgroups do not define this option, so they fall back on the default,
except for the `eq' destgroup, for which this option is set to
1.7\normalbaselineskip
,
to accommodate the usual cases of large operators in displayed math.
Example: \hldestopts[eq]{raise=2.5\normalbaselineskip}
colormodel
color
\color
command is defined,
e.g., by loading the LaTeX `color' package (see Packages known to work). The \color
command is called as
\color[
colormodel]{
color}
, where colormodel
and color are the definitions of the colormodel
and
color
options, respectively. However, if colormodel is
empty, the optional argument to \color
is omitted; and if
color is empty, the \color
command is omitted altogether.
The default setting is colormodel=cmyk
and
color=0.28,1,1,0.35
.
When specifying colors with several components delimited by commas
(e.g., RGB and CMYK colors in the LaTeX `color' package), it is not
possible to specify the components directly in the option list of
\hlopts
, because comma is the option list delimiter. With the
`color' package, it is possible to specify such colors by defining a
custom color with \definecolor
and using the new color name with
an empty colormodel (see examples below).
Examples:
\hlopts{colormodel=,color=blue}% predefined color \definecolor{mycolor}{rgb}{.3,.8,.95} \hlopts{colormodel=,color=mycolor}% custom color \hlopts{colormodel=gray,color=.4}
pdftex
and dvipdfm
This subsection describes link and destination types and options
supported by the pdftex
and dvipdfm
drivers. Many of the
hyperlink types and options are common to both drivers, so we describe
them together.
pdftex
and dvipdfm
xyz
zoom
specifies magnification to use (zero or empty means leave
magnification unchanged, which is the default). This is the default
type.
For dvipdfm
: the options
left
and
top
specify position coordinates to use (empty options mean
current position coordinate, which is the default).
Example: \hldest{xyz}{zoom=2000}{dest123}
fit
Example: \hldest{fit}{}{dest123}
fith
For dvipdfm
: the
top
option specifies vertical position (default is empty, meaning
current position).
Example: \hldest{fith}{}{dest123}
fitv
For dvipdfm
: The option
left
specifies horizontal position (default is empty, meaning
current position).
Example: \hldest{fitv}{}{dest123}
fitb
Example: \hldest{fitb}{}{dest123}
fitbh
For dvipdfm
: the option
top
specifies vertical position (default is empty, meaning
current position).
Example: \hldest{fitbh}{}{dest123}
fitbv
For dvipdfm
: the option
left
specifies horizontal position (default is empty, meaning
current position).
Example: \hldest{fitbv}{}{dest123}
fitr
pdftex
: fit the rectangle specified by the options
width
,
height
and
depth
(as a TeX rule specification) in the window. For
dimensions set to empty, the corresponding value of the parent box is
used (these are the defaults).
For dvipdfm
: fit the rectangle specified by the options
left
,
bottom
,
right
and
top
(in
PostScript points, 72 points per inch) in the window. For
dimensions set to empty, current position coordinate is substituted
(these are the defaults).
Example for pdftex
:
\hldest{fitr}{width=\hsize,height=.5\vsize,depth=0pt}{dest123}
Example for dvipdfm
:
\hldest{fitr}{left=72,bottom=72,right=720,top=360}{dest123}
raw
\special
) is taken from the command sequence
\
cs, where cs is the value of the
cmd
option. In the definition of \
cs, use
\@hllabel
to refer to the hyperlink label. This option is
intended to be used with destgroups (see Setting hyperlink types and options), as it does not make sense to use it in a direct call to
\hldest
—you can just call the raw command.
Example for pdftex
:
\makeatletter \def\mydest{\pdfdest name{\@hllabel} xyz} \hldesttype{raw} \hldestopts{cmd=mydest} \resetatcatcode
Example for dvipdfm
:
\makeatletter \def\mydest{\special{pdf: dest (\@hllabel) [@thispage /XYZ @xpos @ypos 0]}} \hldesttype{raw} \hldestopts{cmd=mydest} \resetatcatcode
pdftex
and dvipdfm
With respect to the destination options, the pdftex
and
dvipdfm
differ in the way the fit rectangle is specified
(relative coordinates for pdftex
, absolute coordinates for
dvipdfm
).
cmd
\special
for the raw
destination.
For an example of usage, see Destination types for pdftex and dvipdfm, description of the raw
destination.
zoom
Example: \hldest{xyz}{zoom=2000}{dest123}
pdftex
-specific destination optionsThe dimension options below must be specified as a TeX rule specification. When set to empty, the corresponding value of the parent box is used (this is the default for all dimension options).
depth
fitr
destination.
height
fitr
destination.
width
fitr
destination.
Example:
\hldest{fitr}{width=\hsize,height=.5\vsize,depth=0pt}{dest123}
dvipdfm
-specific destination optionsThe dimension options below must be specified in PostScript points (72 points per inch), as a number without the `bp' unit name. When set to empty, the current position coordinate is used (this is the default for all dimension options).
bottom
left
right
top
Example:
\hldest{fitr}{left=72,bottom=72,right=720,top=360}{dest123}
pdftex
and dvipdfm
Link types are the same for the pdftex
and dvipdfm
drivers, except that the pdftex
driver provides one additional
link type num
(link to a numbered destination). dvipdfm does not
support numbered destinations, therefore it does not have this link
type. Note that all destinations created by Eplain hyperlink macros are
named destinations; to define a numbered destination, you have to use
low-level pdfTeX commands.
name
\hldest
are named destinations.
This is the default type.
Example: \hlstart{name}{}{dest123}Link to dest123\hlend
page
pagefit
option.
Example:
\hlstart{page}{pagefit=/FitH 600}{123}Link to page~123\hlend
filename
file
option. Page fitting is specified by the
pagefit
option. The
newwin
option specifies whether the destination document is
opened in the same window or in a new window.
Example:
\hlstart{filename}{file=book.pdf,newwin=1}{dest123} Link to dest123 in file `book.pdf'\hlend
filepage
file
option. Page fitting is specified by the
pagefit
option. The
newwin
option specifies whether the destination document is
opened in the same window or in a new window.
Example:
\hlstart{filepage}{file=book.pdf,newwin=,% pagefit=/FitR 50 100 300 500}{1} Link to page~1 in file `book.pdf'\hlend
url
Example: \hlstart{url}{}{http://tug.org/eplain/}Eplain home\hlend
raw
\special
primitive) is taken from the command sequence
\
cs, where cs is the value of the
cmd
option. This option is intended to be used with linkgroups
(see Setting hyperlink types and options), as it does not make sense
to use it in a direct call to
\hlstart
—you can just call the raw command.
Example for pdftex
:
% Redirect all \url links to the first page \def\mycmd{\pdfstartlink goto page 1 {/Fit}} \hltype[url]{raw} \hlopts[url]{cmd=mycmd}
Example for dvipdfm
:
% Redirect all \url links to the first page \def\mycmd{\special{pdf: beginann <</Type/Annot /Subtype/Link /Dest[0 /Fit]>>}} \hltype[url]{raw} \hlopts[url]{cmd=mycmd}
pdftex
-specific link typesnum
Example: \hlstart{num}{}{123}Link to 123\hlend
pdftex
and dvipdfm
Link options are mostly the same for the pdftex
and
dvipdfm
drivers. The pdftex
driver has additional
options to specify link dimensions.
bcolor
Example: \hlstart{name}{bcolor=.1 .5 1}{dest123}Link\hlend
bdash
Example: \hlstart{name}{bstyle=D,bdash=2 4}{dest123}Link\hlend
bstyle
S
D
bdash
option).
B
I
U
The default is `S'.
Example: \hlstart{name}{bstyle=D,bdash=2 4}{dest123}Link\hlend
bwidth
Example: \hlstart{name}{bwidth=2}{dest123}Link\hlend
cmd
\special
for the raw
link.
For an example of usage, see Link types for pdftex and dvipdfm,
description of the raw
link.
file
filename
and filepage
link types.
For an example of usage, see Link types for pdftex and dvipdfm,
description of the filename
and filepage
links.
hlight
I
N
O
P
The default is `I'.
Example: \hlstart{name}{bstyle=S,hlight=O}{dest123}Link\hlend
newwin
filename
and filepage
links, specifies whether the destination document is
opened in the same window or in a new window. The settings are:
0
0
The default is empty.
For an example of usage, see Link types for pdftex and dvipdfm,
description of the filename
and filepage
links.
pagefit
page
and filepage links
, specifies how the page
must be fitted to the window. pagefit
specification is written
to the PDF file as is, so it must conform to the PDF standard.
For an example of usage, see Link types for pdftex and dvipdfm,
description of the page
and filepage
links.
pdftex
-specific link optionsThe dimension options below must be specified as a TeX rule specification. When set to empty, the corresponding value of the parent box is used (this is the default for all dimension options).
depth
height
width
Example:
\hlstart{name}{width=5in,height=20pc,depth=0pt}{dest123} Link\hlend
nolinks
Select this driver to suppress all hyperlinks in your document.
Selecting this driver is quite different from not selecting any driver
at all, or from selecting some driver and then turning hyperlinks off
for the entire document with
\hloff
and
\hldestoff
(see Turning hyperlinks on/off).
The purpose of \hldestoff
and \hloff
is to mark (parts) of
your document where hyperlinks should never appear. (Imagine you want
to prevent a cross-referencing macro from generating a link at a certain
spot in your document.)
If instead you have prepared a document with hyperlinks and just want to
compile a version without them, it is better to select the driver
nolinks
. This ensures that spacing and page-breaking are the
same as what you were getting with hyperlinks enabled.
The reason for this is that hyperlinks are produced by the
\special
primitives or low-level hyperlink commands. Each such
command is placed inside a
whatsit (an internal TeX object), which may introduce
legitimate breakpoints at places where none would exist without the
whatsits. The macros \hldestoff
and \hloff
disable the
hyperlink macros completely, so that no whatsits are produced.
In contrast, the nolinks
driver does not completely disable
hyperlink macros. Instead, it defines them to merely write to the log
file (what gets written is unimportant). This also produces
whatsits, thus imitating the whatsits from the hyperlink commands.
(This trick was borrowed from the
LaTeX `color' package.)
Another reason for using nolinks
is that in horizontal mode
\hldest
places destinations inside boxes of zero width, height,
and depth. When you say \hldestoff
, \hldest
will omit
both destination definitions and these boxes. The missing boxes can
again cause the typesetting to be inconsistent with that with
destinations enabled. Here again, the nolinks
driver helps by
defining \hldest
to produce the empty boxes.
You can define default types for links and destinations, which will be
used when you do not specify a type in
\hlstart
or
\hldest
. Similarly, you can define default values for the
options; the default value for an option is used when you do not set the
option in the argument to \hlstart
or \hldest
.
The parameters for implicit links and destinations can be customized by setting the “group” types and options. When not set, the defaults are used.
All these settings are local to the current (TeX) group, so if
you want to set an option temporarily, you can do so inside a
\begingroup...\endgroup
block; when the group ends, the
previous settings are restored.
The default types for links and destinations can be set with the following commands:
\hltype{type} \hldesttype{type}
where type is one of the link/destination types supported by the selected hyperlink driver (see Hyperlink drivers).
Default values for the options can be set with the following commands:
\hlopts{options} \hldestopts{options}
where options is a comma-separated list of option assignments in the format `option=value'. Again, what options are allowed depends on the selected hyperlink driver.
When called with an optional argument, as in
\hltype[groups]{type} \hldesttype[groups]{type}
where groups is a comma-separated list of groups,
\hltype
and \hldesttype
set the type for each group from
groups to type. The default type is used for all groups
with an empty type (this is the initial setting for all groups, except
that the type for the `url' linkgroup is set to `url' by the
drivers which support this link type).
There are two special “groups” which can be used inside the groups list. An empty group sets the default type. This allows to set the default type and group types in one command, for example:
\hltype[eq,]{type}
sets the link type for the `eq' linkgroup and the default link type to type.
Another special group is a star (`*') group, which signifies all defined groups. For example, the command
\hldesttype[*,]{type}
sets the destination type to type for each group, as well as the default destination type.
Option values for each group are stored as a list of option assignments. This list does not have to contain every supported option. Values for options missing from this list are taken from the default option values.
To manipulate the list of option values for the groups, you use the
\hlopts
and \hldestopts
commands with an optional
argument:
\hlopts[groups]{options} \hldestopts[groups]{options} \hlopts![groups]{options} \hldestopts![groups]{options}
where groups is a comma-separated list of groups and
options is a comma-separated list of option assignments. The
two special “groups”, the empty group and the star (`*')
group, have the same meaning as for \hltype
and
\hldesttype
.
When used without the exclamation mark, \hlopts
and
\hldestopts
preserve the current list of options for the groups,
and only update the options listed in options. If you add the
exclamation mark, the current list of options for each group in
groups is discarded and the new list is set to options.
The “overriding” nature of the `!' is appropriate when you give a complete specification of the options for a group, e.g., at the beginning of your document. On the other hand, when you want to adjust some option(s) and leave others intact, you should use the macros without the `!'.
For example, with displayed mathematical formulas, you often need to
adjust the `raise' option for the
`eq' destgroup, because the formulas often contain large parentheses and
brackets. But when doing so, you want to leave the other settings
unchanged. To achieve this, call \hldestopts
without the
`!', for example:
$$\hldestopts[eq]{raise=2.5\normalbaselineskip} ... $$
The display commands (`$$') implicitly put the entire
formula inside a (TeX) group (\begingroup...\endgroup
), so
you do not need to isolate the setting of the `raise' option—it
will be restored after the closing `$$'.
Initially, Eplain sets the option lists for almost all groups to empty, so that the groups fall back on the default values for all options. The one exception to this rule is the `eq' destgroup, whose initial option list contains one setting:
raise=1.7\normalbaselineskip
This setting usually accommodates the large operators, which often appear in displayed math.
Links and/or destinations can be turned on or off globally by disabling the low-level commands, or for each group individually.
All these settings are local to the current (TeX) group, so if you
want to enable or disable links/destinations temporarily, you can do so
inside a \begingroup...\endgroup
block; when the group ends, the
previous settings are restored.
The low-level commands \hlstart
, \hlend
and
\hldest
can be turned on/off with the following commands:
\hldeston \hldestoff \hlon \hloff
See Hyperlink driver nolinks, for the implications of using these commands to disable hyperlinks for the entire document.
If you want to disable links/destinations produced by certain groups, you can give a list of the groups as an optional argument to these commands:
\hldeston[groups] \hldestoff[groups] \hlon[groups] \hloff[groups]
where groups is the list of linkgroups/destgroups. This list can contain two special groups. The empty group switches the low-level commands (see Turning low-level commands on/off), and the star (`*') group operates on all defined groups.
Note that turning off the low-level commands disables all hyperlinks globally, including groups which have them enabled. Turning off certain linkgroups/destgroups records the fact that the macros in the group should not produce links/destinations. To illustrate the distinction, assume that all links are on; after the following sequence of commands:
\hloff \hloff[eq] \hlon
all links are on except for the `eq' linkgroup.
This chapter describes definitions for producing commutative diagrams.
Steven Smith wrote this documentation (and the macros).
The macros \drawline
and \drawvector
provide the capability found in LaTeX's
picture mode to draw slanted lines and vectors of certain directions.
Both of these macros take three arguments: two integer arguments to
specify the direction of the line or vector, and one argument to specify
its length. For example, `\drawvector(-4,1){60pt}' produces the
vector
which lies in the 2d quadrant, has a slope of minus 1/4, and a width of
60 pt.
Note that if an \hbox
is placed around \drawline
or
\drawvector
, then the width of the \hbox
will be the
positive dimension specified in the third argument, except when a
vertical line or vector is specified, e.g.,
\drawline(0,1){1in}
, which has zero width. If the specified
direction lies in the 1st or 2d quadrant (e.g., (1,1)
or
(-2,3)
), then the \hbox
will have positive height and zero
depth. Conversely, if the specified direction lies in the 3d or 4th
quadrant (e.g., (-1,-1)
or (2,-3)
), then the \hbox
will have positive depth and zero height.
There are a finite number of directions that can be specified. For
\drawline
, the absolute value of each integer defining the
direction must be less than or equal to six, i.e., (7,-1)
is
incorrect, but (6,-1)
is acceptable. For \drawvector
, the
absolute value of each integer must be less than or equal to four.
Furthermore, the two integers cannot have common divisors; therefore, if
a line with slope 2 is desired, say (2,1)
instead of
(4,2)
. Also, specify (1,0)
instead of, say, (3,0)
for horizontal lines and likewise for vertical lines.
Finally, these macros depend upon the LaTeX font line10
. If
your site doesn't have this font, ask your system administrator to get
it. Future enhancements will include macros to draw dotted lines and
dotted vectors of various directions.
The primitive commands \drawline
and \drawvector
can be
used to typeset arrow theoretic diagrams. This section describes (1)
macros to facilitate typesetting arrows and morphisms, and (2) macros to
facilitate the construction of commutative diagrams. All macros
described in this section must be used in math mode.
The macros \mapright
and \mapleft
produce right and left
pointing arrows, respectively. Use superscript (^
) to place a
morphism above the arrow, e.g., `\mapright^\alpha'; use subscript
(_
) to place a morphism below the arrow, e.g.,
`\mapright_{\tilde l}'. Superscripts and subscripts may be used
simulataneously, e.g., `\mapright^\pi_{\rm epimor.}'.
Similarly, the macros \mapup
and \mapdown
produce up and
down pointing arrows, respectively. Use \rt
to place a morphism to the right of the arrow, e.g., `\mapup\rt{\rm
id}'; use \lft
to place a morphism to the left of the arrow, e.g., `\mapup\lft\omega'.
\lft
and \rt
may be used simultaneously, e.g.,
`\mapdown\lft\pi\rt{\rm monomor.}'.
Slanted arrows are produced by the macro \arrow
, which takes
a direction argument (e.g., `\arrow(3,-4)'). Use \rt
and
\lft
to place morphisms to the right and left, respectively, of
the arrow. A slanted line (no arrowhead) is produced with the macro
\sline
,
whose syntax is identical to that of \arrow
.
The length of these macros is predefined by the default TeX
dimensions \harrowlength
,
for horizontal arrows (or lines),
\varrowlength
,
for vertical arrows (or lines), and
\sarrowlength
,
for slanted arrows (or lines). To change any of these dimensions, say,
e.g., `\harrowlength=40pt'. As with all other TeX dimensions,
the change may be as global or as local as you like. Furthermore, the
placement of morphisms on the arrows is controlled by the dimensions
\hmorphposn
,
\vmorphposn
,
and \morphdist
.
The first two dimensions control the horizontal and vertical position of
the morphism from its default position; the latter dimension controls
the distance of the morphism from the arrow. If you have more than one
morphism per arrow (i.e., a ^
/_
or \lft
/\rt
construction), use the parameters
\hmorphposnup
,
\hmorphposndn
,
\vmorphposnup
,
\vmorphposndn
,
\hmorphposnrt
,
\hmorphposnlft
,
\vmorphposnrt
,
and \vmorphposnlft
.
The default values of all these dimensions are provided in the section
on parameters that follows below.
There is a family of macros to produce horizontal lines, arrows, and
adjoint arrows. The following macros produce horizontal maps and have
the same syntax as \mapright
:
\mapright
$X\mapright Y$
\mapleft
$X\mapleft Y$
\hline
$X\hline Y$
\bimapright
$X\bimapright Y$
\bimapleft
$X\bimapleft Y$
\adjmapright
$X\adjmapright Y$
\adjmapleft
$X\adjmapleft Y$
\bihline
$X\bihline Y$
There is also a family of macros to produce vertical lines, arrows, and
adjoint arrows. The following macros produce vertical maps and have
the same syntax as \mapdown
:
\mapdown
\mapup
\vline
\bimapdown
\bimapup
\adjmapdown
\adjmapup
\bivline
Finally, there is a family of macros to produce slanted lines, arrows,
and adjoint arrows. The following macros produce slanted maps and have
the same syntax as \arrow
:
\arrow
\sline
\biarrow
\adjarrow
\bisline
The width between double arrows is controlled by the parameter
\channelwidth
.
The parameters \hchannel
and \vchannel
, if nonzero,
override \channelwidth
by controlling the horizontal and vertical
shifting from the first arrow to the second.
There are no adornments on these arrows to distinguish inclusions from
epimorphisms from monomorphisms. Many texts, such as Lang's book
Algebra, use as a tasteful alternative the symbol `inc' (in roman) next
to an arrow to denote inclusion.
Future enhancements will include a mechanism to draw curved arrows
found in, e.g., the Snake Lemma, by employing a version of the
\path
macros of Appendix D of The TeXbook.
There are two approaches to the construction of commutative diagrams
described here. The first approach, and the simplest, treats
commutative diagrams like fancy matrices, as Knuth does in Exercise
18.46 of The TeXbook. This case is covered by the macro
\commdiag
,
which is an altered version of the Plain TeX macro \matrix
.
An example suffices to demonstrate this macro. The following
commutative diagram (illustrating the covering homotopy property; Bott
and Tu, Differential Forms in Algebraic Topology)
is produced with the code
$$\commdiag{Y&\mapright^f&E\cr \mapdown&\arrow(3,2)\lft{f_t}&\mapdown\cr Y\times I&\mapright^{\bar f_t}&X}$$
Of course, the parameters may be changed to produce a different effect. The following commutative diagram (illustrating the universal mapping property; Warner, Foundations of Differentiable Manifolds and Lie Groups) is produced with the code
$$\varrowlength=20pt \commdiag{V\otimes W\cr \mapup\lft\phi&\arrow(3,-1)\rt{\tilde l}\cr V\times W&\mapright^l&U\cr}$$
A diagram containing isosceles triangles is achieved by placing the apex of the triangle in the center column, as shown in the example (illustrating all constant minimal realizations of a linear system; Brockett, Finite Dimensional Linear Systems) which is produced with the code
$$\sarrowlength=.42\harrowlength \commdiag{&R^m\cr &\arrow(-1,-1)\lft{\bf B}\quad \arrow(1,-1)\rt{\bf G}\cr R^n&\mapright^{\bf P}&R^n\cr \mapdown\lft{e^{{\bf A}t}}&&\mapdown\rt{e^{{\bf F}t}}\cr R^n&\mapright^{\bf P}&R^n\cr &\arrow(1,-1)\lft{\bf C}\quad \arrow(-1,-1)\rt{\bf H}\cr &R^q\cr}$$
Other commutative diagram examples appear in the file
commdiags.tex
, which is distributed with this package.
In these examples the arrow lengths and line slopes were carefully
chosen to blend with each other. In the first example, the default
settings for the arrow lengths are used, but a direction for the arrow
must be chosen. The ratio of the default horizontal and vertical arrow
lengths is approximately the golden mean
the arrow direction closest to this mean is (3,2)
. In the second
example, a slope of
is desired and the default horizontal arrow length is 60 pt; therefore,
choose a vertical arrow length of 20 pt. You may affect the interline
glue settings of \commdiag
by redefining the macro
\commdiagbaselines
.
(cf. Exercise 18.46 of The TeXbook and the section on
parameters below.)
The width, height, and depth of all morphisms are hidden so that the
morphisms' size do not affect arrow positions. This can cause a large
morphism at the top or bottom of a diagram to impinge upon the text
surrounding the diagram. To overcome this problem, use TeX's
\noalign
primitive to insert a \vskip
immediately above or
below the offending line, e.g.,
`$$\commdiag{\noalign{\vskip6pt}X&\mapright^\int&Y\cr ...}'.
The macro \commdiag
is too simple to be used for more complicated
diagrams, which may have intersecting or overlapping arrows. A second
approach, borrowed from Francis Borceux's Diagram macros for
LaTeX, treats the commutative diagram like a grid of identically
shaped boxes. To compose the commutative diagram, first draw an equally
spaced grid, e.g.,
on a piece of scratch paper. Then draw each element (vertices and
arrows) of the commutative diagram on this grid, centered at each
grid point. Finally, use the macro \gridcommdiag
to implement your design as a TeX alignment. For example, the cubic
diagram
that appears in Francis Borceux's documentation can be implemented on
a 7 by 7 grid, and is achieved with the code
$$\harrowlength=48pt \varrowlength=48pt \sarrowlength=20pt \def\cross#1#2{\setbox0=\hbox{$#1$}% \hbox to\wd0{\hss\hbox{$#2$}\hss}\llap{\unhbox0}} \gridcommdiag{&&B&&\mapright^b&&D\cr &\arrow(1,1)\lft a&&&&\arrow(1,1)\lft d\cr A&&\cross{\hmorphposn=12pt\mapright^c}{\vmorphposn=-12pt\mapdown\lft f} &&C&&\mapdown\rt h\cr\cr \mapdown\lft e&&F&&\cross{\hmorphposn=-12pt\mapright_j} {\vmorphposn=12pt\mapdown\rt g}&&H\cr &\arrow(1,1)\lft i&&&&\arrow(1,1)\rt l\cr E&&\mapright_k&&G\cr}$$
The dimensions \hgrid
and \vgrid
control the horizontal and vertical spacing of the grid used by
\gridcommdiag
. The default setting for both of these dimensions
is 15 pt. Note that in the example of the cube the arrow lengths must
be adjusted so that the arrows overlap into neighboring boxes by the
desired amount. Hence, the \gridcommdiag
method, albeit more
powerful, is less automatic than the simpler \commdiag
method.
Furthermore, the ad hoc macro \cross
is introduced to allow the
effect of overlapping arrows. Finally, note that the positions of four
of the morphisms are adjusted by setting \hmorphposn
and
\vmorphposn
.
One is not restricted to a square grid. For example, the proof of Zassenhaus's Butterfly Lemma can be illustrated by the diagram (appearing in Lang's book Algebra) This diagram may be implemented on a 9 by 12 grid with an aspect ratio of 1/2, and is set with the code
$$\hgrid=16pt \vgrid=8pt \sarrowlength=32pt \def\cross#1#2{\setbox0=\hbox{$#1$}% \hbox to\wd0{\hss\hbox{$#2$}\hss}\llap{\unhbox0}} \def\l#1{\llap{$#1$\hskip.5em}} \def\r#1{\rlap{\hskip.5em$#1$}} \gridcommdiag{&&U&&&&V\cr &&\bullet&&&&\bullet\cr &&\sarrowlength=16pt\sline(0,1)&&&&\sarrowlength=16pt\sline(0,1)\cr &&\l{u(U\cap V)}\bullet&&&&\bullet\r{(U\cap V)v}\cr &&&\sline(2,-1)&&\sline(2,1)\cr &&\cross{=}{\sline(0,1)}&&\bullet&&\cross{=}{\sline(0,1)}\cr\cr &&\l{^{\textstyle u(U\cap v)}}\bullet&&\cross{=}{\sline(0,1)}&& \bullet\r{^{\textstyle(u\cap V)v}}\cr &\sline(2,1)&&\sline(2,-1)&&\sline(2,1)&&\sline(2,-1)\cr \l{u}\bullet&&&&\bullet&&&&\bullet\r{v}\cr &\sline(2,-1)&&\sline(2,1)&&\sline(2,-1)&&\sline(2,1)\cr &&\bullet&&&&\bullet\cr &&u\cap V&&&&U\cap v\cr}$$
Again, the construction of this diagram requires careful choices for the
arrow lengths and is facilitated by the introduction of the ad hoc
macros \cross
, \r
, and \l
. Note also that
superscripts were used to adjust the position of the vertices
Many diagrams may be typeset with the predefined macros that appear
here; however, ingenuity is often required to handle special cases.
The following is a list describing the parameters used in the commutative diagram macros. These dimensions may be changed globally or locally.
\harrowlength
\varrowlength
\harrowlength
) The length of up or down
arrows.
\sarrowlength
\hmorphposn
\hmorphposnup
,
\hmorphposndn
,
\hmorphposnrt
,
and \hmorphposnlft
for ^
/_
or \lft
/\rt
constructions.
\vmorphposn
\vmorphposnup
,
\vmorphposndn
,
\vmorphposnrt
,
and \vmorphposnlft
for ^
/_
or \lft
/\rt
constructions.
\morphdist
\channelwidth
\hchannel, \vchannel
\channelwidth
. The
horizontal and vertical shifts between double lines or arrows.
\commdiagbaselines
\baselineskip=15pt
\lineskip=3pt
\lineskiplimit=3pt
)
The parameters used by \commdiag
for setting interline glue.
\hgrid
\gridcommdiag
.
\vgrid
\gridcommdiag
.
The definitions in this section are only likely to be useful when you are writing nontrivial macros, not when writing a document.
Plain TeX defines \active
(as the number 13) for use in
changing category codes. Although the author of The TeXbook
has “intentionally kept the category codes numeric”, two other
categories are commonly used: letters (category code 11) and others
(12). Therefore, Eplain defines \letter
and
\other
.
Sometimes it is cleaner to make a character active without actually
writing a \catcode
command. The \makeactive
command takes
a character as an argument to make active (and ignores following
spaces). For example, here are two commands which both make \
active:
\makeactive`\\ \makeactive92
Sometimes you might want to temporarily change the category code of
the `@' character to \letter
, so that you can use or define
macros which are normally inaccessible to the user. For such
situations, Eplain provides the \makeatletter
command. It sets the category code of `@' to \letter
(11) and
defines
\resetatcatcode
to restore the category code to whatever it was before the call to
\makeatletter
. For example:
\makeatletter \def\@hidden@macro{This macro cannot normally be called / redefined by the user} \resetatcatcode
There is also \makeatother
which works similarly but sets the category code of `@' to
\other
(12).
Usually, when you give a definition to an active character, you have
to do so inside a group where you temporarily make the character active,
and then give it a global definition (cf. the definition of
\obeyspaces
in The TeXbook).
This is inconvenient if you are writing a long macro, or if the
character already has a global definition you do not wish to transcend.
Eplain provides \letreturn
, which defines the usual end-of-line
character to be the argument. For example:
\def\mymacro{... \letreturn\myreturn ... } \mymacro hello there
The end-of-line between `hello' and `there' causes
\myreturn
to be expanded.
The TeXbook describes \uncatcodespecials
,
which makes all characters which are normally “special” into “other”
characters, but the definition never made it into plain TeX.
Eplain therefore defines it.
Finally, \percentchar
expands into a literal `%' character. This is useful when you
\write
TeX output to a file, and want to avoid spurious
spaces. For example, Eplain writes a \percentchar
after the
definition of cross-references. The macros \lbracechar
and \rbracechar
expand similarly.
Plain TeX provides macros that allocate registers of each primitive
type in TeX, to prevent different sets of macros from using the same
register for two different things. The macros are all named starting
with `new',
e.g., \newcount
allocates a new “count”
(integer) register. Such allocations are usually needed only at the top
level of some macro definition file; therefore, plain TeX makes the
allocation registers \outer
,
to help find errors. (The error this helps to find is a missing right
brace in some macro definition.)
Sometimes, however, it is useful to allocate a register as part of
some macro. An outer control sequence cannot be used as part of a macro
definition (or in a few other contexts: the parameter text of a
definition, an argument to a definition, the preamble of an alignment,
or in conditional text that is being skipped). Therefore, Eplain
defines “inner” versions of all the allocation macros, named with the
prefix `inner':
\innernewbox
,
\innernewcount
,
\innernewdimen
,
\innernewfam
,
\innernewhelp
,
\innernewif
,
\innernewinsert
,
\innernewlanguage
,
\innernewread
,
\innernewskip
,
\innernewtoks
,
\innernewwrite
.
You can also define non-outer versions of other macros in the same way
that Eplain defines the above. The basic macro is called
\innerdef
:
\innerdef \innername {outername}
The first argument (\innername) to \innerdef
is the
control sequence that you want to define. Any previous definition of
\innername is replaced. The second argument
(outername) is the characters in the name of the outer
control sequence. (You can't use the actual control sequence name,
since it's outer!)
If the outer control sequence is named \cs, and you want to
define inner
cs as the inner one, you can use
\innerinnerdef
,
which is just an abbreviation for a call to \innerdef
. For
example, these two calls are equivalent:
\innerdef\innerproclaim{proclaim} \innerinnerdef{proclaim}
You can iterate through a comma-separated list of items with
\for
.
Here is an example:
\for\name:=karl,kathy\do{% \message{\name}% }%
This writes `karl' and `kathy' to the terminal. Spaces
before or after the commas in the list, or after the :=
, are
not ignored.
\for
expands the iterated values fully (with \edef
), so
this is equivalent to the above:
\def\namelist{karl,kathy}% \for\name:=\namelist\do ...
It is occasionally useful to redefine a macro that takes arguments to
do nothing. Eplain defines \gobble
,
\gobbletwo
,
and \gobblethree
to swallow one, two, and three arguments,
respectively.
For example, if you want to produce a “short” table of
contents—one that includes only chapters, say—the easiest thing to
do is read the entire .toc
file (see Contents), and just
ignore the commands that produce section or subsection entries. To be
specific:
\let\tocchapterentry = \shorttocchapter \let\tocsectionentry = \gobbletwo \let\tocsubsectionentry = \gobbletwo \readtocfile
(Of course, this assumes you only have chapters, sections, and subsections in your document.)
In addition, Eplain defines \eattoken
to swallow the single following token, using \let
. Thus,
\gobble
followed by `{...}' ignores the entire
brace-enclosed text. \eattoken
followed by the same ignores only
the opening left brace.
Eplain defines a macro \identity
which takes one argument and expands to that argument. This may be
useful if you want to provide a function for the user to redefine, but
don't need to do anything by default. (For example, the default
definition of \eqconstruct
(see Formatting equation references) is \identity
.)
You may also want to read an optional argument. The established
convention is that optional arguments are put in square brackets, so
that is the syntax Eplain recognizes. Eplain ignores space tokens
before an optional argument, via \futurenonspacelet
.
You test for an optional argument by using \@getoptionalarg
.
It takes one argument, a control sequence to expand after reading the
argument, if present. If an optional argument is present, the control
sequence \@optionalarg
expands to it; otherwise,
\@optionalarg
is \empty
. You must therefore have the
category code of @ set to 11 (letter). Here is an example:
\catcode`@=\letter \def\cmd{\@getoptionalarg\finishcmd} \def\finishcmd{% \ifx\@optionalarg\empty % No optional argument present. \else % One was present. \fi }
If an optional argument contains another optional argument, the inner one will need to be enclosed in braces, so TeX does not mistake the end of the first for the end of the second.
Eplain defines \xrlabel
to produce control sequence names for cross-reference labels, et al.
This macro expands to its argument with an `_' appended. (It does
this because the usual use of \xrlabel
is to generate a control
sequence name, and we naturally want to avoid conflicts between control
sequence names.)
Because \xrlabel
is fully expandable, to make a control
sequence name out of the result you need only do
\csname \xrlabel{
label}\endcsname
The \csname
primitive makes a control sequence name out
of any sequence of character tokens, regardless of category code.
Labels can therefore include any characters except for `\',
`{', `}', and `#', all of which are used in macro
definitions themselves.
\sanitize
takes a control sequence as an argument and converts
the expansion of the control sequence into a list of character tokens.
This is the behavior you want when writing information like chapter
titles to an output file. For example, here is part of the definition
of \writenumberedtocentry
; #2
is the title that the user
has given.
... \def\temp{#2}% ... \write\tocfile{% ... \sanitize\temp ... }%
This section describes some miscellanous macros for expansion, etc.
\csn
and \ece
\csn
{name} simply abbreviates \csname
name
\endcsname
, thus saving some typing. The extra level of expansion
does take some time, though, so I don't recommend it for an inner loop.
\expandafter token \csname name \endcsname
For example,
\def\fontabbrevdef#1#2{\ece\def{@#1font}{#2}} \fontabbrevdef{normal}{ptmr}
defines a control sequence \@normalfont
to expand to
ptmr
.
\edefappend
\edefappend
is a way of adding on to an existing definition. It
takes two arguments: the first is the control sequence name, the second
the new tokens to append to the definition. The second argument is
fully expanded (in the \edef
that redefines the control sequence).
For example:
\def\foo{abc} \def\bar{xyz} \edefappend\foo{\bar karl}
results in \foo
being defined as `abcxyzkarl'.
A hook is simply a name for a group of actions which is executed
in certain places—presumably when it is most useful to allow
customization or modification. TeX already provides many builtin
hooks; for example, the \every ...
token lists are all
examples of hooks.
Eplain provides several macros for adding actions to hooks. They all take two arguments: the name of the hook and the new actions.
hookaction
name actionshookappend
name actionshookprepend
name actionshookactiononce
name \
cs\hookactiononce
adds cs to name, like the macros
above, but first it adds
\global\let \cs \relax
to the definition of \cs. (This implies \cs must
be a true expandable macro, not a control sequence \let
to a
primitive or some other such thing.) Thus, \cs is expanded the
next time the hook name is run, but it will disappear after that.
The \global
is useful because \hookactiononce
is most
useful when the grouping structure of the TeX code could be anything.
Neither this nor the other hook macros do global assignments to the hook
variable itself, so TeX's usual grouping rules apply.
The companion macro to defining hook actions is \hookrun
, for
running them. This takes a single argument, the name of the hook. If
no actions for the hook are defined, no error ensues.
Here is a skeleton of general \begin
and \end
macros that
run hooks, and a couple of calls to define actions. The use of
\hookprepend
for the begin action and \hookappend
for the
end action ensures that the actions are executed in proper sequence with
other actions (as long as the other actions use \hookprepend
and
\hookappend
also).
\def\begin#1{ ... \hookrun{begin} ... } \def\end#1{ ... \hookrun{end} ... } \hookprepend{begin}\start_underline \hookappend{end}\finish_underline
A property is a name/value pair associated with another symbol, traditionally called an atom. Both atom and property names are control sequence names.
Eplain provides two macros for dealing with property lists:
\setproperty
and \getproperty
.
\setproperty
atom propname value\setproperty
defines the property property on the atom
atom to be value. atom and propname can be
anything acceptable to \csname
. value can be anything.
\getproperty
atom propname\getproperty
expands to the value stored for propname on
atom. If propname is undefined, it expands to nothing
(i.e., \empty
).
The idea of properties originated in Lisp (I believe). There, the implementation truly does associate properties with atoms. In TeX, where we have no builtin support for properties, the association is only conceptual.
The following example typesets `xyz'.
\setproperty{a}{pr}{xyz} \getproperty{a}{pr}
\expandonce
\expandonce
is defined as \expandafter\noexpand
. Thus,
\expandonce
token expands token once, instead of to
TeX primitives. This is most useful in an \edef
.
For example, the following defines \temp
to be \foo
, not
`abc'.
\def\foo{abc} \def\bar{\foo} \edef\temp{\expandonce\bar}
\ifundefined
\ifundefined{
cs}
t \else
f \fi
expands the
t text if the control sequence \
cs is undefined or
has been \let
to \relax
, and the f text otherwise.
Since \ifundefined
is not a primitive conditional, it cannot be
used in places where TeX might skip tokens “at high speed”, e.g.,
within another conditional—TeX can't match up the \if
's and
\fi
's.
This macro was taken directly from The TeXbook, page 308.
\futurenonspacelet
The \futurelet
primitive allows you to look at the next token
from the input. Sometimes, though, you want to look ahead ignoring any
spaces. This is what \futurenonspacelet
does. It is otherwise
the same as \futurelet
: you give it two control sequences as
arguments, and it assigns the next nonspace token to the first, and then
expands the second. For example:
\futurenonspacelet\temp\finishup \def\finishup{\ifx\temp ...}
\obeywhitespace
makes both end-of-lines and space characters in
the input be respected in the output. Unlike plain TeX's
\obeyspaces
, even spaces at the beginnings of lines turn into
blank space.
By default, the size of the space that is produced by a space
character is the natural space of the current font, i.e.,
what \
produces.
Ordinarily, a blank line in the input produces as much blank vertical
space as a line of text would occupy. You can adjust this by assigning
to the parameter \blanklineskipamount
:
if you set this negative, the space produced by a blank line will be
smaller; if positive, larger.
Tabs are not affected by this routine. In particular, if tabs occur at the beginning of a line, they will disappear. (If you are trying to make TeX do the “right thing” with tabs, don't. Use a utility program like expand instead.)
\numbername
produces the written-out form of its argument, i.e., `zero' through
`ten' for the numbers 0–10, and numerals for all others.
TeX's built-in \penalty
command simply appends to the
current list, no matter what kind of list it is. You might intend a
particular penalty to always be a “vertical” penalty, however, i.e.,
appended to a vertical list. Therefore, Eplain provides
\vpenalty
and \hpenalty
which first leave the other mode and then do \penalty
.
More precisely, \vpenalty
inserts \par
if the current
mode is horizontal, and \hpenalty
inserts \leavevmode
if
the current mode is vertical. (Thus, \vpenalty
cannot be used in
math mode.)
It is common to write some information out to a file to be used on a
subsequent run. But when it is time to read the file again, you only
want to do so if the file actually exists. \testfileexistence
is given an argument which is appended to \jobname
,
and sets the conditional \iffileexists
appropriately. For example:
\testfileexistence{toc}% \iffileexists \input \jobname.toc \fi
\testfileexistence
takes an optional parameter; when
given, it will override \jobname
for the root part of the file
name. For example, if you want to test for the file
answers.aux, you can do this with the following:
\testfileexistence[answers]{aux}% \iffileexists \input answers.aux \fi
Plain TeX does not provide “named” block structures, only the anonymous
\begingroup
and \endgroup
pair. The disadvantage of this
is that when there are several such groups and one is mismatched, it can
be difficult to find the error. Eplain provides a named block structure
so that if you forget an \environment
or an
\endenvironment
, you will (probably) get an error message about
it.
For example:
\def\itpar{ \environment{@italicpar} \it\par } \def\enditpar{ \par \endenvironment{@italicpar}% }
which could then be used to set italicized paragraphs:
\itpar If I reprehend anything in this world, it is the use of my oracular tongue, and a nice derangement of epitaphs! \enditpar
The above sort of environment allows nesting. But environments
shouldn't always be allowed to nest. Put the control sequence
\checkenv
at the beginning of a macro that is going to define an
environment that should not be nested.
The macros which Eplain uses to parse the page lists and ranges in the
index, \idxparselist
and \idxparserange
(see Page destinations for index terms), are sometimes useful when defining page
number encapsulators. They take one argument, text to parse. When a
page list (range) is not present, they set \idxpagei
to be
\empty
; when a list (range) is detected, they set
\idxpagei
and \idxpageii
to the first and the second page
numbers, respectively.
Eplain's defaults for the page list and page range delimiters are the same as those in MakeIndex, a comma followed by a space (`, ') and two dashes (`--'), respectively. If you customize MakeIndex to use different delimiters, you must not forget to let Eplain know about them with the commands
\setidxpagelistdelimiter{list-delim} \setidxpagerangedelimiter{page-delim}
These commands save the list-delim and
page-delim delimiters in
\idxpagelistdelimiter
and \idxpagerangedelimiter
,
respectively.
For example, you may want to define a page number markup command which italicizes and properly underlines page ranges by underlining only the page numbers and not the delimiter:
\def\ituline#1{% {\it \idxparserange{#1}% \ifx\idxpagei\empty % The argument is a single page number. \underbar{#1}% \else % The argument is a page range. \underbar{\idxpagei}\idxpagerangedelimiter\underbar{\idxpageii}% \fi}% }
Note that the \ituline
macro is not aware of page
lists. This is not needed if you use hyperlinks in the index, because
\hlidx
and \hlidxpage
will break up the page lists before
calling the user's page encapsulator (see Page destinations for index terms), so \ituline
will never see the lists. If, however, you
need to design a macro which also takes care of the lists, you can
extend \ituline
with an additional call to \idxparselist
.
.aux
file: Cross-references.aux
file: Citations.bbl
file: Citations.bib
file: Citations.bst
files: Citations.cls
files: Loading LaTeX packages.eps
files: Packages known to work.fmt
file: Invoking Eplain.fmt
file: Installation.idx
files: Index hyperlinks.idx
files: Indexing.ind
files: Index hyperlinks.ind
files: Indexing.pdf
files: Introduction to hyperlinks.pdf
files: Checking for PDF output.ps
files: Introduction to hyperlinks.sty
files: Loading LaTeX packages.toc
file: Contents@hllabel
: Destination types for pdftex and dvipdfm@indexproof
insertion class: Proofing index termsabovecolumnskip
: Multiple columnsabovecolumnspenalty
: Tablesabovelistpenalty
: Formatting listsabovelistskip
: Formatting listsabovelistskipamount
: Formatting listsadjarrow
: Arrows and morphismsadjmapdown
: Arrows and morphismsadjmapleft
: Arrows and morphismsadjmapright
: Arrows and morphismsadjmapup
: Arrows and morphismsadvancebottommargin
: Marginsadvanceleftmargin
: Marginsadvancerightmargin
: Marginsadvancetopmargin
: Marginsafterindexterm
: Customizing indexingafterindexterm
hook: Indexing commandsAMSLaTeX
: Logosamsppt.sty
: Invoking EplainAMSTeX
: Logosarrow
: Arrows and morphismsautopict.sty
: Packages known to workbblem
: Formatting bibliographiesbblfilebasename
: Citationsbblhook
: Formatting bibliographiesbblnewblock
: Formatting bibliographiesbblrm
: Formatting bibliographiesbblsc
: Formatting bibliographiesbcolor
(hyperlink option): Link options for pdftex and dvipdfmbdash
(hyperlink option): Link options for pdftex and dvipdfmbegin
for index entries: Modifying index entriesbeginindex
hook: Typesetting an indexbeginlist
: Formatting listsbeginpackages
: Environment for loading packagesbegin{picture}
: Packages known to workbegin{theindex}
: Typesetting an indexbelowcolumnskip
: Multiple columnsbelowfootnoterulespace
: Footnotesbelowlistskip
: Formatting listsbelowlistskipamount
: Formatting listsbiarrow
: Arrows and morphismsbiblabelcontents
: Formatting bibliographiesbiblabelextraspace
: Formatting bibliographiesbiblabelprint
: Formatting bibliographiesbiblabelwidth
: Formatting bibliographiesbibliography
: Citationsbibliography
(hyperlinks): Citation hyperlinksbibliographystyle
: CitationsBibTeX
: Logosbibtex
: Invoking Eplainbihline
: Arrows and morphismsbimapdown
: Arrows and morphismsbimapleft
: Arrows and morphismsbimapright
: Arrows and morphismsbimapup
: Arrows and morphismsbisline
: Arrows and morphismsbivline
: Arrows and morphismsblackbox
: Boxesblanklineskipamount
in justified text: Justificationblanklineskipamount
in obeyed text: Obeying spacesbottom
(destination option): Destination options for pdftex and dvipdfmbottom
(destination option): Destination types for pdftex and dvipdfmbottommargin
: Marginsboxit
: Boxesboxitspace
: Boxesbstyle
(hyperlink option): Link options for pdftex and dvipdfmbwidth
(hyperlink option): Link options for pdftex and dvipdfmcatcode
: Category codescenter
: Justificationcentereddisplays
: Displayschannelwidth
: Commutative diagram parameterschannelwidth
: Arrows and morphismscite
: Citationscite
(hyperlinks): Citation hyperlinkscmd
(destination option): Destination options for pdftex and dvipdfmcmd
(destination option): Destination types for pdftex and dvipdfmcmd
(hyperlink option): Link options for pdftex and dvipdfmcmd
(hyperlink option): Link types for pdftex and dvipdfmcmtt8
: Proofing index termscolor
(hyperlink option): Options supported by all driverscolor.sty
: Hyperlink driver nolinkscolor.sty
: Packages known to workcolormodel
(hyperlink option): Options supported by all driverscolumnfill
: Multiple columnscommdiag
: Construction of commutative diagramscommdiagbaselines
: Commutative diagram parameterscommdiagbaselines
: Construction of commutative diagramscsn
: \csn and \ecedefinecontentsfile
: Contentsdefineindex
: Indexingdefinexref
: Defining generic referencesdefinexref
(hyperlinks): Cross-reference hyperlinksdepth
(destination option): Destination options for pdftex and dvipdfmdepth
(destination option): Destination types for pdftex and dvipdfmdepth
(hyperlink option): Link options for pdftex and dvipdfmdiscretionaries
: Pathsdisplaylines
: Displaysdoublecolumns
: Multiple columnsdrawline
: Slanted lines and vectorsdrawvector
: Slanted lines and vectorsdvipdfm
: Introduction to hyperlinkseattoken
: Macro argumentsece
: \csn and \eceedefappend
: \edefappendehrule
: Rulesenablehyperlinks
: Choosing destination placementenablehyperlinks
: Introduction to hyperlinksend
for index entries: Modifying index entriesendlist
: Formatting listsendnumberedlist
: Listsendorderedlist
: Listsendpackages
: Environment for loading packagesendunorderedlist
: Listsend{picture}
: Packages known to workend{theindex}
: Typesetting an indexeplain
: Invoking Eplaineplain.aux
: Installationeqalignno
: Displayseqconstruct
: Formatting equation referenceseqdef
: Equation referenceseqdef
(hyperlinks): Equation reference hyperlinkseqdefn
: Equation referenceseqdefn
(hyperlinks): Equation reference hyperlinkseqnumber
: Equation referenceseqprint
: Formatting equation referenceseqref
: Equation reference hyperlinkseqref
: Equation referenceseqrefn
: Equation reference hyperlinkseqrefn
: Equation referenceseqsubdef
: Subequation referenceseqsubdef
(hyperlinks): Equation reference hyperlinkseqsubdefn
: Subequation referenceseqsubdefn
(hyperlinks): Equation reference hyperlinkseqsubreftext
: Subequation referenceseveryfootnote
: Footnotesevrule
: Rulesexpandonce
: \expandoncefile
(hyperlink option): Link options for pdftex and dvipdfmfile
(hyperlink option): Link types for pdftex and dvipdfmfileexists
(conditional): Auxiliary filesfilename
(hyperlink type): Link types for pdftex and dvipdfmfilepage
(hyperlink type): Link types for pdftex and dvipdfmfit
(destination type): Destination types for pdftex and dvipdfmfitb
(destination type): Destination types for pdftex and dvipdfmfitbh
(destination type): Destination types for pdftex and dvipdfmfitbv
(destination type): Destination types for pdftex and dvipdfmfith
(destination type): Destination types for pdftex and dvipdfmfitr
(destination type): Destination types for pdftex and dvipdfmfitv
(destination type): Destination types for pdftex and dvipdfmflushleft
: Justificationflushright
: Justificationfmtversion
: Introductionfootnote
(hyperlinks): Footnote hyperlinksfootnotemarkseparation
: Footnotesfootnoteruleheight
: Footnotesfootnoterulewidth
: Footnotesfor
: Iterationfrac
: Fractionsfullmonthname
: Time of dayfuturenonspacelet
: \futurenonspaceletgeneraldisplay
: Formatting displaysgetproperty
: Propertiesgloggingall
: Diagnosticsgobble
: Macro argumentsgobbletwo
: Macro argumentsgraphics.sty
: Packages known to workgraphicx.sty
: Packages known to workgridcommdiag
: Construction of commutative diagramsgtracingall
: Diagnosticsgutter
: Multiple columnsgutterbox
: Multiple columnshangindent
for index entries: Typesetting an indexharrowlength
: Commutative diagram parametersharrowlength
: Arrows and morphismshchannel
: Commutative diagram parametersheight
(destination option): Destination options for pdftex and dvipdfmheight
(destination option): Destination types for pdftex and dvipdfmheight
(hyperlink option): Link options for pdftex and dvipdfmhgrid
: Commutative diagram parametershgrid
: Construction of commutative diagramshldest
: Setting hyperlink types and optionshldest
: Destination types for pdftex and dvipdfmhldest
: Explicit hyperlinkshldestoff
: Turning low-level commands on/offhldestoff
: Hyperlink driver nolinkshldeston
: Turning low-level commands on/offhldestopts
: Setting group optionshldestopts
: Setting default types and optionshldesttype
: Setting group typeshldesttype
: Setting default types and optionshlend
: Explicit hyperlinkshlfootbacklabel
: Footnote hyperlinkshlfootlabel
: Footnote hyperlinkshlfootlabelnumber
: Footnote hyperlinkshlidx
: Exact destinations for index termshlidxlabel
: Exact destinations for index termshlidxlabelnumber
: Exact destinations for index termshlidxpage
: Page destinations for index termshlidxpagelabel
: Page destinations for index termshlight
(hyperlink option): Link options for pdftex and dvipdfmhline
: Arrows and morphismshloff
: Turning low-level commands on/offhloff
: Hyperlink driver nolinkshlon
: Turning low-level commands on/offhlopts
: Setting group optionshlopts
: Setting default types and optionshlstart
: Setting hyperlink types and optionshlstart
: Link types for pdftex and dvipdfmhlstart
: Explicit hyperlinkshltype
: Setting group typeshltype
: Setting default types and optionshmorphposn
: Commutative diagram parametershmorphposn
: Arrows and morphismshmorphposndn
: Commutative diagram parametershmorphposndn
: Arrows and morphismshmorphposnlft
: Commutative diagram parametershmorphposnlft
: Arrows and morphismshmorphposnrt
: Commutative diagram parametershmorphposnrt
: Arrows and morphismshmorphposnup
: Commutative diagram parametershmorphposnup
: Arrows and morphismshoffset
: Proofing index termshookaction
: Hookshookactiononce
: Hookshookappend
: Hookshookprepend
: Hookshookrun
: Hookshruledefaultdepth
: Ruleshruledefaultheight
: Ruleshsize
: Marginshyphenpenalty
for index entries: Typesetting an indexidentity
: Macro argumentsidx
: Indexing commandsidx
(hyperlinks): Index hyperlinksidxbeginrangemark
: Customizing indexingidxencapoperator
: Customizing indexingidxendrangemark
: Customizing indexingidxexact
: Choosing destination placementidxmarked
: Indexing commandsidxmarked
(hyperlinks): Index hyperlinksidxname
: Indexing commandsidxname
(hyperlinks): Index hyperlinksidxnameseparator
: Indexing commandsidxnone
: Choosing destination placementidxpage
: Choosing destination placementidxpagei
: Page list and page range parsersidxpageii
: Page list and page range parsersidxpagelistdelimiter
: Page list and page range parsersidxpagenum
: Customizing indexingidxpagerangedelimiter
: Page list and page range parsersidxparselist
: Page list and page range parsersidxparserange
: Page list and page range parsersidxrangebeginword
: Customizing indexingidxrangeendword
: Customizing indexingidxseealsocmdword
: Customizing indexingidxseecmdword
: Customizing indexingidxsubentryseparator
: Customizing indexingidxsubmarked
: Indexing commandsidxsubmarked
(hyperlinks): Index hyperlinksidxuniq
: Exact destinations for index termsiffileexists
: Auxiliary filesifpdf
: Introduction to hyperlinksifpdf
: Checking for PDF outputifrewritetocfile
: Contentsifundefined
: \ifundefinedindexfilebasename
: Typesetting an indexindexfonts
: Typesetting an indexindexitem
hook: Typesetting an indexindexprooffont
: Proofing index termsindexproofterm
: Proofing index termsindexproofunbox
: Proofing index termsindexsee
: Hyperlinks in see and see also entriesindexsee
: Customizing indexingindexseealso
: Hyperlinks in see and see also entriesindexseealso
: Customizing indexingindexseealsowords
: Customizing indexingindexseeword
: Customizing indexingindexsetmargins
: Proofing index termsindexspace
: Typesetting an indexinnerdef
: Allocation macrosinnerinnerdef
: Allocation macrosinnernewbox
: Allocation macrosinnernewcount
: Allocation macrosinnernewdimen
: Allocation macrosinnernewfam
: Allocation macrosinnernewhelp
: Allocation macrosinnernewif
: Allocation macrosinnernewinsert
: Allocation macrosinnernewlanguage
: Allocation macrosinnernewread
: Allocation macrosinnernewskip
: Allocation macrosinnernewtoks
: Allocation macrosinnernewwrite
: Allocation macrosinsidemargin
: Proofing index termsinterfootnoteskip
: Footnotesinteritemskip
: Formatting listsinteritemskipamount
: Formatting listsitem
in indexes: Typesetting an indexitemletter
: Formatting listsitemnumber
: Formatting listsituline
: Page list and page range parsersjobname
: Auxiliary filesjobname
: Typesetting an indexjobname
: CitationsLAMSTeX
: LogosLaTeX
: Logoslbracechar
: Category codesleft
(destination option): Destination options for pdftex and dvipdfmleft
(destination option): Destination types for pdftex and dvipdfmleftdisplayindent
: Displaysleftdisplays
: Displaysleftdisplaysetup
: Formatting displaysleftmargin
: Marginsleqalignno
: Displaysletreturn
: Category codesletter
: Category codeslft
: Arrows and morphismsli
: Listsli
(hyperlinks): List hyperlinkslinenumberedlisting
: Verbatim listinglistcompact
: Listslisting
: Verbatim listinglistingfont
: Verbatim listinglistleftindent
: Formatting listslistmarkerspace
: Formatting listslistrightindent
: Formatting listsloggingall
: Diagnosticsmakeactive
: Category codesmakeatletter
: Category codesmakeatother
: Category codesmakeblankbox
: Boxesmakecolumns
: Tablesmakeheadline
: Proofing index termsmakeindex
: Index hyperlinksmakeindex
: Indexingmakeindex
: Invoking Eplainmapdown
: Arrows and morphismsmapleft
: Arrows and morphismsmapright
: Arrows and morphismsmapup
: Arrows and morphismsmatrix
: Construction of commutative diagramsMF
: Logosminiltx.tex
: Loading LaTeX packagesmonthname
: Time of daymorphdist
: Commutative diagram parametersmorphdist
: Arrows and morphismsname
(hyperlink type): Link types for pdftex and dvipdfmnew...
: Allocation macrosnewwin
(hyperlink option): Link options for pdftex and dvipdfmnewwin
(hyperlink option): Link types for pdftex and dvipdfmnoarrow
: Invoking Eplainnoauxfile
: Invoking Eplainnobibtex
: Invoking Eplainnocite
: Citationsnormalbaselineskip
: Options supported by all driversnum
(hyperlink type): Link types for pdftex and dvipdfmnumberedfootnote
: Footnotesnumberedfootnote
(hyperlinks): Footnote hyperlinksnumberedlist
: Listsnumberedlistdepth
: Formatting listsnumberedmarker
: Formatting listsnumbername
: Writing out numbersobeywhitespace
: Obeying spacesorderedlist
: Listsother
: Category codesouter
: Allocation macrosoutsidemargin
: Proofing index termspage
(hyperlink type): Link types for pdftex and dvipdfmpagefit
(hyperlink option): Link options for pdftex and dvipdfmpagefit
(hyperlink option): Link types for pdftex and dvipdfmpageno
: Proofing index termspagetotal
: Multiple columnspaperheight
: Marginspaperwidth
: Marginsparindent
in indexes: Typesetting an indexpath
: Pathspdfoutput
: Checking for PDF outputpdftex
: Introduction to hyperlinkspdftex
: Checking for PDF outputpdftex
: Invoking Eplainpercentchar
: Category codesphantomeqlabel
: Equation reference hyperlinksphantomeqnumber
: Equation reference hyperlinkspict2e.sty
: Packages known not to workpreviouseverydisplay
: Formatting displaysprintbetweencitations
: Formatting citationsprintcitefinish
: Formatting citationsprintcitenote
: Formatting citationsprintcitestart
: Formatting citationsprintitem
: Formatting listspsfrag.sty
: Packages known to workquadcolumns
: Multiple columnsraggedright
for index entries: Typesetting an indexraise
(hyperlink option): Setting group optionsraise
(hyperlink option): Options supported by all driversraw
(destination type): Destination types for pdftex and dvipdfmraw
(hyperlink type): Link types for pdftex and dvipdfmrbracechar
: Category codesreadindexfile
: Typesetting an indexreadindexfile
(hyperlinks): Index hyperlinksreadtocfile
: Contentsref
: Using generic referencesref
(hyperlinks): Cross-reference hyperlinksrefn
: Using generic referencesrefn
(hyperlinks): Cross-reference hyperlinksrefs
: Using generic referencesrefs
(hyperlinks): Cross-reference hyperlinksrefspace
: Page reference hyperlinksrefspace
: Cross-reference hyperlinksreftie
: Equation reference hyperlinksreftie
: Cross-reference hyperlinksresetatcatcode
: Category codesrewritetocfile
(conditional): Contentsright
(destination option): Destination options for pdftex and dvipdfmright
(destination option): Destination types for pdftex and dvipdfmrightmargin
: Marginsrt
: Arrows and morphismssanitize
: Converting to characterssarrowlength
: Commutative diagram parameterssarrowlength
: Arrows and morphismssed
: Customizing indexingsee
for index entries: Customizing indexingsee
for index entries: Modifying index entriesseealso
for index entries: Modifying index entriesseevariant
: Customizing indexingsetidxpagelistdelimiter
: Page list and page range parserssetidxpagerangedelimiter
: Page list and page range parserssetproperty
: Propertiessetuplistinghook
: Verbatim listingsidx
: Indexing commandssidxmarked
: Indexing commandssidxname
: Indexing commandssidxsubmarked
: Indexing commandssinglecolumn
: Multiple columnssline
: Arrows and morphismsSLiTeX
: Logosspecial
: Introduction to hyperlinksspecialpathdelimiters
(conditional): Pathssubeqnumber
: Subequation referencessubitem
in indexes: Typesetting an indexsubsubitem
in indexes: Typesetting an indextestfileexistence
: Auxiliary filesTeX
: Logostexi2dvi
: Indexingtexi2dvi
: Citationstexi2dvi
: Invoking Eplaintimestamp
: Time of daytimestring
: Time of daytoc...entry
: Contentstocfilebasename
: Contentstoday
: Time of daytop
(destination option): Destination options for pdftex and dvipdfmtop
(destination option): Destination types for pdftex and dvipdfmtopmargin
: Marginstracingall
: Diagnosticstracingboxes
: Diagnosticstracingoff
: Diagnosticstrimsee
: Customizing indexingtriplecolumns
: Multiple columnsuncatcodespecials
: Category codesunorderedlist
: Listsunorderedlistdepth
: Formatting listsunorderedmarker
: Formatting listsurl
(hyperlink type): Link types for pdftex and dvipdfmurl
(hyperlinks): URL hyperlinksurl.sty
: URL hyperlinksurl.sty
: Packages known to workusepackage
: The \usepackage commandvarrowlength
: Commutative diagram parametersvarrowlength
: Arrows and morphismsvchannel
: Commutative diagram parametersverbatim
: Verbatim listingverbatimescapechar
: Verbatim listingvgrid
: Commutative diagram parametersvgrid
: Construction of commutative diagramsvline
: Arrows and morphismsvmorphposn
: Commutative diagram parametersvmorphposn
: Arrows and morphismsvmorphposndn
: Commutative diagram parametersvmorphposndn
: Arrows and morphismsvmorphposnlft
: Commutative diagram parametersvmorphposnlft
: Arrows and morphismsvmorphposnrt
: Commutative diagram parametersvmorphposnrt
: Arrows and morphismsvmorphposnup
: Commutative diagram parametersvmorphposnup
: Arrows and morphismsvpenalty
: Mode-specific penaltiesvruledefaultwidth
: Ruleswidth
(destination option): Destination options for pdftex and dvipdfmwidth
(destination option): Destination types for pdftex and dvipdfmwidth
(hyperlink option): Link options for pdftex and dvipdfmwritenumberedtocentry
: Contentswritetocentry
: Contentsxcolor.sty
: Packages known not to workxeplain.tex
: Introductionxrdef
: Page referencesxrdef
(hyperlinks): Page reference hyperlinksxref
: Page referencesxref
(hyperlinks): Page reference hyperlinksxrefn
: Using generic referencesxrefn
(hyperlinks): Cross-reference hyperlinksxrefpageword
: Page reference hyperlinksxrefpageword
: Page referencesxrefwarning
conditional: Using generic referencesxrefwarningfalse
: Citationsxrlabel
: Converting to charactersxyz
(destination type): Destination types for pdftex and dvipdfmzoom
(destination option): Destination options for pdftex and dvipdfmzoom
(destination option): Destination types for pdftex and dvipdfm\singlecolumn
: Multiple columns\singlecolumn
: Multiple columnsdvipdfm
: Destination options for pdftex and dvipdfmpdftex
: Destination options for pdftex and dvipdfmdvipdfm
: Destination types for pdftex and dvipdfmpdftex
: Destination types for pdftex and dvipdfmdvipdfm
: Hyperlink drivers pdftex and dvipdfmnolinks
: Hyperlink driver nolinkspdftex
: Hyperlink drivers pdftex and dvipdfmdvipdfm
, destination options: Destination options for pdftex and dvipdfmdvipdfm
, destination types: Destination types for pdftex and dvipdfmdvipdfm
, hyperlink driver: Hyperlink drivers pdftex and dvipdfmdvipdfm
, link options: Link options for pdftex and dvipdfmdvipdfm
, link types: Link types for pdftex and dvipdfmdvipdfm
: Hyperlink drivers pdftex and dvipdfmnolinks
: Hyperlink driver nolinkspdftex
: Hyperlink drivers pdftex and dvipdfmdvipdfm
: Link options for pdftex and dvipdfmpdftex
: Link options for pdftex and dvipdfmdvipdfm
: Link types for pdftex and dvipdfmpdftex
: Link types for pdftex and dvipdfmnolinks
, hyperlink driver: Hyperlink driver nolinksdvipdfm
: Destination options for pdftex and dvipdfmpdftex
: Destination options for pdftex and dvipdfmdvipdfm
: Link options for pdftex and dvipdfmpdftex
: Link options for pdftex and dvipdfmpdftex
, destination options: Destination options for pdftex and dvipdfmpdftex
, destination types: Destination types for pdftex and dvipdfmpdftex
, hyperlink driver: Hyperlink drivers pdftex and dvipdfmpdftex
, link options: Link options for pdftex and dvipdfmpdftex
, link types: Link types for pdftex and dvipdfmdvipdfm
: Destination types for pdftex and dvipdfmpdftex
: Destination types for pdftex and dvipdfmdvipdfm
: Link types for pdftex and dvipdfmpdftex
: Link types for pdftex and dvipdfm