git.iko.soy/typeable/pandoc
on 2.4 help sign in
typeable/pandoc/doc/org.md
95 lines 2.7 kB history raw
1---
2title: Org-mode features and differences
3author: Albert Krewinkel
4---
6Pandoc handles org files very similarly to Emacs org-mode.
7However, there are differences worth highlighting.
10Citations
11=========
13Emacs org-mode lacks an official citation syntax, leading to
14multiple syntaxes coexisting. Pandoc recognizes four different
15syntaxes for citations.
17Berkeley-style citations
18------------------------
20The semi-offical Org-mode citation syntax is based on John
21MacFarlane's Pandoc syntax and org-oriented enhancements
22contributed by Richard Lawrence and others. It's dubbed Berkeley
23syntax due the place of activity of its main contributors.
25Example:
27 See @john_doe_2006.
28 [cite: See; @Mandelkern1981; and @Watson1953]
29 [(cite): See; @Mandelkern1981; and @Watson1953]
32org-ref citations
33-----------------
35The [org-ref] package is in wide use to handle citations and has
36excellent tooling support in Emacs. Its citation syntax is
37geared towards users in the natural sciences but still very
38flexible regardless.
40 cite:doe_john_2000
41 citep:doe_jane_1989
42 [[citep:Dominik201408][See page 20 of::, for example]]
45Pandoc-Markdown-like syntax
46---------------------------
48Historically, Markdown-style citations syntax was the first that
49was added to pandoc's org reader. It is almost identical to
50Markdown's citation syntax.
52Example:
54 [prefix @citekey suffix]
55 [see @doe2000 p. 23-42]
58LaTeX-Syntax
59------------
61Use normal latex citation commands like `\cite{x}` or
62`\citet{y}`.
64[org-ref]: https://github.com/jkitchin/org-ref
67Emphasis rules
68==============
70Org-mode uses complex rules to decide whether a string
71represents emphasized text. In Emacs, this can be customized via
72the variable `org-emphasis-regexp-components`. A variable like
73this doesn't fit well with pandoc's model. Instead, it is
74possible to use special lines to change these values:
76 #+pandoc-emphasis-pre: "-\t ('\"{"
77 #+pandoc-emphasis-post: "-\t\n .,:!?;'\")}["
79The above describes the default values of these variables. The
80arguments must be valid (Haskell) strings. If interpretation of
81the argument as string fails, the default is restored.
83Changing emphasis rules only affect the part of the document
84following the special lines. They must be some of the first
85lines to alter parsing behavior for the whole document. It is
86also possible to change the values temporarily for selected
87sections only. The string `test` in the following snippet will
88be read as emphasized text, while the rest of the document will
89be parsed using default emphasis rules:
91 #+pandoc-emphasis-pre: "["
92 #+pandoc-emphasis-post: "]"
93 [/test/]
94 #+pandoc-emphasis-pre:
95 #+pandoc-emphasis-post: