aboutsummaryrefslogtreecommitdiff
path: root/test/command/biblatex-inbook.md
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 /test/command/biblatex-inbook.md
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 'test/command/biblatex-inbook.md')
-rw-r--r--test/command/biblatex-inbook.md147
1 files changed, 147 insertions, 0 deletions
diff --git a/test/command/biblatex-inbook.md b/test/command/biblatex-inbook.md
new file mode 100644
index 000000000..7d2ee5b47
--- /dev/null
+++ b/test/command/biblatex-inbook.md
@@ -0,0 +1,147 @@
+```
+% pandoc -f biblatex -t markdown -s
+@comment{
+adapted from http://mirrors.ctan.org/macros/latex/contrib/biblatex/doc/examples/biblatex-examples.bib
+
+TODO / citeproc: in biblatex "inbook" entries, citeproc should suppress bookauthor = CSL container-author if identical with author. -- See annotation in kant:kpv.
+}
+
+@string{dtv = {Deutscher Taschenbuch-Verlag}}
+
+@inbook{kant:kpv,
+ Annotation = {An edition of Kant's \emph{Collected Works}, volume five. This is an inbook entry which explicitly refers to the \emph{Critique of Practical Reason} only, not to the entire fifth volume. Note the author and bookauthor fields in the database file. By default, the bookauthor is omitted if the values of the author and bookauthor fields are identical},
+ Author = {Kant, Immanuel},
+ Bookauthor = {Kant, Immanuel},
+ Booktitle = {Kritik der praktischen Vernunft. Kritik der Urtheilskraft},
+ Date = 1968,
+ Hyphenation = {german},
+ Location = {Berlin},
+ Maintitle = {Kants Werke. Akademie Textausgabe},
+ Pages = {1-163},
+ Publisher = {Walter de Gruyter},
+ Shorthand = {KpV},
+ Shorttitle = {Kritik der praktischen Vernunft},
+ Title = {Kritik der praktischen Vernunft},
+ Volume = 5}
+
+@inbook{kant:ku,
+ Annotation = {An edition of Kant's \emph{Collected Works}, volume five. This is an inbook entry which explicitly refers to the \emph{Critique of Judgment} only, not to the entire fifth volume},
+ Author = {Kant, Immanuel},
+ Bookauthor = {Kant, Immanuel},
+ Booktitle = {Kritik der praktischen Vernunft. Kritik der Urtheilskraft},
+ Date = 1968,
+ Hyphenation = {german},
+ Location = {Berlin},
+ Maintitle = {Kants Werke. Akademie Textausgabe},
+ Pages = {165-485},
+ Publisher = {Walter de Gruyter},
+ Shorthand = {KU},
+ Title = {Kritik der Urtheilskraft},
+ Volume = 5}
+
+@inbook{nietzsche:historie,
+ Annotation = {A single essay from the critical edition of Nietzsche's works. This inbook entry explicitly refers to an essay found in the first volume. Note the title, booktitle, and maintitle fields. Also note the sorttitle and sortyear fields. We want this entry to be listed after the entry referring to the entire first volume},
+ Author = {Nietzsche, Friedrich},
+ Bookauthor = {Nietzsche, Friedrich},
+ Booktitle = {Die Geburt der Tragödie. Unzeitgemäße Betrachtungen I--IV. Nachgelassene Schriften 1870--1973},
+ Date = 1988,
+ Editor = {Colli, Giorgio and Montinari, Mazzino},
+ Hyphenation = {german},
+ Indexsorttitle = {Vom Nutzen und Nachtheil der Historie fur das Leben},
+ Indextitle = {Vom Nutzen und Nachtheil der Historie für das Leben},
+ Location = {München and Berlin and New York},
+ Mainsubtitle = {Kritische Studienausgabe},
+ Maintitle = {Sämtliche Werke},
+ Pages = {243-334},
+ Publisher = dtv # { and Walter de Gruyter},
+ Shorttitle = {Vom Nutzen und Nachtheil der Historie},
+ Sorttitle = {Werke-01-243},
+ Sortyear = {1988-2},
+ Subtitle = {Vom Nutzen und Nachtheil der Historie für das Leben},
+ Title = {Unzeitgemässe Betrachtungen. Zweites Stück},
+ Volume = 1}
+
+^D
+---
+nocite: '[@*]'
+references:
+- annote: 'An edition of Kant''s *Collected Works*, volume five. This is
+ an inbook entry which explicitly refers to the *Critique of
+ Practical Reason* only, not to the entire fifth volume. Note the
+ author and bookauthor fields in the database file. By default, the
+ bookauthor is omitted if the values of the author and bookauthor
+ fields are identical'
+ author:
+ - family: Kant
+ given: Immanuel
+ container-author:
+ - family: Kant
+ given: Immanuel
+ container-title: Kants Werke. Akademie Textausgabe
+ id: 'kant:kpv'
+ issued: 1968
+ language: 'de-DE'
+ page: '1-163'
+ publisher: Walter de Gruyter
+ publisher-place: Berlin
+ title: Kritik der praktischen Vernunft
+ title-short: Kritik der praktischen Vernunft
+ type: chapter
+ volume: 5
+ volume-title: Kritik der praktischen Vernunft. Kritik der
+ Urtheilskraft
+- annote: 'An edition of Kant''s *Collected Works*, volume five. This is
+ an inbook entry which explicitly refers to the *Critique of
+ Judgment* only, not to the entire fifth volume'
+ author:
+ - family: Kant
+ given: Immanuel
+ container-author:
+ - family: Kant
+ given: Immanuel
+ container-title: Kants Werke. Akademie Textausgabe
+ id: 'kant:ku'
+ issued: 1968
+ language: 'de-DE'
+ page: '165-485'
+ publisher: Walter de Gruyter
+ publisher-place: Berlin
+ title: Kritik der Urtheilskraft
+ type: chapter
+ volume: 5
+ volume-title: Kritik der praktischen Vernunft. Kritik der
+ Urtheilskraft
+- annote: 'A single essay from the critical edition of Nietzsche''s
+ works. This inbook entry explicitly refers to an essay found in the
+ first volume. Note the title, booktitle, and maintitle fields. Also
+ note the sorttitle and sortyear fields. We want this entry to be
+ listed after the entry referring to the entire first volume'
+ author:
+ - family: Nietzsche
+ given: Friedrich
+ container-author:
+ - family: Nietzsche
+ given: Friedrich
+ container-title: 'Sämtliche Werke: Kritische Studienausgabe'
+ editor:
+ - family: Colli
+ given: Giorgio
+ - family: Montinari
+ given: Mazzino
+ id: 'nietzsche:historie'
+ issued: 1988
+ language: 'de-DE'
+ page: '243-334'
+ publisher: 'Deutscher Taschenbuch-Verlag; Walter de Gruyter'
+ publisher-place: München; Berlin; New York
+ title: 'Unzeitgemässe Betrachtungen. Zweites Stück: Vom Nutzen und
+ Nachtheil der Historie für das Leben'
+ title-short: Vom Nutzen und Nachtheil der Historie
+ type: chapter
+ volume: 1
+ volume-title: 'Die Geburt der Tragödie. Unzeitgemäße Betrachtungen
+ I--IV. Nachgelassene Schriften 1870--1973'
+---
+
+
+```