git.iko.soy/typeable/pandoc
on master help sign in
doc/org.md: describe all supported export options in detail
commitcd3941d34e578f2ebd4dd11484fc26c7afae8a6a authorAlbert Krewinkel <albert@zeitkraut.de> dateSat 27 Jun 2020, 10:10 (6 years ago) parent8dce28d
1 file changed+57
doc/org.md+57
doc/org.md+57
@@ -36,6 +36,63 @@ The following export keywords are supported:
3636 defaults to stdout unless a target has to be given as a command
3737 line option.
3838
39+Format-specific options
40+-----------------------
41+
42+Emacs Org-mode supports additional export options which work for
43+specific export formats. Some of these options' behavior differs
44+in Org-mode depending on the output format, while pandoc is
45+format-agnostic when parsing; differences are noted where they
46+occur.
47+
48+- DESCRIPTION: the document's description; pandoc parses this
49+ option as text with markup into the `description` metadata
50+ field. The field is not used in default templates.
51+
52+ Pandoc follows the LaTeX exporter in that it allows markup in
53+ the description. In contrast, the Org-mode HTML exporter treats
54+ reads the description as plain text.
55+
56+- LATEX_HEADER: arbitrary lines to add to the document's preamble.
57+ Contrary to Org-mode, these lines are not inserted before the
58+ hyperref settings, but close to the end of the preamble.
59+
60+ The contents of this option are stored as a list of raw LaTeX
61+ lines in the `header-includes` metadata field.
62+
63+- LATEX\_CLASS: the LaTeX document class; like Org-mode, pandoc
64+ uses `article` as the default class.
65+
66+ The contents of this option are stored as plain text in the
67+ `documentclass` metadata field.
68+
69+- LATEX\_CLASS\_OPTIONS: Options for the LaTeX document class;
70+ fully supported.
71+
72+ The contents of this option are stored as plain text in the
73+ `classoption` metadata field.
74+
75+- SUBTITLE: the document's subtitle; fully supported.
76+
77+- HTML_HEAD: arbitrary lines to add to the HTML document's head;
78+ fully supported.
79+
80+ The contents of this option are stored as a list of raw HTML
81+ lines in the `header-includes` metadata field.
82+
83+Pandoc-specific options
84+-----------------------
85+
86+Pandoc recognizes some export options not used by Emacs Org.
87+
88+- NOCITE: this field adds the listed citations to the
89+ bibliography, without the need to mention them to the text. The
90+ special value `@*` causes all available references to be added
91+ the bibliography.
92+
93+- HEADER-INCLUDES: like HTML_HEAD and, LATEX_HEADER, but treats
94+ the option's value as normal text with markup.
95+
3996
4097Citations
4198=========