Next: , Previous: Selective export, Up: Exporting

12.2 Export options

The exporter recognizes special lines in the buffer which provide additional information. These lines may be put anywhere in the file. The whole set of lines can be inserted into the buffer with C-c C-e t. For individual lines, a good way to make sure the keyword is correct is to type ‘#+’ and then use M-<TAB> completion (see Completion). For a summary of other in-buffer settings not specifically related to export, see In-buffer settings. In particular, note that you can place commonly-used (export) options in a separate file which can be included using #+SETUPFILE.

C-c C-e t     (org-insert-export-options-template)
Insert template with export options, see example below.

     #+TITLE:       the title to be shown (default is the buffer name)
     #+AUTHOR:      the author (default taken from user-full-name)
     #+DATE:        a date, an Org timestamp1, or a format string for format-time-string
     #+EMAIL:       his/her email address (default from user-mail-address)
     #+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., ‘en’ (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., org-export-latex-low-levels itemize
                    You need to confirm using these, or configure org-export-allow-BIND
     #+LINK_UP:     the ``up'' link of an exported page
     #+LINK_HOME:   the ``home'' link of an exported page
     #+LaTeX_HEADER: extra line(s) for the LaTeX header, like \usepackage{xyz}
     #+EXPORT_SELECT_TAGS:   Tags that select a tree for export
     #+EXPORT_EXCLUDE_TAGS:  Tags that exclude a tree from export
     #+XSLT:        the XSLT stylesheet used by DocBook exporter to generate FO file

The #+OPTIONS line is a compact2 form to specify export settings. Here you can:

     H:         set the number of headline levels for export
     num:       turn on/off section-numbers
     toc:       turn on/off table of contents, or set level limit (integer)
     \n:        turn on/off line-break-preservation (DOES NOT WORK)
     @:         turn on/off quoted HTML tags
     ::         turn on/off fixed-width sections
     |:         turn on/off tables
     ^:         turn on/off TeX-like syntax for sub- and superscripts.  If
                you write "^:{}", a_{b} will be interpreted, but
                the simple a_b will be left as it is.
     -:         turn on/off conversion of special strings.
     f:         turn on/off footnotes like this[1].
     todo:      turn on/off inclusion of TODO keywords into exported text
     tasks:     turn on/off inclusion of tasks (TODO items), can be nil to remove
                all tasks, todo to remove DONE tasks, or list of kwds to keep
     pri:       turn on/off priority cookies
     tags:      turn on/off inclusion of tags, may also be not-in-toc
     <:         turn on/off inclusion of any time/date stamps like DEADLINES
     *:         turn on/off emphasized text (bold, italic, underlined)
     TeX:       turn on/off simple TeX macros in plain text
     LaTeX:     configure export of LaTeX fragments.  Default auto
     skip:      turn on/off skipping the text before the first heading
     author:    turn on/off inclusion of author name/email into exported file
     email:     turn on/off inclusion of author email into exported file
     creator:   turn on/off inclusion of creator info into exported file
     timestamp: turn on/off inclusion creation time into exported file
     d:         turn on/off inclusion of drawers, or list drawers to include

These options take effect in both the HTML and LaTeX export, except for TeX and LaTeX options, which are respectively t and nil for the LaTeX export.

The default values for these and many other options are given by a set of variables. For a list of such variables, the corresponding OPTIONS keys and also the publishing keys (see Project alist), see the constant org-export-plist-vars.

When exporting only a single subtree by selecting it with C-c @ before calling an export command, the subtree can overrule some of the file's export settings with properties EXPORT_FILE_NAME, EXPORT_TITLE, EXPORT_TEXT, EXPORT_AUTHOR, EXPORT_DATE, and EXPORT_OPTIONS.


[1] org-export-date-timestamp-format defines how this timestamp will be exported.

[2] If you want to configure many options this way, you can use several #+OPTIONS lines.