RefTeX User Manual

RefTeX is a package for managing Labels, References, Citations and index entries with GNU Emacs.

Don't be discouraged by the size of this manual, which covers RefTeX in great depth. All you need to know to use RefTeX can be summarized on two pages (see RefTeX in a Nutshell). You can go back later to other parts of this document when needed.

• Introduction: Quick-Start information.
• Table of Contents: A Tool to move around quickly.
• Labels and References: Creating and referencing labels.
• Citations: Creating Citations.
• Index Support: Creating and Checking Index Entries.
• Viewing Cross-References: Who references or cites what?
• RefTeXs Menu: The Ref menu in the menubar.
• Key Bindings: The default key bindings.
• Faces: Fontification of RefTeX's buffers.
• Multifile Documents: Document spread over many files.
• Language Support: How to support other languages.
• Finding Files: Included TeX files and BibTeX .bib files.
• AUCTeX: Cooperation with AUCTeX.
• Optimizations: When RefTeX is too slow.
• Problems and Work-Arounds: First Aid.
• Imprint: Author, Web-site, Thanks
• Commands: Which are the available commands.
• Options: How to extend and configure RefTeX.
• Keymaps and Hooks: For customization.
• Changes: A List of recent changes to RefTeX.
• GNU Free Documentation License: The license for this documentation.

The Index

• Index: The full index.

Introduction

• Installation: How to install and activate RefTeX.
• RefTeX in a Nutshell: A brief summary and quick guide.

Labels and References

• Creating Labels
• Referencing Labels
• Builtin Label Environments: The environments RefTeX knows about.
• Defining Label Environments: ... and environments it doesn't.
• Reference Info: View the label corresponding to a \ref.
• xr (LaTeX package): References to external documents.
• varioref (LaTeX package): How to create \vref instead of \ref.
• fancyref (LaTeX package): How to create \fref instead of \ref.

Defining Label Environments

• Theorem and Axiom: Defined with \newenvironment.
• Quick Equation: When a macro sets the label type.
• Figure Wrapper: When a macro argument is a label.
• Adding Magic Words: Other words for other languages.
• Using \eqref: How to switch to this AMS-LaTeX macro.
• Non-Standard Environments: Environments without \begin and \end
• Putting it Together: How to combine many entries.

Citations

• Creating Citations: How to create them.
• Citation Styles: Natbib, Harvard, Chicago and Co.
• Citation Info: View the corresponding database entry.
• Chapterbib and Bibunits: Multiple bibliographies in a Document.
• Citations Outside LaTeX: How to make citations in Emails etc.
• BibTeX Database Subsets: Extract parts of a big database.

Index Support

• Creating Index Entries: Macros and completion of entries.
• The Index Phrases File: A special file for global indexing.
• Displaying and Editing the Index: The index editor.
• Builtin Index Macros: The index macros RefTeX knows about.
• Defining Index Macros: ... and macros it doesn't.

The Index Phrases File

• Collecting Phrases: Collecting from document or external.
• Consistency Checks: Check for duplicates etc.
• Global Indexing: The interactive indexing process.

AUCTeX

• AUCTeX-RefTeX Interface: How both packages work together
• Style Files: AUCTeX's style files can support RefTeX
• Bib-Cite: Hypertext reading of a document

Options, Keymaps, Hooks

• Options (Table of Contents)
• Options (Defining Label Environments)
• Options (Creating Labels)
• Options (Referencing Labels)
• Options (Creating Citations)
• Options (Index Support)
• Options (Viewing Cross-References)
• Options (Finding Files)
• Options (Optimizations)
• Options (Fontification)
• Options (Misc)