@@ -72,6 +72,12 @@
72 which URLs it is fetching, but not giving the full header). In
72 which URLs it is fetching, but not giving the full header). In
73 addition, there are better error messages when fetching a URL fails.
73 addition, there are better error messages when fetching a URL fails.
75+ * Citation support is no longer baked in to core pandoc. Users who
76+ need citations will need to install and use a separate filter
77+ (`--filter pandoc-citeproc`). This filter will take `bibliography`,
78+ `csl`, and `citation-abbreviations` from the metadata, though it
79+ may still be specified on the command line as before.
75 * Previously we used to store the directory of the first input file,
81 * Previously we used to store the directory of the first input file,
76 even if it was local, and used this as a base directory for finding
82 even if it was local, and used this as a base directory for finding
77 images in ODT, EPUB, Docx, and PDF. This has been confusing to many
83 images in ODT, EPUB, Docx, and PDF. This has been confusing to many
@@ -258,7 +264,7 @@
258 + Skip positional options after `\begin{figure}`.
264 + Skip positional options after `\begin{figure}`.
259 + Support `\v{}` for hacek (#926).
265 + Support `\v{}` for hacek (#926).
260 + Don't add spurious ", " to citation suffixes.
266 + Don't add spurious ", " to citation suffixes.
261− This is added when needed in `Text.Pandoc.Biblio` anyway.
267+ This is added when needed in pandoc-citeproc.
262 + Allow spaces in alignment spec in tables, e.g. `{ l r c }`.
268 + Allow spaces in alignment spec in tables, e.g. `{ l r c }`.
263 + Improved support for accented characters (thanks to Scott Morrison).
269 + Improved support for accented characters (thanks to Scott Morrison).
264 + Parse label after section command and set id (#951).
270 + Parse label after section command and set id (#951).
@@ -506,51 +512,33 @@
507------------------
513------------------
509− TODO - metadata changes
515− TODO - citation changes
517− removed integrated citation support
519− include pandoc-citeproc changes
521 * citeproc support has been removed from core pandoc (API changes).
515 * citeproc support has been removed from core pandoc (API changes).
523− + The `--bibliography`, `--csl`, and `--citation-abbreviation` options are
524− now implemented as follows:
525− --bibliography FILE => --metadata bibliography=FILE --filter pandoc-citeproc
526− --csl FILE => --metadata csl=FILE
527− --citation-abbreviations FILE => --metadata csl-abbreviations=FILE
528− + Markdown and LaTeX citations as still parsed, but an external
529− filter, `pandoc-citeproc`, is now needed to process
530− them against a bibliography and CSL stylesheet. The bibliography
531− and stylesheet should be specified in the document's YAML metadata
532− (`bibliography` and `csl` fields), and the filter called with
533− `pandoc --filter pandoc-citeproc`.
534− + The `Text.Pandoc.Biblio` module has been removed, and the Markdown
517+ + The `Text.Pandoc.Biblio` module has been removed (API change),
535 and LaTeX readers no longer process citations. Users of the
519 and LaTeX readers no longer process citations. Users of the
536 pandoc library who want citation support will need to use
520 pandoc library who want citation support will need to use
537 `Text.CSL.Pandoc` from `pandoc-citations`.
521 `Text.CSL.Pandoc` from `pandoc-citations`.
538 + All bibliography-related fields have been removed from
523 + All bibliography-related fields have been removed from
539 `ReaderOptions` and `WriterOptions`: `writerBiblioFiles`,
524 `ReaderOptions` and `WriterOptions`: `writerBiblioFiles`,
540− `readerReferences`, `readerCitationStyle`.
525+ `readerReferences`, `readerCitationStyle`. (API change)
541 + Note that a Cite element is now created in parsing markdown whether
527 + Note that a Cite element is now created in parsing markdown whether
542 or not there is a matching reference (indeed, pandoc has no way of
528 or not there is a matching reference (indeed, pandoc has no way of
543 knowing, since the `--bibliography` option has been removed).
529 knowing, since the `--bibliography` option has been removed).
544− By default citations will print as `???`.
530+ By default citations will print as `???`. (behavior change)
545 + The `pandoc-citeproc` script will put the bibliography at the
532 + The `pandoc-citeproc` script will put the bibliography at the
546 end of the document, as before. However, it will be put inside a Div
533 end of the document, as before. However, it will be put inside a Div
547 element with class "references", allowing users some control
534 element with class "references", allowing users some control
548 over the styling of references. A final header, if any, will
535 over the styling of references. A final header, if any, will
549− be included in the Div.
536+ be included in the Div. (behavior change)
550 * The markdown writer will not print a bibliography if the
538 * The markdown writer will not print a bibliography if the
551 `citations` extension is enabled. (If the citations are formatted
539 `citations` extension is enabled. (If the citations are formatted
552 as markdown citations, it is redundant to have a bibliography,
540 as markdown citations, it is redundant to have a bibliography,
553− since one will be generated automatically.)
541+ since one will be generated automatically.) (behavior change)
555 * Use new flexible metadata type.
543 * Use new flexible metadata type.
@@ -568,11 +556,6 @@
568 and `<span>` elements; in other formats they will simply pass through
556 and `<span>` elements; in other formats they will simply pass through
569 their contents. But they can be targeted by scripts.
557 their contents. But they can be targeted by scripts.
571− [ TODO - systematic documentation of pandoc-types API changes,
572− including .JSON, .Walk and changes to .Definition, .Builder.
573− Include the new Format newtype, and the new Span and Div
576 * Added `Text.Pandoc.Walk` (in `pandoc-types`), which exports
559 * Added `Text.Pandoc.Walk` (in `pandoc-types`), which exports
577 hand-written tree-walking functions that are orders of magnitude
560 hand-written tree-walking functions that are orders of magnitude
578 faster than the SYB functions from `Text.Pandoc.Generic`.
561 faster than the SYB functions from `Text.Pandoc.Generic`.
@@ -581,15 +564,20 @@
581 the generic traversals `bottomUp` and `queryWith`.
564 the generic traversals `bottomUp` and `queryWith`.
582 (API change.)
565 (API change.)
584−
567+ * New module `Text.Pandoc.JSON` in pandoc-types.
569+ + This provides `ToJSON` and `FromJSON` instances for the basic
570+ pandoc types. They use GHC generics and should be faster than the
571+ old JSON serialization using `Data.Aeson.Generic`.
586− * `Text.Pandoc.Biblio`
574+ * Citation processing improvements (now part of pandoc-citeproc):
588− + Override citeproc-hs's `endWithPunct`.
589− The new version correctly sees a sentence ending in '.)' as ending
577+ + Fixed `endWithPunct` The new version correctly sees a sentence
590− with punctuation. This fixes a bug which led such sentences to receive
578+ ending in '.)' as ending with punctuation. This fixes a bug which
579+ led such sentences to receive an extra period at the end: '.).'.
591− an extra period at the end: '.).'. Thanks to Steve Petersen for
580+ Thanks to Steve Petersen for reporting.
593 + Don't interfere with Notes that aren't citation notes.
581 + Don't interfere with Notes that aren't citation notes.
594 This fixes a bug in which notes not generated from citations were
582 This fixes a bug in which notes not generated from citations were
595 being altered (e.g. first letter capitalized) (#898).
583 being altered (e.g. first letter capitalized) (#898).
@@ -603,12 +591,6 @@
603 `\citep[23]{item1}` in LaTeX will be interpreted properly,
591 `\citep[23]{item1}` in LaTeX will be interpreted properly,
604 with '23' treated as a locator of type 'page'.
592 with '23' treated as a locator of type 'page'.
606− * New module `Text.Pandoc.JSON` in pandoc-types.
608− + This provides `ToJSON` and `FromJSON` instances for the basic
609− pandoc types. They use GHC generics and should be faster than the
610− old JSON serialization using `Data.Aeson.Generic`.
612pandoc (1.11.1)
594pandoc (1.11.1)
614 * Markdown reader:
596 * Markdown reader: