The pandoc-citeproc package

[ Tags: bsd3, library, program, text ] [ Propose Tags ]

The pandoc-citeproc library exports functions for using the citeproc system with pandoc. It relies on citeproc-hs, a library for rendering bibliographic reference citations into a variety of styles using a macro language called Citation Style Language (CSL). More details on CSL can be found here: http://citationstyles.org/.

Currently this package includes a heavily revised copy of the citeproc-hs code. When citeproc-hs is updated to be compatible, this package will simply depend on citeproc-hs.

This package also contains an executable: pandoc-citeproc, which works as a pandoc filter, and also has a mode for converting bibliographic databases a YAML format suitable for inclusion in pandoc YAML metadata.


[Skip to Readme]

Properties

Versions 0.1, 0.1.1, 0.1.1.1, 0.1.1.2, 0.1.2, 0.1.2.1, 0.2, 0.3, 0.3.0.1, 0.3.1, 0.4, 0.4.0.1, 0.5, 0.6, 0.6.0.1, 0.7, 0.7.0.1, 0.7.0.2, 0.7.1, 0.7.1.1, 0.7.2, 0.7.3, 0.7.3.1, 0.7.4, 0.8, 0.8.0.1, 0.8.1, 0.8.1.1, 0.8.1.2, 0.8.1.3, 0.9, 0.9.1, 0.9.1.1, 0.10, 0.10.1, 0.10.1.1, 0.10.1.2, 0.10.1.3, 0.10.1.4, 0.10.2, 0.10.2.1, 0.10.2.2, 0.10.3, 0.10.4, 0.10.4.1, 0.10.5, 0.10.5.1, 0.11, 0.11.1, 0.11.1.1, 0.11.1.2, 0.11.1.3, 0.12, 0.12.1
Change log changelog
Dependencies aeson (>=0.7 && <0.10), aeson-pretty, attoparsec, base (>=4), bytestring, containers (>=0.4), data-default, directory, filepath, ghc-prim, hs-bibutils (>=0.3), mtl, old-locale, pandoc (>=1.13), pandoc-citeproc, pandoc-types (>=1.12.3), parsec, pretty-show, process, rfc5051, setenv (==0.1.*), split, syb, tagsoup, temporary (>=1.1), text, text-icu, time, vector (>=0.10), xml-conduit (>=1.2 && <1.4), yaml (>=0.8.8.7) [details]
License BSD3
Author John MacFarlane, Andrea Rossato
Maintainer jgm@berkeley.edu
Category Text
Source repository head: git clone git://github.com/jgm/pandoc-citeproc.git
Uploaded Sat Aug 15 00:00:55 UTC 2015 by JohnMacFarlane
Distributions Arch:0.12.1, Debian:0.9, Fedora:0.10.4.1, FreeBSD:0.7.3.1, LTSHaskell:0.10.5.1, NixOS:0.12.1, Stackage:0.12.1, Tumbleweed:0.10.4.1
Executables test-citeproc, pandoc-citeproc
Downloads 27148 total (748 in the last 30 days)
Rating 2.0 (votes: 1) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2015-08-15 [all 1 reports]
Hackage Matrix CI

Modules

[Index]

Flags

NameDescriptionDefaultType
bibutils

Use Chris Putnam's Bibutils.

EnabledAutomatic
embed_data_files

Embed locale files into the library (needed for windows packaging)

DisabledAutomatic
unicode_collation

Use Haskell bindings to the International Components for Unicode (ICU) libraries

DisabledAutomatic
test_citeproc

Build the test-citeproc program

DisabledAutomatic
debug

Turn on debug tracing.

DisabledAutomatic

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for pandoc-citeproc-0.7.3.1

[back to package description]

pandoc-citeproc

This package provides a library and executable to facilitate the use of citeproc with pandoc 1.12 and greater. (Earlier versions of pandoc have integrated citeproc support.)

pandoc-citeproc

The pandoc-citeproc executable can be used as a filter with pandoc to resolve and format citations using a bibliography file and a CSL stylesheet. It can also be used (with --bib2yaml or --bib2json options) to convert a bibliography to a YAML format that can be put directly into a pandoc markdown document or to CSL JSON. Bibliographies can be in any of several formats, but bibtex and biblatex are the best supported.

For usage and further details, see the pandoc-citeproc man page.

The current version of the package includes code from citeproc-hs, which has not been updated for some time. When citeproc-hs is brought up to date, this code can be removed and this package will depend on citeproc-hs.

Text.CSL.Pandoc

Those who use pandoc as a library (e.g. in a web application) will need to use this module to process citations.

The module exports two functions, processCites, which is pure and accepts a style and a list of references as arguments, and processCites', which lives in the IO monad and derives the style and references from the document's metadata.