org-citeproc

org-citeproc is a standalone program that uses pandoc-citeproc to generate citations and a bibliography, given a database of bibliographic references and a CSL stylesheet. The idea is to make it possible for Emacs' Org mode exporters to use this excellent tool.

org-citeproc is a fork of John MacFarlane's citeproc program. The major changes are:

• The input JSON format is compatible with the format used by citeproc-js
• This version renders output directly in a target format (currently ASCII, HTML, or ODT) rather than as JSON

Usage

org-citeproc format stylefile.csl bibliofile.bib

• The bibliography file can be in any of the formats that pandoc-citeproc supports.
• The format can be ascii, html, or odt; also native or native-before can be useful formats for debugging purposes.
• The program reads JSON from stdin and writes formatted data to stdout.

Input

The input is an array of JSON citation data objects. A citation data object contains one required field, citationItems, whose value is a JSON array of cites. A cite is a JSON object describing one source. Fields in a cite can include:

• id (string)
• prefix (string)
• suffix (string)
• label (string)
• locator (string)
• suppress-author (boolean)
• author-in-text (boolean)

id must be included; the rest are optional.

A citation data object may also include a properties field, whose value is a JSON object containing one or more of the following fields:

• noteIndex
• common-prefix (non-standard)
• common-suffix (non-standard)

The common-prefix and common-suffix fields allow support for BibLaTeX-style multi-cite citations.

See the *-to-json functions in the org-cite library for Elisp code that generates JSON in this format, given Org citation objects.

Installing org-citeproc

Change to the source directory and run:

cabal build

If you want to use org-citeproc with Org mode, copy or link the resulting org-citeproc binary from dist/build/org-citeproc/org-citeproc to $ORGROOT/bin/org-citeproc, where $ORGROOT is the root of your Org mode distribution. My wip-cite-org-citeproc branch of Org mode makes use of this binary.

Contributing

There is a list of TODO items in TODO.org. Contributions of code, bug reports, and so on are welcome!