@@ -1,5 +1,231 @@
11# Revision history for pandoc
22
3+## pandoc 2.14 (PROVISIONAL)
4+
5+ * Change reader types, allowing better tracking of source positions
6+ [API change]. Previously, when multiple file arguments were provided,
7+ pandoc simply concatenated them and passed the contents to the readers,
8+ which took a Text argument. As a result, the readers had no way of knowing
9+ which file was the source of any particular bit of text. This meant that
10+ we couldn't report accurate source positions on errors or include accurate
11+ source positions as attributes in the AST. More seriously, it meant that
12+ we couldn't resolve resource paths relative to the files containing them
13+ (see e.g. #5501, #6632, #6384, #3752).
14+
15+ * Add Text.Pandoc.Sources (exported module), with a `Sources` type and a
16+ `ToSources` class. A `Sources` wraps a list of `(SourcePos, Text)` pairs
17+ [API change]. A parsec `Stream` instance is provided for `Sources`. The
18+ module also exports versions of parsec's `satisfy` and other Char parsers
19+ that track source positions accurately from a `Sources` stream (or any
20+ instance of the new `UpdateSourcePos` class).
21+
22+ * Text.Pandoc.Parsing
23+
24+ + Export the modified Char parsers defined in Text.Pandoc.Sources
25+ instead of the ones parsec provides. Modified parsers to use a
26+ `Sources` as stream [API change].
27+ + Improve include file functions [API change]. Remove old
28+ `insertIncludedFileF`. Give `insertIncludedFile` a more general type,
29+ allowing it to be used where `insertIncludedFileF` was.
30+
31+ * Text.Pandoc.Error: Modified the constructor `PandocParsecError` to take a
32+ `Sources` rather than a `Text` as first argument, so parse error locations
33+ can be accurately reported.
34+
35+ * Fix source position reporting for YAML bibliographies (#7273).
36+
37+ * Issue error message when reader or writer format is malformed
38+ (#7231). Previously we exited with an error status but (due to a bug)
39+ no message.
40+
41+ * Smarter smart quotes (#7216, #2103). Treat a leading `"` with no
42+ closing `"` as a left curly quote. This supports the practice, in
43+ fiction, of continuing paragraphs quoting the same speaker without an
44+ end quote. It also helps with quotes that break over lines in line blocks.
45+
46+ * Markdown reader: Use MetaInlines not MetaBlocks for multimarkdown
47+ metadata fields. This gives better results in converting to e.g.
48+ pandoc markdown.
49+
50+ * RST reader:
51+
52+ + Seek include files in the directory of the file
53+ containing the include directive, as RST requires (#6632).
54+ + Use `insertIncludedFile` from Text.Pandoc.Parsing
55+ instead of reproducing much of its code.
56+
57+ * Org reader: Resolve org includes relative to the directory containing the
58+ file containing the INCLUDE directive (#5501).
59+
60+ * ODT reader: Treat tabs as spaces (#7185, niszet).
61+
62+ * Docx reader: Add handling of vml image objects (#7257, mbrackeantidot).
63+
64+ * DocBook/JATS readers:
65+
66+ + Fix mathml regression caused by the switch in XML libraries (#7173).
67+ + Fix "phrase" in DocBook: take classes from "role" not "class" (#7195).
68+
69+ * Plain writer: handle superscript unicode minus (#7276).
70+
71+ * LaTeX writer: better handling of line breaks in simple tables (#7272).
72+ Now we also handle the case where they're embedded in other
73+ elements, e.g. spans.
74+
75+ * EPUB Writer: Fix belongs-to-collection XML id choice (#7267, nuew).
76+ The epub writer previously used the same XML id for both the book
77+ identifier and the epub collection. This causes an error on epubcheck.
78+
79+ * BibTeX/BibLaTeX writer: Handle `annote` field (#7266).
80+
81+ * ConTeXt writer: support blank lines in line blocks (#6564,
82+ Albert Krewinkel, thanks to @denismaier).
83+
84+ * Org writer:
85+
86+ + Inline latex envs need newlines (#7252, tecosaur).
87+ As specified in https://orgmode.org/manual/LaTeX-fragments.html, an
88+ inline \begin{}...\end{} LaTeX block must start on a new line.
89+ + Use LaTeX style maths deliminators (#7196, tecosaur).
90+
91+ * JATS writer (Albert Krewinkel):
92+
93+ + Use either styled-content or named-content for spans (#7211).
94+ If the element has a content-type attribute, or at least one class,
95+ then that value is used as `content-type` and the span is put inside
96+ a `<named-content>` element. Otherwise a `<styled-content>` element
97+ is used instead.
98+ + Reduce unnecessary use of <p> elements for wrapping (#7227).
99+ The `<p>` element is used for wrapping in cases were the contents
100+ would otherwise not be allowed in a certain context. Unnecessary
101+ wrapping is avoided, especially around quotes (`<disp-quote>` elements).
102+ + Convert spans to `<named-content>` elements (#7211). Spans with
103+ attributes are converted to `<named-content>` elements instead of
104+ being wrapped with `<milestone-start/>` and `<milestone-end>`
105+ elements. Milestone elements are not allowed in documents using the
106+ articleauthoring tag set, so this change ensures the creation of valid
107+ documents.
108+ + Add footnote number as label in backmatter (#7210). Footnotes in the
109+ backmatter are given the footnote's number as a label. The
110+ articleauthoring output is unaffected from this change, as footnotes
111+ are placed inline there.
112+ + Escape disallows chars in identifiers. XML identifiers must start
113+ with an underscore or letter, and can contain only a limited set
114+ of punctuation characters. Any IDs not adhering to these rules are
115+ rewritten by writing the offending characters as `Uxxxx`,
116+ where `xxxx` is the character's hex code.
117+
118+ * Docx writer:
119+
120+ + Autoset table width if no column has an explicit width (Albert
121+ Krewinkel).
122+ + Extract Table handling into separate module (Albert Krewinkel).
123+ + Support colspans and rowspans in tables (Albert Krewinkel, #6315).
124+ + Improve integration of settings from reference.docx (#1209).
125+ This change allows users to create a reference.docx that
126+ sets `w:proofState` for spelling or grammar to `dirty`,
127+ so that spell/grammar checking will be triggered on the
128+ generated docx.
129+
130+ * Writers: Recognize custom syntax definitions (#7241, Jan Tojnar).
131+ Languages defined using `--syntax-definition` were not recognized by
132+ `languagesByExtension`. This patch corrects that, allowing the writers
133+ to see all custom definitions. The LaTeX writer still uses the default
134+ syntax map, but that's okay in that context, since
135+ `--syntax-definition` won't create new listings styles.
136+
137+ * Markdown writer:
138+
139+ + Use cleaner braceless syntax for code blocks with a
140+ single class (#7242, Jan Tojnar).
141+ + Add quotes properly in markdown YAML metadata fields (#7245).
142+ This fixes a bug, which caused the writer to look at the *last*
143+ rather than the *first* character in determining whether quotes
144+ were needed. So we got spurious quotes in some cases and
145+ didn't get necessary quotes in others.
146+
147+ * Commonmark writer: Use backslash escapes for `<` and `|`...
148+ instead of entities (#7208).
149+
150+ * Powerpoint writer: allow `monofont` to be specified in metadata
151+ (#7187).
152+
153+ * LaTeX template:
154+
155+ + Use non-starred names for xcolor color names (#6109).
156+ This should make svgnames and x11names work properly.
157+ + Fix bad vertical spacing after bibliography (#7234, badumont).
158+ + List of figures before list of tables (#7235, Julien Dutant).
159+
160+ * ConTeXt template: List of figures before list of tables (#7235,
161+ Julien Dutant).
162+
163+ * reveal.js template: Support `toc-title` (#7171, Florian Kohrt).
164+
165+ * Text.Pandoc.XML.Light: add Eq, Ord instances for Content,
166+ Element, Attr, CDataKind [API change].
167+
168+ * Text.Pandoc.Asciify: simplify code and export `toAsciiText` [API change].
169+ Instead of encoding a giant (and incomplete) map, we now
170+ just use unicode-transforms to normalize the text to
171+ a canonical decomposition, and manipulate the result.
172+
173+ * App: allow tabs expansion even if file-scope is used (Albert Krewinkel,
174+ #6709). Tabs in plain-text inputs are now handled correctly, even if
175+ the `--file-scope` flag is used.
176+
177+ * Add new internal module Text.Pandoc.Writers.GridTable (Albert Krewinkel).
178+
179+ * Text.Pandoc.Highlighting: Change type of `languagesByExtension`, adding
180+ a parameter for a `SyntaxMap` [API change] (Jan Tojnar).
181+
182+ * Use metadata's `lang` for the lang parameter of citeproc, overriding
183+ `localeLanguage`.
184+
185+ * Remove Text.Pandoc.BCP47 module [API change].
186+ Use types and functions from UnicodeCollation.Lang instead.
187+ This is a richer implementation of BCP 47.
188+
189+ * Text.Pandoc.Shared:
190+
191+ + Fix regression in grid tables for wide characters (#7214).
192+ In the translation from String to Text, a char-width-sensitive
193+ `splitAt'` was dropped. This commit reinstates it and uses it to make
194+ `splitTextByInstances` char-width sensitive.
195+ + Add `getLang` (formerly in the now-removed BCP47) [API change].
196+
197+ * Text.Pandoc.SelfContained: use `application/octet-stream`
198+ for unknown mime types instead of halting with an error (#7202).
199+
200+ * Lua filters: respect Inlines/Blocks filter functions in `pandoc.walk_*`
201+ (Albert Krewinkel).
202+
203+ * Add text as build-depend for trypandoc (#7193, Roman Beránek).
204+
205+ * Use citeproc 0.4.
206+
207+ * Use texmath 0.12.3.
208+
209+ * Allow attoparsec 0.14.x.
210+
211+ * Require latest skylighting (fixes a bug in XML syntax highlighting).
212+
213+ * Use latest xml-conduit.
214+
215+ * MANUAL: Add information about `lang` and bibliography sorting.
216+
217+ * Updated and fixed typos in documentation (Charanjit Singh,
218+ Anti-Distinctlyminty, Tatiana Porras, obcat).
219+
220+ * Add instructions for installing pandoc-types before compiling filter.
221+
222+ * INSTALL: add note that parallel installations should be avoided
223+ (#6865).
224+
225+ * Remove `biblatex-nussbaum.md` test. It is basically the same
226+ as `biblaetx-quotes.md`.
227+
228+
3229## pandoc 2.13 (2021-03-21)
4230
5231 * Support `yaml_metadata_block` extension for `commonmark`, `gfm` (#6537).