aboutsummaryrefslogtreecommitdiff
path: root/pandoc.cabal
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2020-09-06 16:25:16 -0700
committerJohn MacFarlane <jgm@berkeley.edu>2020-09-21 10:15:50 -0700
commite0984a43a99231e72c02a0a716c8d0315de9abdf (patch)
tree8531ef58c2470d372ff2427a6ae09a6284461471 /pandoc.cabal
parent89c577befb78b32a0884b6092e0415c0dcadab72 (diff)
downloadpandoc-e0984a43a99231e72c02a0a716c8d0315de9abdf.tar.gz
Add built-in citation support using new citeproc library.
This deprecates the use of the external pandoc-citeproc filter; citation processing is now built in to pandoc. * Add dependency on citeproc library. * Add Text.Pandoc.Citeproc module (and some associated unexported modules under Text.Pandoc.Citeproc). Exports `processCitations`. [API change] * Add data files needed for Text.Pandoc.Citeproc: default.csl in the data directory, and a citeproc directory that is just used at compile-time. Note that we've added file-embed as a mandatory rather than a conditional depedency, because of the biblatex localization files. We might eventually want to use readDataFile for this, but it would take some code reorganization. * Text.Pandoc.Loging: Add `CiteprocWarning` to `LogMessage` and use it in `processCitations`. [API change] * Add tests from the pandoc-citeproc package as command tests (including some tests pandoc-citeproc did not pass). * Remove instructions for building pandoc-citeproc from CI and release binary build instructions. We will no longer distribute pandoc-citeproc. * Markdown reader: tweak abbreviation support. Don't insert a nonbreaking space after a potential abbreviation if it comes right before a note or citation. This messes up several things, including citeproc's moving of note citations. * Add `csljson` as and input and output format. This allows pandoc to convert between `csljson` and other bibliography formats, and to generate formatted versions of CSL JSON bibliographies. * Add module Text.Pandoc.Writers.CslJson, exporting `writeCslJson`. [API change] * Add module Text.Pandoc.Readers.CslJson, exporting `readCslJson`. [API change] * Added `bibtex`, `biblatex` as input formats. This allows pandoc to convert between BibLaTeX and BibTeX and other bibliography formats, and to generated formatted versions of BibTeX/BibLaTeX bibliographies. * Add module Text.Pandoc.Readers.BibTeX, exporting `readBibTeX` and `readBibLaTeX`. [API change] * Make "standalone" implicit if output format is a bibliography format. This is needed because pandoc readers for bibliography formats put the bibliographic information in the `references` field of metadata; and unless standalone is specified, metadata gets ignored. (TODO: This needs improvement. We should trigger standalone for the reader when the input format is bibliographic, and for the writer when the output format is markdown.) * Carry over `citationNoteNum` to `citationNoteNumber`. This was just ignored in pandoc-citeproc. * Text.Pandoc.Filter: Add `CiteprocFilter` constructor to Filter. [API change] This runs the processCitations transformation. We need to treat it like a filter so it can be placed in the sequence of filter runs (after some, before others). In FromYAML, this is parsed from `citeproc` or `{type: citeproc}`, so this special filter may be specified either way in a defaults file (or by `citeproc: true`, though this gives no control of positioning relative to other filters). TODO: we need to add something to the manual section on defaults files for this. * Add deprecation warning if `upandoc-citeproc` filter is used. * Add `--citeproc/-C` option to trigger citation processing. This behaves like a filter and will be positioned relative to filters as they appear on the command line. * Rewrote the manual on citatations, adding a dedicated Citations section which also includes some information formerly found in the pandoc-citeproc man page. * Look for CSL styles in the `csl` subdirectory of the pandoc user data directory. This changes the old pandoc-citeproc behavior, which looked in `~/.csl`. Users can simply symlink `~/.csl` to the `csl` subdirectory of their pandoc user data directory if they want the old behavior. * Add support for CSL bibliography entry formatting to LaTeX, HTML, Ms writers. Added CSL-related CSS to styles.html.
Diffstat (limited to 'pandoc.cabal')
-rw-r--r--pandoc.cabal21
1 files changed, 19 insertions, 2 deletions
diff --git a/pandoc.cabal b/pandoc.cabal
index a6e277283..619712160 100644
--- a/pandoc.cabal
+++ b/pandoc.cabal
@@ -180,6 +180,9 @@ data-files:
data/bash_completion.tpl
-- jats csl
data/jats.csl
+ -- citeproc
+ data/default.csl
+ citeproc/biblatex-localization/*.lbx.strings
-- documentation
MANUAL.txt, COPYRIGHT
extra-source-files:
@@ -201,6 +204,9 @@ extra-source-files:
test/bodybg.gif
test/*.native
test/command/*.md
+ test/command/*.csl
+ test/command/biblio.bib
+ test/command/biblatex-examples.bib
test/command/A.txt
test/command/B.txt
test/command/C.txt
@@ -397,6 +403,7 @@ library
blaze-markup >= 0.8 && < 0.9,
bytestring >= 0.9 && < 0.11,
case-insensitive >= 1.2 && < 1.3,
+ citeproc >= 0.0 && < 0.1,
commonmark >= 0.1.0.2 && < 0.2,
commonmark-extensions >= 0.2 && < 0.3,
commonmark-pandoc >= 0.2 && < 0.3,
@@ -409,6 +416,7 @@ library
doctemplates >= 0.8.2 && < 0.9,
emojis >= 0.1 && < 0.2,
exceptions >= 0.8 && < 0.11,
+ file-embed >= 0.0 && < 0.1,
filepath >= 1.1 && < 1.5,
haddock-library >= 1.8 && < 1.10,
hslua >= 1.1 && < 1.3,
@@ -457,7 +465,6 @@ library
build-depends: unix >= 2.4 && < 2.8
if flag(embed_data_files)
cpp-options: -DEMBED_DATA_FILES
- build-depends: file-embed >= 0.0 && < 0.1
other-modules: Text.Pandoc.Data
if os(windows)
cpp-options: -D_WINDOWS
@@ -495,6 +502,8 @@ library
Text.Pandoc.Readers.Markdown,
Text.Pandoc.Readers.CommonMark,
Text.Pandoc.Readers.Creole,
+ Text.Pandoc.Readers.BibTeX,
+ Text.Pandoc.Readers.CslJson,
Text.Pandoc.Readers.MediaWiki,
Text.Pandoc.Readers.Vimwiki,
Text.Pandoc.Readers.RST,
@@ -553,6 +562,7 @@ library
Text.Pandoc.Writers.FB2,
Text.Pandoc.Writers.TEI,
Text.Pandoc.Writers.Muse,
+ Text.Pandoc.Writers.CslJson,
Text.Pandoc.Writers.Math,
Text.Pandoc.Writers.Shared,
Text.Pandoc.Writers.OOXML,
@@ -572,7 +582,8 @@ library
Text.Pandoc.Emoji,
Text.Pandoc.ImageSize,
Text.Pandoc.BCP47,
- Text.Pandoc.Class
+ Text.Pandoc.Class,
+ Text.Pandoc.Citeproc
other-modules: Text.Pandoc.App.CommandLineOptions,
Text.Pandoc.App.FormatHeuristics,
Text.Pandoc.App.Opt,
@@ -651,6 +662,12 @@ library
Text.Pandoc.Translations,
Text.Pandoc.Slides,
Text.Pandoc.Image,
+ Text.Pandoc.Citeproc.BibTeX,
+ Text.Pandoc.Citeproc.CslJson,
+ Text.Pandoc.Citeproc.Data,
+ Text.Pandoc.Citeproc.Locator,
+ Text.Pandoc.Citeproc.MetaValue,
+ Text.Pandoc.Citeproc.Util,
Paths_pandoc
autogen-modules: Paths_pandoc
buildable: True