(eplain.info)Top


Eplain
******

This manual documents the Eplain macros, version 3.8, May 2016.  Eplain
provides functionality for plain TeX that is intended to be useful
regardless of how your document is actually formatted.

   Most of this manual is in the public domain, like most of the Eplain
code.  It was originally written by Karl Berry, starting in 1989.
Steven Smith wrote the documentation for the commutative diagram macros;
this chapter is under the GNU General Public License.  Adam Lewenberg
has made additions and corrections.  Oleg Katsitadze wrote the section
on LaTeX packages and the chapter on hyperlinks, and updates throughout.

   The Eplain home page is <http://tug.org/eplain>.

Introduction: Eplain's purpose and philosophy.
Installation: Installing Eplain.
Invoking Eplain: Using Eplain from a TeX file.
User definitions: Macros to be used in a document.
Hyperlinks: Producing documents with hyperlinks.
Arrow theoretic diagrams: Macros for commutative diagrams.
Programming definitions: Macros to be used in writing other macros.
Demo files: Sample documents demonstrating Eplain.
Macro index: Entries for TeX and Eplain control sequences.
Concept index: General index.

-- The Detailed Node Listing -- User definitions

Diagnostics: Tracing information.
Rules: Changing the default rule dimensions.
Citations: Using BibTeX and Eplain to make bibliographies.
Displays: Changing the formatting of math displays.
Time of day: Producing the time of day.
Lists: Producing numbered and unordered lists.
Verbatim listing: Producing text just as it appears.
Contents: Making a table of contents.
Cross-references: Symbolically referring to pages or equations.
Page references: Symbolic references to page numbers.
Equation references: Symbolic references to equation numbers.
Indexing: Creating and typesetting indexes.
Justification: Left- or right-justification, or centering.
Tables: Producing ordered tables.
Margins: Changing the margins directly.
Multiple columns: Getting output in two columns.
Footnotes: Autonumbered footnotes; changing formatting.
Fractions: A better way to produce fractions in text.
Paths: Allowing line breaks in pathnames.
Logos: Various logos.
Boxes: Producing filled or open rectangles.
Checking for PDF output: Checking for pdfTeX in PDF mode.
Loading LaTeX packages: Support for LaTeX packages under plain TeX.

Citations

Formatting citations: Changing the way citations are printed.
Formatting bibliographies: Changing the way bibliographies are printed.

Displays

Formatting displays: General formatting of displays.

Lists

Formatting lists: Changing how the lists look.

Contents

Writing the .toc file
Reading the .toc file
Changing the .toc file's root name
Alternative contents files

Cross-references

Defining generic references
Using generic references

Equation references

Formatting equation references
Subequation references

Indexing

Indexing terms: Specifying what to index.
Typesetting an index: Printing the sorted output.
Customizing indexing: Creating commands and specifying extra actions.

Indexing terms

Indexing commands: Making index entries.
Modifying index entries: Ranges, see/see also, page number typesetting.
Index entries with special characters
Proofing index terms: Noting index entries in the margins.

Loading LaTeX packages

The \usepackage command: Command to load packages.
Environment for loading packages: Environment for the \usepackage commands.
Packages known to work: Supported packages.
Packages known not to work: Packages known not to work with Eplain.

Hyperlinks

Introduction to hyperlinks
Explicit hyperlinks
Implicit hyperlinks
Hyperlink drivers
Setting hyperlink types and options
Turning hyperlinks on/off

Implicit hyperlinks

General hyperlinks: hrefint, hrefext
URL hyperlinks: url
Citation hyperlinks: cite, bib
List hyperlinks: li
Cross-reference hyperlinks: definexref, ref
Page reference hyperlinks: xrdef, xref
Equation reference hyperlinks: eq
Index hyperlinks: idx
Footnote hyperlinks: foot, footback
Contents hyperlinks

Index hyperlinks

Exact destinations for index terms
Page destinations for index terms
Choosing destination placement
Index page list and page range parsers
Hyperlinks in see and see also entries

Hyperlink drivers

Options supported by all drivers
Hyperlink driver hypertex
Hyperlink drivers pdftex and dvipdfm
Hyperlink driver nolinks

Hyperlink driver hypertex::

Destination types for hypertex
Destination options for hypertex
Link types for hypertex
Link options for hypertex

Hyperlink drivers pdftex and dvipdfm::

Destination types for pdftex and dvipdfm
Destination options for pdftex and dvipdfm
Link types for pdftex and dvipdfm
Link options for pdftex and dvipdfm

Setting hyperlink types and options

Setting default types and options
Setting group types
Setting group options

Turning hyperlinks on/off

Turning low-level commands on/off
Turning hyperlinks on/off for a group

Arrow theoretic diagrams

Slanted lines and vectors
Commutative diagrams

Commutative diagrams

Arrows and morphisms
Construction of commutative diagrams
Commutative diagram parameters

Programming definitions

Category codes: Changing category codes.
Allocation macros: Non-outer versions of \newcount et al.
Iteration: Doing 'for' and 'while' loops in TeX.
Macro arguments: Reading and ignoring them.
Converting to characters: Normalizing control sequences and spaces.
Expansion: Controlling expansion.
Obeying spaces: Making whitespace count anywhere.
Writing out numbers: Making '1' into 'one'.
Mode-specific penalties
Auxiliary files: Testing for their existence.
User-defined environments: User-defined environments.
Page list and page range parsers

Expansion

\csn and \ece
\edefappend
Hooks: Manipulating and executing named actions.
Properties: Associating information with a csname.
\expandonce
\ifundefined
\ifempty
\ifinteger and \isinteger
\futurenonspacelet

Demo files

Hyperlinks (xhyper.tex)
Highlighting TeX comments in listings (lscommnt.tex)

automatically generated by info2www version 1.2.2.9