summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCarsten Dominik <carsten.dominik@gmail.com>2013-05-02 03:20:51 (GMT)
committer Carsten Dominik <carsten.dominik@gmail.com>2013-05-02 03:20:51 (GMT)
commit73ce77f991f0adffe5ad6459eeca8f3bc38e54c8 (patch)
treef72c3db5eef5fb54b4ff2a3e8212393d18edd4ad
parent00badf1b70dcb3b40b4b833ad47ab6559005e2e2 (diff)
downloadorg-mode-73ce77f991f0adffe5ad6459eeca8f3bc38e54c8.zip
org-mode-73ce77f991f0adffe5ad6459eeca8f3bc38e54c8.tar.gz
Improve documentation of TOC placement.
* doc/org.texi: (Table of contents) Improve documentation of TOC placement.
-rw-r--r--doc/org.texi29
1 files changed, 19 insertions, 10 deletions
diff --git a/doc/org.texi b/doc/org.texi
index d97e41a..7437451 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -9607,21 +9607,30 @@ per-file basis with a line
@cindex #+TOC
@vindex org-export-with-toc
The table of contents is normally inserted directly before the first headline
-of the file. If you would like to get it to a different location, insert
-@code{#+TOC: headlines} at the desired location. The depth of the table of
-contents is by default the same as the number of headline levels, but you can
-choose a smaller number, or turn off the table of contents entirely, by
-configuring the variable @code{org-export-with-toc}, or on a per-file basis
-with a line like
+of the file. The depth of the table is by default the same as the number of
+headline levels, but you can choose a smaller number, or turn off the table
+of contents entirely, by configuring the variable @code{org-export-with-toc},
+or on a per-file basis with a line like
@example
#+OPTIONS: toc:2 (only to two levels in TOC)
-#+TOC: headlines 2 (the same, at a specific location)
-#+OPTIONS: toc:nil (no TOC at all)
+#+OPTIONS: toc:nil (no default TOC at all)
@end example
-The same @code{TOC} keyword can also generate a list of all tables (resp.@:
-all listings) with a caption in the buffer.
+If you would like to move the table of contents to a different location, you
+should turn off the detault table using @code{org-export-with-toc} or
+@code{#+OPTIONS} and insert @code{#+TOC: headlines N} at the desired
+location(s).
+
+@example
+#+OPTIONS: toc:nil (no default TOC)
+...
+#+TOC: headlines 2 (insert TOC here, with two headline levels)
+@end example
+
+Multiple @code{#+TOC: headline} lines are allowed. The same @code{TOC}
+keyword can also generate a list of all tables (resp.@: all listings) with a
+caption in the buffer.
@example
#+TOC: listings (build a list of listings)