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.
2020-09-07 01:25:16 +02:00
|
|
|
```
|
|
|
|
|
% pandoc --citeproc -t markdown-citations
|
|
|
|
|
---
|
|
|
|
|
csl: command/apa.csl
|
|
|
|
|
nocite: '@*'
|
|
|
|
|
references:
|
|
|
|
|
- author:
|
|
|
|
|
- literal: NN
|
Switch back from HsYAML to yaml.
Reasons:
- Performance: HsYAML is around 20 times slower in parsing
large YAML bibliographies (#6084).
- An issue was submitted to HsYAML, but it hasn't gotten
any attention. HsYAML seems borderline unmaintained; it hasn't
had a commit in over a year.
- Unfortunately this goes back on our attempts to free ourselves
from C dependencies (#4535). But I don't see a better alternative
until a better pure Haskell parser is available.
Closes #6084.
Notes:
- We've removed the FromYAML instances for all types that had
them, since this is a HsYAML-specific typeclass [API change].
(The yaml package just uses From/ToJSON.)
- Unlike HsYAML (in the configuration we were using), yaml
parses 'Y', 'N', 'Yes', 'No', 'On', 'Off' as boolean values.
Users may need to quote these when they are meant to be
interpreted as strings. Similarly, 'null' is parsed as
a YAML null value (and will be treated as an empty string
by pandoc rather than the string 'null'). Quoting it will
force it to be interpreted as a string.
- Some tests had to be adjusted accordingly.
- Pandoc now behaves better when the YAML metadata contains
escaping errors: instead of just falling back on treating
the section as a table, it raises a YAML parsing error.
2021-10-25 17:48:18 +02:00
|
|
|
id: 'Y'
|
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.
2020-09-07 01:25:16 +02:00
|
|
|
issued:
|
|
|
|
|
- year: 1950
|
|
|
|
|
title: 'Date: Year'
|
|
|
|
|
title-short: Date
|
|
|
|
|
type: webpage
|
|
|
|
|
- author:
|
|
|
|
|
- literal: NN
|
|
|
|
|
id: Y/Y
|
|
|
|
|
issued:
|
|
|
|
|
- year: 1951
|
|
|
|
|
- year: 1952
|
|
|
|
|
title: 'Date range: Year'
|
|
|
|
|
title-short: Date range
|
|
|
|
|
type: webpage
|
|
|
|
|
- author:
|
|
|
|
|
- literal: NN
|
|
|
|
|
id: YM
|
|
|
|
|
issued:
|
|
|
|
|
- month: 1
|
|
|
|
|
year: 1953
|
|
|
|
|
title: 'Date: Year+month'
|
|
|
|
|
title-short: Date
|
|
|
|
|
type: webpage
|
|
|
|
|
- author:
|
|
|
|
|
- literal: NN
|
|
|
|
|
id: YM/YM
|
|
|
|
|
issued:
|
|
|
|
|
- month: 1
|
|
|
|
|
year: 1954
|
|
|
|
|
- month: 2
|
|
|
|
|
year: 1955
|
|
|
|
|
title: 'Date range: Year+month'
|
|
|
|
|
title-short: Date range
|
|
|
|
|
type: webpage
|
|
|
|
|
- author:
|
|
|
|
|
- literal: NN
|
|
|
|
|
id: YM/YM_same
|
|
|
|
|
issued:
|
|
|
|
|
- month: 1
|
|
|
|
|
year: 1956
|
|
|
|
|
- month: 2
|
|
|
|
|
year: 1956
|
|
|
|
|
title: 'Date range: Year+month, same year'
|
|
|
|
|
title-short: Date range
|
|
|
|
|
type: webpage
|
|
|
|
|
- author:
|
|
|
|
|
- literal: NN
|
|
|
|
|
id: YMD
|
|
|
|
|
issued:
|
|
|
|
|
- day: 15
|
|
|
|
|
month: 1
|
|
|
|
|
year: 1958
|
|
|
|
|
title: 'Date: Year+month+day'
|
|
|
|
|
title-short: Date
|
|
|
|
|
type: webpage
|
|
|
|
|
- author:
|
|
|
|
|
- literal: NN
|
|
|
|
|
id: YMD/YMD
|
|
|
|
|
issued:
|
|
|
|
|
- day: 15
|
|
|
|
|
month: 1
|
|
|
|
|
year: 1959
|
|
|
|
|
- day: 16
|
|
|
|
|
month: 2
|
|
|
|
|
year: 1960
|
|
|
|
|
title: 'Date range: Year+month+day'
|
|
|
|
|
title-short: Date range
|
|
|
|
|
type: webpage
|
|
|
|
|
- author:
|
|
|
|
|
- literal: NN
|
|
|
|
|
id: YMD/YMD_same
|
|
|
|
|
issued:
|
|
|
|
|
- day: 15
|
|
|
|
|
month: 1
|
|
|
|
|
year: 1961
|
|
|
|
|
- day: 16
|
|
|
|
|
month: 1
|
|
|
|
|
year: 1962
|
|
|
|
|
title: 'Date range: Year+month+day, same month'
|
|
|
|
|
title-short: Date range
|
|
|
|
|
type: webpage
|
|
|
|
|
- author:
|
|
|
|
|
- literal: NN
|
|
|
|
|
id: YS
|
|
|
|
|
issued:
|
|
|
|
|
- season: 3
|
|
|
|
|
year: 1963
|
|
|
|
|
title: 'Date: Year+season'
|
|
|
|
|
title-short: Date
|
|
|
|
|
type: webpage
|
|
|
|
|
- author:
|
|
|
|
|
- literal: NN
|
|
|
|
|
id: YS/YS
|
|
|
|
|
issued:
|
|
|
|
|
- season: 1
|
|
|
|
|
year: 1964
|
|
|
|
|
- season: 4
|
|
|
|
|
year: 1965
|
|
|
|
|
title: 'Date range: Year+season'
|
|
|
|
|
title-short: Date range
|
|
|
|
|
type: webpage
|
|
|
|
|
- author:
|
|
|
|
|
- literal: NN
|
|
|
|
|
id: YS/YS_same
|
|
|
|
|
issued:
|
|
|
|
|
- season: 2
|
|
|
|
|
year: 1966
|
|
|
|
|
- season: 4
|
|
|
|
|
year: 1966
|
|
|
|
|
title: 'Date range: Year+season, same year'
|
|
|
|
|
title-short: Date range
|
|
|
|
|
type: webpage
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
^D
|
|
|
|
|
::: {#refs .references .csl-bib-body .hanging-indent line-spacing="2"}
|
|
|
|
|
::: {#ref-Y .csl-entry}
|
|
|
|
|
NN. (1950). Date: Year.
|
|
|
|
|
:::
|
|
|
|
|
|
|
|
|
|
::: {#ref-Y/Y .csl-entry}
|
|
|
|
|
NN. (1951--1952). Date range: Year.
|
|
|
|
|
:::
|
|
|
|
|
|
|
|
|
|
::: {#ref-YM .csl-entry}
|
|
|
|
|
NN. (1953, January). Date: Year+month.
|
|
|
|
|
:::
|
|
|
|
|
|
|
|
|
|
::: {#ref-YM/YM .csl-entry}
|
|
|
|
|
NN. (1954--1955, January--February). Date range: Year+month.
|
|
|
|
|
:::
|
|
|
|
|
|
|
|
|
|
::: {#ref-YM/YM_same .csl-entry}
|
|
|
|
|
NN. (1956, January--February). Date range: Year+month, same year.
|
|
|
|
|
:::
|
|
|
|
|
|
|
|
|
|
::: {#ref-YMD .csl-entry}
|
|
|
|
|
NN. (1958, January 15). Date: Year+month+day.
|
|
|
|
|
:::
|
|
|
|
|
|
|
|
|
|
::: {#ref-YMD/YMD .csl-entry}
|
|
|
|
|
NN. (1959--1960, January 15--February 16). Date range: Year+month+day.
|
|
|
|
|
:::
|
|
|
|
|
|
|
|
|
|
::: {#ref-YMD/YMD_same .csl-entry}
|
|
|
|
|
NN. (1961--1962, January 15--16). Date range: Year+month+day, same
|
|
|
|
|
month.
|
|
|
|
|
:::
|
|
|
|
|
|
|
|
|
|
::: {#ref-YS .csl-entry}
|
|
|
|
|
NN. (1963, Autumn). Date: Year+season.
|
|
|
|
|
:::
|
|
|
|
|
|
|
|
|
|
::: {#ref-YS/YS .csl-entry}
|
|
|
|
|
NN. (1964--1965, Spring--Winter). Date range: Year+season.
|
|
|
|
|
:::
|
|
|
|
|
|
|
|
|
|
::: {#ref-YS/YS_same .csl-entry}
|
|
|
|
|
NN. (1966, Summer--Winter). Date range: Year+season, same year.
|
|
|
|
|
:::
|
|
|
|
|
:::
|
|
|
|
|
```
|