From e0984a43a99231e72c02a0a716c8d0315de9abdf Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Sun, 6 Sep 2020 16:25:16 -0700 Subject: 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. --- .../command/pandoc-citeproc-locators-integrated.md | 159 +++++++++++++++++++++ 1 file changed, 159 insertions(+) create mode 100644 test/command/pandoc-citeproc-locators-integrated.md (limited to 'test/command/pandoc-citeproc-locators-integrated.md') diff --git a/test/command/pandoc-citeproc-locators-integrated.md b/test/command/pandoc-citeproc-locators-integrated.md new file mode 100644 index 000000000..64490e376 --- /dev/null +++ b/test/command/pandoc-citeproc-locators-integrated.md @@ -0,0 +1,159 @@ +``` +% pandoc --citeproc -t markdown-citations +--- +csl: command/locators.csl +references: +- id: citekey + title: Title + type: 'article-journal' +suppress-bibliography: true +--- + +See . + +[@citekey, 89, and suffix] + +[@citekey, 89, perfect Ibid with suffix] + +[@citekey, 123-79, and suffix] + +[@citekey, xi, will be entirely suffix] + +[@citekey, p. xi, gives you a (page) locator xi] + +[@citekey, pp. VII, 89, gives you a (pages) locator VII, 89] + +[@citekey, p. VI, VII, VIII-IX, explicit romans] + +[@citekey \[89\]] + +[@citekey, p. \[89\]] + +[@citekey and nothing else]. + +[@citekey, 123(4)\[5\]6, and suffix] + +[@citekey, 3(a), 4.4.8, \[7.6\], 7A(2)(a)(i)-(iv)] + +[@citekey, 4B.2a.i(3.4), and suffix] + +[@citekey, IV.2A, and suffix] + +[@citekey, \[28\], and suffix] + +[@citekey, \[39-52\], and suffix] + +[@citekey, \[39\]-\[52\], and suffix] + +[@citekey, s 123(4)(a)(iv), and suffix] + +[@citekey, ss 123(4)-(6), and suffix] + +[@citekey, \[13\], and suffix] + +[@citekey, p.3, and suffix] + +[@citekey, (13 entirely suffix] + +[@citekey, p.a entirely suffix] + +[@citekey, s (a) entirely suffix] +^D +See . + +[^1] + +[^2] + +[^3] + +[^4] + +[^5] + +[^6] + +[^7] + +[^8] + +[^9] + +.[^10] + +[^11] + +[^12] + +[^13] + +[^14] + +[^15] + +[^16] + +[^17] + +[^18] + +[^19] + +[^20] + +[^21] + +[^22] + +[^23] + +[^24] + +[^1]: Title {89}, and suffix. + +[^2]: Ibid, perfect Ibid with suffix. + +[^3]: Ibid-with-locator {123--79}, and suffix. + +[^4]: Subsequent, xi, will be entirely suffix. + +[^5]: Ibid-with-locator {xi}, gives you a (page) locator xi. + +[^6]: Ibid-with-locator {VII, 89}, gives you a (pages) locator VII, 89. + +[^7]: Ibid-with-locator {VI, VII, VIII--IX}, explicit romans. + +[^8]: Ibid-with-locator {\[89\]}. + +[^9]: Ibid. + +[^10]: Subsequent and nothing else. + +[^11]: Ibid-with-locator {123(4)\[5\]6}, and suffix. + +[^12]: Ibid-with-locator {3(a), 4.4.8, \[7.6\], 7A(2)(a)(i)--(iv)}. + +[^13]: Ibid-with-locator {4B.2a.i(3.4)}, and suffix. + +[^14]: Ibid-with-locator {IV.2A}, and suffix. + +[^15]: Ibid-with-locator {\[28\]}, and suffix. + +[^16]: Ibid-with-locator {\[39--52\]}, and suffix. + +[^17]: Ibid-with-locator {\[39\]--\[52\]}, and suffix. + +[^18]: Ibid-with-locator s {123(4)(a)(iv)}, and suffix. + +[^19]: Ibid-with-locator ss {123(4)--(6)}, and suffix. + +[^20]: Ibid-with-locator {\[13\]}, and suffix. + +[^21]: Ibid-with-locator {3}, and suffix. + +[^22]: Subsequent, (13 entirely suffix. + +[^23]: Ibid, p.a entirely suffix. + +[^24]: Ibid, s (a) entirely suffix. +``` -- cgit v1.2.3