Variable: org-export-with-toc

org-export-with-toc is a customizable variable defined in ox.el.gz.

Value

t

Documentation

Non-nil means create a table of contents in exported files.

The table of contents contains headlines with levels up to org-export-headline-levels.

When this variable is set to an integer N, include levels up to N in the table of contents. Although it may then be different from org-export-headline-levels, it is cannot be larger than the number of headline levels.

When nil, no table of contents is created.

This option can also be set with the OPTIONS keyword, e.g. "toc:nil" or "toc:3".

Source Code

;; Defined in /usr/src/emacs/lisp/org/ox.el.gz
(defcustom org-export-with-toc t
  "Non-nil means create a table of contents in exported files.

The table of contents contains headlines with levels up to
`org-export-headline-levels'.

When this variable is set to an integer N, include levels up to
N in the table of contents.  Although it may then be different
from `org-export-headline-levels', it is cannot be larger than
the number of headline levels.

When nil, no table of contents is created.

This option can also be set with the OPTIONS keyword,
e.g. \"toc:nil\" or \"toc:3\"."
  :group 'org-export-general
  :type '(choice
	  (const :tag "No Table of Contents" nil)
	  (const :tag "Full Table of Contents" t)
	  (integer :tag "TOC to level"))
  :safe (lambda (x)
	  (or (booleanp x)
	      (integerp x))))