[AUCTeX-diffs] Changes to auctex/doc/tex-ref.tex

[David Kastrup]

Index: auctex/doc/tex-ref.tex
diff -u auctex/doc/tex-ref.tex:1.16 auctex/doc/tex-ref.tex:1.17
--- auctex/doc/tex-ref.tex:1.16 Fri May 20 08:49:23 2005
+++ auctex/doc/tex-ref.tex      Tue May 24 01:41:18 2005
@@ -340,6 +340,114 @@
 
 \copyrightnotice
 \penalty-9000
+
+\newcolumn
+
+\title{RefTeX (long)}
+
+\section{Activation}
+
+RefTeX is part of [X]Emacs.  To activate and make it interact with
+AUCTeX, insert the following lines in .emacs.
+\vskip-3mm
+\beginexample
+(add-hook 'latex-mode-hook 'turn-on-reftex)
+(add-hook 'LaTeX-mode-hook 'turn-on-reftex)
+(setq reftex-plug-into-auctex t)
+\endexample
+
+\section{Table of Contents}
+The table of contents is a structured view of the entire document.  It
+contains the sections, and optionally labels, index entries, and file
+boundaries.
+
+\key{Show the table of contents$\sp1$}{C-c =}
+\key{Recenter *toc* buffer to here$\sp1$}{C-c -}
+
+\section{Crossreferences, Citations, Index}
+
+\key{Insert unique label$\sp1$}{C-c (}
+\key{Reference a label$\sp1$}{C-c )}
+\key{Insert citation with key selection}{C-c [}
+\key{... prompt for optional arguments}{C-u C-c [}
+\key{Index  word at point with default macro}{C-c /}
+\key{Insert an index entry}{C-c <}
+\key{Add word to index phrases}{C-c \\}
+\key{Visit index phrases buffer}{C-c |}
+\key{Compile and display index}{C-c >}
+\key{View cross reference$\sp1$}{C-c \&}
+\key{View cross reference with mouse}{S-mouse-2}
+\key{View cross reference from BibTeX file}{C-c \&}
+
+\section{Standard keys in special buffers}
+RefTeX's special buffers have many active keys.  The common ones are:
+
+\key{Display summary of active keys}{?}
+\key{Select this item}{RET}
+\key{Rescan the document}{r}
+\key{Display location in other window}{SPC}
+\key{Follow mode}{f}
+
+\section{Multifile actions}
+Since RefTeX scans the entire (multifile) document, it can provide
+commands that act on all files of a document.  Check the {\tt
+Ref->Global Avtions} menu for these commands.
+
+\section{Variables}
+
+To tell reftex about your own macro definitions, customize the
+variables
+\vskip-3mm
+\beginexample
+reftex-label-alist
+reftex-section-lecels
+reftex-index-macros
+reftex-cite-format
+\endexample
+
+\vskip2mm\hrule
+$\sp1$ An argument of \kbd{C-u} triggers a document scan first.  This can
+be necessary if file content and RefTeX's knowledge are no longer
+consistent.
+
+\newcolumn
+
+\title{RefTeX (compact)}
+
+\section{Activation in .emacs}
+
+\vskip-4mm
+\beginexample
+(add-hook 'latex-mode-hook 'turn-on-reftex)
+(add-hook 'LaTeX-mode-hook 'turn-on-reftex)
+(setq reftex-plug-into-auctex t)
+\endexample
+
+\section{Table of Contents}
+
+\key{Show the table of contents$\sp1$}{C-c =}
+\key{Recenter *toc* buffer to here$\sp1$}{C-c -}
+
+\section{Crossreferences, Citations, Index}
+
+\key{Insert unique label$\sp1$}{C-c (}
+\key{Reference a label$\sp1$}{C-c )}
+\key{Insert citation with key selection}{C-c [}
+\key{... prompt for optional arguments}{C-u C-c [}
+\key{Index  word at point with default macro}{C-c /}
+\key{Insert an index entry}{C-c <}
+\key{Add word to index phrases}{C-c \\}
+\key{Visit index phrases buffer}{C-c |}
+\key{Compile and display index}{C-c >}
+\key{View cross reference$\sp1$}{C-c \&}
+\key{View cross reference with mouse}{S-mouse-2}
+\key{View cross reference from BibTeX file}{C-c \&}
+
+\vskip2mm\hrule
+$\sp1$ An argument of \kbd{C-u} triggers a document scan first.
+
+\newcolumn
+
 \title{Math Mode}
 
 \section{Variables}