Function: reftex-mode

reftex-mode is an autoloaded, interactive and byte-compiled function defined in reftex.el.gz.

Signature

(reftex-mode &optional ARG)

Documentation

Minor mode with distinct support for \label, \ref and \cite in LaTeX.

A Table of Contents of the entire (multifile) document with browsing capabilities is available with C-c = (reftex-toc).

Labels can be created with C-c ( (reftex-label) and referenced with C-c ) (reftex-reference). When referencing, you get a menu with all labels of a given type and context of the label definition. The selected label is inserted as a
\ref macro.

Citations can be made with C-c [ (reftex-citation) which will use a regular expression to pull out a *formatted* list of articles from your BibTeX database. The selected citation is inserted as a \cite macro.

Index entries can be made with C-c / (reftex-index-selection-or-word) which indexes the word at point or the current selection. More general index entries are created with C-c < (reftex-index). C-c > (reftex-display-index) displays the compiled index.

Most command have help available on the fly. This help is accessed by pressing ? to any prompt mentioning this feature.

Extensive documentation about RefTeX is available in Info format. You can view this information with M-x reftex-info (reftex-info).

C-c & reftex-view-crossref
C-c ( reftex-label
C-c ) reftex-reference
C-c - reftex-toc-recenter
C-c / reftex-index-selection-or-word
C-c < reftex-index
C-c = reftex-toc
C-c > reftex-display-index
C-c [ reftex-citation
C-c \ reftex-index-phrase-selection-or-word
C-c | reftex-index-visit-phrases-buffer
S-<mouse-2> reftex-mouse-view-crossref
Under X, these and other functions will also be available as Ref menu on the menu bar.

------------------------------------------------------------------------------

This is a minor mode. If called interactively, toggle the Reftex mode mode. If the prefix argument is positive, enable the mode, and if it is zero or negative, disable the mode.

If called from Lisp, toggle the mode if ARG is toggle. Enable the mode if ARG is nil, omitted, or is a positive number. Disable the mode if ARG is a negative number.

To check whether the minor mode is enabled in the current buffer, evaluate the variable reftex-mode(var)/reftex-mode(fun).

The mode's hook is called both when the mode is enabled and when it is disabled.

Probably introduced at or before Emacs version 20.1.

Key Bindings

Source Code

;; Defined in /usr/src/emacs/lisp/textmodes/reftex.el.gz
;;;###autoload
(define-minor-mode reftex-mode
  "Minor mode with distinct support for \\label, \\ref and \\cite in LaTeX.

\\<reftex-mode-map>A Table of Contents of the entire (multifile) document with browsing
capabilities is available with `\\[reftex-toc]'.

Labels can be created with `\\[reftex-label]' and referenced with `\\[reftex-reference]'.
When referencing, you get a menu with all labels of a given type and
context of the label definition.  The selected label is inserted as a
\\ref macro.

Citations can be made with `\\[reftex-citation]' which will use a regular expression
to pull out a *formatted* list of articles from your BibTeX
database.  The selected citation is inserted as a \\cite macro.

Index entries can be made with `\\[reftex-index-selection-or-word]' which indexes the word at point
or the current selection.  More general index entries are created with
`\\[reftex-index]'.  `\\[reftex-display-index]' displays the compiled index.

Most command have help available on the fly.  This help is accessed by
pressing `?' to any prompt mentioning this feature.

Extensive documentation about RefTeX is available in Info format.
You can view this information with `\\[reftex-info]'.

\\{reftex-mode-map}
Under X, these and other functions will also be available as `Ref' menu
on the menu bar.

------------------------------------------------------------------------------"
  :lighter " Ref" :keymap reftex-mode-map
  (if reftex-mode
      (progn
        ;; Mode was turned on
        (and reftex-plug-into-AUCTeX
             (reftex-plug-into-AUCTeX))
        (unless (get 'reftex-auto-view-crossref 'initialized)
          (and reftex-auto-view-crossref
               (reftex-toggle-auto-view-crossref))
          (put 'reftex-auto-view-crossref 'initialized t))
        (unless (get 'reftex-auto-recenter-toc 'initialized)
          (and (eq reftex-auto-recenter-toc t)
               (reftex-toggle-auto-toc-recenter))
          (put 'reftex-auto-recenter-toc 'initialized t))

        ;; Prepare the special syntax tables.
	(reftex--prepare-syntax-tables)

        (run-hooks 'reftex-mode-hook))))