diff --git a/doc/org.md b/doc/org.md index 924db917b..127163a81 100644 --- a/doc/org.md +++ b/doc/org.md @@ -167,120 +167,6 @@ function Meta (meta) end ``` -Citations -========= - -Emacs org-mode lacks an official citation syntax, leading to -multiple syntaxes coexisting. Pandoc recognizes four different -syntaxes for citations. - -Citation support for org-mode is enabled by default. Support can -be toggled off by disabling the `citation` extension; e.g. -`pandoc --from=org-citations`. - -Berkeley-style citations ------------------------- - -The semi-official Org-mode citation syntax was designed by Richard -Lawrence with additions by contributors on the [emacs-orgmode -mailing list]. It is based on John MacFarlane's pandoc Markdown -syntax. It's dubbed Berkeley syntax due the place of activity of -its creators, both philosophers at UC Berkeley. - -### Simple in-text citation - -This is the simplest form of citation. It consists of the citation -ID prefixed by '@'. - -Example: - - @WatsonCrick1953 showed that DNA forms a double-helix. - -### In-text citation list - -Citations presented in the text unparenthesized are called -*in-text citations*. The syntax for these citations is - - [cite: PREFIX; INDIVIDUAL-REFERENCE; ... INDIVIDUAL-REFERENCE; SUFFIX] - -where the initial PREFIX and final SUFFIX are optional. At least -one INDIVIDUAL-REFERENCE must be present. The colon and -semicolons here are literal and indicate the end of the TAG and -the end of a PREFIX or INDIVIDUAL-REFERENCE respectively. - -An INDIVIDUAL-REFERENCE has the format: - - PREFIX KEY SUFFIX - -The KEY is obligatory, and the prefix and suffix are optional. - -A PREFIX or SUFFIX is arbitrary text (except `;`, `]`, and -citation keys). - -Example: - - [cite: See; @Mandelkern1981; and @Watson1953] - -### Parenthetical citation - -Citations surrounded by parentheses. The syntax is identical to -in-text citations, except for the additional parentheses enclosing -the initial `cite` tag. - - [(cite): See; @Mandelkern1981; and @Watson1953] - -[emacs-orgmode mailing list]: https://lists.gnu.org/archive/html/emacs-orgmode/2015-02/msg00932.html - -org-ref citations ------------------ - -The [org-ref] package by [John Kitchen] is in wide use to handle -citations and has excellent tooling support in Emacs. Its -citation syntax is geared towards users in the natural sciences -but still very flexible regardless. - - cite:doe_john_2000 - citep:doe_jane_1989 - [[citep:Dominik201408][See page 20 of::, for example]] - - -Pandoc-Markdown-like syntax ---------------------------- - -Historically, Markdown-style citations syntax was the first that -was added to pandoc's org reader. It is close to Markdown's -citation syntax. - -Citations go inside square brackets and are separated by -semicolons. Each citation must have a key, composed of '@' plus -the citation identifier from the database, and may optionally -have a prefix, a locator, and a suffix. The citation key must -begin with a letter, digit, or `_`, and may contain -alphanumerics, `_`, and internal punctuation characters -(`:.#$%&-+?<>~/`). Here are some examples: - -### Simple citation - -The simplest method to insert a citation is to write the citation -ID prefixed by '@'. - - -Example: - - [prefix @citekey suffix] - [see @doe2000 pp. 23-42] - [@doe2000 p. 5; to a lesser extend @doe2005] - - -LaTeX-Syntax ------------- - -Use normal latex citation commands like `\cite{x}` or -`\citet{y}`. - -[org-ref]: https://github.com/jkitchin/org-ref -[John Kitchen]: https://kitchingroup.cheme.cmu.edu/ - Tables ======