This is the official manual for the latest Org-mode release.
Export options can be set: globally with variables; for an individual file by
making variables buffer-local with in-buffer settings (see In-buffer settings), by setting individual keywords, or by specifying them in a
compact form with the #+OPTIONS
keyword; or for a tree by setting
properties (see Properties and Columns). Options set at a specific level
override options set at a more general level.
In-buffer settings may appear anywhere in the file, either directly or
indirectly through a file included using ‘#+SETUPFILE: filename’ syntax.
Option keyword sets tailored to a particular back-end can be inserted from
the export dispatcher (see The Export Dispatcher) using the Insert
template
command by pressing <#>. To insert keywords individually,
a good way to make sure the keyword is correct is to type #+
and then
to use M-<TAB> for completion.
The export keywords available for every back-end, and their equivalent global variables, include:
user-full-name
).
org-export-creator-string
).
user-mail-address
).
org-export-default-language
). E.g., ‘#+LANGUAGE: fr’ will tell
Org to translate File (english) into Fichier (french) in the
clocktable.
org-export-select-tags
). The
default value is :export:
. Within a subtree tagged with
:export:
, you can still exclude entries with :noexport:
(see
below). When headlines are selectively exported with :export:
anywhere in a file, text before the first headline is ignored.
org-export-exclude-tags
).
The default value is :noexport:
. Entries with the :noexport:
tag will be unconditionally excluded from the export, even if they have an
:export:
tag.
The #+OPTIONS
keyword is a compact2 form that
recognizes the following arguments:
':
org-export-with-smart-quotes
).
*:
org-export-with-emphasize
).
-:
org-export-with-special-strings
).
::
org-export-with-fixed-width
).
<:
org-export-with-timestamps
).
:
org-export-preserve-breaks
).
^:
org-export-with-sub-superscripts
).
arch:
headline
to only
process the headline, skipping its contents
(org-export-with-archived-trees
).
author:
org-export-with-author
).
c:
org-export-with-clocks
).
creator:
comment
(org-export-with-creator
).
d:
org-export-with-drawers
).
e:
org-export-with-entities
).
email:
org-export-with-email
).
f:
org-export-with-footnotes
).
H:
org-export-headline-levels
). Below that level, headlines are treated
differently. In most back-ends, they become list items.
inline:
org-export-with-inlinetasks
).
num:
org-export-with-section-numbers
). It can also
be set to a number ‘n’, so only headlines at that level or above will be
numbered.
p:
org-export-with-planning
).
“Planning information” is the line containing the SCHEDULED:
, the
DEADLINE:
or the CLOSED:
cookies or a combination of them.
pri:
org-export-with-priority
).
stat:
org-export-with-statistics-cookies
).
tags:
not-in-toc
(org-export-with-tags
).
tasks:
nil
to remove all
tasks, todo
to remove DONE tasks, or a list of keywords to keep
(org-export-with-tasks
).
tex:
verbatim
(org-export-with-latex
).
timestamp:
org-export-time-stamp-file
).
toc:
org-export-with-toc
).
todo:
org-export-with-todo-keywords
).
|:
org-export-with-tables
).
When exporting only a subtree, each of the previous keywords3 can be overridden locally by special node properties. These begin with ‘EXPORT_’, followed by the name of the keyword they supplant. For example, ‘DATE’ and ‘OPTIONS’ keywords become, respectively, ‘EXPORT_DATE’ and ‘EXPORT_OPTIONS’ properties.
If org-export-allow-bind-keywords
is non-nil
, Emacs variables
can become buffer-local during export by using the BIND keyword. Its syntax
is ‘#+BIND: variable value’. This is particularly useful for in-buffer
settings that cannot be changed using specific keywords.
The name of the output file to be generated is taken from the file associated to the buffer, when possible, or asked to you otherwise. For subtree export, you can also set ‘EXPORT_FILE_NAME’ property. In all cases, only the base name of the file is retained, and a back-end specific extension is added.