summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBastien Guerry <bzg@altern.org>2013-03-24 19:14:43 +0100
committerBastien Guerry <bzg@altern.org>2013-03-25 05:41:59 +0100
commit225289c2db35048cf41981fc998188ae4dfb20a4 (patch)
tree039dfa588accb313f519d5249e954d7cac1d2a97
parent7f2f8457001e8eeace67136e14bc02e314815e95 (diff)
downloadorg-mode-225289c2db35048cf41981fc998188ae4dfb20a4.tar.gz
doc/org.texi: Reflect changes from the new export engine
* org.texi (Sparse trees, Agenda commands) (@LaTeX{} fragments, Selective export, Export options) (Export options, Export options, The export dispatcher) (ASCII/Latin-1/UTF-8 export, ASCII/Latin-1/UTF-8 export) (HTML Export commands, HTML Export commands) (@LaTeX{}/PDF export commands, @LaTeX{}/PDF export commands) (ODT export commands, ODT export commands, iCalendar export) (Publishing options, Publishing options) (Triggering publication, In-buffer settings): Update to reflect changes from the new export engine.
-rw-r--r--doc/org.texi233
1 files changed, 106 insertions, 127 deletions
diff --git a/doc/org.texi b/doc/org.texi
index d1d4ec3..54da5f4 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -1609,15 +1609,15 @@ a sparse tree matching the string @samp{FIXME}.
The other sparse tree commands select headings based on TODO keywords,
tags, or properties and will be discussed later in this manual.
-@kindex C-c C-e v
+@kindex C-c C-e C-v
@cindex printing sparse trees
@cindex visible text, printing
To print a sparse tree, you can use the Emacs command
@code{ps-print-buffer-with-faces} which does not print invisible parts
of the document @footnote{This does not work under XEmacs, because
XEmacs uses selective display for outlining, not text properties.}.
-Or you can use the command @kbd{C-c C-e v} to export only the visible
-part of the document and print the resulting file.
+Or you can use @kbd{C-c C-e C-v} to export only the visible part of
+the document and print the resulting file.
@node Plain lists, Drawers, Sparse trees, Document Structure
@section Plain lists
@@ -8792,7 +8792,7 @@ calendars.
@orgcmd{H,org-agenda-holidays}
Show holidays for three months around the cursor date.
-@item M-x org-export-icalendar-combine-agenda-files
+@item M-x org-icalendar-combine-agenda-files
Export a single iCalendar file containing entries from all agenda files.
This is a globally available command, and also available in the agenda menu.
@@ -9883,18 +9883,19 @@ If $a^2=b$ and \( b=2 \), then the solution must be
either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
@end example
-@noindent
-@vindex org-format-latex-options
-If you need any of the delimiter ASCII sequences for other purposes, you
-can configure the option @code{org-format-latex-options} to deselect the
-ones you do not wish to have interpreted by the @LaTeX{} converter.
+@c FIXME
+@c @noindent
+@c @vindex org-format-latex-options
+@c If you need any of the delimiter ASCII sequences for other purposes, you
+@c can configure the option @code{org-format-latex-options} to deselect the
+@c ones you do not wish to have interpreted by the @LaTeX{} converter.
-@vindex org-export-with-LaTeX-fragments
+@vindex org-export-with-latex
@LaTeX{} processing can be configured with the variable
-@code{org-export-with-LaTeX-fragments}. The default setting is @code{t}
-which means @file{MathJax} for HTML, and no processing for ASCII and @LaTeX{}
-backends. You can also set this variable on a per-file basis using one of
-these lines:
+@code{org-export-with-latex}. The default setting is @code{t} which means
+@file{MathJax} for HTML, and no processing for ASCII and @LaTeX{} backends.
+You can also set this variable on a per-file basis using one of these
+lines:
@example
#+OPTIONS: LaTeX:t @r{Do the right thing automatically (MathJax)}
@@ -10061,7 +10062,7 @@ Finally, all subtrees that are marked by any of the @emph{exclude} tags will
be removed from the export buffer.
@end enumerate
-The variable @code{org-export-with-tasks} can be configured to select which
+The variable @var{org-export-with-tasks} can be configured to select which
kind of tasks should be included for export. See the docstring of the
variable for more information.
@@ -10077,14 +10078,11 @@ C-e t}. For individual lines, a good way to make sure the keyword is
correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
(@pxref{Completion}). For a summary of other in-buffer settings not
specifically related to export, see @ref{In-buffer settings}.
+
In particular, note that you can place commonly-used (export) options in
a separate file which can be included using @code{#+SETUPFILE}.
@table @kbd
-@orgcmd{C-c C-e t,org-insert-export-options-template}
-Insert template with export options, see example below.
-@end table
-
@cindex #+TITLE
@cindex #+AUTHOR
@cindex #+DATE
@@ -10095,15 +10093,17 @@ Insert template with export options, see example below.
@cindex #+TEXT
@cindex #+OPTIONS
@cindex #+BIND
+@cindex #HTML_HEAD
@cindex #+HTML_LINK_UP
@cindex #+HTML_LINK_HOME
@cindex #+SELECT_TAGS
@cindex #+EXCLUDE_TAGS
@cindex #+LaTeX_HEADER
+@cindex #+LaTeX_HEADER_EXTRA
@vindex user-full-name
@vindex user-mail-address
@vindex org-export-default-language
-@vindex org-export-date-timestamp-format
+@c FIXME New name? @vindex org-export-date-timestamp-format
@example
#+TITLE: the title to be shown (default is the buffer name)
#+AUTHOR: the author (default taken from @code{user-full-name})
@@ -10112,14 +10112,15 @@ Insert template with export options, see example below.
#+DESCRIPTION: the page description, e.g., for the XHTML meta tag
#+KEYWORDS: the page keywords, e.g., for the XHTML meta tag
#+LANGUAGE: language for HTML, e.g., @samp{en} (@code{org-export-default-language})
-#+TEXT: Some descriptive text to be inserted at the beginning.
-#+TEXT: Several lines may be given.
#+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
#+BIND: lisp-var lisp-val, e.g., @code{org-latex-image-default-option width=.7\\linewidth}
@r{You need to confirm using these, or configure @code{org-export-allow-BIND}}
+#+HTML_HEAD: Additional line to the @samp{<head>...</head>} of the HTML output
#+HTML_LINK_UP: the ``up'' link of an exported page
#+HTML_LINK_HOME: the ``home'' link of an exported page
#+LaTeX_HEADER: extra line(s) for the @LaTeX{} header, like \usepackage@{xyz@}
+@c FIXME
+#+LaTeX_HEADER_EXTRA: extra line(s) for the @LaTeX{} header, used in special contexts
#+SELECT_TAGS: Tags that select a tree for export
#+EXCLUDE_TAGS: Tags that exclude a tree from export
@end example
@@ -10205,14 +10206,13 @@ the subtrees are exported.
@table @kbd
@orgcmd{C-c C-e,org-export}
-@vindex org-export-run-in-background
Dispatcher for export and publishing commands. Displays a help-window
listing the additional key(s) needed to launch an export or publishing
command. The prefix arg is passed through to the exporter. A double prefix
@kbd{C-u C-u} causes most commands to be executed in the background, in a
separate Emacs process@footnote{To make this behavior the default, customize
the variable @code{org-export-run-in-background}.}.
-@orgcmd{C-c C-e v,org-export-visible}
+@orgcmd{C-c C-e C-v,org-export-visible}
Like @kbd{C-c C-e}, but only export the text that is currently visible
(i.e., not hidden by outline visibility).
@orgcmd{C-u C-u C-c C-e,org-export}
@@ -10236,7 +10236,7 @@ with special characters and symbols available in these encodings.
@cindex active region
@cindex transient-mark-mode
@table @kbd
-@orgcmd{C-c C-e a,org-export-as-ascii}
+@orgcmd{C-c C-e t a,org-ascii-export-to-ascii}
@cindex property, EXPORT_FILE_NAME
Export as an ASCII file. For an Org file, @file{myfile.org}, the ASCII file
will be @file{myfile.txt}. The file will be overwritten without
@@ -10247,41 +10247,36 @@ current subtree, use @kbd{C-c @@}.}, the tree head will
become the document title. If the tree head entry has or inherits an
@code{EXPORT_FILE_NAME} property, that name will be used for the
export.
-@orgcmd{C-c C-e A,org-export-as-ascii-to-buffer}
+@orgcmd{C-c C-e t A,org-ascii-export-as-ascii}
Export to a temporary buffer. Do not create a file.
-@orgcmd{C-c C-e n,org-export-as-latin1}
-@xorgcmd{C-c C-e N,org-export-as-latin1-to-buffer}
-Like the above commands, but use Latin-1 encoding.
-@orgcmd{C-c C-e u,org-export-as-utf8}
-@xorgcmd{C-c C-e U,org-export-as-utf8-to-buffer}
-Like the above commands, but use UTF-8 encoding.
-@item C-c C-e v a/n/u
+@item C-c C-e C-v t a/t A
Export only the visible part of the document.
@end table
-@cindex headline levels, for exporting
-In the exported version, the first 3 outline levels will become
-headlines, defining a general document structure. Additional levels
-will be exported as itemized lists. If you want that transition to occur
-at a different level, specify it with a prefix argument. For example,
+@c FIXME Exporting sublevels
+@c @cindex headline levels, for exporting
+@c In the exported version, the first 3 outline levels will become
+@c headlines, defining a general document structure. Additional levels
+@c will be exported as itemized lists. If you want that transition to occur
+@c at a different level, specify it with a prefix argument. For example,
-@example
-@kbd{C-1 C-c C-e a}
-@end example
+@c @example
+@c @kbd{C-1 C-c C-e a}
+@c @end example
-@noindent
-creates only top level headlines and exports the rest as items. When
-headlines are converted to items, the indentation of the text following
-the headline is changed to fit nicely under the item. This is done with
-the assumption that the first body line indicates the base indentation of
-the body text. Any indentation larger than this is adjusted to preserve
-the layout relative to the first line. Should there be lines with less
-indentation than the first one, these are left alone.
-
-@vindex org-export-ascii-links-to-notes
+@c @noindent
+@c creates only top level headlines and exports the rest as items. When
+@c headlines are converted to items, the indentation of the text following
+@c the headline is changed to fit nicely under the item. This is done with
+@c the assumption that the first body line indicates the base indentation of
+@c the body text. Any indentation larger than this is adjusted to preserve
+@c the layout relative to the first line. Should there be lines with less
+@c indentation than the first one, these are left alone.
+
+@vindex org-ascii-links-to-notes
Links will be exported in a footnote-like style, with the descriptive part in
the text and the link in a note before the next heading. See the variable
-@code{org-export-ascii-links-to-notes} for details and other options.
+@code{org-ascii-links-to-notes} for details and other options.
@node HTML export, @LaTeX{} and PDF export, ASCII/Latin-1/UTF-8 export, Exporting
@section HTML export
@@ -10311,7 +10306,7 @@ language, but with additional support for tables.
@cindex active region
@cindex transient-mark-mode
@table @kbd
-@orgcmd{C-c C-e h,org-export-as-html}
+@orgcmd{C-c C-e h h,org-html-export-to-html}
@cindex property, EXPORT_FILE_NAME
Export as a HTML file. For an Org file @file{myfile.org},
the HTML file will be @file{myfile.html}. The file will be overwritten
@@ -10321,38 +10316,27 @@ exported. If the selected region is a single tree@footnote{To select the
current subtree, use @kbd{C-c @@}.}, the tree head will become the document
title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
property, that name will be used for the export.
-@orgcmd{C-c C-e b,org-export-as-html-and-open}
+@kbd{C-c C-e h o}
Export as a HTML file and immediately open it with a browser.
-@orgcmd{C-c C-e H,org-export-as-html-to-buffer}
+@orgcmd{C-c C-e h H,org-html-export-as-html}
Export to a temporary buffer. Do not create a file.
-@orgcmd{C-c C-e R,org-export-region-as-html}
-Export the active region to a temporary buffer. With a prefix argument, do
-not produce the file header and footer, but just the plain HTML section for
-the region. This is good for cut-and-paste operations.
-@item C-c C-e v h/b/H/R
+@item C-c C-e C-v h H/h h/h o
Export only the visible part of the document.
-@item M-x org-export-region-as-html
-Convert the region to HTML under the assumption that it was in Org mode
-syntax before. This is a global command that can be invoked in any
-buffer.
-@item M-x org-replace-region-by-HTML
-Replace the active region (assumed to be in Org mode syntax) by HTML
-code.
@end table
-@cindex headline levels, for exporting
-In the exported version, the first 3 outline levels will become headlines,
-defining a general document structure. Additional levels will be exported as
-itemized lists. If you want that transition to occur at a different level,
-specify it with a numeric prefix argument. For example,
+@c FIXME Exporting sublevels
+@c @cindex headline levels, for exporting
+@c In the exported version, the first 3 outline levels will become headlines,
+@c defining a general document structure. Additional levels will be exported as
+@c itemized lists. If you want that transition to occur at a different level,
+@c specify it with a numeric prefix argument. For example,
-@example
-@kbd{C-2 C-c C-e b}
-@end example
-
-@noindent
-creates two levels of headings and does the rest as items.
+@c @example
+@c @kbd{C-2 C-c C-e b}
+@c @end example
+@c @noindent
+@c creates two levels of headings and does the rest as items.
@node HTML preamble and postamble, Quoting HTML tags, HTML Export commands, HTML export
@subsection HTML preamble and postamble
@@ -10732,7 +10716,7 @@ be correctly exported: respect the hierarchy of sections.
@cindex active region
@cindex transient-mark-mode
@table @kbd
-@orgcmd{C-c C-e l,org-export-as-latex}
+@orgcmd{C-c C-e l l,org-latex-export-to-latex}
@cindex property EXPORT_FILE_NAME
Export as a @LaTeX{} file. For an Org file
@file{myfile.org}, the @LaTeX{} file will be @file{myfile.tex}. The file will
@@ -10742,40 +10726,34 @@ exported. If the selected region is a single tree@footnote{To select the
current subtree, use @kbd{C-c @@}.}, the tree head will become the document
title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME}
property, that name will be used for the export.
-@orgcmd{C-c C-e L,org-export-as-latex-to-buffer}
+@orgcmd{C-c C-e l L,org-latex-export-as-latex}
Export to a temporary buffer. Do not create a file.
-@item C-c C-e v l/L
+@item C-c C-e C-v l/L
Export only the visible part of the document.
-@item M-x org-export-region-as-latex
-Convert the region to @LaTeX{} under the assumption that it was in Org mode
-syntax before. This is a global command that can be invoked in any
-buffer.
-@item M-x org-replace-region-by-latex
-Replace the active region (assumed to be in Org mode syntax) by @LaTeX{}
-code.
-@orgcmd{C-c C-e p,org-export-as-pdf}
+@orgcmd{C-c C-e l p,org-latex-export-to-pdf}
Export as @LaTeX{} and then process to PDF.
-@orgcmd{C-c C-e d,org-export-as-pdf-and-open}
+@kbd{C-c C-e l o}
Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
@end table
-@cindex headline levels, for exporting
-@vindex org-latex-low-levels
-In the exported version, the first 3 outline levels will become
-headlines, defining a general document structure. Additional levels
-will be exported as description lists. The exporter can ignore them or
-convert them to a custom string depending on
-@code{org-latex-low-levels}.
+@c FIXME Exporting sublevels
+@c @cindex headline levels, for exporting
+@c @vindex org-latex-low-levels
+@c In the exported version, the first 3 outline levels will become
+@c headlines, defining a general document structure. Additional levels
+@c will be exported as description lists. The exporter can ignore them or
+@c convert them to a custom string depending on
+@c @code{org-latex-low-levels}.
-If you want that transition to occur at a different level, specify it
-with a numeric prefix argument. For example,
+@c If you want that transition to occur at a different level, specify it
+@c with a numeric prefix argument. For example,
-@example
-@kbd{C-2 C-c C-e l}
-@end example
+@c @example
+@c @kbd{C-2 C-c C-e l}
+@c @end example
-@noindent
-creates two levels of headings and does the rest as items.
+@c @noindent
+@c creates two levels of headings and does the rest as items.
@node Header and sectioning, Quoting @LaTeX{} code, @LaTeX{}/PDF export commands, @LaTeX{} and PDF export
@subsection Header and sectioning structure
@@ -11108,14 +11086,14 @@ output. Check the availability of this program before proceeding further.
@cindex active region
@cindex transient-mark-mode
@table @kbd
-@orgcmd{C-c C-e o,org-export-as-odt}
+@orgcmd{C-c C-e o o,org-odt-export-to-odt}
@cindex property EXPORT_FILE_NAME
Export as OpenDocument Text file.
@vindex org-export-odt-preferred-output-format
-If @code{org-export-odt-preferred-output-format} is specified, automatically
-convert the exported file to that format. @xref{x-export-to-other-formats, ,
+If @code{org-preferred-output-format} is specified, automatically convert
+the exported file to that format. @xref{x-export-to-other-formats, ,
Automatically exporting to other formats}.
For an Org file @file{myfile.org}, the ODT file will be
@@ -11127,13 +11105,13 @@ tree head will become the document title. If the tree head entry has, or
inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the
export.
-@orgcmd{C-c C-e O,org-export-as-odt-and-open}
+@kbd{C-c C-e o O}
Export as an OpenDocument Text file and open the resulting file.
-@vindex org-export-odt-preferred-output-format
-If @code{org-export-odt-preferred-output-format} is specified, open the
-converted file instead. @xref{x-export-to-other-formats, , Automatically
-exporting to other formats}.
+@vindex org-odt-preferred-output-format
+If @code{org-preferred-output-format} is specified, open the converted file
+instead. @xref{x-export-to-other-formats, , Automatically exporting to
+other formats}.
@end table
@node Extending ODT export, Applying custom styles, ODT export commands, OpenDocument Text export
@@ -12014,19 +11992,19 @@ In this way the UID remains unique, but a synchronization program can still
figure out from which entry all the different instances originate.
@table @kbd
-@orgcmd{C-c C-e i,org-export-icalendar-this-file}
-Create iCalendar entries for the current file and store them in the same
+@orgcmd{C-c C-e c f,org-icalendar-export-to-ics}
+Create iCalendar entries for the current buffer and store them in the same
directory, using a file extension @file{.ics}.
-@orgcmd{C-c C-e I, org-export-icalendar-all-agenda-files}
+@orgcmd{C-c C-e c a, org-icalendar-export-agenda-files}
@vindex org-agenda-files
-Like @kbd{C-c C-e i}, but do this for all files in
+Like @kbd{C-c C-e c f}, but do this for all files in
@code{org-agenda-files}. For each of these files, a separate iCalendar
file will be written.
-@orgcmd{C-c C-e c,org-export-icalendar-combine-agenda-files}
-@vindex org-combined-agenda-icalendar-file
+@orgcmd{C-c C-e c c,org-icalendar-combine-agenda-files}
+@vindex org-icalendar-combined-agenda-file
Create a single large iCalendar file from all files in
@code{org-agenda-files} and write it to the file given by
-@code{org-combined-agenda-icalendar-file}.
+@code{org-icalendar-combined-agenda-file}.
@end table
@vindex org-use-property-inheritance
@@ -12236,7 +12214,7 @@ respective variable for details.
@vindex org-export-with-done-tasks
@vindex org-export-with-priority
@vindex org-export-with-TeX-macros
-@vindex org-export-with-LaTeX-fragments
+@vindex org-export-with-latex
@vindex org-export-skip-text-before-1st-heading
@vindex org-export-with-fixed-width
@vindex org-export-with-timestamps
@@ -12283,7 +12261,7 @@ respective variable for details.
@item @code{:tasks} @tab @code{org-export-with-tasks}
@item @code{:priority} @tab @code{org-export-with-priority}
@item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros}
-@item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments}
+@item @code{:LaTeX-fragments} @tab @code{org-export-with-latex}
@item @code{:latex-listings} @tab @code{org-latex-listings}
@item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading}
@item @code{:fixed-width} @tab @code{org-export-with-fixed-width}
@@ -12559,13 +12537,13 @@ right place on the web server, and publishing images to it.
Once properly configured, Org can publish with the following commands:
@table @kbd
-@orgcmd{C-c C-e X,org-publish}
+@orgcmd{C-c C-e P x,org-publish}
Prompt for a specific project and publish all files that belong to it.
-@orgcmd{C-c C-e P,org-publish-current-project}
+@orgcmd{C-c C-e P p,org-publish-current-project}
Publish the project containing the current file.
-@orgcmd{C-c C-e F,org-publish-current-file}
+@orgcmd{C-c C-e P f,org-publish-current-file}
Publish only the current file.
-@orgcmd{C-c C-e E,org-publish-all}
+@orgcmd{C-c C-e P a,org-publish-all}
Publish every project.
@end table
@@ -14918,10 +14896,11 @@ this file, and (potentially) the corresponding @emph{fast tag selection}
keys. The corresponding variable is @code{org-tag-alist}.
@item #+TBLFM:
This line contains the formulas for the table directly above the line.
-@item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+DATE:,
+@item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+DATE:,
@itemx #+OPTIONS:, #+BIND:,
@itemx #+DESCRIPTION:, #+KEYWORDS:,
-@itemx #+LaTeX_HEADER:, #+HTML_HEAD:, #+HTML_LINK_UP:, #+HTML_LINK_HOME:,
+@itemx #+LaTeX_HEADER:, #+LaTeX_HEADER_EXTRA:,
+@itemx #+HTML_HEAD:, #+HTML_LINK_UP:, #+HTML_LINK_HOME:,
@itemx #+SELECT_TAGS:, #+EXCLUDE_TAGS:
These lines provide settings for exporting files. For more details see
@ref{Export options}.