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
|
|
|
|
|
---
|
|
|
|
|
references:
|
|
|
|
|
- URL: 'http://www.example.com'
|
|
|
|
|
author:
|
|
|
|
|
- family: Doe
|
|
|
|
|
given: John
|
|
|
|
|
container-title: The Web Site
|
|
|
|
|
id: item1
|
|
|
|
|
issued:
|
|
|
|
|
date-parts:
|
|
|
|
|
- - 2006
|
|
|
|
|
- 10
|
|
|
|
|
- 26
|
|
|
|
|
title: Title
|
|
|
|
|
type: webpage
|
|
|
|
|
- URL: 'http://www.example.com'
|
|
|
|
|
author:
|
|
|
|
|
- family: Doe
|
|
|
|
|
given: John
|
|
|
|
|
container-title: The Web Site
|
|
|
|
|
id: item2
|
|
|
|
|
issued:
|
|
|
|
|
date-parts:
|
|
|
|
|
- - 2006
|
|
|
|
|
- 10
|
|
|
|
|
- 26
|
|
|
|
|
- - 2006
|
|
|
|
|
- 11
|
|
|
|
|
- 27
|
|
|
|
|
title: Title
|
|
|
|
|
type: webpage
|
|
|
|
|
- URL: 'http://www.example.com'
|
|
|
|
|
author:
|
|
|
|
|
- family: Doe
|
|
|
|
|
given: John
|
|
|
|
|
container-title: The Web Site
|
|
|
|
|
id: item2a
|
|
|
|
|
issued:
|
|
|
|
|
date-parts:
|
|
|
|
|
- - 2006
|
|
|
|
|
- 10
|
|
|
|
|
- - 2006
|
|
|
|
|
- 11
|
|
|
|
|
title: Title
|
|
|
|
|
type: webpage
|
|
|
|
|
- URL: 'http://www.example.com'
|
|
|
|
|
author:
|
|
|
|
|
- family: Doe
|
|
|
|
|
given: John
|
|
|
|
|
container-title: The Web Site
|
|
|
|
|
id: item2b
|
|
|
|
|
issued:
|
|
|
|
|
date-parts:
|
|
|
|
|
- - 2006
|
|
|
|
|
- 12
|
|
|
|
|
- 31
|
|
|
|
|
- - 2007
|
|
|
|
|
- 1
|
|
|
|
|
- 1
|
|
|
|
|
title: Title
|
|
|
|
|
type: webpage
|
|
|
|
|
- URL: 'http://www.example.com'
|
|
|
|
|
author:
|
|
|
|
|
- family: Doe
|
|
|
|
|
given: John
|
|
|
|
|
container-title: The Newspaper
|
|
|
|
|
id: item3
|
|
|
|
|
issued:
|
|
|
|
|
date-parts:
|
|
|
|
|
- - 2006
|
|
|
|
|
- 10
|
|
|
|
|
- 26
|
|
|
|
|
- - 2006
|
|
|
|
|
- 11
|
|
|
|
|
- 27
|
|
|
|
|
title: Title
|
|
|
|
|
type: 'article-newspaper'
|
|
|
|
|
- URL: 'http://www.example.com'
|
|
|
|
|
author:
|
|
|
|
|
- family: Doe
|
|
|
|
|
given: John
|
|
|
|
|
container-title: The Newspaper
|
|
|
|
|
id: item3b
|
|
|
|
|
issued:
|
|
|
|
|
date-parts:
|
|
|
|
|
- - 2006
|
|
|
|
|
- 10
|
|
|
|
|
- - 2006
|
|
|
|
|
- 11
|
|
|
|
|
title: Title
|
|
|
|
|
type: 'article-newspaper'
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
@item1 -- webpage, date
|
|
|
|
|
|
|
|
|
|
@item2 -- webpage, date range
|
|
|
|
|
|
|
|
|
|
@item2a -- webpage, date range YM
|
|
|
|
|
|
|
|
|
|
@item2b -- webpage, date range across years
|
|
|
|
|
|
|
|
|
|
@item3 -- article-newspaper
|
|
|
|
|
|
|
|
|
|
@item3b -- article-newspaper YM
|
|
|
|
|
|
|
|
|
|
References
|
|
|
|
|
==========
|
|
|
|
|
^D
|
|
|
|
|
Doe (2006c) -- webpage, date
|
|
|
|
|
|
|
|
|
|
Doe (2006d) -- webpage, date range
|
|
|
|
|
|
|
|
|
|
Doe (2006a) -- webpage, date range YM
|
|
|
|
|
|
|
|
|
|
Doe (2006--2007) -- webpage, date range across years
|
|
|
|
|
|
|
|
|
|
Doe (2006e) -- article-newspaper
|
|
|
|
|
|
|
|
|
|
Doe (2006b) -- article-newspaper YM
|
|
|
|
|
|
2020-11-15 00:09:44 +01:00
|
|
|
# References {#references .unnumbered}
|
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
|
|
|
|
|
|
|
|
::: {#refs .references .csl-bib-body .hanging-indent}
|
|
|
|
|
::: {#ref-item2a .csl-entry}
|
|
|
|
|
Doe, John. 2006a. "Title." The Web Site. October--November 2006.
|
|
|
|
|
<http://www.example.com>.
|
|
|
|
|
:::
|
|
|
|
|
|
|
|
|
|
::: {#ref-item3b .csl-entry}
|
|
|
|
|
---------. 2006b. "Title." *The Newspaper*, October--November 2006.
|
|
|
|
|
<http://www.example.com>.
|
|
|
|
|
:::
|
|
|
|
|
|
|
|
|
|
::: {#ref-item1 .csl-entry}
|
|
|
|
|
---------. 2006c. "Title." The Web Site. October 26, 2006.
|
|
|
|
|
<http://www.example.com>.
|
|
|
|
|
:::
|
|
|
|
|
|
|
|
|
|
::: {#ref-item2 .csl-entry}
|
|
|
|
|
---------. 2006d. "Title." The Web Site. October 26--November 27, 2006.
|
|
|
|
|
<http://www.example.com>.
|
|
|
|
|
:::
|
|
|
|
|
|
|
|
|
|
::: {#ref-item3 .csl-entry}
|
|
|
|
|
---------. 2006e. "Title." *The Newspaper*, October 26--November 27,
|
|
|
|
|
2006. <http://www.example.com>.
|
|
|
|
|
:::
|
|
|
|
|
|
|
|
|
|
::: {#ref-item2b .csl-entry}
|
|
|
|
|
---------. 2006--2007. "Title." The Web Site. December 31, 2006--January
|
|
|
|
|
1, 2007. <http://www.example.com>.
|
|
|
|
|
:::
|
|
|
|
|
:::
|
|
|
|
|
```
|
