From 76fa5e8e1df302a76387fdcd18ae069d1b4fed02 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Fri, 24 Jul 2009 23:41:28 +0000 Subject: eplain 3.3 (24jul09) git-svn-id: svn://tug.org/texlive/trunk@14435 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/eplain/ChangeLog | 106 + Master/texmf-dist/doc/eplain/NEWS | 22 +- Master/texmf-dist/doc/eplain/README.TOP | 13 + Master/texmf-dist/doc/eplain/demo/Makefile | 6 + Master/texmf-dist/doc/eplain/doc/eplain.html | 4208 +++++++++++++------------ Master/texmf-dist/doc/eplain/doc/eplain.pdf | Bin 924999 -> 893366 bytes Master/texmf-dist/doc/eplain/doc/lscommnt.jpg | Bin 68529 -> 68468 bytes Master/texmf-dist/doc/eplain/doc/xhyper.jpg | Bin 14157 -> 14084 bytes Master/texmf-dist/doc/eplain/util/idxuniq | 14 +- Master/texmf-dist/doc/eplain/util/trimsee | 4 +- 10 files changed, 2295 insertions(+), 2078 deletions(-) create mode 100644 Master/texmf-dist/doc/eplain/README.TOP (limited to 'Master/texmf-dist/doc/eplain') diff --git a/Master/texmf-dist/doc/eplain/ChangeLog b/Master/texmf-dist/doc/eplain/ChangeLog index 06bff49b92c..9d12ad3aefb 100644 --- a/Master/texmf-dist/doc/eplain/ChangeLog +++ b/Master/texmf-dist/doc/eplain/ChangeLog @@ -1,3 +1,109 @@ +2009-07-21 Oleg Katsitadze + + * NEWS, Makefile, eplain.tex, doc/eplain.info, doc/eplain.pdf: + * doc/eplain.texi: + Version 3.3. + +2009-07-18 Oleg Katsitadze + + * util/mkdist-merge: Only unset world's and group's write + permission bit on the generated eplain.tex and leave user's bit + on. + + * xeplain.tex (\idx@scanterm): Reset catcode of newline before + calling \scantokens, to work around a peculiarity of TeX/e-TeX + adding a trailing newline in \scantokens when newline's catcode is + 13 (active). Hopefully nobody will ever rely on unusual newline + catcode inside an index term. + + * doc/userdef.texi (Packages known to work): Updated with the new + version of epstopdf (v2.2). + + * xeplain.tex (\usepkg@load@pkg): Send the package reloading + warning to the log file only and not the terminal, for the sake of + epstopdf.sty which causes several such warnings. + +2009-07-12 Oleg Katsitadze + + * doc/userdef.texi (Verbatim listing): Added a note on extending + \dospecials when defining new special characters. + * doc/progdef.texi (Category codes): Refer to "Verbatim listing" + for the note on \dospecials. + + * xeplain.tex (\@idxwrite): \sanitize the term before passing it + to \indexproofterm, to unactivate any active characters the user + hasn't bothered to add to \dospecials. + +2009-07-10 Karl Berry + + * xeplain.tex (\beginpackages): Set \DoNotLoadEpstopdf, + for TL 2009 graphics.cfg. + +2009-07-05 Oleg Katsitadze + + xeplain.tex (\eqnum, \eqalignnum, \lefteqnumbers, \righteqnumbers): + New macros. Suggested by Dan Luecking May 15 00:32:26 CEST 2009. + doc/userdef.texi (Displays): Documented \eqnum, \eqalignnum, + \lefteqnumbers and \righteqnumbers. + (Formatting displays): Removed stale reference to \generaldisplay. + + xeplian.tex, doc/userdef.texi (Logos): Added eTeX, ExTeX, XeTeX + and XeLaTeX (from tugboat.dtx). Suggested by Dorai Sitaram Apr 12 + 21:30:42 CEST 2009. + +2009-06-28 Oleg Katsitadze + + (NEWS): News for the upcoming release. + +2009-06-26 Oleg Katsitadze + + doc/hlink.texi (General hyperlinks, URL hyperlinks): Added + examples of mailto hyperlinks. Suggested by John Culleton Apr 22 + 14:53:31 CEST 2009. + +2009-06-25 Oleg Katsitadze + + demo/Makefile (ctan_lion_350x350.png): New target to notify about + the missing image file and how to obtain it. + + Makefile (DIR_SOURCE, FILES_ZSOURCE): Renamed to DIR_ZSOURCE and + FILES_ZSOURCE ("zipped source"). + (DIR_SOURCE, FILES_SOURCE): Targets for packaging unzipped source + files. Includes only xeplain.tex so far. Suggested by Jim + Diamond Jun 15 16:59:03 CEST 2009. + +2009-06-21 Oleg Katsitadze + + * README.TDS, xeplain.tex, doc/invoke.texi: Added a note on how to + obtain Eplain's source files. + + * ifpdf.sty: Updated. + + * util/idxuniq, util/trimsee: Comment tweaks. + +2009-05-23 Karl Berry + + * util/trimsee: use standard sh instead of bash ((...)), Frank K + tex-live mail 23 May 2009 19:30:06 +0200, debian#530199 + +2009-03-28 Oleg Katsitadze + + * doc/userdef.texi (Indexing): Note on specifying output file for + MakeIndex (option -o) when using multiple indexes. Reported by + John Culleton Mar 24 15:30:47 CET 2009. + +2009-03-27 Oleg Katsitadze + + * xeplain.tex (\@idxcollectname): Expand \idxnameseparator once, + so that the .idx file contains its contents. This ensures that + \idxname{John}{Smith} and \idx{Smith, John} don't end up as + separate index entries. Reported by John Culleton Mar 23 19:31:46 + CET 2009. + +2008-03-30 Oleg Katsitadze + + * doc/userdef.texi: Note on writing .bbl by hand. + 2007-11-26 Oleg Katsitadze * NEWS, Makefile, eplain.tex, doc/eplain.info, doc/eplain.pdf: diff --git a/Master/texmf-dist/doc/eplain/NEWS b/Master/texmf-dist/doc/eplain/NEWS index 78b45d1b6f6..b30b0254313 100644 --- a/Master/texmf-dist/doc/eplain/NEWS +++ b/Master/texmf-dist/doc/eplain/NEWS @@ -1,7 +1,25 @@ This file records noteworthy changes. This file is public domain. -3.2 (26 November 2007) +3.3 (21 July 2009) + +* New commands \eqnum and \eqalignnum, counterparts of \(l)eqno and + \(l)eqalignno, producing equation numbers which can be uniformly + transformed to right-aligned (\righteqnumbers) or left-aligned + (\lefteqnumbers). +* Eplain has borrowed the eTeX, ExTeX, XeTeX and XeLaTeX logos from + tugboat.dtx. +* \idxnameseparator is now expanded once so that the .idx file + contains its contents instead of the macro call. +* Non-silent indexing macros have been fixed not to produce a spurious + newline when newline's catcode is 13 (active). +* Eplain now takes care to unactivate any active characters before + typesetting index term in the margin for proofing. +* Updated ifpdf.sty. +* LaTeX package reloading warnings are now not shown on the terminal. +* Documentation improvements. + +3.2 (26 November 2007) * Fixed a bug which caused silent indexing macros to output spurious space in vertical mode. * Added a switch to disable index file input/output. @@ -12,6 +30,7 @@ This file records noteworthy changes. This file is public domain. and producing columns too high to fit on a page. Also improved appearance of the last column, which often came out spaced out. + 3.1 (3 December 2006) General: @@ -127,7 +146,6 @@ Other: * \ref and \cite conflicts with amstex described in manual. 2.3 (1 March 1993) - * New macros for arbitrary cross-references. * \iterate is redefined to allow \else in loops. * texnames.sty uses \spacefactor1000 instead of an empty hbox to handle diff --git a/Master/texmf-dist/doc/eplain/README.TOP b/Master/texmf-dist/doc/eplain/README.TOP new file mode 100644 index 00000000000..544578f69ae --- /dev/null +++ b/Master/texmf-dist/doc/eplain/README.TOP @@ -0,0 +1,13 @@ +This directory contains the Eplain macro package for the TeX typesetting +system. For more information about Eplain see http://tug.org/eplain. + +The package consists of the files in the directories conforming to the +TeX Directory Structure (v. 1.1). The directories are: + + tex/eplain compiled Eplain package + doc/eplain compiled Eplain manual and other docs + source/eplain zip archive of the source files for Eplain + +Please note that eplain.tex is a generated file. The original sources +can be found in the zip archive under the source/eplain directory, on +CTAN or on Eplain's home page at http://tug.org/eplain. diff --git a/Master/texmf-dist/doc/eplain/demo/Makefile b/Master/texmf-dist/doc/eplain/demo/Makefile index 45ba215c7aa..7a578663f38 100644 --- a/Master/texmf-dist/doc/eplain/demo/Makefile +++ b/Master/texmf-dist/doc/eplain/demo/Makefile @@ -21,6 +21,12 @@ xhyper.pdf: xhyper.tex ctan_lion_350x350.png lscommnt.pdf: lscommnt.tex PDFLATEX=$(PDFTEX) $(TEXI2PDF) lscommnt.tex +ctan_lion_350x350.png: + @echo "Please download" + @echo " ftp://tug.ctan.org/ftpmaint/CTAN_lion/ctan_lion_350x350.png" + @echo "and place it in the demo subdirectory." + exit 1 + # # Documents which have to be processed with dvipdfm(x). # diff --git a/Master/texmf-dist/doc/eplain/doc/eplain.html b/Master/texmf-dist/doc/eplain/doc/eplain.html index 50bd1c4bd2c..a7c7a04a014 100644 --- a/Master/texmf-dist/doc/eplain/doc/eplain.html +++ b/Master/texmf-dist/doc/eplain/doc/eplain.html @@ -3,12 +3,12 @@ Eplain: Expanded Plain TeX - +
-


+


Next: , Up: (dir) @@ -238,8 +238,8 @@ Up: (dir)

Eplain

-

This manual documents the Eplain macros, version 3.2, -November 2007. Eplain provides functionality for plain TeX that +

This manual documents the Eplain macros, version 3.3, +July 2009. Eplain provides functionality for plain TeX that is intended to be useful regardless of how your document is actually formatted. @@ -519,8 +519,8 @@ updates throughout.

-


+


Next: , Previous: Top, Up: Top @@ -556,8 +556,8 @@ format, you are out of luck.

On the other hand, almost everyone would like capabilities such as cross-referencing by labels, so that you don't have to put actual page numbers in the manuscript. The author of Eplain -is not aware of any generally available macro packages that (1) do -not force their typographic style on an author, and yet (2) provide +is not aware of any generally available macro packages that (1) do +not force their typographic style on an author, and yet (2) provide such capabilities.

Besides such generic macros as cross-referencing, Eplain @@ -596,8 +596,8 @@ article (written for

-


+


Next: , Previous: Introduction, Up: Top @@ -653,8 +653,8 @@ installed under /usr/local/share/texmf/web2c/
-


+


Next: , Previous: Installation, Up: Top @@ -674,7 +674,7 @@ contemporary machines.

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

     initex
@@ -720,7 +720,9 @@ by Nelson Beebe.
    
 
 

The file eplain.tex is all of these files merged -together, with comments removed. +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 http://tug.org/eplain.

All of these files except xeplain.tex can be input individually, if all you want are the definitions in that file. @@ -766,20 +768,20 @@ undefined cross-references and/or citations. The shell script http://www.gnu.org/software/texinfo) can automate this process: it runs BibTeX, MakeIndex and TeX as many times as needed to complete the compilation process. You will need to set the -LATEX environment variable to `tex'. For example, in a +LATEX environment variable to ‘tex’. For example, in a Bourne-compatible shell, the following command will do all the work:

     prompt$ LATEX=tex texi2dvi file.tex
 

(Despite the name, texi2dvi can also produce -.pdf files; just set `LATEX=pdftex'.) See the output from +.pdf files; just set ‘LATEX=pdftex’.) See the output from the command texi2dvi --help for invoking information and a full list of options.

-


+


Next: , Previous: Invoking Eplain, Up: Top @@ -819,8 +821,8 @@ formatting are described in subsections.
-


+


Next: , Up: User definitions @@ -863,8 +865,8 @@ Eplain defines it to be the character ^^J. hoping that will fix it.}%
-


+


Next: , Previous: Diagnostics, Up: User definitions @@ -873,7 +875,7 @@ Up: User definitions

4.2 Rules

-

The default dimensions of rules are defined in chapter 21 of the +

The default dimensions of rules are defined in chapter 21 of the The TeXbook. To sum up what is given there, the “thickness” of rules is 0.4pt by default. Eplain defines three parameters that let you change @@ -891,8 +893,8 @@ to take advantage of the default rule parameters, you must use

-


+


Next: , Previous: Rules, Up: User definitions @@ -931,6 +933,11 @@ name for the .bbl file by defining the co \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 +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 @@ -961,7 +968,7 @@ in the text. 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, +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 @@ -993,29 +1000,36 @@ You can restore the default by saying \xrefwarningtrue.

If we suppose that this file was named citex.tex and that the bibliography data is in knuth.bib (as the \bibliography -command says), the following commands do what's required. (`$ ' +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). +

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

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.

@@ -1031,8 +1045,8 @@ of numbered, the bibliography style is alpha.)
-


+


Next: , Up: Citations @@ -1051,7 +1065,7 @@ redefining the following macros.
\printcitestart
\printcitefinish
Eplain expands these macros at the begining and end of the list of citations for each \cite command. By default, they produce a -`[' and `]', respectively. +‘[’ and ‘]’, respectively.
\printbetweencitations
If a \cite command has multiple citations, as in \cite{acp,texbook}, Eplain expands this macro in between each @@ -1072,8 +1086,8 @@ superscripted labels, with the optional notes in parentheses. \def\printcitenote#1{\hbox{\sevenrm\space (#1)}}
-


+


Previous: Formatting citations, Up: Citations @@ -1136,8 +1150,8 @@ the names. Just use \def.) that BibTeX produces to do anything you wish.
-


+


Next: , Previous: Citations, Up: User definitions @@ -1146,34 +1160,42 @@ Up: User definitions

4.4 Displays

-

+

By default, TeX centers displayed material. (Displayed material is just whatever you put between $$'s—it's not necessarily mathematics.) Many layouts would be better served if the displayed material was left-justified. Therefore, Eplain provides the command \leftdisplays, -which indents displayed material by \parindent plus +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 +(It is usually poor typography to have both centered and left-justified displays in a single publication, though.)

\leftdisplays also changes the plain TeX commands that deal with alignments inside math displays, \displaylines, -\eqalignno, -and \leqalignno, -to produce left-justified text. You can still override this formatting +\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 +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 +(right-aligned equation numbers). +

-


+


Up: Displays
@@ -1183,19 +1205,18 @@ Up: 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 -is called at the beginning of every display (presumably by invoking it -in TeX's \everydisplay parameter), and to define -\generaldisplay. - -\leftdisplays expands the old value of \everydisplay +is called at the beginning of every display (presumably by invoking it +in TeX's \everydisplay parameter). + +

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

-


+


Next: , Previous: Displays, Up: User definitions @@ -1204,30 +1225,30 @@ Up: User definitions

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 -produces the name of the current month, abbreviated to three letters. +produces the name of the current month, abbreviated to three letters.

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

\timestring -produces the current time, as in `1:14 p.m.' +produces the current time, as in `1:14 p.m.'

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

\today -produces the current date, as in `23 April 1964'. +produces the current date, as in `23 April 1964'.

-


+


Next: , Previous: Time of day, Up: User definitions @@ -1236,20 +1257,20 @@ Up: User definitions

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, Eplain provides two pairs of commands:

-
\numberedlist ... \endnumberedlist
\orderedlist ... \endorderedlist
These commands (they are synonyms) produce a list with the items +
\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 `*'. +more deeply nested numbered lists label items with ‘*’. -
\unorderedlist ... \endunorderedlist
This produces a list with the items labelled with small black boxes +
\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. @@ -1259,7 +1280,7 @@ 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. -An item may continue for several paragraphs. Each item starts a +An item may continue for several paragraphs. Each item starts a paragraph.

You can give \li an optional argument, a cross-reference label. @@ -1271,7 +1292,7 @@ with \xrefn. See Cross-references< \xrefn pointing to the relevant list item (see List hyperlinks).

You can also say \listcompact -right after \numberedlist or \unorderedlist. The items in +right after \numberedlist or \unorderedlist. The items in the list will then not have any extra space between them (see Formatting lists). You might want to do this if the items in this particular list are short. @@ -1290,56 +1311,56 @@ this particular list are short.

-


+


Up: 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
The vertical glue inserted before each item except the first. +
\interitemskipamount
The vertical glue inserted before each item except the first. \listcompact resets this to zero, as mentioned above. -
\listleftindent, \listrightindent
\listrightindent is the amount of space by which the list is +
\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 +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 -are analogous. +does \vpenalty\abovelistpenalty +and then \vskip\abovelistskip. \belowlistskip +and \interitemskip +are analogous.

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

If you want to change the labels on the items, you can redefine these macros: \numberedmarker -or \unorderedmarker. -The following registers might be useful if you do: +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, i.e., lowercase `a'. @@ -1348,16 +1369,16 @@ i.e., lowercase `a'.

You can also redefine the control sequences that are used internally, if you want to do something radically different: \beginlist -is invoked to begin both kinds of lists; \printitem -is invoked to print the label (and space following the label) for each +is invoked to begin both kinds of lists; \printitem +is invoked to print the label (and space following the label) for each item; and \endlist -is invoked to end both kinds of +is invoked to end both kinds of lists. - +

-


+


Next: , Previous: Lists, Up: User definitions @@ -1366,40 +1387,40 @@ Up: User definitions

4.7 Verbatim listing

-

It is sometimes useful to include a file verbatim in your document; +

It is sometimes useful to include a file verbatim in your document; for example, part of a computer program. The \listing -command is given one argument, a filename, and produces the contents of +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. +is \tt.

You can take arbitrary actions before reading the file by defining the macro \setuplistinghook. -This is expanded just before the file is input. +This is expanded just before the file is input.

If you want to have line numbers on the output, you can say \let\setuplistinghook = \linenumberedlisting. -The line numbers are stored in the count register \lineno while +The line numbers are stored in the count register \lineno while the file is being read. You can redefine the macro \printlistinglineno -to change how they are printed. +to change how they are printed.

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. -This also works with line numbers (say +This also works with line numbers (say \def\setuplistinghook{\linenumberedlisting \nolastlinelisting}), but only if \printlistinglineno -consists exclusively of boxes at the top level (i.e., any +consists exclusively of boxes at the top level (i.e., any \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 +

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.

You can produce in-line verbatim text in your document with \verbatim. -End the text with |endverbatim. If you need a `|' in the text, +End the text with |endverbatim. If you need a ‘|’ in the text, double it. If the first character of the verbatim text is a space, use | . (| will work elsewhere in the argument, too, but isn't necessary.) @@ -1412,9 +1433,9 @@ isn't necessary.)

Line breaks and spaces in the verbatim text are preserved. -

You can change the verbatim escape character from the default `|' +

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

     \verbatimescapechar \@
 
@@ -1423,6 +1444,18 @@ 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. +

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 +characters, lest they be given special treatment inside verbatim +environments. For example, + +

     \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 characters, calling inside a macro definition of your own does not work properly. For example: @@ -1434,8 +1467,8 @@ making the macro definition. Perhaps \uncatcodespecials will help you (see Category codes).

-


+


Next: , Previous: Verbatim listing, Up: User definitions @@ -1444,12 +1477,12 @@ Up: User definitions

4.8 Contents

-

Producing a table of contents that is both useful and aesthetic is one +

Producing a table of contents that is both useful and aesthetic is one of the most difficult design problems in any work. Naturally, Eplain does not pretend to solve the design problem. Collecting the raw data for a table of contents, however, is much the same across documents. Eplain uses an auxiliary file with extension .toc -(and the same root name as your document) to save the information. +(and the same root name as your document) to save the information.

-


+


Next: , Up: Cross-references @@ -1675,8 +1708,8 @@ Up: Cross-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 @@ -1695,8 +1728,8 @@ it on the next TeX run. commands. See the next section.

-


+


Previous: Defining generic references, Up: Cross-references @@ -1704,23 +1737,23 @@ Up: Cross-references

4.9.2 Using generic references

-

+

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

\refn{label}

\xrefn{label}
\refn and \xrefn (they are synonyms) produce the bare + +
\refn{label}

\xrefn{label}
\refn and \xrefn (they are synonyms) produce the bare definition of label. If label isn't defined, issue a warning, and produce label itself instead, in typewriter. (The warning isn't given if \xrefwarningfalse.) - -
\ref{label}
Given the class c for label (see the description of + +
\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 +


\refs{label}
Like \ref, but append the letter ‘s’ to the \...word.
@@ -1739,8 +1772,8 @@ reference number.

This produces `See Sections 3.1 and 3.2 ...'

-


+


Next: , Previous: Cross-references, Up: User definitions @@ -1753,22 +1786,22 @@ Up: User definitions 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 +
\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. +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).

-


+


Next: , Previous: Page references, Up: User definitions @@ -1777,27 +1810,28 @@ Up: User definitions

4.11 Equation references

-

Instead of referring to pages, it's most useful if equation labels +

Instead of referring to pages, it's most useful if equation labels refer to equation numbers. Therefore, Eplain reserves a \count register, \eqnumber, -for the current equation number, and increments it at each +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 \eqno -command. (The condition makes it possible to use \eqdef in an +
\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 +

If label is empty, you still get an equation number (although naturally you can't reliably refer to it). This is useful if you want to put numbers on all equations in your document, and you don't want to think up unique labels. -

To refer to the last equation with the empty label, you just use the +

To refer to the last equation with the empty label, you just use the empty label in one of the equation reference macros (see below). This can be handy when you want to refer to an equation shortly after its definition, say, in the sentence following the displayed equation, and @@ -1806,23 +1840,23 @@ extreme caution: if later you change the text and insert another empty definition between the original definition and the reference, the reference will start to refer to the new empty-labeled equation. -

\eqdefn{label}
This is like \eqdef, except it always omits the \eqno +
\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. -
\eqrefn{label}
This produces the cross-reference text for label. That is, it +
\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 +

Equation labels can contain the same characters that are valid in general cross-references.

Eplain can create hypertext links for the equation references @@ -1834,8 +1868,8 @@ general cross-references.

-


+


Next: , Up: Equation references @@ -1843,14 +1877,14 @@ Up: Equation referenc

4.11.1 Formatting equation references

-

Both defining an equation label and referring to it should usually +

Both defining an equation label and referring to it should usually produce output. This output is produced with the \eqprint macro, which takes one argument, the equation number being defined or referred -to. By default, this just produces `(number)', where +to. By default, this just produces ‘(number)’, where number is the equation number. To produce the equation number in a different font, or with different surrounding symbols, or whatever, you can redefine \eqprint. -For example, the following definition would print all equation numbers +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.) @@ -1860,7 +1894,7 @@ from affecting surrounding text.) to add more structure to the equation number; for example, you might want to include the chapter number, to get equation numbers like `(1.2)'. To achieve this, you redefine \eqconstruct. -For example: +For example:

     \def\eqconstruct#1{\the\chapternumber.#1}
 
@@ -1895,8 +1929,8 @@ produced. Here's how to get the example just mentioned: include chapter number in all equation references, and additionally we want to include the part number when referencing an equation from any 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)' +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, respectively. @@ -1939,8 +1973,8 @@ therefore we first put the argument in a box, thus causing \eqpartnum to be set.
-


+


Previous: Formatting equation references, Up: Equation references @@ -1948,18 +1982,18 @@ Up: Equation referenc

4.11.2 Subequation references

-

Eplain also provides for one level of substructure for equations. That +

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, +\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 +This counter is advanced by one at every \eqsubdef or \eqsubdefn, and reset to zero at every \eqdef or \eqdefn. @@ -1968,7 +2002,7 @@ equations.

To put the two together to construct the text that the label will produce, they use a macro \eqsubreftext. -This macros takes two arguments, the “main” equation number (which, +This macros takes two arguments, the “main” equation number (which, because the equation label can be defined as arbitrary text, as described in the previous section, might be anything at all) and the “sub” equation number (which is always just a number). Eplain's @@ -1989,11 +2023,11 @@ like. For example, this definition makes the labels print as `2a',

Sadly, we must define a new count register, \subref, instead of using the scratch count register \count255, because -`#1' might include other macro calls which use \count255. +‘#1’ might include other macro calls which use \count255.

-


+


Next: , Previous: Equation references, Up: User definitions @@ -2002,7 +2036,7 @@ Up: User definitions

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 collection and sorting of terms, because TeX itself has no support @@ -2011,7 +2045,7 @@ for sorting.

Eplain can create hypertext links pointing from the index to the index terms (see Index hyperlinks). -

Eplain's indexing commands were designed to work with the program +

Eplain's indexing commands were designed to work with the program MakeIndex, available from CTAN hosts in tex-archive/indexing/makeindex; MakeIndex is also commonly included in prepackaged TeX distributions. It is beyond the scope of @@ -2022,11 +2056,11 @@ options. See http:

    -

  1. For a document foo.tex, Eplain's indexing commands (e.g., +

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

  3. MakeIndex reads foo.idx, collects and sorts the index, and +

  4. MakeIndex reads foo.idx, collects and sorts the index, and writes the result to foo.ind.
  5. Eplain reads and typesets foo.ind on a subsequent run of @@ -2034,12 +2068,12 @@ TeX. See the section `Typesetting an index' below.
-

The texi2dvi program can help you automate this +

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 +

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 +takes an argument that is a single letter, which replaces ‘i’ in the filenames and in the indexing command names described below. For example, @@ -2049,7 +2083,15 @@ example, foo.mdx. Eplain simply does \defineindex{i} to define the default commands. -

For each index defined with \defineindex{n}, Eplain +

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}, +you'll need to run MakeIndex like this: + +

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

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 @@ -2071,8 +2113,8 @@ file input/output.

-


+


Next: , Up: Indexing @@ -2080,23 +2122,23 @@ Up: Indexing

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 +

The silent form of the commands take a subterm as a trailing optional argument. For example, \sidx{truth}[definition of] on page 75 makes an index entry that will eventually be typeset (by default) as

     truth
        definition of, 75
 
-

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

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

-


+


Next: , Up: Indexing terms @@ -2115,25 +2157,25 @@ Up: Indexing terms
4.12.1.1 Indexing commands
-

Here are the commands. +

Here are the commands.

    -
  • \sidx{term}[subterm] makes an index entry for +
  • \sidx{term}[subterm] makes an index entry for term, optionally with subterm subterm. \idx{term} also produces term as output. Example:
              \sidx{truth}[beauty of]
               The beauty of truth is \idx{death}.
    -     
    +

    Subterms at the second and further levels can also be specified in subterm, using the \idxsubentryseparator character to separate -them. This character is by default `!'. +them. This character is by default ‘!’. -

  • \sidxname{First M.}{von Last}[subterm] +
  • \sidxname{First M.}{von Last}[subterm] makes an index -entry for `von Last, First M.'. You can change the -`, ' by redefining \idxnameseparator. +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: @@ -2141,8 +2183,8 @@ and \sidx.) Example:
              \sidxname{Richard}{Stark}
               \idxname{Donald}{Westlake} has written many kinds of novels, under
               almost as many names.
    -     
    -
  • \sidxmarked\cs{term}[subterm] makes an index + +
  • \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 @@ -2153,8 +2195,8 @@ the typesetting of index entries. Example: \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 + +
  • \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 @@ -2164,10 +2206,10 @@ syntax is convoluted enough to make this useful. Example:
              \def\title#1{{\sl #1}}
               \sidxsubmarked{Anderson, Laurie}\title{Strange Angels}
               The \idxsubmarked{Anderson}\title{Carmen} is a strange twist.
    -     
    +
-

The commands above rely on MakeIndex's feature for separating sorting of +

The commands above rely on MakeIndex's feature for separating sorting of an index entry's from its typesetting. You can use this directly by specifying an index entry as sort@typeset. For example: @@ -2180,7 +2222,7 @@ See http://www.ctan 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 +

After any index command, Eplain runs \hookaction{afterindexterm}. Because the index commands always add a whatsit item to the current list, you may wish to preserve a penalty or space past the new item. For example, given a conditional @@ -2190,8 +2232,8 @@ could do:

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


+


Next: , Previous: Indexing commands, Up: Indexing terms @@ -2200,7 +2242,7 @@ Up: Indexing terms
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 @@ -2216,45 +2258,45 @@ 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[end]{future}[Cohen, Leonard]
-     
+

will typeset as something like

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

becomes

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

the index will contain

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

(Aside for the academically curious: The archetypally critical book I took these dichotomous examples from is Laurence Berman's The Musical Image, which I happened to co-design and typeset.) @@ -2267,16 +2309,16 @@ it is up to you to define the control sequences you want to use. Example:

          \def\defn#1{{\sl #1}}
           \sidx[pagemarkeup=defn]{indexing}
-     
+

becomes something like

          indexing, \defn{75}
-     
+
-


+


Next: , Previous: Modifying index entries, Up: Indexing terms @@ -2285,12 +2327,12 @@ Up: Indexing terms
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. @@ -2299,7 +2341,7 @@ indexing commands (see Indexing terms), since TeX 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{"!}
 
@@ -2313,7 +2355,7 @@ 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 -then typeset the term by rescanning the verbatim copy, therefore for +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 @@ -2322,16 +2364,16 @@ writes the .ind file. This is what makes commands less powerful and more troublesome when dealing with special characters. -

Here's an example showing that terms for the silent commands can +

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

     \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 +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 @@ -2347,8 +2389,8 @@ 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 +

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

     \sidx {braces {, }@braces
@@ -2358,8 +2400,8 @@ 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:
 
@@ -2369,18 +2411,18 @@ without any restrictions.  Here's an example:
 

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 the final note: if you need a subentry containing brackets +(‘[’ 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 [}
 
-


+


Previous: Index entries with special characters, Up: Indexing terms @@ -2388,14 +2430,14 @@ Up: Indexing 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, 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 +

So Eplain puts index terms in the margin of each page, if you set \indexproofingtrue. It is false by default. The terms are typeset by the macro \indexproofterm, which takes a single argument, the term to be typeset. Eplain's definition of @@ -2404,14 +2446,14 @@ argument, the term to be typeset. Eplain's definition of 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 +

On the other hand, we certainly don't want the index term to run into the text of the page, so Eplain uses the right-hand side of the page rather than the left-hand page (assuming a language read left to right here). So \ifodd\pageno, Eplain kerns by \outsidemargin, otherwise by \insidemargin. If those macros are undefined, \indexsetmargins defines them to be one inch plus \hoffset. -

To get the proofing index entries on the proper page, Eplain defines a new +

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, @@ -2420,8 +2462,8 @@ if you have your own output routine, that redefines or doesn't use the appropriate time.

-


+


Next: , Previous: Indexing terms, Up: Indexing @@ -2430,38 +2472,38 @@ Up: Indexing

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 indexing commands in the previous sections write). Eplain defines a number of commands that support the default MakeIndex output. -

More precisely, \readindexfile reads +

More precisely, \readindexfile reads \indexfilebasename.index-letternd, where the index-letter is the argument. \indexfilebasename is \jobname by default, but if you have different indexes in different parts of a book, you may wish to change it, just as with bibliographies (see Citations). -

MakeIndex was designed to work with LaTeX; therefore, by default the +

MakeIndex was designed to work with LaTeX; therefore, by default the .ind file starts with \begin{theindex} and ends with \end{theindex}. If no \begin has been defined, Eplain defines one to ignore its argument and set up for typesetting the index (see below), and also defines a \end to ignore its argument. (In a group, naturally, since there is a primitive \end). -

Eplain calls \indexfonts, sets \parindent = 0pt, and does +

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 +

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

     \hookaction{beginindex}{\triplecolumns}
 
-

MakeIndex turns each main index entry into an \item, subentries +

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 @@ -2472,23 +2514,23 @@ index entries.

All levels do the following: -

+

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

Finally, MakeIndex outputs \indexspace between each group of +

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

-


+


Previous: Typesetting an index, Up: Indexing @@ -2496,8 +2538,8 @@ Up: 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: @@ -2511,13 +2553,13 @@ change this, you can add the following to your MakeIndex style

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

-
\idxrangebeginword
`begin' +
\idxrangebeginword
`begin' -
\idxrangeendword
`end' +
\idxrangeendword
`end' -
\idxseecmdword
`see' +
\idxseecmdword
`see' -
\idxseealsocmdword
`seealso' +
\idxseealsocmdword
`seealso'
@@ -2525,24 +2567,24 @@ change this, you can add the following to your MakeIndex style .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” +

You can change the (imaginary) page number that “see also” entries sort as by redefining \idxmaxpagenum. This is 99999 by default, which is one digit too many for old versions of MakeIndex. -

The words output by Eplain for “see” and “see also” index entries +

The words output by Eplain for “see” and “see also” index entries are defined by \indexseeword and \indexseealsowords respectively. You can change the typeface used for these words by redefining \seevariant. And finally, the macros @@ -2552,12 +2594,12 @@ entirely different. If you do redefine them, make them take two parameters, the term being referenced and the \idxmaxpagenum (the latter should normally be ignored). See the example below. -

Unfortunately, it is impossible to reliably control the commas +

Unfortunately, it is impossible to reliably control the commas produced by MakeIndex in front of “see ...” entries in the .ind file, either at MakeIndex level or at Eplain level. However, the -sed script 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: @@ -2588,13 +2630,13 @@ following:

-i is
Use is as a regular expression matching separator before “see -...” commands in the input (default: `, \+'). +...” commands in the input (default: ‘, \+’).
-o os
Use os as a separator to replace is before “see ...” -commands (default: ` '). +commands (default: ‘ ’).
-s see
Use see as a regular expression matching “see ...” -commands (default: `\\indexsee'). +commands (default: ‘\\indexsee’).
-h
--help
Print a usage message. @@ -2605,8 +2647,8 @@ commands (default: `\\indexsee'). output to the standard output.
-


+


Next: , Previous: Indexing, Up: User definitions @@ -2615,10 +2657,10 @@ Up: User definitions

4.13 Justification

-

Eplain defines three commands to conveniently justify multiple +

Eplain defines three commands to conveniently justify multiple lines of text: \flushright, \flushleft, and \center. - + They all work in the same way; let's take \center as the example. To start centering lines, you say \center inside a group; to stop, you end the group. Between the two commands, each @@ -2635,7 +2677,7 @@ until the end of the paragraph).

The space between paragraphs is by default one blank line's worth. You can adjust this space by assigning to \blanklineskipamount; -this (vertical) glue is inserted after each blank line. +this (vertical) glue is inserted after each blank line.

Here is an example: @@ -2658,8 +2700,8 @@ a title macro might be defined: \def\endtitle{\endgroup}

-


+


Next: , Previous: Justification, Up: User definitions @@ -2668,12 +2710,11 @@ Up: User definitions

4.14 Tables

-

Eplain provides a single command, \makecolumns, -to make generating one particular kind of table easier. More ambitious -macro packages might be helpful to you for more difficult applications. -The files ruled.tex and TXSruled.tex, available from -http://www.ctan.org/tex-archive/macros/texsis, is the only -one I know of. +

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 +provides similar functionality to this.

Many tables are homogenous, i.e., all the entries are semantically the same. The arrangement into columns is to save space on the page, not @@ -2696,7 +2737,7 @@ to these parameters, probably inside a group.

You can also control the penalty at a page break before the \makecolumns by setting the parameter \abovecolumnspenalty. -Usually, the table is preceded by some explanatory text. You wouldn't +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 @@ -2726,8 +2767,8 @@ looking somewhat out of place. `four', `five', and `six' in the second.

-


+


Next: , Previous: Tables, Up: User definitions @@ -2736,7 +2777,7 @@ Up: User definitions

4.15 Margins

-

TeX's primitives describe the type area in terms of an offset from +

TeX's primitives describe the type area in terms of an offset from the upper left corner, and the width and height of the type. Some people prefer to think in terms of the margins at the top, bottom, left, and right of the page, and most composition systems other than @@ -2744,13 +2785,13 @@ 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. +
\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 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, @@ -2758,7 +2799,7 @@ Eplain always changes the type area in response, not the other margins. For example, when TeX starts, the left and right margins are both one inch. If you then say \leftmargin = 2in, the right margin will remain at one inch, and the width of the lines (i.e., \hsize) -will decrease by one inch. +will decrease by one inch.

When you use any of these commands, Eplain computes the old value of the particular margin, by how much you want to change it, and then @@ -2768,9 +2809,9 @@ help: you must tell it the full width and height of the final output page. It defines two new parameters for this:

-
\paperheight
The height of the output page; default is 11truein. +
\paperheight
The height of the output page; default is 11truein. -
\paperwidth
The width of the output page; default is 8.5truein. +
\paperwidth
The width of the output page; default is 8.5truein.

If your output page has different dimensions than this, you must @@ -2780,8 +2821,8 @@ reassign to these parameters, as in \paperwidth = 17truein

-


+


Next: , Previous: Margins, Up: User definitions @@ -2790,18 +2831,18 @@ Up: User definitions

4.16 Multiple columns

-

Eplain provides for double, triple, and quadruple column output: say +

Eplain provides for double, triple, and quadruple column output: say \doublecolumns, -\triplecolumns, -or \quadcolumns, -and from that point on, the manuscript will be +\triplecolumns, +or \quadcolumns, +and from that point on, the manuscript will be set in columns. To go back to one column, say \singlecolumn. - -You may need to invoke \singlecolumn to balance the columns + +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 +

To do a “column eject”, i.e., move to the top of the next column, do \columnfill. This does not actually force an eject, however: it merely inserts a kern of size \@normalvsize minus \pagetotal (\@normalvsize being the usual height of the @@ -2810,9 +2851,9 @@ by the number of columns). In most circumstances, a column break will be forced after this kern (during the column splitting operation when the whole page is output), as desired. -

The columns are separated by the value of the dimen parameter +

The columns are separated by the value of the dimen parameter \gutter. Default value is two picas. -If you want to add vertical material between the columns, use +If you want to add vertical material between the columns, use \gutterbox. For example, to put a vertical line between columns, define \gutterbox as @@ -2825,13 +2866,13 @@ contains the height of the column.

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

The macros take into account only the insertion classes -defined by plain TeX; namely, footnotes and \topinserts. If +defined by plain TeX; namely, footnotes and \topinserts. If you have additional insertion classes, you will need to change the implementation. @@ -2839,8 +2880,8 @@ the implementation. provision for column-width insertions.

-


+


Next: , Previous: Multiple columns, Up: User definitions @@ -2849,9 +2890,9 @@ Up: User definitions

4.17 Footnotes

-

The most common reference mark for footnotes is a raised number, +

The most common reference mark for footnotes is a raised number, incremented on each footnote. The \numberedfootnote -macro provides this. It takes one argument, the footnote text. +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: @@ -2871,18 +2912,18 @@ could say \footnotenumber=0. an en space (it uses the \textindent macro). In Eplain, you can change this space by setting the dimension register \footnotemarkseparation. -The default is still an en. +The default is still an en.

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

\parskip is also set to zero by default before the beginning of each footnote (but not for the text of the footnote).

You can also control footnote formatting in a more general way: Eplain expands the token register \everyfootnote -before a footnote is typeset, but after the default values for all the +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: @@ -2892,10 +2933,10 @@ could say:

By default, an \hrule is typeset above each group of footnotes on a page. You can control the dimensions of this rule by setting the dimension registers \footnoterulewidth -and \footnoteruleheight. -The space between the rule and the first footnote on the page is +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, +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. @@ -2907,8 +2948,8 @@ by the glue register \skip\footins. The default is a plain TeX

Eplain can create hypertext links for the footnote marks (see Footnote hyperlinks).

-


+


Next: , Previous: Footnotes, Up: User definitions @@ -2917,8 +2958,8 @@ Up: User definitions

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 @@ -2926,15 +2967,15 @@ So Eplain includes it. 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 +see page 203 of The TeXbook for an explanation of delimited macro arguments.)

For example, \frac 23/{64} turns `23/64' into .

-


+


Next: , Previous: Fractions, Up: User definitions @@ -2943,24 +2984,24 @@ Up: User definitions

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

If you use the \path macro to typeset the names, TeX will find these good breakpoints. The argument to \path is delimited by -any character other other than `\' which does not appear in the +any character other 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|
 
-

You can control the exact set of characters at which breakpoints will be +

You can control the exact set of characters at which breakpoints will be allowed by calling \discretionaries. This takes the same sort of delimited argument; any character in the argument will henceforth be a valid breakpoint within \path. The default set is essentially all the @@ -2968,19 +3009,19 @@ punctuation characters:

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

If for some reason you absolutely must use \ as the delimiter +

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 http://www.ctan.org/tex-archive/macros/latex/contrib/misc/path.sty.

-


+


Next: , Previous: Paths, Up: User definitions @@ -2989,30 +3030,34 @@ Up: User definitions

4.20 Logos

-

+

Eplain redefines the \TeX -macro of plain TeX to end with \null, so that the proper +macro of plain TeX to end with \null, so that the proper spacing is produced when \TeX is used at the end of a sentence. The other ...TeX macros listed here do this, also.

Eplain defines -\AMSTeX, -\BibTeX -\AMSLaTeX, -\LAMSTeX, -\LaTeX -\MF, -and \SLiTeX -to produce their respective logos. (Sorry, the logos are not shown +\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. -

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

Most of these macros come from texnames.sty, compiled by Nelson Beebe and available at http://www.ctan.org/tex-archive/info/biblio/texnames.sty.

-


+


Next: , Previous: Logos, Up: User definitions @@ -3021,14 +3066,14 @@ Up: User definitions

4.21 Boxes

-

The solid rectangle that Eplain uses as a marker in unordered lists +

The solid rectangle that Eplain uses as a marker in unordered lists (see Lists) is available by itself: just say \blackbox. - + You can create black boxes of arbitrary size with \hrule or \vrule. -

You can also get unfilled rectangles with \makeblankbox. -This takes two explicit arguments: the height and depth of the rules that +

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, @@ -3045,9 +3090,9 @@ putting next to numbers in, e.g., a table of contents. }

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 +This takes one argument, which must itself be a (TeX) box, and puts a printed box around it, separated by \boxitspace -white space (3 points by default) on all four sides. For example: +white space (3 points by default) on all four sides. For example:

     \boxit{\hbox{This text is boxed.}}
 
@@ -3061,8 +3106,8 @@ you can always reset it yourself.) easily adjust the thicknesses of the box rules. See Rules.
-


+


Next: , Previous: Boxes, Up: User definitions @@ -3071,12 +3116,12 @@ Up: User definitions

4.22 Checking for PDF output

-

pdfTeX is a TeX variant that can output both .dvi and +

pdfTeX is a TeX variant that can output both .dvi and .pdf (Adobe's Portable Document Format) files (see http://www.ctan.org/tex-archive/systems/pdftex). You might sometimes want to know whether the target format is .pdf or .dvi. The \ifpdf -switch can be used to detect pdfTeX in PDF mode: +switch can be used to detect pdfTeX in PDF mode:

     \ifpdf
         This text is produced when pdfTeX is in PDF mode.
@@ -3087,17 +3132,17 @@ sometimes want to know whether the target format is .pd
 

Keep in mind that \ifpdf is set based on the value of the \pdfoutput -primitive of pdfTeX at the time Eplain is loaded. If you change +primitive of pdfTeX at the time Eplain is loaded. If you change the value of \pdfoutput after you load Eplain, \ifpdf will not reflect the change. -

Eplain defines \ifpdf by incorporating Heiko Oberdiek's +

Eplain defines \ifpdf by incorporating Heiko Oberdiek's ifpdf.sty, which is available at http://www.ctan.org/tex-archive/macros/latex/contrib/oberdiek/ifpdf.sty.

-


+


Previous: Checking for PDF output, Up: User definitions @@ -3105,7 +3150,7 @@ Up: User definitions

4.23 Loading LaTeX packages

-

Eplain provides a limited support for loading LaTeX packages +

Eplain provides a limited support for loading LaTeX packages (.sty files—not .cls). This will mostly work for packages which were designed with plain TeX compatibility in mind, which means that most LaTeX packages cannot be loaded. The @@ -3113,7 +3158,7 @@ packages which are known to work are listed below (see Introduction). -

To set up a pseudo-LaTeX environment for the packages, Eplain uses +

To set up a pseudo-LaTeX environment for the packages, Eplain uses miniltx.tex (http://www.ctan.org/tex-archive/macros/plain/graphics/miniltx.tex) from the LaTeX graphics collection, written by David Carlisle and @@ -3130,9 +3175,9 @@ e.g., support for package options.

-


+


Next: , Up: Loading LaTeX packages @@ -3140,7 +3185,7 @@ Up: Loading LaTeX

4.23.1 The \usepackage command

-

\usepackage loads a LaTeX package. Its syntax is similar to +

\usepackage loads a LaTeX package. Its syntax is similar to that of LaTeX's \usepackage command:

     \usepackage[options]{packages}[version]
@@ -3148,7 +3193,7 @@ that of LaTeX's \usepackage command:
    

where options is a comma-separated list of package options, packages is a comma-separated list of packages to load (without the .sty suffix), and version is a package -version number given as a date in the format `YYYY/MM/DD'. If an +version number given as a date in the format ‘YYYY/MM/DD’. If an older version of the package is found, a warning is issued. If several packages are loaded within a single \usepackage command, the options will be applied to each of the packages. @@ -3159,13 +3204,13 @@ omitted (together with the square brackets).

     \usepackage[foo,bar]{pack1,pack2}[2005/08/29]
 
-

will load packages `pack1' and `pack2', each with -the options `foo' and `bar', and will check that each of the +

will load packages ‘pack1’ and ‘pack2’, each with +the options ‘foo’ and ‘bar’, and will check that each of the packages are dated 2005/08/29 or newer.

-


+


Next: , Previous: The \usepackage command, Up: Loading LaTeX packages @@ -3174,7 +3219,7 @@ Up: Loading LaTeX

4.23.2 Environment for loading packages

-

Some packages request that certain commands are executed after all +

Some packages request that certain commands are executed after all packages have been loaded. In LaTeX, this means that the commands are executed at the beginning of the document, after the so-called preamble. Neither plain TeX nor Eplain have any kind of @@ -3192,20 +3237,20 @@ commands at the end of the \beginpackages...\endpackages block.

For the same reason, it is advisable to specify only one such block per document, just like there is only one preamble in LaTeX. -

Some packages (and the pseudo-LaTeX environment, miniltx.tex) +

Some packages (and the pseudo-LaTeX environment, miniltx.tex) redefine TeX's primitive \input to be a macro. Non-primitive \input is probably not what the user expects under -plain TeX. Therefore, at the beginning of the +plain TeX. Therefore, at the beginning of the \beginpackages...\endpackages block Eplain saves the meaning of \input as -\eplaininput and restores the original \input at the end +\eplaininput and restores the original \input at the end of the block. This usually means that the primitive \input is restored, unless you (or some other macro package you've loaded directly) have redefined it before calling \beginpackages. In case you need to access the package-provided \input, Eplain saves it as \packageinput. -

Sometimes you may encounter packages which make conflicting +

Sometimes you may encounter packages which make conflicting redefinitions of \input. Common symptoms are TeX spewing incomprehensible error messages or hanging in a loop at a call to \input. This sometimes can be cured by restoring \input @@ -3218,8 +3263,8 @@ to \eplaininput before loading each package. For example: \endpackages

-


+


Next: , Previous: Environment for loading packages, Up: Loading LaTeX packages @@ -3228,32 +3273,32 @@ Up: Loading LaTeX

4.23.3 Packages known to work

-

The following table lists packages that had been tested and are known +

The following table lists packages that had been tested and are known to work with Eplain, and locations where you can find manuals for these packages. Some of the short descriptions of the packages were taken from the documentation for those packages.

-
autopict (`2001/06/04 v1.1j Picture mode autoload file')
http://tug.org/eplain/misc/ltpictur.pdf +
autopict (‘2001/06/04 v1.1j Picture mode autoload file’)
http://tug.org/eplain/misc/ltpictur.pdf -

This is the LaTeX “picture mode”, started by +

This is the LaTeX “picture mode”, started by \begin{picture} and ended by \end{picture} (in LaTeX, this package is not explicitly loaded since it is part of the LaTeX kernel). It provides commands to draw simple figures inside your document without resorting to any external tools. -

color (`1999/02/16 v1.0i Standard LaTeX Color (DPC)')
graphics (`2001/07/07 v1.0n Standard LaTeX Graphics (DPC,SPQR)')
graphicx (`1999/02/16 v1.0f Enhanced LaTeX Graphics (DPC,SPQR)')
http://www.ctan.org/tex-archive/macros/latex/required/graphics/grfguide.pdf +
color (‘1999/02/16 v1.0i Standard LaTeX Color (DPC)’)
graphics (‘2001/07/07 v1.0n Standard LaTeX Graphics (DPC,SPQR)’)
graphicx (‘1999/02/16 v1.0f Enhanced LaTeX Graphics (DPC,SPQR)’)
http://www.ctan.org/tex-archive/macros/latex/required/graphics/grfguide.pdf -

These packages are from the LaTeX graphics collection. They +

These packages are from the LaTeX graphics collection. They provide commands for changing text/page colors, text rotation and scaling, and much more. -

Warning 1: If you encounter problems loading one of +

Warning 1: If you encounter problems loading one of these packages under pdfTeX (more specifically, when pdfTeX reads supp-mis.tex), the cause may be an outdated supp-mis.tex (part of ConTeXt, a typesetting system for TeX) installed on your system. The problem was fixed in -supp-mis.tex version 2004.10.26. You can obtain +supp-mis.tex version 2004.10.26. You can obtain up-to-date versions of supp-mis.tex and the accompanying supp-pdf.tex from http://www.ctan.org/tex-archive/macros/pdftex/graphics. @@ -3273,51 +3318,51 @@ TeX directory structure see

  • upgrade your ConTeXt installation. -

    Note that option 1 is the safest but provides the fix -only for your current document. Options 2 and 3 will -usually suffice for Eplain but may break ConTeXt. Option 4 is +

    Note that option 1 is the safest but provides the fix +only for your current document. Options 2 and 3 will +usually suffice for Eplain but may break ConTeXt. Option 4 is the most general but is more complicated than the first three. Be sure to backup any files you overwrite. Also keep in mind that upgrading your TeX distribution may overwrite files you install in -the system texmf tree.
    End of warning 1. +the system texmf tree.
    End of warning 1. -

    Warning 2: If you encounter problems using the +

    Warning 2: If you encounter problems using the \pagecolor command from the color.sty package under pdfTeX, the cause may be an outdated pdfTeX color and graphics driver pdftex.def. The problem was fixed in pdftex.def -version 0.03p. You can obtain an up-to-date version from +version 0.03p. You can obtain an up-to-date version from http://www.ctan.org/tex-archive/graphics/pdftex/pdftex.def.
    -End of warning 2. +End of warning 2. -

    The graphics/graphicx packages have the option -draft which instructs \includegraphics not to include the +

    The graphics/graphicx packages have the option +draft which instructs \includegraphics not to include the graphics but instead typeset a box with the dimensions of the graphics and the name of the graphics file in typewriter type at the center of the box. These packages expect the LaTeX-provided command -\ttfamily to switch to the typewrite type. This command is not +\ttfamily to switch to the typewrite type. This command is not defined by miniltx.tex, therefore Eplain defines it and makes it -equivalent to plain TeX's -\tt. +equivalent to plain TeX's +\tt.

    See Hyperlinks (xhyper.tex), for the demonstration of text rotation and graphics inclusion using the graphicx package, and using the color package to colorize hypertext links. -

    Klaus Höppner has written a nice introduction to the LaTeX graphics +

    Klaus Höppner has written a nice introduction to the LaTeX graphics packages and different graphics formats. You can download it from

              http://www.tug.org/pracjourn/2005-3/hoeppner
    -     
    -
    epstopdf (`2001/02/04 v1.1 Conversion with epstopdf on the fly (HO)')
    http://www.ctan.org/tex-archive/macros/latex/contrib/oberdiek + +
    epstopdf (‘2009/07/16 v2.2 Conversion with epstopdf on the fly (HO)’)
    http://www.ctan.org/tex-archive/macros/latex/contrib/oberdiek -

    This package does on-the-fly conversion of Encapsulated PostScript +

    This package does on-the-fly conversion of Encapsulated PostScript (EPS) graphics into Portable Document Format (PDF) graphics for inclusion with the \includegraphics command from the graphics/graphicx packages, so that you do not have to explicitly call the epstopdf script. -

    psfrag (`1998/04/11 v3.04 PSfrag (MCG)')
    http://www.ctan.org/tex-archive/macros/latex/contrib/psfrag/pfgguide.pdf +
    psfrag (‘1998/04/11 v3.04 PSfrag (MCG)’)
    http://www.ctan.org/tex-archive/macros/latex/contrib/psfrag/pfgguide.pdf -

    PSfrag allows the user to precisely overlay Encapsulated PostScript +

    PSfrag allows the user to precisely overlay Encapsulated PostScript (EPS) files with arbitrary (La)TeX constructions. In order to accomplish this, the user places a simple text “tag” in the graphics file, as a “position marker” of sorts. Then, using simple @@ -3325,18 +3370,18 @@ file, as a “position marker” of sorts. Then, using simple the figure, and replace it with a properly sized, aligned, and rotated (La)TeX equation. -

    soul (`2003/11/17 v2.4 letterspacing/underlining (mf)')
    http://www.ctan.org/tex-archive/macros/latex/contrib/soul +
    soul (‘2003/11/17 v2.4 letterspacing/underlining (mf)’)
    http://www.ctan.org/tex-archive/macros/latex/contrib/soul -

    This package provides hyphenatable letterspacing (spacing out), +

    This package provides hyphenatable letterspacing (spacing out), underlining, and some derivatives. The package is optimized for LaTeX, but works with plain TeX—you don't actually need to load it with the \usepackage command, just say \input soul.sty. If you intend to use the highlighting macros of soul, don't forget to load the color package. -

    url (`2005/06/27 ver 3.2 Verb mode for urls, etc.')
    http://www.ctan.org/tex-archive/macros/latex/contrib/misc/url.sty +
    url (‘2005/06/27 ver 3.2 Verb mode for urls, etc.’)
    http://www.ctan.org/tex-archive/macros/latex/contrib/misc/url.sty -

    This package provides a form of \verbatim that allows +

    This package provides a form of \verbatim that allows line breaks at certain characters or combinations of characters, accepts reconfiguration, and can usually be used in the argument to another command. It is intended for email addresses, hypertext links, @@ -3346,12 +3391,12 @@ directories/paths, etc., which normally have no spaces. (see URL hyperlinks).

    Be sure to get a version dated at least 2005/06/27, as older versions -have problems in plain TeX. +have problems in plain TeX.

  • -


    +


    Previous: Packages known to work, Up: Loading LaTeX packages @@ -3359,24 +3404,24 @@ Up: Loading LaTeX

    4.23.4 Packages known not to work

    -

    The following packages are known not to work with Eplain: +

    The following packages are known not to work with Eplain:

    -
    hyperref
    http://www.ctan.org/tex-archive/macros/latex/contrib/hyperref +
    hyperref
    http://www.ctan.org/tex-archive/macros/latex/contrib/hyperref

    This package depends heavily on LaTeX, so that it is mostly unusable outside of LaTeX. Eplain provides its own macros for creating hyperlinks, see Hyperlinks. -

    pict2e (`2005/07/15 v0.2r Improved picture commands (HjG,RN)')
    http://www.ctan.org/tex-archive/macros/latex/contrib/pict2e +
    pict2e (‘2005/07/15 v0.2r Improved picture commands (HjG,RN)’)
    http://www.ctan.org/tex-archive/macros/latex/contrib/pict2e -
    xcolor (`2005/06/06 v2.03 LaTeX color extensions (UK)')
    http://www.ctan.org/tex-archive/macros/latex/contrib/xcolor +
    xcolor (‘2005/06/06 v2.03 LaTeX color extensions (UK)’)
    http://www.ctan.org/tex-archive/macros/latex/contrib/xcolor
    -


    +


    Next: , Previous: User definitions, Up: Top @@ -3385,7 +3430,7 @@ Up: Top

    5 Hyperlinks

    -

    This chapter describes the support which Eplain provides for hypertext +

    This chapter describes the support which Eplain provides for hypertext links (hyperlinks for short). Hyperlinks can be created implicitly by the cross-reference, indexing and other macros in Eplain. Macros for constructing explicit hyperlinks are also @@ -3401,8 +3446,8 @@ provided.

    -


    +


    Next: , Up: Hyperlinks @@ -3410,16 +3455,16 @@ Up: Hyperlinks

    5.1 Introduction to hyperlinks

    -

    The original TeX engine has no built-in support for hyperlinks +

    The original TeX engine has no built-in support for hyperlinks (a.k.a. hypertext links). Many of the present-day file formats with hyperlinking capabilities did not even exist at the time TeX was written. However, TeX's -\special primitive can be used to instruct TeX to write +\special primitive can be used to instruct TeX to write special directives into its .dvi output file. These directives are not interpreted by TeX in any way; they are intended for programs which process the .dvi files produced by TeX, be it printing or converting to other formats, such as -.ps or .pdf. +.ps or .pdf.

    Another approach is to extend the original TeX engine with the ability to generate one of the hyperlinking formats; TeX's set of @@ -3443,15 +3488,15 @@ provides three drivers: hypertex (implementation of the HyperTeX standard, see http://arxiv.org/hypertex), and pdftex and dvipdfm (named after the programs which process the hyperlink commands, -pdfTeX and -dvipdfm). Therefore, Eplain can only produce HyperTeX commands and +pdfTeX and +dvipdfm). Therefore, Eplain can only produce HyperTeX commands and hyperlink commands for one of these two programs—except that the extended dvipdfmx program can be used as well as the original dvipdfm, since they are compatible.

    To tell Eplain which .dvi processor or extended TeX engine you are using, use the command -\enablehyperlinks. +\enablehyperlinks.

    For example: @@ -3462,7 +3507,7 @@ driver to use, as follows: if it detects pdfTeX in PDF mode, it loads the pdftex driver. If it does not detect pdfTeX in PDF mode, the hypertex driver is loaded. The detection is based on the -\ifpdf switch (see Checking for PDF output). +\ifpdf switch (see Checking for PDF output).

    If necessary, you can explicitly specify the driver name: @@ -3498,26 +3543,26 @@ destinations jointly, in which case we will use the term destinations in cases when we need to refer specifically to links or destinations. -

    Hyperlink drivers provide several kinds of links and destinations. We +

    Hyperlink drivers provide several kinds of links and destinations. We will refer to them as link types and destination types.

    For example, one of the destination types that the pdftex -driver provides is the `xyz' type; when the user follows a link -pointing to an `xyz' destination, the exact location marked by +driver provides is the ‘xyz’ type; when the user follows a link +pointing to an ‘xyz’ destination, the exact location marked by that destination is displayed. Another destination type provided by -the pdftex driver is the `fit' type; when the user follows -a link pointing to a `fit' destination, the page containing that +the pdftex driver is the ‘fit’ type; when the user follows +a link pointing to a ‘fit’ destination, the page containing that destination is zoomed to fit into the window in which the document is displayed.

    Similarly, drivers support various link types. For example, with the pdftex driver, the usual link type used to refer to -destinations in the current document is called `name'. You can +destinations in the current document is called ‘name’. You can also create a link pointing to another local document (by using the -`filename' link type) or to a URL (by using the -`url' link type). +‘filename’ link type) or to a URL (by using the +‘url’ link type). -

    In addition, each hyperlink driver supports a number of destination and +

    In addition, each hyperlink driver supports a number of destination and link options. By setting these options you can customize hyperlink parameters (e.g., the thickness of the border drawn around a hyperlink) or pass information to hyperlinks (for example, file name of @@ -3527,8 +3572,8 @@ a document, for a link pointing to a destination in another document). options supported by the drivers. See Setting hyperlink types and options, for the information on how to set hyperlink options.

    -


    +


    Next: , Previous: Introduction to hyperlinks, Up: Hyperlinks @@ -3537,7 +3582,7 @@ Up: Hyperlinks

    5.2 Explicit hyperlinks

    -

    Explicit hyperlinks are created by you, in the source of your +

    Explicit hyperlinks are created by you, in the source of your document. The simplest command is \hldest, which marks the current position in your document as a destination: @@ -3552,11 +3597,11 @@ destination. For example, with the pdftex driver, the command

         \hldest{xyz}{zoom=2000}{index}
     
    -

    creates a destination of type `xyz' (“the current +

    creates a destination of type ‘xyz’ (“the current position”), sets the magnification ratio for this destination to be 200%, and associates the label index with the destination. -

    Another command, \hlstart, paired with \hlend, turns all +

    Another command, \hlstart, paired with \hlend, turns all intervening material into a link:

         \hlstart{type}{options}{label} ... \hlend
    @@ -3567,14 +3612,14 @@ meaning as for \hldest.  Continuing the previous example,
     
         \hlstart{name}{bstyle=U,bwidth=2}{index} Index\hlend
     

    typesets the word `Index' as a link with underline border of -width PostScript points, pointing to the named destination +width 2 PostScript points, pointing to the named destination index defined in the previous example. (The other options, like highlight mode and border color, are determined by the defaults, see Setting default types and options).

    The label argument of both \hldest and \hlstart -can contain special characters (such as `#', `%', `&', -`~', etc.) without any escaping. This is especially important +can contain special characters (such as ‘#’, ‘%’, ‘&’, +‘~’, etc.) without any escaping. This is especially important for URL links supported by some drivers (see Hyperlink drivers).

    Both \hldest and \hlstart ignore following spaces. @@ -3592,8 +3637,8 @@ pass it for the options. For example: explicit hyperlinks.

    -


    +


    Next: , Previous: Explicit hyperlinks, Up: Hyperlinks @@ -3602,11 +3647,11 @@ Up: Hyperlinks

    5.3 Implicit hyperlinks

    -

    Implicit hyperlinks are hyperlinks created implicitly by various +

    Implicit hyperlinks are hyperlinks created implicitly by various Eplain macros, such as the macros for citations, cross-references, indexing, etc. -

    All such macros are divided into link groups and +

    All such macros are divided into link groups and destination groups (or linkgroups and destgroups for short) so that parameters can be set individually for each group. For example, all equation macros which define a destination are assigned @@ -3647,8 +3692,8 @@ and the hyperlink support provided.

    -


    +


    Next: , Up: Implicit hyperlinks @@ -3656,29 +3701,30 @@ Up: Implicit hyperlin

    5.3.1 General hyperlinks: hrefint, hrefext

    -

    \href{url}{text} typesets text as a link +

    \href{url}{text} typesets text as a link to url. It basically does what the explicit hyperlink macros do (see Explicit hyperlinks), but is more convenient (at the expense of flexibility). -

    If url starts with `#', the rest of url is assumed to +

    If url starts with ‘#’, the rest of url is assumed to be a local hyperlink destination name (destination within the same document). Parameters for these links can be set by customizing the -`hrefint' linkgroup. For example: +`hrefint' linkgroup. For example:

         See \href{#intro}{Introduction}
     

    will make `Introduction' into an internal link, which might have been created, e.g., with \xrdef{intro}. -

    If url does not start with `#', it is assumed to be a +

    If url does not start with ‘#’, it is assumed to be a URL link. Parameters for these links can be set by customizing the -`hrefext' linkgroup. The special characters (such as `#' and -`~') in the URL don't need to be escaped. For example: +`hrefext' linkgroup. The special characters (such as ‘#’ and +‘~’) in the URL don't need to be escaped. For example:

         \href{http://tug.org/eplain/doc/eplain.html#Hyperlinks}{Hyperlinks
    -     in Eplain}
    +       in Eplain}
    +     \href{mailto:tex-eplain@tug.org}{Eplain mailing list}
     

    See URL hyperlinks, for another way to create URL hyperlinks. @@ -3690,12 +3736,12 @@ catcodes. For example:

         \href{#WeirdChars}{The weird chars \verbatim #&%$~|endverbatim}
     

    \href does not currently handle other link types, such as -`file:' and -`run:' links. +file:’ and +run:’ links.

    -


    +


    Next: , Previous: General hyperlinks, Up: Implicit hyperlinks @@ -3704,12 +3750,12 @@ Up: Implicit hyperlin

    5.3.2 URL hyperlinks: url

    -

    The `url' linkgroup covers the -\url command from the LaTeX package -url (see Packages known to work), as well as any new +

    The `url' linkgroup covers the +\url command from the LaTeX package +url (see Packages known to work), as well as any new \url-like commands you define. The type for this linkgroup is -set to `url' by the drivers which support this link type. -`url' links use the parameter to the \url command as the +set to ‘url’ by the drivers which support this link type. +‘url’ links use the parameter to the \url command as the URL to point to.

    You may be using the \url command to typeset something other than @@ -3717,12 +3763,12 @@ a URL, e.g., a path, for which you do not want a link to be created; in that case, you can disable the `url' linkgroup with the command \hloff[url] (see Turning hyperlinks on/off for a group). -

    By default, URL (and other types of) links are boxed, so +

    By default, URL (and other types of) links are boxed, so that they are visually marked even if you do not load the LaTeX -`color' package (see Loading LaTeX packages) and therefore link text +`color' package (see Loading LaTeX packages) and therefore link text is not colored. You can see the effect by compiling the following code snippet (be sure to get a modern url.sty, older versions do not -work in plain TeX; see Packages known to work): +work in plain TeX; see Packages known to work):

         \input eplain
          \beginpackages
    @@ -3732,6 +3778,9 @@ work in plain TeX; see Packag
          \enablehyperlinks
          
          \url{http://foo/bar}
    +     
    +     \url{mailto:foobar@example.org}
    +     
          \bye
     

    If the hyperlink driver you use supports the link option bwidth @@ -3748,6 +3797,9 @@ border around them. Try this: \hlopts{bwidth=0} \url{http://foo/bar} + + \url{mailto:foobar@example.org} + \bye

    The command \hlopts{bwidth=0} sets border width to @@ -3757,8 +3809,8 @@ apply to URL links only, say \hlopts[url]{bwidth=0}Setting hyperlink types and options).

    -


    +


    Next: , Previous: URL hyperlinks, Up: Implicit hyperlinks @@ -3767,12 +3819,12 @@ Up: Implicit hyperlin

    5.3.3 Citation hyperlinks: cite, bib

    -

    The `cite' linkgroup includes only the \cite command +

    The `cite' linkgroup includes only the \cite command (see Citations). \cite turns each of the references in the list into a link pointing to the respective bibliography entry produced by the \bibliography command. -

    The `bib' destgroup includes the macros related to the +

    The `bib' destgroup includes the macros related to the \bibliography command (see Citations). \bibliography inputs a .bbl file, which contains a list of bibliography entries. For each of the entries, a destination is defined. @@ -3780,8 +3832,8 @@ entries. For each of the entries, a destination is defined.

    Both commands use the citation label as the hyperlink label.

    -


    +


    Next: , Previous: Citation hyperlinks, Up: Implicit hyperlinks @@ -3790,15 +3842,15 @@ Up: Implicit hyperlin

    5.3.4 List hyperlinks: li

    -

    The `li' destgroup consists of the \li command (see Lists), +

    The `li' destgroup consists of the \li command (see Lists), which defines a destination if you supply the optional argument (cross-reference label). This label is also used as the hyperlink label.

    -


    +


    Next: , Previous: List hyperlinks, Up: Implicit hyperlinks @@ -3807,35 +3859,35 @@ Up: Implicit hyperlin

    5.3.5 Cross-reference hyperlinks: definexref, ref

    -

    The `definexref' destgroup is for the \definexref command +

    The `definexref' destgroup is for the \definexref command (see Defining generic references). \definexref defines a destination using the cross-reference label (the first argument) as the hyperlink label. -

    The `ref' linkgroup includes \refn and \xrefn (they are +

    The `ref' linkgroup includes \refn and \xrefn (they are synonyms), \ref, and \refs (see Using generic references). -

    \refn turns the cross-reference it produces into a link, using +

    \refn turns the cross-reference it produces into a link, using the cross-reference label as the hyperlink label. If an optional argument is present, it is tied by -\reftie to the reference and become part of the link. +\reftie to the reference and become part of the link. -

    \ref works similarly to \refn. It takes an optional +

    \ref works similarly to \refn. It takes an optional argument, which is treated the same way as the optional argument to \refn. In addition, \ref can produce a “class word”. Both the optional argument and the class word become part of the link, when present. The cross-reference is tied by -\reftie to the preceding word. The optional argument is +\reftie to the preceding word. The optional argument is separated from the class word by -\refspace. +\refspace. -

    Unlike \ref, \refs does not take an optional argument and +

    Unlike \ref, \refs does not take an optional argument and does not make the class word part of the link, which is appropriate for its intended use.

    -


    +


    Next: , Previous: Cross-reference hyperlinks, Up: Implicit hyperlinks @@ -3844,18 +3896,18 @@ Up: Implicit hyperlin

    5.3.6 Page reference hyperlinks: xrdef, xref

    -

    The `xrdef' destgroup is for \xrdef (see Page references). +

    The `xrdef' destgroup is for \xrdef (see Page references). \xrdef defines a destination using cross-reference label as the hyperlink label. -

    The `xref' linkgroup includes the \xref command (see Page references). \xref turns its optional argument (followed by +

    The `xref' linkgroup includes the \xref command (see Page references). \xref turns its optional argument (followed by \refspace), \xrefpageword and the cross-reference (page number) into a link, using the cross-reference label as the hyperlink label.

    -


    +


    Next: , Previous: Page reference hyperlinks, Up: Implicit hyperlinks @@ -3864,7 +3916,7 @@ Up: Implicit hyperlin

    5.3.7 Equation reference hyperlinks: eq

    -

    All commands that define equation labels are part of the `eq' destgroup. +

    All commands that define equation labels are part of the `eq' destgroup. These are \eqdef, \eqdefn, \eqsubdef and \eqsubdefn (see Equation references). All these commands use the equation label as the hyperlink label. However, if the equation @@ -3872,21 +3924,21 @@ label is empty, they make up a (hopefully) unique hyperlink label for the destination. This label will be used for the link when you refer to this empty-labeled equation with one of the equation reference macros. -

    The command \phantomeqlabel is called to generate hyperlink +

    The command \phantomeqlabel is called to generate hyperlink labels for the empty-labeled equations. By default, it produces the -labels in the format `PHEQnumber', where number comes +labels in the format ‘PHEQnumber’, where number comes from the count register \phantomeqnumber; this count register is incremented at every empty-labeled equation definition. -

    The commands \eqref and \eqrefn (see Equation references) form the `eq' linkgroup. These commands take an optional +

    The commands \eqref and \eqrefn (see Equation references) form the `eq' linkgroup. These commands take an optional argument, which, when present, is tied with \reftie to the equation reference and becomes part of the link. The equation label is used for the hyperlink label; if the label is empty, the link is for the label generated for the last empty-labeled equation.

    -


    +


    Next: , Previous: Equation reference hyperlinks, Up: Implicit hyperlinks @@ -3895,15 +3947,15 @@ Up: Implicit hyperlin

    5.3.8 Index hyperlinks: idx

    -

    All indexing commands (\idx, \idxname, \idxmarked, +

    All indexing commands (\idx, \idxname, \idxmarked, \idxsubmarked and their silent equivalents, see Indexing commands) form the `idx' destgroup. The `idx' linkgroup consists of the macros which are used to typeset the index when you say -\readindexfile{index-letter} (see Typesetting an index). +\readindexfile{index-letter} (see Typesetting an index). -

    To create the links in index entries, Eplain uses MakeIndex's +

    To create the links in index entries, Eplain uses MakeIndex's “encapsulation” feature. When you use an indexing macro to mark an index term, Eplain writes out a line to the -.idx file of the following general form: +.idx file of the following general form:

         \indexentry{entry|pagemarkup}{pageno}
     
    @@ -3915,7 +3967,7 @@ and pageno is the page number on which the term appeared. When processing the .idx file, MakeIndex makes the page number an argument to the page markup command (“encapsulates” the page number), so the page number in the -.ind file appears as \cs{pageno}. Eplain +.ind file appears as \cs{pageno}. Eplain internally replaces the cs command name with its own command, which, in addition to calling the original \cs encapsulator, turns the page number into a link. @@ -3932,8 +3984,8 @@ locations of index terms in the text.
    -


    +


    Next: , Up: Index hyperlinks @@ -3948,7 +4000,7 @@ writes to the .idx file becomes
         \indexentry{entry|hlidx{label}{cs}}{pageno}
     
    -

    where \hlidx is the command that is defined by Eplain +

    where \hlidx is the command that is defined by Eplain to take three arguments: a hyperlink label (label), a name of page number encapsulator (cs) and a page number (pageno). In the .ind file that MakeIndex will generate, the page number @@ -3961,19 +4013,19 @@ will now appear as label destination.

    The hyperlink labels for the index terms are generated by the -\hlidxlabel command, by default in the format -`IDXnumber', where number is the value of the count +\hlidxlabel command, by default in the format +‘IDXnumber’, where number is the value of the count register -\hlidxlabelnumber. This count register is incremented at each +\hlidxlabelnumber. This count register is incremented at each index term. -

    The advantage of this approach, as compared to the second approach +

    The advantage of this approach, as compared to the second approach described below, is that links in the index point to exact locations of the indexed terms on the page. The disadvantage of this approach is that MakeIndex will regard all index entries as distinct, because each one contains a (unique) hyperlink label. This disadvantage can be partially overcome by the script -idxuniq distributed with Eplain in the util directory. +idxuniq distributed with Eplain in the util directory. This script filters out \indexentry lines differing only in the hyperlink label but identical otherwise. You should process the .idx with this script before passing it on to MakeIndex. For @@ -3988,8 +4040,8 @@ entry appears on the same page as another entry with the same definition; idxuniq will not filter out the second entry).

    -


    +


    Next: , Previous: Exact destinations for index terms, Up: Index hyperlinks @@ -4004,16 +4056,16 @@ number encapsulator which can parse the page number and generate a link pointing to the page on which the term appeared. On top of each page containing an index term, Eplain defines a destination with label produced by -\hlidxpagelabel. The \hlidxpagelabel command takes a +\hlidxpagelabel. The \hlidxpagelabel command takes a single argument (page number number) and by default produces the -label in the format `IDXPGnumber'. +label in the format ‘IDXPGnumber’.

    With this approach, the \indexentry line which Eplain writes to the .idx file looks like this:

         \indexentry{entry|hlidxpage{cs}}{pageno}
     
    -

    where \hlidxpage is the command that is defined by Eplain +

    where \hlidxpage is the command that is defined by Eplain to take two arguments: a name of page number encapsulator (cs) and a page number (pageno). In the .ind file that MakeIndex will generate, the page number will appear as @@ -4025,13 +4077,13 @@ intact. The drawback is that links in the index do not point to exact locations of indexed terms on a page, but to the top of a page on which the term appears. -

    Another disadvantage is that this approach depends on the page range and +

    Another disadvantage is that this approach depends on the page range and page list separators which MakeIndex was configured to output. \hlidxpage must be able to parse the first page number in a page -range like `1--4'. In addition, page list parsing is needed +range like ‘1--4’. In addition, page list parsing is needed because MakeIndex combines two consecutive page numbers in one call to the page number encapsulator, so \hlidxpage can be passed, e.g., -`1, 2' for the pageno. In this last case, \hlidxpage +‘1, 2’ for the pageno. In this last case, \hlidxpage splits the two page numbers, applies \cs to each of them, and makes each of the page numbers a link to the appropriate page. Note that this will alter typesetting slightly, because now the page list @@ -4039,8 +4091,8 @@ separator (a comma followed by a space, by default) is not typeset using the page number encapsulator (\cs).

    Eplain's defaults for the page list and page number delimiters are the -same as those in MakeIndex, a comma followed by a space (`, ') and -two dashes (`--'), respectively. If you customize MakeIndex to use +same as those in MakeIndex, a comma followed by a space (‘, ’) and +two dashes (‘--’), respectively. If you customize MakeIndex to use different delimiters, you must not forget to let Eplain know about them with the commands @@ -4050,8 +4102,8 @@ with the commands

    (see Page list and page range parsers).

    -


    +


    Next: , Previous: Page destinations for index terms, Up: Index hyperlinks @@ -4060,13 +4112,13 @@ Up: Index hyperlinks
    5.3.8.3 Choosing destination placement
    -

    The approach that Eplain should use for the index terms can be +

    The approach that Eplain should use for the index terms can be selected in the -\enablehyperlinks command. The optional argument it accepts is +\enablehyperlinks command. The optional argument it accepts is a comma-separated list of options. The -idxexact option selects the first approach, -idxpage the second, and -idxnone disables hyperlink support for the index terms +idxexact option selects the first approach, +idxpage the second, and +idxnone disables hyperlink support for the index terms altogether, in case you want to stop Eplain from writing its link wrappers into the .idx file. The default is idxpage. @@ -4077,8 +4129,8 @@ wrappers into the .idx file. The default

    selects the first approach (“exact index links”).

    -


    +


    Next: , Previous: Choosing destination placement, Up: Index hyperlinks @@ -4093,8 +4145,8 @@ when defining page number encapsulators. See -


    +


    Previous: Index page list and page range parsers, Up: Index hyperlinks @@ -4102,11 +4154,11 @@ Up: Index hyperlinks
    5.3.8.5 Hyperlinks in see and see also entries
    -

    There is no automatic support for hyperlinks with “see” and “see +

    There is no automatic support for hyperlinks with “see” and “see also” index entries, as there is not enough information to trace the parameters of -\indexsee and -\indexseealso to corresponding index entries. But if desired, +\indexsee and +\indexseealso to corresponding index entries. But if desired, this can be implemented with \hldest and \hlstart (see Explicit hyperlinks); for example: @@ -4117,8 +4169,8 @@ this can be implemented with \hldest and \hlstart {\hlstart{}{}{idx:theo truth}semantic theory of truth\hlend}

    -


    +


    Next: , Previous: Index hyperlinks, Up: Implicit hyperlinks @@ -4127,19 +4179,19 @@ Up: Implicit hyperlin

    5.3.9 Footnote hyperlinks: foot, footback

    -

    The `foot' link and destination groups include the -\numberedfootnote and -\footnote macros (see Footnotes). The `footback' groups +

    The `foot' link and destination groups include the +\numberedfootnote and +\footnote macros (see Footnotes). The `footback' groups include the same macros, but control parameters for links and destinations created inside the footnote to point back to the footnote mark within the text body.

    The macros use hyperlink labels generated by -\hlfootlabel and -\hlfootbacklabel. The default formats for the labels are -`FOOTnumber' and `FOOTBnumber', respectively, +\hlfootlabel and +\hlfootbacklabel. The default formats for the labels are +‘FOOTnumber’ and ‘FOOTBnumber’, respectively, where number is the value of the count register -\hlfootlabelnumber. This register is incremented at every +\hlfootlabelnumber. This register is incremented at every footnote.

    Generally, footnote hyperlinks are not of much use, because the @@ -4152,8 +4204,8 @@ hyperlinks (see Turning hyp \hlon[foot,footback]

    -


    +


    Previous: Footnote hyperlinks, Up: Implicit hyperlinks @@ -4161,14 +4213,14 @@ Up: Implicit hyperlin

    5.3.10 Contents hyperlinks

    -

    There is currently no special support for hyperlinks in the table of +

    There is currently no special support for hyperlinks in the table of contents (see Contents), but implementing them with the \hldest and \hlstart ... \hlend commands (see Explicit hyperlinks) should be possible.

    -


    +


    Next: , Previous: Implicit hyperlinks, Up: Hyperlinks @@ -4182,7 +4234,7 @@ they support, and the options they accept. During the first reading, you may only want to skim through this section.

    Some of the descriptions below come from Portable Document Format -Reference Manual Version 1.3, March 11, 1999. +Reference Manual Version 1.3, March 11, 1999.

    -


    +


    Next: , Up: Hyperlink drivers @@ -4201,20 +4253,20 @@ Up: Hyperlink drivers5.4.1 Options supported by all drivers -

    This subsection describes the destination and link options which are +

    This subsection describes the destination and link options which are supported by all hyperlink drivers.

    Destination options supported by all drivers
    -

    +

    -
    raise
    Specifies how much to raise destinations above the baseline. When set +
    raise
    Specifies how much to raise destinations above the baseline. When set to zero or empty, destinations are placed at the baseline.

    It is usually convenient to set this option to some variable parameter, so that the height to which destinations are raised is automatically adjusted according to the current context. For example, setting it to -\normalbaselineskip (or some fraction of it, like +\normalbaselineskip (or some fraction of it, like 1.7\normalbaselineskip) makes the setting appropriate for different point sizes, in case your document uses more than one. @@ -4222,16 +4274,16 @@ different point sizes, in case your document uses more than one. destgroups do not define this option, so they fall back on the default, except for the `eq' destgroup, for which this option is set to 1.7\normalbaselineskip, -to accommodate the usual cases of large operators in displayed math. +to accommodate the usual cases of large operators in displayed math.

    Example: \hldestopts[eq]{raise=2.5\normalbaselineskip}

    Link options supported by all drivers
    -

    +

    -
    colormodel
    color
    These two options define the color to be used for rendering the link +
    colormodel
    color
    These two options define the color to be used for rendering the link text. The colors are used only when a \color command is defined, e.g., by loading the LaTeX `color' package (see Packages known to work). The \color command is called as \color[colormodel]{color}, where colormodel @@ -4256,12 +4308,12 @@ an empty colormodel (see examples below). \definecolor{mycolor}{rgb}{.3,.8,.95} \hlopts{colormodel=,color=mycolor}% custom color \hlopts{colormodel=gray,color=.4} - +
    -


    +


    Next: , Previous: Options supported by all drivers, Up: Hyperlink drivers @@ -4270,19 +4322,19 @@ Up: Hyperlink drivers5.4.2 Hyperlink driver hypertex -

    HyperTeX is a standard for inclusion of hyperlink information in +

    HyperTeX is a standard for inclusion of hyperlink information in TeX (and LaTeX) documents (see http://arxiv.org/hypertex). This standard defines a set of hyperlink tags implemented as \special commands written into the DVI file. The major advantage of such standard is that a single .dvi file containing HyperTeX commands can be viewed by any HyperTeX-enabled viewer (e.g., any more or less modern version of -xdvi) or converted to other file formats (e.g., PDF) +xdvi) or converted to other file formats (e.g., PDF) by any HyperTeX-enabled DVI converter (e.g., -dvipdfmx or -dvips with -Ghostscript's -ps2pdf script). +dvipdfmx or +dvips with +Ghostscript's +ps2pdf script).

    The downside to the standard is that it is by design “the common factor” of other formats supporting hyperlinks, so many features of a @@ -4301,21 +4353,21 @@ please see

    For convenience, we list a few HyperTeX-enabled converters: - +

    dvips
    Note that you need to pass the -z option to dvips to tell it to preserve the information about the hyperlinks. To generate a .pdf file with hyperlinks, you can use the -ps2pdf script of -Ghostscript. For example, if foo.tex is a TeX file using +ps2pdf script of +Ghostscript. For example, if foo.tex is a TeX file using HyperTeX commands, then
              prompt$ tex foo.tex
               prompt$ dvips -z foo.dvi -o
               prompt$ ps2pdf foo.ps
    -     
    +

    will produce foo.pdf with hyperlinks. -

    dvipdfm
    dvipdfmx
    No special command line arguments are required, these programs +
    dvipdfm
    dvipdfmx
    No special command line arguments are required, these programs automatically detect the HyperTeX commands.
    @@ -4323,12 +4375,12 @@ automatically detect the HyperTeX commands.

    One more note is in place: support for the HyperTeX commands varies from one previewer/converter to another, so you might need to experiment to see if what you need is supported by the program(s) you intend to -use. For example, dvips(k) as of version 5.92b converts all +use. For example, dvips(k) as of version 5.92b converts all internal hyperlinks into page links pointing to a page containing the destination, so that “exact” linking to destinations is not possible (this was confirmed to be a bug and most probably has already been fixed -in later versions of dvips(k)); dvipdfm as of version 0.13.2c and -dvipdfmx as of version 20040411 do not correctly parse links to +in later versions of dvips(k)); dvipdfm as of version 0.13.2c and +dvipdfmx as of version 20040411 do not correctly parse links to external local files, and produce a URL link instead of a file link. @@ -4340,8 +4392,8 @@ file link.

    -


    +


    Next: , Up: Hyperlink driver hypertex @@ -4349,19 +4401,19 @@ Up: Hyperlink d
    5.4.2.1 Destination types for hypertex
    -

    +

    -
    xyz
    “Current position”. This is the default type. +
    xyz
    “Current position”. This is the default type.

    Example: \hldest{xyz}{}{dest123} -

    raw
    The destination specification (in the form of a HyperTeX +
    raw
    The destination specification (in the form of a HyperTeX \special) is taken from the command sequence \cs, where cs is the value of the -cmd option. In the definition of \cs, use -\@hllabel to refer to the hyperlink label. This option is +cmd option. In the definition of \cs, use +\@hllabel to refer to the hyperlink label. This option is intended to be used with destgroups (see Setting hyperlink types and options), as it does not make sense in a direct call to -\hldest—you can just call the raw command. +\hldest—you can just call the raw command.

    Example: @@ -4371,12 +4423,12 @@ intended to be used with destgroups (see -


    +


    Next: , Previous: Destination types for hypertex, Up: Hyperlink driver hypertex @@ -4385,9 +4437,9 @@ Up: Hyperlink d
    5.4.2.2 Destination options for hypertex
    -

    +

    -
    cmd
    Name of the macro (without the leading `\') containing a +
    cmd
    Name of the macro (without the leading ‘\’) containing a HyperTeX \special for the raw destination.

    See Destination types for hypertex, the description of the raw @@ -4395,8 +4447,8 @@ destination, for an example.

    -


    +


    Next: , Previous: Destination options for hypertex, Up: Hyperlink driver hypertex @@ -4405,25 +4457,25 @@ Up: Hyperlink d
    5.4.2.3 Link types for hypertex
    -

    +

    -
    name
    Go to a “named destination”. The label is the destination name. All +
    name
    Go to a “named destination”. The label is the destination name. All destinations in HyperTeX are named destinations. This is the default type.

    Example: \hlstart{name}{}{dest123}Link to dest123\hlend -

    url
    Go to a URL. The label is the URL. +
    url
    Go to a URL. The label is the URL.

    Example:

              \hlstart{url}{}{http://tug.org/eplain/}Eplain home\hlend
    -     
    -
    filename
    Go to a named destination in another file. The label is the + +
    filename
    Go to a named destination in another file. The label is the destination name. The file name is specified by the -file option. The file name extension can be specified separately +file option. The file name extension can be specified separately by the -ext option. The idea is to set the ext option globally at +ext option. The idea is to set the ext option globally at the beginning of the document to avoid hard-coding the extension together with the file name within each link—HyperTeX is not restricted to any single output format, it can be DVI, @@ -4434,16 +4486,16 @@ restricted to any single output format, it can be DVI,
              \hlopts{ext=.pdf}
               \hlstart{filename}{file=book}{dest123}
                 Link to dest123 in file `book.pdf'\hlend
    -     
    -
    raw
    The link specification (in the form of a HyperTeX \special) is + +
    raw
    The link specification (in the form of a HyperTeX \special) is taken from the command sequence \cs, where cs is the value of the -cmd option. In the definition of \cs, use -\@hllabel to refer to the hyperlink label. Use the predefined +cmd option. In the definition of \cs, use +\@hllabel to refer to the hyperlink label. Use the predefined command -\hlhash to insert the # characters. This option is +\hlhash to insert the # characters. This option is intended to be used with linkgroups (see Setting hyperlink types and options), as it does not make sense in a direct call to -\hlstart—you can just call the raw command. +\hlstart—you can just call the raw command.

    Example: @@ -4452,12 +4504,12 @@ intended to be used with linkgroups (see -


    +


    Previous: Link types for hypertex, Up: Hyperlink driver hypertex @@ -4465,21 +4517,21 @@ Up: Hyperlink d
    5.4.2.4 Link options for hypertex
    -

    +

    -
    cmd
    Name of the macro (without the leading `\') containing a +
    cmd
    Name of the macro (without the leading ‘\’) containing a HyperTeX \special for the raw link.

    See Link types for hypertex, the description of the raw link, for an example. -

    file
    File name for the filename link type. See also the ext +
    file
    File name for the filename link type. See also the ext option.

    See Link types for hypertex, the description of the filename link, for an example. -

    ext
    File name extension for the filename link type. The idea is to +
    ext
    File name extension for the filename link type. The idea is to set the ext option globally at the beginning of the document to avoid hard-coding the extension together with the file name within each link—HyperTeX is not restricted to any single output format, it can @@ -4490,8 +4542,8 @@ link, for an example.
    -


    +


    Next: , Previous: Hyperlink driver hypertex, Up: Hyperlink drivers @@ -4500,7 +4552,7 @@ Up: Hyperlink drivers5.4.3 Hyperlink drivers pdftex and dvipdfm -

    This subsection describes link and destination types and options +

    This subsection describes link and destination types and options supported by the pdftex and dvipdfm drivers. Many of the hyperlink types and options are common to both drivers, so we describe them together. @@ -4513,8 +4565,8 @@ them together.

    -


    +


    Next: , Up: Hyperlink drivers pdftex and dvipdfm @@ -4522,73 +4574,73 @@ Up: 
    5.4.3.1 Destination types for pdftex and dvipdfm
    -

    +

    -
    xyz
    “Current position”. The option -zoom specifies magnification to use (zero or empty means leave +
    xyz
    “Current position”. The option +zoom specifies magnification to use (zero or empty means leave magnification unchanged, which is the default). This is the default type.

    For dvipdfm: the options -left and -top specify position coordinates to use (empty options mean +left and +top specify position coordinates to use (empty options mean current position coordinate, which is the default).

    Example: \hldest{xyz}{zoom=2000}{dest123} -

    fit
    Fit the page to the window. +
    fit
    Fit the page to the window.

    Example: \hldest{fit}{}{dest123} -

    fith
    Fit the width of the page to the window. +
    fith
    Fit the width of the page to the window.

    For dvipdfm: the -top option specifies vertical position (default is empty, meaning +top option specifies vertical position (default is empty, meaning current position).

    Example: \hldest{fith}{}{dest123} -

    fitv
    Fit the height of the page to the window. +
    fitv
    Fit the height of the page to the window.

    For dvipdfm: The option -left specifies horizontal position (default is empty, meaning +left specifies horizontal position (default is empty, meaning current position).

    Example: \hldest{fitv}{}{dest123} -

    fitb
    Fit the page's bounding box to the window. +
    fitb
    Fit the page's bounding box to the window.

    Example: \hldest{fitb}{}{dest123} -

    fitbh
    Fit the width of the page's bounding box to the window. +
    fitbh
    Fit the width of the page's bounding box to the window.

    For dvipdfm: the option -top specifies vertical position (default is empty, meaning +top specifies vertical position (default is empty, meaning current position).

    Example: \hldest{fitbh}{}{dest123} -

    fitbv
    Fit the height of the page's bounding box to the window. +
    fitbv
    Fit the height of the page's bounding box to the window.

    For dvipdfm: the option -left specifies horizontal position (default is empty, meaning +left specifies horizontal position (default is empty, meaning current position).

    Example: \hldest{fitbv}{}{dest123} -

    fitr
    For pdftex: fit the rectangle specified by the options -width, -height and -depth (as a TeX rule specification) in the window. For +
    fitr
    For pdftex: fit the rectangle specified by the options +width, +height and +depth (as a TeX rule specification) in the window. For dimensions set to empty, the corresponding value of the parent box is used (these are the defaults).

    For dvipdfm: fit the rectangle specified by the options -left, -bottom, -right and -top (in -PostScript points, 72 points per inch) in the window. For +left, +bottom, +right and +top (in +PostScript points, 72 points per inch) in the window. For dimensions set to empty, current position coordinate is substituted (these are the defaults). @@ -4596,19 +4648,19 @@ dimensions set to empty, current position coordinate is substituted

              \hldest{fitr}{width=\hsize,
                             height=.5\vsize,depth=0pt}{dest123}
    -     
    +

    Example for dvipdfm:

              \hldest{fitr}{left=72,bottom=72,
                             right=720,top=360}{dest123}
    -     
    -
    raw
    The destination specification (in the form of a pdfTeX command or a + +
    raw
    The destination specification (in the form of a pdfTeX command or a dvipdfm \special) is taken from the command sequence \cs, where cs is the value of the -cmd option. In the definition of \cs, use -\@hllabel to refer to the hyperlink label. This option is +cmd option. In the definition of \cs, use +\@hllabel to refer to the hyperlink label. This option is intended to be used with destgroups (see Setting hyperlink types and options), as it does not make sense in a direct call to -\hldest—you can just call the raw command. +\hldest—you can just call the raw command.

    Example for pdftex: @@ -4617,7 +4669,7 @@ intended to be used with destgroups (see \makeatletter @@ -4626,12 +4678,12 @@ intended to be used with destgroups (see -


    +


    Next: , Previous: Destination types for pdftex and dvipdfm, Up: Hyperlink drivers pdftex and dvipdfm @@ -4640,7 +4692,7 @@ Up: 
    5.4.3.2 Destination options for pdftex and dvipdfm
    -

    With respect to the destination options, the pdftex and +

    With respect to the destination options, the pdftex and dvipdfm differ in the way the fit rectangle is specified (relative coordinates for pdftex, absolute coordinates for dvipdfm). @@ -4648,14 +4700,14 @@ Up: 

    Common destination options
    -
    cmd
    Name of the macro (without the leading `\') containing a +
    cmd
    Name of the macro (without the leading ‘\’) containing a pdfTeX command or a dvipdfm \special for the raw destination.

    See Destination types for pdftex and dvipdfm, the description of the raw destination, for an example. -

    zoom
    Magnification ratio times 1000 (like TeX's scale factor). +
    zoom
    Magnification ratio times 1000 (like TeX's scale factor). Zero or empty means leave magnification unchanged, which is the default. @@ -4670,49 +4722,49 @@ of the parent box is used (this is the default for all dimension options).
    -
    depth
    Depth of the fit rectangle for the fitr destination. +
    depth
    Depth of the fit rectangle for the fitr destination. -
    height
    Height of the fit rectangle for the fitr destination. +
    height
    Height of the fit rectangle for the fitr destination. -
    width
    Width of the fit rectangle for the fitr destination. +
    width
    Width of the fit rectangle for the fitr destination.

    Example:

              \hldest{fitr}{width=\hsize,
                             height=.5\vsize,depth=0pt}{dest123}
    -     
    +
    dvipdfm-specific destination options

    The dimension options below must be specified in -PostScript points (72 points per inch), as a number without the -`bp' unit name. When set to empty, the current position +PostScript points (72 points per inch), as a number without the +‘bp’ unit name. When set to empty, the current position coordinate is used (this is the default for all dimension options).

    -
    bottom
    Bottom position coordinate of a box specification for the various +
    bottom
    Bottom position coordinate of a box specification for the various destination types. -
    left
    Left position coordinate of a box specification for the various +
    left
    Left position coordinate of a box specification for the various destination types. -
    right
    Right position coordinate of a box specification for the various +
    right
    Right position coordinate of a box specification for the various destination types. -
    top
    Top position coordinate of a box specification for the various +
    top
    Top position coordinate of a box specification for the various destination types.

    Example:

              \hldest{fitr}{left=72,bottom=72,
                             right=720,top=360}{dest123}
    -     
    +
    -


    +


    Next: , Previous: Destination options for pdftex and dvipdfm, Up: Hyperlink drivers pdftex and dvipdfm @@ -4721,7 +4773,7 @@ Up: 
    5.4.3.3 Link types for pdftex and dvipdfm
    -

    Link types are the same for the pdftex and dvipdfm +

    Link types are the same for the pdftex and dvipdfm drivers, except that the pdftex driver provides one additional link type num (link to a numbered destination). dvipdfm does not support numbered destinations, therefore it does not have this link @@ -4732,42 +4784,42 @@ low-level pdfTeX commands.

    Common link types
    -
    name
    Go to a “named destination”. The label is the destination name. +
    name
    Go to a “named destination”. The label is the destination name. All destinations created with \hldest are named destinations (see Explicit hyperlinks). This is the default type.

    Example: \hlstart{name}{}{dest123}Link to dest123\hlend -

    url
    Go to a URL. The label is the URL. +
    url
    Go to a URL. The label is the URL.

    Example: \hlstart{url}{}{http://tug.org/eplain/}Eplain home\hlend -

    page
    Go to a page. The label is the page number (counting from 1). +
    page
    Go to a page. The label is the page number (counting from 1). Page fitting is specified by the -pagefit option. +pagefit option.

    Example:

              \hlstart{page}{pagefit=/FitH 600}{123}
                 Link to page~123\hlend
    -     
    -
    filename
    Go to a named destination in another file. The label is the + +
    filename
    Go to a named destination in another file. The label is the destination name. The file name is specified by the -file option. Page fitting is specified by the -pagefit option. The -newwin option specifies whether the destination document is +file option. Page fitting is specified by the +pagefit option. The +newwin option specifies whether the destination document is opened in the same window or in a new window.

    Example:

              \hlstart{filename}{file=book.pdf,newwin=1}{dest123}
                 Link to dest123 in file `book.pdf'\hlend
    -     
    -
    filepage
    Go to a page in another file. The label is the page number (counting -from 1). The file name is specified by the -file option. Page fitting is specified by the -pagefit option. The -newwin option specifies whether the destination document is + +
    filepage
    Go to a page in another file. The label is the page number (counting +from 1). The file name is specified by the +file option. Page fitting is specified by the +pagefit option. The +newwin option specifies whether the destination document is opened in the same window or in a new window.

    Example: @@ -4775,14 +4827,14 @@ opened in the same window or in a new window.

              \hlstart{filepage}{file=book.pdf,newwin=,
                                  pagefit=/FitR 50 100 300 500}{1}
                 Link to page~1 in file `book.pdf'\hlend
    -     
    -
    raw
    The link specification (in the form of a pdfTeX command or a dvipdfm + +
    raw
    The link specification (in the form of a pdfTeX command or a dvipdfm \special primitive) is taken from the command sequence \cs, where cs is the value of the -cmd option. In the definition of \cs, use -\@hllabel to refer to the hyperlink label. This option is +cmd option. In the definition of \cs, use +\@hllabel to refer to the hyperlink label. This option is intended to be used with linkgroups (see Setting hyperlink types and options), as it does not make sense in a direct call to -\hlstart—you can just call the raw command. +\hlstart—you can just call the raw command.

    Example for pdftex: @@ -4790,7 +4842,7 @@ intended to be used with linkgroups (see % Redirect all \url links to the first page @@ -4798,21 +4850,21 @@ intended to be used with linkgroups (see pdftex-specific link types

    -
    num
    Go to a “numbered destination”. The label is the destination +
    num
    Go to a “numbered destination”. The label is the destination number.

    Example: \hlstart{num}{}{123}Link to 123\hlend

    -


    +


    Previous: Link types for pdftex and dvipdfm, Up: Hyperlink drivers pdftex and dvipdfm @@ -4820,31 +4872,31 @@ Up: 
    5.4.3.4 Link options for pdftex and dvipdfm
    -

    Link options are mostly the same for the pdftex and +

    Link options are mostly the same for the pdftex and dvipdfm drivers. The pdftex driver has additional options to specify link dimensions.

    Common link options
    -
    bcolor
    Border color. An array of three numbers in the range 0 to 1, +
    bcolor
    Border color. An array of three numbers in the range 0 to 1, representing a color in DeviceRGB.

    Example: \hlstart{name}{bcolor=.1 .5 1}{dest123}Link\hlend -

    bdash
    Array of numbers representing on and off stroke lengths for drawing +
    bdash
    Array of numbers representing on and off stroke lengths for drawing dashes.

    Example: \hlstart{name}{bstyle=D,bdash=2 4}{dest123}Link\hlend -

    bstyle
    Link border style: +
    bstyle
    Link border style:
    S
    The border is drawn as a solid line.
    D
    The border is drawn with a dashed line (the dash pattern is specified by the -bdash option). +bdash option).
    B
    The border is drawn in a beveled style. @@ -4853,27 +4905,27 @@ by the
    U
    The border is drawn as a line on the bottom of the link rectangle.
    -

    The default is `S'. +

    The default is ‘S’.

    Example: \hlstart{name}{bstyle=D,bdash=2 4}{dest123}Link\hlend -

    bwidth
    Border width in -PostScript points (72 points per inch). The default is 1. +
    bwidth
    Border width in +PostScript points (72 points per inch). The default is 1.

    Example: \hlstart{name}{bwidth=2}{dest123}Link\hlend -

    cmd
    Name of the macro (without the leading `\') containing a +
    cmd
    Name of the macro (without the leading ‘\’) containing a pdfTeX command or a dvipdfm \special for the raw link.

    See Link types for pdftex and dvipdfm, the description of the raw link, for an example. -

    file
    File name for the filename and filepage link types. +
    file
    File name for the filename and filepage link types.

    See Link types for pdftex and dvipdfm, the descriptions of the filename and filepage links, for an example. -

    hlight
    Link border highlight modes: +
    hlight
    Link border highlight modes:
    I
    The rectangle specified by the bounding box of the link is inverted. @@ -4886,11 +4938,11 @@ pdfTeX command or a dvipdfm \special for the raw link. the page.
    -

    The default is `I'. +

    The default is ‘I’.

    Example: \hlstart{name}{bstyle=S,hlight=O}{dest123}Link\hlend -

    newwin
    For the filename and filepage links, specifies whether the destination document is +
    newwin
    For the filename and filepage links, specifies whether the destination document is opened in the same window or in a new window. The settings are:
    @@ -4904,7 +4956,7 @@ opened in the same window or in a new window. The settings are:

    See Link types for pdftex and dvipdfm, the descriptions of the filename and filepage links, for an example. -

    pagefit
    For the page and filepage links, specifies how the page +
    pagefit
    For the page and filepage links, specifies how the page must be fitted to the window. pagefit specification is written to the PDF file as is, so it must conform to the PDF standard. @@ -4921,22 +4973,22 @@ of the parent box is used (this is the default for all dimension options).
    -
    depth
    Depth of the link. +
    depth
    Depth of the link. -
    height
    Height of the link. +
    height
    Height of the link. -
    width
    Width of the link. +
    width
    Width of the link.

    Example:

              \hlstart{name}{width=5in,height=20pc,depth=0pt}{dest123}
                 Link\hlend
    -     
    +
    -


    +


    Previous: Hyperlink drivers pdftex and dvipdfm, Up: Hyperlink drivers @@ -4944,13 +4996,13 @@ Up: Hyperlink drivers5.4.4 Hyperlink driver nolinks -

    Select this driver to suppress all hyperlinks in your document. +

    Select this driver to suppress all hyperlinks in your document.

    Selecting this driver is quite different from not selecting any driver at all, or from selecting some driver and then turning hyperlinks off for the entire document with -\hloff and -\hldestoff (see Turning hyperlinks on/off). +\hloff and +\hldestoff (see Turning hyperlinks on/off).

    The purpose of \hldestoff and \hloff is to mark (parts) of your document where hyperlinks should never appear. (Imagine you want @@ -4965,7 +5017,7 @@ same as what you were getting with hyperlinks enabled.

    The reason for this is that hyperlinks are produced by the \special primitives or low-level hyperlink commands. Each such command is placed inside a -whatsit (an internal TeX object), which may introduce +whatsit (an internal TeX object), which may introduce legitimate breakpoints at places where none would exist without the whatsits. The macros \hldestoff and \hloff disable the hyperlink macros completely, so that no whatsits are produced. @@ -4975,7 +5027,7 @@ hyperlink macros. Instead, it defines them to merely write to the log file (what gets written is unimportant). This also produces whatsits, thus imitating the whatsits from the hyperlink commands. (This trick was borrowed from the -LaTeX `color' package.) +LaTeX `color' package.)

    Another reason for using nolinks is that in horizontal mode \hldest places destinations inside boxes of zero width, height, @@ -4989,7 +5041,7 @@ defining \hldest to produce the empty boxes. document both with and without hyperlinks, here is the recommended way to enable the hyperlinks under pdfTeX: -

    +

         \ifpdf
            \enablehyperlinks
          \else
    @@ -4997,8 +5049,8 @@ to enable the hyperlinks under pdfTeX:
          \fi
     
    -


    +


    Next: , Previous: Hyperlink drivers, Up: Hyperlinks @@ -5007,14 +5059,14 @@ Up: Hyperlinks

    5.5 Setting hyperlink types and options

    -

    You can define default types for links and destinations, which will be +

    You can define default types for links and destinations, which will be used when you do not specify a type in -\hlstart or -\hldest. Similarly, you can define default values for the +\hlstart or +\hldest. Similarly, you can define default values for the options; the default value for an option is used when you do not set the option in the argument to \hlstart or \hldest. -

    The parameters for implicit links and destinations can be customized by +

    The parameters for implicit links and destinations can be customized by setting the “group” types and options. When not set, the defaults are used. @@ -5030,8 +5082,8 @@ previous settings are restored.

    -


    +


    Next: , Up: Setting hyperlink types and options @@ -5039,7 +5091,7 @@ Up: S

    5.5.1 Setting default types and options

    -

    The default types for links and destinations can be set with the +

    The default types for links and destinations can be set with the following commands:

         \hltype{type}
    @@ -5049,19 +5101,19 @@ following commands:
     link/destination types supported by the selected hyperlink driver
     (see Hyperlink drivers).
     
    -   

    Default values for the options can be set with the following commands: +

    Default values for the options can be set with the following commands:

         \hlopts{options}
          \hldestopts{options}
     

    where options is a comma-separated list of option -assignments in the format `option=value'. Again, what options +assignments in the format ‘option=value’. Again, what options are allowed depends on the selected hyperlink driver. -

    Many people regard the default boxed links as not aesthetic and +

    Many people regard the default boxed links as not aesthetic and intruding on page layout. The reason why boxed links are the default is that the links are not colored until you load the LaTeX -`color' package (see Loading LaTeX packages) or use other means to +`color' package (see Loading LaTeX packages) or use other means to define the \color command; therefore, not producing any kind of link border may result in the links not being marked in any way. However, when the links are actually colored, there is no need to @@ -5072,8 +5124,8 @@ option bwidth; see Hyperlink drivers \hlopts{bwidth=0}

    -


    +


    Next: , Previous: Setting default types and options, Up: Setting hyperlink types and options @@ -5082,7 +5134,7 @@ Up: S

    5.5.2 Setting group types

    -

    When called with an optional argument, as in +

    When called with an optional argument, as in

         \hltype[groups]{type}
          \hldesttype[groups]{type}
    @@ -5091,10 +5143,10 @@ Up: S
     \hltype and \hldesttype set the type for each group from
     groups to type.  The default type is used for all groups
     with an empty type (this is the initial setting for all groups, except
    -that the type for the `url' linkgroup is set to `url' by the
    +that the type for the `url' linkgroup is set to ‘url’ by the
     drivers which support this link type).
     
    -   

    There are two special “groups” which can be used inside the +

    There are two special “groups” which can be used inside the groups list. An empty group sets the default type. This allows to set the default type and group types in one command, for example: @@ -5103,7 +5155,7 @@ to set the default type and group types in one command, for example:

    sets the link type for the `eq' linkgroup and the default link type to type. -

    Another special group is a star (`*') group, which signifies all +

    Another special group is a star (‘*’) group, which signifies all defined groups. For example, the command

         \hldesttype[*,]{type}
    @@ -5112,8 +5164,8 @@ defined groups.  For example, the command
     as well as the default destination type.
     
     
    -


    +


    Previous: Setting group types, Up: Setting hyperlink types and options @@ -5121,12 +5173,12 @@ Up: S

    5.5.3 Setting group options

    -

    Option values for each group are stored as a list of option +

    Option values for each group are stored as a list of option assignments. This list does not have to contain every supported option. Values for options missing from this list are taken from the default option values. -

    To manipulate the list of option values for the groups, you use the +

    To manipulate the list of option values for the groups, you use the \hlopts and \hldestopts commands with an optional argument: @@ -5137,38 +5189,38 @@ argument:

    where groups is a comma-separated list of groups and options is a comma-separated list of option assignments. The -two special “groups”, the empty group and the star (`*') +two special “groups”, the empty group and the star (‘*’) group, have the same meaning as for \hltype and \hldesttype. -When used without the exclamation mark, \hlopts and +When used without the exclamation mark, \hlopts and \hldestopts preserve the current list of options for the groups, and only update the options listed in options. If you add the exclamation mark, the current list of options for each group in groups is discarded and the new list is set to options. -

    The “overriding” nature of the `!' is appropriate when you give +

    The “overriding” nature of the ‘!’ is appropriate when you give a complete specification of the options for a group, e.g., at the beginning of your document. On the other hand, when you want to adjust some option(s) and leave others intact, you should use the -macros without the `!'. +macros without the ‘!’. -

    For example, with displayed mathematical formulas, you often need to -adjust the `raise' option for the -`eq' destgroup, because the formulas often contain large parentheses and +

    For example, with displayed mathematical formulas, you often need to +adjust the ‘raise’ option for the +`eq' destgroup, because the formulas often contain large parentheses and brackets. But when doing so, you want to leave the other settings unchanged. To achieve this, call \hldestopts without the -`!', for example: +‘!’, for example:

         $$\hldestopts[eq]{raise=2.5\normalbaselineskip}
          ...
          $$
     
    -

    The display commands (`$$') implicitly put the entire +

    The display commands (‘$$’) implicitly put the entire formula inside a (TeX) group (\begingroup...\endgroup), so -you do not need to isolate the setting of the `raise' option—it -will be restored after the closing `$$'. +you do not need to isolate the setting of the ‘raise’ option—it +will be restored after the closing ‘$$’. -

    Initially, Eplain sets the option lists for almost all groups to empty, +

    Initially, Eplain sets the option lists for almost all groups to empty, so that the groups fall back on the default values for all options. The one exception to this rule is the `eq' destgroup, whose initial option list contains one setting: @@ -5179,9 +5231,9 @@ list contains one setting: appear in displayed math.

    -


    +


    Previous: Setting hyperlink types and options, Up: Hyperlinks @@ -5189,7 +5241,7 @@ Up: Hyperlinks

    5.6 Turning hyperlinks on/off

    -

    Links and/or destinations can be turned on or off globally by disabling +

    Links and/or destinations can be turned on or off globally by disabling the low-level commands, or for each group individually.

    All these settings are local to the current (TeX) group, so if you @@ -5203,9 +5255,9 @@ previous settings are restored.

    -


    +


    Next: , Up: Turning hyperlinks on/off @@ -5213,7 +5265,7 @@ Up: Turning

    5.6.1 Turning low-level commands on/off

    -

    The low-level commands \hlstart, \hlend and +

    The low-level commands \hlstart, \hlend and \hldest can be turned on/off with the following commands:

         \hldeston
    @@ -5225,9 +5277,9 @@ Up: Turning
     these commands to disable hyperlinks for the entire document.
     
     
    -


    +


    Previous: Turning low-level commands on/off, Up: Turning hyperlinks on/off @@ -5235,7 +5287,7 @@ Up: Turning

    5.6.2 Turning hyperlinks on/off for a group

    -

    If you want to disable links/destinations produced by certain groups, +

    If you want to disable links/destinations produced by certain groups, you can give a list of the groups as an optional argument to these commands: @@ -5247,7 +5299,7 @@ commands:

    where groups is the list of linkgroups/destgroups. This list can contain two special groups. The empty group switches the low-level commands (see Turning low-level commands on/off), and the -star (`*') group operates on all defined groups. +star (‘*’) group operates on all defined groups.

    Note that turning off the low-level commands disables all hyperlinks globally, including groups which have them enabled. Turning off certain @@ -5280,8 +5332,8 @@ assume that all links are on; after the following sequence of commands:

    -


    +


    Next: , Previous: Hyperlinks, Up: Top @@ -5300,8 +5352,8 @@ Up: Top
    -


    +


    Next: , Up: Arrow theoretic diagrams @@ -5310,14 +5362,14 @@ Up: Arrow theore

    6.1 Slanted lines and vectors

    The macros \drawline -and \drawvector -provide the capability found in LaTeX's -picture mode to draw slanted lines and vectors of certain directions. +and \drawvector +provide the capability found in LaTeX's +picture mode to draw slanted lines and vectors of certain directions. Both of these macros take three arguments: two integer arguments to specify the direction of the line or vector, and one argument to specify -its length. For example, `\drawvector(-4,1){60pt}' produces the +its length. For example, ‘\drawvector(-4,1){60pt}’ produces the vector -which lies in the 2d quadrant, has a slope of minus 1/4, and a width of +which lies in the 2d quadrant, has a slope of minus 1/4, and a width of 60 pt.

    Note that if an \hbox is placed around \drawline or @@ -5347,8 +5399,8 @@ it. Future enhancements will include macros to draw dotted lines and dotted vectors of various directions.

    -


    +


    Previous: Slanted lines and vectors, Up: Arrow theoretic diagrams @@ -5356,7 +5408,7 @@ Up: Arrow theore

    6.2 Commutative diagrams

    -

    +

    The primitive commands \drawline and \drawvector can be used to typeset arrow theoretic diagrams. This section describes (1) macros to facilitate typesetting arrows and morphisms, and (2) macros to @@ -5370,8 +5422,8 @@ described in this section must be used in math mode.

    -


    +


    Next: , Up: Commutative diagrams @@ -5379,56 +5431,56 @@ Up: Commutative diag

    6.2.1 Arrows and morphisms

    -

    +

    The macros \mapright and \mapleft produce right and left -pointing arrows, respectively. Use superscript (^) to place a -morphism above the arrow, e.g., `\mapright^\alpha'; use subscript +pointing arrows, respectively. Use superscript (^) to place a +morphism above the arrow, e.g., ‘\mapright^\alpha’; use subscript (_) to place a morphism below the arrow, e.g., -`\mapright_{\tilde l}'. Superscripts and subscripts may be used -simulataneously, e.g., `\mapright^\pi_{\rm epimor.}'. +‘\mapright_{\tilde l}’. Superscripts and subscripts may be used +simulataneously, e.g., ‘\mapright^\pi_{\rm epimor.}’.

    Similarly, the macros \mapup and \mapdown produce up and -down pointing arrows, respectively. Use \rt -to place a morphism to the right of the arrow, e.g., `\mapup\rt{\rm -id}'; use \lft -to place a morphism to the left of the arrow, e.g., `\mapup\lft\omega'. +down pointing arrows, respectively. Use \rt +to place a morphism to the right of the arrow, e.g., ‘\mapup\rt{\rm +id}’; use \lft +to place a morphism to the left of the arrow, e.g., ‘\mapup\lft\omega’. \lft and \rt may be used simultaneously, e.g., -`\mapdown\lft\pi\rt{\rm monomor.}'. +‘\mapdown\lft\pi\rt{\rm monomor.}’.

    Slanted arrows are produced by the macro \arrow, which takes -a direction argument (e.g., `\arrow(3,-4)'). Use \rt and +a direction argument (e.g., ‘\arrow(3,-4)’). Use \rt and \lft to place morphisms to the right and left, respectively, of the arrow. A slanted line (no arrowhead) is produced with the macro \sline, -whose syntax is identical to that of \arrow. +whose syntax is identical to that of \arrow.

    The length of these macros is predefined by the default TeX dimensions \harrowlength, -for horizontal arrows (or lines), +for horizontal arrows (or lines), \varrowlength, -for vertical arrows (or lines), and +for vertical arrows (or lines), and \sarrowlength, -for slanted arrows (or lines). To change any of these dimensions, say, -e.g., `\harrowlength=40pt'. As with all other TeX dimensions, +for slanted arrows (or lines). To change any of these dimensions, say, +e.g., ‘\harrowlength=40pt’. As with all other TeX dimensions, the change may be as global or as local as you like. Furthermore, the placement of morphisms on the arrows is controlled by the dimensions \hmorphposn, -\vmorphposn, -and \morphdist. -The first two dimensions control the horizontal and vertical position of +\vmorphposn, +and \morphdist. +The first two dimensions control the horizontal and vertical position of the morphism from its default position; the latter dimension controls the distance of the morphism from the arrow. If you have more than one morphism per arrow (i.e., a ^/_ or \lft/\rt construction), use the parameters \hmorphposnup, -\hmorphposndn, -\vmorphposnup, -\vmorphposndn, -\hmorphposnrt, -\hmorphposnlft, -\vmorphposnrt, -and \vmorphposnlft. -The default values of all these dimensions are provided in the section +\hmorphposndn, +\vmorphposnup, +\vmorphposndn, +\hmorphposnrt, +\hmorphposnlft, +\vmorphposnrt, +and \vmorphposnlft. +The default values of all these dimensions are provided in the section on parameters that follows below.

    There is a family of macros to produce horizontal lines, arrows, and @@ -5436,21 +5488,21 @@ adjoint arrows. The following macros produce horizontal maps and have the same syntax as \mapright:

    -
    \mapright
    $X\mapright Y$ +
    \mapright
    $X\mapright Y$ -
    \mapleft
    $X\mapleft Y$ +
    \mapleft
    $X\mapleft Y$ -
    \hline
    $X\hline Y$ +
    \hline
    $X\hline Y$ -
    \bimapright
    $X\bimapright Y$ +
    \bimapright
    $X\bimapright Y$ -
    \bimapleft
    $X\bimapleft Y$ +
    \bimapleft
    $X\bimapleft Y$ -
    \adjmapright
    $X\adjmapright Y$ +
    \adjmapright
    $X\adjmapright Y$ -
    \adjmapleft
    $X\adjmapleft Y$ +
    \adjmapleft
    $X\adjmapleft Y$ -
    \bihline
    $X\bihline Y$ +
    \bihline
    $X\bihline Y$

    There is also a family of macros to produce vertical lines, arrows, and @@ -5458,21 +5510,21 @@ adjoint arrows. The following macros produce vertical maps and have the same syntax as \mapdown:

    -
    \mapdown
    (a down arrow) +
    \mapdown
    (a down arrow) -
    \mapup
    (an up arrow) +
    \mapup
    (an up arrow) -
    \vline
    (vertical line) +
    \vline
    (vertical line) -
    \bimapdown
    (two down arrows) +
    \bimapdown
    (two down arrows) -
    \bimapup
    (two up arrows) +
    \bimapup
    (two up arrows) -
    \adjmapdown
    (two adjoint arrows; down then up) +
    \adjmapdown
    (two adjoint arrows; down then up) -
    \adjmapup
    (two adjoint arrows; up then down) +
    \adjmapup
    (two adjoint arrows; up then down) -
    \bivline
    (two vertical lines) +
    \bivline
    (two vertical lines)

    Finally, there is a family of macros to produce slanted lines, arrows, @@ -5480,21 +5532,21 @@ and adjoint arrows. The following macros produce slanted maps and have the same syntax as \arrow:

    -
    \arrow
    (a slanted arrow) +
    \arrow
    (a slanted arrow) -
    \sline
    (a slanted line) +
    \sline
    (a slanted line) -
    \biarrow
    (two straight arrows) +
    \biarrow
    (two straight arrows) -
    \adjarrow
    (two adjoint arrows) +
    \adjarrow
    (two adjoint arrows) -
    \bisline
    (two straight lines) +
    \bisline
    (two straight lines)

    The width between double arrows is controlled by the parameter \channelwidth. -The parameters \hchannel and \vchannel, if nonzero, +The parameters \hchannel and \vchannel, if nonzero, override \channelwidth by controlling the horizontal and vertical shifting from the first arrow to the second. @@ -5502,15 +5554,15 @@ shifting from the first arrow to the second. epimorphisms from monomorphisms. Many texts, such as Lang's book Algebra, use as a tasteful alternative the symbol `inc' (in roman) next to an arrow to denote inclusion. - + Future enhancements will include a mechanism to draw curved arrows found in, e.g., the Snake Lemma, by employing a version of the \path macros of Appendix D of The TeXbook. - +

    -


    +


    Next: , Previous: Arrows and morphisms, Up: Commutative diagrams @@ -5524,11 +5576,11 @@ described here. The first approach, and the simplest, treats commutative diagrams like fancy matrices, as Knuth does in Exercise 18.46 of The TeXbook. This case is covered by the macro \commdiag, -which is an altered version of the Plain TeX macro \matrix. -An example suffices to demonstrate this macro. The following +which is an altered version of the Plain TeX macro \matrix. +An example suffices to demonstrate this macro. The following commutative diagram (illustrating the covering homotopy property; Bott and Tu, Differential Forms in Algebraic Topology) -is produced with the code +is produced with the code
         $$\commdiag{Y&\mapright^f&E\cr \mapdown&\arrow(3,2)\lft{f_t}&\mapdown\cr
          Y\times I&\mapright^{\bar f_t}&X}$$
    @@ -5537,7 +5589,7 @@ and Tu, Differential Forms in Algebraic Topology)
     The following commutative diagram (illustrating the universal mapping
     property; Warner, Foundations of Differentiable Manifolds and Lie
     Groups)
    -is produced with the code
    +is produced with the code
     
     
         $$\varrowlength=20pt
          \commdiag{V\otimes W\cr \mapup\lft\phi&\arrow(3,-1)\rt{\tilde l}\cr
    @@ -5547,7 +5599,7 @@ Groups)
     of the triangle in the center column, as shown in the example
     (illustrating all constant minimal realizations of a linear system;
     Brockett, Finite Dimensional Linear Systems)
    -which is produced with the code
    +which is produced with the code
     
     
         $$\sarrowlength=.42\harrowlength
          \commdiag{&R^m\cr &\arrow(-1,-1)\lft{\bf B}\quad \arrow(1,-1)\rt{\bf G}\cr
    @@ -5565,13 +5617,13 @@ chosen to blend with each other.  In the first example, the default
     settings for the arrow lengths are used, but a direction for the arrow
     must be chosen.  The ratio of the default horizontal and vertical arrow
     lengths is approximately the golden mean
    -the arrow direction closest to this mean is (3,2). In the second
    +the arrow direction closest to this mean is (3,2). In the second
     example, a slope of
     is desired and the default horizontal arrow length is 60 pt; therefore,
     choose a vertical arrow length of 20 pt.  You may affect the interline
     glue settings of \commdiag by redefining the macro
     \commdiagbaselines. 
    -(cf. Exercise 18.46 of The TeXbook and the section on
    +(cf. Exercise 18.46 of The TeXbook and the section on
     parameters below.)
     
        

    The width, height, and depth of all morphisms are hidden so that the @@ -5580,7 +5632,7 @@ morphism at the top or bottom of a diagram to impinge upon the text surrounding the diagram. To overcome this problem, use TeX's \noalign primitive to insert a \vskip immediately above or below the offending line, e.g., -`$$\commdiag{\noalign{\vskip6pt}X&\mapright^\int&Y\cr ...}'. +‘$$\commdiag{\noalign{\vskip6pt}X&\mapright^\int&Y\cr ...}’.

    The macro \commdiag is too simple to be used for more complicated diagrams, which may have intersecting or overlapping arrows. A second @@ -5588,12 +5640,12 @@ approach, borrowed from Francis Borceux's Diagram macros for LaTeX, treats the commutative diagram like a grid of identically shaped boxes. To compose the commutative diagram, first draw an equally spaced grid, e.g., -on a piece of scratch paper. Then draw each element (vertices and +on a piece of scratch paper. Then draw each element (vertices and arrows) of the commutative diagram on this grid, centered at each grid point. Finally, use the macro \gridcommdiag -to implement your design as a TeX alignment. For example, the cubic +to implement your design as a TeX alignment. For example, the cubic diagram -that appears in Francis Borceux's documentation can be implemented on +that appears in Francis Borceux's documentation can be implemented on a 7 by 7 grid, and is achieved with the code

         $$\harrowlength=48pt \varrowlength=48pt \sarrowlength=20pt
    @@ -5609,7 +5661,7 @@ a 7 by 7 grid, and is achieved with the code
          E&&\mapright_k&&G\cr}$$
     

    The dimensions \hgrid and \vgrid -control the horizontal and vertical spacing of the grid used by +control the horizontal and vertical spacing of the grid used by \gridcommdiag. The default setting for both of these dimensions is 15 pt. Note that in the example of the cube the arrow lengths must be adjusted so that the arrows overlap into neighboring boxes by the @@ -5623,7 +5675,7 @@ of the morphisms are adjusted by setting \hmorphposn and

    One is not restricted to a square grid. For example, the proof of Zassenhaus's Butterfly Lemma can be illustrated by the diagram (appearing in Lang's book Algebra) -This diagram may be implemented on a 9 by 12 grid with an aspect ratio +This diagram may be implemented on a 9 by 12 grid with an aspect ratio of 1/2, and is set with the code

         $$\hgrid=16pt \vgrid=8pt \sarrowlength=32pt
    @@ -5651,8 +5703,8 @@ Many diagrams may be typeset with the predefined macros that appear
     here; however, ingenuity is often required to handle special cases.
     
     
    -


    +


    Previous: Construction of commutative diagrams, Up: Commutative diagrams @@ -5665,46 +5717,46 @@ commutative diagram macros. These dimensions may be changed globally or locally.
    -
    \harrowlength
    (Default: 60 pt) The length of right or left arrows. +
    \harrowlength
    (Default: 60 pt) The length of right or left arrows. -
    \varrowlength
    (Default: 0.618\harrowlength) The length of up or down +
    \varrowlength
    (Default: 0.618\harrowlength) The length of up or down arrows. -
    \sarrowlength
    (Default: 60 pt) The horizontal length of slanted arrows. +
    \sarrowlength
    (Default: 60 pt) The horizontal length of slanted arrows. -
    \hmorphposn
    (Default: 0 pt) The horizontal position of the morphism with +
    \hmorphposn
    (Default: 0 pt) The horizontal position of the morphism with respect to its default position. There are also the dimensions \hmorphposnup, -\hmorphposndn, -\hmorphposnrt, -and \hmorphposnlft -for ^/_ or \lft/\rt constructions. +\hmorphposndn, +\hmorphposnrt, +and \hmorphposnlft +for ^/_ or \lft/\rt constructions. -
    \vmorphposn
    (Default: 0 pt) The vertical position of the morphism with +
    \vmorphposn
    (Default: 0 pt) The vertical position of the morphism with respect to its default position. There are also the dimensions \vmorphposnup, -\vmorphposndn, -\vmorphposnrt, -and \vmorphposnlft -for ^/_ or \lft/\rt constructions. +\vmorphposndn, +\vmorphposnrt, +and \vmorphposnlft +for ^/_ or \lft/\rt constructions. -
    \morphdist
    (Default: 4 pt) The distance of morphisms from slanted lines +
    \morphdist
    (Default: 4 pt) The distance of morphisms from slanted lines or arrows. -
    \channelwidth
    (Default: 3 pt) The distance between double lines or arrows. +
    \channelwidth
    (Default: 3 pt) The distance between double lines or arrows. -
    \hchannel, \vchannel
    (Defaults: 0 pt) Overrides \channelwidth. The +
    \hchannel, \vchannel
    (Defaults: 0 pt) Overrides \channelwidth. The horizontal and vertical shifts between double lines or arrows. -
    \commdiagbaselines
    (Default: \baselineskip=15pt +
    \commdiagbaselines
    (Default: \baselineskip=15pt \lineskip=3pt \lineskiplimit=3pt ) The parameters used by \commdiag for setting interline glue. -
    \hgrid
    (Default: 15 pt) The horizontal spacing of the grid used by +
    \hgrid
    (Default: 15 pt) The horizontal spacing of the grid used by \gridcommdiag. -
    \vgrid
    (Default: 15 pt) The vertical spacing of the grid used by +
    \vgrid
    (Default: 15 pt) The vertical spacing of the grid used by \gridcommdiag.
    @@ -5712,8 +5764,8 @@ The parameters used by \commdiag for setting interline glue.
    -


    +


    Next: , Previous: Arrow theoretic diagrams, Up: Top @@ -5741,8 +5793,8 @@ are writing nontrivial macros, not when writing a document.
    -


    +


    Next: , Up: Programming definitions @@ -5750,30 +5802,30 @@ Up: Programming d

    7.1 Category codes

    -

    +

    Plain TeX defines \active (as the number 13) for use in changing category codes. Although the author of The TeXbook -has “intentionally kept the category codes numeric”, two other +has “intentionally kept the category codes numeric”, two other categories are commonly used: letters (category code 11) and others (12). Therefore, Eplain defines \letter and \other. - + Sometimes it is cleaner to make a character active without actually -writing a \catcode command. The \makeactive command takes -a character as an argument to make active (and ignores following +writing a \catcode command. The \makeactive command takes +a character as an argument to make active (and ignores following spaces). For example, here are two commands which both make \ active: - +

         \makeactive\\   \makeactive92
     
    -

    Sometimes you might want to temporarily change the category code of +

    Sometimes you might want to temporarily change the category code of the `@' character to \letter, so that you can use or define macros which are normally inaccessible to the user. For such situations, Eplain provides the \makeatletter -command. It sets the category code of `@' to \letter (11) and +command. It sets the category code of `@' to \letter (11) and defines \resetatcatcode -to restore the category code to whatever it was before the call to +to restore the category code to whatever it was before the call to \makeatletter. For example:

         \makeatletter
    @@ -5782,41 +5834,41 @@ defines
          \resetatcatcode
     

    There is also \makeatother -which works similarly but sets the category code of `@' to +which works similarly but sets the category code of `@' to \other (12).

    Usually, when you give a definition to an active character, you have to do so inside a group where you temporarily make the character active, and then give it a global definition (cf. the definition of \obeyspaces in The TeXbook). -This is inconvenient if you are writing a long macro, or if the +This is inconvenient if you are writing a long macro, or if the character already has a global definition you do not wish to transcend. Eplain provides \letreturn, which defines the usual end-of-line -character to be the argument. For example: +character to be the argument. For example:

         \def\mymacro{... \letreturn\myreturn ... }
          \mymacro hello
          there
     
    -

    The end-of-line between `hello' and `there' causes +

    The end-of-line between ‘hello’ and ‘there’ causes \myreturn to be expanded.

    The TeXbook describes \uncatcodespecials, -which makes all characters which are normally “special” into “other” +which makes all characters which are normally “special” into “other” characters, but the definition never made it into plain TeX. -Eplain therefore defines it. +Eplain therefore defines it. For notes on the usage, see Verbatim listing.

    Finally, \percentchar -expands into a literal `%' character. This is useful when you +expands into a literal `%' character. This is useful when you \write TeX output to a file, and want to avoid spurious spaces. For example, Eplain writes a \percentchar after the definition of cross-references. The macros \lbracechar -and \rbracechar -expand similarly. +and \rbracechar +expand similarly.

    -


    +


    Next: , Previous: Category codes, Up: Programming definitions @@ -5825,16 +5877,16 @@ Up: Programming d

    7.2 Allocation macros

    -

    +

    Plain TeX provides macros that allocate registers of each primitive type in TeX, to prevent different sets of macros from using the same register for two different things. The macros are all named starting -with `new', -e.g., \newcount allocates a new “count” +with ‘new’, +e.g., \newcount allocates a new “count” (integer) register. Such allocations are usually needed only at the top level of some macro definition file; therefore, plain TeX makes the allocation registers \outer, -to help find errors. (The error this helps to find is a missing right +to help find errors. (The error this helps to find is a missing right brace in some macro definition.)

    Sometimes, however, it is useful to allocate a register as part of @@ -5843,24 +5895,24 @@ definition (or in a few other contexts: the parameter text of a definition, an argument to a definition, the preamble of an alignment, or in conditional text that is being skipped). Therefore, Eplain defines “inner” versions of all the allocation macros, named with the -prefix `inner': +prefix ‘inner’: \innernewbox, -\innernewcount, -\innernewdimen, -\innernewfam, -\innernewhelp, -\innernewif, -\innernewinsert, -\innernewlanguage, -\innernewread,
    -\innernewskip, -\innernewtoks, -\innernewwrite. - +\innernewcount, +\innernewdimen, +\innernewfam, +\innernewhelp, +\innernewif, +\innernewinsert, +\innernewlanguage, +\innernewread,
    +\innernewskip, +\innernewtoks, +\innernewwrite. + You can also define non-outer versions of other macros in the same way that Eplain defines the above. The basic macro is called \innerdef: - +

         \innerdef \innername {outername}
     

    The first argument (\innername) to \innerdef is the @@ -5873,15 +5925,15 @@ since it's outer!)

    If the outer control sequence is named \cs, and you want to define innercs as the inner one, you can use \innerinnerdef, -which is just an abbreviation for a call to \innerdef. For +which is just an abbreviation for a call to \innerdef. For example, these two calls are equivalent:

         \innerdef\innerproclaim{proclaim}
          \innerinnerdef{proclaim}
     
    -


    +


    Next: , Previous: Allocation macros, Up: Programming definitions @@ -5890,20 +5942,20 @@ Up: Programming d

    7.3 Iteration

    -

    +

    You can iterate through a comma-separated list of items with \for. -Here is an example: +Here is an example:

         \for\name:=karl,kathy\do{%
             \message{\name}%
          }%
     
    -

    This writes `karl' and `kathy' to the terminal. Spaces +

    This writes ‘karl’ and ‘kathy’ to the terminal. Spaces before or after the commas in the list, or after the :=, are not ignored. To strip leading spaces off the items, use \For: - +

         \For\name:=
             karl,
             kathy\do{%
    @@ -5929,9 +5981,9 @@ token after := which is space, not \namelist.
     
        

    Eplain provides another kind of loops, which is an extension of plain TeX's -\loop. If you say: +\loop. If you say: -

    +

         \loop
            loop-text
          \if condition
    @@ -5953,12 +6005,12 @@ the optional else clause:
     

    Here, loop-text will be repeated as long as condition is not satisfied. This extension is from -Victor Eijkhout's -TeX by Topic (page 104). +Victor Eijkhout's +TeX by Topic (page 104).

    -


    +


    Next: , Previous: Iteration, Up: Programming definitions @@ -5967,14 +6019,14 @@ Up: Programming d

    7.4 Macro arguments

    -

    It is occasionally useful to redefine a macro that takes arguments to +

    It is occasionally useful to redefine a macro that takes arguments to do nothing. Eplain defines \gobble, -\gobbletwo, -and \gobblethree to swallow one, two, and three arguments, +\gobbletwo, +and \gobblethree to swallow one, two, and three arguments, respectively.

    For example, if you want to produce a “short” table of -contents—one that includes only chapters, say—the easiest thing to +contents—one that includes only chapters, say—the easiest thing to do is read the entire .toc file (see Contents), and just ignore the commands that produce section or subsection entries. To be specific: @@ -5988,13 +6040,13 @@ specific: subsections in your document.)

    In addition, Eplain defines \eattoken -to swallow the single following token, using \let. Thus, -\gobble followed by `{...}' ignores the entire +to swallow the single following token, using \let. Thus, +\gobble followed by ‘{...}’ ignores the entire brace-enclosed text. \eattoken followed by the same ignores only the opening left brace.

    Eplain defines a macro \identity -which takes one argument and expands to that argument. This may be +which takes one argument and expands to that argument. This may be useful if you want to provide a function for the user to redefine, but don't need to do anything by default. (For example, the default definition of \eqconstruct (see Formatting equation references) is \identity.) @@ -6027,8 +6079,8 @@ one will need to be enclosed in braces, so TeX does not mistake the end of the first for the end of the second.

    -


    +


    Next: , Previous: Macro arguments, Up: Programming definitions @@ -6037,9 +6089,9 @@ Up: Programming d

    7.5 Converting to characters

    -

    Eplain defines \xrlabel -to produce control sequence names for cross-reference labels, et al. -This macro expands to its argument with an `_' appended. (It does +

    Eplain defines \xrlabel +to produce control sequence names for cross-reference labels, et al. +This macro expands to its argument with an ‘_’ appended. (It does this because the usual use of \xrlabel is to generate a control sequence name, and we naturally want to avoid conflicts between control sequence names.) @@ -6051,11 +6103,11 @@ sequence name out of the result you need only do

    The \csname primitive makes a control sequence name out of any sequence of character tokens, regardless of category code. -Labels can therefore include any characters except for `\', -`{', `}', and `#', all of which are used in macro +Labels can therefore include any characters except for ‘\’, +‘{’, ‘}’, and ‘#’, all of which are used in macro definitions themselves. -

    \sanitize takes a control sequence as an argument and converts +

    \sanitize takes a control sequence as an argument and converts the expansion of the control sequence into a list of character tokens. This is the behavior you want when writing information like chapter titles to an output file. For example, here is part of the definition @@ -6072,8 +6124,8 @@ has given. }%

    -


    +


    Next: , Previous: Converting to characters, Up: Programming definitions @@ -6097,9 +6149,9 @@ Up: Programming d
    -


    +


    Next: , Up: Expansion @@ -6107,11 +6159,11 @@ Up: Expansion

    7.6.1 \csn and \ece

    -

    \csn{name} simply abbreviates \csname name +

    \csn{name} simply abbreviates \csname name \endcsname, thus saving some typing. The extra level of expansion does take some time, though, so I don't recommend it for an inner loop. -

    \ece{token}{name} abbreviates +

    \ece{token}{name} abbreviates

         \expandafter token \csname name \endcsname
     
    @@ -6124,9 +6176,9 @@ does take some time, though, so I don't recommend it for an inner loop. ptmr.
    -


    +


    Next: , Previous: \csn and \ece, Up: Expansion @@ -6135,7 +6187,7 @@ Up: Expansion

    7.6.2 \edefappend

    -

    \edefappend is a way of adding on to an existing definition. It +

    \edefappend is a way of adding on to an existing definition. It takes two arguments: the first is the control sequence name, the second the new tokens to append to the definition. The second argument is fully expanded (in the \edef that redefines the control sequence). @@ -6146,11 +6198,11 @@ fully expanded (in the \edef that redefines the control sequence). \def\bar{xyz} \edefappend\foo{\bar karl}

    -

    results in \foo being defined as `abcxyzkarl'. +

    results in \foo being defined as ‘abcxyzkarl’.

    -


    +


    Next: , Previous: \edefappend, Up: Expansion @@ -6159,7 +6211,7 @@ Up: Expansion

    7.6.3 Hooks

    -

    A hook is simply a name for a group of actions which is executed +

    A hook is simply a name for a group of actions which is executed in certain places—presumably when it is most useful to allow customization or modification. TeX already provides many builtin hooks; for example, the \every ... token lists are all @@ -6169,16 +6221,16 @@ examples of hooks. take two arguments: the name of the hook and the new actions. - -

    hookaction name actions
    hookappend name actions

    hookprepend name actions
    Each of these adds actions to the hook name. (Any + +
    hookaction name actions
    hookappend name actions

    hookprepend name actions
    Each of these adds actions to the hook name. (Any previously-defined actions are retained.) name is not a control sequence, but rather the characters of the name. -


    hookactiononce name \cs
    \hookactiononce adds cs to name, like the macros +


    hookactiononce name \cs
    \hookactiononce adds cs to name, like the macros above, but first it adds
              \global\let \cs \relax
    -     
    +

    to the definition of \cs. (This implies \cs must be a true expandable macro, not a control sequence \let to a primitive or some other such thing.) Thus, \cs is expanded the @@ -6190,7 +6242,7 @@ Neither this nor the other hook macros do global assignments to the hook variable itself, so TeX's usual grouping rules apply.

    -

    The companion macro to defining hook actions is \hookrun, for +

    The companion macro to defining hook actions is \hookrun, for running them. This takes a single argument, the name of the hook. If no actions for the hook are defined, no error ensues. @@ -6207,8 +6259,8 @@ other actions (as long as the other actions use \hookprepend and \hookappend{end}\finish_underline

    -


    +


    Next: , Previous: Hooks, Up: Expansion @@ -6217,7 +6269,7 @@ Up: Expansion

    7.6.4 Properties

    -

    A property is a name/value pair associated with another symbol, +

    A property is a name/value pair associated with another symbol, traditionally called an atom. Both atom and property names are control sequence names. @@ -6225,12 +6277,12 @@ control sequence names. \setproperty and \getproperty. - +

    \setproperty atom propname value
    \setproperty defines the property property on the atom atom to be value. atom and propname can be anything acceptable to \csname. value can be anything. -


    \getproperty atom propname
    \getproperty expands to the value stored for propname on +


    \getproperty atom propname
    \getproperty expands to the value stored for propname on atom. If propname is undefined, it expands to nothing (i.e., \empty). @@ -6241,15 +6293,15 @@ implementation truly does associate properties with atoms. In TeX, where we have no builtin support for properties, the association is only conceptual. -

    The following example typesets `xyz'. +

    The following example typesets ‘xyz’.

         \setproperty{a}{pr}{xyz}
          \getproperty{a}{pr}
     
    -


    +


    Next: , Previous: Properties, Up: Expansion @@ -6258,21 +6310,21 @@ Up: Expansion

    7.6.5 \expandonce

    -

    \expandonce is defined as \expandafter\noexpand. Thus, +

    \expandonce is defined as \expandafter\noexpand. Thus, \expandonce token expands token once, instead of to TeX primitives. This is most useful in an \edef.

    For example, the following defines \temp to be \foo, not -`abc'. +‘abc’.

         \def\foo{abc}
          \def\bar{\foo}
          \edef\temp{\expandonce\bar}
     
    -


    +


    Next: , Previous: \expandonce, Up: Expansion @@ -6281,11 +6333,11 @@ Up: Expansion

    7.6.6 \ifundefined

    -

    \ifundefined{cs} t \else f \fi expands the +

    \ifundefined{cs} t \else f \fi expands the t text if the control sequence \cs is undefined or has been \let to \relax, and the f text otherwise. -

    Since \ifundefined is not a primitive conditional, it cannot be +

    Since \ifundefined is not a primitive conditional, it cannot be used in places where TeX might skip tokens “at high speed”, e.g., within another conditional—TeX can't match up the \if's and \fi's. @@ -6293,9 +6345,9 @@ within another conditional—TeX can't match up the \if's and

    This macro was taken directly from The TeXbook, page 308.

    -


    +


    Next: , Previous: \ifundefined, Up: Expansion @@ -6304,14 +6356,14 @@ Up: Expansion

    7.6.7 \ifempty

    -

    \ifempty{arg} t \else f \fi expands the +

    \ifempty{arg} t \else f \fi expands the t text if arg is the empty string, and the f text otherwise. This macro is useful when you need to test for empty arguments to your macros, for example:

         \def\foo#1{\ifempty{#1} t \else f \fi}
     
    -

    Since \ifempty is not a primitive conditional, it cannot be +

    Since \ifempty is not a primitive conditional, it cannot be used in places where TeX might skip tokens “at high speed”, e.g., within another conditional—TeX can't match up the \if's and \fi's. @@ -6321,12 +6373,12 @@ within another conditional—TeX can't match up the \if's and

         \def\empty{}
          \ifempty\empty\message{empty}\else\message{not empty}\fi
     
    -

    will produce the message `not empty'. +

    will produce the message ‘not empty’.

    -


    +


    Next: , Previous: \ifempty, Up: Expansion @@ -6335,7 +6387,7 @@ Up: Expansion

    7.6.8 \ifinteger and \isinteger

    -

    \ifinteger{arg} t \else f \fi expands the +

    \ifinteger{arg} t \else f \fi expands the t text if arg is an integer, and the f text otherwise. This macro can detect positive and negative integers. @@ -6343,7 +6395,7 @@ otherwise. This macro can detect positive and negative integers. used in places where TeX might skip tokens “at high speed”, e.g., within another conditional—TeX can't match up the \if's and \fi's. For such situations Eplain provides -\isinteger, which can be used as follows: +\isinteger, which can be used as follows:

         \if\isinteger{arg} t \else f \fi
     
    @@ -6353,16 +6405,16 @@ following code
         \ifinteger{12_ab}integer\else not integer\fi
     
    -

    will expand to `ab_integer' (and thus would not +

    will expand to ‘ab_integer’ (and thus would not even compile outside math mode). -

    These macros come from TeX Frequently Asked Question +

    These macros come from TeX Frequently Asked Question (http://www.tex.ac.uk/cgi-bin/texfaq2html).

    -


    +


    Previous: \ifinteger and \isinteger, Up: Expansion @@ -6370,7 +6422,7 @@ Up: Expansion

    7.6.9 \futurenonspacelet

    -

    The \futurelet primitive allows you to look at the next token +

    The \futurelet primitive allows you to look at the next token from the input. Sometimes, though, you want to look ahead ignoring any spaces. This is what \futurenonspacelet does. It is otherwise the same as \futurelet: you give it two control sequences as @@ -6381,8 +6433,8 @@ expands the second. For example: \def\finishup{\ifx\temp ...}

    -


    +


    Next: , Previous: Expansion, Up: Programming definitions @@ -6391,7 +6443,7 @@ Up: Programming d

    7.7 Obeying spaces

    -

    +

    \obeywhitespace makes both end-of-lines and space characters in the input be respected in the output. Unlike plain TeX's \obeyspaces, even spaces at the beginnings of lines turn into @@ -6404,18 +6456,18 @@ what \ produces.

    Ordinarily, a blank line in the input produces as much blank vertical space as a line of text would occupy. You can adjust this by assigning to the parameter \blanklineskipamount: -if you set this negative, the space produced by a blank line will be +if you set this negative, the space produced by a blank line will be smaller; if positive, larger.

    Tabs are not affected by this routine. In particular, if tabs occur at the beginning of a line, they will disappear. (If you are trying to make TeX do the “right thing” with tabs, don't. Use a utility program like expand instead.) - +

    -


    +


    Next: , Previous: Obeying spaces, Up: Programming definitions @@ -6424,14 +6476,14 @@ Up: Programming d

    7.8 Writing out numbers

    -

    \numbername -produces the written-out form of its argument, i.e., `zero' through +

    \numbername +produces the written-out form of its argument, i.e., `zero' through `ten' for the numbers 0–10, and numerals for all others.

    -


    +


    Next: , Previous: Writing out numbers, Up: Programming definitions @@ -6445,7 +6497,7 @@ current list, no matter what kind of list it is. You might intend a particular penalty to always be a “vertical” penalty, however, i.e., appended to a vertical list. Therefore, Eplain provides \vpenalty -and \hpenalty +and \hpenalty which first leave the other mode and then do \penalty.

    More precisely, \vpenalty inserts \par if the current @@ -6454,8 +6506,8 @@ the current mode is vertical. (Thus, \vpenalty cannot be used in math mode.)

    -


    +


    Next: , Previous: Mode-specific penalties, Up: Programming definitions @@ -6464,12 +6516,12 @@ Up: Programming d

    7.10 Auxiliary files

    -

    It is common to write some information out to a file to be used on a +

    It is common to write some information out to a file to be used on a subsequent run. But when it is time to read the file again, you only want to do so if the file actually exists. \testfileexistence -is given an argument which is appended to \jobname, -and sets the conditional \iffileexists -appropriately. For example: +is given an argument which is appended to \jobname, +and sets the conditional \iffileexists +appropriately. For example:

         \testfileexistence{toc}%
          \iffileexists
    @@ -6487,9 +6539,9 @@ name.  For example, if you want to test for the file
          \fi
     
    -


    +


    Next: , Previous: Auxiliary files, Up: Programming definitions @@ -6498,7 +6550,7 @@ Up: Programming d

    7.11 User-defined environments

    -

    Plain TeX does not provide “named” block structures, only the anonymous +

    Plain TeX does not provide “named” block structures, only the anonymous \begingroup and \endgroup pair. The disadvantage of this is that when there are several such groups and one is mismatched, it can be difficult to find the error. Eplain provides a named block structure @@ -6530,8 +6582,8 @@ shouldn't always be allowed to nest. Put the control sequence environment that should not be nested.

    -


    +


    Previous: User-defined environments, Up: Programming definitions @@ -6539,7 +6591,7 @@ Up: Programming d

    7.12 Page list and page range parsers

    -

    The macros which Eplain uses to parse the page lists and ranges in the +

    The macros which Eplain uses to parse the page lists and ranges in the index, \idxparselist and \idxparserange (see Page destinations for index terms), are sometimes useful when defining page number encapsulators. They take one argument, text to parse. When a page list (range) is not present, they set \idxpagei to be @@ -6547,9 +6599,9 @@ page list (range) is not present, they set \idxpagei to be \idxpagei and \idxpageii to the first and the second page numbers, respectively. -

    Eplain's defaults for the page list and page range delimiters are the -same as those in MakeIndex, a comma followed by a space (`, ') and -two dashes (`--'), respectively. If you customize MakeIndex to use +

    Eplain's defaults for the page list and page range delimiters are the +same as those in MakeIndex, a comma followed by a space (‘, ’) and +two dashes (‘--’), respectively. If you customize MakeIndex to use different delimiters, you must not forget to let Eplain know about them with the commands @@ -6558,14 +6610,14 @@ with the commands

    These commands save the list-delim and page-delim delimiters in -\idxpagelistdelimiter and \idxpagerangedelimiter, +\idxpagelistdelimiter and \idxpagerangedelimiter, respectively. -

    For example, you may want to define a page number markup command which +

    For example, you may want to define a page number markup command which italicizes and properly underlines page ranges by underlining only the page numbers and not the delimiter: -

    +

         \def\ituline#1{%
            {\it
            \idxparserange{#1}%
    @@ -6587,8 +6639,8 @@ extend \ituline with an additional call to \idxparselist
     
    -


    +


    Next: , Previous: Programming definitions, Up: Top @@ -6597,7 +6649,7 @@ Up: Top

    8 Demo files

    -

    This chapter contains listings of source files, along with the output +

    This chapter contains listings of source files, along with the output they produce (where appropriate), which illustrate various aspects of Eplain. The files can be found in the demo subdirectory of Eplain distribution. These demos, both the sources and the compiled PDF @@ -6609,9 +6661,9 @@ and PS files, are also available from http:

    -


    +


    Next: , Up: Demo files @@ -6621,15 +6673,15 @@ Up: Demo files
    xhyper.jpg
    -

    - - - - - - - - +

    + + + + + + + +

    % (This file is public domain.)
     %
    @@ -6824,9 +6876,9 @@ Take me to
     
    -


    +


    Previous: Hyperlinks (xhyper.tex), Up: Demo files @@ -6836,9 +6888,9 @@ Up: Demo files
    lscommnt.jpg
    -

    - - +

    + +

    % (This file is public domain.)
     % Demonstrate how Eplain can be used to include a TeX source file
    @@ -6891,8 +6943,8 @@ Up: Demo files
     
     
     
    -


    +


    Next: , Previous: Demo files, Up: Top @@ -6902,553 +6954,565 @@ Up: Top

    Macro index

    -


    +


    Previous: Macro index, Up: Top @@ -7459,692 +7523,700 @@ Up: Top diff --git a/Master/texmf-dist/doc/eplain/doc/eplain.pdf b/Master/texmf-dist/doc/eplain/doc/eplain.pdf index 4add1a858c7..d99a093638a 100644 Binary files a/Master/texmf-dist/doc/eplain/doc/eplain.pdf and b/Master/texmf-dist/doc/eplain/doc/eplain.pdf differ diff --git a/Master/texmf-dist/doc/eplain/doc/lscommnt.jpg b/Master/texmf-dist/doc/eplain/doc/lscommnt.jpg index 8b4fb5f64ed..0ad895dc00f 100644 Binary files a/Master/texmf-dist/doc/eplain/doc/lscommnt.jpg and b/Master/texmf-dist/doc/eplain/doc/lscommnt.jpg differ diff --git a/Master/texmf-dist/doc/eplain/doc/xhyper.jpg b/Master/texmf-dist/doc/eplain/doc/xhyper.jpg index 3204a2e7c72..aa797d53dae 100644 Binary files a/Master/texmf-dist/doc/eplain/doc/xhyper.jpg and b/Master/texmf-dist/doc/eplain/doc/xhyper.jpg differ diff --git a/Master/texmf-dist/doc/eplain/util/idxuniq b/Master/texmf-dist/doc/eplain/util/idxuniq index 6ee7d225f5c..599d9b593cb 100644 --- a/Master/texmf-dist/doc/eplain/util/idxuniq +++ b/Master/texmf-dist/doc/eplain/util/idxuniq @@ -1,26 +1,28 @@ #!/usr/bin/awk -f - +# # (This file is public domain.) - +# +# This file is part of the Eplain macro package. +# # This script filters input lines (which are expected to be a list of # `\indexentry' lines for MakeIndex) eliminating matching lines. The comparison # is done without regard to hyperlink label names (in the form `IDX*', where `*' # stands for a non-negative integer). - +# # This has to be done to avoid terms which differ only in hyperlink label names # embedded into them, because MakeIndex will treat these otherwise identical # terms as distinct, listing more than once a page number for equivalent terms # on the same page. - +# # `stripped' array is indexed by `\indexentry' lines stripped off the hyperlink # label name. For each term, we use its stripped version as a key into the # `stripped' array to increment its element. This records the fact that we have # seen the term with such key. Also, we add the (full) `\indexentry' line to # the `terms' array, but only if we have not yet seen a term with such key. - +# # The idea was borrowed from Edition 3 of `GAWK: Effective AWK Programming: A # User's Guide for GNU Awk', which contains the following credit: - +# # histsort.awk --- compact a shell history file # Thanks to Byron Rakitzis for the general idea diff --git a/Master/texmf-dist/doc/eplain/util/trimsee b/Master/texmf-dist/doc/eplain/util/trimsee index 8af5ebe6434..00459956f47 100644 --- a/Master/texmf-dist/doc/eplain/util/trimsee +++ b/Master/texmf-dist/doc/eplain/util/trimsee @@ -1,6 +1,6 @@ #!/bin/sh - # (This file is public domain.) +# This file is part of the Eplain macro package. help () { @@ -25,7 +25,7 @@ EOF check_missing_arg () { - if (( $1 < 2 )); then + if test "$1" -lt 2; then echo "Missing argument to option '$2'" 1>&2 exit 1 fi -- cgit v1.2.3