From 31e66aefb450e51367451a84ab01d0a92510cda2 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Wed, 17 Apr 2024 19:39:35 +0000 Subject: eplain (17apr24) git-svn-id: svn://tug.org/texlive/trunk@70971 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/eplain/ChangeLog | 29 + Master/texmf-dist/doc/eplain/NEWS | 5 +- Master/texmf-dist/doc/eplain/eplain.html | 10748 ++++++++++--------- Master/texmf-dist/doc/eplain/eplain.pdf | Bin 775348 -> 726401 bytes Master/texmf-dist/doc/info/eplain.info | 3219 +++--- Master/texmf-dist/doc/man/man1/eplain.1 | 2 +- Master/texmf-dist/doc/man/man1/eplain.man1.pdf | Bin 18523 -> 18710 bytes .../source/eplain/eplain-source-3.13.zip | Bin 258094 -> 0 bytes .../source/eplain/eplain-source-3.14.zip | Bin 0 -> 259129 bytes Master/texmf-dist/source/eplain/xeplain.tex | 22 +- Master/texmf-dist/tex/eplain/eplain.tex | 11 +- 11 files changed, 7048 insertions(+), 6988 deletions(-) delete mode 100644 Master/texmf-dist/source/eplain/eplain-source-3.13.zip create mode 100644 Master/texmf-dist/source/eplain/eplain-source-3.14.zip (limited to 'Master') diff --git a/Master/texmf-dist/doc/eplain/ChangeLog b/Master/texmf-dist/doc/eplain/ChangeLog index b96c04fd0a3..40f910cb5ff 100644 --- a/Master/texmf-dist/doc/eplain/ChangeLog +++ b/Master/texmf-dist/doc/eplain/ChangeLog @@ -1,3 +1,32 @@ +2022-10-16 Karl Berry + + * NEWS, + * Makefile (version), + * doc/eplain.texi, + * doc/eplain.1: 3.14. + + * xeplain.tex (\readcontentsfile): \immediate\closeout + the tocfile before reading it, in case the document mixes + reading and writing. + * doc/userdef.texi (Reading the .toc file): mention reading the + toc after writing all entries. + * test/tocwriteread.tex: test file from Andy Bradford. + + * PROJECTS: lists of figures etc. are supported. + + * doc/Makefile (eplain.html): do not build split html; we don't + distribute or use it. + +2023-10-30 Karl Berry + + * PROJECTS: tweak release commands. + * doc/userdef.texi: mention that using apalike.bst requires + \input apalike.tex. Report from Terry S, + https://tug.org/pipermail/tex-eplain/2023/001096.html. + + * xeplain.tex: avoid premature end of input if iftex.sty + has already been read. + 2022-10-16 Karl Berry * NEWS, diff --git a/Master/texmf-dist/doc/eplain/NEWS b/Master/texmf-dist/doc/eplain/NEWS index b9277cd72ff..1e323ebdc8f 100644 --- a/Master/texmf-dist/doc/eplain/NEWS +++ b/Master/texmf-dist/doc/eplain/NEWS @@ -1,6 +1,9 @@ -$Id: NEWS 63 2022-10-16 16:56:05Z karl $ +$Id: NEWS 66 2024-04-17 16:38:05Z karl $ This file records noteworthy changes. This file is public domain. + 3.14 (17 April 2024) +* Allow writing and then reading toc files. + 3.13 (16 October 2022) * Fix dumb bug in 3.12 making toc processing fail (\@gobbleminus definition was lost). diff --git a/Master/texmf-dist/doc/eplain/eplain.html b/Master/texmf-dist/doc/eplain/eplain.html index ea8b83ce357..0d43b2ce821 100644 --- a/Master/texmf-dist/doc/eplain/eplain.html +++ b/Master/texmf-dist/doc/eplain/eplain.html @@ -1,10 +1,10 @@ - + - + - @@ -53,7 +53,6 @@ ul.no-bullet {list-style: none} -

Eplain: Expanded Plain TeX

@@ -63,15 +62,15 @@ ul.no-bullet {list-style: none} -
-
+
+ -

Eplain

+

Eplain

-

This manual documents the Eplain macros, version 3.13, -October 2022. Eplain provides functionality for plain TeX that +

This manual documents the Eplain macros, version 3.14, +April 2024. Eplain provides functionality for plain TeX that is intended to be useful regardless of how your document is actually formatted.

@@ -83,61 +82,79 @@ Lewenberg has made additions and corrections. Oleg Katsitadze wrote the section on LaTeX packages and the chapter on hyperlinks, and updates throughout.

-

The Eplain home page is https://tug.org/eplain. +

The Eplain home page is https://tug.org/eplain.

-
+ +

Table of Contents

-
-
-
-
+
+ -

1 Introduction

+

1 Introduction

- + - -

The Eplain macro package expands on and extends the definitions in -plain TeX. Its home on the web is https://tug.org/eplain. + +

The Eplain macro package expands on and extends the definitions in +plain TeX. Its home on the web is https://tug.org/eplain.

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) +implementation; see comments in the source code (xeplain.tex) for that.

Eplain is not intended to provide typesetting capabilities, as does LaTeX (originally written by Leslie Lamport) - - + + and Texinfo - + (originally written by Richard Stallman). - - + + 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 to format +

For example, Eplain does not have a command \section to format section headings in an “appropriate” way, such as LaTeX’s -\section. The philosophy of Eplain is that some people will +\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 @@ -331,7 +330,7 @@ put in extra work to override the defaults.

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. @@ -340,7 +339,7 @@ such capabilities. 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 +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. @@ -350,264 +349,264 @@ 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, +. 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 subscribe to this mailing list (anyone can subscribe, and archives -are public), visit https://lists.tug.org/tex-eplain. +are public), visit https://lists.tug.org/tex-eplain.

- +

David Walden reported his experience with Eplain as a new user. The article is available online at -https://tug.org/pracjourn/2005-4/walden. An introductory +https://tug.org/pracjourn/2005-4/walden. An introductory article (written for - -TUGboat) is also available online at -https://tug.org/eplain/misc/tb84katsi.pdf. + +TUGboat) is also available online at +https://tug.org/eplain/misc/tb84katsi.pdf.

Finally, here are two alternatives to Eplain:

-
    +
    1. If you just want to load the LaTeX color or graphics package, -the LaTeX team’s miniltx.tex suffices: +the LaTeX team’s miniltx.tex suffices:
      -
      \input miniltx.tex
      +
      \input miniltx.tex
       \input graphicx.tex
       
      -
    2. +
    3. If you’re interested in a fully-fledged format that shares much of Eplain’s (and plain.tex’s) philosophy, check out OpTeX: -https://ctan.org/pkg/optex. +https://ctan.org/pkg/optex.

-
-
+
+ -

2 Installation

+

2 Installation

- - - - + + + +

Your TeX installation should already contain a version of Eplain -(eplain.tex) in its main texmf tree; with TeX Live, -it’s in .../texmf-dist/tex/eplain/eplain.tex. +(eplain.tex) in its main texmf tree; with TeX Live, +it’s in .../texmf-dist/tex/eplain/eplain.tex.

Generally, you can just use that version and there is no need to do anything else. But if you want to use a newer version of Eplain for a -given document, you can put the new eplain.tex in the +given document, you can put the new eplain.tex in the document’s directory, and it will be found.

- -

If you want to install a new eplain.tex in some other place, -set an environment variable (commonly, TEXINPUTS) to tell + +

If you want to install a new eplain.tex in some other place, +set an environment variable (commonly, TEXINPUTS) to tell TeX how to find it.

- - - -

Distributions should also create and maintain the eplain.fmt + + + +

Distributions should also create and maintain the eplain.fmt file file. But if you want to do it yourself, you can:

-
$ touch eplain.aux
+
$ touch eplain.aux
 $ initex
 This is TeX, ...
 **&plain eplain
 (eplain.tex)
 *\dump
-... messages ...
+... messages ...
 
- - -

You must make sure that eplain.aux exists -before you run initex; otherwise, warning messages about + + +

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 your local -texmf tree or set an environment variable (TEXFORMATS to + +

You then have to install the resulting eplain.fmt in your local +texmf tree or set an environment variable (TEXFORMATS to tell TeX how to find it. You’ll need to consult your distribution’s documentation about that.


-
-
+
+ -

3 Invoking Eplain

+

3 Invoking Eplain

- +

The simplest way to use Eplain is simply to put:

-
\input eplain
+
\input eplain
 

at the beginning of your (plain TeX) input file. The macro file is small enough that reading it does not take long.

-

However, if a format (.fmt) - +

However, if a format (.fmt) + file has been created for Eplain (see the previous section), you can eliminate even the time spent reading the macro source file. You do this -by responding &eplain to TeX’s ‘**’ prompt. For +by responding &eplain to TeX’s ‘**’ prompt. For example:

-
$ tex
+
$ tex
 This is TeX, ...
 **&eplain myfile
 

In TeX Live and other distributions, a command-line executable -named eplain is provided which reads the eplain.fmt file +named eplain is provided which reads the eplain.fmt file automatically.

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 +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 +\eplain + +to be the letter t (a convention borrowed from Lisp; it doesn’t matter what the definition is, only that the definition exists). Therefore, you can do the following:

-
\ifx\eplain\undefined \input eplain \fi
+
\ifx\eplain\undefined \input eplain \fi
 
-

where \undefined must never acquire a definition. +

where \undefined must never acquire a definition.

Eplain consists of several source files: -

-
xeplain.tex
+

+
xeplain.tex

most of the macros;

-
arrow.tex
-

commutative diagram macros (see Arrow theoretic diagrams), written by +

arrow.tex
+

commutative diagram macros (see Arrow theoretic diagrams), written by Steven Smith;

-
btxmac.tex
-

bibliography-related macros (see Citations); +

btxmac.tex
+

bibliography-related macros (see Citations and bibliographies);

-
iftex.sty
-

sets the switch \ifpdf (among other things), which can be used -to detect direct PDF output (see Checking for PDF output), +

iftex.sty
+

sets the switch \ifpdf (among other things), which can be used +to detect direct PDF output (see Checking for PDF output), originally written by Heiko Oberdiek;

-
path.sty
+
path.sty

macro for allowing line breaks at punctuation characters within long -pathnames, electronic mail addresses, etc., (see Paths), written +pathnames, electronic mail addresses, etc., (see Paths), written by Philip Taylor;

-
texnames.sty
-

abbreviations for various TeX-related names (see Logos), edited +

texnames.sty
+

abbreviations for various TeX-related names (see Logos), edited by Nelson Beebe.

-

The file eplain.tex is all of these files merged +

The file eplain.tex is all of these files merged together, with comments removed. The original sources can be found in Eplain source zip archive in your TeX distribution, on CTAN -or on Eplain’s home page at https://tug.org/eplain. +or on Eplain’s home page at https://tug.org/eplain.

-

All of these files except xeplain.tex can be input individually, +

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 - +control sequence \nobibtex + is defined, then the bibliography definitions are skipped. You must set -\nobibtex before eplain.tex is read, naturally. For +\nobibtex before eplain.tex is read, naturally. For example, you could start your input file like this:

-
\let\nobibtex = t
+
\let\nobibtex = t
 \input eplain
 
-

By default, \nobibtex is not defined, and so the -bibliography definitions are made. +

By default, \nobibtex is not defined, 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 + +

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 +

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. + + +

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 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 +

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. +\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 +.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 -https://www.gnu.org/software/texinfo) can automate this process: +texi2dvi from the Texinfo documentation system (see +https://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 +LATEX environment variable to ‘tex’. For example, in a Bourne-compatible shell, the following command will do all the work:

-
$ LATEX=tex texi2dvi file.tex
+
$ LATEX=tex texi2dvi file.tex
 
- -

Despite the name, texi2dvi can also produce -.pdf output (among other formats); set LATEX=pdftex for -this. See the output from texi2dvi --help for a full list + +

Despite the name, texi2dvi can also produce +.pdf output (among other formats); set LATEX=pdftex for +this. See the output from texi2dvi --help for a full list of options.


-
-
+
+ -

4 User definitions

+

4 User definitions

This chapter describes definitions that are meant to be used directly in a document. When appropriate, ways to change the default @@ -615,10 +614,10 @@ formatting are described in subsections.

-
    +
    -
    -
    +
    + -

    4.1 Diagnostics

    +

    4.1 Diagnostics

    - - -

    Plain TeX provides the \tracingall command, to turn on the + + +

    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 +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. - +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 +\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 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. +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%
    +
    \newhelp\envhelp{Perhaps you forgot to end the previous^^J%
        environment? I'm finishing off the current group,^^J%
        hoping that will fix it.}%
     
    @@ -698,55 +697,55 @@ Eplain defines it to be the character ^^J.
    -
    -
    +
    + -

    4.2 Rules

    +

    4.2 Rules

    The default dimensions of rules are defined in chapter 21 of the -The TeXbook. To sum up what is given there, the “thickness” +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 +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. - +\ehrule + +and \evrule. +


    -
    -
    +
    + -

    4.3 Citations

    +

    4.3 Citations and bibliographies

    - - + +

    Bibliographies are part of almost every technical document. To handle them conveniently, 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. @@ -754,94 +753,102 @@ 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. - - +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 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 - + +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 +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. +name for the .bbl file by defining the control sequence +\bblfilebasename. + +The default definition is simply \jobname.

    On the other hand, if your document’s bibliography is very simple, you -may prefer to create the .bbl file yourself, by hand, instead of +may prefer to create the .bbl file yourself, by hand, instead of using BibTeX. An annotated example of this approach is also given below.

    -

    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 +

    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 - +

    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 +(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 +(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, + +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: cite, bib). +bibliography entries (see Citation hyperlinks: cite, bib).

    -

    Another command, \nocite, - +

    Another command, \nocite, + puts the given reference(s) into the bibliography, but produces nothing in the text.

    -

    The \bibliography - +

    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, +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 +\bibliographystyle. +The argument to this is a single filename style, which tells +BibTeX to look for a file style.bst. +

    +

    Numerous styles have been defined by now; see +https://www.ctan.org/topic/bibtex-sty. One particular case: the +apalike semi-standard style requires \input apalike.tex +to function properly (else text is overwritten); other APA-like +(“humanities”) styles surely also require this or similar changes. +

    +

    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. +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.
    +
    \input eplain                    % Reads the .aux file.
     Two citations to Knuthian works:
       \cite[note]{surreal,concrete-math}.
     \beginsection{References.}\par   % Title for the bibliography.
    @@ -849,100 +856,100 @@ Two citations to Knuthian works:
     \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 above -\bibliography command says), the following commands do what’s -required. (‘$ ’ represents the shell prompt.) +

    If we suppose that this file was named citex.tex and that the +bibliography data is in knuth.bib (as the above +\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)
    +
    $ 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 texi2dvi program can help you automate this +process (see Invoking Eplain).

    -

    For simple documents you might choose to write the .bbl file +

    For simple documents you might choose to write the .bbl file yourself, instead of running BibTeX. For this scenario, the following commands should suffice:

    -
    $ tex citex     (read citex.bbl, produces undefined citation messages)
    -$ tex citex     (one more time, to resolve the references)
    +
    $ tex citex     (read citex.bbl, produces undefined citation messages)
    +$ tex citex     (one more time, to resolve the references)
     
    -

    The output looks something like (because we used the plain +

    The output looks something like (because we used the plain bibliography style):

    -
    +

    Two citations to Knuthian works: [2,1 note].

    -

    References +

    References

    -

    [1] Ronald L. Graham, Donald E. Knuth, and Oren Patashnik. Concrete +

    [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, +

    [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.) - - +of numbered, the bibliography style is alpha.) + +

    -
      +
      -
      -
      +
      + -

      4.3.1 Formatting citations

      +

      4.3.1 Formatting citations

      - +

      You may wish to change Eplain’s formatting of citations; i.e., the -result of your \cite commands. By default, the citation labels +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 accommodate such formats by redefining the following macros.

      -
      -
      \printcitestart
      -
      \printcitefinish
      -
      -

      Eplain expands these macros at the beginning and end of the list of -citations for each \cite command. By default, they produce a -‘[’ and ‘]’, respectively. +

      +
      +\printcitestart
      +
      \printcitefinish
      +

      Eplain expands these macros at the beginning and end of the list of +citations for each \cite command. By default, they produce a +‘[’ and ‘]’, respectively.

      -
      \printbetweencitations
      -

      If a \cite command has multiple citations, as in -\cite{acp,texbook}, Eplain expands this macro in between each +

      \printbetweencitations
      +

      If a \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
      +
      \printcitenote

      This macro takes one argument, which is the optional note to the -\cite command. If the \cite command had no note, this +\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.

      @@ -953,7 +960,7 @@ note is preceded with a comma and a space. superscripted labels, with the optional notes in parentheses.

      -
      \def\printcitestart{\unskip $^\bgroup}
      +
      \def\printcitestart{\unskip $^\bgroup}
       \def\printbetweencitations{,}
       \def\printcitefinish{\egroup$}
       \def\printcitenote#1{\hbox{\sevenrm\space (#1)}}
      @@ -962,74 +969,74 @@ superscripted labels, with the optional notes in parentheses.
       
       
      -
      -
      +
      + -

      4.3.2 Formatting bibliographies

      +

      4.3.2 Formatting bibliographies

      - +

      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
      -

      This control sequence represents a \dimen register, and its value +

      +
      \biblabelwidth
      +

      This control sequence represents a \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. +to use it if you redefine \biblabelprint, below.

      -
      \biblabelprint
      +
      \biblabelprint

      This macro takes one argument, the label to print. By default, the -label is put in a box of width \biblabelwidth, and is followed by +label is put in a box of width \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
      +
      \biblabelcontents

      This macro also takes one argument, the label to print. By default, the -label is printed using the font \bblrm (below), and enclosed in +label is printed using the font \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.

      -
      \biblabelprecontents
      -
      \biblabelpostcontents
      -
      -

      Macros expanded before and after \biblabelcontents, +

      +\biblabelprecontents
      +
      \biblabelpostcontents
      +

      Macros expanded before and after \biblabelcontents, respectively. For example, to get left-justified numeric labels (they are right-justified by default):

      -
      \def\biblabelprecontents{\relax}
      +
      \def\biblabelprecontents{\relax}
       \def\biblabelpostcontents{\hss}
       
      -
      \bblrm
      -
      -

      The default font used for printing the bibliography. +

      +\bblrm
      +

      The default font used for printing the bibliography.

      -
      \bblem
      +
      \bblem

      The font used for printing the titles and other “emphasized” material.

      -
      \bblemph
      -
      -

      Typesets its argument using \bblem, then inserts an italic correction. +

      +\bblemph
      +

      Typesets its argument using \bblem, then inserts an italic correction.

      -
      \bblsc
      +
      \bblsc

      In some styles, authors’ names are printed in a caps-and-small-caps font. In those cases, this font is used.

      -
      \bblnewblock
      +
      \bblnewblock

      This is invoked between each of the parts of a bibliography entry. The default is to leave some extra space between the parts; you could redefine it to start each part on a new line (for example). A part is @@ -1038,76 +1045,76 @@ simply a main element of the entry; for example, the author is a part. concerned) term ‘block’ for this.)

      -
      \biblabelextraspace
      +
      \biblabelextraspace

      Bibliography entries are typeset with a hanging indentation of -\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. +\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
      -
      -

      This is expanded before reading the .bbl file. By +

      +\bblhook
      +

      This is expanded before reading the .bbl file. By default, it does nothing. You could, for example, define it to set the bibliography fonts, or produce the heading for the references. Two -spacing parameters must be changed inside \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.) +spacing parameters must be changed inside \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 desperate, of course you can also hand-edit the .bbl +

      If you are desperate, of course you can also hand-edit the .bbl file that BibTeX produces to do anything you wish.


      -
      -
      +
      + -

      4.3.3 Commands from LaTeX

      +

      4.3.3 Commands from LaTeX

      - +

      Because of the historical connection between BibTeX and LaTeX, in practice many bibliography styles and bibliographies use LaTeX commmands that are not part of bibliography handling, per se.

      -

      To support this, btxmac.tex (and thus Eplain) define the +

      To support this, btxmac.tex (and thus Eplain) define the following. In all cases, an existing definition (e.g., from -miniltx.tex, see Loading LaTeX +miniltx.tex, see Loading LaTeX packages) will not be overwritten. Here is the list:

      -
      -
      \newcommand
      -
      \renewcommand
      -
      \providecommand
      -
      - - -

      Defining new commands in various ways. The Eplain versions do not -support the *-form of these; use miniltx for that. +

      +
      + + +\newcommand
      +
      \renewcommand
      +
      \providecommand
      +

      Defining new commands in various ways. The Eplain versions do not +support the *-form of these; use miniltx for that.

      -
      \em
      -
      \emph
      -
      \sc
      -
      \textbf
      -
      - - -

      Selecting fonts. +

      + + +\em
      +
      \emph
      +
      \sc
      +
      \textbf
      +

      Selecting fonts.

      -
      \mbox
      +
      \mbox

      A horizontal box.

      -
      \newblock
      +
      \newblock

      Starts elements of a bibliography entry.

      @@ -1118,163 +1125,163 @@ support the *-form of these; use miniltx for that.
      -
      -
      +
      + -

      4.4 Displays

      +

      4.4 Displays

      - - - - - + + + + +

      By default, TeX centers displayed material. (Displayed material is -just whatever you put between $$’s—it’s not necessarily +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. - +\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 +

      \leftdisplays also changes the plain TeX commands that deal with alignments inside math displays, -\displaylines, - -\eqalignno, - -and \leqalignno, - +\displaylines, + +\eqalignno, + +and \leqalignno, + to produce left-justified text. You can still override this formatting -by inserting \hfill glue, as explained in The TeXbook. -

      - - - - - - - - -

      Eplain defines \eqnum and \eqalignnum which can be set +by inserting \hfill glue, as explained in The TeXbook. +

      + + + + + + + + +

      Eplain defines \eqnum and \eqalignnum which can be set up to produce either left-aligned or right-aligned equation numbers. -\lefteqnumbers (\righteqnumbers) will define -\eqnum to expand to \eqno (\leqno), and -\eqalignnum to expand to \eqalignno -(\leqalignno). Default is \righteqnumbers +\lefteqnumbers (\righteqnumbers) will define +\eqnum to expand to \eqno (\leqno), and +\eqalignnum to expand to \eqalignno +(\leqalignno). Default is \righteqnumbers (right-aligned equation numbers).

      -
        +
        -
        -
        +
        + -

        4.4.1 Formatting displays

        +

        4.4.1 Formatting displays

        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 - +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). +in TeX’s \everydisplay parameter).

        -

        \leftdisplays expands the old value of \everydisplay -before calling \leftdisplaysetup, so that any changes you have made +

        \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. - +the token register \previouseverydisplay. +


        -
        -
        +
        + -

        4.5 Time of day

        +

        4.5 Time of day

        - - + +

        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 - +

        \monthname + produces the name of the current month, abbreviated to three letters.

        -

        \fullmonthname - +

        \fullmonthname + produces the name of the current month, unabbreviated (in English).

        -

        \timestring - +

        \timestring + produces the current time, as in ‘1:14 p.m.’

        -

        \timestamp - +

        \timestamp + produces the current date and time, as in ‘23 Apr 64 1:14 p.m.’. (Except the spacing is slightly different.)

        -

        \today - +

        \today + produces the current date, as in ‘23 April 1964’.


        -
        -
        +
        + -

        4.6 Lists

        +

        4.6 Lists

        - - - - + + + +

        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, +\item, but that is insufficient in many cases. Therefore, Eplain provides two pairs of commands:

        -
        -
        \numberedlist … \endnumberedlist
        -
        \orderedlist … \endorderedlist
        -
        - - -

        These commands (they are synonyms) produce a list with the items -numbered sequentially, starting from one. A nested \numberedlist +

        +
        + + +\numberedlist … \endnumberedlist
        +
        \orderedlist … \endorderedlist
        +

        These commands (they are synonyms) produce a list with the items +numbered sequentially, starting from one. A nested \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 ‘*’. +nested \numberedlist labels the items with roman numerals. Yet +more deeply nested numbered lists label items with ‘*’.

        -
        \unorderedlist … \endunorderedlist
        -
        -

        This produces a list with the items labelled with small black boxes -(“square bullets”). A nested \unorderedlist labels items with +

        +\unorderedlist … \endunorderedlist
        +

        This produces a list with the items labelled with small black boxes +(“square bullets”). A nested \unorderedlist labels items with em-dashes. Doubly (and deeper) nested unordered lists label items with ‘*’s.

        @@ -1283,30 +1290,30 @@ em-dashes. Doubly (and deeper) nested unordered lists label items with

        The two kinds of lists can be nested within each other, as well.

        -

        In both kinds of lists, you begin an item with \li. - +

        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. +

        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. +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: li). +\xrefn pointing to the relevant list item (see List hyperlinks: li).

        -

        You can also say \listcompact - -right after \numberedlist or \unorderedlist. The items in +

        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 +(see Formatting lists). You might want to do this if the items in this particular list are short.

        Here is an example:

        -
        \numberedlist\listcompact
        +
        \numberedlist\listcompact
         \li The first item.
         \li The second item.
         
        @@ -1316,328 +1323,328 @@ The second paragraph of the second item.
         
         
         
        -
          +
          -
          -
          +
          + -

          4.6.1 Formatting lists

          +

          4.6.1 Formatting lists

          - +

          Several registers define the spacing associated with lists. It is likely that their default values won’t suit your particular layout.

          -
          -
          \abovelistskipamount, \belowlistskipamount
          -
          -

          The vertical glue inserted before and after every list, respectively. +

          +
          +\abovelistskipamount, \belowlistskipamount
          +

          The vertical glue inserted before and after every list, respectively.

          -
          \interitemskipamount
          +
          \interitemskipamount

          The vertical glue inserted before each item except the first. -\listcompact resets this to zero, as mentioned above. +\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 +

          +\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 +(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 - +penalties: \abovelistskip + +does \vpenalty\abovelistpenalty + +and then \vskip\abovelistskip. \belowlistskip + +and \interitemskip + are analogous.

          -

          In addition, the macro \listmarkerspace - +

          In addition, the macro \listmarkerspace + is called to separate the item label from the item text. This is set to -\enspace by default. +\enspace by default.

          If you want to change the labels on the items, you can redefine these macros: -\numberedmarker - -or \unorderedmarker. - +\numberedmarker + +or \unorderedmarker. + The following registers might be useful if you do:

          -
          -
          \numberedlistdepth, \unorderedlistdepth
          -
          -

          These keep track of the depth of nesting of the two kinds of lists. +

          +
          +\numberedlistdepth, \unorderedlistdepth
          +

          These keep track of the depth of nesting of the two kinds of lists.

          -
          \itemnumber, \itemletter
          -
          -

          These keep track of the number of items that have been seen in the current +

          +\itemnumber, \itemletter
          +

          These keep track of the number of items that have been seen in the current numbered list. They are both integer registers. The difference is that -\itemnumber starts at one, and \itemletter starts at 97, +\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 - +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 - +item; and \endlist + is invoked to end both kinds of lists. - - + +


          -
          -
          +
          + -

          4.7 Verbatim listing

          +

          4.7 Verbatim listing

          - - - + + +

          It is sometimes useful to include a file verbatim in your document; -for example, part of a computer program. The \listing - +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. +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. - +\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 +\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 - +\printlistinglineno + to change how they are printed.

          -

          Normally, the \listing command will add a final empty line at +

          Normally, the \listing command will add a final empty line at the end of the output, even if the file does not end in a newline. To suppress this final line, you can say -\let\setuplistinghook = \nolastlinelisting. - +\let\setuplistinghook = \nolastlinelisting. + This also works with line numbers (say -\def\setuplistinghook{\linenumberedlisting \nolastlinelisting}), -but only if \printlistinglineno - +\def\setuplistinghook{\linenumberedlisting \nolastlinelisting}), +but only if \printlistinglineno + consists exclusively of boxes at the top level (i.e., any -\kerns or glue should be wrapped up in a box). +\kerns or glue should be wrapped up in a box).

          - - + +

          You can use the form feed control character (ASCII code 12, typed -as CTRL-L) in the file to force a page break in the output. +as CTRL-L) in the file to force a page break in the output.

          -

          You can produce in-line verbatim text in your document with \verbatim. - -End the text with |endverbatim. If you need a ‘|’ in the text, +

          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 +| . (| will work elsewhere in the argument, too, but isn’t necessary.)

          For example:

          -
          \verbatim| ||\#%&!|endverbatim
          +
          \verbatim| ||\#%&!|endverbatim
           
          -

          produces |\#%&!. +

          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 ‘@’. + + +

          You can change the verbatim escape character from the default ‘|’ +with \verbatimescapechar char; for example, this changes +it to ‘@’.

          -
          \verbatimescapechar \@
          +
          \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. +\verbatimescapechar is used as \catcode `char, so +the exact rules follow that for \catcode.

          - - - - + + + +

          To reset the category code of all special characters to 12 -(“other”), \verbatim uses \uncatcodespecials -(see Category codes). If you make additional characters -“special”, you should extend \dospecials to include those +(“other”), \verbatim uses \uncatcodespecials +(see Category codes). If you make additional characters +“special”, you should extend \dospecials to include those characters, lest they be given special treatment inside verbatim environments. For example,

          -
          \catcode`\A=\active
          +
          \catcode`\A=\active
           % Try commenting out the following line.
           \expandafter\def\expandafter\dospecials\expandafter{\dospecials\do\A}
           \verbatimA#$%_^|endverbatim
           
          -

          Because \verbatim must change the category code of special +

          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!
          +
          \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). +making the macro definition. Perhaps \uncatcodespecials will +help you (see Category codes).


          -
          -
          +
          + -

          4.8 Contents

          +

          4.8 Contents

          - - + +

          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 - +Eplain uses an auxiliary file with extension .toc + (and the same root name as your document) to save the information.

          -
            -
          • Writing the .toc file
          • -
          • Reading the .toc file
          • -
          • Changing the .toc file’s root name
          • +
            -
            -
            +
            + -

            4.8.1 Writing the .toc file

            +

            4.8.1 Writing the .toc file

            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 \tocpartentry{text}{page number} -(unless part is an integer, see below). The text is +\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 \tocpartentry{text}{page number} +(unless part is an integer, see below). The text is written unexpanded.

            - -

            A related command, \writenumberedtocentry, takes one additional + +

            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 +\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 +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. +call \writenumberedtocentry.

            For example:

            -
            \writenumberedtocentry{chapter}{A $\sin$ wave}{\the\chapno}
            +
            \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: +

            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}
            +
            \tocchapterentry{A $\sin$ wave}{3}{8}
             \tocsectionentry{A section title}{9}
             
            - -

            A variation on \writenumberedtocentry is -\writenumberedtocline, differing only in the order of the -parameters it takes and writes for the \tocpartentry + +

            A variation on \writenumberedtocentry is +\writenumberedtocline, differing only in the order of the +parameters it takes and writes for the \tocpartentry control sequences. To continue the previous example:

            -
            \writenumberedtocline{chapter}{\the\chapno}{A $\sin$ wave}
            +
            \writenumberedtocline{chapter}{\the\chapno}{A $\sin$ wave}
             
            -

            writes the following to the .toc file: +

            writes the following to the .toc file:

            -
            \tocchapterentry{3}{A $\sin$ wave}{8}
            +
            \tocchapterentry{3}{A $\sin$ wave}{8}
             

            Such ordering of the parameters allows the -\tocpartentry macros to typeset the text of the entry +\tocpartentry macros to typeset the text of the entry without actually reading it as an argument. This is required for entries which need to change character catcodes, e.g., to produce - - - - -verbatim text (see Verbatim listing). -

            -

            Each of \writetocentry, \writenumberedtocentry and -\writenumberedtocline processes a numeric part argument -specially. If you pass part expanding to an integer, these -macros write into the .toc file an entry that starts with - -\tocentry{part}. Thus, you can define a single -\tocentry macro which formats all entries for a table of + + + + +verbatim text (see Verbatim listing). +

            +

            Each of \writetocentry, \writenumberedtocentry and +\writenumberedtocline processes a numeric part argument +specially. If you pass part expanding to an integer, these +macros write into the .toc file an entry that starts with + +\tocentry{part}. Thus, you can define a single +\tocentry macro which formats all entries for a table of contents. To continue the previous examples:

            -
            \writenumberedtocentry{1}{A $\sin$ wave}{\the\chapno}
            +
            \writenumberedtocentry{1}{A $\sin$ wave}{\the\chapno}
             \writenumberedtocline{1}{\the\chapno}{A $\sin$ wave}
             \writetocentry{2}{A section title}
             
            @@ -1645,7 +1652,7 @@ contents. To continue the previous examples:

            writes the following to the .toc file:

            -
            \tocentry{1}{A $\sin$ wave}{3}{8}
            +
            \tocentry{1}{A $\sin$ wave}{3}{8}
             \tocentry{1}{3}{A $\sin$ wave}{8}
             \tocentry{2}{A section title}{9}
             
            @@ -1653,93 +1660,97 @@ contents. To continue the previous examples:
            -
            -
            +
            + -

            4.8.2 Reading the .toc file

            +

            4.8.2 Reading the .toc file

            - -

            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 + +

            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, \writenumberedtocentry and -\writenumberedtocline 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, +

            Each of \writetocentry, \writenumberedtocentry and +\writenumberedtocline 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, or after the last call. You +can’t arbitrarily mix reading and writing. +

            + + +

            \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).) + +and normal table of contents. (To produce this particular case, +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 +

            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. - - +manuscript, you can set \rewritetocfilefalse. + +


            -
            -
            +
            + -

            4.8.3 Changing the .toc file’s root name

            +

            4.8.3 Changing the .toc file’s root name

            -

            By default, the .toc file has the root \jobname. If your +

            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. - +\tocfilebasename. +

            - - -

            Note that \writetocentry, \writenumberedtocentry and -\writenumberedtocline will + + +

            Note that \writetocentry, \writenumberedtocentry and +\writenumberedtocline will open the contents file for writing only at the first call, using the -value of \tocfilebasename at that time. Changing the value of -\tocfilebasename afterwards will not affect which file gets -written, although it will affect which file gets read by -\readcontentsfile. In case you need to write several contents -files from a single TeX job, use \definecontentsfile -(see Alternative contents files). +value of \tocfilebasename at that time. Changing the value of +\tocfilebasename afterwards will not affect which file gets +written, although it will affect which file gets read by +\readcontentsfile. In case you need to write several contents +files from a single TeX job, use \definecontentsfile +(see Alternative contents files).


            -
            -
            +
            + -

            4.8.4 Alternative contents files

            +

            4.8.4 Alternative contents files

            - - - + + +

            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 +this with \definecontentsfile{abbrev}. All of the above commands are actually a special case that Eplain predefines with

            -
            \definecontentsfile{toc}
            +
            \definecontentsfile{toc}
             
            -

            The abbrev is used both for the file extension and in +

            The abbrev is used both for the file extension and in the control sequence names.

            @@ -1747,141 +1758,136 @@ the control sequence names.
            -
            -
            +
            + -

            4.9 Cross-references

            +

            4.9 Cross-references

            - +

            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 - +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 +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. See Citations and bibliographies.

            - +

            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. +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. +and list items. See Citations and bibliographies, and Lists.

            Eplain can create hypertext links for the cross-references -(see Cross-reference hyperlinks: definexref, ref). +(see Cross-reference hyperlinks: definexref, ref).

            -
              +
              -
              -
              +
              + -

              4.9.1 Defining generic references

              +

              4.9.1 Defining generic references

              - - - + + + - -

              Eplain provides the command \definexref for general + +

              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}
              +
              \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 +

              \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 +

              The class argument is used by the \ref and \refs commands. See the next section.


              -
              -
              +
              + -

              4.9.2 Using generic references

              +

              4.9.2 Using generic references

              - - - + + + -

              To retrieve the value of the label defined via \definexref (see +

              To retrieve the value of the label defined via \definexref (see the previous section), Eplain provides the following macros:

              -
              -
              - +
              +
              \refn{label}
              +
              -
              \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.) - +

              \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}
              -

              Given the class c for label (see the description of -\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.) +

              \ref{label}
              +

              Given the class c for label (see the description of +\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}
              -

              Like \ref, but append the letter ‘s’ to the -\…word. +

              \refs{label}
              +

              Like \ref, but append the letter ‘s’ to the +\…word.

              -

              The purpose of the \…word macro is to produce 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}
              +
              \def\sectionword{Section}
               \definexref{sec-intro}{3.1}{section}
               \definexref{sec-next}{3.2}{section}
              -See \refs{sec-intro} and \refn{sec-next} …
              +See \refs{sec-intro} and \refn{sec-next} ...
               

              This produces ‘See Sections 3.1 and 3.2 …’ @@ -1890,76 +1896,76 @@ See \refs{sec-intro} and \refn{sec-next} …


              -
              -
              +
              + -

              4.10 Page references

              +

              4.10 Page references

              Eplain provides two commands for handling references to page numbers, one for definition and one for use.

              -
              -
              \xrdef{label}
              -

              Define label to be the current page number. This produces no +

              +
              \xrdef{label}
              +

              Define label to be the current page number. This produces no printed output, and ignores following spaces.

              -
              \xref{label}
              -

              Produce the text ‘p. pageno’, which is the usual form for -cross-references. The pageno is actually label’s -definition; if label isn’t defined, the text of the label itself -is printed. The ‘p. ’ prefix is defined by \xrefpageword. - -Its default definition is p.\thinspace. +

              \xref{label}
              +

              Produce the text ‘p. pageno’, which is the usual form for +cross-references. The pageno is actually label’s +definition; if label isn’t defined, the text of the label itself +is printed. The ‘p. ’ prefix is defined by \xrefpageword. + +Its default definition is p.\thinspace.

              -

              Eplain can create hypertext links for the page references (see Page reference hyperlinks: xrdef, xref). +

              Eplain can create hypertext links for the page references (see Page reference hyperlinks: xrdef, xref).


              -
              -
              +
              + -

              4.11 Equation references

              +

              4.11 Equation references

              - - + +

              Instead of referring to pages, it’s most useful if equation labels -refer to equation numbers. Therefore, Eplain reserves a \count -register, \eqnumber, - +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}
              -
              -

              This defines label to be the current value of \eqnumber, -and, if the current context is not inner, then produces a \eqnum -command (see Displays). (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 +

              +
              +\eqdef{label}
              +

              This defines label to be the current value of \eqnumber, +and, if the current context is not inner, then produces a \eqnum +command (see Displays). (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 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 @@ -1970,86 +1976,86 @@ definition between the original definition and the reference, the reference will start to refer to the new empty-labeled equation.

              -
              \eqdefn{label}
              -
              -

              This is like \eqdef, except it always omits the \eqnum -command. It can therefore be used in places where \eqdef can’t; +

              +\eqdefn{label}
              +

              This is like \eqdef, except it always omits the \eqnum +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}
              -

              This produces a formatted reference to label. If label is +

              \eqref{label}
              +

              This produces a formatted reference to label. If label is undefined (perhaps because it is a forward reference), it just produces -the text of the label itself. Otherwise, it calls \eqprint. +the text of the label itself. Otherwise, it calls \eqprint.

              -
              \eqrefn{label}
              -

              This produces the cross-reference text for label. That is, it -is like \eqref, except it doesn’t call \eqprint. +

              \eqrefn{label}
              +

              This produces the cross-reference text for label. That is, it +is like \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: eq). +(see Equation reference hyperlinks: eq).

              -
                +
                -
                -
                +
                + -

                4.11.1 Formatting equation references

                +

                4.11.1 Formatting equation references

                - +

                Both defining an equation label and referring to it should usually -produce output. This output is produced with the \eqprint macro, +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 +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. - +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)}}
                +
                \def\eqprint#1{{\it (#1)}}
                 

                In addition to changing the formatting of equation numbers, you might want 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. - +‘(1.2)’. To achieve this, you redefine \eqconstruct. + For example:

                -
                \def\eqconstruct#1{\the\chapternumber.#1}
                +
                \def\eqconstruct#1{\the\chapternumber.#1}
                 

                (If you are keeping the chapter number in a count register named -\chapternumber, naturally.) +\chapternumber, naturally.)

                -

                The reason for having both \eqconstruct and \eqprint may -not be immediately apparent. The difference is that \eqconstruct +

                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 +\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 @@ -2059,18 +2065,18 @@ 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 +\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}, …
                +
                $$...\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. +

                We use \eqrefn in the cross-reference text, not +\eqref, so that \eqprint is called only once.

                As another example, consider the following requirement: we want to include chapter number in all equation references, and additionally we @@ -2079,23 +2085,23 @@ part other than the one where the equation appears. For example, references to the third equation in chapter 2 of part 1 should be typeset as ‘(2.3)’ throughout part 1, but as ‘(I.2.3)’ in any other part. Let’s assume we have the current chapter and part -numbers in count registers \chapnum and \partnum, +numbers in count registers \chapnum and \partnum, respectively.

                -

                The idea is to have \eqconstruct store the part number of the -equation (that is, the part number at the time of definition), -so that later \eqprint can compare the stored number with the -current part number (that is, the part number at the time of +

                The idea is to have \eqconstruct store the part number of the +equation (that is, the part number at the time of definition), +so that later \eqprint can compare the stored number with the +current part number (that is, the part number at the time of reference). The complicating factor is that internally, the result -of \eqconstruct is both expanded and written out to the -.aux file, and used to typeset the equation number, so +of \eqconstruct is both expanded and written out to the +.aux file, and used to typeset the equation number, so the commands that store the part number should behave correctly in both situations. This is difficult to achieve with expandable commands; therefore, to avoid expansion problems, we are going to use only TeX primitives, which are non-expandable:

                -
                \newcount\eqpartnum
                +
                \newcount\eqpartnum
                 
                 \def\eqconstruct#1{%
                   \global\eqpartnum=\the\partnum\relax
                @@ -2111,52 +2117,52 @@ only TeX primitives, which are non-expandable:
                 }%
                 
                -

                In \eqconstruct, besides constructing the base equation number +

                In \eqconstruct, besides constructing the base equation number (e.g., ‘1.2’), we also store the part number of the equation in the -count register \eqpartnum (\the\partnum is expanded when -the equation number is written to the .aux file, so the -equation label definition in the .aux file will contain the -actual part number). In \eqprint, we need to know the +count register \eqpartnum (\the\partnum is expanded when +the equation number is written to the .aux file, so the +equation label definition in the .aux file will contain the +actual part number). In \eqprint, we need to know the equation’s part number before we typeset the base equation number, therefore we first put the argument in a box, thus causing -\eqpartnum to be set. +\eqpartnum to be set.


                -
                -
                +
                + -

                4.11.2 Subequation references

                +

                4.11.2 Subequation references

                - - + +

                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, +

                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 +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. - +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 @@ -2164,15 +2170,15 @@ described in the previous section, might be anything at all) and the default definition just puts a period between them:

                -
                \def\eqsubreftext#1#2{#1.#2}%
                +
                \def\eqsubreftext#1#2{#1.#2}%
                 
                -

                You can redefine \eqsubreftext to print however you +

                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
                +
                \newcount\subref
                 \def\eqsubreftext#1#2{%
                   \subref = #2           % The space stops a <number>.
                   \advance\subref by 96  % `a' is character code 97.
                @@ -2180,23 +2186,23 @@ like.  For example, this definition makes the labels print as ‘2a’,
                 }
                 
                -

                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. +

                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.


                -
                -
                +
                + -

                4.12 Indexing

                +

                4.12 Indexing

                - - + +

                Eplain provides support for generating raw material for an index, and for typesetting a sorted index. A separate program must do the actual @@ -2204,349 +2210,349 @@ 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: idx). +terms (see Index hyperlinks: idx).

                - +

                Eplain’s indexing commands were designed to work with the program -MakeIndex (https://ctan.org/pkg/makeindex); MakeIndex is also +MakeIndex (https://ctan.org/pkg/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.

                The basic strategy for indexing works like this:

                -
                  -
                1. -For a document foo.tex, Eplain’s indexing commands (e.g., -\idx; see the section ‘Indexing terms’ below) write the raw index -material to foo.idx. +
                    +
                  1. +For a document foo.tex, Eplain’s indexing commands (e.g., +\idx; see the section ‘Indexing terms’ below) write the raw index +material to foo.idx. -
                  2. -MakeIndex reads foo.idx, collects and sorts the index, and -writes the result to foo.ind. +
                  3. +MakeIndex reads foo.idx, collects and sorts the index, and +writes the result to foo.ind. -
                  4. Eplain reads and typesets foo.ind on a subsequent run of +
                  5. Eplain reads and typesets foo.ind on a subsequent run of TeX. See the section ‘Typesetting an index’ below.
                  - -

                  The texi2dvi program can help you automate this -process (see Invoking Eplain). + +

                  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 +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}
                  +
                  \defineindex{m}
                   
                  -

                  defines the command \mdx to write to the file -foo.mdx. Eplain simply does \defineindex{i} to define +

                  defines the command \mdx to write to the file +foo.mdx. Eplain simply does \defineindex{i} to define the default commands.

                  Note that MakeIndex does not use the above naming scheme for multiple indexes. Unless instructed otherwise, MakeIndex always writes its -output to a file with extension .ind. For example, if you -define an additional index with the command \defineindex{j}, +output to a file with extension .ind. For example, if you +define an additional index with the command \defineindex{j}, you’ll need to run MakeIndex like this:

                  -
                  $ makeindex book.jdx -o book.jnd
                  +
                  $ makeindex book.jdx -o book.jnd
                   
                  - - - -

                  For each index defined with \defineindex{n}, Eplain -provides a switch \ifndx which controls whether indexing + + + +

                  For each index defined with \defineindex{n}, Eplain +provides a switch \ifndx which controls whether indexing commands write index entries to the corresponding index file. However, even when index term writing is disabled, indexing commands still do all other processing of their arguments, including typesetting of -proof index terms (see Proofing index terms. +proof index terms (see Proofing index terms.

                  -

                  For example, if you write \idxfalse near the beginning of a -document foo.tex (before the first indexing command), Eplain -will not open the default index file (foo.idx) and the -corresponding indexing commands (\idx, \sidx, etc.) +

                  For example, if you write \idxfalse near the beginning of a +document foo.tex (before the first indexing command), Eplain +will not open the default index file (foo.idx) and the +corresponding indexing commands (\idx, \sidx, etc.) will not write index entries there. This may be useful for draft compilations of a manuscript, e.g., to avoid the overhead of index file input/output.

                  -
                    +
                    -
                    -
                    +
                    + -

                    4.12.1 Indexing terms

                    +

                    4.12.1 Indexing terms

                    - - + +

                    Indexing commands in Eplain come in pairs: one command that only -writes the index entry to the ‘.idx’ file (see above section), and +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 +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 +argument. For example, \sidx{truth}[definition of] on page 75 makes an index entry that will eventually be typeset (by default) as

                    -
                    truth
                    +
                    truth
                       definition of, 75
                     
                    - - - + + +

                    Also, the silent commands ignore trailing spaces. The non-silent ones do not.

                    -
                      +
                      -
                      -
                      +
                      + -

                      4.12.1.1 Indexing commands

                      +

                      4.12.1.1 Indexing commands

                      - +

                      Here are the commands.

                      -
                        -
                      • - -\sidx{term}[subterm] makes an index entry for -term, optionally with subterm subterm. -\idx{term} also produces term as output. Example: +
                          +
                        • + +\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]
                          +
                          \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] +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: +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}
                          +
                          \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 +
                        • + +\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''}
                          +
                          \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 +
                        • + +\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}}
                          +
                          \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 +specifying an index entry as sort@typeset. For example:

                        -
                        \sidx{Ap-weight@$A_\pi$-weight}
                        +
                        \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. -To make an index entry with an @ in it, you have to escape it +

                        will sort as Ap-weight, but print with the proper math. +The @ here is MakeIndex’s default character for this purpose. +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 +\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 +\if@aftersctnhead set true when you’re at a section heading, you could do:

                        -
                        \hookaction{afterindexterm}{\if@aftersctnhead \nobreak \fi}
                        +
                        \hookaction{afterindexterm}{\if@aftersctnhead \nobreak \fi}
                         

                      -
                      -
                      +
                      + -

                      4.12.1.2 Modifying index entries

                      +

                      4.12.1.2 Modifying index entries

                      - - + +

                      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 +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]). +[begin,pagemarkup=defn]).

                      -

                      These work via MakeIndex’s “encapsulation” feature. See Customizing indexing, if you’re not using the default characters for the +

                      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
                      -
                      - - -

                      These mark an index entry as the beginning or end of a range. The index +

                      +
                      + + +begin
                      +
                      end
                      +

                      These mark an index entry as the beginning or end of a range. The index entries must match exactly for MakeIndex to recognize them. Example:

                      -
                      \sidx[begin]{future}[Cohen, Leonard]
                      -…
                      +
                      \sidx[begin]{future}[Cohen, Leonard]
                      +...
                       \sidx[end]{future}[Cohen, Leonard]
                       

                      will typeset as something like

                      -
                      future,
                      +
                      future,
                         Cohen, Leonard, 65–94
                       
                      -
                      see
                      -
                      - - -

                      This marks an index entry as pointing to another; the real index term is +

                      + + +see
                      +

                      This marks an index entry as pointing to another; the real index term is an additional (non-optional) argument to the command. Thus you can anticipate a term readers may wish to look up, yet which you have decided not to index. Example:

                      -
                      \sidx[see]{analysis}[archetypal]{archetypal criticism}
                      +
                      \sidx[see]{analysis}[archetypal]{archetypal criticism}
                       

                      becomes

                      -
                      analysis,
                      -  archetypal, see archetypal criticism
                      +
                      analysis,
                      +  archetypal, see archetypal criticism
                       
                      -
                      seealso
                      -

                      Similar to see (the previous item), but also allows for normal +

                      seealso
                      +

                      Similar to see (the previous item), but also allows for normal index entries of the referencing term. The normal index entries have -to be created separately—seealso does not contribute a +to be created separately—seealso does not contribute a page number to the index entry. For example, if you have indexed a -term on pages 75, 97 and 114, and then add a seealso +term on pages 75, 97 and 114, and then add a seealso entry for the term:

                      -
                      \sidx[seealso]{archetypal criticism}[elements of]{dichotomies}
                      +
                      \sidx[seealso]{archetypal criticism}[elements of]{dichotomies}
                       

                      the index will contain

                      -
                      archetypal criticism,
                      -  elements of, 75, 97, 114, see also dichotomies
                      +
                      archetypal criticism,
                      +  elements of, 75, 97, 114, see also dichotomies
                       

                      (Aside for the academically curious: The archetypal critical book I -took these dichotomous examples from is Laurence Berman’s The +took these dichotomous examples from is Laurence Berman’s The Musical Image, which I happened to co-design and typeset.)

                      -
                      pagemarkup=cs
                      -

                      This puts \cs before the page number in the typeset index, +

                      pagemarkup=cs
                      +

                      This puts \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 +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}}
                      +
                      \def\defn#1{{\sl #1}}
                       \sidx[pagemarkeup=defn]{indexing}
                       

                      becomes something like

                      -
                      indexing, \defn{75}
                      +
                      indexing, \defn{75}
                       
                      @@ -2555,39 +2561,39 @@ it is up to you to define the control sequences you want to use. Example:
                      -
                      -
                      +
                      + -

                      4.12.1.3 Index entries with special characters

                      +

                      4.12.1.3 Index entries with special characters

                      - - + +

                      Indexing terms with special characters can become quite cumbersome because you have to keep both TeX and MakeIndex happy at the same -time. For example, while ‘!’ has no special meaning for TeX, +time. For example, while ‘!’ has no special meaning for TeX, it is a subentry separator for MakeIndex, therefore you’d have to -escape occurrences of literal ‘!’ in index terms. Things get +escape occurrences of literal ‘!’ in index terms. Things get even more interesting with characters which are special in both TeX and MakeIndex.

                      This in turn has some implications for the non-silent forms of the -indexing commands (see Indexing terms), since TeX and MakeIndex +indexing commands (see Indexing terms), since TeX and MakeIndex use different conventions for escaping characters. For example, this will not typeset the exclamation point correctly within the text, while it will come out right inside the index, after MakeIndex strips -the quoting character (‘"’): +the quoting character (‘"’):

                      -
                      \idx{"!}
                      +
                      \idx{"!}
                       

                      This would have to be rewritten using the silent command:

                      -
                      !\sidx{"!}
                      +
                      !\sidx{"!}
                       

                      In general, it is a good idea to eschew the non-silent @@ -2595,34 +2601,34 @@ commands whenever index term contains anything unusual.

                      To understand this keep in mind that indexing commands read the terms verbatim so that the terms can embed almost any character, and that’s -what gets written into the .idx file. The non-silent forms +what gets written into the .idx file. The non-silent forms then typeset the term by rescanning the verbatim copy, hence for the non-silent commands the term, besides being a valid MakeIndex input, must also represent a valid TeX input. The silent commands don’t have this restriction—their terms only need to become valid -TeX input after MakeIndex processes the .idx file and -writes the .ind file. This is what makes the non-silent +TeX input after MakeIndex processes the .idx file and +writes the .ind file. This is what makes the non-silent commands less powerful and more troublesome when dealing with special characters.

                      - - - + + +

                      Here’s an example showing that terms for the silent commands can contain almost any character:

                      -
                      \sidx[see]{comments}[with %@with \verbatim %"|endverbatim]
                      +
                      \sidx[see]{comments}[with %@with \verbatim %"|endverbatim]
                         {commenting with \verbatim %"|endverbatim}
                       
                      -

                      We didn’t have to escape ‘%’ in the sort string for +

                      We didn’t have to escape ‘%’ in the sort string for MakeIndex, while we had to put it inside the verbatim environment -(see Verbatim listing) in the part which MakeIndex will pass back -to TeX. Also, we had to escape the ‘|’ character because it +(see Verbatim listing) in the part which MakeIndex will pass back +to TeX. Also, we had to escape the ‘|’ character because it is special for MakeIndex. If you have trouble understanding the reasons for the different types of escaping used, it is best to -examine the .idx and .ind files resulting from +examine the .idx and .ind files resulting from processing the above input.

                      As was mentioned, index terms can embed “almost any character”, so @@ -2635,14 +2641,14 @@ treated as spaces; ASCII return is treated as end-of-line (this means, among other things, that long terms can be broken across several lines).

                      - - + +

                      You have to be careful with the begin- and end-group characters -(‘{’ and ‘}’ by default). If they are matched, you don’t +(‘{’ and ‘}’ by default). If they are matched, you don’t have to do anything special. For example:

                      -
                      \sidx {braces {, }@braces
                      +
                      \sidx {braces {, }@braces
                         \verbatim {"|endverbatim, \verbatim }"|endverbatim}
                       
                      @@ -2650,47 +2656,47 @@ have to do anything special. For example: hand. The first one is TeX—you have to instruct TeX to use something else as begin- and/or end-group characters. Eplain provides an easy way to do this: just define - -\idxargopen and/or - -\idxargclose to the begin- and end-group characters you are + +\idxargopen and/or + +\idxargclose to the begin- and end-group characters you are going to use with indexing macros, and use braces inside index terms without any restrictions. Here’s an example:

                      -
                      \def\idxargopen{`\<}
                      +
                      \def\idxargopen{`\<}
                       \def\idxargclose{`\>}
                       \sidx <left brace "{@left brace \verbatim "{"|endverbatim>
                       

                      In this example we’ve also dealt with the second problem—braces are MakeIndex’s grouping characters as well (by -default), so we have escaped unmatched braces with ‘"’. +default), so we have escaped unmatched braces with ‘"’.

                      - - + +

                      And the final note: if you need a subentry containing brackets -(‘[’ and ‘]’), avoid the optional argument of \sidx +(‘[’ and ‘]’), avoid the optional argument of \sidx and friends, and use instead MakeIndex’s subentry separator to create the subentry with the brackets in it:

                      -
                      \sidx{entry!subentry with a bracket [}
                      +
                      \sidx{entry!subentry with a bracket [}
                       

                      -
                      -
                      +
                      + -

                      4.12.1.4 Proofing index terms

                      +

                      4.12.1.4 Proofing index terms

                      - - - + + +

                      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, @@ -2698,339 +2704,339 @@ 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 +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 +\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. -

                      - - - - +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, +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 +\makeheadline, it’s up to you to call \indexproofunbox at the appropriate time.


                      -
                      -
                      +
                      + -

                      4.12.2 Typesetting an index

                      +

                      4.12.2 Typesetting an index

                      - - - + + + -

                      The command \readindexfile{i} reads and typesets the -.ind file that MakeIndex outputs (from the .idx file which +

                      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 + + +

                      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). +bibliographies (see Citations and bibliographies).

                      - - + +

                      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 +.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; +(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: + +

                      It ends the setup with \hookrun{beginindex}, so you can +override anything you like in that hook (see Hooks). For example:

                      -
                      \hookaction{beginindex}{\triplecolumns}
                      +
                      \hookaction{beginindex}{\triplecolumns}
                       
                      - - - - - - - - -

                      MakeIndex turns each main index entry into an \item, subentries -into \subitem, and subsubentries into \subsubitem. By + + + + + + + + +

                      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 +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
                      +
                      \hangindent = 1em
                       \raggedright
                       \hyphenpenalty = 10000
                       
                      - -

                      Each entry ends with \hookrun{indexitem}, so you can change any + +

                      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}
                      +
                      \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. + + +

                      Finally, MakeIndex outputs \indexspace between each group of +entries in the .ind file. Eplain makes this equivalent to +\bigbreak.


                      -
                      -
                      +
                      + -

                      4.12.3 Customizing indexing

                      +

                      4.12.3 Customizing indexing

                      - + - - - -

                      By default, MakeIndex outputs ‘, ’ after each term in the index. To + + + +

                      By default, MakeIndex outputs ‘, ’ after each term in the index. To change this, you can add the following to your MakeIndex style -(.ist) file: +(.ist) file:

                      -
                      delim_0 "\\afterindexterm "
                      +
                      delim_0 "\\afterindexterm "
                       delim_1 "\\afterindexterm "
                       delim_2 "\\afterindexterm "
                       
                      -

                      Eplain makes \afterindexterm equivalent to -\quad. +

                      Eplain makes \afterindexterm equivalent to +\quad.

                      -

                      You can also change the keywords Eplain recognizes (see Modifying index entries): +

                      You can also change the keywords Eplain recognizes (see Modifying index entries):

                      -
                      -
                      \idxrangebeginword
                      +
                      +
                      \idxrangebeginword

                      ‘begin’

                      -
                      \idxrangeendword
                      +
                      \idxrangeendword

                      ‘end’

                      -
                      \idxseecmdword
                      +
                      \idxseecmdword

                      ‘see’

                      -
                      \idxseealsocmdword
                      +
                      \idxseealsocmdword

                      ‘seealso’

                      You can also change the magic characters Eplain puts into the -.idx file, in case you’ve changed them in the .ist file: +.idx file, in case you’ve changed them in the .ist file:

                      -
                      -
                      \idxsubentryseparator
                      -

                      !’ +

                      +
                      \idxsubentryseparator
                      +

                      !

                      -
                      \idxencapoperator
                      -

                      |’ +

                      \idxencapoperator
                      +

                      |

                      -
                      \idxbeginrangemark
                      -

                      (’ +

                      \idxbeginrangemark
                      +

                      (

                      -
                      \idxendrangemark
                      -

                      )’ +

                      \idxendrangemark
                      +

                      )

                      -

                      There is no macro for the actual (‘@’ by default) +

                      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 +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 +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 +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 +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. +.ind file, either at MakeIndex level or at Eplain level. However, the - -sed script contained in trimsee - -distributed with Eplain in the util directory can be used to + +sed script contained in trimsee + +distributed with Eplain in the util 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)
                      +
                      analysis,
                      +  archetypal (see archetypal criticism)
                       archetypal criticism,
                      -  elements of, 75, 97, 114 (see also dichotomies)
                      +  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\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): +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):

                      -
                      $ cat myfile.idx | makeindex | ./trimsee >myfile.ind
                      +
                      $ cat myfile.idx | makeindex | ./trimsee >myfile.ind
                       
                      -

                      By default, trimsee uses default page list separators and +

                      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 +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:

                      -
                      -
                      -i is
                      -

                      Use is as a regular expression matching separator before “see -…” commands in the input (default: ‘, \+’). +

                      +
                      -i is
                      +

                      Use is as a regular expression matching separator before “see +…” commands in the input (default: ‘, \+’).

                      -
                      -o os
                      -

                      Use os as a separator to replace is before “see …” -commands (default: ‘ ’). +

                      -o os
                      +

                      Use os as a separator to replace is before “see …” +commands (default: ‘ ’).

                      -
                      -s see
                      -

                      Use see as a regular expression matching “see …” -commands (default: ‘\\indexsee’). +

                      -s see
                      +

                      Use see as a regular expression matching “see …” +commands (default: ‘\\indexsee’).

                      -
                      -h
                      -
                      --help
                      +
                      -h
                      +
                      --help

                      Print a usage message.

                      -
                      -v
                      -
                      --version
                      +
                      -v
                      +
                      --version

                      Print version.

                      -

                      trimsee reads input from the standard input, and directs its +

                      trimsee reads input from the standard input, and directs its output to the standard output.


                      -
                      -
                      +
                      + -

                      4.13 Justification

                      +

                      4.13 Justification

                      - - - - + + + +

                      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 +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.

                      @@ -3038,20 +3044,20 @@ end-of-line in the input file also starts a new line in the output file. 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 +\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; - +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.
                      +
                      {\center First line.
                       
                          Second line, with a blank line before.
                       }
                      @@ -3059,42 +3065,42 @@ this (vertical) glue is inserted after each blank line.
                       
                       

                      This produces:

                      -
                      First line. -
                      -
                      Second line, with a blank line before. +
                      First line. +
                      +
                      Second line, with a blank line before.

                      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\title{\begingroup\titlefont\center}
                       \def\endtitle{\endgroup}
                       
                      - - - - - - - -

                      In addition, Eplain defines \raggedleft, analogous to plain -TeX’s \raggedright. This macro is also typically used + + + + + + + +

                      In addition, Eplain defines \raggedleft, analogous to plain +TeX’s \raggedright. This macro is also typically used inside a group, but unlike the environments above, TeX does normal line breaking; that is, ends-of-lines in the input file aren’t treated -specially. Just like plain’s \raggedright, it also resets -\spaceskip and \xspaceskip so that interword spacing is -uniform. It also sets \parfillskip to zero so that last lines -of paragraphs are also “ragged left”. Finally, \leftskip’s -new value is taken from a new glue register, \raggedleft; its -default value is 0pt plus 2em, the same as -\raggedright’s \rightskip. +specially. Just like plain’s \raggedright, it also resets +\spaceskip and \xspaceskip so that interword spacing is +uniform. It also sets \parfillskip to zero so that last lines +of paragraphs are also “ragged left”. Finally, \leftskip’s +new value is taken from a new glue register, \raggedleft; its +default value is 0pt plus 2em, the same as +\raggedright’s \rightskip.

                      Here’s an example:

                      -
                      {\raggedleft This text will be set ragged left,
                      +
                      {\raggedleft This text will be set ragged left,
                       although the left margin won't be too ragged by default.
                       You may well want to increase the value of
                       {\tt \char`\\raggedleftskip} before calling the macro.
                      @@ -3103,32 +3109,32 @@ or the setting won't have any effect, so: {\tt \char`\\par}
                       }
                       
                      -

                      Despite \raggedleft resetting \parfillskip to zero, +

                      Despite \raggedleft resetting \parfillskip to zero, TeX’s line breaking may still prefer to make the last line of a paragraph considerably shorter than the rest, to minimize overall -badness. Increasing \raggedleftskip may help somewhat, but -using \emergencystretch, retaining interword stretchability by -assigning \leftskip directly, or even forcing line breaks may +badness. Increasing \raggedleftskip may help somewhat, but +using \emergencystretch, retaining interword stretchability by +assigning \leftskip directly, or even forcing line breaks may be necessary.


                      -
                      -
                      +
                      + -

                      4.14 Tables

                      +

                      4.14 Tables

                      - - -

                      Eplain provides a single command, \makecolumns, - + + +

                      Eplain provides a single command, \makecolumns, + to make generating one particular kind of table easier. More ambitious LaTeX styles and macro packages tackle more difficult -applications. The autorows feature of the Memoir package +applications. The autorows feature of the Memoir package provides similar functionality to this.

                      Many tables are homogenous, i.e., all the entries are semantically the @@ -3137,40 +3143,40 @@ 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 +

                      \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). +\makecolumns command itself).

                      -

                      \parindent defines the space to the left of the -table. \hsize defines the width of the table. +

                      \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. - +\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 +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 +

                      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, +\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:
                      +
                      % Arrange 6 entries into 2 columns:
                       \makecolumns 6/2: % This line doesn't have an entry.
                       one
                       two
                      @@ -3187,53 +3193,53 @@ Text after the table.
                       
                       
                      -
                      -
                      +
                      + -

                      4.15 Margins

                      +

                      4.15 Margins

                      - +

                      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, +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
                      -
                      - - -

                      These commands set the specified margin to the dimen given. -The = and the spaces around it are optional. The control +

                      +
                      + + +\topmargin = dimen
                      +
                      \bottommargin = dimen
                      +
                      \leftmargin = dimen
                      +
                      \rightmargin = dimen
                      +

                      These commands set the specified margin to the dimen given. +The = 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 +therefore, commands like \showthe\topmargin will not do what you expect.

                      -
                      \advancetopmargin by dimen
                      -
                      \advancebottommargin by dimen
                      -
                      \advanceleftmargin by dimen
                      -
                      \advancerightmargin by dimen
                      -
                      - - -

                      These commands change the specified margin by the dimen given. +

                      + + +\advancetopmargin by dimen
                      +
                      \advancebottommargin by dimen
                      +
                      \advanceleftmargin by dimen
                      +
                      \advancerightmargin by dimen
                      +

                      These commands change the specified margin by the dimen given.

                      Regardless 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) - +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 @@ -3243,12 +3249,12 @@ 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
                      +
                      +
                      \paperheight

                      The height of the output page; default is 11truein.

                      -
                      \paperwidth
                      +
                      \paperwidth

                      The width of the output page; default is 8.5truein.

                      @@ -3257,92 +3263,92 @@ page. It defines two new parameters for this: reassign to these parameters, as in

                      -
                      \paperheight = 11truein
                      +
                      \paperheight = 11truein
                       \paperwidth = 17truein
                       

                      -
                      -
                      +
                      + -

                      4.16 Multiple columns

                      +

                      4.16 Multiple columns

                      - - - - + + + +

                      Eplain provides for double, triple, and quadruple column output: say -\doublecolumns, - -\triplecolumns, - -or \quadcolumns, - +\doublecolumns, + +\triplecolumns, + +or \quadcolumns, + and from that point on, the manuscript will be set in columns. To go back to one column, say -\singlecolumn. - +\singlecolumn. +

                      - - -

                      You may need to invoke \singlecolumn to balance the columns + + +

                      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 +\columnfill. This does not actually force an eject, however: it merely inserts an unbreakable space of (essentially) size -\@normalvsize minus \pagetotal (where -\@normalvsize is the usual height of the page; to implement -multicolumns, Eplain multiplies \vsize itself by the number of +\@normalvsize minus \pagetotal (where +\@normalvsize is 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 space (during the column splitting operation when the whole page is output).

                      - +

                      The columns are separated by the value of the dimen parameter -\gutter. Default value is two picas. - +\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, +\gutterbox. For example, to put a vertical line between columns, define -\gutterbox as +\gutterbox as

                      -
                      \def\gutterbox{\vbox to \dimen0{\vfil\hbox{\vrule height\dimen0}\vfil}}%
                      +
                      \def\gutterbox{\vbox to \dimen0{\vfil\hbox{\vrule height\dimen0}\vfil}}%
                       

                      There are known bugs in the multiple-column code such that -\topmark and possibly other marks can have an incorrect value +\topmark and possibly other marks can have an incorrect value on the last page of multiple-column material when using -\singlecolumn to balance the columns. Unfortunately this is +\singlecolumn to balance the columns. Unfortunately this is quite difficult to fix, and at present (volunteers welcome), it’s going to remain. A suboptimal workaround is to insert -\columnfill at the appropriate place. +\columnfill at the appropriate place.

                      The dimension counter -\dimen0 +\dimen0 contains the height of the column.

                      -

                      All the \…columns macros insert the value of the glue parameter -\abovecolumnskip - +

                      All the \…columns macros insert the value of the glue parameter +\abovecolumnskip + before the multicolumn text, and the value of the glue parameter -\belowcolumnskip - +\belowcolumnskip + after it. The default value for both of these parameters is -\bigskipamount, i.e., one linespace in plain TeX. +\bigskipamount, i.e., one linespace in plain TeX.

                      The macros take into account only the insertion classes - -defined by plain TeX; namely, footnotes and \topinserts. If + +defined by plain TeX; namely, footnotes and \topinserts. If you have additional insertion classes, you will need to change the implementation.

                      @@ -3352,473 +3358,473 @@ provision for column-width insertions.
                      -
                      -
                      +
                      + -

                      4.17 Footnotes

                      +

                      4.17 Footnotes

                      - +

                      The most common reference mark for footnotes is a raised number, -incremented on each footnote. The \numberedfootnote - +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: +\numberedfootnote more convenient with a command such as:

                      -
                      \let\footnote = \numberedfootnote
                      +
                      \let\footnote = \numberedfootnote
                       

                      After doing this, you can type your footnotes as -\footnote{footnote text}, instead of as -\numberedfootnote{footnote text}. +\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, +\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. +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 +an en space (it uses the \textindent macro). In Eplain, you can change this space by setting the dimension register -\footnotemarkseparation. - +\footnotemarkseparation. + The default is still an en.

                      You can produce a space between footenotes by setting the glue -register \interfootnoteskip. - +register \interfootnoteskip. + The default is zero.

                      -

                      \parskip is also set to zero by default before the beginning of +

                      \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 - +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}
                      +
                      \everyfootnote = {\sevenrm \leftskip = 1in}
                       
                      -

                      By default, an \hrule is typeset above each group of footnotes +

                      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 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 +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. +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: foot, footback). +

                      Eplain can create hypertext links for the footnote marks (see Footnote hyperlinks: foot, footback).


                      -
                      -
                      +
                      + -

                      4.18 Fractions

                      +

                      4.18 Fractions

                      - -

                      Exercise 11.6 of The TeXbook describes a macro \frac - -for setting fractions, but \frac never made it into plain TeX. + +

                      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 +

                      \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 +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 +

                      For example, \frac 23/{64} turns ‘23/64’ into .


                      -
                      -
                      +
                      + -

                      4.19 Paths

                      +

                      4.19 Paths

                      - - - + + +

                      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 than ‘\’ which does not appear in the +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 than ‘\’ which does not appear in the name itself. -‘|’ is often a good choice, as in: +‘|’ is often a good choice, as in:

                      -
                      \path|letters@alpha.gnu.ai.mit.edu|
                      +
                      \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 +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 +breakpoint within \path. The default set is essentially all the punctuation characters:

                      -
                      \discretionaries |~!@$%^&*()_+`-=#{}[]:";'<>,.?\/|
                      +
                      \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 + +

                      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 + +

                      The \path macro comes from path.sty, written by Nelson Beebe and Philip Taylor, and available at -https://ctan.org/pkg/path. +https://ctan.org/pkg/path.


                      -
                      -
                      +
                      + -

                      4.20 Logos

                      +

                      4.20 Logos

                      - - + + -

                      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. +

                      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 -\AMSLaTeX, - - -\AMSTeX, - - -\BibTeX - - -\eTeX, - - -\ExTeX, - - -\LAMSTeX, - - -\LaTeX, - - -\MF, - - -\SLiTeX, - - -\XeLaTeX, - - -and \XeTeX - - +\AMSLaTeX, + + +\AMSTeX, + + +\BibTeX + + +\eTeX, + + +\ExTeX, + + +\LAMSTeX, + + +\LaTeX, + + +\MF, + + +\SLiTeX, + + +\XeLaTeX, + + +and \XeTeX + + to produce their respective logos. (Sorry, the logos are not shown here.) Some spelling variants of these are also supported.

                      - -

                      Most of these macros come from texnames.sty, compiled by Nelson + +

                      Most of these macros come from texnames.sty, compiled by Nelson Beebe and available at -https://mirror.ctan.org/info/biblio/texnames.sty -(part of the biblio package, https://ctan.org/pkg/biblio). +https://mirror.ctan.org/info/biblio/texnames.sty +(part of the biblio package, https://ctan.org/pkg/biblio).


                      -
                      -
                      +
                      + -

                      4.21 Boxes

                      +

                      4.21 Boxes

                      - - + +

                      The solid rectangle that Eplain uses as a marker in unordered lists -(see Lists) is available by itself: just say \blackbox. - +(see Lists) is available by itself: just say \blackbox. +

                      -

                      You can create black boxes of arbitrary size with \hrule or -\vrule. +

                      You can create black boxes of arbitrary size with \hrule or +\vrule.

                      - - -

                      You can also get unfilled rectangles with \makeblankbox. - + + +

                      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 +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{%
                      +
                      \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. - +

                      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 - +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.}}
                      +
                      \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, +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. +

                      \boxit uses \ehrule and \evrule so that you can +easily adjust the thicknesses of the box rules. See Rules.


                      -
                      -
                      +
                      + -

                      4.22 Checking for PDF output

                      +

                      4.22 Checking for PDF output

                      - - - + + +

                      You might sometimes want to test whether the target format is -.pdf or .dvi. The \ifpdf conditional can be used +.pdf or .dvi. The \ifpdf conditional can be used for this:

                      -
                      \ifpdf
                      +
                      \ifpdf
                          This text is produced when the engine outputs PDF.
                       \else
                          This text is produced when the engine outputs DVI (or similar).
                       \fi
                       
                      -

                      At this writing, \ifpdf will be true when running pdfTeX +

                      At this writing, \ifpdf will be true when running pdfTeX or LuaTeX with PDF output. It will be false when running XeTeX, or (of course) original TeX, etc.

                      - - -

                      Eplain defines \ifpdf by incorporating iftex.sty, a + + +

                      Eplain defines \ifpdf by incorporating iftex.sty, a package now maintained by the LaTeX Project Team. -iftex.sty, and therefore Eplain, defines numerous related +iftex.sty, and therefore Eplain, defines numerous related conditionals to test for different engines; see its package -documentation for details: https://ctan.org/pkg/ifpdf. +documentation for details: https://ctan.org/pkg/ifpdf.


                      -
                      -
                      +
                      + -

                      4.23 Loading LaTeX packages

                      +

                      4.23 Loading LaTeX packages

                      - - - - + + + +

                      Eplain provides a limited support for loading LaTeX packages -(.sty files—not .cls). This will mostly work for +(.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 +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). +(see Introduction).

                      - - - - - + + + + +

                      To set up a pseudo-LaTeX environment for the packages, Eplain uses -miniltx.tex (https://ctan.org/pkg/miniltx) from the +miniltx.tex (https://ctan.org/pkg/miniltx) from the LaTeX graphics collection, written by David Carlisle and Sebastian -Rahtz. Eplain extends miniltx.tex to provide (primarily) +Rahtz. Eplain extends miniltx.tex to provide (primarily) support for package options; in many cases, you can use -miniltx.tex directly without loading Eplain at all. +miniltx.tex directly without loading Eplain at all.

                      -