org.texi: Add documentation for optional title
* doc/org.texi (Table of contents): Add documentation for optional title and #+TOC: keyword.
This commit is contained in:
parent
d790fbd489
commit
cf9bc7819b
20
doc/org.texi
20
doc/org.texi
|
@ -9167,20 +9167,28 @@ per-file basis with a line
|
||||||
@subheading Table of contents
|
@subheading Table of contents
|
||||||
@cindex table of contents, markup rules
|
@cindex table of contents, markup rules
|
||||||
|
|
||||||
|
@cindex #+TOC
|
||||||
@vindex org-export-with-toc
|
@vindex org-export-with-toc
|
||||||
The table of contents is normally inserted directly before the first headline
|
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 the
|
of the file. If you would like to get it to a different location, insert
|
||||||
string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired
|
@code{#+TOC: headlines} at the desired location. The depth of the table of
|
||||||
location. The depth of the table of contents is by default the same as the
|
contents is by default the same as the number of headline levels, but you can
|
||||||
number of headline levels, but you can choose a smaller number, or turn off
|
choose a smaller number, or turn off the table of contents entirely, by
|
||||||
the table of contents entirely, by configuring the variable
|
configuring the variable @code{org-export-with-toc}, or on a per-file basis
|
||||||
@code{org-export-with-toc}, or on a per-file basis with a line like
|
with a line like
|
||||||
|
|
||||||
@example
|
@example
|
||||||
#+OPTIONS: toc:2 (only to two levels in TOC)
|
#+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 TOC at all)
|
||||||
@end example
|
@end example
|
||||||
|
|
||||||
|
@cindex property, OPTIONAL_TITLE
|
||||||
|
The headline's title usually determines its corresponding entry in a table of
|
||||||
|
contents. However, it is possible to specifify an alternative title by
|
||||||
|
setting @code{:OPTIONAL_TITLE:} property accordingly. It will then be used
|
||||||
|
when building the table.
|
||||||
|
|
||||||
@node Initial text, Lists, Table of contents, Structural markup elements
|
@node Initial text, Lists, Table of contents, Structural markup elements
|
||||||
@subheading Text before the first headline
|
@subheading Text before the first headline
|
||||||
@cindex text before first headline, markup rules
|
@cindex text before first headline, markup rules
|
||||||
|
|
Loading…
Reference in New Issue