diff options
author | John MacFarlane <jgm@berkeley.edu> | 2020-09-06 16:25:16 -0700 |
---|---|---|
committer | John MacFarlane <jgm@berkeley.edu> | 2020-09-21 10:15:50 -0700 |
commit | e0984a43a99231e72c02a0a716c8d0315de9abdf (patch) | |
tree | 8531ef58c2470d372ff2427a6ae09a6284461471 /test/command/biblatex-ctan.md | |
parent | 89c577befb78b32a0884b6092e0415c0dcadab72 (diff) | |
download | pandoc-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-ctan.md')
-rw-r--r-- | test/command/biblatex-ctan.md | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/test/command/biblatex-ctan.md b/test/command/biblatex-ctan.md new file mode 100644 index 000000000..d15b47b55 --- /dev/null +++ b/test/command/biblatex-ctan.md @@ -0,0 +1,73 @@ +``` +% pandoc -f biblatex -t markdown -s +@comment{ + +Adapted from biblatex-example.bib + + +Formatted with pandoc and chicago-author-date.csl, 2013-10-23: + +(“CTAN: The Comprehensive TeX Archive Network” 2006) + +“CTAN: The Comprehensive TeX Archive Network.” 2006. +<http://www.ctan.org>. + + +Formatted with pandoc and apa.csl, 2013-10-23: + +(“CTAN: The Comprehensive TeX Archive Network,” 2006) + +CTAN: The Comprehensive TeX Archive Network. (2006). Retrieved October +01, 2006, from <http://www.ctan.org> + + +NOTES: + +- biblio2yaml + - if there is no shorttitle, but title and subtitle, the title alone should also be mapped to title-short + +- citeproc + - citeproc should use title-short (if available) instead of title for in-text citations when there is no author + +} + +@Online{ctan, + title = {{CTAN}}, + date = 2006, + url = {http://www.ctan.org}, + subtitle = {{The Comprehensive TeX Archive Network}}, + urldate = {2006-10-01}, + label = {CTAN}, + hyphenation = {american}, + annotation = {This is an online entry. The \textsc{url}, which is + given in the url field, is transformed into a + clickable link if hyperref support has been + enabled. Note the format of the urldate field + (yyyy-mm-dd) in the database file. Also note the + label field which may be used as a fallback by + citation styles which need an author and\slash or a + year}, +} + +^D +--- +nocite: '[@*]' +references: +- accessed: '2006-10-01' + annote: 'This is an online entry. The [url]{.smallcaps}, which is + given in the url field, is transformed into a clickable link if + hyperref support has been enabled. Note the format of the urldate + field (yyyy-mm-dd) in the database file. Also note the label field + which may be used as a fallback by citation styles which need an + author and/or a year' + id: ctan + issued: 2006 + language: 'en-US' + title: 'CTAN: The Comprehensive TeX Archive Network' + title-short: CTAN + type: webpage + url: 'http://www.ctan.org' +--- + + +``` |