13.1 The Export Dispatcher

The export dispatcher is the main interface for Org’s exports. A hierarchical menu presents the currently configured export formats. Options are shown as easy toggle switches on the same screen.

Org also has a minimal prompt interface for the export dispatcher. When the variable org-export-dispatch-use-expert-ui is set to a non-nil value, Org prompts in the minibuffer. To switch back to the hierarchical menu, press ?.

C-c C-e (org-export-dispatch)

Invokes the export dispatcher interface. The options show default settings. The C-u prefix argument preserves options from the previous export, including any subtree selections.

Org exports the entire buffer by default. If the Org buffer has an active region, then Org exports just that region.

Within the dispatcher interface, the following key combinations can further alter what is exported, and how.

C-a

Toggle asynchronous export. Asynchronous export uses an external Emacs process with a specially configured initialization file to complete the exporting process in the background, without tying-up Emacs. This is particularly useful when exporting long documents.

Output from an asynchronous export is saved on the export stack. To view this stack, call the export dispatcher with a double C-u prefix argument. If already in the export dispatcher menu, & displays the stack.

You can make asynchronous export the default by setting org-export-in-background.

You can set the initialization file used by the background process by setting org-export-async-init-file.

C-b

Toggle body-only export. Useful for excluding headers and footers in the export. Affects only those back-end formats that have sections like ‘<head>...</head>’ in HTML.

C-s

Toggle subtree export. When turned on, Org exports only the subtree starting from point position at the time the export dispatcher was invoked. Org uses the top heading of this subtree as the document’s title. If point is not on a heading, Org uses the nearest enclosing header. If point is in the document preamble, Org signals an error and aborts export.

To make subtree export the default, customize the variable org-export-initial-scope.

C-v

Toggle visible-only export. This is useful for exporting only certain parts of an Org document by adjusting the visibility of particular headings. See also Sparse Trees.