forked from mirrors/org-mode
org.texi: Move "Comment lines" and "Table of contents"
* doc/org.texi (Top): Update menu. (Structural markup elements): Move "Table of contents" and "Comment lines" nodes from here... (Exporting): ... to there.
This commit is contained in:
parent
8168c61ebc
commit
b94ef2e3d7
171
doc/org.texi
171
doc/org.texi
|
@ -549,11 +549,9 @@ Markup for rich export
|
||||||
|
|
||||||
Structural markup elements
|
Structural markup elements
|
||||||
|
|
||||||
* Table of contents:: The if and where of the table of contents
|
|
||||||
* Paragraphs:: Paragraphs
|
* Paragraphs:: Paragraphs
|
||||||
* Emphasis and monospace:: Bold, italic, etc.
|
* Emphasis and monospace:: Bold, italic, etc.
|
||||||
* Horizontal rules:: Make a line
|
* Horizontal rules:: Make a line
|
||||||
* Comment lines:: What will *not* be exported
|
|
||||||
|
|
||||||
Embedded @LaTeX{}
|
Embedded @LaTeX{}
|
||||||
|
|
||||||
|
@ -568,8 +566,10 @@ Exporting
|
||||||
* The export dispatcher:: The main exporter interface
|
* The export dispatcher:: The main exporter interface
|
||||||
* Export back-ends:: Built-in export formats
|
* Export back-ends:: Built-in export formats
|
||||||
* Export settings:: Generic export settings
|
* Export settings:: Generic export settings
|
||||||
|
* Table of contents:: The if and where of the table of contents
|
||||||
* Include files:: Include additional files into a document
|
* Include files:: Include additional files into a document
|
||||||
* Macro replacement:: Use macros to create templates
|
* Macro replacement:: Use macros to create templates
|
||||||
|
* Comment lines:: What will not be exported
|
||||||
* ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
|
* ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
|
||||||
* Beamer export:: Exporting as a Beamer presentation
|
* Beamer export:: Exporting as a Beamer presentation
|
||||||
* HTML export:: Exporting to HTML
|
* HTML export:: Exporting to HTML
|
||||||
|
@ -9732,67 +9732,11 @@ markup rules used in an Org mode buffer.
|
||||||
@section Structural markup elements
|
@section Structural markup elements
|
||||||
|
|
||||||
@menu
|
@menu
|
||||||
* Table of contents:: The if and where of the table of contents
|
|
||||||
* Paragraphs:: Paragraphs
|
* Paragraphs:: Paragraphs
|
||||||
* Emphasis and monospace:: Bold, italic, etc.
|
* Emphasis and monospace:: Bold, italic, etc.
|
||||||
* Horizontal rules:: Make a line
|
* Horizontal rules:: Make a line
|
||||||
* Comment lines:: What will *not* be exported
|
|
||||||
@end menu
|
@end menu
|
||||||
|
|
||||||
@node Table of contents
|
|
||||||
@subheading Table of contents
|
|
||||||
@cindex table of contents, markup rules
|
|
||||||
|
|
||||||
@cindex #+TOC
|
|
||||||
@vindex org-export-with-toc
|
|
||||||
The table of contents is normally inserted directly before the first headline
|
|
||||||
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 @r{only inlcude two levels in TOC}
|
|
||||||
#+OPTIONS: toc:nil @r{no default TOC at all}
|
|
||||||
@end example
|
|
||||||
|
|
||||||
If you would like to move the table of contents to a different location, you
|
|
||||||
should turn off the default 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 @r{no default TOC}
|
|
||||||
...
|
|
||||||
#+TOC: headlines 2 @r{insert TOC here, with two headline levels}
|
|
||||||
@end example
|
|
||||||
|
|
||||||
Moreover, if you append @samp{local} parameter, the table contains only
|
|
||||||
entries for the children of the current section@footnote{For @LaTeX{} export,
|
|
||||||
this feature requires the @code{titletoc} package. Note that @code{titletoc}
|
|
||||||
must be loaded @emph{before} @code{hyperref}. Thus, you may have to
|
|
||||||
customize @code{org-latex-default-packages-alist}.}. In this case, any depth
|
|
||||||
parameter becomes relative to the current level.
|
|
||||||
|
|
||||||
@example
|
|
||||||
* Section
|
|
||||||
#+TOC: headlines 1 local @r{insert local TOC, with direct children only}
|
|
||||||
@end example
|
|
||||||
|
|
||||||
The same @code{TOC} keyword can also generate a list of all tables (resp.@:
|
|
||||||
all listings) with a caption in the document.
|
|
||||||
|
|
||||||
@example
|
|
||||||
#+TOC: listings @r{build a list of listings}
|
|
||||||
#+TOC: tables @r{build a list of tables}
|
|
||||||
@end example
|
|
||||||
|
|
||||||
@cindex property, ALT_TITLE
|
|
||||||
The headline's title usually determines its corresponding entry in a table of
|
|
||||||
contents. However, it is possible to specify an alternative title by
|
|
||||||
setting @code{ALT_TITLE} property accordingly. It will then be used when
|
|
||||||
building the table.
|
|
||||||
|
|
||||||
@node Paragraphs
|
@node Paragraphs
|
||||||
@subheading Paragraphs, line breaks, and quoting
|
@subheading Paragraphs, line breaks, and quoting
|
||||||
@cindex paragraphs, markup rules
|
@cindex paragraphs, markup rules
|
||||||
|
@ -9866,33 +9810,6 @@ may need to restart Emacs.
|
||||||
A line consisting of only dashes, and at least 5 of them, will be exported as
|
A line consisting of only dashes, and at least 5 of them, will be exported as
|
||||||
a horizontal line.
|
a horizontal line.
|
||||||
|
|
||||||
@node Comment lines
|
|
||||||
@subheading Comment lines
|
|
||||||
@cindex comment lines
|
|
||||||
@cindex exporting, not
|
|
||||||
@cindex #+BEGIN_COMMENT
|
|
||||||
|
|
||||||
Lines starting with zero or more whitespace characters followed by one
|
|
||||||
@samp{#} and a whitespace are treated as comments and, as such, are not
|
|
||||||
exported.
|
|
||||||
|
|
||||||
Likewise, regions surrounded by @samp{#+BEGIN_COMMENT}
|
|
||||||
... @samp{#+END_COMMENT} are not exported.
|
|
||||||
|
|
||||||
Finally, a @samp{COMMENT} keyword at the beginning of an entry, but after any
|
|
||||||
other keyword or priority cookie, comments out the entire subtree. In this
|
|
||||||
case, the subtree is not exported and no code block within it is executed
|
|
||||||
either@footnote{For a less drastic behavior, consider using a select tag
|
|
||||||
(@pxref{Export settings}) instead.}. The command below helps changing the
|
|
||||||
comment status of a headline.
|
|
||||||
|
|
||||||
@table @kbd
|
|
||||||
@kindex C-c ;
|
|
||||||
@item C-c ;
|
|
||||||
Toggle the @samp{COMMENT} keyword at the beginning of an entry.
|
|
||||||
@end table
|
|
||||||
|
|
||||||
|
|
||||||
@node Images and tables
|
@node Images and tables
|
||||||
@section Images and Tables
|
@section Images and Tables
|
||||||
|
|
||||||
|
@ -10402,8 +10319,10 @@ appointments to produce a file in the iCalendar format.
|
||||||
* The export dispatcher:: The main exporter interface
|
* The export dispatcher:: The main exporter interface
|
||||||
* Export back-ends:: Built-in export formats
|
* Export back-ends:: Built-in export formats
|
||||||
* Export settings:: Generic export settings
|
* Export settings:: Generic export settings
|
||||||
|
* Table of contents:: The if and where of the table of contents
|
||||||
* Include files:: Include additional files into a document
|
* Include files:: Include additional files into a document
|
||||||
* Macro replacement:: Use macros to create templates
|
* Macro replacement:: Use macros to create templates
|
||||||
|
* Comment lines:: What will not be exported
|
||||||
* ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
|
* ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
|
||||||
* Beamer export:: Exporting as a Beamer presentation
|
* Beamer export:: Exporting as a Beamer presentation
|
||||||
* HTML export:: Exporting to HTML
|
* HTML export:: Exporting to HTML
|
||||||
|
@ -10774,6 +10693,62 @@ you can also set @code{EXPORT_FILE_NAME} property. In all cases, only the
|
||||||
base name of the file is retained, and a back-end specific extension is
|
base name of the file is retained, and a back-end specific extension is
|
||||||
added.
|
added.
|
||||||
|
|
||||||
|
@node Table of contents
|
||||||
|
@section Table of contents
|
||||||
|
@cindex table of contents
|
||||||
|
@cindex list of tables
|
||||||
|
@cindex list of listings
|
||||||
|
|
||||||
|
@cindex #+TOC
|
||||||
|
@vindex org-export-with-toc
|
||||||
|
The table of contents is normally inserted directly before the first headline
|
||||||
|
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 @r{only inlcude two levels in TOC}
|
||||||
|
#+OPTIONS: toc:nil @r{no default TOC at all}
|
||||||
|
@end example
|
||||||
|
|
||||||
|
If you would like to move the table of contents to a different location, you
|
||||||
|
should turn off the default 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 @r{no default TOC}
|
||||||
|
...
|
||||||
|
#+TOC: headlines 2 @r{insert TOC here, with two headline levels}
|
||||||
|
@end example
|
||||||
|
|
||||||
|
Moreover, if you append @samp{local} parameter, the table contains only
|
||||||
|
entries for the children of the current section@footnote{For @LaTeX{} export,
|
||||||
|
this feature requires the @code{titletoc} package. Note that @code{titletoc}
|
||||||
|
must be loaded @emph{before} @code{hyperref}. Thus, you may have to
|
||||||
|
customize @code{org-latex-default-packages-alist}.}. In this case, any depth
|
||||||
|
parameter becomes relative to the current level.
|
||||||
|
|
||||||
|
@example
|
||||||
|
* Section
|
||||||
|
#+TOC: headlines 1 local @r{insert local TOC, with direct children only}
|
||||||
|
@end example
|
||||||
|
|
||||||
|
The same @code{TOC} keyword can also generate a list of all tables (resp.@:
|
||||||
|
all listings) with a caption in the document.
|
||||||
|
|
||||||
|
@example
|
||||||
|
#+TOC: listings @r{build a list of listings}
|
||||||
|
#+TOC: tables @r{build a list of tables}
|
||||||
|
@end example
|
||||||
|
|
||||||
|
@cindex property, ALT_TITLE
|
||||||
|
The headline's title usually determines its corresponding entry in a table of
|
||||||
|
contents. However, it is possible to specify an alternative title by
|
||||||
|
setting @code{ALT_TITLE} property accordingly. It will then be used when
|
||||||
|
building the table.
|
||||||
|
|
||||||
@node Include files
|
@node Include files
|
||||||
@section Include files
|
@section Include files
|
||||||
@cindex include files, during export
|
@cindex include files, during export
|
||||||
|
@ -10920,6 +10895,32 @@ The surrounding brackets can be made invisible by setting
|
||||||
|
|
||||||
Macro expansion takes place during the very beginning of the export process.
|
Macro expansion takes place during the very beginning of the export process.
|
||||||
|
|
||||||
|
@node Comment lines
|
||||||
|
@section Comment lines
|
||||||
|
@cindex comment lines
|
||||||
|
@cindex exporting, not
|
||||||
|
@cindex #+BEGIN_COMMENT
|
||||||
|
|
||||||
|
Lines starting with zero or more whitespace characters followed by one
|
||||||
|
@samp{#} and a whitespace are treated as comments and, as such, are not
|
||||||
|
exported.
|
||||||
|
|
||||||
|
Likewise, regions surrounded by @samp{#+BEGIN_COMMENT}
|
||||||
|
... @samp{#+END_COMMENT} are not exported.
|
||||||
|
|
||||||
|
Finally, a @samp{COMMENT} keyword at the beginning of an entry, but after any
|
||||||
|
other keyword or priority cookie, comments out the entire subtree. In this
|
||||||
|
case, the subtree is not exported and no code block within it is executed
|
||||||
|
either@footnote{For a less drastic behavior, consider using a select tag
|
||||||
|
(@pxref{Export settings}) instead.}. The command below helps changing the
|
||||||
|
comment status of a headline.
|
||||||
|
|
||||||
|
@table @kbd
|
||||||
|
@kindex C-c ;
|
||||||
|
@item C-c ;
|
||||||
|
Toggle the @samp{COMMENT} keyword at the beginning of an entry.
|
||||||
|
@end table
|
||||||
|
|
||||||
@node ASCII/Latin-1/UTF-8 export
|
@node ASCII/Latin-1/UTF-8 export
|
||||||
@section ASCII/Latin-1/UTF-8 export
|
@section ASCII/Latin-1/UTF-8 export
|
||||||
@cindex ASCII export
|
@cindex ASCII export
|
||||||
|
|
Loading…
Reference in New Issue