Function: rst-toc-mode

rst-toc-mode is an interactive and byte-compiled function defined in rst.el.gz.

Signature

(rst-toc-mode)

Documentation

Major mode for output from M-x rst-toc (rst-toc), the table-of-contents for the document.

<mouse-1> rst-toc-mode-mouse-follow-link-kill
<mouse-2> rst-toc-mouse-follow-link
RET rst-toc-mode-follow-link-kill
f rst-toc-mode-follow-link-kill
n next-line
p previous-line
q rst-toc-mode-return
z rst-toc-mode-return-kill

In addition to any hooks its parent mode special-mode might have run, this mode runs the hook rst-toc-mode-hook, as the final or penultimate step during initialization.

Key Bindings

Source Code

;; Defined in /usr/src/emacs/lisp/textmodes/rst.el.gz
(define-derived-mode rst-toc-mode special-mode "ReST-TOC"
  "Major mode for output from \\[rst-toc], the table-of-contents for the document.
\\{rst-toc-mode-map}"
  ;; FIXME: 'revert-buffer-function' must be defined so 'revert-buffer' works
  ;;        as expected for a special mode. In particular the referred buffer
  ;;        needs to be rescanned and the TOC must be updated accordingly.
  ;; FIXME: Should contain the name of the buffer this is the toc of.
  (setq header-line-format "Table of Contents"))