git.iko.soy/typeable/pandoc
on rc/2.11 help sign in
typeable/pandoc/changelog.md
18239 lines 784 kB history raw
1# Revision history for pandoc
3## pandoc 2.11 (2020-10-11)
5 * Add `--citeproc` (`-C`) option to trigger built-in citation processing.
6 It is no longer necessary to use the external `pandoc-citeproc`
7 filter. `--citeproc` behaves like a filter and can be positioned
8 relative to other filters as they appear on the command line.
10 The new built-in citation processing uses the citeproc library,
11 a reimplementation of CSL citation processing that fixes many
12 of the shortcomings of pandoc-citeproc. In general, citation
13 processing should work much the same as it did with pandoc-citeproc,
14 but with greater fidelity to CSL styles and better performance.
15 (The tests from the pandoc-citeproc package have been carried
16 over to pandoc.) The following differences should be noted:
18 - At this point, only some of the writers (HTML, ms, LaTeX) properly
19 interpret CSL display styles. You should get decent output in
20 all formats (at least as good as with pandoc-citeproc), but
21 indentation and block-alignment may not be right.
23 - pandoc-citeproc searches the `~/.csl` directory for `.csl`
24 styles. Pandoc instead searches the `csl` subdirectory of
25 the pandoc user data directory (e.g., `~/.pandoc/csl` or
26 `~/.local/share/pandoc/csl`). Users who already keep
27 CSL styles in `~/.csl` may find it convenient to add a
28 symlink.
30 - Some of the bibliography formats supported by pandoc-citeproc (via
31 hs-bibutils) are no longer supported: Copac, EndNote,
32 ISI, MEDLINE, MODS, and RIS. If you use one of these formats,
33 you may use the `bibutils` utility to convert to CSL JSON
34 or BibTeX. We now support only BibTeX, BibLaTeX, CSL JSON,
35 and pandoc's YAML/Markdown analogue of CSL JSON.
37 - pandoc-citeproc would always retrieve the independent parent
38 of a dependent style by doing an HTTP request. pandoc will
39 now first seek the independent parent locally (in the resource
40 path or in the `csl` subdirectory of the pandoc user data
41 directory) before resorting to HTTP. In addition, you may
42 omit the `.csl` extension, e.g. `--csl zoology`.
44 - Using the `--bibliography` option (or including
45 `bibliography` in YAML metadata) no longer triggers
46 citation processing implicitly: one must always use the
47 `--citeproc` option if citation processing is wanted.
49 * Add `csljson` as and input and output format. This allows pandoc
50 to convert between `csljson` and other bibliography formats
51 (e.g. `-f csljson -t markdown -s` or `-f bibtex -t csljson`),
52 and to generate formatted versions of CSL JSON bibliographies
53 (e.g., `pandoc -f csljson --citeproc pl.json -o pl.pdf`).
55 * Added `bibtex`, `biblatex` as input formats. This allows pandoc
56 to convert between BibLaTeX and BibTeX and other bibliography formats,
57 and to generated formatted versions of BibTeX/BibLaTeX bibliographies
58 (e.g., `pandoc -f biblatex --citeproc pl.bib -o pl.pdf`).
60 * Raise informative errors when YAML metadata parsing fails (#6730).
61 Previously the command would succeed, returning empty metadata,
62 with no errors or warnings.
64 * Sort languages in `--list-highlight-languages` output (#6718,
65 Albert Krewinkel). Languages were previously sorted by their
66 long name, which leads to unexpected results).
68 * Add CSS to default HTML template (#6601, Mauro Bieg). This
69 greatly improves the default typography in pandoc's HTML
70 output. The CSS is sensitive to a number of variables
71 (e.g. `mainfont`, `fontsize`, `linestretch`): see the manual for
72 details. To restore the earlier, more spartan output, you can
73 disable this with `-M document-css=false`.
75 * Support `--toc-depth` option for ODT writer (#6696, niszet).
77 * Fix issues with Windows UNC paths with some options (#5127).
79 * Remove `fenced_code_blocks` and `backtick_code_blocks` from allowed
80 `commonmark` and `gfm` extensions. These shouldn't really be counted
81 as extensions, because they can't be disabled in commonmark.
82 Adjust markdown writer to check for the commonmark variant in addition
83 to extensions.
85 * Add these extensions to `gfm` and `commonmark`:
86 `fenced_code_blocks`, `backtick_code_blocks`, `fenced_code_attributes`.
87 These can't really be disabled in the reader, but they need to be enabled
88 in the writer or we just get indented code.
90 * Make sure proper set of extensions is recognized for `commonmark_x`.
92 * Allow `gfm_auto_identifiers`, `ascii_identifiers` extensions for `docx`.
94 * Markdown reader:
96 + Add `Maybe FilePath` parameter to `yamlToMeta` [API change].
97 + Export `yamlToRefs` [API change], a version of `yamlToMeta`
98 specialized to references.
99 + Set `citationNoteNum` accurately in citations.
100 + Revise abbreviation support. Don't insert a nonbreaking space after a
101 potential abbreviation if it comes right before a note or citation.
102 This causes problems for citeproc's moving of note citations.
104 * LaTeX reader:
106 + Support missing siunitx commands (#6658).
107 + Support `squared`, `cubed`, `tothe` in siunitx (#6657).
108 + Improved uncertainty handling in slunitx.
109 + Factored out siunitx stuff into separate unexposed module.
110 + Fix improper empty cell filtering (#6689, Christian Despres).
111 + Fix parsing of "show name" in `\newtheorem` (#6734).
112 Previously we were just treating it as a string and
113 ignoring accents and formatting.
114 + Prevent wrong nesting of `\multirow` and `\multicolumn` table
115 cells (#6603, Laurent P. René de Cotret).
116 + Table cell parser not consuming spaces correctly (#6596,
117 Laurent P. René de Cotret).
118 + Change `SIRange` to `SIrange` (#6617, Emerson Harkin).
119 + Allow blank lines inside `\author` (#6324).
121 * DocBook reader:
123 + Don't squelch space at end of emphasis and other inline elements;
124 instead, move it outside the element (#6719).
125 + Implement table cell alignment (#6698, Nils Carlson).
126 + Implement column span support for tables (#6492, Nils Carlson).
127 + Update list of block level tags (#6610).
130 * JATS reader:
132 + Don't squelch space at end of emphasis and other inline elements;
133 instead, move it outside the element (#6719).
135 * RST reader:
137 + Apply `.. class::` directly to following Header rather than creating
138 a surrounding Div (#6699).
140 * Docx reader:
142 + Allow empty dates in comments and tracked changes (#6726, Diego
143 Balseiro).
145 * Markdown writer:
147 + Be less aggressive about using quotes for YAML values,
148 allowing e.g. a quotation mark or bracket as long as it's not at the
149 beginning of the line.
150 + Use double quotes for YAML metadata (#6727).
151 + Sort YAML metadata keys in Markdown output case-insensitive.
154 * Asciidoc writer:
156 + Support asciidoctor's block figures (#6538, argent0).
158 * LaTeX writer:
160 + Fix spacing issue with list in definition list.
161 When a list occurs at the beginning of a definition list definition,
162 it can start on the same line as the label, which looks bad.
163 Fix that by starting such lists with an `\item[]`.
165 * HTML writer:
167 + Support intermediate table headers (#5314, Albert Krewinkel).
168 + Support attributes on all table elements (Albert Krewinkel).
169 + Render table footers if present (#6314, Albert Krewinkel).
170 + Fix addition of `doc-biblioentry` role.
171 + Support colspans and rowspans in HTML tables (#6312, Albert Krewinkel).
173 * ICML writer:
175 + Support internal document links (#5541, Leonard Rosenthol).
176 + Changed default link state to invisible (#6676, Leonard Rosenthol).
178 * Docx writer:
180 + Better handle list items whose contents are lists (#5948, Michael
181 Hoffmann). If the first element of a bulleted or ordered list is
182 another list, then that first item would previously disappear if the
183 target format is docx.
184 + Separate adjacent tables (#4315). Word combines adjacent tables,
185 so to prevent this we insert an empty paragraph between two
186 adjacent tables.
188 * Org writer:
190 + Don't force blank line after headings (#6554).
192 * OpenDocument writer:
194 + Implement table cell alignment (#6700 Nils Carson, Mauro Bieg).
195 + New table cell support with row and column spans (#6682, Nils Carson).
196 + Syntax highlighting for inline code (#6711, niszet).
198 * Add Text.Pandoc.Citeproc module, exporting `processCitations`
199 [API change]. This depends on several other, unexported
200 modules under Text.Pandoc.Citeproc.
202 * Add module Text.Pandoc.Writers.CslJson, exporting `writeCslJson`.
203 [API change]
205 * Add module Text.Pandoc.Readers.CslJson, exporting `readCslJson`.
206 [API change]
208 * Add module Text.Pandoc.Readers.BibTeX, exporting `readBibTeX` and
209 `readBibLaTeX`. [API change]
211 * Text.Pandoc.Filter: Add `CiteprocFilter` constructor to Filter.
212 [API change] This runs the processCitations transformation.
213 We need to treat it like a filter so it can be placed
214 in the sequence of filter runs (after some, before others).
215 In FromYAML, this is parsed from `citeproc` or `{type: citeproc}`,
216 so this special filter may be specified either way in a defaults file
217 (or by `citeproc: true`, though this gives no control of positioning
218 relative to other filters).
220 * Add new exported module Text.Pandoc.Writers.AnnotatedTable [API change]
221 (#6655, Christian Despres). This module (which should generally
222 be imported qualified to avoid name conflicts) provides a
223 `Table` type that mirrors the structure of a pandoc `Table`,
224 but with added inferred information so that the writers do not have to
225 lay out tables themselves. The `toTable` and `fromTable` functions convert
226 between an annotated `Table` and a regular pandoc `Table`. In addition to
227 producing a `Table` with coherent and well-formed annotations, the
228 `toTable` function also normalizes its input table like the table
229 builder does. Tests ensure that `toTable` normalizes tables exactly
230 like the table builder, and that its annotations are coherent.
232 * Text.Pandoc.Logging:
234 + Remove unused `CouldNotParseYamlMetadata` constructor for `LogMessage`
235 [API change].
236 + Add `CiteprocWarning` constructor to `LogMessage` [API change].
238 * Text.Pandoc.Readers.Metadata: export `yamlBsToRefs` [API change].
239 These allow specifying an id filter so we parse only references
240 that are used in the document.
242 * Text.Pandoc.Parsing:
244 + Export ParseError [API change].
245 + Add `stateInNote` and `stateNoteNumber` to `ParserState`
246 [API change]. These are used to populate note numbers for citation
247 processing.
249 * Fix apparent typos in sample.lua (#6729, William Lupton).
250 Also make the writer less aggressive in escaping quotes.
252 * Text.Pandoc.Options:
254 + `defaultMathJaxURL`: use `tex-chtml-full` instead of `tex-mml-chtml`
255 (#6599, Kolen Cheung). This drops the MathML support (which we
256 don't need for HTML math rendering) and includes the full JavaScript,
257 which makes it possible to use `--self-contained` (though there may
258 still be issues if the required math fonts aren't available). This
259 change should also reduce latency in pages with lots of formulas.
260 + Add `/tex-chtml-full.js` to `defaultMathJaxURL` (#6593) Previously we
261 added this in processing command line options, but not in processing
262 defaults files, which was inconsistent.
264 * epub.css: Fix cover page selectors and add note explaining their use
265 (#6649, a-vrma).
267 * Add data files needed for Text.Pandoc.Citeproc: these include
268 `default.csl` in the data directory and a `citeproc` directory that
269 is only used at compile-time for biblatex localizations. Note that we've
270 added `file-embed` as a mandatory rather than a conditional depedency,
271 because of the biblatex localization files.
273 * Lua filters:
275 + Add SimpleTable for backwards compatibility (#6575, Albert Krewinkel).
276 A new type `SimpleTable` is made available to Lua filters. It is
277 similar to the `Table` type in pandoc versions before 2.10;
278 conversion functions from and to the new Table type are provided.
279 Old filters using tables now require minimal changes and can use, e.g.,
281 if PANDOC_VERSION > {2,10,1} then
282 pandoc.Table = pandoc.SimpleTable
283 end
285 and
287 function Table (tbl)
288 tbl = pandoc.utils.to_simple_table(tbl)
289 …
290 return pandoc.utils.from_simple_table(tbl)
291 end
293 to work with the current pandoc version.
295 + Make `attr` argument optional in `Table` constructor (Albert Krewinkel).
296 This changes the Lua API. It is highly unlikely for this change to affect
297 existing filters, since the documentation for the new Table constructor
298 (and type) was incomplete and partly wrong before. The Lua API is now
299 more consistent, as all constructors for elements with attributes now
300 take attributes as the last parameter.
302 * MANUAL.txt:
304 * Add a dedicated Citations section which consolidates the information
305 the manual used to contain about citation processing, and incorporates
306 some information formerly found in the pandoc-citeproc man page.
307 + Add note about lualatex using `selnolig`.
308 + Remove duplicate `seriespage` (#6568, Blake Eryx).
309 + Remove lists of support extensions for markdown variants (#6604).
310 Instead, offer the advice to use `--list-extensions=FORMAT`.
311 + Fix position of attributes in header (Albert Krewinkel).
312 + Delete obsolete section on compact and loose lists (#6684).
315 * doc/lua-filters.md:
317 + Add info on how to debug Lua filters (#6732, Ian Max Andolina).
318 + Document Underline type and constructor (Albert Krewinkel).
319 + Document `body` field (Albert Krewinkel).
320 + Add missing header attribute
321 + Add missing Link.title field (Albert Krewinkel).
322 + Make the setting-the-date example conditional (the-solipsist).
323 This makes the example a bit more realistic.
324 + Remove outdated link table example.
326 * doc/org.md:
328 + Add section on tables (Albert Krewinkel).
329 + Add section on handling of unknown directives (Albert Krewinkel).
331 * CONTRIBUTING.md: fix typo (#6584, Dmitry Volodin).
333 * Use golden test framework for command tests. This means that
334 `--accept` can be used to update expected output.
336 * Use the `smart` extension when generating pandoc's man page (#6613).
338 * Release-candidate: don't build windows i386.
339 So far we haven't been able to figure out how to get
340 stack to use a 32-bit ghc.
342 * Use `null` instead of deprecated `Builder.isNull`.
344 * Makefile:
346 + Fix macospkg target to fetch target from S3 artifacts.
347 + Fix pandoc-templates target to include all partials.
349 * Remove duplicated dependency in pandoc.cabal (#6591, Felix Yan).
351 * Sort build depends in pandoc.cabal alphabetically (#6691,
352 Albert Krewinkel).
354 * Add .travis.yml for macos release candidate build (#6622).
355 We need to build the release candidate on Travis rather
356 than GitHub actions, because GH has macos 10.15, and
357 binaries compiled on that OS will not work with 10.13.
358 This build is only triggered on `rc/*` branches.
360 * Remove instructions for building pandoc-citeproc from CI and
361 release binary build instructions. We will no longer distribute
362 pandoc-citeproc.
364 * Fix math rendering in trypandoc (this broke after
365 commit d8ad766d17603784b86fc5c2e1b22864125d04d1).
367 * Use latest versions of skylighting, commonmark (#6589),
368 comonmark-extensions, commonmark-pandoc, texmath.
370 * Relax version bounds for hslua, hslua-module-text, bytestring.
372 * Use released pandoc-types 1.22. This changes the JSON
373 encoding slightly for the new table types introduced
374 in 1.21, so they're more consistent with the rest.
375 Developers of libraries for pandoc filters will want
376 to take note.
378 * Fix hlint suggestions, update hlint.yaml (#6680, Christian Despres).
380 * Code cleanup (#6678, Joseph C. Sible).
382 * Add haddocks to functions in Text.Pandoc.Writers.Shared (Albert
383 Krewinkel).
385 * Remove duplicate `tshow` definition.
387 * Linux release candidate build: use ghc-musl container. This simplifies
388 our build process (over using a customized alpine container).
391## pandoc 2.10.1 (2020-07-23)
393 * Add `commonmark_x` output format. This is `commonmark` with a number
394 of useful pandoc extensions enabled.
396 * Many more extensions now work with `commonmark` and `gfm`.
398 * Add generic `attributes` extension. This allows attributes to
399 be added to any block or inline element in a uniform way. Since
400 the Pandoc AST doesn't include attributes on each element type,
401 the attributes will sometimes be added by creating a surrounding
402 Div or Span container. Currently this extension is only
403 compatible with the `commonmark` and `gfm` readers.
405 To add an attribute to a block-level element, e.g. a paragraph,
406 put it before the block:
407 ```
408 {#mypara}
409 This is a paragraph.
410 ```
411 Multiple attributes may be used and will be combined:
412 ```
413 {#mypara}
414 {.blue .warning key="val"}
415 This is a paragraph.
416 ```
417 To add an attribute to an inline-level element, put it
418 immediately after the element:
419 ```
420 *emphasized text*{.special}
421 ```
423 * Support `--number-sections` for docx output (#1413).
425 * LaTeX reader:
427 + Support `\SIRange` reader (#6418, Emerson Harkin).
428 + Support table col-span and row-span (#6311, Laurent P. René de Cotret).
429 Supports `\multirow` and `\multicolumn`.
430 + Support amsthm: `\newtheorem`, `\theoremstyle`, and theorem and
431 proof environments, including labels and references. The only thing
432 that is unsupported is the second optional argument, which causes
433 numbering to be reset after the specified series is incremented.
434 + Moved some code to T.P.LaTeX.Parsing. We need to reduce the size
435 of the LaTeX reader to ease compilation on resource-limited systems.
437 * RST reader:
439 + Fix csv tables with multiline cells (#6549).
440 + Fix spurious newlines in some attributes from directives.
441 + Avoid extra newline in included code blocks.
443 * Commonmark reader:
445 + Switch from cmark-gfm to commonmark-hs for commonmark and gfm
446 parsing. This avoids depending on a C library
447 and allows us to support more pandoc extensions for
448 `commonmark` and `gfm`.
450 * DocBook reader:
452 + Parse releaseinfo as metadata (#6542).
454 * Docx reader:
456 + Only use `bCs/iCs` on runs with `rtl` or `cs` property (#6514, Nikolay
457 Yakimov).
458 + Code cleanup/refactoring (Nikolay Yakimov).
460 * Org reader (Albert Krewinkel):
462 + Respect export setting which disables entities
463 MathML-like entities, e.g., `\alpha`, can be disabled with the
464 `#+OPTION: e:nil` export setting (Albert Krewinkel).
465 + Respect export setting disabling footnotes. Footnotes can be removed
466 from the final document with the `#+OPTION: f:nil` export setting.
467 + Respect tables-excluding export setting. Tables can be removed from
468 the final document with the `#+OPTION: |:nil` export setting.
470 * Markdown writer:
472 + Move `asciify` out of `escapeString`. Otherwise `unsmartify`
473 doesn't catch quotes that have already been turned to entities.
474 + Add `writeCommonmark` (new exported function, API change).
475 + Use unicode super/subscript characters when possible if the
476 `superscript` or `subscript` extension or `raw_html` aren't available.
477 + Render caption as following paragraph when `table_caption` extension
478 is not enabled.
479 + Use numerical labels for reference links that are longer
480 than 999 characters or contain square brackets, for conformity
481 with commonmark (#6560).
483 * Commonmark writer:
485 + Instead of using cmark-gfm, use `writeCommonmark` from the
486 Markdown writer. This function calls the markdown writer
487 with appropriate extensions and a few small modifications
488 (e.g. not requiring backslashes before spaces inside
489 super/subscripts). With this change `comonmark` and
490 `gfm` output can be used with a wider selection of
491 extensions.
493 * Jira writer: keep image caption as alt attribute (#6529, Albert
494 Krewinkel).
496 * HTML writer:
498 + Improve alt-text/caption handling for HTML5 (#6491, Albert Krewinkel).
499 Screen readers read an image's `alt` attribute and the figure caption,
500 both of which come from the same source in pandoc. The figure caption is
501 hidden from screen readers with the `aria-hidden` attribute. This
502 improves accessibility. For HTML4, where `aria-hidden` is not allowed,
503 pandoc still uses an empty `alt` attribute to avoid duplicate contents.
505 * Ms writer:
507 + Fix code highlighting with blank lines. Previously blank lines
508 were simply omitted from highligted code.
509 + Escape starting periods in ms writer code blocks (#6505, Michael
510 Hoffmann). If a line of ms code block output starts with a period (.),
511 it should be prepended by `\&` so that it is not interpreted as a roff
512 command.
514 * Text.Pandoc.Extensions:
516 + Add `raw_markdown` extension (which only affects `ipynb`
517 input).
518 + Trim down `githubMarkdownExtensions`.
519 Previously it included all of the following, which make
520 sense for the legacy `markdown_github` but not for `gfm`,
521 since they are part of base commonmark and thus
522 can't be turned off in `gfm`:
524 - `Ext_all_symbols_escapable`
525 - `Ext_backtick_code_blocks`
526 - `Ext_fenced_code_blocks`
527 - `Ext_space_in_atx_header`
528 - `Ext_intraword_underscores`
529 - `Ext_lists_without_preceding_blankline`
530 - `Ext_shortcut_reference_links`
532 These have been removed from `githubMarkdownExtensions`, though
533 they're still turned on for legacy `markdown_github`.
534 + Add `Ext_attributes` constructor for `Extension` [API change].
536 * LaTeX template: use selnolig to selectively suppress ligatures with
537 lualatex (#6534).
539 * Benchmark bytestring readers (Nikolay Yakimov).
541 * Documentation:
543 + Update using-the-pandoc-api.md (favonia).
544 + Fix Typos in lua-filters.md (tajmone).
545 + Rewrite Raw HTML/TeX section in MANUAL.txt to avoid duplicate
546 headings for the extensions.
547 + Fix typo in MANUAL.txt (Benjamin Wuethrich).
548 + Remove duplicate 'titlepage' in MANUAL.txt (Blake Eryx).
549 + CONTRIBUTING.md: Advertise the official nightlies in GitHub actions.
550 Replaces #6500, thanks to @ickc.
554## pandoc 2.10 (2020-06-29)
556 * Use pandoc-types 1.21. This adds two things:
558 + A native Underline constructor for Inline (#6277, Vaibhav Sagar).
559 + More expressive types for tables (#1024, Christian Despres).
560 Tables can now take attributes; and rowspans and colspans,
561 column headers, multiple row headers, table head and foot
562 can all be represented. (Note, however, that reader and
563 writer support for these features is still lacking, so
564 most users won't see any differences in table conversion
565 yet. These changes just lay the foundation for further
566 improvements.)
568 * Support new Underline element in readers and writers (#6277,
569 Vaibhav Sagar).
571 * Support new Table type (Christian Despres).
572 The Builder.simpleTable now only adds a row to the TableHead
573 when the given header row is not null. This uncovered an
574 inconsistency in the readers: some would unconditionally
575 emit a header filled with empty cells, even if the header
576 was not present. Now every reader has the conditional
577 behaviour. Only the XWiki writer depended on the header row
578 being always present; it now pads its head as necessary.
580 * Add an option to disable certificate validation (#6156, Cédric Couralet,
581 Cécile Chemin, Juliette Fourcot). This commit adds the option
582 `--no-check-certificate`, which disables certificate checking when
583 resources are fetched by HTTP.
585 * Unify defaults and markdown metadata parsers (#6328, Nikolay
586 Yakimov). Clean up code in Text.Pandoc.Readers.Metadata and
587 properly handle errors in `yamlToMeta`. This fixes parsing
588 of Boolean fields in metadata withinin defaults files and reduces
589 code duplication.
591 * Docbook reader:
593 + Implement `<procedure>` (#6442, Mathieu Boespflug).
594 + Implement `<phrase>` (#6438, Mathieu Boespflug).
595 + Treat envar and systemitem like code (#6435, Mathieu Boespflug).
596 + Implement `<replaceable>` (#6437, Mathieu Boespflug)
597 + Map `<simplesect>` to unnumbered section (#6436, Mathieu Boespflug).
599 * JATS reader:
601 + Handle "label" element in section title (#6288).
602 + Parse abstract element into metadata field of same name
603 (#6480, Albert Krewinkel).
605 * Jira reader (Albert Krewinkel):
607 + Resolve multiple parsing problems, including issues with empty
608 table cells, faulty recognition of closing emphasis characters, and
609 parsing of image attributes (#6212, #6219, #6220).
610 + Two consecutive markup chars are now parsed verbatim (#6343);
611 styled text must not be empty.
612 + Newlines are no longer allowed within styled text (#6325).
613 + Links to anchors are now parsed as links (#6407).
614 + Retain image attributes (#6234). Jira images attributes as in
615 `!image.jpg|align=right!` are retained as key-value pairs. Thumbnail
616 images, such as `!example.gif|thumbnail!`, are marked by a
617 `thumbnail` class in their attributes.
618 + Use Underline for inserted text (#6237). Previously, the span was
619 marked with the non-standard class `inserted`.
620 + Improve icon conversion for `(/)`, `(x)`, `(!)`, `(?)`
621 `(+)`, `(-)`, `(off)`, `(*)`. (#6236, #6264).
622 + Support citations, attachment links, and user links (#6231, #6238,
623 #6239).
624 + Resolve parsing issues of blockquote, color (#6233, #6235).
626 * HTML reader:
628 + Parse attributes into table attributes.
629 + Support `<bdo>` (#5794, Tristan de Cacqueray).
630 + Add `summary` to list of block-level HTML tags (#6385).
631 This improves support for summary/details inside Markdown.
632 NOTE: you need to include a blank line before the closing
633 `</details>`, if you want the last part of the content to
634 be parsed as a paragraph.
635 + Fix parsing unclosed th elements in a table (#6247).
637 * Commonmark reader: Implement `implicit_figures` extension (#6350).
639 * Markdown Reader:
641 + Fix inline code in lists (#6284, Nikolay Yakimov).
642 Previously inline code containing list markers was sometimes
643 parsed incorrectly.
644 + Don't require blank line after grid table (#6481).
645 This allows grid tables to be enclosed in fenced divs with no
646 intervening blank lines.
648 * LaTeX reader:
650 + Don't parse beyond `\end{document}` (#6380).
651 This required some internal changes to `\subfile` handling.
652 + Better handling of `\lettrine`. SmallCaps instead of Span
653 for the part after the initial capital. Ensure that both
654 arguments are parsed, so that in Markdown both
655 are treated as raw LateX. (Closes #6258.)
657 * Org reader (Albert Krewinkel):
659 + Recognize images with uppercase extensions (#6472).
660 + Keep unknown keyword lines as raw org. The lines of unknown
661 keywords, like `#+SOMEWORD: value` are no longer read as metadata,
662 but kept as raw `org` blocks. This ensures that more information
663 is retained when round-tripping org-mode files; additionally,
664 this change makes it possible to support non-standard org
665 extensions via filters.
666 + Unify keyword handling. Handling of export settings and other
667 keywords (like `#+LINK`) has been combined and unified.
668 + Support `LATEX_HEADER_EXTRA` and `HTML_HEAD_EXTRA`
669 settings. These export settings are treated like their non-extra
670 counterparts, i.e., the values are added to the `header-includes`
671 metadata list.
672 + Allow multiple `#+SUBTITLE` export settings. The values of all
673 lines are read as inlines and collected in the `subtitle`
674 metadata field.
675 + Read `#+INSTITUTE` values as text with markup. The value is
676 stored in the `institute` metadata field and used in the
677 default beamer presentation template.
678 + The behavior of the `#+AUTHOR` and `#+KEYWORD` export
679 settings has changed: Org now allows multiple such lines
680 and adds a space between the contents of each line. Pandoc
681 now always parses these settings as meta inlines; setting
682 values are no longer treated as comma-separated lists.
683 Note that a Lua filter can be used to restore the previous
684 behavior.
685 + Read description lines as inlines (#6485). `#+DESCRIPTION` lines
686 are now treated as text with markup. If multiple such
687 lines are given, then all lines are read and separated by soft
688 linebreaks.
689 + Honor tex export option (#4070). The `tex` export option can be set
690 with `#+OPTION: tex:nil` and allows three settings:
691 `t` (the default) causes LaTeX fragments to be parsed as TeX or added
692 as raw TeX. `nil` removes all LaTeX fragments from the document.
693 `verbatim` treats LaTeX as text.
696 * RST reader:
698 + Pass arbitrary attributes through in code blocks (#6465).
699 Exceptions: name (which becomes the id), class (which becomes the
700 classes), and number-lines (which is treated specially to fit
701 with pandoc highlighting).
702 + Handle `date::` directive (#6276).
704 * Textile reader: support `pre.` for code blocks (#6454).
706 * Ipynb reader:
708 + Implement `raw_markdown` extension (#5408). Specifying
709 `-f ipynb+raw_markdown` will cause Markdown cells
710 to be represented as raw Markdown blocks, instead of being
711 parsed. This is not what you want when going from `ipynb`
712 to other formats, but it may be useful when going from `ipynb`
713 to Markdown or to `ipynb`, to avoid semantically insignificant
714 changes in the contents of the Markdown cells that might
715 otherwise be introduced.
716 + Handle application/pdf output as image (#6430).
717 + Properly handle image/svg+xml as an image (#6430).
719 * Docx reader:
721 + Distinguish between docx parsing and docx container unpacking errors.
723 * MediaWiki reader:
725 + Fix `gfm_auto_identifiers` so that `-` is not replaced by `_` (#6335).
727 * Vimwiki reader:
729 + Add nested syntax highlighting (#6256, Vlad Hanciuta).
730 Nested syntaxes are specified like this:
731 ```
732 {{{sql
733 SELECT * FROM table
734 }}}
735 ```
736 The preformatted code block parser has been extended to check if the
737 first attribute of the block is not a `key=value` pair, and in that
738 case it will be considered as a class.
741 * Jira writer (Albert Krewinkel):
743 + Always escape braces (#6478). Braces are now always escaped, even
744 within words or when surrounded by whitespace. Jira and
745 Confluence treat braces specially.
746 + Convert Underline to inserted text (`+inserted+`).
747 + Add image attributes (#6234). Image attributes are added
748 to the output as image parameters. If the image has a
749 class "thumbnail", then a thumbnail image is generated;
750 all other attributes are discarded in this case.
752 * LaTeX writer:
754 + Ensure that `-M csquotes` works even in fragment mode (#6265).
755 + Escape `^` specially for listings (#6460).
756 + Create hypertarget for links with identifier (#6360).
757 + Distinguish between single and double quotes when using enquote
758 package (#6457, dbecher-ito).
759 + Add support for customizable alignment of columns in beamer (#6331,
760 andrebauer).
761 + Add support for customizable alignment of columns in beamer
762 (#4805, #4150, andrebauer).
764 * HTML writer:
766 + Use CSS in favor of `<br>` for display math (#6372)
767 Some CSS to ensure that display math is
768 displayed centered and on a new line is now included
769 in the default HTML-based templates; this may be
770 overridden if the user wants a different behavior.
772 * Org writer:
774 + Clean-up Div handling (Albert Krewinkel).
776 * Docx writer:
778 + Enable column and row bands for tables (#6371).
779 This change will not have any effect with the default style.
780 However, it enables users to use a style (via a reference.docx)
781 that turns on row and/or column bands.
783 * OpenDocument (and ODT) writer:
785 + Add custom-style "Abstract" in metadata abstract.
786 This ensures that the abstract is rendered with style Abstract.
787 + Enable custom-style attribute on a Div.
788 This allows you to apply a custom style to contained paragraphs.
790 * DocBook writer:
792 + Add id of figure to enclosed image.
793 + Add personname element to docbook author (#6244).
795 * FB2 writer:
797 + Properly handle cover-image containing spaces (#6391).
799 * Markdown writer:
801 + Ensure consistent padding for pipe tables (#6240).
802 + Avoid unnecessary escapes before intraword `_` when
803 `intraword_underscores` extension is enabled (#6296).
805 * RST writer:
807 + Properly handle images with same alt text (#6194).
808 Previously we created duplicate references for these in rendering RST.
810 * AsciiDoc writer:
812 + Add blank line after Div (#6308).
814 * Haddock Writer:
816 + Support Haddock tables (Joe Hermaszewski).
817 See this PR on Haddock for details on the table format:
818 <https://github.com/haskell/haddock/pull/718>.
820 * PowerPoint writer (Jesse Rosenthal):
822 + Write math input verbatim in speaker notes (#6301).
823 OMML in speaker notes would lead to corrupt PowerPoint output. We now
824 output the OMML verbatim as LaTeX in the speaker notes.
826 * LaTeX template: Make polyglossia package options list-aware
827 (#6444, Frederik Elwert).
829 * Reveal.js template:
831 + Update template for reveal.js 4.0.0 (#6390, Salim B).
832 + Update template with newly available options (#6347, Jake Zimmerman).
833 + Use CDN version of revealjs v4 by default (#6408).
835 * opendocument template: Add abstract and subtitle to opendocument
836 template (#6369).
838 * reference.odt: clean up styles. Add Abstract.
839 Change Author, Date to centered paragraphs with no character
840 styling.
842 * epub.css: wrap overlong lines in highlighted code blocks (#6242).
843 This fixes a problem in iBooks v2.4 with our earlier
844 horizontally scrolling code blocks. The problem seems to
845 be a bug in iBooks, not pandoc, but since iBooks is a major
846 target we're changing pandoc's default behavior so that
847 pandoc-produced epubs work on that platform.
849 * Text.Pandoc.PDF:
851 + Use `--enable-local-file-access` in invoking `wkhtmltopdf` (#6474).
852 `wkhtmltopdf` changed in recent versions to require this for
853 access to local files. This fixes PDF via HTML5 with `--css`.
854 + Send verbose output to stderr, not stdout (#6483).
856 * Text.Pandoc.MIME: Fix MIME type for TrueType fonts in EPUBs
857 (#6464, Michael Reed).
859 * Text.Pandoc.Shared:
861 + `makeSections`: omit number attribute when unnumbered class
862 is present (#6339). Previously the attribute was included but given
863 an empty value, and this caused the table of contents creation
864 functions in Text.Pandoc.Writers.Shared to think these items had
865 numbers, which meant that they were included in the TOC even if the
866 `unlisted` class was used.
867 + Deprecate `underlineSpan` in Shared in favor of
868 `Text.Pandoc.Builder.underline` (Vaibhav Sagar).
869 + `renderTags'`: use self-closing tag for col element (#6295).
871 * Text.Pandoc.UUID: Fix `getRandomUUID`, which previously would
872 return the same value twice in a row. Make `getRandomUUID`
873 polymorphic in PandocMonad. Remove `getUUID` (#6228, Joseph C. Sible).
875 * Text.Pandoc.Class: Generalize `PandocIO` functions to `MonadIO`.
877 * Fixed Katex standalone script (#6399, Lucas Escot).
878 Global macros are now persistent when using the HTML Writer with the
879 `--katex` option.
881 * Lua subsystem (Albert Krewinkel):
883 + Use new type PandocLua for all pandoc Lua operations (API change).
884 The new type `PandocLua` is an instance of the `PandocMonad` typeclass
885 and can thus be used in a way similar to `PandocIO`.
886 + Use PandocError for exceptions in Lua subsystem (API change).
887 The PandocError type is used throughout the Lua subsystem. All Lua
888 functions throw an exception of this type if an error occurs. The
889 `LuaException` type is removed and no longer exported from
890 `Text.Pandoc.Lua`. In its place, a new constructor `PandocLuaError`
891 is added to PandocError.
893 * Lua filters: improve error messages for failing filters (#6332,
894 Albert Krewinkel). Print the Lua error properly instead of
895 displaying their `show` string.
897 * Use latest skylighting. This fixes a bug with lua multiline
898 comments (and may improve handling of other syntaxes as well).
899 IT also adds `aria-hidden="true"` to the empty a elements, which
900 helps people who use screen readers.
902 * Use latest texmath.
904 * Require latest doctemplates 0.8.2.
905 This adds support for template pipes `first`, `rest`,
906 `last`, `allbutlast`.
908 * Revert 0e48a02 and dependency on base-noprelude, which hasn't
909 been updated for ghc 8.10 (see #6187).
911 * Dependency adjustments:
913 + Allow haddock-library 1.9.x.
914 + Allow hslua 1.1 (#6243, Felix Yan).
915 + Allow base64-bytestring 1.1.
916 + Use latest jira-wiki-markup.
917 + Allow http-client 0.7.
918 + Allow tasty 1.3.x.
919 + Allow aeson 1.5 (#6400, Felix Yan).
920 + Remove unused dependency `vector` (#6462, Laurent P. René de Cotret).
921 + Bump QuickCheck upper bound.
923 * Significant code cleanup and simplification (Joseph C. Sible, #6223,
924 #6209, #6225, #6229, #6226, #6340).
926 * Remove unnecessary hlint ignores (#6341, Joseph C. Sible).
928 * Remove obsolete RelaxedPolyRec extension (#6487, Nikolay Yakimov).
930 * trypandoc improvements (Mike Tzou):
932 + Add standalone option to the command text (#6210).
933 + Update third party libraries.
935 * MANUAL.txt:
937 + Clarify template partial naming (#6476, Mauro Bieg).
938 + Describe `jira` as "Jira/Confluence wiki markup" (#6351, Albert
939 Krewinkel). In the past, Jira's wiki markup was also used by -- and
940 could be imported into -- Atlassian Confluence.
941 + Add link to print-css.rocks (#6272, Mauro Bieg).
942 + Clarify pipe table column width adjustment (#6254).
943 + Fix ATX header syntax.
944 + Fix misleading note about image size conversions (#6353).
945 + Update links to reveal.js documentation (#6386, Salim B).
946 + Separate adjacent verbatim code blocks (#6307, tom-audm).
948 * org.md:
950 + Document behavior of `smart` extension (#4387, Albert Krewinkel).
951 + Describe all supported export options in detail.
953 * lua-filters.md:
955 + Fix description of BulletList Lua type (Levi Gruspe).
956 + Use pandoc.system module in TikZ example (Albert
957 Krewinkel). Showcase temporary directory handling with
958 `with_temporary_directory` and `with_working_directory`.
960 * INSTALL.md: fix FreeBSD port link (#6422, Mo).
961 The FreeBSD port was renamed from pandoc to hs-pandoc in 2010.
962 The old pandoc port is still at version 1.5.1.1
964 * Propagate `(DY)LD_LIBRARY_PATH` in tests (#6376, Lila).
966 * Bump `cabal-version` to 2.2 (#6377).
968 * Make it possible to compile using Stack on NixOS (#6439, Mathieu
969 Boespflug).
971 * CI action to check for commit messsage length (Nikolay Yakimov, #6398).
974## pandoc 2.9.2.1 (2020-03-23)
976 * Markdown reader: Fix table alignment when heading begins with t (#6153).
977 Due to a typo (`t` instead of `\t`) we were center aligning column
978 headings that begin with a lowercase `t`!
980 * Text.Pandoc.Readers.Roff:
982 + Fix parsing of `\.` in man/ms readers (#6175).
983 Previously due to a typo it was being parsed as `` ` ``.
984 + Fix parsing of `\'` in man/ms readers (#6175). It was being parsed
985 as a backtick.
987 * Jira reader (Albert Krewinkel):
989 + Fix parsing of tables without preceding blankline (#6198).
990 A bug was fixed which caused faulty parsing if a table was not
991 preceded by a newline and the first table cell had no space
992 after the initial `|` characters.
993 + Fix parsing of strikeout, emphasis (#6196). A bug was fixed which
994 caused non-emphasized text containing digits and/or non-special
995 symbols (like dots) to sometimes be parsed incorrectly.
996 + Support colored inline text, indented lists (#6183, #6184).
998 * Ms writer:
1000 + Fix definition lists so indent even when paragraph indent is
1001 set to 0 (as is the default). Also ensure indent for display math
1002 that falls back to TeX.
1003 + Use `.QS/.QE` instead of `.RS/.RE` for block quotes.
1005 * EPUB writer: fix regression on detection of front/back/bodymatter
1006 (#6170). This bug caused sections with epub:type `dedication` to be
1007 misplaced in bodymatter instead of frontmatter as specified
1008 in the manual. The same problem would affect other epub:types.
1009 The pattern matching needed to be changed with the use of
1010 `makeSection`.
1012 * AsciiDoc writer: remove redundant `otherwise` guard in
1013 `inlineToAsciiDoc` (#6146, Ryan Scott).
1015 * Text.Pandoc.Class:
1017 + Fix missing import when data files are not embedded (Albert Krewinkel).
1018 + Subdivide Text.Pandoc.Class into small unexported modules
1019 and ensure that all functions have Haddock documentation (#6106,
1020 Albert Krewinkel).
1021 + Finer grained imports of Text.Pandoc.Class submodules (#6203, Albert
1022 Krewinkel).
1024 * Text.Pandoc.XML: Add to list of HTML5 attributes:
1025 `allow`, `autocapitalize`, `decoding`, `enterkeyhint`,
1026 `imagesizes`, `imagesrcset`, `loading`.
1028 * Use implicit Prelude (#6187, Albert Krewinkel).
1029 The previous behavior was introduced as a fix for #4464. It seems that
1030 this change alone did not fix the issue, and `stack ghci` and `cabal
1031 repl` only work with GHC 8.4.1 or newer, as no custom Prelude is loaded
1032 for these versions. Given this, it seems cleaner to revert to the
1033 implicit Prelude.
1035 * Always use custom prelude (#6187, Albert Krewinkel).
1036 Previously, the custom prelude was used only with older GHC versions, as
1037 a workaround for problems with ghci. The ghci problems are resolved by
1038 replacing package `base` with `base-noprelude`, allowing for consistent
1039 use of the custom prelude across all GHC versions.
1041 * Remove outdated checks for no longer supported base versions
1042 (Albert Krewinkel).
1044 * PDF via wkhtmltopdf: put user-specified options last (#6171).
1045 Certain options (e.g. `cover`) need to come after flags on
1046 the command line.
1048 * Text.Pandoc.App: set resource path at the beginning so it can affect
1049 things like include-in-header (#5982).
1051 * Change macOS release candidate CI process so that notarized
1052 packages can be produced (#6169).
1054 * Make MANUAL more explicit about nonbreaking space handling by
1055 `all_symbols_escapable` (#6154, Fabien Schurter).
1057 * trypandoc (Mike Tzou):
1059 + Add checkbox for standalone option (#6189).
1060 + Use strict mode for JavaScript code (#6188).
1061 + Fetch resources over https (#6188).
1062 + Remove unnecessary attributes on style, script elements (#6188).
1064 * Use details tag to make GitHub releases changelog collapsible.
1066 * Update filter code in doc/filters.md so it works with latest pandoc
1067 (#6185).
1069 * linux/Dockerfile: upgrade to alpine 3.11 (#6180, Albert Krewinkel).
1070 This is used to build the static linux binaries.
1073## pandoc 2.9.2 (2020-02-15)
1075 * Add `csv` as an input format (#6100). The CSV table is converted into a
1076 pandoc simple table. A new module Text.Pandoc.Readers.CSV
1077 exports `readCSV` [API change].
1079 * Introduce new format variants for JATS writer (#6014, Albert Krewinkel):
1081 - `jats_archiving` for the "Archiving and Interchange Tag Set",
1082 - `jats_publishing` for the "Journal Publishing Tag Set", and
1083 - `jats_articleauthoring` for the "Article Authoring Tag Set."
1085 The `jats` output format is now an alias for `jats_archiving`.
1086 The module Text.Pandoc.Writers.JATS now exports
1087 `writeJatsArchiving`, `writeJatsPublishing`, and
1088 `writeJatsArticleAuthoring`, as well as the legacy
1089 `writeJATS` [API change].
1091 * `--defaults`: Support `bibliography` and `csl` fields.
1092 Move `addMeta` from Text.Pandoc.App.CommandLineOptions to
1093 Text.Pandoc.App.Opt (internal change).
1095 * Add timing info for filters in `--verbose` mode (#6112).
1096 When verbose mode is specified (verbosity == INFO), print a
1097 notice when running a filter and when a filter completes (including
1098 timing).
1100 * LaTeX reader:
1102 + Allow `&` in LaTeX citation keys (#6110).
1103 + Improve caption and label parsing.
1104 + Don't emit empty Span elements for labels.
1105 + Put tables with labels in a surrounding Div.
1106 + Resolve `\ref` to table numbers (#6137).
1107 + Skip comments in more places where this is needed (#6114).
1108 + Allow beamer overlays for all commands in all raw tex (#6043).
1109 This affects parsing of raw tex in LaTeX and in Markdown and
1110 other formats.
1111 + Improve parsing of raw environments (#6034). If parsing fails
1112 in a raw environment (e.g. due to special characters like unescaped
1113 `_`), try again as a verbatim environment, which is less sensitive to
1114 special characters. This allows us to capture special environments
1115 that change catcodes as raw tex when `-f latex+raw_tex` is used.
1117 * RST reader:
1119 + Add highlight directive (#6140, Lucas Escot).
1121 * MediaWiki writer:
1123 + Prevent triple `[[[` which confuses MediaWiki (#6119).
1125 * HTML reader:
1127 + Don't parse `data-id` as `id` attribute. And similarly don't
1128 parse any `data-X` as `X` when `X` is a valid HTML attribute.
1130 * Org reader:
1132 + Simplify parsing of sub- and superscripts (#6127, Albert Krewinkel).
1133 Speeds up parsing of single-word, markup-less sub- and superscripts.
1135 * LaTeX writer:
1137 + Group biblatex citations even with prefix and suffix (#5849, Ethan
1138 Riley). Previously biblatex citations were only grouped if there
1139 was no prefix. This patch allows them to be grouped in subgroups split
1140 by prefixes and suffixes, which allows better citation sorting.
1141 + Fix regression in handling of columns in beamer slides (#6033).
1142 Columns in title slides were causing problems with
1143 slide division.
1144 + Fix duplicate frame classes in LaTeX/Beamer output (#6107).
1146 * HTML writer:
1148 + Fix duplicate attributes on headings (#6062), regression from 2.7.x.
1149 + Fix `--number-offset` with HTML TOC. Eventually it would be worth
1150 adding a parameter to `makeSections` so this could be done at that
1151 level; then it would also affect other writers that construct
1152 TOC manually.
1153 + reveal.js: restore old behavior for 2D nesting (#6032).
1154 The fix to #6030 actually changed behavior, so that the
1155 2D nesting occurred at slide level N-1 and N, instead of
1156 at the top-level section. This commit restores the v2.7.3 behavior.
1157 If there are more than 2 levels, the top level is horizontal
1158 and the rest are collapsed to vertical.
1159 + reveal.js: ensure that pauses work even in title slides (#5819).
1161 * Markdown writer:
1163 + Fix regression: spurious dots in markdown_mmd metadata output (#6133).
1165 * Docx writer:
1167 + Fix regression with Compact style on tight lists (#6072).
1168 Starting in 2.8, the docx writer no longer distinguishes between tight
1169 and loose lists, since the Compact style is omitted. This is a
1170 side-effect of the fix to #5670, as explained in the changelog. This
1171 patch fixes the problem by extending the exception currently offered to
1172 Plain blocks inside tables to Plain blocks inside list items.
1174 * Jira writer:
1176 + Fix output of table headers (Albert Krewinkel, #6035).
1178 * Add Text.Pandoc.Image with unexported svgToPng.
1180 * Text.Pandoc.XML: Export `html5Attributes`, `html4Attributes`,
1181 `rdfaAttributes` (formerly unexported in Text.Pandoc.Writers.HTML).
1182 [API change]
1184 * Text.Pandoc.Shared: Export a new function `findM` (#6125,
1185 Joseph C. Sible).
1187 * Text.Pandoc.Logging: Add `RunningFilter`, `FilterCompleted`
1188 constructors to LogMessage [API change].
1190 * Text.Pandoc.CSV: fix bug in CSV parser; previously an extra blank record
1191 would sometimes be inserted at the end.
1193 * LaTeX template: add space option to xeCJK with PassOptionsToPackage
1194 (#6002). Otherwise we can get a clash with documentclasses that
1195 already load the package.
1197 * Lua filters:
1199 + Allow filtering of element lists (#6038, Albert Krewinkel). Lists of
1200 Inline and Block elements can now be filtered via `Inlines` and
1201 `Blocks` functions, respectively. This is helpful if a filter
1202 conversion depends on the order of elements rather than a single
1203 element. For example, the following filter can be used to remove all
1204 spaces before a citation:
1206 function isSpaceBeforeCite (spc, cite)
1207 return spc and spc.t == 'Space'
1208 and cite and cite.t == 'Cite'
1209 end
1211 function Inlines (inlines)
1212 for i = #inlines-1,1,-1 do
1213 if isSpaceBeforeCite(inlines[i], inlines[i+1]) then
1214 inlines:remove(i)
1215 end
1216 end
1217 return inlines
1218 end
1220 + Add methods `insert`, `remove`, and `sort` to pandoc.List
1221 (Albert Krewinkel). Example of use:
1223 local numbers = pandoc.List {2, 3, 1}
1224 numbers:sort() -- numbers is now {1, 2, 3}
1225 + Make `pandoc.List` a callable constructor (Albert Krewinkel).
1226 It is now possible to construct a new List via
1227 `pandoc.List()` instead of `pandoc.List:new()`.
1228 + Add tests for pandoc.List module (Albert Krewinkel).
1230 * Text.Pandoc.App.CommandLineOptions: Change `setVariable` to use `Text`
1231 instead of `String`. This avoids some unnecessary unpacking.
1233 * Use versioned directory for windows release zipfile.
1234 Also remove old `make-windows-installer.bat`, superseded by GitHub
1235 actions workflow, and modify `pandoc.wxs` for new paths.
1237 * Extensive code cleanup (#6141, #6128, #6129, #6130, #6123,
1238 #6105, 6102, #6117, #6124, #6115, #6116, #6111, Joseph C. Sible).
1240 * Fix hlint warnings (Albert Krewinkel).
1242 * Use latest doclayout, doctemplates (#6031). The new version of
1243 doclayout fixes a memory leak that affected `--include-in-header` with
1244 large files (and possibly other cases involving extremely long lines).
1246 * Use latest texmath.
1248 * Use latest skylighting and fix test suite (#6086).
1250 * sample.lua: Fix typo in descriptive comments (#6136, Caleb Maclennan).
1251 Fix typo in error message (#6135).
1253 * Add Docker and GH Actions instructions/links to INSTALL.md.
1255 * Update filter documentation (#6065). Improve cabal v2 instructions.
1256 Remove example using pandoc API directly (we have other
1257 docs for that and it was outdated).
1259 * Lua filter docs:
1261 + Cross-link constructors and types (Albert Krewinkel).
1262 Thanks to @bpj for the idea.
1263 + Sort pandoc.List methods alphabetically (Albert Krewinkel).
1264 + Unify, fix anchors and internal links (#6061, Albert Krewinkel).
1265 Links and anchors now follow consistent conventions, like
1266 lowercase-only anchor names. This breaks some links to specific
1267 sections in the document, but will make it much easier to link
1268 documentation in the future.
1269 + Clarify filter function execution order (#6059, Albert Krewinkel).
1271 * In docs, update URLs and use `https:` wherever possible (#6090,
1272 Salim B).
1274## pandoc 2.9.1.1 (2020-01-05)
1276 * Markdown reader:
1278 + Fix parsing bug affected indented code after raw HTML (#6009, #5360).
1280 * LaTeX writer:
1282 + Fix regression in beamer slide structure with certain slide levels
1283 (#6030).
1284 + Allow framebreaks for beamer's TOC (Heiko Schlittermann, #6012)
1285 + Properly handle unnumbered headings level 4+ (#6018).
1286 Previously the `\paragraph` command was used instead of
1287 `\paragraph*` for unnumbered level 4 headings.
1289 * HTML writer:
1291 + Fix revealjs slide structure regression with certain slide levels
1292 (#6030).
1293 + Add newlines to make slide show output more readable.
1295 * Org writer:
1297 + Remove extra spaces from table cells (Albert Krewinkel, #6024).
1299 * JATS template: Update JATS dtd (Arfon Smith, #6020). Use the archiving
1300 and interchange DTD rather than the more restrictive journal publishing
1301 DTD (which doesn't permit ext-link as a valid child).
1303 * Text.Pandoc.PDF: Fix `runTeXProgram` so that the input source is always
1304 overwritten (#6027). Previously it wasn't overridden if the file already
1305 existed, which led to bad results on subsequent runs when
1306 `pdf-engine-opt=-output-directory=` was used to specify an explicit temp
1307 dir.
1309 * Text.Pandoc.BCP47: Change `getLang` to handle block-level contents
1310 (#6008). Some readers (e.g. RST) will populate the `lang` metadata field
1311 with block-level content. `getLang` has been modified to handle this.
1312 Previously in these cases the LaTeX writer would not properly set the
1313 "main language" of the document.
1315 * Fix `test/tables.org` (Albert Krewinkel).
1317 * Use HTTPS in copyright message (Felix Yan, #6010)
1320## pandoc 2.9.1 (2019-12-23)
1322 * Add Jira reader (Albert Krewinkel, #5556).
1324 * Jira writer: use jira-wiki-markup renderer (Albert Krewinkel,
1325 #5926). The following improvements are included in this change:
1327 + non-jira raw blocks are fully discarded instead of showing
1328 as blank lines;
1329 + table cells can contain multiple blocks;
1330 + unnecessary blank lines are removed from the output;
1331 + markup chars within words are properly surrounded by
1332 braces;
1333 + preserving soft linebreaks via `--wrap=preserve` is
1334 supported.
1336 Note that backslashes are rendered as HTML entities, as there
1337 appears no alternative to produce a plain backslash if it is
1338 followed by markup. This may cause problems when used with
1339 confluence, where rendering seems to fail in this case.
1341 * Fix regression with `--number-sections`. Starting with 2.8,
1342 `--number-sections` also had the effect of `--section-divs`,
1343 even if `--section-divs` was not specified.
1345 * Improved table of contents generation in markdown, RTF,
1346 commonmark, better handling cases where section headings are
1347 enclosed in divs.
1349 * Ensure that later default file values for `variable` replace
1350 earlier ones (5988).
1352 * HTML reader: Add `nav` to list of block-level tags.
1354 * Org reader (Albert Krewinkel):
1356 + Wrap named table in Div, using name as id (#5984).
1357 Tables which are given a name via `#+NAME:` or `#+LABEL:`
1358 are wrapped in an additional Div, with the name set as the
1359 Div's ID.
1360 + Report parsing errors properly.
1361 + Fix parsing problem for colons in headline (#5993).
1363 * Text.Pandoc.PDF: Ensure UTF8 when printing source in
1364 `--verbose` mode, avoiding an error on platforms that
1365 default to something other than UTF-8 (#5997).
1367 * Text.Pandoc.Templates: Strip directory before trying to find
1368 partial in data files (#5987).
1370 * Text.Pandoc.Shared: Improve `makeSections` so we don't get
1371 doubled "number" attributes in EPUB output (or anywhere
1372 else) (#5986).
1374 * Added tests for `--toc` and `--section-divs`.
1376 * Text.Pandoc.MIME: Added glsl MIME type for WebGL maps (#6000,
1377 Jared Lander).
1379 * MANUAL: A bit clearer explanation for `--base-header-level`.
1380 We now say exactly how to translate between the deprecated
1381 `--base-header-level` and `--shift-heading-level-by`.
1383 * lua-filters.md:
1385 + Remove spurious dot in title (#5996, Mauro Bieg).
1386 + Replace metadata example with image centering (#6004,
1387 Albert Krewinkel). Thanks to @efx for proposing this filter.
1390## pandoc 2.9 (2019-12-11)
1392 * Text.Pandoc.Templates [API change]
1394 + Add Monad wrappers `WithDefaultPartials` and `WithPartials`.
1395 Wrapping these around an instance of `PandocMonad` gives
1396 us different instances of `TemplateMonad`, with different
1397 search behavior in retrieving partials.
1398 To compile a template and limit partial search to pandoc's
1399 data files, use `runWithDefaultPartials (compileTemplate ...)`.
1400 To compile a template and allow partials to be found locally
1401 (either on the file system or via HTTP, in the event that
1402 the main template has an absolute URL), ue
1403 `runWithPartials (compileTemplate ...)`.
1404 + Export `getTemplate`, which seeks a template locally,
1405 or via HTTP if the template has an absolute URL, falling
1406 back to the data files if not found.
1407 + Export `compileDefaultTemplate` -- does `getDefaultTemplate`
1408 and compiles the result, raising an error on failure.
1410 * Text.Pandoc.Class [API change]
1412 + Remove `TemplateMonad` instances for `PandocIO` and `PandocPure`.
1413 These were too limiting and caused a bug whereby a local
1414 partial could be used even when the default template was requested.
1415 We now rely on instances provided in the Templates module.
1417 * Text.Pandoc.App.OutputSettings: Simplify template retrieval code.
1419 * ConTeXt template: Adjust to title formatting (#5949, Denis Maier).
1420 Add `\setupinterlinespace` to `title`, `subtitle`, `date` and `author`
1421 elements: otherwise longer titles that run over multiple lines will look
1422 squashed as `\tfd` etc. won't adapt the line spacing to the font size.
1424 * reveal.js template: Add title-slide-attributes variable (#5981,
1425 Frederik Elwert).
1427 * More informative JSON parse error (#5973).
1429 * Use external emojis package (forked from pandoc). Removed emoji data
1430 in Text.Pandoc.Emoji.
1432 * Fix regression in `makeSections` (#5965).
1433 Previously `hierarchicalize` (the ancestor of `makeSections`) would put
1434 header attributes on the containing Div. In 2.8 this behavior changed,
1435 which broke some tools depending on pandoc. Here we roll back this change,
1436 so that attributes again migrate from the header to the containing Div when
1437 `makeSections` is run. Note that attributes are retained on the header as
1438 well (unlike before) -- with the exception of the `id` attribute, which of
1439 course cannot be duplicated.
1441 * Fix `--toc-depth` regression in 2.8 (#5967).
1443 * Use doctemplates 0.8. Rename template 'filters' as 'pipes'
1444 to avoid confusion with the other notion of filter used by pandoc.
1446 * Fix README.md so that relative links from manual become absolute.
1447 Previously they'd be broken links when viewed on GitHub or Hackage.
1448 So we add the base URL for the pandoc manual.
1450 * Document display math syntax in manual.
1452## pandoc 2.8.1 (2019-12-05)
1454 * Add `ascii_identifiers` as a supported extension for `markdown`.
1455 This fixes a regression in 2.8.
1457 * Fix regression with behavior of `--variable` (#5962).
1458 Previously `-Vfoo=1 -Vfoo=2` would produce a list value for foo;
1459 with 2.8 it produced just `2`. This commit restores the earlier
1460 behavior.
1462 * Roll back part of of `--shift-heading-level-by` change (#5957).
1463 With positive heading shifts, starting in 2.8 this option
1464 caused metadata titles to be removed and changed to regular
1465 headings. This behavior is incompatible with the old
1466 behavior of `--base-header-level` and breaks old workflows,
1467 so we have rolled back the change. Note that there is now an
1468 asymmetry in positive and negative heading level shifts:
1469 With positive shifts, the metadata title stays the same and
1470 does not get changed to a heading in the body, while with
1471 negative shifts, a heading can be converted into the
1472 metadata title.
1474 * Text.Pandoc.Shared: Fix `makeSections` so it doesn't turn
1475 column Divs into sections.
1477 * HTML writer: add task-list class to ul if all elements are
1478 task list items. This will allow styling unordered task
1479 lists in a way that omits the bullet.
1481 * HTML-based templates: Add CSS to suppress bullet on unordered task lists.
1483 * ConTeXt template: Fix `\startcslreferences` and use ConTeXt syntax
1484 conventions (#5945, Denis Maier). The old version had a too large
1485 a skip at the beginning of the reference list.
1487 * LaTeX template: keep the `\author{}` command even if author is not
1488 specified (#5961, Yihui Xie). Avoids a LaTeX warning.
1490 * Generate Emoji module with TH.
1492 + Add Text.Pandoc.Emoji.TH.
1493 + Replace long literal list in Text.Pandoc.Emoji with one-liner
1494 generating it from `emoji.json` using TH.
1495 + Add Makefile target to download `emoji.json`.
1496 + Remove `tools/emoji.hs`.
1498 * Increase GC allocation space for compilation in cabal.project.
1500 * Clean up manual on PDF generation backend options (#5940).
1502 * Update release checklist to include code signing step and update
1503 Windows release-candidate builds (#5950).
1506## pandoc 2.8.0.1 (2019-11-26)
1508 * List `pdf` in `--list-output-formats`.
1509 * EPUB writer: Fix regression with `--css` (#5937). In 2.8 `--css`
1510 would not have an effect on EPUB output.
1511 * RST writer: Use grid tables for one-column tables, since
1512 simple tables clash with heading syntax in this case (#5936).
1513 * Add unexported module Text.Pandoc.Readers.Metadata (see #5914).
1514 * Use doctemplates 0.7.2, which adds the `nowrap` filter to
1515 templates.
1516 * Update default man template using `nowrap` for .TH heading (#5929).
1517 * HTML templates: Add support for `toc-title` variable (#5930,
1518 Alexandre Franke).
1519 * Remove `grffile` (LaTeX package) requirement in MANUAL.txt
1520 (#5927, Ian Max Andolina).
1521 * Use skylighting 0.8.3.
1523## pandoc 2.8 (2019-11-22)
1525 * Improvements in templates system (from doctemplates):
1527 + Pandoc templates now support a number of new features that
1528 have been added in doctemplates: notably, `elseif`, `it`,
1529 partials, filters, and syntax to control nesting and reflowing of
1530 text. These changes make pandoc more suitable out of the
1531 box for generating plain-text documents from data in YAML
1532 metadata. It can create enumerated lists and even tabular
1533 structures.
1534 + We now used templates parameterized on doclayout Doc types.
1535 The main impact of this change is better reflowing of
1536 content interpolated into templates. Previously,
1537 interpolated variables were rendered independently and
1538 intepolated as strings, which could lead to overly long
1539 lines. Now the templates interpolated as Doc values which
1540 may include breaking spaces, and reflowing occurs after
1541 template interpolation rather than before.
1542 + Remove code from the LaTeX, Docbook, and JATS writers that
1543 looked in the template for strings to determine whether it
1544 is a book or an article, or whether csquotes is used. This
1545 was always kludgy and unreliable.
1546 + Change template code to use new API for doctemplates.
1548 * Add `--defaults`/`-d` option. This adds the ability to specify
1549 a collection of default values for options in a YAML file. For
1550 example, one might define a set of defaults for letters,
1551 and then do `pandoc -d letter myletter.md -o myletter.pdf`.
1552 See the documentation of this feature in MANUAL.txt.
1554 * Raise error on unsupported extensions (#4338).
1556 * The `--list-extensions[=FORMAT]` option now lists only
1557 extensions that affect the given FORMAT.
1559 * Add `-L` option as shortcut for `--lua-filter`.
1561 * Add `--shift-heading-level-by` option and deprecate
1562 `--base-heading-level` (#5615). The new option does
1563 everything the old one does, but also allows negative shifts.
1564 It also promotes the document metadata (if not null) to a
1565 level-1 heading with a +1 shift, and demotes an initial
1566 level-1 heading to document metadata with a -1 shift. This
1567 supports converting documents that use an initial level-1
1568 heading for the document title.
1570 * Allow `--metadata-file` to be used repeatedly to include
1571 multiple metadata files (Owen McGrath, #5702). Values in
1572 files specified first will be overridden by those in later
1573 files.
1575 * `--ascii` now uses numerical hex character references (#5718).
1577 * Allow PDF output to stdout (#5751). PDF output now behaves like other
1578 binary formats: it will not be output to the terminal, but can be
1579 sent to stdout using either `-o -` or a pipe. The intermediate format
1580 will be determined based on the setting of `--pdf-engine`.
1582 * Make some writers sensitive to 'unlisted' class on headings (#1762).
1583 If this is present on a heading with the 'unnumbered' class,
1584 the heading won't appear in the TOC. This class has no
1585 effect if 'unnumbered' is not also specified. This affects HTML-based
1586 writers (including slide shows and EPUB), LateX (including beamer), RTF,
1587 and PowerPoint. Other writers do not yet support `unlisted`.
1589 * Fix `gfm_auto_identifiers` behavior with emojis (#5813). Note that
1590 we also now use emoji names for emojis when `ascii_identifiers`
1591 is enabled.
1593 * When `--ipynb-output` is used with the default "best" format, strip
1594 ANSI escape codes for non-ipynb output (#5633). These cause problems
1595 in many formats, including LaTeX.
1597 * Don't look for template files remotely for remote input (#5579).
1598 Previously pandoc would look for the template at a remote URL when a
1599 URL was used for the input file, instead of taking it from the
1600 data directory.
1602 * Allow combining `-Vheader-includes` and `--include-in-header` (#5904).
1603 Previously `header-includes` set as a variable would be
1604 clobbered by material included using `--include-in-header`.
1606 * Change merge behavior for metadata. Previously, if a document
1607 contained two YAML metadata blocks that set the same field, the
1608 conflict would be resolved in favor of the first. Now it is resolved
1609 in favor of the second (due to a change in pandoc-types).
1610 This makes the behavior more uniform with other things in pandoc
1611 (such as reference links and `--metadata-file`).
1613 * Don't add a newline to fragment output if there's already one.
1615 * Change exit codes and document in MANUAL.txt:
1617 + `PandocAppError` was 1, is now 4
1618 + `PandocOptionError` was 2, is now 6
1619 + `PandocMakePDFError` was 65, is now 66
1621 * Switch to new pandoc-types and use Text instead of String [API change].
1622 (Christian Despres, #5884).
1624 * HTML reader:
1626 + Better handling of `<q>` with cite attribute (#5798, Ole Martin Ruud).
1627 If a `<q>` tag has a `cite` attribute, we interpret it as a Quoted
1628 element with an inner Span.
1629 + Add support for HTML `<samp>` element (#5792, Amogh Rathore).
1630 The `<samp>` element is parsed as Code with class `sample`.
1631 + Add support for HTML `<var>` element (#5799, Amogh Rathore).
1632 The `<var>` element is parsed as Code with class `variable`.
1633 + Add support for `<mark>` elements (Florian B, #5797). Parse
1634 `<mark>` elements from HTML as Spans with class `mark`.
1635 + Add support for `<kbd>` elements, parsing them as Span with class
1636 `kbd` (Daniele D'Orazio, #5796).
1637 + Add support for `<dfn>`, parsing this as a Span with class `dfn`
1638 (#5882, Florian Beeres).
1640 * Markdown reader:
1642 + Headers: don't parse content over newline boundary (#5714).
1643 + Handle inline code more eagerly within lists (Brian Leung, #5627).
1644 + Removed some needless lookaheads.
1645 + Don't parse footnote body unless extension enabled.
1646 + Fix small super/subscript issue (#5878). Superscripts and subscripts
1647 cannot contain spaces, but newlines were previously allowed
1648 (unintentionally). This led to bad interactions in some cases
1649 with footnotes. With this change newlines are also not allowed inside
1650 super/subscripts.
1651 + Use `take1WhileP` for `str`, table row. This yields a small but
1652 measurable performance improvement.
1655 * LaTeX reader:
1657 + Fix parsing of optional arguments that contain braced text (#5740).
1658 + Don't try to parse includes if `raw_tex` is set (#5673).
1659 When the `raw_tex` extension is set, we just carry through
1660 `\usepackage`, `\input`, etc. verbatim as raw LaTeX.
1661 + Properly handle optional arguments for macros (#5682).
1662 + Fix `\\` in `\parbox` inside a table cell (#5711).
1663 + Improve `withRaw` so it can handle cases where the token string is
1664 modified by a parser (e.g. accent when it only takes part of a Word
1665 token) (#5686). This fixes a bug that caused the ends of
1666 certain documents to be dropped.
1667 + Handle `\passthrough` macro used by latex writer (#5659).
1668 + Support tex `\tt` command (#5654).
1669 + Search for image with list of extensions like latex does, if an
1670 extension is not provided (#4933).
1671 + Handle `\looseness` command values better (#4439).
1672 + Add `mbox` and `hbox` handling (Vasily Alferov, #5586).
1673 When `+raw_tex` is enabled, these are passed through literally.
1674 Otherwise, they are handled in a way that emulates LaTeX's behavior.
1675 + Properly handle `\providecommand` and `\provideenvironment` (#5635).
1676 They are now ignored if the corresponding command or environment
1677 is already defined.
1678 + Support epigraph command in LaTeX Reader (oquechy, #3523).
1679 + Ensure that expanded macros in raw LaTeX end with a space
1680 if the original did (#4442).
1681 + Treat `ly` environment from lilypond as verbatim (Urs Liska, #5671).
1682 + Add `tikzcd` to list of special environments (Eigil Rischel).
1683 This allows it to be processed by filters, in the same way that
1684 one can do for `tikzpicture`.
1686 * Roff reader:
1688 + Better support for `while`.
1689 + More improvements in parsing conditionals.
1690 + Fix problem parsing comments before macro.
1691 + Improve handling of groups.
1692 + Better parsing of groups (#5410). We now allow groups
1693 where the closing `\\}` isn't at the beginning of a line.
1695 * RST reader:
1697 + Keep `name` property in `imgAttr` (Brian Leung, #5619).
1698 + Fixed parsing of indented blocks (#5753). We were requiring
1699 consistent indentation, but this isn't required by RST.
1700 + Use title, not admonition-title, for admonition title.
1701 This puts RST reader into alignment with docbook reader.
1702 + Don't strip final underscore from absolute URI (#5763).
1703 + Avoid spurious warning when resolving links to internal anchors
1704 ending with `_` (#5763).
1706 * Org reader:
1708 + Accept `ATTR_LATEX` in block attributes (Albert Krewinkel, #5648).
1709 Attributes for LaTeX output are accepted as valid block attributes;
1710 however, their values are ignored.
1711 + Modify handling of example blocks (Brian Leung, #5717).
1712 + Allow the `-i` switch to ignore leading spaces (Brian Leung).
1713 + Handle awkwardly-aligned code blocks within lists (Brian Leung).
1714 Code blocks in Org lists must have their `#+BEGIN_` aligned in a
1715 reasonable way, but their other components can be
1716 positioned otherwise.
1717 + Fix parsing of empty comment lines (#5856, Albert Krewinkel).
1718 Comment lines in Org-mode can be completely empty.
1720 * Muse reader (Alexander Krotov):
1722 + Add RTL support (#5551).
1723 + Do not allow closing asterisks to be followed by `*`.
1724 + Do not split series of asterisks into symbols and emphasis (#5821).
1725 + Do not terminate emphasis on `*` not followed by space.
1727 * DokuWiki reader:
1729 + Parse markup inside monospace ('') (#5916, Alexander Krotov).
1731 * Docx reader:
1733 + Move style-parsing-specific code to a new unexported module,
1734 Text.Pandoc.Readers.Docx.Parse.Styles (Nikolay Yakimov).
1735 + Move StyleMap to docx writer (Nikolay Yakimov).
1736 + Only use LTR when it is overriding BiDi setting (#5723, Jesse
1737 Rosenthal). The left-to-right direction setting in docx is used
1738 in the spec only for overriding an explicit right-to-left setting.
1739 We only process it when it happens in a paragraph set with BiDi.
1740 This is especially important for docs exported from Google Docs,
1741 which explicitly (and unnecessarily) set `rtl=0` for every paragraph.
1742 + Fix list number resumption for sublists (#4324).
1743 The first list item of a sublist should not resume numbering
1744 from the number of the last sublist item of the same level,
1745 if that sublist was a sublist of a different list item.
1747 * Docbook reader:
1749 + Richer parse for admonitions (Michael Peyton Jones, #1234).
1750 Instead of parsing admonitions as blockquotes, we now parse
1751 them as Divs with an appropriate class. We also handle titles
1752 for admonitions as a nested Div with the "title" class.
1753 + Fix nesting of chapters and sections (#5864, Florian Klink,
1754 Félix Baylac-Jacqué).
1755 + Fix bug with entities in mathphrase element (#5885).
1757 * MediaWiki reader:
1759 + Skip optional `{{table}}` template (#5757).
1761 * LaTeX reader:
1763 + Fix dollar-math parsing to ensure that space is left between a
1764 control sequence and a following letter (#5836).
1765 + In `untokenize`, ensure space between control sequence
1766 and following letter (#5836).
1767 + Don't omit macro definitions defined in the preamble.
1768 These were formerly omitted (though they still affected macro
1769 resolution if `latex_macros` was set). Now they are included in
1770 the document body.
1771 + Parse macro definitions as raw LaTeX when `latex_macros` is
1772 disabled. (When `latex_macros` is enabled, we omit them, since
1773 pandoc is applying the macros itself.)
1774 + Fix a hang/memory leak in certain circumstances (#5845).
1775 + Text.Pandoc.Readers.LaTeX.Parsing: add `[Tok]` parameter to
1776 `rawLaTeXParser`. This allows us to repeat retokenizing
1777 unnecessarily in e.g. `rawLaTeXBlock`.
1778 + Add KOMA-Script metadata commands (#5910, Andrew Dunning).
1779 Add all titling commands to existing definition for `\dedication`.
1780 + Parse `\micro` siunitx unit command (#5921, Jose Luis Duran).
1782 * Markdown writer:
1784 + Ensure proper nesting when we have long ordered list markers (#5705).
1785 + Make `plain` output plainer (#5741). Previously we used the following
1786 Project Gutenberg conventions for plain output: extra space before and
1787 after level 1 and 2 headings, all-caps for strong emphasis,
1788 underscores surrounding regular emphasis. Now these
1789 conventions are used only when the `gutenberg` extension is
1790 enabled. By default, Strong and Emph are rendered without
1791 special formatting, and headings are rendered without
1792 special formatting, and with only one blank line following.
1793 To restore the former behavior, use `-t plain+gutenberg`.
1794 + Prefer using raw_attribute when enabled (#4311).
1795 The `raw_attribute` will be used to mark raw bits, even HTML
1796 and LaTeX, and even when `raw_html` and `raw_tex` are
1797 enabled, as they are by default. To get the old behavior,
1798 disable `raw_attribute` in the writer.
1799 + Prefer `pipe_tables` to raw HTML even when we must
1800 lose width information (#2608, #4497).
1801 + Improve escaping in list items (#5918).
1803 * AsciiDoc writer:
1805 + Don't include `+` in code blocks for regular asciidoc.
1806 This is asciidoctor-specific.
1807 + Handle admonitions (#5690).
1809 * LaTeX writer:
1811 + Add thin space when needed in LaTeX quote ligatures (#5684).
1812 + Use `\hspace{0pt}` for 0-width space U+200B (#5756).
1813 + Use `cslreferences` environment for csl bibliographies.
1814 This allows bibliographies to receive special formatting.
1815 The template now contains definition of this environment (enabled
1816 only when CSL is used). It also defines a `\cslhangindent` length.
1817 This is set to 2em by default when the bibliography style specifies
1818 a hanging indent. To override the length, you can use e.g.
1819 `\setlength{\cslhangindent}{7em}` in header-includes.
1820 See jgm/pandoc-citeproc#410.
1821 + Strip off `{}` around locator for biblatex/natbib output (#5722).
1822 + Fix line breaks at start of paragraph (#3324).
1823 Previously we just omitted these. Now we render them
1824 using `\hfill\break` instead of `\\`. This is a revision
1825 of a PR by @sabine (#5591) who should be credited with the idea.
1826 + We no longer look in the template or header-includes to see if a
1827 book or article documentclass is used, or to see whether the
1828 `csquotes` package is used. To use `csquotes` for LaTeX, set
1829 `csquotes` in your variables or metadata. To specify a book
1830 style, use the `documentclass` variable or
1831 `--top-level-division`.
1832 + Fix horizontal rule (#5801). We change to use 0.5pt rather than
1833 `\linethickness`, which apparently only ever worked "by accident"
1834 and no longer works with recent updates to texlive.
1836 * ConTeXt writer:
1838 + Add option to include source files in ConTeXt PDFs (Tristan
1839 Stenner, #5578). The metadata field or variable
1840 (`includesource`) can be set to attach the source documents
1841 to the resulting PDF.
1842 + Customizable type of PDF/A for the ConTeXt writer (Karl
1843 Pettersson, #5608). The `pdfa` variable may now be set in metadata.
1844 Also updated color profile settings in accordance with ConTeXt wiki,
1845 and made ICC profile and output intent for PDF/A customizable
1846 using `pdfaiccprofile` and `pdfaintent`.
1847 + Unit tests: adjust code property to avoid an irrelevant
1848 failure involving inline code with two consecutive newlines.
1849 + Set `csl-hanging-indent` variable if needed.
1850 + Use special environment for CSL references.
1851 + Use braces, not start/stop, for inline language tags.
1852 This prevents unwanted gobbling of spaces.
1854 * HTML writer:
1856 + Use numeric character references with `--ascii` (#5718).
1857 Previously we used named character references with html5 output.
1858 But these aren't valid XML, and we aim to produce html5 that is
1859 also valid XHTML (polyglot markup). (This is also needed for epub3.)
1860 + Ensure that line numbers in code blocks get id-prefix (#5650).
1861 + Ensure TeX formulas are rendered correctly (Philip Pesca,
1862 #5658). The web service passed in to `--webtex` may render
1863 formulas using inline or display style by default.
1864 Prefixing formulas with the appropriate command ensures
1865 they are rendered correctly.
1866 + Render inline formulas correctly with `--webtex` (Philip
1867 Pesca, #5655). We add `\textstyle` to the beginning of the
1868 formula to ensure it will be rendered in inline style.
1869 + Pass through `aria-` attributes to HTML5 (#5642).
1870 + Render a Quoted element with an inner Span with
1871 `cite` attribute using a `<q>` tag (#5798, Ole Martin Ruud).
1872 + Render a Span with class `mark` using the `<mark>` element
1873 (Florian Beeres, #5797).
1874 + Render Span with class `dfn` using `<dfn>` element
1875 (Florian Beeres, #5882).
1876 + Render Span with class `kbd` using `<kbd>` element (Daniele
1877 D'Orazio, #5796).
1878 + Render Code with class `variable` using `<var>` element
1879 (Amogh Rathore, #5799).
1880 + Render Code with class `sample` using `<samp>` element
1881 (Amogh Rathore, #5799).
1883 * EPUB writer:
1885 + Improve splitting into chapters (#5761), using `makeSection`.
1886 + Avoid issuing warning multiple times when title not set (see #5760).
1887 + Use svg tag wrapper for cover image (#5638). In addition, the
1888 code generating the image has been moved to the template, to make it
1889 more customizable. NOTE: Those who use custom EPUB
1890 templates will need to adjust their templates, adding the
1891 code to generate the cover image. (Previously this was just
1892 inserted into 'body'.)
1893 + Improve toChapters, making it work better if there are Divs
1894 around sections.
1895 + Add support for EPUB2 covers (blmage, #3992).
1896 + Do not override existing "fileN" medias when writing to EPUB format
1897 (blmage, #4206).
1898 + Ensure that `lang` variable is set on all chapters (so that it
1899 will add an `xml:lang` attribute on the `html` element).
1901 * RST writer:
1903 + Removed remnants of `admonition-title`.
1904 + Fix handling of `:align:` on figures and images (#4420).
1905 When the image has the `align-right` (etc.) class, we now use
1906 an `:align:` attribute.
1907 + Improve spacing for tables with no width information (#5899).
1908 If a simple table would be too wide, we use a grid table.
1909 + Fix backslash escaping after strings (Albert Krewinkel, #5906).
1910 The check whether a complex inline element following a string must
1911 be escaped, now depends on the last character of the string instead
1912 of the first.
1913 + Ensure there's a blank line before tables (#5898).
1915 * Dokuwiki writer:
1917 + Handle mixed lists without HTML fallback (#5107).
1919 * XWiki writer:
1921 + Fix multiline table (Zihang Chen, #5683).
1923 * Muse writer:
1925 + Add RTL support (Alexander Krotov, #5551).
1927 * Man writer:
1929 + Suppress non-absolute link URLs (#5770). Absolute URLs are
1930 still printed in parentheses following the link text, but relative
1931 URLs are suppressed (just as internal links starting with '#'
1932 always have been).
1933 + Improved definition list term output. Now we boldface code but
1934 not other things. This matches the most common style in man pages
1935 (particularly option lists).
1937 * Ms writer:
1939 + Use `.LP` instead of `.PP` for line block (#5588).
1940 + Use boldface for definition terms in DefinitionLists.
1942 * JATS writer:
1944 + Do not emit empty `<fn-group>` (Mauro Bieg, #5595).
1945 + Update template to v1.1dtd (#5632, Arfon Smith).
1946 + Update `data/jats.csl` to avoid commas between editor
1947 name-part elements. (#5629)
1948 + Add `abstract` to template (Mauro Bieg).
1950 * TEI writer:
1952 + Don't strip hash from internal links (#5922).
1954 * Jira writer:
1956 + Remove escapeStringForJira for code blocks (Jan-Otto Kröpke).
1957 + Remove extraneous newline after single-line block quotes
1958 (#5858, Albert Krewinkel).
1959 + Improve escaping of special characters, using backslash escapes
1960 instead of HTML entities (#5858, Albert Krewinkel).
1962 * OpenDocument writer:
1964 + Avoid duplicate attributes (#4634). We use the innermost
1965 attribute in nested cases.
1966 + If `native_numbering` extension is set, use native OpenDocument
1967 enumeration for figures and tables (Nils Carlson).
1968 + Place caption before table (#5681, Dmitry Pogodin).
1970 * ODT writer:
1972 + Add a test for MathML formulas in ODT documents (blmage).
1973 + Improve the parsing of frames in ODT documents (blmage).
1975 * Docx writer:
1977 + Make handling of styles more robust in localized versions
1978 of Word (Nikolay Yakimov, #5523, #5052, #5074). We now use
1979 style names, not ids, for assigning semantic meaning, since
1980 the ids can change depending on the locale. Style name
1981 comparisons are case-insensitive, since those are
1982 case-insensitive in Word. Since docx style names can have
1983 spaces in them, and pandoc-markdown classes can't, anywhere
1984 when style name is used as a class name, spaces are
1985 replaced with ASCII dashes `-`. Code styles, i.e. "Source
1986 Code" and "Verbatim Char" now honor style inheritance. Docx
1987 Reader now honours "Compact" style (used in
1988 Pandoc-generated docx). The side-effect is that "Compact"
1989 style no longer shows up in docx+styles output. Styles
1990 inherited from "Compact" will still show up.
1991 + Re-use Readers.Docx.Parse for StyleMap (#5766, Nikolay Yakimov).
1992 + Internal improvements and code simplification (Nikolay Yakimov).
1993 + Preserve built-in styles in DOCX with custom style (Ben Steinberg,
1994 #5670). This change prevents custom styles on divs and spans
1995 from overriding styles on certain elements inside them, like
1996 headings, blockquotes, and links. On those elements, the
1997 "native" style is required for the element to display correctly.
1998 This change also allows nesting of custom styles; in order to do so,
1999 it removes the default "Compact" style applied to Plain blocks,
2000 except when inside a table.
2001 + Add `proofState` to list of elements carried over from
2002 settings.xml in the reference.docx (Krystof Beuermann, #5703).
2003 + Change order of `ilvl` and `numId` in `document.xml` (Agustín
2004 Martín Barbero, #5645). Also, make list para properties go first.
2005 This reordering of properties shouldn't be necessary but
2006 it seems Word Online does not understand the docx correctly otherwise.
2008 * PowerPoint writer:
2010 + Code formatting is now context dependent (Jeroen de Haas, #5573).
2011 This commit alters the way in which the Powerpoint writer treats
2012 inline code and code blocks. Inline code is now formatted at
2013 the same size as the surrounding text. Code blocks are now given
2014 a margin and font size according to their level.
2015 Furthermore this commit allows changing the font with which code is
2016 formatted via the `monofont` option.
2017 + Start numbering at appopriate numbers (Jesse Rosenthal, #5709).
2018 Starting numbers for ordered lists were previously ignored. Now
2019 we specify the number if it is something other than 1.
2021 * Text.Pandoc.Parsing:
2023 + Add `manyChar`, `many1Char`, `manyTillChar`, `many1TillChar`,
2024 `many1Till`, `manyUntil`, `mantyUntilChar`: these are like their
2025 unsuffixed counterparts but pack some or all of their output
2026 (Christian Despres, #5884).
2027 + Add `stateAllowLineBreaks` to `ParserState` [API change].
2028 + Fix inline parsing in grid table cells (#5708).
2029 + Change type of `setLastStrPos` so it takes a `Maybe SourcePos`
2030 rather than a `SourcePos` [API change].
2031 + Make `parseFromString'` and `gridTableWith` and
2032 `gridTableWith'` polymorphic in the parser state,
2033 constraining it with `HasLastStrPosition` [API change].
2034 + `parseFromString'`: reset `stateLastStrPos` to `Nothing` before parse.
2035 + Rename takeWhileP -> take1WhileP and clean it up.
2036 (It doesn't match the empty sequence.)
2038 * Text.Pandoc.PDF:
2040 + For PDFs via HTML, ensure temp file is deleted even if the pdf
2041 program is not found (#5720).
2042 + Better detection of a Cygwin environment (#5451).
2043 + Don't assume tex log file is UTF8-encoded (#5872).
2044 Fall back to latin1 if it can't be read as UTF-8.
2046 * Text.Pandoc.Extensions:
2048 + Export new function `getAllExtensions`, which returns the
2049 extensions that affect a given format (whether enabled by default
2050 or not) [API change].
2051 + Change type of `parseFormatSpec` from
2052 `Either ParseError (String, Extensions -> Extensions)`
2053 to `Either ParseError (String, [Extension], [Extension])`
2054 [API change].
2055 + Add `Ext_gutenberg` constructor to `Extension` [API change].
2056 + Add `Ext_native_numbering` constructor to `Extension` [API change]
2057 (Nils Carlson).
2059 * Text.Pandoc.Readers, Text.Pandoc.Writers:
2061 + Change type of `getReader` and `getWriter` so they return
2062 a value in the PandocMonad instance rather than an Either
2063 [API change]. Exceptions for unknown formats and unsupported
2064 extensions are now raised by these functions.
2066 * Text.Pandoc.App
2068 + Change `optMetadataFile` type from `Maybe FilePath` to `[FilePath]`
2069 (Owen McGrath, #5702) [API change].
2071 * Text.Pandoc.Logging:
2073 + Add `CouldNotDeduceFormat` constructor to `LogMessage` [API change].
2074 Issue this warning when we're falling back to markdown or
2075 html because we don't recognize the extension of the input or
2076 output files.
2077 + Clarify warning for missing title (#5760).
2078 + Add `UnusualConversion` constructor to `LogMessage` [API change]
2079 (Mauro Bieg, #5736). Emit warning on `-f latex -o out.pdf`.
2081 * Lua filters:
2083 + Improve function documentation (Albert Krewkinkel).
2084 + Traverse nested blocks and inlines in correct order (Albert
2085 Krewinkel, #5667). Traversal methods are updated to use the new
2086 Walk module so that sequences with nested Inline (or Block) elements
2087 are traversed in the order in which they appear in the linearized
2088 document.
2089 + New unexported module `Text.Pandoc.Lua.Walk` (Albert Krewinkel).
2090 Lua filters must be able to traverse sequences of AST
2091 elements and to replace elements by splicing sequences back
2092 in their place. Special `Walkable` instances can be used for
2093 this; those are provided in a new module
2094 `Text.Pandoc.Lua.Walk`.
2095 + `Attr` values can now be given as normal Lua tables (Albert
2096 Krewinkel, #5744). This can be used as a convenient alternative
2097 to constructing `Attr` values with `pandoc.Attr`. Identifiers
2098 are taken from the `id` field, classes must be given as
2099 space separated words in the `class` field. All remaining fields
2100 are included as attributes. With this change, the following lines
2101 now create equal elements:
2102 ```
2103 pandoc.Span('test', {id = 'test', class = 'a b', check = 1})
2104 pandoc.Span('test', pandoc.Attr('test', {'a','b'}, {check = 1}))
2105 ```
2106 This also works when using the *attr* setter:
2107 ```
2108 local span = pandoc.Span 'text'
2109 span.attr = {id = 'test', class = 'a b', check = 1}
2110 ```
2111 Furthermore, the *attributes* field of AST elements can now be a
2112 plain key-value table even when using the `attributes` accessor:
2113 ```
2114 local span = pandoc.Span 'test'
2115 span.attributes = {check = 1} -- works as expected now
2116 ```
2117 + Export `make_sections`, remove `hierarchicalize`. Lua filters that
2118 use `hierarchicalize` will need to be rewritten to use
2119 `make_sections`.
2120 + Add a `clone()` method to all AST elements (Albert Krewinkel, #5568).
2121 + Fix Lua function names in pandoc.system (niszet). Change
2122 `get_current_directory` to `get_working_directory` and
2123 `with_temp_directory` to `with_temporary_directory`, to
2124 conform to the manual.
2126 * Text.Pandoc.Error:
2128 + Add constructors `PandocUnknownReaderError`,
2129 `PandocUnknownWriterError`, `PandocUnsupportedExtensionError`.
2130 [API change].
2131 + Better message for `PandocShouldNeverHappenError`.
2132 + Better message for `PandocTemplateError`.
2134 * Text.Pandoc.Emoji:
2136 + Update emoji list (#5666). Done using new `tools/emojis.hs`,
2137 which uses the list from the gem GitHub uses. Future updates
2138 can be done with this tool.
2140 * Text.Pandoc.PDF:
2142 + Pass value of `--dpi` to `rsvg-convert` when converting SVG to PDF
2143 in the process of creating a PDF (#5721).
2145 * Text.Pandoc.Shared:
2147 + Replace `Element` and `makeHierarchical` with `makeSections`.
2148 Now that we have Divs, we can use them to represent the
2149 structure of sections, and we don't need a special Element type.
2150 `makeSections` reorganizes a block list, adding Divs with class
2151 `section` around sections, and adding numbering if needed.
2152 This change also fixes some longstanding issues recognizing section
2153 structure when the document contains Divs (#3057, see also #997).
2154 + Remove `Element` type [API change]
2155 + Remove `makeHierarchicalize` [API change]
2156 + Add `makeSections` [API change]
2157 + Export `deLink` [API change]
2158 + Make `filterIpynbOutput` strip ANSI escapes from code in output
2159 for non-ipynb formats, when the default "best" option is used with
2160 `--ipynb-output` (#5633).
2161 + Fix `camelCaseToHyphenated` so it handles `ABCDef` better.
2162 + Improve `isTight` (#5857). If a list has an empty item,
2163 this should not count against its being a tight list.
2164 + Export `htmlSpanLikeElements` [API change] (Daniele D'Orazio, #5796).
2165 This is a mapping of HTML span-like elements that are internally
2166 represented as a Span with a single class.
2167 + Change the implementation of `htmlSpanLikeElements` to retain
2168 classes and attributes (#5882, Florian Beeres).
2170 * Text.Pandoc.Slides: recognize content in Divs when determining
2171 slide level.
2173 * Text.Pandoc.SelfContained:
2175 + Omit content-type on type attribute for `<style>` (#5725).
2176 It doesn't seem to be valid for HTML5, and as a result Chrome
2177 ignores the style element.
2179 * Text.Pandoc.Pretty has been removed [API change].
2180 We now use the new external doclayout module instead.
2182 * Text.Pandoc.Writers.Shared:
2184 + Remove `metaToJSON`, `metaToJSON'` [API change].
2185 + Modify `addVariablesToContext`, `defField`, `setField`, `getField`,
2186 `resetField` to work with Context rather than JSON values. [API change]
2187 + Export new function `endsWithPlain` [API change].
2188 + Change `gridTables` so it does better at keeping the widths of
2189 columns (#4320) and does better at figuring out column widths
2190 when no widths are given (#5899).
2192 * Text.Pandoc.Options
2194 + Change type of `writerTemplate` to `Maybe Template` instead
2195 of `Maybe String`.
2196 + Change To/FromJSON instances for `HTMLMathMethod`, `CiteMethod`,
2197 `ObfuscationMethod`, `TrackChanges`, `WrapOption`,
2198 `TopLevelDivision`, `ReferenceLocation`, `HTMLSlideVariant` (#5790).
2199 In each case we use lowercase (or hyphenated lowercase) for
2200 constructors to line up more closely with command-line option
2201 values. This is a breaking change for those who manually decode or
2202 encode JSON for these data types (e.g. for `ReaderOptions` or
2203 `WriterOptions`).
2205 * Text.Pandoc.Filters:
2207 + Add `FromYAML` instance for `Filter`.
2208 + `applyFilters`: Add and apply filters in order (not reversed)
2209 This changes `applyFilters` from Text.Pandoc.Filter so
2210 that it does a left fold rather than a right fold, applying
2211 the filters in the order listed.
2213 * Text.Pandoc.XML:
2215 + Change `toEntities` to emit numerical hex character references
2216 (#5718).
2218 * Text.Pandoc.Highlighting:
2220 + Add additional listings languages (Wandmalfarbe).
2222 * Text.Pandoc.MediaBag:
2224 + Some of the types using Strings were switched to use FilePath instead
2225 (Christian Despres, #5884).
2227 * Text.Pandoc.Templates:
2229 + Don't import/export `varListToJSON` [API change]. It is removed in
2230 doctemplates >= 0.3.
2231 + Change type of `renderTemplate'` [API change]. Return value is
2232 now Text rather than being polymorphic. This makes room for
2233 upcoming removal of the `TemplateTarget` class from doctemplates.
2235 * Text.Pandoc.App.Opt [API changes]:
2237 + More convenient To/FromJSON instances. Make the field names
2238 like `strip-empty-paragraphs` rather than `optStripEmptyParagraphs`.
2239 Anyone who is using JSON serialization of Opt will need to adjust
2240 things accordingly.
2241 + Change `optHighlightStyle` to a `Maybe String` instead of
2242 `Maybe Style`. Do the parsing/loading of themes later, after
2243 option parsing.
2244 + Remove `optBaseHeaderLevel` from `Opt`. We now just use
2245 `optShiftHeadingLevelBy`, to avoid redundancy.
2246 + Change `optShiftHeadingLevel` to `optShiftHeadingLevelBy` to
2247 match the option.
2248 + Custom FromJSON instance for `LineEnding`, so either `CRLF`
2249 or `crlf` will work.
2250 + Change `optVariables` from `[(String, String)]` to `Context Text`.
2251 + Change `optMetadata` to `Meta`, to allow structured values.
2252 The current behavior of the `--metadata` option stays the same.
2253 + Rename `optReader`, `optWriter` as `optFrom`, `optTo`.
2254 + Add `FromYAML` instances to `Opt` and to all subsidiary types.
2255 + Rename `optMetadataFile` to `optMetadataFiles`.
2256 + Rename `optPDFEngineArgs` to `optPDFEngineOpts`.
2257 + Rename `optWrapText` to `optWrap`.
2258 + Add `IpynbOutput` enumerated type: use this instead of
2259 a string for `optIpynbOutput`.
2260 + Change optInputFiles to a `Maybe [FilePath]` (#5888) [API change].
2261 `Nothing` means: nothing specified.
2262 `Just []` means: an empty list specified (e.g. in defaults).
2263 + List fields in Opt so they aren't reversed (#5881) [API change].
2264 Previously `optIncludeInHeader`, etc. were in reverse order.
2265 + The `sourcefile` variable is now always a list. It used to be
2266 sometimes a string, sometimes a list (when there was more than one).
2268 * Template changes:
2270 + default.latex: added code for `cslreferences` environment,
2271 to be used for pandoc-citeproc references. A `csl-hanging-indent`
2272 variable (set automatically if there is a `hanging-ident`
2273 class on the references Div) controls whether contents of this
2274 environment receive a hanging indent.
2275 + default.latex: Add `space` as default option for xeCJK, so that
2276 spaces between words are preserved (#5855, jeongminkim-islab).
2277 This is necessary for Korean.
2278 + default.latex: Remove include of `grffile` (#5848).
2279 This package used to be needed for proper handling of image filenames
2280 containing periods (in addition to the period before the extension).
2281 It no longer works with the latest LaTeX kernel and graphicx,
2282 so we have removed it. Future versions of graphicx will handle
2283 these filenames without the need for `grffile`.
2284 + default.context: add a saner default for page numbers.
2285 Previously they appeared centered at the top of the page;
2286 now we put them centered at the bottom, unless the `pagenumbering`
2287 variable is set.
2288 + default.context: define a start-stop-pair `cslreferences` to
2289 allow for hanging indents in the bibliography (#5875, Denis Maier).
2290 + default.ms: update defaults. Use Palatino font, use slightly
2291 wider interparagraph space, don't indent paragraphs,
2292 and put page numbers on the bottom. This brings ms output
2293 closer to default LaTeX output.
2294 + default.revealjs: add navigationMode (Mauro Bieg, #5657).
2295 + default.muse: handle multiple authors better.
2296 + docbook4, docbook5 templates: add indentation to body.
2297 + HTML-based templates: use `styles.html` partial to avoid
2298 code duplication.
2299 + HTML-based templates: change indentation of styles in template.
2301 * reference.docx (#5820):
2303 + Change Block Text (block quote) style so that the same font
2304 is used as in the body text, and the block text is indented
2305 left and right.
2306 + All headings now have a uniform color.
2307 + Level-1 headings no longer set `w:themeShade="B5"`.
2308 + Level-2 headings are now 14 point rather than 16 point.
2309 + Level-3 headings are now 12 point rather than 14 point.
2310 + Level-4 headings are italic rather than bold.
2312 * epub.css: Add CSS for hanging-indent div to support pandoc-citeproc's
2313 new hanging indents.
2315 * pandoc.cabal:
2317 + Repeat ghc-options in all stanzas.
2318 + Remove conditionals for ghc < 8 (Albert Krewinkel, #5693).
2319 + Compile with `-Wcpp-undef` and `-fhide-source-paths` when possible
2320 (Albert Krewinkel).
2321 + Add cabal.project to extra-source-files (Albert Krewinkel).
2322 + Add dependency on skylighting-core (#5729). Even though it shouldn't
2323 be needed, some tools require it.
2324 + Require latest pandoc-types, texmath, skylighting, haddock-library.
2325 + Ensure TemplateHaskell is added to other-extensions when it is
2326 used (Vanessa McHale, #5728).
2327 + Remove `derive_json_via_th` flag; always use TH. This cuts down
2328 on code duplication and reduces the chance for errors. See #4083.
2330 * Makefile:
2332 + Add ghci target.
2333 + Add ghcid target.
2334 + Remove references to obsolete flag (#5694).
2336 * Benchmarks: fix failure on ipynb.
2338 * Use MathJax 3 (zorkow).
2340 * KaTeX math: respect `classoption=fleqn` variable,
2341 bump KaTeX version to 0.11.1 (#5815, Mauro Bieg).
2343 * Fix redundant constraint compiler warnings (Pete Ryland, #5625).
2345 * Use throwError instead of fail when appropriate.
2347 * Use Prelude.fail to avoid ambiguity with fail from GHC.Base.
2349 * Add `diff-zip.sh` to tools (John MacFarlane, Agustín Martín Barbero).
2350 This is intended to make it easier to test differences in zip
2351 containers, like epub, docx, or odt.
2353 * Add `.gitattributes` (#5747). This ensures that the golden files
2354 in `test/fb2/reader/` don't have newlines converted. This should fix
2355 a test failure on GitHub CI with Windows.
2357 * Reorder options in `--help`.
2359 * Revise code for HsYAML-0.2.0.0 (@vijayphoenix, #5704).
2361 * Remove blank line in code example in Haddocks (Leif Metcalf, #5679).
2363 * Fix trypandoc with `getReader`/`getWriter` changes.
2365 * Allow building pandoc with GHC 8.8.
2367 * linux tarball: add architecture `-amd64` to filename.
2368 Now it will be: `pandoc-VERSION-linux-ARCH.tar.gz`.
2370 * MANUAL.txt:
2372 + Add section for exit codes.
2373 + Document some pptx limitations in slide show section:
2374 No incremental display (#5689). No pause with `. . .` (#5701).
2375 + reveal.js flags (Mauro Bieg, #5653).
2376 + Document addition of `data-` prefix to unknown attributes in HTML5.
2377 + Link to YAML spec (Mauro Bieg, #5687).
2378 + Fix capitalization of "Linux" (#5859, Marcus Stollsteimer).
2379 + Use a table for exit codes.
2380 + Put all template variable docs into one section.
2381 + Use ATX headers consistently.
2382 + Add fuller documentation of templates (#5779), including
2383 new template syntax, partials, etc.
2384 + Add documentation for the variable `hyperrefoptions` (Wandmalfarbe).
2385 + Clarify when macro definitions are passed as raw latex.
2386 In Markdown input, they are always passed through. In LaTeX, only if
2387 `latex_macros` is disabled.
2388 + Clarify that `--dpi` provides a default and doesn't override
2389 dpi values specified in the images themselves (#5721).
2390 + Document how to use custom writers with `--standalone` (#5866).
2391 + Clarify `--preserve-tabs` default.
2393 * INSTALL.md:
2395 + Fix instructions for libicu.
2396 + Add Void Linux instructions (Volodymyr Kozachnyskyi).
2398 * CONTRIBUTING.md:
2400 + Add information on tests (Agustín Martín Barbero, #5652).
2401 + Add information about command test naming to CONTRIBUTING (Florian B).
2403 * Fix typos in changelog and comments (#5896, Brian Wignall).
2405 * doc/lua-filters.md:
2407 + Fix mistakes in mediabag module docs (#5851, Albert Krewinkel).
2408 + Improve metadata replacement example in lua-filters doc (#5851).
2409 + Mention which Lua version is shipped with pandoc (Albert Krewinkel,
2410 #5892).
2412## pandoc 2.7.3 (2019-06-11)
2414 * Add `jira` (Atlassian's Jira wiki markup) as output format (#2497,
2415 Albert Krewinkel).
2417 * Add `tex_math_dollars` to `multimarkdownExtensions` (#5512).
2418 This form is now supported in multimarkdown,
2419 in addition to `tex_math_double_backslash`.
2421 * Fix `--self-contained` so it works when output format has extensions.
2422 Previously if you used `--self-contained` with `html-smart` or
2423 `html+smart`, it wouldn't work.
2425 * Add template variable `curdir` with working directory
2426 from which pandoc is run (#5464).
2428 * Markdown reader: don't create implicit reference for empty header
2429 (#5549).
2431 * Muse reader: allow images inside link descriptions (Alexander Krotov).
2433 * HTML reader: epub related fixes.
2435 + With epub extensions, check for `epub:type` in addition to `type`.
2436 + Fix problem with noteref parsing which caused block-level
2437 content to be eaten with the noteref.
2438 + Rename `pAnyTag` to `pAny`.
2439 + Refactor note resolution.
2440 + Trim definition list terms (Alexander Krotov).
2442 * LaTeX reader:
2444 + Add braces when resolving `\DeclareMathOperator`
2445 (#5441). These seem to be needed for xelatex but not pdflatex.
2446 + Allow newlines in `\mintinline`.
2447 + Pass through unknown listings language as class (#5540).
2448 Previously if the language was not in the list of languages supported
2449 by listings, it would not be added as a class, so highlighting
2450 would not be triggered.
2451 + `rawLaTeXInline`: Include trailing `{}`s in raw latex commands (#5439).
2452 This change affects the markdown reader and other readers that allow raw
2453 LaTeX. Previously, trailing `{}` would be included for unknown
2454 commands, but not for known commands. However, they are sometimes used
2455 to avoid a trailing space after the command. The chances that a `{}`
2456 after a LaTeX command is not part of the command are very small.
2458 * MediaWiki reader: handle multiple attributes in table row (#5471,
2459 chinapedia).
2461 * Docx reader: Add support for `w:rtl` (#5545). Elements with this
2462 property are put into Span inlines with `dir="rtl"`.
2464 * DocBook reader: Issue `IgnoredElement` warnings.
2466 * Org reader (Albert Krewinkel):
2468 + Fix planning elements in headers level 3 and higher
2469 (#5494). Planning info is now always placed before
2470 the subtree contents. Previously, the planning info was placed after
2471 the content if the header's subtree was converted to a list, which
2472 happens with headers of level 3 and higher per default.
2473 + Omit, but warn about unknown export options. Unknown export
2474 options are properly ignored and omitted from the output.
2475 + Prefer plain symbols over math symbols (#5483).
2476 Symbols like `\alpha` are output plain and unemphasized, not as math.
2477 + Recognize emphasis after TODO/DONE keyword (#5484).
2479 * FB2 reader:
2481 + Skip unknown elements rather than throwing errors (#5560).
2482 Sometimes custom elements are used (e.g. `id` element
2483 inside `author`); previously the reader would halt with an error.
2484 Now it skips the element and issues an `IgnoredElement` warning.
2485 + Parse notes (#5493, Alexander Krotov).
2486 + Internal improvements (Alexander Krotov).
2488 * OpenDocument writer: Roll back automatic figure/table numbering
2489 (#5474). This was added in pandoc 2.7.2, but it makes it impossible
2490 to use pandoc-crossref. So this has been rolled back for now,
2491 until we find a good solution to make this behavior optional
2492 (or a creative way to let pandoc-crossref and this feature
2493 to coexist).
2495 * New module Text.Pandoc.Writers.Jira, exporting `writeJira` [API
2496 change] (Albert Krewinkel).
2498 * EPUB writer:
2500 + Don't include 'landmarks' if there aren't any.
2501 Previously we could get an empty ol element, which caused
2502 validation errors with epubcheck.
2503 + Ensure unique ids for styleesheets in content.opf (#5463).
2504 + Make stylesheet link compatible with kindlegen (#5466,
2505 Eric Schrijver). Pandoc omitted `type="text/css"` from both
2506 `<style>` and `<rel="stylesheet">` elements in all templates, which
2507 is valid according to the spec. However, Amazon’s kindlegen software
2508 relies on this attribute on `<link>` elements when detecting
2509 stylesheets to include.
2511 * HTML writer:
2513 + Output video and audio elements depending on file
2514 extension of the image path (Mauro Bieg).
2515 + Emit empty alt tag in figures (#5518, Mauro Bieg).
2516 The same text is already in the <figcaption> and
2517 screen-readers would read it twice, see #4737.
2518 + Don't add variation selector if it's already there.
2519 This fixes round-trip failures.
2520 + Prevent gratuitous emojification on iOS (#5469).
2521 iOS chooses to render a number of Unicode entities, including '↩', as
2522 big colorful emoji. This can be defeated by appending Unicode
2523 VARIATION SELECTOR-15'/'VARIATION SELECTOR-16'. So we now append this
2524 character when escaping strings, for both '↩' and '↔'. If other
2525 characters prove problematic, they can simply be added to
2526 `needsVariationSelector`. + Add `class="heading"` to level 7+ Headers
2527 rendered as `<p>` elements (#5457).
2529 * RST writer: treat Span with no attributes as transparent (#5446).
2530 Previously an Emph inside a Span was being treated as
2531 nested markup and ignored. With this patch, the Span
2532 is just ignored.
2534 * LaTeX writer:
2536 + Include inline code attributes with `--listings` (#5420).
2537 + Don't produce columns environment unless beamer (#5485).
2538 + Fix footnote in image caption. Regression: the fix for #4683 broke
2539 this case.
2540 + Don't highlight code in headings (#5574). This causes
2541 compilation errors.
2542 + Use `\mbox` to get proper behavior inside `\sout` (#5529).
2544 * EPUB writer: Fix document section assignments (#5546).
2545 For example, introduction should go in bodymatter, not frontmatter, and
2546 epigraph, conclusion, and afterward should go in bodymatter, not
2547 backmatter. For the full list of assignments, see the manual.
2549 * Markdown writer:
2551 + Add backslashes to avoid unwanted interpretation of
2552 definition list terms as other kinds of block (#554).
2553 + Ensure the code fence is long enough (#5519).
2554 Previously too few backticks were used when the code block
2555 contained an indented line of backticks. (Ditto tildes.)
2556 + Handle labels with integer names (Jesse Rosenthal, #5495).
2557 Previously if labels had integer names, it could produce a conflict
2558 with auto-labeled reference links. Now we test for a conflict and
2559 find the next available integer. This involves adding a new state
2560 variable `stPrevRefs` to keep track of refs used in other document
2561 parts when using `--reference-location=block|section`
2563 * Textile writer: fix closing tag for math output (Albert Krewinkel).
2564 Opening and closing tag for math output match now.
2566 * Org writer: always indent src blocks content by 2 spaces (#5440, Albert
2567 Krewinkel). Emacs always uses two spaces when indenting the content of
2568 src blocks, e.g., when exiting a `C-c '` edit-buffer. Pandoc used to
2569 indent contents by the space-equivalent of one tab, but now always uses
2570 two spaces, too.
2572 * Asciidoc writer:
2574 + Use `` `+...+` `` form for inline code.
2575 The old `` `a__b__c` `` yields emphasis inside code in asciidoc.
2576 To get a pure literal code span, use `` `+a__b__c+` ``.
2577 + Use proper smart quotes with asciidoctor (#5487).
2578 Asciidoctor has a different format for smart quotes.
2579 + Use doubled ## when necessary for spans (#5566).
2580 + Ensure correct nesting of strong/emph (#5565): strong
2581 must be the outer element.
2583 * JATS writer:
2585 + Wrap elements with p when needed (#5570). The JATS spec restricts
2586 what elements can go inside `fn` and `list-item`. So we wrap other
2587 elements inside `<p specific-use="wrapper">` when needed.
2588 + Properly handle footnotes (#5511) according to "best practice."
2589 (Group them at the end in `<fn-group>` and use `<xref>` elements
2590 to link them.)
2591 + Fix citations with PMID so they validate (#5481). This includes
2592 an update to data/jats.csl.
2593 + Ensure validity of `<pub-date>` by parsing the date and
2594 extracting year, month, and day, as expected. Also add an
2595 iso-8601-date attribute automatically.
2596 + Don't use `<break>` element for LineBreak. It is only
2597 allowed in a few special contexts, and not in `<p>` elements.
2598 + Don't make `<string-name>` a child of `<string>`, which is illegal.
2600 * FB2 writer:
2602 + Do not wrap note references into `<sup>` and brackets
2603 (Alexander Krotov). Existing FB2 readers, such as FBReader, already
2604 display links with type="note" as a superscript.
2605 + Use genre metadata field (#5478).
2607 * Muse writer: do not escape empty line after `<br>` (Alexander Krotov).
2609 * Add unicode code point in "Missing character" warning (#5538).
2610 If the character isn't in the console font, the message is pretty useless,
2611 so we show the code point for anything non-ASCII.
2613 * Lua: add Version type to simplify comparisons (Albert Krewinkel).
2614 Version specifiers like `PANDOC_VERSION` and `PANDOC_API_VERSION` are
2615 turned into `Version` objects. The objects simplify version-appropriate
2616 comparisons while maintaining backward-compatibility.
2617 A function `pandoc.types.Version` is added as part of the newly
2618 introduced module `pandoc.types`, allowing users to create version
2619 objects in scripts.
2621 * pandoc lua module (Albert Krewinkel):
2623 - Fix deletion of nonexistent attributes (#5569).
2624 - Better tests for Attr and AttributeList.
2626 * pandoc.mediabag lua module (Albert Krewinkel):
2628 + Add function `delete` for deleting a single item.
2629 + Add function `empty` for removing all entries.
2630 + Add function `items` for iterating over mediabag.
2632 * Text.Pandoc.Class: Fix handling of `file:` URL scheme in
2633 `downloadOrRead` (#5517, Mauro Bieg). Previously `file:/`
2634 URLs were handled wrongly and pandoc attempted to make HTTP
2635 requests, which failed.
2637 * Text.Pandoc.MIME: add `mediaCategory` [API change] (Mauro Bieg).
2639 * Text.Pandoc.Shared:
2641 + Add `onlySimpleTableCells` [API change]
2642 (Mauro Bieg) and use this to consolidate simple-table detection
2643 (#5524). This fixes an inconsistency in the HTML reader, which did not
2644 treat tables with `<p>` inside cells as simple.
2645 + `metaToJSON`: treat digits starting with 0 as a string, not a number
2646 (#5479). This fixes a regression in YAML metadata in pandoc 2.7.2.
2648 * Text.Pandoc.Logging: Add `IgnoredElement` constructor for
2649 `LogMessage`. `SkippedConetnt` doesn't work for some XML-based
2650 readers which don't have access to parsec source positions.
2652 * Text.Pandoc.Asciify: Add Turkish undotted-i (#5433, Mauro Bieg).
2654 * Improve output of Lua tests (#5499, Albert Krewinkel).
2655 This makes use of tasty-lua, a package to write tests in Lua
2656 and integrate the results into Tasty output. Test output becomes
2657 more informative: individual tests and test groups become visible
2658 in test output. Failures are reported with helpful error messages.
2660 * Lua: add `pandoc.system` module (#5468, Albert Krewinkel).
2661 The `system` Lua module provides utility functions to interact with the
2662 operating- and file system. E.g.
2663 `print(pandoc.system.get_current_directory())`
2664 or
2665 ```lua
2666 pandoc.system.with_temporary_directory('tikz', function (dir)
2667 -- write and compile a TikZ file with pdflatex
2668 end)
2669 ```
2671 * LaTeX template: Add pdflang to hypersetup if lang is set (#5443).
2673 * beamer template: Fix using Beamer with geometry (#5505, Daniel Maslowski).
2674 Beamer already loads geometry, so we need to use the `\geometry`
2675 command to set geometry options.
2677 * EPUB2/3 templates: Move inline styles to default epub.css (#5466).
2678 NOTE: Those who use a custom CSS stylesheet with EPUB should
2679 add these lines:
2681 code{ white-space: pre-wrap; }
2682 span.smallcaps{ font-variant: small-caps; }
2683 span.underline{ text-decoration: underline; }
2684 q { quotes: "“" "”" "‘" "’"; }
2685 div.column{ display: inline-block; vertical-align: top; width: 50%; }
2687 * reveal.js template:
2689 + Updates for revealjs 3.8.0 (#5435, ebiim).
2690 + Remove reference to head.min.js (#5448, Winnie Hellmann).
2691 NOTE: users will need to update reveal.js to at least 3.8.0
2692 for their presentations generated with this version of pandoc
2693 to work correctly.
2695 * Text.Pandoc.PDF:
2697 + Replace `</>` with literal `/` (#5451).
2698 We use forward-slash for a directory separator in tmpDir,
2699 even on Windows (because that's what tex likes). So we
2700 should not put a backslash between the tmpDir and the
2701 filename on Windows. This is harmless enough in normal
2702 Windows setups, but it breaks on Cygwin.
2703 Thanks to @cc2x for noticing and diagnosing the problem.
2704 + Allow use of `-output-directory` in `--pdf-engine-opt` (#5462).
2705 This is currently possible with `mklatex` and `-outdir`, but
2706 was not yet possible with xelatex and `-output-directory`.
2707 + For PDF via ms/pdfroff, make TOC appear at beginning and in
2708 PDF bookmarks (#5553). Previously the TOC appeared at the end
2709 of the document, and was not bookmarked. To keep it at the end,
2710 add `--pdf-engine-opt=--no-toc-relocation` to your command line.
2712 * Fix broken links in documents (#5473, Shim Myeongseob).
2713 Also, use absolute links to pandoc.org when possible, so that
2714 the links can be followed by people viewing these documents
2715 on GitHub.
2717 * Improved sample lua tikz filter in lua-filters docs (#5445,
2718 Matthew Doty). There are three changes:
2720 + It only processes elements which begin with `\begin{tikzpicture}`
2721 + It uses pdf2svg instead of imagemagick to preserve fidelity
2722 + The images produced have transparent backgrounds
2724 * MANUAL.txt:
2726 + Add note about `title-meta`, `author-meta`, `date-meta` (#5486).
2727 + Fix typo (#5489, Christian Krause).
2729 * add test/tables.xwiki to git and pandoc.cabal (#5498, Mauro Bieg).
2731 * Disable missing-home-modules warning in `stack.yaml`.
2732 Otherwise `stack ghci` fails.
2735## pandoc 2.7.2 (2019-04-05)
2737 * Add XWiki writer (#1800, Derek Chen-Becker).
2738 Add `Text.Pandoc.Writers.XWiki`, exporting `writeXWiki` [API change].
2740 * Dokuwiki Reader: parse single curly brace (#5416, Mauro Bieg).
2742 * Vimwiki reader: improve handling of internal links (#5414).
2743 We no longer append `.html` to link targets, and we add a title
2744 `wikilink`. This mirrors behavior of other wiki readers. Generally
2745 the `.html` extension is not wanted. It may be important for output
2746 to HTML in certain circumstances, but it can always be added using a
2747 filter that matches on links with title `wikilink`.
2749 If your workflow requires the current behavior, here is a lua filter
2750 that will add the `.html` extension:
2752 ```lua
2753 function Link(el)
2754 if el.title == 'wikilink' then
2755 el.target = el.target .. ".html"
2756 end
2757 return el
2758 end
2759 ```
2760 * ipynb reader:
2762 + Use format `ipynb` for raw cell where no format given.
2763 + Avoid introducing spurious `.0` on integers in metadata.
2765 * Markdown reader: fenced div takes priority over setext header.
2767 * HTML reader: read `data-foo` attribute into `foo` (#5392).
2768 The HTML writer adds the `data-` prefix for HTML5 for nonstandard
2769 attributes. But the attributes are represented in the AST without
2770 the `data-` prefix, so we should strip this when reading HTML.
2772 * LaTeX reader: Improve autolink detection (#5340).
2774 * PowerPoint writer (Jesse Rosenthal):
2776 + Expand builtin reference doc to model all layouts.
2777 The previous built-in reference doc had only title and content
2778 layouts. Add in a section-header slide and a two-content slide, so
2779 users can more easily modify it to build their own templates.
2780 + Always open up in slide view. When editing a
2781 template/reference-doc, the user might be in Master view, but when
2782 producing a slide show, it is assumed that slide view will be
2783 desired.
2784 + Remove `handoutsMasterList` from template presentation.xml
2785 + Fix numerous errors in templating (#5402). Previously, some templates
2786 produced by Office 365 (MacOS) would not render with `--reference-doc`
2787 correctly. We now apply correct shapes for content, and build
2788 shape trees correctly.
2789 + Make default placeholder type for template lookup.
2790 + Apply speaker notes to metadata slide if applicable.
2791 + Test for speaker notes after breaking header.
2792 + Correctly handle notes after section-title header.
2793 Previously, if notes came after a section-title header (ie, a level-1
2794 header in a slide-level=2 presentation), they would go on the next
2795 slide. This keeps them on the slide with the header.
2796 + Internal improvements.
2798 * ipynb writer:
2800 + Use format `ipynb` for raw cell where no format given.
2801 According to nbformat docs, this is supposed to render in every
2802 format. We don't do that, but we at least preserve it as a raw
2803 block in markdown, so you can round-trip.
2804 + Consolidate adjacent raw blocks. Sometimes pandoc creates two
2805 HTML blocks, e.g. one for the open tag and one for a close tag.
2806 If these aren't consolidated, only one will show up in output cell.
2807 + Fixed carry-over of nbformat from metadata.
2808 + Preserve `nbformat_minor` if it's given. This helps with round-tripping.
2810 * LaTeX writer:
2812 + Avoid inadvertently creating ?` or !` ligatures (#5407).
2813 These are upside down ? and !, resp.
2814 + Fix footnotes in table caption and cells (#5367). This fixes a
2815 bug wherein footnotes appeared in the wrong order, and with
2816 duplicate numbers, when in table captions and cells.
2817 We now use regular `\footnote` commands, even in the table
2818 caption and the minipages containing cells. Apparently
2819 longtable knows how to handle this.
2821 * HTML writer: Don't add data- prefix to RDFa attributes (#5403).
2823 * JATS writer: Ensure that plain strings go inside `<pub-id>` tag (#5397).
2825 * Markdown writer:
2827 + Better rendering of numbers (#5398). If the number is integral,
2828 we render it as an integral not a float.
2829 + Proper rendering of empty map in YAML metadata (#5398). Should
2830 be `{}`, not empty string.
2831 + Properly escape attributes in Markdown writer (#5369).
2832 + Be sure implicit figures work in list contexts (#5368).
2833 Previously they would sometimes not work: e.g., when they
2834 occurred in final paragraphs in lists that were originally
2835 parsed as Plain and converted later using PlainToPara.
2837 * Docx writer: Use `w:br` without attributes for line breaks (#5377).
2838 We previously added the attribute `type="textWrapping"`, but
2839 this causes problems on Word Online.
2841 * LaTeX template (Andrew Dunning):
2843 + Ensure correct heading/table order (#5365). Improve workaround
2844 (#1658) for tables following headings. The new solution works whether
2845 or not the `indent` variable is enabled.
2846 + Remove `subparagraph` variable. The default is now to use run-in
2847 style for level 4 and 5 headings (`\paragraph` and `\subparagraph`).
2848 To get the previous default behavior (where these were formatted as
2849 blocks, like `\subsubsection`), set the `block-headings` variable.
2850 + Add pandoc to PDF metadata (#5388).
2851 + Group graphics-related code (#5389).
2852 + Move `\setstretch` after front matter (#5179). Ensures that
2853 `\maketitle`, `\tableofcontents`, and so forth are not affected by
2854 changes to line spacing.
2856 * Update data/jats.csl to avoid commas between name-part elements
2857 (#5397).
2859 * Add support for golang (`go`) with `--listings` (#5427).
2861 * Text.Pandoc.Shared - improve `metaToJSON` behavior with numbers.
2862 We now do a better job marshalling numbers from MetaString
2863 or MetaInlines into JSON Number.
2865 * Text.Pandoc.Writers.Shared: `metaValueToJSON`: use Number Values for
2866 integers. Pandoc's MetaValue doesn't have a distinguished number type,
2867 so numbers are put in MetaStrings. If the MetaString consists
2868 entirely of digits, we convert it to a Number. We should probably
2869 consider adding a MetaNumber constructor to MetaValue, for better
2870 round-tripping with JSON etc. This change aids round-tripping in
2871 ipynb metadata fields, like `toc_depth`.
2873 * Text.Pandoc.Class: `fetchItem`: don't treat UNC paths as
2874 protocol-relative URLs (#5127). These are paths beginning `//?/UNC/...`.
2876 * Text.Pandoc.ImageSize: Improve `pdfSize` so it handles
2877 a wider range of PDFs (#4322, with help from Richard Davis).
2879 * Text.Pandoc.Pretty: avoid stack overflow by using strict sum (#5401).
2881 * Fix harmless error in file-scope code (#5422).
2883 * MANUAL.txt:
2885 + Improve 'header' and 'heading' usage (#5423, Andrew
2886 Dunning). The term 'header' was being used where 'heading'
2887 is more appropriate.
2888 + Add paragraph on options affecting markdown in ipynb.
2890 * stack.yaml - remove -Wmissing-home-modules
2891 This seems to cause problems with stack ghci. Remove RTS options.
2893 * Add ghc-options to cabal.project.
2895 * appveyor.yml - use ghc 8.6.4. Fixes segfault issues on Windows (#5037).
2897 * linux build process: Remove clone of pandoc-citeproc (#5366).
2898 It wasn't being used; cabal.project specifies the version to use.
2900## pandoc 2.7.1 (2019-03-14)
2902 * Add tectonic as an option for --pdf-engine (#5345, Cormac Relf).
2903 Runs tectonic on STDIN instead of a temporary .tex file, so that it
2904 looks in the working directory for `\include` and `\input` like the rest
2905 of the engines. Allows overriding the output directory
2906 args with `--pdf-engine-opt=--outdir --pdf-engine-opt="$DIR"`.
2908 * Allow `-o/--output` to be used with `--print-default-data-file`,
2909 `--print-highlighting-style`, `--print-default-template`.
2910 Note that `-o` must occur BEFORE the `--print*` command on the command
2911 line (this is documented, #5357).
2913 * LaTeX reader:
2915 + Support `\underline`, `\ul`, `\uline` (#5359, Paul
2916 Tilley). These are parsed as a Span with class `underline`, as
2917 with other readers.
2918 + Ensure that `\Footcite` and `\Footcites` get put in a note.
2920 * ipynb reader:
2922 + Remove sensitivity to `raw_html`, `raw_tex` extensions.
2923 We now include every output format. Pruning is handled by
2924 `--ipynb-output`.
2925 + Better handling of cell metadata. We now include even complex cell
2926 metadata in the Div's attributes (as JSON, in complex cases, or
2927 as plain strings in simple cases).
2929 * ipynb writer:
2931 + Recurse into native divs for output cell data (#5354).
2932 + Render cell metadata fields from div attributes.
2934 * Docx writer: avoid extra copy of abstractNum and num elements
2935 in numbering.xml. This caused pandoc-produced docx files to
2936 be uneditable using Word Online (#5358).
2938 * Markdown writer: improve handling of raw blocks/inline.
2939 We now emit raw content using `raw_attribute` when no more
2940 direct method is available. Use of `raw_attribute` can be
2941 forced by disabling `raw_html` and `raw_tex`.
2943 * LaTeX writer: Add classes for frontmatter support (#5353, Andrew Dunning)
2944 and remove frontmatter from `scrreprt`.
2946 * LaTeX template:
2948 + Improve readability (#5363, Andrew Dunning).
2949 + Robust section numbering removal (#5351, Andrew Dunning).
2950 Ensures that section numbering does not reappear with custom
2951 section levels. See <https://tex.stackexchange.com/questions/473653/>.
2952 + Better handling of front/main/backmatter (#5348).
2953 In pandoc 2.7 we assumed that every class with chapters would accept
2954 `\frontmatter`, `\mainmatter`, and `\backmatter`. This is not so (e.g.
2955 report does not). So pandoc 2.7 breaks on report class by including an
2956 unsupported command. Instead of the `book-class` variable, we use two
2957 variables, `has-chapters` and `has-frontmatter`, and set these
2958 intelligently in the writer.
2960 * Text.Pandoc.Shared: Improve `filterIpynbOutput`. Ensure that
2961 images are prioritized over text. `best` should include everything
2962 for ipynb.
2964 * Tests.Old: specify `--data-dir=../data` to ensure tests can find
2965 data files even if they haven't been installed. Remove old
2966 `pandoc_datadir` environment variable, which hasn't done anything for a
2967 long time.
2969 * MANUAL.txt: Add recommendation to use `raw_attribute` with ipynb (#5354).
2971 * Use cmark-gfm-hs 0.1.8 (note that 0.1.7 is buggy).
2973 * Use latest pandoc-citeproc, texmath.
2976## pandoc 2.7 (2019-03-03)
2978 * Use XDG data directory for user data directory (#3582). Instead of
2979 `$HOME/.pandoc`, the default user data directory is now
2980 `$XDG_DATA_HOME/pandoc`, where `XDG_DATA_HOME` defaults to
2981 `$HOME/.local/share` but can be overridden by setting the
2982 environment variable. If this directory is missing, then
2983 `$HOME/.pandoc` is searched instead, for backwards compatibility.
2984 However, we recommend moving local pandoc data files from
2985 `$HOME/.pandoc` to `$HOME/.local/share/pandoc`. On Windows the
2986 default user data directory remains the same.
2988 * Slide show formats behavior change: content under headers
2989 less than slide level is no longer ignored, but included in
2990 the title slide (for HTML slide shows) or in a slide after
2991 the title slide (for beamer). This change makes possible
2992 2D reveal.js slideshows with content in the top slide on
2993 each stack (#4317, #5237).
2995 * Add command line option `--ipynb-output=all|none|best` (#5339).
2996 Output cells in ipynb notebooks often contain several different
2997 versions of an output, with different MIME types, e.g. an HTML
2998 table and a plain-text fallback. Specifying `--ipynb-output=best`
2999 (the default) ensures that the best version for the output format
3000 is used. `all` includes all versions, and `none` suppresses them
3001 all, leaving output cells empty.
3003 * `asciidoctor` is now an output format separate from `asciidoc`,
3004 to accommodate some minor implementation-specific differences
3005 (currently just in the treatment of display math).
3007 * Add `latexmk` as an option for `--pdf-engine` (#3195).
3008 Note that you can use `--pdf-engine-opt=-outdir=bar` to specify
3009 a persistent temp directory.
3011 * Markdown reader:
3013 + Improve tight/loose list handling (#5285). Previously the
3014 algorithm allowed list items with a mix of Para and Plain, which
3015 is never wanted.
3016 + Add newline when parsing blocks in YAML (#5271). Otherwise last
3017 block gets parsed as a Plain rather than a Para. This is a
3018 regression in pandoc 2.x. This patch restores pandoc 1.19
3019 behavior.
3020 + Make `yamlToMeta` respect extensions (#5272, Mauro Bieg).
3021 This adds a `ReaderOptions` parameter to `yamlToMeta` [API change].
3022 + Fix bug parsing fenced code blocks (#5304). Previously parsing
3023 would break if the code block contained a string of backticks of
3024 sufficient length followed by something other than end of line.
3026 * LaTeX reader: don't let `\egroup` match `{`. `braced` now actually
3027 requires nested braces. Otherwise some legitimate command and
3028 environment definitions can break.
3030 * Docx reader (Jesse Rosenthal):
3032 + Rename `getDocumentPath` as `getDocumentXmlPath`.
3033 + Use field notation for setting `ReaderEnv`.
3034 + Figure out `document.xml` path once at the beginning of parsing, and
3035 add it to the environment, so we can avoid repeated lookups.
3036 + Dynamically determine main document xml path (#5277).
3037 The desktop Word program places the main document file in
3038 `word/document.xml`, but the online word places it in
3039 `word/document2.xml`. This file path is actually stated in the root
3040 `_rels/.rels` file, in the `Relationship` element with an
3041 `http://../officedocument` type.
3042 + Fix paths in archive to prevent Windows failure (#5277).
3043 Some paths in archives are absolute (have an opening slash) which, for
3044 reasons unknown, produces a failure in the test suite on MS
3045 Windows. This fixes that by removing the leading slash if it exists.
3046 + Add comments to aid code readability.
3047 + Trim space inside the last inline (#5273).
3048 + Unwrap sdt elements in footnotes and comments (#5302).
3050 * Muse reader (Alexander Krotov):
3052 + Test that block level markup does not break `<verbatim>`.
3053 + Add secondary note support.
3055 * ipynb reader: handle images referring to attachments. Previously
3056 we didn't strip off the attachment: prefix, so even though the
3057 attachment was available in the mediabag, pandoc couldn't find it.
3059 * JATS reader:
3061 + Fix parsing of figures (#5321). This ensures that a figure
3062 containing a single image is parsed as a pandoc "implicit
3063 figure" (i.e., a Para with a single Image whose title attribute
3064 begins with `fig:`). More complex figures will still be parsed
3065 as divs.
3066 + Support `fig-group` block element (#5317).
3067 + Handle citations with multiple references (#5310). The `rid`
3068 attribute can have a space-separated list of ids.
3070 * AsciiDoc Writer: Add `writeAsciiDoctor` [API change, Tarik Graba].
3071 Handle display math appropriately for Asciidoctor.
3073 * JATS writer: wrap figure caption in `<p>` to fix validation (#5290,
3074 Mauro Bieg).
3076 * HTML writer:
3078 + Implement WAI-ARIA roles for (end)notes, citations, and
3079 bibliography (#4213). Note that doc-biblioref is only used when
3080 link-citations produces links, since it belongs on links.
3081 + Include content (including speaker notes) in title slides
3082 (#4317, #5237).
3084 * ipynb writer:
3086 + Ensure final newline.
3087 + Only include metadata under `jupyter` field.
3088 + Don't create attachments for images with absolute URIs,
3089 including data: URIs (#5303).
3090 + Keep plain text fallbacks in output even if a richer format is
3091 included (#5293). We don't know what output format will be needed.
3092 See the `--ipynb-output` command line option for a way to control
3093 what formats are included in the output.
3095 * Markdown writer: use `markdown="1"` when appropriate for Divs:
3096 when `native_divs` and `markdown_in_html_blocks` are disabled
3097 but `raw_html` and `markdown_attribute` are enabled.
3099 * LaTeX writer:
3101 + Use right fold for `escapeString`. This is more elegant than
3102 the explicit recursive code we were using.
3103 + Avoid `{}` after control sequences when escaping.
3104 `\ldots{}.` doesn't behave as well as `\ldots.` with the latex
3105 ellipsis package. This patch causes pandoc to avoid emitting
3106 the `{}` when it is not necessary. Now `\ldots` and other
3107 control sequences used in escaping will be followed by either
3108 a `{}`, a space, or nothing, depending on context.
3109 + For beamer, include contents under headers superordinate to
3110 slidelevel (#4317). Currently we keep the fancy title slide, and
3111 add a new slide with the same title and whatever content was
3112 under the header.
3114 * Powerpoint writer (Jesse Rosenthal): support underlines.
3115 Use span with single class "underline" as in docx writer.
3117 * Muse writer: escape secondary notes (Alexander Krotov).
3119 * FB2 writer: add section identifiers support (#5229, John KetzerX).
3121 * Make `--fail-if-warnings` work for PDF output (#5343).
3123 * Lua filters (Albert Krewinkel):
3125 + Load module `pandoc` before calling `init.lua` (#5287). The file
3126 `init.lua` in pandoc's data directory is run as part of pandoc's
3127 Lua initialization process. Previously, the `pandoc` module was
3128 loaded in `init.lua`, and the structure for marshaling was
3129 set up after. This allowed simple patching of element
3130 marshaling, but made using `init.lua` more difficult. Now, all
3131 required modules are now loaded before calling `init.lua`. The
3132 file can be used entirely for user customization. Patching
3133 marshaling functions, while discouraged, is still possible via
3134 the `debug` module.
3135 + All Lua modules bundled with pandoc, i.e., `pandoc.List`,
3136 `pandoc.mediabag`, `pandoc.utils`, and `text` are re-exported from the
3137 `pandoc` module. They are assigned to the fields `List`, `mediabag`,
3138 `utils`, and `text`, respectively.
3140 * Text.Pandoc.Lua (Albert Krewinkel):
3142 + Split `StackInstances` into smaller Marshaling modules.
3143 + Get `CommonState` from Lua global. This allows more control over
3144 the common state from within Lua scripts.
3146 * LaTeX template:
3148 + Support the `subject` metadata variable (#5289, Pascal Wagler).
3149 + Add `\frontmatter`, `\mainmatter`, `\backmatter`
3150 for book classes (#5306).
3152 * epub3 template: Add titlepage class to section (#5269).
3154 * HTML5 template: Add ARIA role `doc-toc` for table of contents (#4213).
3156 * Make `--metadata-file` use selected extensions (#5279, #5272, Mauro Bieg).
3158 * Text.Pandoc.Shared:
3160 + Remove `withTempDir` [API change].
3161 + Add new exported function `defaultUserDataDirs` [API change].
3162 + Add `filterIpynbOutput` [API change].
3163 + `compactify`: Avoid lists with a mix of Plain and Para elements
3164 (#5285).
3166 * Text.Pandoc.Translations: reorder alphabetically and remove `Author`
3167 (#5334, Mauro Bieg).
3169 * Text.Pandoc.Extensions:
3171 + More carefully groom ipynb default extensions.
3172 + Add `all_symbols_escapable` to `githubMarkdownExtensions`.
3174 * Text.Pandoc.PDF:
3176 + Use system temp directory when possible (#1192). Previously we
3177 created temp dirs in the working directory, partly (a) because
3178 there were problems using the system temp directory on Windows,
3179 when their pathnames included tildes, and partly (b) because
3180 programs like `epstopdf.pl` would not be allowed to write to
3181 directories outside the working directory in restricted mode. We
3182 now (a) use the system temp dir except when the path includes
3183 tildes, and (b) set `TEXMFOUTPUT` when creating the PDF, so that
3184 subsidiary programs can use the system temp directory. This
3185 addresses problems that occurred when pandoc was used in a
3186 synced directory (such as Dropbox).
3187 + Change types of subsidiary functions to PandocIO, to allow
3188 warnings to be threaded through (#5343).
3190 * Text.Pandoc.MIME: add WebP (#5267, Mauro Bieg).
3192 * Tests: avoid calling `findPandoc` multiple times.
3194 * Old tests: remove need for temp files by using `pipeProcess`.
3196 * Added simple ipynb reader/writer tests (#5274).
3198 * Rearrange `--help` output in a more rational way, with common
3199 options at the beginning and options grouped by function (#5336).
3201 * trypandoc: Add JATS and other missing formats (Arfon Smith, #5291).
3203 * Add missing copyright notices and remove license boilerplate (#4592,
3204 Albert Krewinkel).
3206 * Use latest basement/foundation on 32bit windows.
3208 * Use latest skylighting (#5328). Custom syntax definitions no
3209 longer try to load `language.dtd`.
3211 * Require texmath 0.11.2.1
3213 * Use latest pandoc-citeproc (0.16.1.1).
3215 * MANUAL.txt:
3217 + Clarify variable substitution indentation in templates (#5338,
3218 Agustín Martín Barbero).
3219 + Reorder custom-styles section (#5324, Mauro Bieg).
3221## pandoc 2.6 (2019-01-30)
3223 * Support ipynb (Jupyter notebook) as input and output format.
3225 + Add `ipynb` as input and output format (extension `.ipynb`).
3226 + Added Text.Pandoc.Readers.Ipynb [API change].
3227 + Added Text.Pandoc.Writers.Ipynb [API change].
3228 + Add `PandocIpynbDecodingError` constructor to Text.Pandoc.Error.Error
3229 [API change].
3230 + Depend on ipynb library.
3231 + Note: there is no template for ipynb.
3233 * Add DokuWiki reader (#1792, Alexander Krotov). This adds
3234 Text.Pandoc.Readers.DokuWiki [API change], and adds `dokuwiki`
3235 as an input format.
3237 * Implement task lists (#3051, Mauro Bieg). Added `task_lists`
3238 extension. Task lists are supported from markdown and gfm input.
3239 They should work, to some degree, in all output formats, though in
3240 most formats you'll get a bullet list with a unicode character for
3241 the box. In HTML, you get checkboxes and in LaTeX/PDF output, a
3242 box is used as the list marker. API changes:
3244 + Added constructor `Ext_task_lists` to `Extension`.
3245 + Added `taskListItemFromAscii` and `taskListItemToAscii` to
3246 Text.Pandoc.Shared.
3248 * Allow some command line options to take URL in addition to FILE.
3249 `--include-in-header`, `--include-before-body`, `--include-after-body`.
3251 * HTML reader:
3253 + Handle empty `start` attribute (see #5162).
3254 + Treat `textarea` as a verbatim environment (#5241) and preserve
3255 spacing.
3257 * RST reader:
3259 + Change treatment of `number-lines` directive (Brian Leung,
3260 #5207). Directives of this type without numeric inputs should
3261 not have a `startFrom` attribute; with a blank value, the
3262 writers can produce extra whitespace.
3263 + Removed superfluous `sourceCode` class on code blocks (#5047).
3264 + Handle `sourcecode` directive as synonynm for `code` (#5204).
3266 * Markdown reader:
3268 + Remove `sourceCode` class for literate Haskell code blocks
3269 (#5047). Reverse order of `literate` and `haskell` classes on
3270 code blocks when parsing literate Haskell, so `haskell` is
3271 first.
3272 + Treat `<textarea>` as a verbatim environment (#5241).
3274 * Org reader:
3276 + Handle `minlevel` option differently (#5190, Brian Leung).
3277 When `minlevel` exceeds the original minimum level observed in
3278 the file to be included, every heading should be shifted
3279 rightward.
3280 + Allow for case of `:minlevel == 0` (#5190).
3281 + Fix treatment of links to images (#5191, Albert Krewinkel).
3282 Links with descriptions which are pointing to images are no
3283 longer parsed as inline images, but as links.
3284 + Add support for #+SELECT_TAGS (Brian Leung).
3285 + Separate filtering logic from conversion function (Brian Leung).
3287 * TWiki reader: Fix performance issue with underscores (#3921).
3289 * MediaWiki reader: use `_` instead of `-` in auto-identifiers (#4731).
3290 We may not still be exactly matching mediawiki's algorithm.
3292 * LaTeX reader:
3294 + Remove `sourceCode` class for literate Haskell code blocks
3295 (#5047). Reverse order of `literate` and `haskell` classes on
3296 code blocks when parsing literate Haskell, so `haskell` is
3297 first.
3298 + Support `\DeclareMathOperator` (#5149).
3299 + Support `\inputminted` (#5103).
3300 + Support `\endinput` (#5233).
3301 + Allow includes with dots like `cc_by_4.0`. Previously the `.0`
3302 was interpreted as a file extension, leading pandoc not to add
3303 `.tex` (and thus not to find the file). The new behavior matches
3304 tex more closely.
3306 * Man reader:
3308 + Use `mapLeft` from Shared instead of defining own.
3310 * Docx reader (Jesse Rosenthal):
3312 + Handle level overrides (#5134).
3314 * Docx writer:
3316 + Support custom properties (#3024, #5252, Agustín Martín Barbero).
3317 Also supports additional core properties: `subject`, `lang`,
3318 `category`, `description`.
3319 + Make Level into a real type, instead of an alias for a tuple
3320 (Jesse Rosenthal).
3322 * ICML writer (Mauro Bieg):
3324 + Support custom-styles (#5137, see #2106).
3325 + Support unnumbered headers (#5140).
3327 * Texinfo writer: Use header identifier for anchor if present (#4731).
3328 Previously we were overwriting an existing identifier with a new one.
3330 * Org writer: Preserve line-numbering for example and code blocks
3331 (Brian Leung).
3333 * Man/Ms writers: Don't escape `-` as `\-`. The `\-` gets rendered
3334 in HTML and PDF as a unicode minus sign.
3336 * Ms writer: Ensure we have a newline after .EN in disply math (#5251).
3338 * RST writer: Don't wrap simple table header lines (#5128).
3340 * Asciidoc writer: Shorter delimiters for tables, blockquotes
3341 (#4364). This matches asciidoctor reference docs.
3343 * Dokuwiki writer: Remove automatic `:` prefix before internal image
3344 links (#5183, Damien Clochard). This prevented users from making
3345 relative image links.
3347 * Zimwiki writer: remove automatic colon prefix before internal
3348 images (#5183, Damien Clochard).
3350 * MediaWiki writer: fix caption, use 'thumb' instead of 'frame'
3351 (#5105). Captions used to have the word 'caption' prepended; this
3352 has been removed. Also, 'thumb' is used instead of 'frame' to
3353 allow images to be resized.
3355 * reveal.js writer:
3357 + Ensure that we don't get > 2 levels of section nesting,
3358 even with slide level > 2 (#5168).
3359 + If slide level == N but there is no N-level header, make
3360 sure the next header with level > N gets treated as a slide
3361 and put in a section, rather than remaining loose (#5168).
3363 * Markdown writer:
3365 + Make `plain` RawBlocks pass through in `plain` output.
3366 + Include needed whitespace after HTML figure (#5121).
3367 We use HTML for a figure in markdown dialects that can't
3368 represent it natively.
3370 * Commonmark writer:
3372 + Fix handling of SoftBreak with `hard_line_breaks` (#5195).
3373 + Implement `--toc` (`writerTableOfContents`)
3374 in commonmark/gfm writers (#5172).
3376 * EPUB writer:
3378 + Ensure that picture transforms are done on metadata too.
3379 + Small fixes to `nav.xhtml`:
3380 Add 'landmarks' id attribute to the landmarks nav.
3381 Replace old default CSS removing numbers from ol.toc li
3382 with new rules that match `nav#toc ol, nav#landmarks ol`.
3383 We keep the `toc` class on `ol` for backwards compatibility.
3385 * LaTeX writer:
3387 + Make raw content marked `beamer` pass through in `beamer`
3388 output (pandoc/lua-filters#40).
3389 + Beamer: avoid duplicated `fragile` property in some cases
3390 (#5208).
3391 + Add `#` special characters for listings (#4939).
3392 This character needs special handling in `\lstinline`.
3394 * RTF writer: use `toTableOfContents` from Shared to replace
3395 old duplicated code.
3397 * Pptx writer:
3399 + Support custom properties. Also supports additional core
3400 properties: `subject`, `category`, `description` (#5252,
3401 Agustín Martín Barbero).
3402 + Use `toTableOfContents` from Shared to replace old duplicated code.
3404 * ODT writer (Augustín Martín Barbero):
3406 + Fix typo in custom properties (#2839).
3407 + Improve standard properties, including the following core
3408 properties: `generator` (Pandoc/VERSION), `description`, `subject`,
3409 `keywords`, `initial-creator` (from authors), `creation-date`
3410 (actual creation date) (#5252).
3412 * Custom writers:
3414 + Allow '-' in filenames for custom lua writers (#5187).
3415 + sample.lua: add `SingleQuoted`, `DoubleQuoted` (#5104).
3416 + sample.lua: Add a missing `>` (MichaWiedenmann).
3418 * reveal.js template: Add `zoomKey` config (#4249).
3420 * HTML5 template: Remove unnecessary type="text/css" on style and
3421 link for HTML5 (#5146).
3423 * LaTeX template (Andrew Dunning, except where noted):
3425 + Prevent fontspec from scaling `mainfont` to match the default
3426 font, Latin Modern. A main font set to 12pt could
3427 previously appear between 11pt to 13pt depending on its design.
3428 To return to the earlier rendering, use `-V
3429 mainfontoptions="Scale=MatchLowercase"` (#5212, #5218).
3430 + Display monospaced fonts without TeX ligatures when using
3431 `--pdf-engine=lualatex`. It now matches the behaviour of other
3432 engines (#5212, #5218).
3433 + Remove the deprecated `romanfont` variable. The functionality of
3434 `mainfont` is identical (#5218).
3435 + Render `\subtitle` with the standard document classes.
3436 Previously, `subtitle` only appeared when using the KOMA-Script
3437 classes or Beamer (#5213, #5244).
3438 + Use Babel instead of Polyglossia for LuaLaTeX. This avoids
3439 several language selection problems, notably with retaining
3440 French spacing conventions when switching to a verbatim
3441 environment or another language; and in printing Greek text
3442 without hyphenation (#5193).
3443 + Use the [`xurl`](https://ctan.org/pkg/xurl) package if
3444 available, improving the appearance of URLs by allowing them to
3445 break at additional points (#5193).
3446 + Use [`bookmark`](https://ctan.org/pkg/bookmark) if available
3447 to correct heading levels in PDF bookmarks: see the [KOMA-Script
3448 3.26 release notes](https://komascript.de/release3.26) (#5193).
3449 + Require the [`xcolor`](https://ctan.org/pkg/xcolor) package to
3450 avoid a possible error when using additional packages alongside
3451 footnotes in tables (#5193, closes #4861).
3452 + Remove obsolete `fixltx2e` package, which has no functionality
3453 with TeX Live 2015 or later (#5193).
3454 + Allow multiple `fontfamilies.options` (#5193, closes #5194).
3455 + Restrict `institute` variable to Beamer (#5219).
3456 + Use [`footnotehyper`](https://ctan.org/pkg/footnotehyper)
3457 package if available to make footnotes in tables compatible
3458 with `hyperref` (#5234).
3459 + Number parts and chapters in book classes only if the
3460 `numbersections` variable is set, for consistency with other
3461 output formats. To return to the previous behaviour, use
3462 `-V numbersections -V secnumdepth=0` (#5235).
3463 + Reindent file (#5193).
3464 + Use built-in parskip handling with KOMA-Script classes (#5143, Enno).
3465 + Set default listings language for lua, assembler (#5227, John
3466 MacFarlane). Otherwise we get an error when trying to compile code
3467 with lua or assembler code. To change the default dialect
3468 (currenty 5.3 for lua and x86masm for assembler), you can use
3469 `--include-in-header` to inject something like
3470 `\lstset{defaultdialect=[5.2]Lua}`.
3472 * Text.Pandoc.Readers: Changed types of `readJSON`; it now runs
3473 in an instance of PandocMonad, like the other readers and
3474 writers. [API change]
3476 * Text.Pandoc.Writers: Changed types of `writeJSON`; it now runs
3477 in an instance of PandocMonad, like the other readers and
3478 writers. [API change]
3480 * Text.Pandoc.Error: Added `PandocUTF8DecodingError` constructor
3481 for `PandocError`. [API change]
3483 * Text.Pandoc.Writers.Shared - add `toTableOfContents`. [API change]
3484 This is refactored out from the Markdown writer.
3485 It can be used in other writers to create a table of contents.
3487 * Improve error messages for UTF-8 decoding errors. Now we give
3488 the filename and byte offset (#4765).
3490 * Text.Pandoc.XML: Strip out illegal XML characters in
3491 `escapeXMLString` (#5119).
3493 * Text.Pandoc.Process: update `pipeProcess` (Albert Krewinkel).
3494 The implementation of `pipeProcess` was rewritten to fix sporadic
3495 failures caused by prematurely closed pipes.
3497 * Use `safeRead` instead of `read` everywhere in the code
3498 (John MacFarlane, Mauro Bieg, #5162, #5180).
3500 * Text.Pandoc.SelfContained: Decompress `.svgz` when
3501 converting to `data:` URI (#5163, Alexander Krotov).
3503 * Text.Pandoc.Parsing: Remove unused `HasHeaderMap`
3504 (#5175, Alexander Krotov). [API change]
3506 * Normalize Windows paths to account for change in ghc 8.6 (#5127).
3507 When pandoc is compiled with ghc 8.6, Windows paths are treated
3508 differently, and paths beginning `\\server` no longer work.
3509 This commit rewrites such patsh to `\\?\UNC\server` which works.
3510 The change operates at the level of argument parsing, so it
3511 only affects the command line program.
3513 * Simplify/fix reading of `--metadata` values on command line
3514 to avoid problems relating to hvr/HsYAML#7 (#5177).
3516 * data/pandoc.lua: auto-fix nested constructor arguments (Albert
3517 Krewinkel). Incorrect types to pandoc element constructors are
3518 automatically converted to the correct types when possible. This was
3519 already done for most constructors, but conversions are now also done
3520 for nested types (like lists of lists).
3522 * Removed custom Setup.hs, use build-type: simple. The only thing we
3523 gained from the custom build was automatic installation of the man
3524 page when using 'cabal install'. But custom builds cause problems,
3525 e.g., with cross-compilation. Installation of the man page is
3526 better handled by packagers. Note to packagers (e.g. Debian): it
3527 may be necessary to add a step installing the man page with the
3528 next release.
3530 * Allow latest http-client, tasty, zip-archive, Glob.
3532 * Require skylighting >= 0.7.5, adding support for sml, J,
3533 typescript.
3535 * Tests: Cleaned up `findPandoc` in `Tests.Helpers`, so it
3536 works well with cabal v2.
3538 * INSTALL.md:
3540 + Use button for installer links (John MacFarlane, Mauro Bieg,
3541 #5167).
3542 + Fix links and bump required stack version (max).
3543 + Improve installation notes on associated software (Andrew
3544 Dunning). Includes explanation of how to install related tools
3545 with package managers (since the method of installing
3546 `rsvg-convert` is not obvious).
3548 * doc/org.md: improve documentation of org features (Albert
3549 Krewinkel).
3551 * doc/lua-filters.md: use 3rd level headers for module fields.
3553 * MANUAL:
3555 + Clarify automatic identifiers (#5201). We remove
3556 non-alphanumerics. This includes, e.g., emojis.
3557 + Fix example for Div with id (Geoffrey Ely).
3558 + Update list of LaTeX packages used.
3559 + Make it clear that `hard_line_breaks` works in `gfm` (see #5195).
3560 + Mention `raw_attribute` in documentation for `raw_html` and
3561 `raw_tex` (#5240, thanks to @eiro).
3562 + Clarify that `$sep$` must come right before `$endfor$` in templates
3563 (#5243, Lev Givon).
3564 + Document metadata support for docx, odt, pptx writers (Agustín
3565 Martín Barbero).
3566 + Reorganize template variables (#5249, Andrew Dunning).
3567 Add additional headings to categorize variables, and
3568 alphabetize when there is large number; add more examples.
3569 + Document `date-meta` template variable (#5260, Tristan Stenner).
3571 * trypandoc: Fix CSS and viewport.
3573## pandoc 2.5 (2018-11-27)
3575 * Text.Pandoc.App: split into several unexported submodules (Albert
3576 Krewinkel): Text.Pandoc.App.FormatHeuristics,
3577 Text.Pandoc.App.Opt, Text.Pandoc.App.CommandLineOptions,
3578 Text.Pandoc.App.OutputSettings. This is motivated partly by the
3579 desire to reduce recompilations when something is modified,
3580 since App previously depended on virtually every other module.
3582 * Text.Pandoc.Extensions
3584 + Semantically, `gfm_auto_identifiers` is now a modifier of
3585 `auto_identifiers`; for identifiers to be set, `auto_identifiers` must
3586 be turned on, and then the type of identifier produced depends on
3587 `gfm_auto_identifiers` and `ascii_identifiers` are set. Accordingly,
3588 `auto_identifiers` is now added to `githubMarkdownExtensions` (#5057).
3589 + Remove `ascii_identifiers` from `githubMarkdownExtensions`.
3590 GitHub doesn't seem to strip non-ascii characters any more.
3592 * Text.Pandoc.Lua.Module.Utils (Albert Krewinkel)
3594 + Test AST object equality via Haskell (#5092). Equality of Lua
3595 objects representing pandoc AST elements is tested by unmarshalling
3596 the objects and comparing the result in Haskell.
3597 A new function `equals` which performs this test has been added to the
3598 `pandoc.utils` module.
3599 + Improve stringify. Meta value strings (MetaString)
3600 and booleans (MetaBool) are now converted to the literal string and the
3601 lowercase boolean name, respectively. Previously, all values of these
3602 types were converted to the empty string.
3604 * Text.Pandoc.Parsing: Remove Functor and Applicative constraints where Monad
3605 already exists (Alexander Krotov).
3607 * Text.Pandoc.Pretty: Don't render BreakingSpace at end of line
3608 or beginning of line (#5050).
3610 * Text.Pandoc.Readers.Markdown
3612 + Fix parsing of citations, quotes, and underline emphasis
3613 after symbols. Starting with pandoc 2.4, citations, quoted inlines,
3614 and underline emphasis were no longer recognized after certain
3615 symbols, like parentheses (#5099, #5053).
3616 + In pandoc 2.4, a soft break after an abbreviation would be
3617 relocated before it to allow for insertion of a nonbreaking
3618 space after the abbreviation. This behavior is here reverted.
3619 A soft break after an abbreviation will remain, and no nonbreaking
3620 space will be added. Those who care about this issue should take care not
3621 to end lines with an abbreviation, or to insert nonbreaking spaces
3622 manually.
3624 * Text.Pandoc.Readers.FB2: Do not throw error for unknown elements in
3625 `<body>` (Alexander Krotov). Some libraries include custom elements
3626 in their FB2 files.
3628 * Text.Pandoc.Readers.HTML
3630 + Allow `tfoot` before body rows (#5079).
3631 + Parse `<small>` as a Span with class "small" (#5080).
3632 + Allow thead containing a row with `td` rather than `th` (#5014).
3634 * Text.Pandoc.Readers.LaTeX
3636 + Cleaned up handling of dimension arguments. Allow decimal points,
3637 preceding space.
3638 + Don't allow arguments for verbatim, etc.
3639 + Allow space before bracketed options.
3640 + Allow optional arguments after `\\` in tables.
3641 + Improve parsing of `\tiny`, `\scriptsize`, etc. Parse as raw,
3642 but know that these font changing commands take no arguments.
3644 * Text.Pandoc.Readers.Muse
3646 + Trim whitespace before parsing grid table cells (Alexander Krotov).
3647 + Add grid tables support (Alexander Krotov).
3649 * Text.Pandoc.Shared
3651 + For bibliography match Div with id `refs`, not class `references`.
3652 This was a mismatch between pandoc's docx, epub, latex, and markdown
3653 writers and the behavior of pandoc-citeproc, which actually looks for a
3654 div with id `refs` rather than one with class `references`.
3655 + Exactly match GitHub's identifier generating algorithm (#5057).
3656 + Add parameter for `Extensions` to `uniqueIdent` and
3657 `inlineListToIdentifier` (#5057). [API change]
3658 This allows these functions to be sensitive to the settings of
3659 `Ext_gfm_auto_identifiers` and `Ext_ascii_identifiers`, and allows us to
3660 use `uniqueIdent` in the CommonMark reader, replacing custom code. It
3661 also means that `gfm_auto_identifiers` can now be used in all formats.
3663 * Text.Pandoc.Writers.AsciiDoc
3665 + Use `.`+ as list markers to support nested ordered lists (#5087).
3666 + Support list number styles (#5089).
3667 + Render Spans using `[#id .class]#contents#` (#5080).
3669 * Text.Pandoc.Writers.CommonMark
3671 + Respect `--ascii` (#5043, quasicomputational).
3672 + Make sure `--ascii` affects quotes, super/subscript.
3674 * Text.Pandoc.Writers.Docx
3676 + Fix bookmarks to headers with long titles (#5091).
3677 Word has a 40 character limit for bookmark names. In addition, bookmarks
3678 must begin with a letter. Since pandoc's auto-generated identifiers may
3679 not respect these constraints, some internal links did not work. With
3680 this change, pandoc uses a bookmark name based on the SHA1 hash of the
3681 identifier when the identifier isn't a legal bookmark name.
3682 + Add bookmarks to code blocks (Nikolay Yakimov).
3683 + Add bookmarks to images (Nikolay Yakimov).
3684 + Refactor common bookmark creation code into a function (Nikolay Yakimov).
3686 * Text.Pandoc.Writers.EPUB: Handle calibre metadata (#5098).
3687 Nodes of the form
3689 <meta name="calibre:series" content="Classics on War and Politics"/>
3691 are now included from an epub XML metadata file. You can also include
3692 this information in your YAML metadata, like so:
3694 calibre:
3695 series: Classics on War and Policitics
3697 In addition, ibooks-specific metadata can now be included via an XML
3698 file. (Previously, it could only be included via YAML metadata, see
3699 #2693.)
3701 * Text.Pandoc.Writers.HTML: Use plain `"` instead of `&quot;` outside of
3702 attributes.
3704 * Text.Pandoc.Writers.ICML: Consolidate adjacent strings, inc. spaces.
3705 This avoids splitting up the output unnecessarily into separate elements.
3707 * Text.Pandoc.Writers.LaTeX: Don't emit `[<+->]` unless beamer output, even
3708 if `writerIncremental` is True (#5072).
3710 * Text.Pandoc.Writers.Muse (Alexander Krotov).
3712 + Output tables as grid tables if they have multi-line cells.
3713 + Indent simple tables only on the top level.
3714 + Output tables with one column as grid tables.
3715 + Add support for `--reference-location`.
3716 + Internal improvements.
3718 * Text.Pandoc.Writers.OpenDocument: Fix list indentation (Nils Carlson,
3719 #5095). This was a regression in pandoc 2.4.
3721 * Text.Pandoc.Writers.RTF: Fix warnings for skipped raw inlines.
3723 * Text.Pandoc.Writers.Texinfo: Add blank line before `@menu` section (#5055).
3725 * Text.Pandoc.XML: in `toHtml5Entities`, prefer shorter entities
3726 when there are several choices for a particular character.
3728 * data/abbreviations
3730 + Add additional abbreviations (Andrew Dunning)
3731 Many of these borrowed from the Chicago Manual of Style 10.42,
3732 'Scholarly abbreviations'.
3734 * Templates
3736 + Asciidoc template: add :lang: to title header is lang is set in
3737 metadata (#5088).
3739 * pandoc.cabal: Add cabal flag `derive_json_via_th` (Albert Krewinkel)
3740 Disabling the flag will cause derivation of ToJSON and FromJSON
3741 instances via GHC Generics instead of Template Haskell. The flag is
3742 enabled by default, as deriving via Generics can be slow (see #4083).
3744 * trypandoc:
3746 + Tweaked drop-down lists.
3747 + Put link to site in footer.
3748 + Preselect output format.
3749 + Update on change of in or out format.
3750 + Add man input format.
3752 * MANUAL.txt:
3754 + Fix outdated description of latex_macros extension.
3755 + Clarified placement of bibliography.
3756 + Added "A note on security."
3757 + Fix note on curly brace syntx for locators.
3758 + Document new explicit syntax for citeproc locators.
3759 + Remove confusing cross-links for some extensions.
3760 + Don't put pandoc in code ticks in heading.
3761 + Document that `--ascii` works for gfm and commonmark too.
3762 + Add `man` to `--from` options.
3764 * doc/customizing-pandoc.md: various improvements (Mauro Bieg).
3767## pandoc 2.4 (2018-11-03)
3769### New features
3771 * New input format `man` (Yan Pashkovsky, John MacFarlane).
3773### Behavior changes
3775 * `--ascii` is now implemented in the writers, not in Text.Pandoc.App,
3776 via the new `writerPreferAscii` field in `WriterOptions`.
3777 Now the `write*` functions for Docbook, HTML, ICML, JATS, LaTeX,
3778 Ms, Markdown, and OPML are sensitive to `writerPreferAscii`.
3779 Previously the to-ascii translation was done in Text.Pandoc.App,
3780 and thus not available to those using the writer functions
3781 directly.
3783 * `--ascii` now works with Markdown output. HTML5 character reference
3784 entities are used.
3786 * `--ascii` now works with LaTeX output. 100% ASCII output can't be
3787 guaranteed, but the writer will use commands like `\"{a}` and `\l`
3788 whenever possible, to avoid emitting a non-ASCII character.
3790 * For HTML5 output, `--ascii` now uses HTML5 character reference
3791 entities rather than numerical entities.
3793 * Improved detection of format based on extension (in Text.Pandoc.App).
3794 We now ensure that if someone tries to convert a file for a
3795 format that has a pandoc writer but not a reader, it won't just
3796 default to markdown.
3798 * Add viz. to abbreviations file (#5007, Nick Fleisher).
3800 * AsciiDoc writer: always use single-line section headers,
3801 instead of the old underline style (#5038). Previously the single-line
3802 style would be used if `--atx-headers` was specified, but
3803 now it is always used.
3805 * RST writer: Use simple tables when possible (#4750).
3807 * CommonMark (and gfm) writer: Add plain text fallbacks. (#4528,
3808 quasicomputational). Previously, the writer would unconditionally
3809 emit HTML output for subscripts, superscripts, strikeouts (if the
3810 strikeout extension is disabled) and small caps, even with
3811 `raw_html` disabled. Now there are plain-text (and, where
3812 possible, fancy Unicode) fallbacks for all of these corresponding
3813 (mostly) to the Markdown fallbacks, and the HTML output is only
3814 used when `raw_html` is enabled.
3816 * Powerpoint writer: support raw openxml (Jesse Rosenthal, #4976).
3817 This allows raw openxml blocks and inlines to be used in the pptx
3818 writer. Caveats: (1) It's up to the user to write
3819 well-formed openxml. The chances for corruption, especially with
3820 such a brittle format as pptx, is high. (2) Because of
3821 the tricky way that blocks map onto shapes, if you are using
3822 a raw block, it should be the only block on a slide
3823 (otherwise other text might end up overlapping it). (3) The
3824 pptx ooxml namespace abbreviations are different from the
3825 docx ooxml namespaces. Again, it's up to the user to get it
3826 right. Unzipped document and ooxml specification should be
3827 consulted.
3829 * With `--katex` in HTML formats, do not use the autorenderer (#4946).
3830 We no longer surround formulas with `\(..\)` or `\[..\]`. Instead,
3831 we tell katex to convert the contents of span elements with
3832 class "math". Since math has already been identified, this
3833 avoids wasted time parsing for LaTeX delimiters. Note, however,
3834 that this may yield unexpected results if you have span elements
3835 with class "math" that don't contain LaTeX math.
3836 Also, use latest version of KaTeX by default (0.9.0).
3838 * The man writer now produces ASCII-only output, using groff escapes,
3839 for portability.
3841 * ODT writer:
3843 + Add title, author and date to metadata; any remaining
3844 metadata fields are added as `meta:user-defined` tags.
3845 + Implement table caption numbering (#4949, Nils Carlson).
3846 Captioned tables are numbered and labeled with format "Table 1:
3847 caption", where "Table" is replaced by a translation, depending
3848 on the value of `lang` in metadata. Uncaptioned tables are not
3849 enumerated.
3850 + OpenDocument writer: Implement figure numbering in captions (#4944,
3851 Nils Carlson). Figure captions are now numbered 1, 2, 3, ...
3852 The format in the caption is "Figure 1: caption" and so on
3853 (where "Figure" is replaced by a translation, depending on the
3854 value of `lang` in the metadata). Captioned figures are numbered
3855 consecutively and uncaptioned figures are not enumerated. This
3856 is necessary in order for LibreOffice to generate an
3857 Illustration Index (Table of Figures) for included figures.
3859 * RST reader: Pass through fields in unknown directives as div attributes
3860 (#4715). Support `class` and `name` attributes for all directives.
3862 * Org reader: Add partial support for `#+EXCLUDE_TAGS` option. (#4284,
3863 Brian Leung). Headers with the corresponding tags should not
3864 appear in the output.
3866 * Log warnings about missing title attributes now include a
3867 suggestion about how to fix the problem (#4909).
3869 * Lua filter changes (Albert Krewinkel):
3871 + Report traceback when an error occurs. A proper Lua traceback is
3872 added if either loading of a file or execution of a filter
3873 function fails. This should be of help to authors of Lua filters
3874 who need to debug their code.
3876 + Allow access to pandoc state (#5015). Lua filters and custom
3877 writers now have read-only access to most fields of pandoc's
3878 internal state via the global variable `PANDOC_STATE`.
3880 + Push ListAttributes via constructor (Albert Krewinkel).
3881 This ensures that ListAttributes, as present in OrderedList elements,
3882 have additional accessors (viz. `start`, `style`, and `delimiter`).
3884 + Rename ReaderOptions fields, use snake_case. Snake case is used
3885 in most variable names, using camelCase for these fields was an
3886 oversight. A metatable is added to ensure that the old field
3887 names remain functional.
3889 + Iterate over AST element fields when using `pairs`. This makes
3890 it possible to iterate over all ield names of an AST element by
3891 using a generic `for` loop with pairs`:
3893 for field_name, field_content in pairs(element) do
3894 ...
3895 end
3897 Raw table fields of AST elements should be considered an
3898 implementation detail and might change in the future. Accessing
3899 element properties should always happen through the fields
3900 listed in the Lua filter docs.
3902 Note that the iterator currently excludes the `t`/`tag` field.
3904 + Ensure that MetaList elements behave like Lists. Methods usable
3905 on Lists can also be used on MetaList objects.
3907 + Fix MetaList constructor (Albert Krewinkel). Passing a MetaList
3908 object to the constructor `pandoc.MetaList` now returns the
3909 passed list as a MetaList. This is consistent with the
3910 constructor behavior when passed an (untagged) list.
3912 * Custom writers: Custom writers have access to the global variable
3913 `PANDOC_DOCUMENT`(Albert Krewinkel, #4957). The variable contains
3914 a userdata wrapper around the full pandoc AST and exposes two
3915 fields, `meta` and `blocks`. The field content is only
3916 marshaled on-demand, performance of scripts not accessing the
3917 fields remains unaffected.
3919### API changes
3921 * Text.Pandoc.Options: add `writerPreferAscii` to `WriterOptions`.
3923 * Text.Pandoc.Shared:
3925 + Export `splitSentences`. This was previously duplicated in the Man and
3926 Ms writers.
3927 + Add `ToString` typeclass (Alexander Krotov).
3929 * New exported module Text.Pandoc.Filter (Albert Krewinkel).
3931 * Text.Pandoc.Parsing
3933 + Generalize `gridTableWith` to any `Char` Stream (Alexander Krotov).
3934 + Generalize `readWithM` from `[Char]` to any `Char` Stream
3935 that is a `ToString` instance (Alexander Krotov).
3937 * New exposed module Text.Pandoc.Filter (Albert Krewinkel).
3939 * Text.Pandoc.XML: add `toHtml5Entities`.
3941 * New exported module Text.Pandoc.Readers.Man (Yan Pashkovsky, John
3942 MacFarlane).
3944 * Text.Pandoc.Writers.Shared
3946 + Add exported functions `toSuperscript` and
3947 `toSubscript` (quasicomputational, #4528).
3948 + Remove exported functions `metaValueToInlines`,
3949 `metaValueToString`. Add new exported functions
3950 `lookupMetaBool`, `lookupMetaBlocks`, `lookupMetaInlines`,
3951 `lookupMetaString`. Use these whenever possible for uniformity
3952 in writers (Mauro Bieg, #4907). (Note that
3953 removed function `metaValueToInlines` was in previous
3954 released versions.)
3955 + Add `metaValueToString`.
3957 * Text.Pandoc.Lua
3959 + Expose more useful internals (Albert Krewinkel):
3961 - `runFilterFile` to run a Lua filter from file;
3962 - data type `Global` and its constructors; and
3963 - `setGlobals` to add globals to a Lua environment.
3965 This module also contains `Pushable` and `Peekable` instances
3966 required to get pandoc's data types to and from Lua. Low-level
3967 Lua operation remain hidden in Text.Pandoc.Lua.
3969 + Rename `runPandocLua` to `runLua` (Albert Krewinkel).
3971 + Remove `runLuaFilter`, merging this into Text.Pandoc.Filter.Lua's
3972 `apply` (Albert Krewinkel).
3974### Bug fixes and under-the-hood improvements
3976 * Text.Pandoc.Parsing
3978 + Make `uri` accept any stream with Char tokens (Alexander Krotov).
3979 + Rewrite `uri` without `withRaw` (Alexander Krotov).
3980 + Generalize `parseFromString` and `parseFromString'` to any
3981 streams with Char token (Alexander Krotov)
3982 + Rewrite `nonspaceChar` using `noneOf` (Alexander Krotov)
3984 * Text.Pandoc.Shared: Reimplement `mapLeft` using `Bifunctor.first`
3985 (Alexander Krotov).
3987 * Text.Pandoc.Pretty: Simplify `Text.Pandoc.Pretty.offset`
3988 (Alexander Krotov).
3990 * Text.Pandoc.App
3992 + Work around HXT limitation for --syntax-definition with windows
3993 drive (#4836).
3994 + Always preserve tabs for man format. We need it for tables.
3995 + Split command line parsing code into a separate unexported
3996 module, Text.Pandoc.App.CommandLineOptions (Albert Krewinkel).
3998 * Text.Pandoc.Readers.Roff: new unexported module for tokenizing
3999 roff documents.
4001 * New unexported module Text.Pandoc.RoffChar, provided character
4002 escape tables for roff formats.
4004 * Text.Pandoc.Readers.HTML: Fix `htmlTag` and `isInlineTag` to
4005 accept processing instructions (#3123, regression since 2.0).
4007 * Text.Pandoc.Readers.JATS: Use `foldl'` instead of `maximum` to
4008 account for empty lists (Alexander Krotov).
4010 * Text.Pandoc.Readers.RST: Don't allow single-dash separator in
4011 headerless table (#4382).
4013 * Text.Pandoc.Readers.Org: Parse empty argument array in inline src
4014 blocks (Brian Leung).
4016 * Text.Pandoc.Readers.Vimwiki:
4018 + Get rid of `F`, `runF` and `stateMeta'` in favor of `stateMeta`
4019 (Alexander Krotov).
4020 + Parse `Text` without converting to `[Char]` (Alexander Krotov).
4022 * Text.Pandoc.Readers.Creole: Parse `Text` without converting to
4023 `[Char]` (Alexander Krotov).
4025 * Text.Pandoc.Readers.LaTeX
4027 + Allow space at end of math after `\` (#5010).
4028 + Add support for `nolinkurl` command (#4992, Brian Leung).
4029 + Simplified type on `doMacros'`.
4030 + Tokenize before pulling tokens, rather than after (#4408). This
4031 has some performance penalty but is more reliable.
4032 + Make macroDef polymorphic and allow in inline context.
4033 Otherwise we can't parse something like `\lowercase{\def\x{Foo}}`.
4034 I have actually seen tex like this in the wild.
4035 + Improved parsing of `\def`, `\let`. We now correctly parse:
4036 ```
4037 \def\bar{hello}
4038 \let\fooi\bar
4039 \def\fooii{\bar}
4040 \fooi +\fooii
4042 \def\bar{goodbye}
4043 \fooi +\fooii
4044 ```
4045 + Improve parsing of `\def` argspec.
4046 + Skip `\PackageError` commands (see #4408).
4047 + Fix bugs omitting raw tex (#4527). The default is `-raw_tex`,
4048 so no raw tex should result unless we explicitly say `+raw_tex`.
4049 Previously some raw commands did make it through.
4050 + Moved `isArgTok` to Text.Pandoc.Readers.LaTeX.Parsing.
4051 + Moved `babelLangToBCP`, `polyglossiaLangToBCP` to new module,
4052 Text.Pandoc.Readers.LaTeX.Lang (unexported).
4053 + Simplified accent code using unicode-transforms.
4054 New dependency on unicode-transforms package for normalization.
4055 + Allow verbatim blocks ending with blank lines (#4624).
4056 + Support `breq` math environments: `dmath`, `dgroup`, `darray`.
4057 This collects some of the general-purpose code from the LaTeX reader,
4058 with the aim of making the module smaller.
4060 * Text.Pandoc.Readers.Markdown
4062 + Fix awkward soft break movements before abbreviations (#4635).
4063 + Add updateStrPos in a couple places where needed.
4065 * Text.Pandoc.Readers.Docx: Trigger bold/italic with bCs, iCs
4066 (#4947). These are variants for "complex scripts" like Arabic
4067 and are now treated just like b, i (bold, italic).
4069 * Text.Pandoc.Readers.Muse (Alexander Krotov)
4071 + Try to parse lists before trying to parse table.
4072 This ensures that tables inside lists are parsed correctly.
4073 + Forbid whitespace after opening and before closing markup
4074 elements.
4075 + Parse page breaks.
4076 + Simplify `museToPandocTable` to get rid of partial functions.
4077 + Allow footnotes to start with empty line.
4078 + Make sure that the whole text is parsed.
4079 + Allow empty headers. Previously empty headers caused parser to
4080 terminate without parsing the rest of the document.
4081 + Allow examples to be indented with tabs.
4082 + Remove indentation from examples indicated by `{{{` and `}}}`.
4083 + Fix parsing of empty cells.
4084 + Various changes to internals.
4085 + Rewrite some parsers in applicative style.
4086 + Avoid tagsoup dependency.
4087 + Allow table caption to contain `+`.
4089 * Text.Pandoc.Writers.LaTeX
4091 + Add newline if math ends in a comment (#4880). This prevents the
4092 closing delimiter from being swalled up in the comment.
4093 + With `--listings`, don't pass through org-babel attributes (#4889).
4094 + With `--biblatex`, use `\autocite` when possible (#4960).
4095 `\autocites{a1}{a2}{a3}` will not collapse the entries. So, if
4096 we don't have prefixes and suffixes, we use instead
4097 `\autocite{a1,a2,a3}`.
4098 + Fix description lists contining highlighted code (#4662).
4100 * Text.Pandoc.Writers.Man
4102 + Don't wrap `.SH` and `.SS` lines (#5019).
4103 + Avoid unnecessary `.RS`/`.RE` pair in definition lists with
4104 one paragraph definitions.
4105 + Moved common groff functions to Text.Pandoc.Writers.Groff.
4106 * Fix strong/code combination on man (should be `\f[CB]` not
4107 `\f[BC]`, see #4973).
4108 + Man writer: use `\f[R]` instead of `\f[]` to reset font
4109 (Alexander Krotov, #4973).
4110 + Move `splitSentences` to Text.Pandoc.Shared.
4112 * Text.Pandoc.Writers.Docx
4114 + Add framework for custom properties (#3034). So far, we don't
4115 actually write any custom properties, but we have the
4116 infrastructure to add this.
4118 + Handle tables in table cells (#4953). Although this is not
4119 documented in the spec, some versions of Word require a `w:p`
4120 element inside every table cell. Thus, we add one when the
4121 contents of a cell do not already include one (e.g. when a table
4122 cell contains a table).
4124 * Text.Pandoc.Writers.AsciiDoc: Prevent illegal nestings.
4125 Adjust header levels so that n+1 level headers are only
4126 found under n level headers, and the top level is 1.
4128 * Text.Pandoc.Writers.OpenDocument: Improve bullet/numbering
4129 alignment (#4385). This change eliminates the large gap we used
4130 to have between bullet and text, and also ensures that numbers
4131 in numbered lists will be right-aligned.
4133 * Text.Pandoc.Writers.ZimWiki
4135 + Number ordered list items sequentially, rather than always
4136 with 1 (#4962).
4137 + Remove extra indentation on lists (#4963).
4139 * Text.Pandoc.Writers.EPUB: Use metadata field `css` instead of
4140 `stylesheet` (Mauro Bieg, #4990).
4142 * Text.Pandoc.Writers.Markdown: Ensure blank between raw block and
4143 normal content (#4629). Otherwise a raw block can prevent a
4144 paragraph from being recognized as such.
4146 * Text.Pandoc.Writers.Ms
4148 + Removed old `escapeBar`. We don't need this now that we use
4149 `@` for math delim.
4150 + Moved common code to Text.Pandoc.Writers.Roff and to
4151 Text.Pandoc.RoffChar.
4152 + Move `splitSentences` to Text.Pandoc.Shared (to avoid duplication
4153 with the man writer).
4155 * Text.Pandoc.Writers.Muse (Alexander Krotov).
4157 + Add support for grid tables.
4158 + Fix Muse writer style.
4159 + Use `length` instead of `realLength` to calculate definition
4160 indentation. Muse parsers don't take character width into
4161 account when calculating indentation.
4162 + Do not insert newline before lists.
4163 + Use lightweight markup after `</em>` tag.
4165 * New unexported module Text.Pandoc.Writers.Roff, providing functions
4166 useful for all roff format writers (man, ms).
4168 * Text.Pandoc.Lua
4170 + Move globals handling to separate module Text.Pandoc.Lua.Global
4171 (Albert Krewinkel).
4173 + Lua filter internals: push Shared.Element as userdata (Albert
4174 Krewinkel). Hierarchical Elements were pushed to Lua as plain
4175 tables. This is simple, but has the disadvantage that marshaling
4176 is eager: all child elements will be marshaled as part of the
4177 object. Using a Lua userdata object instead allows lazy access
4178 to fields, causing content marshaling just (but also each time)
4179 when a field is accessed. Filters which do not traverse the full
4180 element contents tree become faster as a result.
4182### Default template changes
4184 * LaTeX template:
4186 + Add variable `hyperrefoptions` (#4925, Mathias Walter).
4187 + Add variable `romanfont`, `romanfontoptions` (#4665, OvidiusCicero).
4189 * AsciiDoc template: use single-line style for title.
4191 * revealjs template: Fix typo in the socket.io javascript plugin (#5006,
4192 Yoan Blanc).
4194 * Text.Pandoc.Lua.Util: add missing docstring to `defineHowTo`
4195 (Albert Krewinkel).
4197 * data/pandoc.lua: add datatype ListAttributes (Albert Krewinkel)
4199 * data/sample.lua: replace custom pipe function with pandoc.utils.pipe
4200 (Albert Krewinkel).
4202### Documentation improvements
4204 * INSTALL.md
4206 + Add chromeos install instructions (#4958) (Evan Pratten).
4207 + Add note about TinyTeX.
4209 * MANUAL.txt
4211 + Change `groff` -> `roff`.
4212 + Implement `--ascii` for Markdown writer.
4213 + Clarify LaTeX image dimensions output (Mauro Bieg).
4215 * doc/customizing-pandoc.md: added skeleton (Mauro Bieg, #3288).
4217 * doc/getting-started.md: Added title to test1.md to avoid warning.
4219 * doc/lua-filters.md: merge type references into main document,
4220 fix description of Code.text (Albert Krewinkel).
4222### Build infrastructure improvements
4224 * Makefile
4226 + Makefile: added quick-cabal, full-cabal targets.
4227 + Make .msi download targets insensitive to order of appveyor builds.
4229 * Update benchmarks for ghc 8.6.1.
4231 * pandoc.cabal:
4233 + Enable more compiler warnings (Albert Krewinkel).
4234 + Make base lower bound 4.8.
4235 + Bump upper bound for QuickCheck.
4236 + Bump upper bound for binary.
4237 + Updated version bounds for containers and haddock-library (#4974).
4238 + Added docx/docPropos/custom.xml to cabal data-files.
4239 + Require skylighting 0.7.4 (#4920).
4240 + New dependency on unicode-transforms package for normalization.
4242 * Improved .travis.yml testing and test with GHC 8.6.1 (Albert Krewinkel).
4244 * Added `tools/changelog-helper.sh`.
4246 * Added test/grofftest.sh for testing the man reader on real man pages.
4248## pandoc 2.3.1 (2018-09-28)
4250 * RST reader:
4252 + Parse RST inlines containing newlines (#4912, Francesco Occhipinti).
4253 This eliminates a regression introduced after pandoc 2.1.1, which
4254 caused inline constructions containing newlines not to be recognized.
4255 + Fix bug with internal link targets (#4919). They were gobbling up
4256 indented content underneath.
4258 * Markdown reader: distinguish autolinks in the AST. With this change,
4259 autolinks are parsed as Links with the `uri` class. (The same is true
4260 for bare links, if the `autolink_bare_uris` extension is enabled.)
4261 Email autolinks are parsed as Links with the `email` class. This
4262 allows the distinction to be represented in the AST.
4264 * Org reader:
4266 + Force inline code blocks to honor export options (Brian Leung).
4267 + Parse empty argument array in inline src blocks (Brian Leung).
4269 * Muse reader (Alexander Krotov):
4271 + Added additional tests.
4272 + Do not allow code markup to be followed by digit.
4273 + Remove heading level limit.
4274 + Simplify `<literal>` tag parsers
4275 + Parse Text instead of String. Benchmark shows 7% improvement.
4276 + Get rid of HTML parser dependency.
4277 + Various code improvements.
4279 * ConTeXt writer: change `\` to `/` in Windows image paths (#4918).
4280 We do this in the LaTeX writer, and it avoids problems.
4281 Note that `/` works as a LaTeX path separator on Windows.
4283 * LaTeX writer:
4285 + Add support for multiprenote and multipostnote arguments
4286 with `--biblatex` (Brian Leung, #4930). The multiprenotes occur before
4287 the first prefix of a multicite, and the multipostnotes follow the
4288 last suffix.
4289 + Fix a use of `last` that might take empty list. If you ran with
4290 `--biblatex` and have an empty document (metadata but no blocks),
4291 pandoc would previously raise an error because of the use of
4292 `last` on an empty list.
4294 * RTF writer: Fix build failure with ghc-8.6.1 caused by missing
4295 MonadFail instance (Jonas Scholl).
4297 * ODT Writer: Improve table header row style handling (Nils Carlson).
4298 This changes the way styles for cells in the header row
4299 and normal rows are handled in ODT tables.
4300 Previously a new (but identical) style was generated for
4301 every table, specifying the style of the cells within the table.
4302 After this change there are two style definitions for table cells,
4303 one for the cells in the header row, one for all other cells.
4304 This doesn't change the actual styles, but makes post-processing
4305 changes to the table styles much simpler as it is no longer
4306 necessary to introduce new styles for header rows and there are
4307 now only two styles where there was previously one per table.
4309 * HTML writer:
4311 + Don't add `uri` class to presumed autolinks. Formerly the `uri`
4312 class was added to autolinks by the HTML writer, but it had to
4313 guess what was an autolink and could not distinguish
4314 `[http://example.com](http://example.com)` from
4315 `<http://example.com>`. It also incorrectly recognized
4316 `[pandoc](pandoc)` as an autolink. Now the HTML writer
4317 simply passes through the `uri` attribute if it is present,
4318 but does not add anything.
4319 + Avoid adding extra section nestings for revealjs.
4320 Previously revealjs title slides at level (slidelevel - 1)
4321 were nested under an extra section element, even when
4322 the section contained no additional (vertical) content.
4323 That caused problems for some transition effects.
4324 + Omit unknown attributes in EPUB2 output. For example,
4325 `epub:type` attributes should not be passed through,
4326 or the epub produced will not validate.
4328 * JATS writer: remove 'role' attribute on 'bold' and 'sc' elements (#4937).
4329 The JATS spec does not allow these.
4331 * Textile writer: don't represent `uri` class explicitly
4332 for autolinks (#4913).
4334 * Lua filters (Albert Krewinkel):
4336 + Cleanup filter execution code.
4337 + Better error on test failure.
4339 * HTML, Muse reader tests: reduce time taken by round-trip test.
4341 * Added cabal.project.
4343 * MANUAL: `epub:type` is only useful for epub3 (Maura Bieg).
4345 * Use hslua v1.0.0 (Albert Krewinkel).
4347 * Fix `translations/ru` to use modern Russian orthography
4348 (Ivan Trubach).
4350 * Build Windows binary using ghc 8.6.1 and cabal new-build. This
4351 fixes issues with segfaults in the 32-bit Windows binaries (#4283).
4353## pandoc 2.3 (2018-09-16)
4355 * Add `--metadata-file` option (Mauro Bieg, #1960), which allows
4356 users to specify metadata in a YAML file, regardless of the
4357 input format (#1960).
4359 * Text.Pandoc.Writers.Shared: export `isDisplayMath` (API change).
4361 * Text.Pandoc.Readers.Markdown: export `yamlToMeta` (API change,
4362 Mauro Bieg).
4364 * Text.Pandoc.Readers.LaTeX.Types:
4366 + New type `ArgSpec` (API change).
4367 + Second parameter of `Macro` constructor is now `[ArgSpec]` instead of
4368 `Int` (API change).
4370 * Markdown reader:
4372 + Use `tex` instead of `latex` for raw tex-ish content. We can't
4373 always tell if it's LaTeX, ConTeXt, or plain TeX. Better just to
4374 use `tex` always. Note that if `context` or `latex` specifically
4375 is desired, you can still force that in a markdown document by
4376 using the raw attribute. Note that this change may affect some
4377 filters, if they assume that raw tex parsed by the Markdown reader
4378 will be RawBlock (Format `latex`). In most cases it should be
4379 trivial to modify the filters to accept `tex` as well.
4380 + Refactor and reorganize YAML code (Mauro Bieg).
4381 + Make `example_lists` work for interrupted lists
4382 without `startnum` (#4908).
4384 * HTML reader:
4386 + Parse `<script type="math/tex` tags as math (#4877).
4387 These are used by MathJax in some configurations.
4388 + Extract spaces inside links instead of trimming them
4389 (Alexander Krotov, #4845).
4390 + Added round-trip tests (Alexander Krotov).
4391 + Make parsing sensitive to the `raw_tex` extension (#1126). This now
4392 allows raw LaTeX environments, `\ref`, and `\eqref` to be parsed
4393 (which is helpful for translation HTML documents using MathJaX).
4395 * Org reader (Albert Krewinkel):
4397 + Respect export option `p` for planning info. Inclusion of planning info
4398 (`*DEADLINE*`, `*SCHEDULED*`, and `*CLOSED*`) can be controlled via the
4399 `p` export option: setting the option to `t` will add all planning
4400 information in a *Plain* block below the respective headline.
4401 + Org reader internals: don't rely on RecordWildCards and ViewPatterns
4402 ghc extensions.
4403 + Strip planning info from output. Planning info is parsed, but not
4404 included in the output (as is the default with Emacs Org-mode, #4867).
4406 * LaTeX reader:
4408 + Handle parameter patterns for `\def` (#4768, #4771).
4409 For example: `\def\foo#1[#2]{#1 and #2}`.
4410 + Allow `%` characters in URLs. This affects `\href` and `\url` (#4832).
4411 + Fixed parsing of `\texorpdfstring`. We were returning the wrong
4412 argument as the content.
4413 + Support `blockcquote`, `foreignblockquote`, `foreigncblockquote`,
4414 `hyphenblockquote`, `hyphencblockquote`, `enquote*`, `foreignquote`,
4415 `hyphenquote` from `csquotes` (#4848). Note that `foreignquote`
4416 will be parsed as a regular Quoted inline (not using the quotes
4417 appropriate to the foreign language).
4418 + Support more text-mode accents (#4652). Add support for `\|`, `\b`, `\G`,
4419 `\h`, `\d`, `\f`, `\r`, `\t`, `\U`, `\i`, `\j`, `\newtie`,
4420 `\textcircled`. Also fall back to combining characters when composed
4421 characters are not available.
4422 + Resolve `\ref` for figure numbers.
4423 + Support `mintinline` (#4365, Marc Schreiber).
4424 + Fix siunitx unit commands so they are only recognized in
4425 siunitx contexts (#4842). For example, `\l` outside of an
4426 siunitx context should be l-slash, not l (for liter).
4427 + Fix double `unnumbered` class (#4838). The `unnumbered` class
4428 was being included twice for starred sections.
4430 * RST reader: Don't skip link definitions after comments (#4860).
4432 * Muse reader (Alexander Krotov):
4434 + Close the `</quote>` in indented tag test.
4435 There is already a separate test for unclosed `</quote>`.
4436 + Autonumber sections in the correct order. Parsing now stops
4437 at each section header to ensure the header is registered before
4438 parsing of the next section starts.
4439 + Move duplicate code into `headingStart` function.
4440 + Allow newline after opening `*` or `**`.
4441 + Don't allow digits after closing marker in lightweight markup
4442 This change makes reader more compatible with Emacs Muse.
4443 + Parse `<verse>` tag in one pass instead of using
4444 `parseFromString`. This change makes it possible to have
4445 verbatim `</verse>` tag inside verse.
4447 * ODT reader: deal gracefully with missing `<office:font-face-decls/>`
4448 (#4336). This allows pandoc to parse ODT document produced by KDE's
4449 Calligra.
4451 * Muse writer (Alexander Krotov):
4453 + Output headers without asterisks if not on the top level.
4454 + Never wrap definition list terms.
4455 + Set `envInsideBlock = True` when rendering notes.
4456 + Use `""` instead of `[]` for empty String.
4457 + Check for whitespace in the beginning and end of Str's.
4458 + Escape `-`, `;` and `>` in the beginning of strings.
4459 + Escape list markers in the beginning of notes.
4460 + Normalize inline list before testing if tags should be used.
4461 + Use tags instead of lightweight markup for empty strings.
4462 + Use lightweight markup when possible.
4463 + Escape empty strings. This guarantees that `conditionalEscapeString`
4464 never returns empty string.
4465 + Wrap conditionalEscapeString result into `Muse` type.
4466 This removes the need to pass `envInsideLinkDescription` to it.
4467 + Separate `shouldEscapeString` function.
4468 + Simplify inline list rendering.
4469 + Replace newlines in strings with spaces.
4471 * Docx writer:
4473 + Add MetaString case for abstract, subtitle (#4900, Mauro Bieg).
4474 + Properly handle display math in spans (#4826). This isn't a
4475 complete solution, since other nestings of display math may still
4476 cause problems, but it should work for what is by far the most
4477 common case.
4479 * HTML writer:
4481 + Always output `<dt>` element, even if it is empty (#4883,
4482 Alexander Krotov).
4483 + Don't prefix `epub:` attributes with `data-`.
4485 * Org writer: Don't escape literal `_`, `^` (#4882). Org doesn't
4486 recognize these escapes.
4488 * ODT writer: Fix percentage image scaling (#4881, Nils Carlson).
4489 Image scaling was broken when a width was set to a percentage.
4491 * EPUB writer: set `epub:type` on body element in each chapter,
4492 depending on the `epub:type` of the first section (#4823). This
4493 only affects epub3. See
4494 http://www.idpf.org/epub/profiles/edu/structure/#h.l0bzsloklt10
4496 * FB2 writer: put `coverpage` element between title and date rather than in
4497 `document-info` element (#4854).
4499 * Markdown writer: Escape `~` if strikeout extension enabled (#4840).
4501 * Haddock writer: Use proper format for latex math in haddock (#4571, Joe
4502 Hermaszewski). Inline math in `\(..\)`, display math in `\[..\]`,
4503 tex is now used. Previously we'd "fake it with unicode" and fall
4504 back to tex when that didn't work. But newer haddock versions
4505 support latex math.
4507 * TEI writer:
4509 + Ensure that title element is always present, even if empty (#4839).
4510 + Put author tags in the template, rather than adding them in
4511 the writer (#4839).
4513 * LaTeX writer/template: be sensitive to `filecolor` variable (#4822).
4514 `linkcolor` only affects internal links, and `urlcolor` only
4515 affects linked URLs. For external links, the option to use is
4516 `filecolor`.
4518 * ConTeXt writer: output raw `tex` blocks as well as `context` (#969).
4520 * RST writer:
4522 + Use `.. raw:: latex` for `tex` content.
4523 + Use `.. container` for generic Divs, instead of raw HTML.
4524 + Render Divs with admonition classes as admonitions (#4833).
4525 Also omit Div with class `admonition-title`. These are generated
4526 by the RST reader and should be omitted on round-trip.
4528 * Text.Pandoc.PDF: fix message printed when rsvg-convert is not available
4529 (#4855, Antonio Terceiro).
4531 * HTML5 template: add the `title-block-header` identifier to the
4532 `header` element, to make it easier to style precisely (#4767,
4533 J. B. Rainsberger).
4535 * OpenDocument template: Remove unnecessary indenting of TOC title (#4798,
4536 José de Mattos Neto).
4538 * latex template: Add support for $toc-title$ to LaTeX (and PDF)
4539 (#4853, Wandmalfarbe).
4541 * TEI template: improve `publicationStmt`. Add support for
4542 `publisher`, `address`, `pubPlace`, and `date` variables.
4544 * beamer template: Support "toc-title" (#4835, Cyril Roelandt).
4546 * Text.Pandoc.Extensions: Fix haddock on `Ext_footnotes` (Chris Martin).
4548 * Lua: cleanup Lua utils, remove unused functions (Albert Krewinkel).
4550 * MANUAL.txt:
4552 + Clarify that `--biblatex/--natbib` don't work directly for PDF
4553 (#4904).
4554 + Document `epub:type` attribute (Mauro Bieg, #4901)
4555 + Clarify when `--resource-path` has an effect.
4556 + More detail on customization in syntax highlighting section.
4557 + Document encoding issue with `--listings` (#4871, Damien Clochard).
4558 + Remove docs on removed `--katex-stylesheet` (Mauro Bieg, #4862).
4559 + Use https for context wiki links (#4910).
4561 * CONTRIBUTING.md:
4563 + Link to lua-filters repository (#4874).
4564 + Fix mistake in REPL instructions for stack. (#4849, Brian Leung).
4566 * lua-filters.md: add links to filters, and to lua-filters repository
4567 (#4874).
4569 * INSTALL.md:
4571 + Indicate that cabal >= 2.0 is needed.
4572 + Added chocolatey installation method (#4844, Miodrag Milić).
4574 * Travis: exclude round-trip tests, except for nightly test which can fail.
4576 * Use latest texmath, pandoc-citeproc.
4578 * Use a patched version of foundation until
4579 https://github.com/haskell-foundation/foundation/pull/503
4580 is fixed.
4582 * Clean up appveyor build and Windows package creation.
4583 We now use 64-bit stack and ghc 8.4.3, lts-12 for the 64-bit build. The
4584 WiX-based msi is now 64-bit for 64-bit builds (fixing #4795).
4586 * Remove obsolete RELEASE-CHECKLIST.md.
4588 * Added additional compiler warnings in Makefile and CI builds.
4590## pandoc 2.2.3.2 (2018-08-07)
4592 * Markdown reader: Properly handle boolean values in YAML metadata (#4819).
4593 This fixes a regression in 2.2.3, which cause boolean values to
4594 be parsed as MetaInlines instead of MetaBool.
4596 We here record another undocumented (but desirable) change in 2.2.3:
4597 numerical metadata fields are now parsed as MetaInlines rather than
4598 MetaString.
4600## pandoc 2.2.3.1 (2018-08-06)
4602 * Markdown reader: Fix parsing of embedded mappings in YAML metadata
4603 (#4817). This fixes a regression in 2.2.3 which caused embedded
4604 mappings (e.g. mappings in sequences) not to work in YAML metadata.
4606## pandoc 2.2.3 (2018-08-05)
4608 * RST reader: improve parsing of inline interpreted text roles (#4811).
4610 + Use a Span with class "title-reference" for the default
4611 title-reference role.
4612 + Use `B.text` to split up contents into `Space`s, `SoftBreak`s,
4613 and `Str`s for `title-reference`.
4614 + Use Code with class "interpreted-text" instead of Span and Str for
4615 unknown roles. (The RST writer has also been modified to round-trip
4616 this properly.)
4617 + Disallow blank lines in interpreted text.
4618 + Backslash-escape now works in interpreted text.
4619 + Backticks followed by alphanumerics no longer end interpreted text.
4620 + Remove support for nested inlines (Francesco Occhipinti).
4621 RST does not allow nested emphasis, links, or other inline
4622 constructs. This fixes several bugs (#4581, #4561, #4792).
4624 * Org reader: fix parsers relying on `parseFromString` (#4784, Albert
4625 Krewinkel). Emphasis was not parsed when it followed directly after
4626 some block types (e.g., lists).
4628 * Markdown reader: Allow unquoted numbers and booleans as YAML mapping
4629 keys. Previously in 2.2.2 you could not do
4630 ```
4631 ---
4632 0: bar
4633 ...
4634 ```
4635 but only
4636 ```
4637 ---
4638 '0': bar
4639 ...
4640 ```
4641 With this change, both forms work.
4643 * DocBook reader: metadata handling improvements.
4644 Now we properly parse title and subtitle elements that are direct
4645 children of book and article (as well as children of bookinfo,
4646 articleinfo, or info). We also now use the `subtitle` metadata
4647 field for subtitles, rather than tacking the subtitle on to the
4648 title.
4650 * RST writer:
4652 + Allow images to be directly nested within links (#4810, Francesco
4653 Occhipinti).
4654 + Use `titleblock` instead of `title` variable for title block (#4803,
4655 Francesco Occhipinti). `titleblock` contains a properly formatted
4656 title and subtitle (using top-level headers). `title` and
4657 `subtitle` variables are still available and just contain the
4658 title and subtitle text. Note that this change will require an
4659 update to custom rst templates.
4660 + Render Code with class "interpreted-text" as interpreted text role.
4662 * MediaWiki writer: Avoid extra blank line in tables with empty cells
4663 (#4794). Note that the old output is semantically identical, but the
4664 new output looks better.
4666 * Lua Utils module: add function `blocks_to_inlines` (#4799, Albert
4667 Krewinkel). Exposes a function converting which flattenes a list of
4668 blocks into a list of inlines. An example use case would be the
4669 conversion of Note elements into other inlines.
4671 * RST template: use `titleblock` instead of `title`. Users of
4672 custom RST templates will want to update this.
4674 * LaTeX template: Moved some beamer code in default.latex template.
4675 This change allows beamer themes to change the template and font (as
4676 Metropolis does) (#4450).
4678 * Better error message on `-t pdf -o out.pdf` (#1155, Mauro Bieg).
4680 * Added test case for #4669 to repository.
4682 * INSTALL.md: Fix broken link for cabal-install (#4806, ChanHoHo).
4684 * MANUAL.txt:
4686 + Add beamer info for slide backgrounds (#4802, John Muccigrosso).
4687 + Clarify when `csquotes` is used in LaTeX writer (#4514).
4688 + Add `commonmark` to list of output formats where `raw_tex` has an
4689 effect (see #4527).
4692## pandoc 2.2.2.1 (2018-07-19)
4694 * Fix regression finding templates in user data directory (#4777).
4695 Under version 2.2.1 and prior pandoc found latex templates in the
4696 templates directory under the data directory, but this broke in 2.2.2.
4698 * Fix for bug in parsing `\input` in `rawLaTeXBlock` and
4699 `rawLaTeXInline` (#4781). (This primarily affects the markdown
4700 reader, and other readers that accept raw tex.)
4701 Starting in 2.2.2, everything after an `\input` (or `\include`)
4702 in a markdown file would be parsed as raw LaTeX.
4704 * MANUAL:
4706 + Clarify `gfm` vs `markdown_github` (#4783, Mauro Bieg).
4707 * Use `keywords` instead of `tags` in YAML metadata example (#4779).
4708 Unlike `tags`, `keywords` is used in some of the writers
4709 and default templates.
4711 * Add missing `rollingLinks` option to revealjs template (#4778,
4712 Igor Khorlo).
4714## pandoc 2.2.2 (2018-07-16)
4716 * Use HsYAML instead of yaml for translations and YAML metadata (#4747).
4717 yaml wraps a C library; HsYAML is pure Haskell. Advances #4535.
4719 Note: HsYAML implements YAML 1.2, in which the valid true
4720 values are `true`, `True`, `TRUE`. This means a change in
4721 the semantics of YAML metadata that could affect users:
4722 `y`, `yes`, and `on` no longer count as true values.
4724 * Fix regression: make `--pdf-engine` work with full paths (#4681, Mauro
4725 Bieg).
4727 * CommonMark reader: Handle `ascii_identifiers` extension (#4742,
4728 Anders Waldenborg). Non-ascii characters were not stripped from
4729 identifiers even if the `ascii_identifiers` extension was
4730 enabled (which is is by default for gfm).
4732 * TikiWiki reader: Improve list parsing (#4722, Mauro Bieg).
4733 Remove trailing Space from list items. Parse lists that have no space
4734 after marker.
4736 * LaTeX reader:
4738 + Treat `lilypond` as a verbatim environment (#4725).
4739 + Parse figure label into Image id (#4700, Mauro Bieg).
4740 + Beamer: Allow "noframenumbering" option (#4696, Raymond Ehlers).
4741 + Allow spaces around `\graphicspath` arguments (#4698).
4742 + Handle includes without surrounding blanklines (#4553).
4743 In addition, `\input` can now be used in an inline context,
4744 e.g. to provide part of a paragraph, as it can in LaTeX.
4745 + In `rawLaTeXBlock`, handle macros that resolve to a
4746 `\begin` or `\end` (#4667).
4747 + In `rawLaTeXBlock`, don't expand macros in macro definitions (#4653).
4748 Note that this only affected LaTeX in markdown.
4749 + Tighten up reading of beamer overlay specifications (#4669).
4750 Ideally we'd turn these on only when reading beamer, but currently
4751 beamer is not distinguished from latex as an input format.
4752 This commit also activates parsing of overlay specifications
4753 after commands in general (e.g. `\item`), since they can occur
4754 in many contexts in beamer.
4755 + Parse more siunitx unit commands (#4296, #4773).
4756 + Be more forgiving in key/value option parsing (#4761).
4758 * Markdown reader:
4760 + Allow empty code spans, e.g. `` ` ` ``.
4761 + Emojis are now wrapped in Spans with class `emoji` and
4762 attribute `data-emoji` (Anders Waldenborg, #4743).
4763 This allows the writer to handle them in a special way
4764 (e.g. using a special font, or just rendering the
4765 emoji name).
4767 * Muse reader (Alexander Krotov, except where indicated):
4769 + Get rid of non-exhaustive pattern match warning (Mauro Bieg).
4770 + Add support for floating images.
4771 + Add support for images with specified width.
4772 + Parse image URLs without "guard" and "takeExtension".
4773 + Split link and image parsing into separate functions.
4774 + Parse links starting with "URL:" explicitly instead of trying to strip
4775 "URL:" prefix after parsing.
4777 * Texinfo writer: Use `@sup` and `@sub` instead of custom macros (#4728,
4778 Alexander Krotov).
4780 * Markdown writer: Preserve `implicit_figures` with attributes, even if
4781 `implicit_attributes` is not set, by rendering in raw HTML (#4677).
4783 * Markdown and commonmark/github writers now respect the `emoji`
4784 extension. So, `-f markdown+emoji -t markdown+emoji` now leaves
4785 `:smile:` as `:smile:` rather than converting it to a smile
4786 character.
4788 * Docx writer: Be sensitive to `toc` in YAML metadata (#4645).
4790 * ODT/OpenDocument writer: Make internal links work (#4358).
4791 This adds proper bookmarks to the headers with non-null IDs.
4793 * EPUB writer: Properly escape pagetitle. Previously we weren't
4794 escaping `&` and other XML characters in the pagetitle, so a title
4795 containing a `&` would be invalid.
4797 * AsciiDoc Writer: Eescape square brackets at start of line (#4545,
4798 Mauro Bieg).
4800 * RST writer:
4802 + Don't treat 'example' as a syntax name (#4748).
4803 This fixes conversions from org with example blocks.
4804 + Support `--number-sections` via the `section-numbering`
4805 directive in standalone output.
4807 * reveal.js writer and template: reuse mathjax URL
4808 provided by the argument to `--mathjax` or the normal pandoc default,
4809 rather than a hard-coded one in the template (#4701).
4811 * LaTeX writer:
4813 + Properly handle footnotes in table captions (#4683).
4814 Refactored code from figure captions to use in both places.
4815 + In beamer output, fix single digit column percentage (#4690, Mauro
4816 Bieg).
4818 * FB2 writer (Alexander Krotov):
4820 + Convert Plain to Para in annotation (#2424).
4821 + Fix order of items in title-info (#2424).
4823 * Custom writer: fix error message on script failure (Albert Krewinkel).
4824 Error messages produced by Lua were not displayed by Pandoc.
4826 * Text.Pandoc.Emoji now exports `emojiToInline`, which returns a Span
4827 inline containing the emoji character and some attributes with metadata
4828 (class `emoji`, attribute `data-emoji` with emoji name). (API change,
4829 Anders Waldenborg, #4743).
4831 * Text.Pandoc.PDF:
4833 + Revert fix for #4484 (only compress images on last run, #4755).
4834 This will mean some increase in the time it takes to
4835 produce an image-heavy PDF with xelatex, but it will
4836 make tables of contents correct, which is more important.
4837 + Fix logic error in `runTeXProgram`. We were running the tex program
4838 one more time than requested. This should speed up PDF production.
4840 * Allow `--template` to take a URL as argument.
4842 * Text.Pandoc.Highlighting: Add missing re-export of `breezeDark`
4843 highlighting style (#4687, Adrian Sieber, API change).
4845 * Clarify macOS install in INSTALL.md (#4661). Make the binary package
4846 installer the recommended method, and note that on some older versions of
4847 macOS, homebrew installs from source and takes a lot of disk space
4848 (#4664, Ian).
4850 * MANUAL:
4852 + Clarify EPUB linked media (#4756, Mauro Bieg)
4853 + Update manual for "true" YAML values. Now that we're using HsYAML and
4854 YAML 1.2, the valid true values are `true`, `True`, `TRUE`. NOTE!
4855 `y`, `yes`, `on` no longer count as true values.
4856 + Document `-F` as alias for `--filter` (thanks to Gandalf Saxe).
4857 + Update manual on how math is rendered in LaTeX.
4858 + Add proxy description (#4131, Mauro Bieg).
4859 + Clarify that `--toc` requires `--standalone` (#4703).
4860 + Update citation styles link (#4699, wiefling).
4862 * In API docs, clarify how `Ext_east_asian_line_breaks` extension works
4863 (kaizshang91). Note that it will not take effect when readers/writers
4864 are called as libraries (#4674).
4866 * Improved translations/fr (#4766, lux-lth).
4868 * Removed inadvertently added `.orig` files from repository (#4648).
4870 * Remove `network-uri` flag and use 'Network.Socket'.
4871 This removes a compiler warning. There is no need for the old
4872 `network-uri` flag, since network 2.6 was released in 2014.
4874 * Add stack.lts10.yaml, stack.lts11.yaml. use lts-12 in stack.yaml.
4876 * Bump upper bounds for dependent packages.
4878 * Exclude foundation 0.0.21 for ghc 7.10. Otherwise cabal gets
4879 confused because of the way ghc 7.10 is excluded in foundation's
4880 cabal file. This can be removed when haskell-foundation/foundation#500
4881 is fixed.
4883 * Require cabal-version >= 2.0. This is needed for haddock-library.
4888## pandoc 2.2.1 (2018-05-10)
4890 * Restored and undeprecated gladtex for HTML math (#4607).
4892 + Added `GladTeX` constructor to `Text.Pandoc.Options.HTMLMathMethod`
4893 [API change, reverts removal in v2.2]
4894 + Restored and undeprecated `--gladtex` option, removed in v2.2.
4896 * LaTeX reader: Handle `$` in `/text{..}` inside math (#4576).
4898 * Org reader: Fix image filename recognition (Albert Krewinkel).
4899 Use a function from the filepath library to check whether a string is a
4900 valid file name. The custom validity checker that was used before gave
4901 wrong results (e.g. for absolute file paths on Windows,
4902 kawabata/ox-pandoc#52).
4904 * FB2 reader: Replace some errors with warnings (Alexander Krotov).
4906 * HTML writer:
4908 + Strip links from headers when creating TOC (#4340).
4909 Otherwise the TOC entries will not link to the sections.
4910 + Fix regression with tex math environments in HTML + MathJax (#4639).
4912 * Muse writer (Alexander Krotov): Add support for left-align and
4913 right-align classes (#4542).
4915 * Docx writer: Support underline (#4633).
4917 * Text.Pandoc.Parsing: Lookahead for non-whitespace after
4918 `singleQuoteStart` and `doubleQuoteStart` (#4637).
4920 * `test-pandoc-utils.lua`: more robust testing on both windows
4921 and \*nix. Previously the pipe tests were only run if
4922 `\bin/false` and `/bin/sed` were present, which they aren't
4923 in default MacOS and Windows systems. Fixed by using `tr`
4924 and `false`, which should always be in the path on a \*nix
4925 system, and `find` and `echo` for Windows.
4927 * Text.Pandoc.Shared: add `uriPathToPath`.
4928 This adjusts the path from a file: URI in a way that is sensitive
4929 to Windows/Linux differences. Thus, on Windows,
4930 `/c:/foo` gets interpreted as `c:/foo`, but on Linux,
4931 `/c:/foo` gets interpreted as `/c:/foo`. See #4613.
4933 * Use `uriPathToPath` with file: URIs (#4613).
4935 * Revert piping HTML to pdf-engine (Mauro Bieg, #4413). Use a temp
4936 file as before.
4938 * Text.Pandoc.Class: Catch IO errors when writing media files
4939 and issue a warning, rather than an error (Francesco Occhipinti, #4559).
4941 * Don't lowercase custom writer filename (Alexander Krotov, #4610).
4943 * MANUAL (Mauro Bieg):
4945 + Clarify truthiness in template variables (#2281).
4946 + Clarify pipe table width calculation (#4520).
4948 * ConTeXt template: New Greek fallback typeface (Pablo Rodríguez, #4405).
4949 CMU Serif gives better typographic results than the previous
4950 Greek fallback DejaVu Serif.
4952 * Make HTML template polyglot (#4606, OvidiusCicero), by making
4953 `<link rel="stylesheet" href="$css$">` self-closing.
4955 * Use texmath 0.11, allowing better translation of non-ASCII
4956 characters in math (#4642).
4959## pandoc 2.2 (2018-04-27)
4961 * New input format: `fb2` (FictionBook2) (Alexander Krotov).
4963 * Make `--ascii` work for all XML formats (ICML, OPML, JATS,...),
4964 and for `ms` and `man`.
4966 * Remove deprecated `--latexmathml`, `--gladtex`, `--mimetex`, `--jsmath`, `-m`,
4967 `--asciimathml` options.
4969 * New module Text.Pandoc.Readers.FB2, exporting readFB2 (Alexander
4970 Krotov, API change).
4972 * Markdown reader:
4974 + Allow empty key-value attributes, like `title=""` (#2944).
4975 + Handle table w/o following blank line in fenced div (#4560).
4976 + Remove "fallback" for `doubleQuote` parser. Previously the
4977 parser tried to be efficient -- if no end double quote was found,
4978 it would just return the contents. But this could backfire in a
4979 case `**this should "be bold**`, since the fallback would return
4980 the content `"be bold**` and the closing boldface delimiter
4981 would never be encountered.
4982 + Improve computation of the relative width of the last column in a
4983 multiline table, so we can round-trip tables without constantly
4984 shrinking the last column.
4986 * EPUB reader:
4988 + Fix images with space in file path (#4344).
4990 * LaTeX reader:
4992 + Properly resolve section numbers with `\ref` and chapters (#4529).
4993 + Parse sloppypar environment (#4517, Marc Schreiber).
4994 + Improve handling of raw LaTeX (for markdown etc.) (#4589, #4594).
4995 Previously there were some bugs in how macros were handled.
4996 + Support `\MakeUppercase`, `\MakeLowercase`, `\uppercase`,
4997 `\lowercase`, and also `\MakeTextUppercase` and
4998 `\MakeTextLowercase` from textcase (#4959).
5000 * Textile reader:
5002 + Fixed tables with no body rows (#4513).
5003 Previously these raised an exception.
5005 * Mediawiki reader:
5007 + Improve table parsing (#4508). This fixes detection of table
5008 attributes and also handles `!` characters in cells.
5010 * DocBook reader:
5012 + Properly handle title in `section` element (#4526).
5013 Previously we just got `section_title` for `section` (though `sect1`,
5014 `sect2`, etc. were handled properly).
5015 + Read tex math as output by asciidoctor (#4569, Joe Hermaszewski).
5017 * Docx reader:
5019 + Combine adjacent CodeBlocks with the same attributes into
5020 a single CodeBlock. This prevents a multiline codeblock in
5021 Word from being read as different paragraphs.
5023 * RST reader:
5025 + Allow < 3 spaces indent under directives (#4579).
5026 + Fix anonymous redirects with backticks (#4598).
5028 * Muse reader (Alexander Krotov):
5030 + Add support for Text::Amuse multiline headings.
5031 + Add `<math>` tag support.
5032 + Add support for `<biblio>` and `<play>` tags.
5033 + Allow links to have empty descriptions.
5034 + Require block `<literal>` tags to be on separate lines.
5035 + Allow `-` in anchors.
5036 + Allow verse to be indented.
5037 + Allow nested footnotes.
5038 + Internal improvements.
5040 * Muse writer (Alexander Krotov):
5042 + Escape `>` only at the beginning of a line.
5043 + Escape `]` in image title.
5044 + Escape `]` brackets in URLs as `%5D`.
5045 + Only escape brackets when necessary.
5046 + Escape ordered list markers.
5047 + Do not escape list markers unless preceded by space.
5048 + Escape strings starting with space.
5049 + Escape semicolons and markers after line break.
5050 + Escape `;` to avoid accidental comments.
5051 + Don't break headers, line blocks and tables with line breaks.
5052 + Correctly output empty headings.
5053 + Escape horizontal rule only if at the beginning of the line.
5054 + Escape definition list terms starting with list markers.
5055 + Place header IDs before header.
5056 + Improve span writing.
5057 + Do not join Spans in normalization.
5058 + Don't align ordered list items.
5059 + Remove key-value pairs from attributes before normalization.
5060 + Enable `--wrap=preserve` for all tests by default.
5061 + Reduced `<verbatim>` tags in output.
5062 + Internal changes.
5064 * RST writer:
5066 + Use more consistent indentation (#4563). Previously we
5067 used an odd mix of 3- and 4-space indentation. Now we use 3-space
5068 indentation, except for ordered lists, where indentation must
5069 depend on the width of the list marker.
5070 + Flatten nested inlines (#4368, Francesco Occhipinti).
5071 Nested inlines are not valid RST syntax, so we flatten them following
5072 some readability criteria discussed in #4368.
5074 * EPUB writer:
5076 + Ensure that `pagetitle` is always set, even when structured titles
5077 are used. This prevents spurious warnings about empty title
5078 elements (#4486).
5080 * FB2 writer (Alexander Krotov):
5082 + Output links inline instead of producing notes. Previously all links
5083 were turned into footnotes with unclickable URLs inside.
5084 + Allow emphasis and notes in titles.
5085 + Don't intersperse paragraph with empty lines.
5086 + Convert metadata value `abstract` to book annotation.
5087 + Use `<empty-line />` for `HorizontalRule` rather than `LineBreak`.
5088 FB2 does not have a way to represent line breaks inside paragraphs;
5089 previously we used `<empty-line />` elements, but these are not allowed
5090 inside paragraphs.
5092 * Powerpoint writer (Jesse Rosenthal):
5094 + Handle Quoted Inlines (#4532).
5095 + Simplify code with `ParseXml`.
5096 + Allow fallback options when looking for placeholder type.
5097 + Check reference-doc for all layouts.
5098 + Simplify speaker notes logic.
5099 + Change notes state to a simpler per-slide value.
5100 + Remove `Maybe` from `SpeakerNotes` in `Slide`. `mempty`
5101 means no speaker notes.
5102 + Add tests for improved speaker notes.
5103 + Handle speaker notes earlier in the conversion process.
5104 + Keep notes with related blocks (#4477). Some blocks automatically
5105 split slides (imgs, tables, `column` divs). We assume that any
5106 speaker notes immediately following these are connected to these
5107 elements, and keep them with the related blocks, splitting after them.
5108 + Remove `docProps/thumbnail.jpeg` in data dir (Jesse Rosenthal, #4588).
5109 It contained a nonfree ICC color calibration profile and is not needed
5110 for production of a powerpoint document.
5112 * Markdown writer:
5114 + Include a blank line at the end of the row in a single-row multiline
5115 table, to prevent it from being interpreted as a simple table (#4578).
5117 * CommonMark writer:
5119 + Correctly ignore LaTeX raw blocks when `raw_tex` is not
5120 enabled (#4527, quasicomputational).
5122 * EPUB writer:
5124 + Add `epub:type="footnotes"` to notes section in EPUB3 (#4489).
5126 * LaTeX writer:
5128 + In beamer, don't use format specifier for default ordered lists
5129 (#4556). This gives better results for styles that put ordered list
5130 markers in boxes or circles.
5131 + Update `\lstinline` delimiters (#4369, Tim Parenti).
5133 * Ms writer:
5135 + Use `\f[R]` rather than `\f[]` to reset font (#4552).
5136 + Use `\f[BI]` and `\f[CB]` in headers, instead of `\f[I]` and `\f[C]`,
5137 since the header font is automatically bold (#4552).
5138 + Use `\f[CB]` rather than `\f[BC]` for monospace bold (#4552).
5139 + Create pdf anchor for a Div with an identifier (#4515).
5140 + Escape `/` character in anchor ids (#4515).
5141 + Improve escaping for anchor ids: we now use _uNNN_ instead of uNNN
5142 to avoid ambiguity.
5144 * Man writer:
5146 + Don't escape U+2019 as `'` (#4550).
5148 * Text.Pandoc.Options:
5150 + Removed `JsMath`, `LaTeXMathML`, and `GladTeX` constructors from
5151 `Text.Pandoc.Options.HTMLMathMethod` [API change].
5153 * Text.Pandoc.Class:
5155 + `writeMedia`: unescape URI-escaping in file path. This avoids
5156 writing things like `file%20one.png` to the file system.
5158 * Text.Pandoc.Parsing:
5160 + Fix `romanNumeral` parser (#4480). We previously accepted 'DDC'
5161 as 1100.
5162 + `uri`: don't treat `*` characters at end as part of URI (#4561).
5164 * Text.Pandoc.MIME:
5166 + Use the alias `application/eps` for EPS (#2067).
5167 This will ensure that we retain the eps extension after reading the
5168 image into a mediabag and writing it again.
5170 * Text.Pandoc.PDF:
5172 + Use `withTempDir` in `html2pdf`.
5173 + With `xelatex`, don't compress images til the last run (#4484).
5174 This saves time for image-heavy documents.
5175 + Don't try to convert EPS files (#2067). `pdflatex` converts them
5176 itself, and JuicyPixels can't do it.
5177 + For `pdflatex`, use a temp directory in the working directory.
5178 Otherwise we can have problems with the EPS conversion pdflatex
5179 tries to do, which can't operate on a file above the working
5180 directory without `--shell-escape`.
5182 * Changes to tests to accommodate changes in pandoc-types.
5183 In <https://github.com/jgm/pandoc-types/pull/36> we changed
5184 the table builder to pad cells. This commit changes tests
5185 (and two readers) to accord with this behavior.
5187 * Set default extensions for `beamer` same as `latex`.
5189 * LaTeX template:
5191 + Add `beameroption` variable (#4359, Étienne Bersac).
5192 + Use `pgfpages` package; this is needed for notes on second
5193 screen in beamer (Étienne Bersac).
5194 + Add `background-image` variable (#4601, John Muccigrosso).
5196 * reveal.js template: Add `background-image` variable (#4600,
5197 John Muccigrosso).
5199 * ms template: Fix date. Previously `.ND` was used, but this only
5200 works if you have a title page, which we don't. Thanks to @teoric.
5202 * Removed pragmas for unused extensions (#4506, Anabra).
5204 * Fix bash completion for `--print-default-data-file` (#4549).
5205 Previously this looked in the filesystem, even if pandoc
5206 was compiled with `embed_data_files` (and sometimes it looked
5207 in a nonexistent build directory). Now the bash completion
5208 script just includes a hard-coded list of data file names.
5210 * MANUAL:
5212 + Clarify template vs metadata variables (#4501, Mauro Bieg).
5213 + Fix raw content example (#4479, Mauro Bieg).
5214 + Specify that you use html for raw output in epub.
5215 + Add examples for raw docx blocks (#4472, Tristan Stenner).
5216 The documentation states that the target format name should match
5217 the output format, which isn't the case for `docx`/`openxml` and
5218 some others.
5219 + Don't say that `empty_paragraphs` affects markdown output (#4540).
5220 + Consolidate input/output format documentation (#4577, Mauro Bieg).
5222 * New README template. Take in/out formats from manual.
5224 * Fix example in lua-filters docs (#4459, HeirOfNorton).
5226 * Use the `-threaded` GHC flag when building benchmarks (#4587,
5227 Francesco Occhipinti).
5229 * Bump temporary upper bound to 1.4.
5231 * Use pandoc-citeproc 0.14.3.1.
5233 * Use texmath-0.10.1.2 (fixes escapes in math in ms, #4597).
5235 * Removed old lib directory. This was used for something long ago,
5236 but plays no role now.
5238 * Removed unneeded data file `LaTeXMathML.js`.
5240 * Create 64- and 32-bit versions of Windows binary packages.
5242## pandoc 2.1.3 (2018-03-18)
5244 * Docx reader (Jesse Rosenthal):
5246 + Add tests for nested smart tags.
5247 + Parse nested smart tags.
5248 + Make unwrapSDT into a general `unwrap` function that can unwrap both
5249 nested SDT tags and smartTags. This makes the SmartTags constructor in
5250 the Docx type unnecessary, so we remove it (#4446).
5251 + Remove unused `docxWarnings` (Alexander Krotov).
5253 * RST reader: Allow unicode bullet characters (#4454).
5255 * Haddock reader: Better table handling, using haddock-library's
5256 new table support, if compiled against a version that
5257 includes it. Note that tables with col/rowspans will not
5258 translate well into Pandoc.
5260 * Muse reader (Alexander Krotov):
5262 + Various internal improvements.
5263 + Require closing tag to have the same indentation as opening.
5264 + Do not reparse blocks inside unclosed block tag (#4425).
5265 + Parse `<class>` tag (supported by Emacs Muse).
5266 + Do not produce empty Str element for unindented verse lines.
5268 * LaTeX reader:
5270 + Add support to parse unit string of `\SI` command (closes #4296,
5271 Marc Schreiber).
5273 * Haddock writer: In the writer, we now render tables always as
5274 grid tables, since Haddock supports these.
5276 * DokuWiki writer: rewrite backSlashLineBreaks (#4445, Mauro Bieg).
5278 * Docx writer: Fixed formatting of `DefaultStyle` ordered lists in
5279 docx writer. We want decimal for the top level, not lower roman.
5281 * RST writer:
5283 + Strip whitespace at beginning and ending of inline containers
5284 (#4327, Francesco Occhipinti).
5285 + Filter out empty inline containers (#4434). There is nothing in
5286 RST that corresponds to e.g. `Emph []`, so we just ignore elements
5287 like this (Francesco Occhipinti).
5289 * Muse writer (Alexander Krotov):
5291 + Support spans with anchors.
5292 + Replace smallcaps with emphasis before normalization.
5293 + Output smallcaps as emphasis.
5294 + Expand Cite before list normalization.
5295 + Write empty inline lists as `<verbatim></verbatim>`.
5296 + Remove empty Str from the beginning of inline lists during normalization.
5297 + Escape "-" to avoid creating bullet lists.
5298 + Fix math expansion for more than one expression per paragraph.
5299 + Expand math before inline list normalization.
5301 * Dokuwiki writer: fix LineBreaks in Tables (#4313, Mauro Bieg).
5303 * Ms writer:
5305 + Asciify pdf anchors, since unicode anchors don't work (#4436).
5306 Internal links should be converted automatically, so this shouldn't
5307 affect users directly.
5308 + Don't escape hyphens as `\-`; that's for a minus sign (#4467).
5310 * Beamer writer: put hyperlink after `\begin{frame}` and not in the title
5311 (#4307). If it's in the title, then we get a titlebar on slides with
5312 the `plain` attribute, when the id is non-null. This fixes a regression
5313 in 2.0.
5315 * EPUB writer: Remove notes from TOC in nav.xhtml (#4453, Mauro Bieg).
5317 * JATS writer: Remove extraneous, significant whitespace (#4335,
5318 Nokome Bentley).
5320 * html2pdf: inject base tag with current working directory (#4413, Mauro
5321 Bieg). This helps ensure that linked resources are included.
5323 * Add Semigroup instances for everything for which we defined a
5324 Monoid instance previously (API change):
5326 + Text.Pandoc.Class.FileTree.
5327 + Text.Pandoc.Translations.Translations.
5328 + Text.Pandoc.Extensions.Extensions.
5329 + Text.Pandoc.Readers.Odt.StyleReader.Styles.
5330 + Text.Pandoc.Pretty.Doc.
5331 + Text.Pandoc.MediaBag.MediaBag.
5333 * Add custom Prelude to give clean code for Monoid and Semigroup
5334 that works with ghc 7.10-8.4. The custom Prelude (`prelude/Prelude`)
5335 is used for ghc versions < 8.4. `NoImplicitPrelude` is used
5336 in all source files, and Prelude is explicitly imported
5337 (this is necessary for ghci to work properly with the custom prelude).
5339 * Text.Pandoc.Writers.Shared (Francesco Occhipinti):
5341 + Export `stripLeadingTrailingSpace`.
5342 + Don't wrap lines in grid tables when `--wrap=none` (#4320).
5343 + `gridTable`: Don't wrap lines in tables when `--wrap=none`. Instead,
5344 expand cells, even if it results in cells that don't respect relative
5345 widths or surpass page column width. This change affects RST,
5346 Markdown, and Haddock writers.
5348 * Raise error if someone tries to print docx, odt, etc. template (#4441).
5350 * LaTeX template: Provide `bidi` package's option using
5351 `\PassOptionsToPackage` (#4357, Václav Haisman). This avoid a
5352 clash when `polyglossia` loads it first and then it is loaded again
5353 for XeLaTeX.
5355 * ConTeXt template: Added `pdfa` variable to generate PDF/A (#4294, Henri
5356 Menke). Instructions on how to install the ICC profiles on ConTeXt
5357 standalone can be found in the wiki:
5358 <http://wiki.contextgarden.net/PDFX#ICC_profiles>.
5359 If the ICC profiles are not available the log will contain error
5360 messages.
5362 * Use latest pandoc-types, skylighting
5364 * Use latest pandoc-citeproc in binary package.
5366 * Bump upper bound for time, criterion, haddock-library, exceptions,
5367 http-types, aeson, haddock-library.
5369 * Bump upper bound tasty-quickcheck 0.10 (#4429, Felix Yan).
5371 * pandoc.cabal: fix up other-extensions and language fields.
5372 Language is now consistently `Haskell2010`, and other-extensions
5373 is consistently `NoImplicitPrelude`. Everything else to be specified
5374 in the module header as needed.
5376 * Removed `old-locale` flag and Text.Pandoc.Compat.Time.
5377 This is no longer necessary since we no longer support ghc 7.8.
5379 * Make `weigh-pandoc` into a benchmark program.
5380 Remove `weigh-pandoc` flag. `weigh-pandoc` is now built (and run)
5381 automatically when you build (and run) benchmarks.
5383 * MANUAL: add instructions for background images reveal.js (#4325, John
5384 Muccigrosso).
5386 * appveyor: use VS 2013 environment instead of VS 2015 for Windows builds.
5388## pandoc 2.1.2 (2018-03-02)
5390 * Markdown reader:
5392 + Fix parsing bug with nested fenced divs (#4281). Previously we allowed
5393 "nonindent spaces" before the opening and closing `:::`, but this
5394 interfered with list parsing, so now we require the fences to be flush with
5395 the margin of the containing block.
5397 * Commonmark reader:
5399 + `raw_html` is now on by default. It can be disabled explicitly
5400 using `-f commonmark-raw_html`.
5402 * Org reader (Albert Krewinkel):
5404 + Move citation tests to separate module.
5405 + Allow changing emphasis syntax (#4378). The characters allowed before
5406 and after emphasis can be configured via `#+pandoc-emphasis-pre` and
5407 `#+pandoc-emphasis-post`, respectively. This allows to change which
5408 strings are recognized as emphasized text on a per-document or even
5409 per-paragraph basis. Example:
5411 #+pandoc-emphasis-pre: "-\t ('\"{"
5412 #+pandoc-emphasis-post: "-\t\n .,:!?;'\")}["
5414 * LaTeX reader:
5416 + Fixed comments inside citations (#4374).
5417 + Fix regression in package options including underscore (#4424).
5418 + Make `--trace` work.
5419 + Fixed parsing of `tabular*` environment (#4279).
5421 * RST reader:
5423 + Fix regression in parsing of headers with trailing space (#4280).
5425 * Muse reader (Alexander Krotov):
5427 + Enable `<literal>` tags even if amuse extension is enabled.
5428 Amusewiki disables <literal> tags for security reasons.
5429 If user wants similar behavior in pandoc, RawBlocks and RawInlines
5430 can be removed or replaced with filters.
5431 + Remove space prefix from `<literal>` tag contents.
5432 + Do not consume whitespace while looking for closing end tag.
5433 + Convert alphabetical list markers to decimal in round-trip test.
5434 Alphabetical lists are an addition of Text::Amuse.
5435 They are not present in Emacs Muse and can be ambiguous
5436 when list starts with "i.", "c." etc.
5437 + Allow `<quote>` and other tags to be indented.
5438 + Allow single colon in definition list term.
5439 + Fix parsing of verse in lists.
5440 + Improved parsing efficiency. Avoid `parseFromString`.
5441 Lists are parsed in linear instead of exponential time now.
5442 + Replace ParserState with MuseState.
5443 + Prioritize lists with roman numerals over alphabetical lists.
5444 This is to make sure "i." starts a roman numbered list,
5445 instead of a list with letter "i" (followed by "j", "k", ...").
5446 + Fix directive parsing.
5447 + Parse definition lists with multiple descriptions.
5448 + Parse next list item before parsing more item contents.
5449 + Fixed a bug: headers did not terminate lists.
5450 + Move indentation parsing from `definitionListItem` to `definitionList`.
5451 + Paragraph indentation does not indicate nested quote.
5452 Muse allows indentation to indicate quotation or alignment,
5453 but only on the top level, not within a <quote> or list.
5454 + Require that block tags are on separate lines.
5455 Text::Amuse already explicitly requires it anyway.
5456 + Fix matching of closing inline tags.
5457 + Various internal changes.
5458 + Fix parsing of nested definition lists.
5459 + Require only one space for nested definition list indentation.
5460 + Do not remove trailing whitespace from `<code>`.
5461 + Fix parsing of trailing whitespace. Newline after whitespace now
5462 results in softbreak instead of space.
5464 * Docx reader (Jesse Rosenthal, except where noted):
5466 + Handle nested sdt tags (#4415).
5467 + Don't look up dependant run styles if `+styles` is enabled.
5468 + Move pandoc inline styling inside custom-style span.
5469 + Read custom styles (#1843). This will read all paragraph and
5470 character classes as divs and spans, respectively. Dependent styles
5471 will still be resolved, but will be wrapped with appropriate style
5472 tags. It is controlled by the `+styles` extension (`-f docx+styles`).
5473 This can be used in conjunction with the `custom-style` feature in the
5474 docx writer for a pandoc-docx editing workflow. Users can convert from
5475 an input docx, reading the custom-styles, and then use that same input
5476 docx file as a reference-doc for producing an output docx file. Styles
5477 will be maintained across the conversion, even if pandoc doesn't
5478 understand them.
5479 + Small change to Fields hyperlink parser. Previously, unquoted string
5480 required a space at the end of the line (and consumed it). Now we
5481 either take a space (and don't consume it), or end of input.
5482 + Pick table width from the longest row or header (Francesco Occhipinti,
5483 #4360).
5485 * Muse writer (Alexander Krotov):
5487 + Change verse markup: `> ` instead of `<verse>` tag.
5488 + Remove empty strings during inline normalization.
5489 + Don't indent nested definition lists.
5490 + Use unicode quotes for quoted text.
5491 + Write image width specified in percent in Text::Amuse mode.
5492 + Don't wrap displayMath into `<verse>`.
5493 + Escape nonbreaking space (`~~`).
5494 + Join code with different attributes during normalization.
5495 + Indent lists inside Div.
5496 + Support definitions with multiple descriptions.
5498 * Powerpoint writer (Jesse Rosenthal):
5500 + Use table styles This will use the default table style in the
5501 reference-doc file. As a result they will be easier when using
5502 in a template, and match the color scheme.
5503 + Remove empty slides. Because of the way that slides were split, these
5504 could be accidentally produced by comments after images. When animations
5505 are added, there will be a way to add an empty slide with either
5506 incremental lists or pauses.
5507 + Implement syntax highlighting. Note that background colors can't
5508 be implemented in PowerPoint, so highlighting styles that require
5509 these will be incomplete.
5510 + New test framework for pptx. We now compare the output of the
5511 Powerpoint writer with files that we know to (a) not be corrupt,
5512 and (b) to show the desired output behavior (details below).
5513 + Add `notesMaster` to `presentation.xml` if necessary.
5514 + Ignore links and (end)notes in speaker notes.
5515 + Output speaker notes.
5516 + Read speaker note templates conditionally. If there are speaker
5517 notes in the presentation, we read in the notesMasters templates
5518 from the reference pptx file.
5519 + Fix deletion track changes (#4303, Jesse Rosenthal).
5521 * Markdown writer: properly escape @ to avoid capture as citation
5522 (#4366).
5524 * LaTeX writer:
5526 + Put hypertarget inside figure environment (#4388).
5527 This works around a problem with the endfloat package and
5528 makes pandoc's output compatible with it.
5529 + Fix image height with percentage (#4389). This previously caused
5530 the image to be resized to a percentage of textwidth, rather than
5531 textheight.
5533 * ConTeXt writer (Henri Menke):
5535 + New section syntax and support `--section-divs` (#2609).
5536 `\section[my-header]{My Header}` ->
5537 `\section[title={My Header},reference={my-header}]`.
5538 The ConTeXt writer now supports the `--section-divs` option to
5539 write sections in the fenced style, with `\startsection` and
5540 `\stopsection`.
5541 + xtables: correct wrong usage of caption (Henri Menke).
5543 * Docx writer:
5545 + Fix image resizing with multiple images (#3930, Andrew Pritchard).
5546 + Use new golden framework (Jesse Rosenthal).
5547 + Make more deterministic to facilitate testing (Jesse Rosenthal).
5548 - `getUniqueId` now calls to the state to get an incremented digit,
5549 instead of calling to P.uniqueHash.
5550 - we always start the PRNG in mkNumbering/mkAbstractNum with the same
5551 seed (1848), so our randoms should be the same each time.
5552 + Fix ids in comment writing (Jesse Rosenthal). Comments from
5553 `--track-changes=all` were producing corrupt docx, because the
5554 writer was trying to get id from the `(ID,_,_)` field of
5555 the attributes, and ignoring the "id" entry in the key-value pairs. We
5556 now check both.
5558 * Ms writer: Added papersize variable.
5560 * TEI writer:
5562 + Use `height` instead of `depth` for images (#4331).
5563 + Ensure that id prefix is always used.
5564 + Don't emit `role` attribute; that was a leftover from the
5565 Docbook writer.
5566 + Use 'xml:id', not 'id' attribute (#4371).
5568 * AsciiDoc writer:
5570 + Do not output implicit heading IDs (#4363, Alexander
5571 Krotov). Convert to `asciidoc-auto_identifiers` for old behaviour.
5573 * RST writer:
5575 + Remove `blockToRST'` moving its logic into `fixBlocks`
5576 (Francesco Occhipinti).
5577 + Insert comment between lists and quotes (#4248, Francesco Occchipinti).
5579 * RST template: remove definition of 'math' role as raw.
5580 This used to be needed prior to v 0.8 of docutils, but
5581 now math support is built-in.
5583 * Slides: Use divs to set incremental/non-incremental (#4381,
5584 Jesse Rosenthal). The old method (list inside blockquote) still
5585 works, but we are encouraging the use of divs with class
5586 `incremental` or `nonincremental`.
5588 * Text.Pandoc.ImageSize:
5590 + Make image size detection for PDFs more robust (#4322).
5591 + Determine image size for PDFs (#4322).
5592 + EMF Image size support (#4375, Andrew Pritchard).
5594 * Text.Pandoc.Extensions:
5596 + Add `Ext_styles` (Jesse Rosenthal, API change). This will be used in
5597 the docx reader (defaulting to off) to read pargraph and character
5598 styles not understood by pandoc (as divs and spans, respectively).
5599 + Made `Ext_raw_html` default for `commonmark` format.
5601 * Text.Pandoc.Parsing:
5603 + Export `manyUntil` (Alexander Krotov, API change).
5604 + Export improved `sepBy1` (Alexander Krotov).
5605 + Export list marker parsers: `upperRoman`, `lowerRoman`,
5606 `decimal`, `lowerAlpha`, `upperAlpha` (Alexander Krotov, API change).
5608 * Tests/Lua: fix tests on windows (Albert Krewinkel).
5610 * Lua: register script name in global variable (#4393). The name of the Lua
5611 script which is executed is made available in the global Lua variable
5612 `PANDOC_SCRIPT_FILE`, both for Lua filters and custom writers.
5614 * Tests: Abstract powerpoint tests out to OOXML tests (Jesse Rosenthal).
5615 There is very little pptx-specific in these tests, so we abstract out
5616 the basic testing function so it can be used for docx as well. This
5617 should allow us to catch some errors in the docx writer that slipped
5618 by the roundtrip testing.
5620 * Lua filters: store constructors in registry (Albert Krewinkel). Lua
5621 functions used to construct AST element values are stored in the Lua
5622 registry for quicker access. Getting a value from the registry is much
5623 faster than getting a global value (partly to idiosyncrasies of hslua);
5624 this change results in a considerable performance boost.
5626 * Documentation:
5628 + `doc/org.md` Add draft of Org-mode documentation (Albert Krewinkel).
5629 + `doc/lua-filters.md`: document global vars set for filters
5630 (Albert Krewinkel).
5631 + INSTALL.md: mention Stack version. (#4343, Adam Brandizzi).
5632 + MANUAL: add documentation on custom styles (Jesse Rosenthal).
5633 + MANUAL.txt: Document incremental and nonincremental divs (Jesse
5634 Rosenthal). Blockquoted lists are still described, but fenced divs are
5635 presented in preference.
5636 + MANUAL.txt: document header and footer variables (newmana).
5637 + MANUAL.txt: self-contained implies standalone (#4304, Daniel Lublin).
5638 + CONTRIBUTING.md: label was renamed. (#4310, Alexander Brandizzi).
5640 * Require tagsoup 0.14.3 (#4282), fixing HTML tokenization bug.
5642 * Use latest texmath.
5644 * Use latest pandoc-citeproc.
5646 * Allow exceptions 0.9.
5648 * Require aeson-pretty 0.8.5 (#4394).
5650 * Bump blaze-markup, blaze-html lower bounds to 0.8, 0.9 (#4334).
5652 * Update tagsoup to 0.14.6 (Alexander Krotov, #4282).
5654 * Removed ghc-prof-options. As of cabal 1.24, sensible defaults are used.
5656 * Update default.nix to current nixpkgs-unstable for hslua-0.9.5 (#4348,
5657 jarlg).
5659## pandoc 2.1.1 (2018-01-18)
5661 * Markdown reader:
5663 + Don't coalesce adjacent raw LaTeX blocks if they are separated by a
5664 blank line. See lierdakil/pandoc-crossref#160.
5665 + Improved `inlinesInBalancedBrackets` (#4272, jgm/pandoc-citeproc#315).
5666 The change both improves performance and fixes a regression whereby
5667 normal citations inside inline notes and figure captions were not
5668 parsed correctly.
5670 * RST reader:
5672 + Better handling for headers with an anchor (#4240). Instead of creating a
5673 Div containing the header, we put the id directly on the header.
5674 This way header promotion will work properly.
5675 + Add aligned environment when needed in math (#4254). `rst2latex.py`
5676 uses an `align*` environment for math in `.. math::` blocks, so this
5677 math may contain line breaks. If it does, we put the math in an
5678 `aligned` environment to simulate `rst2latex.py`'s behavior.
5680 * HTML reader:
5682 + Fix col width parsing for percentages < 10% (#4262, n3fariox).
5684 * LaTeX reader:
5686 + Advance source position at end of stream.
5687 + Pass through macro defs in `rawLaTeXBlock` even if the `latex_macros`
5688 extension is set (#4246). This reverts to earlier behavior and is
5689 probably safer on the whole, since some macros only modify things in
5690 included packages, which pandoc's macro expansion can't modify.
5691 + Fixed pos calculation in tokenizing escaped space.
5692 + Allow macro definitions inside macros (#4253). Previously we went into
5693 an infinite loop with
5694 ```
5695 \newcommand{\noop}[1]{#1}
5696 \noop{\newcommand{\foo}[1]{#1}}
5697 \foo{hi}
5698 ```
5699 + Fix inconsistent column widths (#4238). This fixes a bug whereby column
5700 widths for the body were different from widths for the header in some
5701 tables.
5703 * Docx reader (Jesse Rosenthal):
5705 + Parse hyperlinks in `instrText` tags (#3389, #4266). This was a form of
5706 hyperlink found in older versions of word. The changes introduced for
5707 this, though, create a framework for parsing further fields in MS Word
5708 (see the spec, ECMA-376-1:2016, §17.16.5, for more on these fields).
5709 We introduce a new module, `Text.Pandoc.Readers.Docx.Fields` which
5710 contains a simple parsec parser. At the moment, only simple hyperlink
5711 fields are accepted, but that can be extended in the future.
5713 * Muse reader (Alexander Krotov):
5715 + Parse `~~` as non-breaking space in Text::Amuse mode.
5716 + Refactor list parsing.
5718 * Powerpoint writer (Jesse Rosenthal):
5720 + Change reference to `notesSlide` to `endNotesSlide`.
5721 + Move image sizing into `picProps`.
5722 + Improve table placement.
5723 + Make our own `_rels/.rels` file.
5724 + Import reference-doc images properly.
5725 + Move `Presentation.hs` out of `PandocMonad`.
5726 + Refactor into separate modules. T.P.W.Powerpoint.Presentation
5727 defines the Presentation datatype and goes Pandoc->Presentation;
5728 T.P.W.Pandoc.Output goes Presentation->Archive.
5729 Text.Pandoc.Writers.Powerpoint a thin wrapper around the two modules.
5730 + Avoid overlapping blocks in column output.
5731 + Position images correctly in two-column layout.
5732 + Make content shape retrieval environment-aware.
5733 + Improve image handling. We now determine image and caption placement
5734 by getting the dimensions of the content box in a given layout.
5735 This allows for images to be correctly sized and positioned in a
5736 different template. Note that images without captions and headers are
5737 no longer full-screened. We can't do this dependably in different
5738 layouts, because we don't know where the header is (it could be to
5739 the side of the content, for example).
5740 + Read presentation size from reference file. Our presentation size is
5741 now dependent on the reference/template file we use.
5742 + Handle (sub)headers above slidelevel correctly. Above the slidelevel,
5743 subheaders will be printed in bold and given a bit of extra space
5744 before them. Note that at the moment, no distinction is made between
5745 levels of headers above the slide header, though that can be changed.
5746 + Check for required files. Since we now import from reference/dist
5747 file by glob, we need to make sure that we're getting the files we
5748 need to make a non-corrupt Powerpoint. This performs that check.
5749 + Improve templating using `--reference-doc`. Templating should work
5750 much more reliably now.
5751 + Include Notes slide in TOC.
5752 + Set notes slide header to slide-level.
5753 + Add table of contents. This is triggered by the `--toc` flag. Note
5754 that in a long slide deck this risks overrunning the text box. The user
5755 can address this by setting `--toc-depth=1`.
5756 + Set notes slide number correctly.
5757 + Clean up adding metadata slide. We want to count the slide numbers
5758 correctly if it's in there.
5759 + Add anchor links. For anchor-type links (`[foo](#bar)`) we produce
5760 an anchor link. In powerpoint these are links to slides, so we keep
5761 track of a map relating anchors to the slides they occur on.
5762 + Make the slide number available to the blocks. For anchors,
5763 block-processing functions need to know what slide number
5764 they're in. We make the `envCurSlideId` available to blocks.
5765 + Move `curSlideId` to environment.
5766 + Allow setting `toc-title` in metadata.
5767 + Link notes to endnotes slide.
5769 * Markdown writer:
5771 + Fix cell width calculation (#4265). Previously we could get
5772 ever-lengthening cell widths when a table was run repeatedly through
5773 `pandoc -f markdown -t markdown`.
5775 * LaTeX writer:
5777 + Escape `&` in lstinline (Robert Schütz).
5779 * ConTeXt writer:
5781 + Use xtables instead of Tables (#4223, Henri Menke).
5782 Default to xtables for context output. Natural Tables are used
5783 if the new `ntb` extension is set.
5785 * HTML writer:
5787 + Fixed footnote backlinks with `--id-prefix` (#4235).
5789 * `Text.Pandoc.Extensions`: Added `Ext_ntb` constructor (API change,
5790 Henri Menke).
5792 * `Text.Pandoc.ImageSize`: add derived `Eq` instance to `Dimension`
5793 (Jesse Rosenthal, API change).
5795 * Lua filters (Albert Krewinkel):
5797 + Make `PANDOC_READER_OPTIONS` available.
5798 The options which were used to read the document are made available to
5799 Lua filters via the `PANDOC_READER_OPTIONS` global.
5800 + Add lua module `pandoc.utils.run_json_filter`, which runs a JSON filter
5801 on a Pandoc document.
5802 + Refactor filter-handling code into `Text.Pandoc.Filter.JSON`,
5803 `Text.Pandoc.Filter.Lua`, and `Text.Pandoc.Filter.Path`.
5804 + Improve error messages. Provide more context about the task
5805 which caused an error.
5807 * data/pandoc.lua (Albert Krewinkel):
5809 + Accept singleton inline as a list. Every constructor which accepts a
5810 list of inlines now also accepts a single inline element for
5811 convenience.
5812 + Accept single block as singleton list. Every constructor which accepts
5813 a list of blocks now also accepts a single block element for
5814 convenience. Furthermore, strings are accepted as shorthand for
5815 `{pandoc.Str "text"}` in constructors.
5816 + Add attr, listAttributes accessors. Elements with
5817 attributes got an additional `attr` accessor. Attributes were
5818 accessible only via the `identifier`, `classes`, and `attributes`,
5819 which was in conflict with the documentation, which indirectly states
5820 that such elements have the an `attr` property.
5821 + Drop `_VERSION`. Having a `_VERSION` became superfluous, as this
5822 module is closely tied to the pandoc version, which is available via
5823 `PANDOC_VERSION`.
5824 + Fix access to Attr components. Accessing an Attr value (e.g.,
5825 ` Attr().classes`) was broken; the more common case of accessing it via
5826 an Inline or Block element was unaffected by this.
5828 * Move `metaValueToInlines` to from Docx writer to
5829 `Text.Pandoc.Writers.Shared`, so it can be used by other writers
5830 (Jesse Rosenthal).
5832 * MANUAL.txt:
5834 + Clarify otherlangs in LaTeX (#4072).
5835 + Clarify `latex_macros` extension.
5836 + Recommend use of `raw_attribute` extension in header includes (#4253).
5838 * Allow latest QuickCheck, tasty, criterion.
5840 * Remove custom prelude and ghc 7.8 support.
5842 * Reduce compiler noise (exact paths for compiled modules).
5844## pandoc 2.1 (2018-01-07)
5846 * Allow filters and lua filters to be interspersed (#4196). Previously
5847 we ran all lua filters before JSON filters. Now we run filters in
5848 the order they are presented on the command line, whether lua or JSON.
5849 There are two incompatible API changes: The type of `applyFilters`
5850 has changed, and `applyLuaFilters` has been removed. `Filter` is
5851 also now exported.
5853 * Use latest skylighting and omit the `missingIncludes` check, fixing
5854 a major performance regression in earlier releases of the 2.x series
5855 (#4226). Behavior change: If you use a custom syntax definition that
5856 refers to a syntax you haven't loaded, pandoc will now complain when
5857 it is highlighting the text, rather than doing a check at the start.
5858 This change dramatically speeds up invocations of pandoc on short
5859 inputs.
5861 * Text.Pandoc.Class: make `FileTree` opaque (don't export
5862 `FileTree` constructor). This forces users to interact with it using
5863 `insertInFileTree` and `getFileInfo`, which normalize file names.
5865 * Markdown reader:
5867 + Rewrite `inlinesInBalancedBrackets`. The rewrite is much more
5868 direct, avoiding `parseFromString`. And it performs significantly
5869 better; unfortunately, parsing time still increases exponentially
5870 (see #1735).
5871 + Avoid parsing raw tex unless `\` + letter seen. This seems to
5872 help with the performance problem, #4216.
5874 * LaTeX reader: Simplified a check for raw tex command.
5876 * Muse reader (Alexander Krotov):
5878 + Enable round trip test (#4107).
5879 + Automatically translate `#cover` into `#cover-image`.
5880 Amusewiki uses #cover directive to specify cover image.
5882 * Docx reader (Jesse Rosenthal):
5884 + Allow for insertion/deletion of paragraphs (#3927).
5885 If the paragraph has a deleted or inserted paragraph break (depending
5886 on the track-changes setting) we hold onto it until the next
5887 paragraph. This takes care of accept and reject. For this we introduce
5888 a new state which holds the ils from the previous para if necessary.
5889 For `--track-changes=all`, we add an empty span with class
5890 `paragraph-insertion`/`paragraph-deletion` at the end of the paragraph
5891 prior to the break to be inserted or deleted.
5892 + Remove unused anchors (#3679). Docx produces a lot of anchors with
5893 nothing pointing to them---we now remove these to produce cleaner
5894 output. Note that this has to occur at the end of the process
5895 because it has to follow link/anchor rewriting.
5896 + Read multiple children of `w:sdtContents`.
5897 + Combine adjacent anchors. There isn't any reason to have numerous
5898 anchors in the same place, since we can't maintain docx's
5899 non-nesting overlapping. So we reduce to a single anchor.
5900 + Improved tests.
5902 * Muse writer (Alexander Krotov): don't escape URIs from AST
5904 * Docx writer:
5906 + Removed redundant subtitle in title (Sebastian Talmon).
5907 + `firstRow` table definition compatibility for Word 2016 (Sebastian
5908 Talmon). Word 2016 seems to use a default value of "1" for table
5909 headers, if there is no firstRow definition (although a default
5910 value of 0 is documented), so all tables get the first Row formatted
5911 as header. Setting the parameter to 0 if the table has no header
5912 row fixes this for Word 2016
5913 + Fix custom styles with spaces in the name (#3290).
5915 * Powerpoint writer (Jesse Rosenthal):
5917 + Ignore Notes div for parity with other slide outputs.
5918 + Set default slidelevel correctly. We had previously defaulted to
5919 slideLevel 2. Now we use the correct behavior of defaulting to the
5920 highest level header followed by content. We change an expected test
5921 result to match this behavior.
5922 + Split blocks correctly for linked images.
5923 + Combine adjacent runs.
5924 + Make inline code inherit code size. Previously (a) the code size
5925 wasn't set when we force size, and (b) the properties was set from
5926 the default, instead of inheriting.
5927 + Simplify `replaceNamedChildren` function.
5928 + Allow linked images. The following markdown:
5929 `[![Image Title](image.jpg)](http://www.example.com)`
5930 will now produce a linked image in the resulting PowerPoint file.
5931 + Fix error with empty table cell. We require an empty `<a:p>` tag,
5932 even if the cell contains no paragraphs---otherwise PowerPoint
5933 complains of corruption.
5934 + Implement two-column slides. This uses the columns/column div
5935 format described in the pandoc manual. At the moment, only two
5936 columns (half the screen each) are allowed. Custom widths are not
5937 supported.
5938 + Added more tests.
5940 * OpenDocument/ODT writers: improved rendering of formulas (#4170, oltolm).
5942 * Lua filters (Albert Krewinkel):
5944 + `data/pandoc.lua`: drop 'pandoc-api-version' from Pandoc objects
5945 + The current pandoc-types version is made available to Lua programs in
5946 the global `PANDOC_API_VERSION`. It contains the version as a list of
5947 numbers.
5948 + The pandoc version available as a global `PANDOC_VERSION` (a list
5949 of numbers).
5950 + `data/pandoc.lua`: make `Attr` an `AstElement`.
5951 + `data/pandoc.lua`: make all types subtypes of `AstElement`.
5952 `Pandoc`, `Meta`, and `Citation` were just plain functions and did
5953 not set a metatable on the returned value, which made it difficult
5954 to amend objects of these types with new behavior. They are now
5955 subtypes of AstElement, meaning that all their objects can gain
5956 new features when a method is added to the behavior object
5957 (e.g., `pandoc.Pandoc.behavior`).
5958 + `data/pandoc.lua`: split type and behavior tables. Clearly distinguish
5959 between a type and the behavioral properties of an instance of that
5960 type. The behavior of a type (and all its subtypes) can now be
5961 amended by adding methods to that types `behavior` object, without
5962 exposing the type objects internals. E.g.:
5963 ```lua
5964 pandoc.Inline.behavior.frob = function () print'42' end
5965 local str = pandoc.Str'hello'
5966 str.frob() -- outputs '42'
5967 ```
5968 + `data/pandoc.lua`: fix Element inheritance. Extending all elements
5969 of a given type (e.g., all inline elements) was difficult, as the
5970 table used to lookup unknown methods would be reset every time a
5971 new element of that type was created, preventing recursive property
5972 lookup. This is was changed in that all methods and attributes of
5973 supertypes are now available to their subtypes.
5974 + `data/pandoc.lua`: fix attribute names of Citation (#4222). The
5975 fields were named like the Haskell fields, not like the documented,
5976 shorter version. The names are changed to match the documentation
5977 and Citations are given a shared metatable to enable simple
5978 extensibility.
5979 + `data/pandoc.lua`: drop function `pandoc.global_filter`.
5980 + Bump `hslua` version to 0.9.5. This version fixes a bug that made it
5981 difficult to handle failures while getting lists or a Map from Lua.
5982 A bug in pandoc, which made it necessary to always pass a tag when
5983 using MetaList or MetaBlock, is fixed as a result. Using the pandoc
5984 module's constructor functions for these values is now optional
5985 (if still recommended).
5986 + Stop exporting `pushPandocModule` (API change). The introduction
5987 of `runPandocLua` renders direct use of this function obsolete.
5988 + Update generation of module docs for lua filters.
5989 + `Lua.Module.Utils`: make stringify work on `MetaValues` (John
5990 MacFarlane). I'm sure this was intended in the first place,
5991 but currently only `Meta` is supported.
5993 * Improve benchmarks.
5995 + Set the default extensions properly.
5996 + Improve benchmark argument parsing. You can now say
5997 `make bench BENCHARGS="markdown latex reader"` and both the
5998 markdown and latex readers will be benchmarked.
6000 * MANUAL.txt simplify and add more structure (Mauro Bieg).
6002 * Generate README.md from template and MANUAL.txt.
6003 `make README.md` will generate the README.md after changes
6004 to MANUAL.txt have been made.
6006 * Update copyright notices to include 2018 (Albert Krewinkel).
6008## pandoc 2.0.6 (2017-12-28)
6010 * Added `jats` as an input format.
6012 + Add Text.Pandoc.Readers.JATS, exporting `readJATS` (API
6013 change) (Hamish Mackenzie).
6014 + Improved citation handling in JATS reader. JATS citations
6015 are now converted to pandoc citations, and JATS ref-lists
6016 are converted into a `references` field in metadata, suitable
6017 for use with pandoc-citeproc. Thus a JATS article with embedded
6018 bibliographic information can be processed with pandoc and
6019 pandoc-citeproc to produce a formatted bibliography.
6021 * Allow `--list-extensions` to take an optional FORMAT argument.
6022 This lists the extensions set by default for the selected FORMAT.
6023 The extensions are now alphabetized, and the `+` or `-`
6024 indicating the default setting comes before, rather than after,
6025 the extension.
6027 * Markdown reader:
6029 + Preserve original whitespace between blocks.
6030 + Recognize `\placeformula` as context.
6031 + Be pickier about table captions. A caption starts with a `:` which
6032 can't be followed by punctuation. Otherwise we can falsely interpret
6033 the start of a fenced div, or even a table header line like
6034 `:--:|:--:`, as a caption.
6035 + Always use four space rule for example lists. It would be awkward
6036 to indent example list contents to the first non-space character after
6037 the label, since example list labels are often long. Thanks to
6038 Bernhard Fisseni for the suggestion.
6039 + Improve raw tex parsing. Note that the Markdown reader is also
6040 affected by the `latex_macros` extension changes described below
6041 under the LaTeX reader.
6043 * LaTeX reader:
6045 + `latex_macros` extension changes (#4179). Don't pass through macro
6046 definitions themselves when `latex_macros` is set. The macros
6047 have already been applied. If `latex_macros` is enabled, then
6048 `rawLaTeXBlock` in Text.Pandoc.Readers.LaTeX will succeed in parsing
6049 a macro definition, and will update pandoc's internal macro map
6050 accordingly, but the empty string will be returned.
6051 + Export `tokenize`, `untokenize` (API change).
6052 + Use `applyMacros` in `rawLaTeXBlock`, `rawLaTeXInline`.
6053 + Refactored `inlineCommand`.
6054 + Fix bug in tokenizer. Material following `^^` was
6055 dropped if it wasn't a character escape. This only affected
6056 invalid LaTeX, so we didn't see it in the wild, but it appeared
6057 in a QuickCheck test failure.
6058 + Fix regression in LateX tokenization (#4159). This mainly affects the
6059 Markdown reader when parsing raw LaTeX with escaped spaces.
6060 + Add tests of LaTeX tokenizer.
6061 + Support `\foreignlanguage` from babel.
6062 + Be more tolerant of `&` character (#4208). This allows us to parse
6063 unknown tabular environments as raw LaTeX.
6065 * Muse reader (Alexander Krotov):
6067 + Parse anchors immediately after headings as IDs.
6068 + Require that note references does not start with 0.
6069 + Parse empty comments correctly.
6071 * Org reader (Albert Krewinkel):
6073 + Fix asterisks-related parsing error (#4180).
6074 + Support minlevel option for includes (#4154). The level of headers
6075 in included files can be shifted to a higher level by specifying a
6076 minimum header level via the `:minlevel` parameter. E.g.
6077 `#+include: "tour.org" :minlevel 1` will shift the headers in
6078 tour.org such that the topmost headers become level 1 headers.
6079 + Break-up org reader test file into multiple modules.
6081 * OPML reader:
6083 + Enable raw HTML and other extensions by default for notes
6084 (#4164). This fixes a regression in 2.0. Note that extensions can
6085 now be individually disabled, e.g. `-f opml-smart-raw_html`.
6087 * RST reader:
6089 + Allow empty list items (#4193).
6090 + More accurate parsing of references (#4156). Previously we erroneously
6091 included the enclosing backticks in a reference ID (#4156). This
6092 change also disables interpretation of syntax inside references, as
6093 in docutils. So, there is no emphasis in `` `my *link*`_ ``.
6095 * Docx reader:
6097 + Continue lists after interruption (#4025, Jesse Rosenthal).
6098 Docx expects that lists will continue where they left off after an
6099 interruption and introduces a new id if a list is starting again. So
6100 we keep track of the state of lists and use them to define a "start"
6101 attribute, if necessary.
6102 + Add tests for structured document tags unwrapping (Jesse Rosenthal).
6103 + Preprocess Document body to unwrap `w:sdt` elements (Jesse Rosenthal,
6104 #4190).
6106 * Plain writer:
6108 + Don't linkify table of contents.
6110 * RST writer:
6112 + Fix anchors for headers (#4188). We were missing an `_`.
6114 * PowerPoint writer (Jesse Rosenthal):
6116 + Treat lists inside BlockQuotes as lists. We don't yet produce
6117 incremental lists in PowerPoint, but we should at least treat lists
6118 inside BlockQuotes as lists, for compatibility with other slide formats.
6119 + Add ability to force size. This replaces the more specific
6120 `blockQuote runProp`, which only affected the size of blockquotes. We
6121 can use this for notes, etc.
6122 + Implement notes. This currently prints all notes on a final slide.
6123 Note that at the moment, there is a danger of text overflowing the
6124 note slide, since there is no logic for adding further slides.
6125 + Implement basic definition list functionality to PowerPoint writer.
6126 + Don't look for default template file for Powerpoint (#4181).
6127 + Add pptx to isTextFormat list. This is used to check standalone
6128 and not writing to the terminal.
6129 + Obey slide level option (Jesse Rosenthal).
6130 + Introduce tests.
6132 * Docx writer:
6134 + Ensure that `distArchive` is the one that comes with pandoc
6135 (#4182). Previously a `reference.docx` in `~/.pandoc` (or the user data
6136 dir) would be used instead, and this could cause problems because a
6137 user-modified docx sometimes lacks vital sections that we count
6138 on the `distArchive` to supply.
6140 * Org writer:
6142 + Do not wrap "-" to avoid accidental bullet lists (Alexander Krotov).
6143 + Don't allow fn refs to wrap to beginning of line (#4171, with help from
6144 Alexander Krotov). Otherwise they can be interpreted as footnote
6145 definitions.
6147 * Muse writer (Alexander Krotov):
6149 + Don't wrap note references to the next line (#4172).
6151 * HTML writer:
6153 + Use br elements in line blocks instead of relying on CSS
6154 (#4162). HTML-based templates have had the custom CSS for
6155 `div.line-block` removed. Those maintaining custom templates will want
6156 to remove this too. We still enclose line blocks in a div with class
6157 `line-block`.
6159 * LaTeX writer:
6161 + Use `\renewcommand` for `\textlatin` with babel (#4161).
6162 This avoids a clash with a deprecated `\textlatin` command defined
6163 in Babel.
6164 + Allow fragile=singleslide attribute in beamer slides (#4169).
6165 + Use `\endhead` after `\toprule` in headerless tables (#4207).
6167 * FB2 writer:
6169 + Add cover image specified by `cover-image` meta (Alexander Krotov,
6170 #4195).
6172 * JATS writer (Hamish Mackenzie):
6174 + Support writing `<fig>` and `<table-wrap>` elements
6175 with `<title>` and `<caption>` inside them by using Divs with class set
6176 to one of `fig`, `table-wrap` or `caption` (Hamish Mackenzie). The
6177 title is included as a Heading so the constraint on where Heading can
6178 occur is also relaxed.
6179 + Leave out empty alt attributes on links.
6180 + Deduplicate image mime type code.
6181 + Make `<p>` optional in `<td>` and `<th>` (#4178).
6182 + Self closing tags for empty xref (#4187).
6183 + Improve support for code language.
6185 * Custom writer:
6187 + Use init file to setup Lua interpreter (Albert Krewinkel).
6188 The same init file (`data/init`) that is used to setup the Lua
6189 interpreter for Lua filters is also used to setup the interpreter of
6190 custom writers.lua.
6191 + Define instances for newtype wrapper (Albert Krewinkel). The custom
6192 writer used its own `ToLuaStack` instance definitions, which made
6193 it difficult to share code with Lua filters, as this could result
6194 in conflicting instances. A `Stringify` wrapper is introduced to
6195 avoid this problem.
6196 + Added tests for custom writer.
6197 + Fixed definition lists and tables in `data/sample.lua`.
6199 * Fixed regression: when target is PDF, writer extensions were being
6200 ignored. So, for example, `pandoc -t latex-smart -o file.pdf`
6201 did not work properly.
6203 * Lua modules (Albert Krewinkel):
6205 + Add `pandoc.utils` module, to hold utility functions.
6206 + Create a Haskell module Text.Pandoc.Lua.Module.Pandoc to
6207 define the `pandoc` lua module.
6208 + Make a Haskell module for each Lua module. Move definitions for the
6209 `pandoc.mediabag` modules to a separate Haskell module.
6210 + Move `sha1` from the main `pandoc` module to `pandoc.utils`.
6211 + Add function `pandoc.utils.hierarchicalize` (convert list of
6212 Pandoc blocks into (hierarchical) list of Elements).
6213 + Add function `pandoc.utils.normalize_date` (parses a date and
6214 converts it (if possible) to "YYYY-MM-DD" format).
6215 + Add function `pandoc.utils.to_roman_numeral` (allows conversion
6216 of numbers below 4000 into roman numerals).
6217 + Add function `pandoc.utils.stringify` (converts any AST element
6218 to a string with formatting removed).
6219 + `data/init.lua`: load `pandoc.utils` by default
6220 + Turn pipe, read into full Haskell functions. The `pipe` and `read`
6221 utility functions are converted from hybrid lua/haskell functions
6222 into full Haskell functions. This avoids the need for intermediate
6223 `_pipe`/`_read` helper functions, which have dropped.
6224 + pandoc.lua: re-add missing MetaMap function. This was a bug
6225 introduced in version 2.0.4.
6227 * Text.Pandoc.Class: Add `insertInFileTree` [API change]. This gives
6228 a pure way to insert an ersatz file into a `FileTree`. In addition, we
6229 normalize paths both on insertion and on lookup.
6231 * Text.Pandoc.Shared: export `blocksToInlines'` (API change, Maura Bieg).
6233 * Text.Pandoc.MIME: Add opus to MIME type table as audio/ogg (#4198).
6235 * Text.Pandoc.Extensions: Alphabetical order constructors for
6236 `Extension`. This makes them appear in order in `--list-extensions`.
6238 * Allow lenient decoding of latex error logs, which are not always
6239 properly UTF8-encoded (#4200).
6241 * Update latex template to work with recent versions of beamer.
6242 The old template produced numbered sections with some recent
6243 versions of beamer. Thanks to Thomas Hodgson.
6245 * Updated reference.docx (#4175). Instead of just "Hello, world", the
6246 document now contains exemplars of most of the styles that have an
6247 effect on pandoc documents. This makes it easier to see the effect
6248 of style changes.
6250 * Removed `default.theme` data file (#4096). It is no longer needed now
6251 that we have `--print-highlight-style`.
6253 * Added `stack.lts9.yaml` for building with lts 9 and ghc 8.0.2.
6254 We still need this for the alpine static linux build, since
6255 we don't have ghc 8.2.2 for that yet.
6257 * Removed `stack.pkg.yaml`. We only really need `stack.yaml`; we
6258 can put flag settings for pandoc-citeproc there.
6260 * Makefile: Add 'trypandoc' and 'pandoc-templates' targets to
6261 make releases easier.
6263 * MANUAL.txt:
6265 + Add note on what formats have `+smart` by default.
6266 + Use native syntax for custom-style (#4174, Mauro Bieg).
6267 + Introduce dedicated Extensions section, since some extensions
6268 affect formats other than markdown (Mauro Bieg, #4204).
6269 + Clarify default html output for `--section-divs` (Richard Edwards).
6271 * filters.md: say that Text.Pandoc.JSON comes form pandoc-types.
6272 Closes jgm/pandoc-website#16.
6274 * epub.md: Delete removed `-S` option from command (#4151, Georger Araújo).
6276## pandoc 2.0.5 (2017-12-12)
6278 * Fix a bug in 2.0.4, whereby pandoc could not read the theme files
6279 generated with `--print-highlight-style` (#4133). Improve JSON
6280 serialization of styles.
6282 * Fix CSS issues involving line numbers (#4128).
6283 Highlighted code blocks are now enclosed in a div with class `sourceCode`.
6284 Highlighting CSS no longer sets a generic color for pre and code; we only
6285 set these for class `sourceCode`.
6287 * `--pdf-engine-opt`: fix bug where option order was reversed (#4137).
6289 * Add PowerPoint (pptx) writer (Jesse Rosenthal).
6290 It works following the standard Pandoc conventions for making other
6291 sorts of slides. Caveats:
6293 + Syntax highlighting is not yet implemented. (This is difficult
6294 because there are no character classes in Powerpoint.)
6295 + Footnotes and Definition lists are not yet implemented. (Notes will
6296 usually take the form of a final slide.
6297 + Image placement and auto-resizing has a few glitches.
6298 + Reference powerpoint files don't work dependably from the command
6299 line. This will be implemented, but at the moment users are advised
6300 to change themes from within Powerpoint.
6302 * Create shared Text.Pandoc.Writers.OOXML module (Jesse Rosenthal).
6303 This is for functions used by both Powerpoint and Docx writers.
6305 * Add default pptx data for Powerpoint writer (Jesse Rosenthal).
6307 * Add `empty_paragraphs` extension.
6309 + Deprecate `--strip-empty-paragraphs` option. Instead we now
6310 use an `empty_paragraphs` extension that can be enabled on
6311 the reader or writer. By default, disabled.
6312 + Add `Ext_empty_paragraphs` constructor to `Extension`.
6313 + Revert "Docx reader: don't strip out empty paragraphs."
6314 This reverts commit d6c58eb836f033a48955796de4d9ffb3b30e297b.
6315 + Implement `empty_paragraphs` extension in docx reader and writer,
6316 opendocument writer, html reader and writer.
6317 + Add tests for `empty_paragraphs` extension.
6319 * Markdown reader:
6321 + Don't parse native div as table caption (#4119).
6322 + Improved computation of column widths in pipe tables.
6323 Pipe tables with lines longer than the text width (as set
6324 by `--columns`) are now scaled to text width, with the relative
6325 widths of columns determined by the ratios between the
6326 header lines. Previously we computed column widths using
6327 the ratio of header line lengths to column width, so that
6328 tables with narrow header lines were extremely thin, which
6329 was very rarely the desired result.
6331 * LaTeX reader: fix `\` before newline (#4134). This should be a space,
6332 as long as it's not followed by a blank line. This has been fixed at the
6333 tokenizer level.
6335 * Muse reader (Alexander Krotov):
6337 + Add test for `#disable-tables` directive in Emacs mode.
6338 + Don't allow emphasis to be preceded by letter.
6339 + Add underline support in Emacs Muse mode..
6340 + Support multiline directives in Amusewiki mode
6342 * Man writer: omit internal links (#4136). That is, just print the link
6343 text without the URL.
6345 * Markdown reader: accept processing instructions as raw HTML (#4125).
6347 * Lua filters (Albert Krewinkel):
6349 + Use script to initialize the interpreter. The file `init.lua` is
6350 used to initialize the Lua interpreter which is used in Lua filters.
6351 This gives users the option to require libraries which they want to
6352 use in all of their filters, and to extend default modules.
6353 + Fix package loading for Lua 5.1. The list of package searchers is
6354 named `package.loaders` in Lua 5.1 and LuaJIT, and `package.searchers`
6355 in Lua 5.2 and later.
6356 + Refactor lua module handling. The integration with Lua's package/module
6357 system is improved: A pandoc-specific package searcher is prepended to
6358 the searchers in `package.searchers`. The modules `pandoc` and
6359 `pandoc.mediabag` can now be loaded via `require`.
6360 + Bump lower bound of hslua. The release hslua 0.9.3 contains a new
6361 function which makes using Haskell functions as package loaders much
6362 easier.
6364 * reveal.js template: add title-slide identifier to title slide (#4120).
6365 This allows it to be styled more easily.
6367 * LaTeX template: Added support for `pagestyle` variable (#4135,
6368 Thomas Hodgson)
6370 * Add `-threaded` to ghc-options for executable (#4130, fixes a build
6371 error on linux).
6374## pandoc 2.0.4 (2017-12-03)
6376 * Add `--print-highlight-style` option. This generates a JSON version
6377 of a highlighting style, which can be saved as a `.theme` file, modified,
6378 and used with `--highlight-style` (#4106, #4096).
6380 * Add `--strip-empty-paragraphs` option. This works for any input format.
6381 It is primarily intended for use with docx and odt documents where
6382 empty paragraphs have been used for inter-paragraph spaces.
6384 * Support `--webtex` for `gfm` output.
6386 * Recognize `.muse` file extension.
6388 * Support beamer `\alert` in LaTeX reader. Closes #4091.
6390 * Docx reader: don't strip out empty paragraphs (#2252).
6391 Users who have a conversion pipeline from docx may want to consider adding
6392 `--strip-empty-paragraphs` to the command line.
6394 * Org reader (Albert Krewinkel): Allow empty list items (#4090).
6396 * Muse reader (Alexander Krotov):
6398 + Parse markup in definition list terms.
6399 + Allow definition to end with EOF.
6400 + Make code blocks round trip.
6401 + Drop common space prefix from list items.
6402 + Add partial round trip test.
6403 + Don't interpret XML entities.
6404 + Remove `nested`.
6405 + Parse `~~` as non-breaking space in Emacs mode.
6406 + Correctly remove indentation from notes. Exactly one space is
6407 required and considered to be part of the marker.
6408 + Allow list items to be empty.
6409 + Add ordered list test.
6410 + Add more multiline definition tests.
6411 + Don't allow blockquotes within lists.
6412 + Fix reading of multiline definitions.
6413 + Add inline `<literal>` support.
6414 + Concatenate inlines of the same type
6416 * Docx writer: allow empty paragraphs (#2252).
6418 * CommonMark/gfm writer:
6420 + Use raw html for native divs/spans (#4113). This allows a pandoc
6421 markdown native div or span to be rendered in gfm using raw html tags.
6422 + Implement `raw_html` and `raw_tex` extensions. Note that `raw_html`
6423 is enabled by default for `gfm`, while `raw_tex` is disabled by default.
6425 * Muse writer (Alexander Krotov):
6427 + Test that inline math conversion result is normalized.
6428 Without normalization this test produced
6429 `<em>a</em><em>b</em><em>c</em>`.
6430 + Improve inline list normalization and move to writer.
6431 + Escape hash symbol.
6432 + Escape `----` to avoid accidental horizontal rules.
6433 + Escape only `</code>` inside code tag.
6434 + Additional `<verbatim>` is not needed as `<code>` is verbatim already.
6436 * LaTeX writer:
6438 + Allow specifying just width or height for image size.
6439 Previously both needed to be specified (unless the image was
6440 being resized to be smaller than its original size).
6441 If height but not width is specified, we now set width to
6442 textwidth. If width but not height is specified, we now set
6443 height to textheight. Since we have `keepaspectratio`, this
6444 yields the desired result.
6445 + Escape `~` and `_` in code with `--listings` (#4111).
6447 * HTML writer: export `tagWithAttributes`. This is a helper allowing
6448 other writers to create single HTML tags.
6450 * Let papersizes `a0`, `a1`, `a2`, ... be case-insensitive by
6451 converting the case as needed in LaTeX and ConTeXt writers.
6453 * Change `fixDisplayMath` from `Text.Pandoc.Writers.Shared`
6454 so that it no longer produces empty `Para`'s as an artifact.
6456 * `Text.Pandoc.Shared.blocksToInlines`: rewrote using builder.
6457 This gives us automatic normalization, so we don't get
6458 for example two consecutive Spaces.
6460 * Include default CSS for 'underline' class in HTML-based templates.
6462 * revealjs template: add `tex2jax` configuration for the
6463 math plugin. With the next release of reveal.js, this will
6464 fix the problem of `$`s outside of math contexts being
6465 interpreted as math delimiters (#4027).
6467 * `pandoc.lua` module for use in lua filters (Albert Krewinkel):
6469 + Add basic lua List module (#4099, #4081). The List module is
6470 automatically loaded, but not assigned to a global variable. It can be
6471 included in filters by calling `List = require 'List'`. Lists of blocks,
6472 lists of inlines, and lists of classes are now given `List` as a metatable,
6473 making working with them more convenient. E.g., it is now possible to
6474 concatenate lists of inlines using Lua's concatenation operator `..`
6475 (requires at least one of the operants to have `List` as a metatable):
6477 function Emph (emph)
6478 local s = {pandoc.Space(), pandoc.Str 'emphasized'}
6479 return pandoc.Span(emph.content .. s)
6480 end
6482 The `List` metatable is assigned to the tables which get passed to
6483 the constructors `MetaBlocks`, `MetaInline`, and `MetaList`. This
6484 enables the use of the resulting objects as lists.
6485 + `Lua/StackInstances`: push Pandoc and Meta via constructor.
6486 Pandoc and Meta elements are now pushed by calling the respective
6487 constructor functions of the pandoc Lua module. This makes serialization
6488 consistent with the way blocks and inlines are pushed to lua and allows
6489 to use List methods with the `blocks` value.
6490 + Add documentation for pandoc.List in `lua-filters.md`.
6492 * Use latest tagsoup. This fixes a bug in parsing HTML tags with
6493 `&` (but not a valid entity) following them (#4094, #4088).
6495 * Use skylighting 0.4.4.1, fixing the color of unmarked code text
6496 when `numberLines` is used (#4103).
6498 * Make `normalizeDate` more forgiving (Mauro Bieg, #4101), not
6499 requiring a leading 0 on single-digit days.
6501 * Fix `--help` output for `--highlight-style` to include `FILE` (Mauro
6502 Bieg, #4095).
6504 * Clearer deprecation warning for `--latexmathml, --asciimathml, -m`.
6505 Previously we only mentioned `--latexmathml`, even if `-m` was
6506 used.
6508 * Changelog: fix description of lua filters in 2.0 release
6509 (Albert Krewinkel). Lua filters were initially run *after* conventional
6510 (JSON) filters. However, this was changed later to make it easier to deal
6511 with files in the mediabag. The changelog is updated to describe that
6512 feature of the 2.0 release correctly.
6514 * Change Generic JSON instances to TemplateHaskell (Jasper Van der Jeugt,
6515 #4085). This reduces compile time and memory usage significantly.
6517 * `lua-filters.md`: Added tikz filter example.
6519 * Create alternative zip file for macOS binaries.
6521 * Create alternative zip file for Windows binaries.
6523 * Update INSTALL.md since we now provide zips for binaries.
6525 * Relax `http-types` dependency (Justus Sagemüller, #4084).
6527 * Add `epub.md`, `getting-started.md` to docs. These used to live in
6528 the website repo.
6530 * Add `packages` target to Makefile.
6532 * Bump bounds for binary, http-types, tasty-hunit
6534## pandoc 2.0.3 (2017-11-20)
6536 * Lua filters: preload text module (Albert Krewinkel, #4077).
6537 The `text` module is preloaded in lua. The module contains some UTF-8
6538 aware string functions, implemented in Haskell. The module is loaded on
6539 request only, e.g.:
6541 text = require 'text'
6542 function Str (s)
6543 s.text = text.upper(s.text)
6544 return s
6545 end
6547 * Allow table-like access to attributes in lua filters (Albert Krewinkel,
6548 #4071). Attribute lists are represented as associative lists in Lua. Pure
6549 associative lists are awkward to work with. A metatable is attached to
6550 attribute lists, allowing to access and use the associative list as if
6551 the attributes were stored in as normal key-value pair in table.
6552 Note that this changes the way `pairs` works on attribute lists. Instead
6553 of producing integer keys and two-element tables, the resulting iterator
6554 function now returns the key and value of those pairs. Use `ipairs` to
6555 get the old behavior. Warning: the new iteration mechanism only works if
6556 pandoc has been compiled with Lua 5.2 or later (current default: 5.3).
6558 * Text.Pandoc.Parsing.uri: allow `&` and `=` as word characters (#4068).
6559 This fixes a bug where pandoc would stop parsing a URI with an
6560 empty attribute: for example, `&a=&b=` wolud stop at `a`.
6561 (The uri parser tries to guess which punctuation characters
6562 are part of the URI and which might be punctuation after it.)
6564 * Introduce `HasSyntaxExtensions` typeclass (Alexander Krotov, #4074).
6566 + Added new `HasSyntaxExtensions` typeclass for `ReaderOptions` and
6567 `WriterOptions`.
6568 + Reimplemented `isEnabled` function from `Options.hs` to accept both
6569 `ReaderOptions` and `WriterOptions`.
6570 + Replaced `enabled` from `CommonMark.hs` with new `isEnabled`.
6572 * Add `amuse` extension (Alexander Krotov) to enable Amuse wiki
6573 behavior for `muse`. New `Ext_amuse` constructor for
6574 `Extension`. Note: this is switched on by default; for
6575 Emacs behavior, use `muse-amuse`.
6577 * Muse reader (Alexander Krotov):
6579 + Count only one space as part of list item marker.
6580 + Produce SoftBreaks on newlines. Now wrapping can be preserved
6581 with `--wrap=preserve`.
6582 + Add Text::Amuse footnote extensions. Footnote end is indicated by
6583 indentation, so footnotes can be placed anywhere in the text,
6584 not just at the end of it.
6585 + Accept Emacs Muse definition lists when `-amuse`.
6586 Emacs Muse does not require indentation.
6588 * HTML reader:
6590 + Ensure we don't produce level 0 headers (#4076), even for chapter
6591 sections in epubs. This causes problems because writers aren't set
6592 up to expect these.
6593 + Allow spaces after `\(` and before `\)` with `tex_math_single_backslash`.
6594 Previously `\( \frac{1}{a} < \frac{1}{b} \)` was not parsed as math in
6595 `markdown` or `html` `+tex_math_single_backslash`.
6597 * MANUAL: clarify that math extensions work with HTML.
6598 Clarify that `tex_math_dollars` and `tex_math_single_backslash`
6599 will work with HTML as well as Markdown.
6601 * Creole reader: Fix performance issue for longer lists (Sascha Wilde,
6602 #4067).
6604 * RST reader: better support for 'container' directive (#4066).
6605 Create a div, incorporate name attribute and classes.
6607 * LaTeX reader:
6609 + Support column specs like `*{2}{r}` (#4056). This is equivalent to
6610 `rr`. We now expand it like a macro.
6611 + Allow optional args for parbox (#4056).
6612 + Allow optional arguments on `\footnote` (#4062).
6614 * EPUB writer: Fixed path for cover image (#4069). It was previously
6615 `media/media/imagename`, and should have been `media/imagename`.
6617 * Markdown writer: fix bug with doubled footnotes in grid tables
6618 (#4061).
6620 * LaTeX template: include natbib/biblatex after polyglossia (#4073).
6621 Otherwise we seem to get an error; biblatex wants polyglossia
6622 language to be defined.
6624 * Added examples to lua filters documentation.
6627## pandoc 2.0.2 (2017-11-12)
6629 * Deprecated ancient HTML math methods: `--latexmathml`, `--gladtex`,
6630 `--mimetex`, `--jsmath`.
6632 * Fixed URIs in `data/jats.csl`. They were being rendered twice,
6633 leading to invalid XML in default JATS output with pandoc-citeproc.
6635 * `lua-filters.md`: use real-world man page filter as example.
6637 * Add lua filter functions `walk_inline` and `walk_block`
6638 in the pandoc module, to apply filters inside particular
6639 inline and block elements.
6641 * Refactored some code from `Text.Pandoc.Lua.PandocModule`
6642 into new internal module `Text.Pandoc.Lua.Filter`.
6644 * Markdown reader:
6646 + Allow fenced code blocks to be indented 1-3 spaces (#4011).
6647 This brings our handling of them into alignment with CommonMark's.
6648 + Fix YAML metadata with "chomp" (`|-`). Previously if a
6649 YAML block under `|-` contained a blank line, pandoc would
6650 not parse it as metadata.
6652 * Removed `etc.` from abbreviations file. Often `etc.` ends a
6653 sentence, and we want the period to be treated as a
6654 sentence-ending period.
6656 * Fix regression with `--metadata` (#4054). Values specified with
6657 `--metadata` should replace a metadata value set in the document
6658 itself, rather than creating a list including a new value.
6660 * EPUB writer:
6662 + Fix EPUB OCF structure. #3720 had been improperly implemented.
6663 + Fix modified paths for raw HTML tags (src, poster, etc.)
6664 (#4050, #4055). This had not been updated for the new EPUB
6665 container layout, with a separate text/ subdirectory.
6666 + Fix image paths with empty `--epub-subdirectory`.
6668 * Miscellaneous code cleanup (Alexander Krotov).
6670 * Use pandoc-types 1.17.3, which adds `Walkable` instances
6671 for `[Block] Block` and `[Inline] Inline`.
6673 * Remove obsolete `stack.full.yaml` (#4052).
6675 * Change to using pandoc-citeproc 0.12.1 in binary packages.
6677 * Consolidate math output method documentation (#4049, Mauro Bieg).
6679 * `MANUAL.txt`: fix header level of "Extension: emoji" (Albert Krewinkel).
6681 * Use lua filter to generate man page from `MANUAL.txt`, replacing old
6682 Haskell filters. This is easier and faster.
6684 * Improved `INSTALL.md`.
6686 * Update commands to extract deb archive on Linux (#4043, Salim B).
6689## pandoc 2.0.1.1 (2017-11-04)
6691 * Improved fix to #3989 (parsing of HTML tags containing
6692 `>` in an attribute or comment). The previous fix (in 2.0.1) only
6693 worked in certain cases.
6695 * FB2 writer (Alexander Krotov):
6697 + Add `unrecognised` genre to `<title-info>`
6698 (Alexander Krotov). XML schema requires at least one genre.
6699 + Remove `<annotation>` from `<body>`.
6701 * CommonMark writer: fix strikethrough for `gfm` (#4038).
6703 * Use texmath 0.10, which adds support for a wider range of
6704 symbols and fixes default column alignments in MathML
6705 and OMML.
6707 * Highlighting fixes, using skylighting 0.4.3.2:
6709 + Fix invalid CSS.
6710 + Support `lineAnchors` (or `line-anchors`) in HTML code blocks.
6711 + Ensure that code lines don't get duplicate identifiers (#4031).
6712 The line identifiers are built using the code block's identifier
6713 as a prefix. If the code block has null identifier, we use
6714 `cb1`, `cb2`, etc.
6716 * Added a few abbreviations to `data/abbreviations`,
6717 and sorted the list (#3984, Wandmalfarbe).
6719 * Improved support for columns in HTML writer (#4028).
6721 + Remove `width` attribute from the `div`.
6722 + Remove space between `<div class="column">` elements,
6723 since this prevents columns whose widths sum to 100%
6724 (the space takes up space).
6725 + Move as much as possible of the CSS to the template.
6726 + Ensure that all the HTML-based templates (including epub)
6727 contain the CSS for columns.
6728 + Columns default to 50% width unless they are given a width
6729 attribute. So if you want two equal-width columns, you
6730 can use a div with class `column` and no `width` attribute.
6732 * SelfContained: use `base64` for css links with media attribute (#4026).
6733 This fixes `--self-contained` with S5.
6735 * Improve `pandoc-template-mode.el` (Vaclav Haisman).
6737 * INSTALL.md: MacOS instructions needed xar -f (adam234).
6739 * MANUAL.txt:
6741 + Clarify that --setext-headers doesn't affect gfm output (#4035).
6742 + Clarify what is needed to open and close a div in `fenced_divs`
6743 (#4039, Tristano Ajmone).
6744 + Removed reference to `default.beamer` in docs (#4024).
6745 Also added mention of other templates affecting PDF output
6746 with different settings.
6749## pandoc 2.0.1 (2017-10-31)
6751 * Fixed regression in parsing of HTML comments in markdown and other
6752 non-HTML formats (`Text.Pandoc.Readers.HTML.htmlTag`) (#4019).
6753 The parser stopped at the first `>` character, even if it wasn't
6754 the end of the comment.
6756 * Creole reader (Sascha Wilde):
6758 + Fix some minor typos and formatting.
6759 + Add additional test on nowiki-block after para.
6760 + Fix lists with trailing white space.
6762 * LaTeX reader: handle `%` comment right after command.
6763 For example, `\emph%`.
6765 * Markdown reader: make sure fenced div closers work in lists.
6766 Previously the following failed:
6768 ::: {.class}
6769 1. one
6770 2. two
6771 :::
6773 and you needed a blank line before the closing `:::`.
6775 * Make `fenced_divs` affect the Markdown writer. If `fenced_divs` is
6776 enabled, Divs will be rendered as fenced divs.
6778 * LaTeX/Beamer writer: support "blocks" inside columns and other Divs
6779 (#4016).
6781 * HTML Writer: consistently use dashed class-names (Mauro Bieg, #3556).
6782 Note: this change may require some changes in CSS rules.
6783 `footnoteRef` has become `footnote-ref`, `titleslide` has
6784 become `title-slide`, and `footnoteBack` has become `footnote-back`.
6786 * JATS writer: Properly pass through author metadata (#4020).
6788 * FB2 writer (Alexander Krotov):
6790 + Write blocks outside of `<p>` in definitions.
6791 + Make bullet lists consistent with ordered lists, repeating
6792 the marker for the outer list rather than indenting sublists,
6793 since indentation does not work in readers.
6794 + Add new style FB2 tests.
6796 * `Text.Pandoc.ImageSize`: Add `Millimeter` constructor to `Dimension`
6797 (#4012) [API change]. Now sizes given in 'mm' are no longer converted
6798 to 'cm'.
6800 * Revise documentation of small caps syntax (Andrew Dunning, #4013).
6802 * Fix broken reference links in manual (Andrew Dunning, #4014)
6804 * Fixed example of slide columns structure in changelog (#4015).
6805 Also documented this feature in MANUAL.txt.
6808## pandoc 2.0.0.1 (2017-10-30)
6810 * EPUB writer:
6812 + Fixed filepaths for nonstandard epub-subdirectory values.
6813 + Ensure that epub2 is recognized as a non-text format,
6814 so that a template is used.
6815 + Don't include "prefix" attribute for ibooks for epub2.
6816 It doesn't validate.
6817 + Fix stylesheet paths; previously we had an incorrect
6818 stylesheet path for the cover page and nav page.
6820 * LaTeX reader:
6822 + Insert space when needed in macro expansion (#4007).
6823 Sometimes we need to insert a space after a control sequence
6824 to prevent it merging with a following letter.
6825 + Allow unbraced arguments for macros (#4007).
6826 + Allow body of macro definition to be unbraced (#4007).
6828 * Linux package build: ensure that pandoc-citeproc is statically linked.
6830 * trypandoc: add native, ms.
6833## pandoc 2.0 (2017-10-29)
6835### New features
6837 * New output format `ms` (groff ms). Complete support, including
6838 tables, math, syntax highlighting, and PDF bookmarks. The writer uses
6839 texmath's new eqn writer to convert math to eqn format, so a ms file
6840 produced with this writer should be processed with `groff -ms -e` if
6841 it contains math.
6843 * New output format `jats` (Journal Article Tag Suite). This is an XML
6844 format used in archiving and publishing articles. Note that a
6845 URI-encoded CSL stylesheet (`data/jats.csl`) is added automatically
6846 unless a stylesheet is specified using `--css`.
6848 * New output format `gfm` (GitHub-flavored CommonMark) (#3841).
6849 This uses bindings to GitHub's fork of cmark, so it should parse
6850 gfm exactly as GitHub does (excepting certain postprocessing
6851 steps, involving notifications, emojis, etc.). `markdown_github`
6852 has been deprecated in favor of `gfm`.
6854 * New output format `muse` (Emacs Muse) (Alexander Krotov, #3489).
6856 * New input format `gfm` (GitHub-flavored CommonMark) (#3841).
6857 This uses bindings to GitHub's fork of cmark. `markdown_github`
6858 has been deprecated in favor of `gfm`.
6860 * New input format `muse` (Emacs Muse) reader (Alexander Krotov, #3620).
6862 * New input format `tikiwiki` (TikiWiki markup) (rlpowell, #3800).
6864 * New input format `vimwiki` (Vimwiki markup) (Yuchen Pei, #3705).
6865 Note that there is a new data file, `data/vimwiki.css`, which can
6866 be used to display the HTML produced by this reader and
6867 pandoc's HTML writer in the style of vimwiki's own HTML
6868 export.
6870 * New input format `creole` (Creole 1.0) (#3994, Sascha Wilde).
6872 * New syntax for Divs, with `fenced_divs` extension enabled by
6873 default (#168). This gives an attractive, plain-text way to create
6874 containers for block-level content.
6876 * Added new syntax for including raw content in any output format,
6877 enabled by the `raw_attribute` extension (which is on by default
6878 for `markdown` and `multimarkdown`). The syntax is the same as
6879 for fenced code blocks or code inlines, only with `{=FORMAT}` for
6880 attributes, where `FORMAT` is the name of the output format
6881 (e.g., `ms`, `html`).
6883 * Implement multicolumn support for slide formats (#1710).
6884 The structure expected is:
6886 :::::::::::::: {.columns}
6887 ::: {.column width="40%"}
6888 contents...
6889 :::
6890 ::: {.column width="60%"}
6891 contents...
6892 :::
6893 ::::::::::::::
6895 Support has been added for beamer and all HTML slide formats.
6897 * Allows line comments in templates, beginning with `$--` (#3806).
6898 (Requires doctemplates 0.2.1.)
6900 * Add `--eol=crlf|lf|native` flag and writer option to control line endings
6901 (Stefan Dresselhaus, #3663, #2097).
6903 * Add `--log` option to save log messages in JSON format to a file (#3392).
6905 * Add `--request-header` option, to set request headers when pandoc
6906 makes HTTP requests to fetch external resources. For example:
6907 `--request-header User-Agent:blah`.
6909 * Added lua filters (Albert Krewinkel, #3514). The new `--lua-filter`
6910 option works like `--filter` but takes pathnames of special lua filters
6911 and uses the lua interpreter baked into pandoc, so that no external
6912 interpreter is needed. Note that lua filters are all applied after
6913 regular filters, regardless of their position on the command line.
6914 For documentation of lua filters, see `doc/lua-filters.md`.
6916 * Set `PANDOC_READER_OPTIONS` in environment where filters are run.
6917 This contains a JSON representation of `ReaderOptions`, so filters
6918 can access it.
6920 * Support creation of pdf via groff `ms` and pdfroff.
6921 `pandoc -t ms -o output.pdf input.txt`.
6923 * Support for PDF generation via HTML and `weasyprint` or `prince`
6924 (Mauro Bieg, #3909). `pandoc -t html5 -o output.pdf --pdf-engine=prince`.
6926 * Added `--epub-subdirectory` option (#3720). This specifies the
6927 subdirectory in the OCF container that holds the EPUB specific content.
6928 We now put all EPUB related content in an `EPUB/` subdirectory by default
6929 (later this will be configurable).
6931 ```
6932 mimetype
6933 META-INF/
6934 com.apple.ibooks.display-options.xml
6935 container.xml
6936 EPUB/ <<--configurable-->>
6937 fonts/ <<--static-->>
6938 font.otf
6939 media/ <<--static-->>
6940 cover.jpg
6941 fig1.jpg
6942 styles/ <<--static-->>
6943 stylesheet.css
6944 content.opf
6945 toc.ncx
6946 text/ <<--static-->>
6947 ch001.xhtml
6948 ```
6950 * Added `--resource-path=SEARCHPATH` command line option (#852).
6951 SEARCHPATH is separated by the usual character, depending on OS
6952 (: on unix, ; on windows). Default resource path is just working
6953 directory. However, the working directory must be explicitly
6954 specified if the `--resource-path` option is used.
6956 * Added --abbreviations=FILE option for custom abbreviations file
6957 (#256). Dfault abbreviations file (`data/abbreviations`) contains
6958 a list of strings that will be recognized by pandoc's
6959 Markdown parser as abbreviations. (A nonbreaking space will
6960 be inserted after the period, preventing a sentence space in
6961 formats like LaTeX.) Users can override the default by putting a file
6962 abbreviations in their user data directory (`~/.pandoc` on *nix).
6964 * Allow a theme file as argument to `--highlight-style`.
6965 Also include a sample, `default.theme`, in `data/`.
6967 * Allow `--syntax-definition` option for dynamic loading of syntax
6968 highlighting definitions (#3334).
6970 * Lists in `markdown` by default now use the CommonMark variable
6971 nesting rules (#3511). The indentation required for a block-level
6972 item to be included in a list item is no longer fixed, but is
6973 determined by the first line of the list item. To be included in
6974 the list item, a block must be indented to the level of the first
6975 non-space content after the list marker. Exception: if are 5 or more
6976 spaces after the list marker, then the content is interpreted as an
6977 indented code block, and continuation paragraphs must be indented
6978 two spaces beyond the end of the list marker. See the CommonMark
6979 spec for more details and examples.
6981 Documents that adhere to the four-space rule should, in most cases,
6982 be parsed the same way by the new rules. Here are some examples
6983 of texts that will be parsed differently:
6985 - a
6986 - b
6988 will be parsed as a list item with a sublist; under the four-space
6989 rule, it would be a list with two items.
6991 - a
6993 code
6995 Here we have an indented code block under the list item, even though it
6996 is only indented six spaces from the margin, because it is four spaces
6997 past the point where a continuation paragraph could begin. With the
6998 four-space rule, this would be a regular paragraph rather than a code
6999 block.
7001 - a
7003 code
7005 Here the code block will start with two spaces, whereas under
7006 the four-space rule, it would start with `code`. With the four-space
7007 rule, indented code under a list item always must be indented eight
7008 spaces from the margin, while the new rules require only that it
7009 be indented four spaces from the beginning of the first non-space
7010 text after the list marker (here, `a`).
7012 This change was motivated by a slew of bug reports from people
7013 who expected lists to work differently (#3125, #2367, #2575, #2210,
7014 #1990, #1137, #744, #172, #137, #128) and by the growing prevalance
7015 of CommonMark (now used by GitHub, for example). Those who
7016 prefer the old behavior can use `-f markdown+four_space_rule`.
7018 * Added `four_space_rule` extension. This triggers the old pandoc
7019 parsing rule for content nested under list items (the "four space
7020 rule").
7022 * Added `spaced_reference_links` extension (#2602). It allows whitespace
7023 between the two parts of a reference link: e.g.
7025 [a] [b]
7027 [b]: url
7029 This was previously enabled by default; now it is forbidden by default.
7031 * Add `space_in_atx_header` extension (#3512). This is enabled by default
7032 in pandoc and GitHub markdown but not the other flavors.
7033 This requirse a space between the opening #'s and the header
7034 text in ATX headers (as CommonMark does but many other implementations
7035 do not). This is desirable to avoid falsely capturing things ilke
7037 #hashtag
7039 or
7041 #5
7043 * Add `sourcefile` and `outputfile` template variables (Roland Hieber,
7044 #3431).
7046 * Allow ibooks-specific metadata in epubs (#2693). You can now have
7047 the following fields in your YAML metadata, and it will be treated
7048 appropriately in the generated EPUB:
7050 ```
7051 ibooks:
7052 version: 1.3.4
7053 specified-fonts: false
7054 ipad-orientation-lock: portrait-only
7055 iphone-orientation-lock: landscape-only
7056 binding: true
7057 scroll-axis: vertical
7058 ```
7061### Behavior changes
7063 * Reader functions no longer presuppose that CRs have been
7064 stripped from the input. (They strip CRs themselves, before
7065 parsing, to simplify the parsers.)
7067 * Added support for translations (localization) (#3559).
7068 Currently this only affects the LaTeX reader, for things
7069 like `\figurename`. Translation data files for 46 languages
7070 can be found in `data/translations`.
7072 * Make `--ascii` work with DocBook output too.
7074 * Rename `--latex-engine` to `--pdf-engine`,
7075 and `--latex-engine-opt` to `--pdf-engine-opt`.
7077 * Removed `--parse-raw` and `readerParseRaw`. These were confusing.
7078 Now we rely on the `+raw_tex` or `+raw_html` extension with latex or html
7079 input. Thus, instead of `--parse-raw -f latex` we use `-f latex+raw_tex`,
7080 and instead of `--parse-raw -f html` we use `-f html+raw_html`.
7082 * With `--filter` R filters are now recognized, even if they are
7083 not executable (#3940, #3941, Andrie de Vries).
7085 * Support SVG in PDF output, converting with `rsvg2pdf` (#1793).
7087 * Make epub an alias for epub3, not epub2.
7089 * Removed `--epub-stylesheet`; use `--css` instead (#3472, #847).
7090 Multiple stylesheets may be used. Stylesheets will be taken both from
7091 `--css` and from the `stylesheet` metadata field (which can contain
7092 either a file path or a list of them).
7094 * `--mathml` and MathML in HTMLMathMethod no longer take an argument.
7095 The argument was for a bridge JavaScript that used to be necessary
7096 in 2004. We have removed the script already.
7098 * `--katex` improvements. The latest version is used, and the
7099 autoload script is loaded by default.
7101 * Change MathJax CDN default since old one is shutting down (#3544).
7102 Note: The new URL requires a version number, which we'll have
7103 to update manually in subsequent pandoc releases in order to
7104 take advantage of mathjax improvements.
7106 * `--self-contained`: don't incorporate elements with `data-external="1"`
7107 (#2656). You can leave an external link as it is by adding the attribute
7108 data-external="1" to the element. Pandoc will then not try to
7109 incorporate its content when `--self-contained` is used. This is
7110 similar to a feature already supported by the EPUB writer.
7112 * Allow `--extract-media` to work with non-binary input formats
7113 (#1583, #2289). If `--extract-media` is supplied with a non-binary
7114 input format, pandoc will attempt to extract the contents of all
7115 linked images, whether in local files, data: uris, or external uris.
7116 They will be named based on the sha1 hash of the contents.
7118 * Make `papersize: a4` work regardless of the case of `a4`.
7119 It is converted to `a4` in LaTeX and `A4` in ConTeXt.
7121 * Make `east_asian_line_breaks` affect all readers/writers (#3703).
7123 * Underlined elements are now treated consistently by readers
7124 (#2270, hftf); they are always put in a Span with class `underline`.
7125 This allows the user to treat them differently from other emphasis,
7126 using a filter. Docx, Org, Textile, Txt2Tags, and HTML readers
7127 have been changed.
7129 * Improved behavior of `auto_identifiers` when there are explicit ids
7130 (#1745). Previously only autogenerated ids were added to the list
7131 of header identifiers in state, so explicit ids weren't taken
7132 into account when generating unique identifiers. Duplicated
7133 identifiers could result. This simple fix ensures that explicitly given
7134 identifiers are also taken into account.
7136 * Use `table-of-contents` for contents of toc, make `toc` a boolean
7137 (#2872). Changed markdown, rtf, and HTML-based templates accordingly.
7138 This allows you to set `toc: true` in the metadata; this
7139 previously produced strange results in some output formats.
7140 For backwards compatibility, `toc` is still set to the
7141 toc contents. But it is recommended that you update templates
7142 to use `table-of-contents` for the toc contents and `toc`
7143 for a boolean flag.
7145 * Change behavior with binary format output to stdout.
7146 Previously, for binary formats, output to stdout was disabled
7147 unless we could detect that the output was being piped (and not
7148 sent to the terminal). Unfortunately, such detection is not
7149 possible on Windows, leaving windows users no way to pipe binary
7150 output. So we have changed the behavior in the following way:
7152 + Output to stdout is allowed when it can be determined that
7153 the output is being piped (on non-Windows platforms).
7154 + If the `-o` option is not used, binary output is never sent
7155 to stdout by default; instead, an error is raised.
7156 + If `-o -` is used, binary output is sent to stdout, regardless
7157 of whether it is being piped. This works on Windows too.
7159 * Better error behavior: uses of `error` have been replaced by
7160 raising of `PandocError`, which can be trapped and handled by the
7161 calling program.
7163 * Removed `hard_line_breaks` extension from `markdown_github` (#3594).
7164 GitHub has two Markdown modes, one for long-form documents like READMEs
7165 and one for short things like issue coments. In issue comments, a line
7166 break is treated as a hard line break. In README, wikis, etc., it is
7167 treated as a space as in regular Markdown. Since pandoc is more likely to
7168 be used to convert long-form documents from GitHub Markdown,
7169 `-hard_line_breaks` is a better default.
7171 * Include `backtick_code_blocks` extension in `mardkown_mmd` (#3637).
7173 * Escape `MetaString` values (as added with `-M/--metadata` flag) (#3792).
7174 Previously they would be transmitted to the template without any
7175 escaping. Note that `--M title='*foo*'` yields a different result from
7177 ---
7178 title: *foo*
7179 ---
7181 In the latter case, we have emphasis; in the former case, just
7182 a string with literal asterisks (which will be escaped
7183 in formats, like Markdown, that require it).
7185 * Allow `em`, `cm`, `in` for image height/width in HTML, LaTeX (#3450).
7187 * HTML writer: Insert `data-` in front of unsupported attributes. Thus,
7188 a span with attribute `foo` gets written to HTML5 with `data-foo`, so
7189 it is valid HTML5. HTML4 is not affected. This will allow us to use
7190 custom attributes in pandoc without producing invalid HTML. (With help
7191 from Wandmalfarbe, #3817.)
7193 * Plain writer: improved super/subscript rendering. We now
7194 handle more non-digit characters for which there are
7195 sub/superscripted unicode characters. When unicode
7196 sub/superscripted characters are not available, we use
7197 `_(..)` or `^(..)` (#3518).
7199 * Docbook, JATS, TEI writers: print INFO message when omitting interior
7200 header (#3750). This only applies to section headers inside list items,
7201 e.g., which were otherwise silently omitted.
7203 * Change to `--reference-links` in Markdown writer (#3701). With
7204 `--reference-location` of `section` or `block`, pandoc will now repeat
7205 references that have been used in earlier sections. The Markdown
7206 reader has also been modified, so that *exactly* repeated references
7207 do not generate a warning, only references with the same label but
7208 different targets. The idea is that, with references after every block,
7209 one might want to repeat references sometimes.
7211 * ODT/OpenDocument writer:
7213 + Support `lang` attribute (#1667).
7214 + Added support for `--toc` (#2836). Thanks to @anayrat.
7216 * Docx writer:
7218 + `lang` meta, see #1667 (Mauro Bieg, #3515).
7219 + Change `FigureWithCaption` to `CaptionedFigure` (iandol, #3658).
7220 + Use `Table` rather than `Table Normal` for table style (#3275).
7221 `Table Normal` is the default table style and can't be modified.
7222 + Pass through comments (#2994). We assume that comments are defined as
7223 parsed by the docx reader:
7225 I want <span class="comment-start" id="0" author="Jesse Rosenthal"
7226 date="2016-05-09T16:13:00Z">I left a comment.</span>some text to
7227 have a comment <span class="comment-end" id="0"></span>on it.
7229 We assume also that the id attributes are unique and properly
7230 matched between comment-start and comment-end.
7231 + Bookmark improvements. Bookmark start/end now surrounds content rather
7232 than preceding it. Bookmarks generated for Div with id
7233 (jgm/pandoc-citeproc#205).
7234 + Add `keywords` metadata to docx document properties (Ian).
7236 * RST writer: support unknown interpreted text roles by
7237 parsing them as `Span` with `role` attributes (#3407). This
7238 way they can be manipulated in the AST.
7240 * HTML writer:
7242 + Line block: Use class instead of style attribute (#1623). We now
7243 issue `<div class="line-block">` and include a default definition
7244 for `line-block` in the default templates, instead of hard-coding a
7245 `style` on the div.
7246 + Add class `footnoteBack` to footnote back references (Timm Albers).
7247 This allows for easier CSS styling.
7248 + Render SmallCaps as span with smallcaps class (#1592), rather than
7249 using a style attribute directly. This gives the user more flexibility
7250 in styling small caps in CSS.
7251 + With reveal.js we use `data-src` instead of `src` for images for
7252 lazy loading.
7253 + Special-case `.stretch` class for images in reveal.js (#1291).
7254 Now in reveal.js, an image with class `stretch` in a paragraph
7255 by itself will stretch to fill the whole screen, with no
7256 caption or figure environment.
7258 * Added warnings for non-rendered blocks to writers.
7260 * Writers now raise an error on template failure.
7262 * When creating a PDF via LaTeX, warn if the font is missing some
7263 characters (#3742).
7265 * Remove initial check for PDF-creating program (#3819).
7266 Instead, just try running it and raise the exception if it
7267 isn't found at that point. This improves things for users of Cygwin
7268 on Windows, where the executable won't be found by `findExecutable`
7269 unless `.exe` is added. The same exception is raised as before, but
7270 at a later point.
7272 * Readers issue warning for duplicate header identifiers (#1745).
7273 Autogenerated header identifiers are given suffixes so as not to clash
7274 with previously used header identifiers. But they may still coincide with
7275 an explicit identifier that is given for a header later in the document,
7276 or with an identifier on a div, span, link, or image. We now issue
7277 a warning in this case, so users can supply an explicit identifier.
7279 * CommonMark reader now supports `emoji`, `hard_line_breaks`, `smart`,
7280 and `raw_html` extensions.
7282 * Markdown reader:
7284 + Don't allow backslash + newline to affect block structure (#3730).
7285 Note that as a result of this change, the following, which formerly
7286 produced a header with two lines separated by a line break, will
7287 now produce a header followed by a paragraph:
7289 # Hi\
7290 there
7292 This may affect some existing documents that relied on
7293 this undocumented and unintended behavior. This change makes pandoc
7294 more consistent with other Markdown implementations, and with itself
7295 (since the two-space version of a line break doesn't work inside ATX
7296 headers, and neither version works inside Setext headers).
7299 * Org reader (Albert Krewinkel, unless noted):
7301 + Support `table.el` tables (#3314).
7302 + Support macros (#3401).
7303 + Support the `#+INCLUDE:` file inclusion mechanism (#3510).
7304 Recognized include types are `example`, `export`, `src`, and
7305 normal org file inclusion. Advanced features like line numbers
7306 and level selection are not implemented yet.
7307 + Interpret more meta value as inlines. The values of the following
7308 meta variables are now interpreted using org-markup instead of
7309 treating them as pure strings: `keywords` (comma-separated list of
7310 inlines), `subtitle` (inline values), `nocite` (inline values, can
7311 be repeated).
7312 + Support `\n` export option (#3940). This turns all newlines in the
7313 text into hard linebreaks.
7315 * RST reader:
7317 + Improved admonition support (#223). We no longer add an
7318 `admonition` class, we just use the class for the type of admonition,
7319 `note` for example. We put the word corresponding to the label in
7320 a paragraph inside a `Div` at the beginning of the admonition with
7321 class `admonition-title`. This is about as close as we can get to
7322 RST's own output.
7323 + Initial support of `.. table` directive. This allows adding captions
7324 to tables.
7325 + Support `.. line-block` directive. This is deprecated but may still
7326 be in older documents.
7327 + Support scale and align attributes of images (#2662).
7328 + Implemented implicit internal header links (#3475).
7329 + Support RST-style citations (#853). The citations appear at the end
7330 of the document as a definition list in a special div with id
7331 `citations`. Citations link to the definitions.
7332 + Recurse into bodies of unknown directives (#3432).
7333 In most cases it's better to preserve the content than
7334 to emit it. This isn't guaranteed to have good results;
7335 it will fail spectacularly for unknown raw or verbatim directives.
7336 + Handle chained link definitions (#262). For example,
7338 .. _hello:
7339 .. _goodbye: example.com
7341 Here both `hello` and `goodbye` should link to `example.com`.
7342 + Support anchors (#262). E.g.
7344 `hello`
7346 .. _hello:
7348 paragraph
7350 This is supported by putting "paragraph" in a `Div` with id `hello`.
7351 + Support `:widths:` attribute for table directive.
7352 + Implement csv-table directive (#3533). Most attributes are supported,
7353 including `:file:` and `:url:`.
7354 + Support unknown interpreted text roles by parsing them as Span
7355 with "role" attributes (#3407). This way they can be manipulated in
7356 the AST.
7358 * HTML reader: parse a span with class `smallcaps` as `SmallCaps`.
7360 * LaTeX reader:
7362 + Implemented `\graphicspath` (#736).
7363 + Properly handle column prefixes/suffixes. For example, in
7364 `\begin{tabular}{>{$}l<{$}>{$}l<{$} >{$}l<{$}}`
7365 each cell will be interpreted as if it has a `$`
7366 before its content and a `$` after (math mode).
7367 + Handle komascript `\dedication` (#1845). It now adds a
7368 `dedication` field to metadata. It is up to the user to supply
7369 a template that uses this variable.
7370 + Support all `\textXX` commands, where XX = `rm`, `tt`, `up`, `md`,
7371 `sf`, `bf` (#3488). Spans with a class are used when there is
7372 nothing better.
7373 + Expand `\newenvironment` macros (#987).
7374 + Add support for LaTeX subfiles package (Marc Schreiber, #3530).
7375 + Better support for subfigure package (#3577).
7376 A figure with two subfigures turns into two pandoc
7377 figures; the subcaptions are used and the main caption
7378 ignored, unless there are no subcaptions.
7379 + Add support for `\vdots` (Marc Schreiber, #3607).
7380 + Add basic support for hyphenat package (Marc Schreiber, #3603).
7381 + Add basic `\textcolor` support (Marc Schreiber).
7382 + Add support for `tabularx` environment (Marc Schreiber, #3632).
7383 + Better handling of comments inside math environments (#3113).
7384 This solves a problem with commented out `\end{eqnarray}` inside
7385 an eqnarray (among other things).
7386 + Parse tikzpicture as raw verbatim environment if `raw_tex` extension
7387 is selected (#3692). Otherwise skip with a warning. This is better
7388 than trying to parse it as text!
7389 + Add `\colorbox` support (Marc Schreiber).
7390 + Set identifiers on Spans used for `\label`.
7391 + Have `\setmainlanguage` set `lang` in metadata.
7392 + Support etoolbox's `\ifstrequal`.
7393 + Support `plainbreak`, `fancybreak` et al from the memoir class
7394 (bucklereed, #3833).
7395 + Support `\let`. Also, fix regular macros so they're expanded at the
7396 point of use, and NOT also the point of definition. `\let` macros,
7397 by contrast, are expanded at the point of definition. Added an
7398 `ExpansionPoint` field to `Macro` to track this difference.
7399 + Support simple `\def` macros. Note that we still don't support
7400 macros with fancy parameter delimiters, like `\def\foo#1..#2{...}`.
7401 + Support `\chaptername`, `\partname`, `\abstractname`, etc. (#3559,
7402 obsoletes #3560).
7403 + Put content of `\ref`, `\label`, `\eqref` commands into `Span` with
7404 attributes, so they can be handled in filters (Marc Schreiber, #3639)
7405 + Add Support for `glossaries` and `acronym` package (Marc Schreiber,
7406 #3589). Acronyms are not resolved by the reader, but acronym and
7407 glossary information is put into attributes on Spans so that they
7408 can be processed in filters.
7409 + Use `Link` instead of `Span` for `\ref`. This makes more sense
7410 semantically and avoids unnecessary `Span [Link]` nestings when
7411 references are resolved.
7412 + Rudimentary support for `\hyperlink`.
7413 + Support `\textquoteleft|right`, `\textquotedblleft|right` (#3849).
7414 + Support `\lq`, `\rq`.
7415 + Implement `\newtoggle`, `\iftoggle`, `\toggletrue|false` from etoolbox
7416 (#3853).
7417 + Support `\RN` and `\Rn`, from biblatex (bucklereed, #3854).
7418 + Improved support for `\hyperlink`, `\hypertarget` (#2549).
7419 + Support `\k` ogonek accent.
7420 + Improve handling of accents. Handle ogonek, and fall back correctly
7421 with forms like `\"{}`.
7422 + Better support for ogonek accents.
7423 + Support for `\faCheck` and `\faClose` (Marc Schreiber, #3727).
7424 + Support for `xspace` (Marc Schreiber, #3797).
7425 + Support `\setmainlanguage` or `\setdefaultlanguage` (polyglossia)
7426 and `\figurename`.
7427 + Better handling of `\part` in LaTeX (#1905). Now we parse chapters as
7428 level 0 headers, and parts as level -1 headers. After parsing, we
7429 check for the lowest header level, and if it's less than 1 we bump
7430 everything up so that 1 is the lowest header level. So `\part` will
7431 always produce a header; no command-line options are needed.
7432 + Add block version of `\textcolor` (Marc Schreiber).
7433 + `\textcolor` works as inline and block command (Marc Schreiber).
7434 + `\textcolor` will be parse as span at the beginning of a paragraph
7435 (Marc Schreiber).
7436 + Read polyglossia/babel `\text(LANG){...}` (bucklereed)
7437 + Improved handling of include files in LaTeX reader (#3971).
7438 Previously `\include` wouldn't work if the included file
7439 contained, e.g., a begin without a matching end.
7440 + Support `\expandafter` (#3983).
7441 + Handle `\DeclareRobustCommand` (#3983). Currently it's just treated
7442 as a synonym for `\newcommand`.
7443 + Handle `\lettrine` (Mauro Bieg).
7445 * Math improvements due to updates in texmath:
7447 + Improved handling of accents and upper/lower delimiters.
7448 + Support for output in GNU eqn format (used with *roff).
7449 + Allow `\boldsymbol` + a token without braces, and similarly
7450 with other styling commands.
7451 + Improve parsing of `\mathop` to allow multi-character operator names.
7452 + Add thin space after math operators when "faking it with
7453 unicode."
7455 * `walk` is now used instead of `bottomUp` in the `ToJSONFilter`
7456 instance for `a -> [a]` (pandoc-types). Note that behavior
7457 will be slightly different, since `bottomUp`'s treatment of
7458 a function `[a] -> [a]` is to apply it to each sublist of a
7459 list, while walk applies it only to maximal sublists.
7460 Usually the latter behavior is what is wanted, and the
7461 former can be simulated when needed. But there may be
7462 existing filters that need to be rewritten in light of the
7463 new behavior. Performance should be improved.
7465 * There are some changes to syntax highlighting due to revisions
7466 in the `skylighting` library:
7468 + Support for `powershell` has been added, and many syntax
7469 definitions have been updated.
7470 + Background colors have been added to the `kate` style.
7471 + The way highlighted code blocks are formatted in HTML has
7472 been changed (David Baynard), in ways that may require
7473 changes in hard-coded CSS affecting highlighting.
7474 (If you haven't included hard-coded highlighting CSS in
7475 your template, you needn't change anything.)
7478### API changes
7480 * New module `Text.Pandoc.Class` (Jesse Rosenthal, John MacFarlane).
7481 This contains definitions of the `PandocMonad` typeclass, the
7482 `PandocIO` and `PandocPure` monads, and associated functions.
7484 * Changed types of all writers and readers.
7486 + We now use `Text` instead of `String` in the interface (#3731).
7487 (We have not yet changed the internals of most readers to work
7488 with `Text`, but making this change in the API now opens up a
7489 path to doing that.)
7490 + The result is now of form `m a` with constraint `PandocMonad m`.
7491 Readers and writers can be combined to form monadic values which
7492 can be run using either `runIO` or `runPure`. If `runIO` is used,
7493 then both readers and writers will be able to do IO when needed
7494 (for include files, for example); if `runPure` is used,
7495 then the functions are pure and will not touch IO.
7496 + Where previously you used
7497 `writeRST def (readMarkdown def "[foo](url)")`, now you
7498 would use
7499 `runPure $ readMarkdown def (pack "[foo](url)") >>= writeRST def`.
7501 * New module `Text.Pandoc.Readers` (Albert Krewinkel). This
7502 contains reader helper functions formerly defined in the
7503 top-level `Text.Pandoc` module.
7505 + Changed `StringReader` -> `TextReader`.
7506 + `getReader` now returns a pair of a reader and
7507 `Extensions`, instead of building the extensions into the
7508 reader (#3659). The calling code must explicitly set
7509 `readerExtensions` using the `Extensions` returned. The
7510 point of the change is to make it possible for the calling
7511 code to determine what extensions are being used.
7513 * New module `Text.Pandoc.Writers` (Albert Krewinkel).
7514 This contains writer helper functions formerly defined in the
7515 top-level `Text.Pandoc` module.
7517 + Changed `StringWriter` -> `TextWriter`.
7518 + `getWriter` now retuns a pair of a reader and
7519 `Extensions`, instead of building the extensions into the
7520 reader (#3659). The calling code must explicitly set
7521 `readerExtensions` using the `Extensions` returned. The
7522 point of the change is to make it possible for the calling
7523 code to determine what extensions are being used.
7525 * New module `Text.Pandoc.Lua`, exporting `runLuaFilter` (Albert Krewinkel,
7526 #3514).
7528 * New module `Text.Pandoc.App`. This abstracts out the functionality
7529 of the command line program (`convertWithOpts`), so it can be reproduced
7530 e.g. in a desktop or web application. Instead of exiting, we throw errors
7531 (#3548), which are caught (leading to exit) in pandoc.hs, but allow other
7532 users of `Text.Pandoc.App` to recover. `pandoc.hs` is now a 2-liner.
7533 The module also exports some utility functions for parsing options
7534 and running filters.
7536 * New module `Text.Pandoc.Logging` (exported module) (#3392).
7537 This now contains the `Verbosity` definition previously in
7538 `Text.Pandoc.Options`, as well as a new `LogMessage` datatype that will
7539 eventually be used instead of raw strings for warnings. This will enable
7540 us, among other things, to provide machine-readable warnings if desired.
7541 Include ToJSON instance and showLogMessage. This gives us the possibility
7542 of both machine-readable and human-readable output for log messages.
7544 * New module `Text.Pandoc.BCP47`, with `getLang`, `Lang(..)`, `parseBCP47`.
7546 * New module `Text.Pandoc.Translations`, exporting `Term`,
7547 `Translations`, `readTranslations`.
7549 * New module `Text.Pandoc.Readers.LaTeX.Types', exporting `Macro`, `Tok`,
7550 `TokType`, `Line`, `Column`.
7552 * `Text.Pandoc.Error`: added many new constructors for `PandocError`.
7554 * Expose some previously private modules (#3260). These are often
7555 helpful to people writing their own reader or writer modules:
7557 + `Text.Pandoc.Writers.Shared`
7558 + `Text.Pandoc.Parsing`
7559 + `Text.Pandoc.Asciify`
7560 + `Text.Pandoc.Emoji`
7561 + `Text.Pandoc.ImageSize`
7562 + `Text.Pandoc.Highlighting`
7564 * New module `Text.Pandoc.Extensions` (Albert Krewinkel):
7565 Extension parsing and processing functions were defined in the top-level
7566 `Text.Pandoc` module. These functions are moved to the Extensions
7567 submodule as to enable reuse in other submodules.
7569 * Add `Ext_raw_attribute` constructor for `Extension`.
7571 * Add `Ext_fenced_divs` constructor for `Extension'.
7573 * Add `Ext_four_space_rule` constructor in `Extension`.
7575 * Add `Ext_gfm_auto_identifiers` constructor for `Extension`.
7577 * Add `Monoid` instance for `Extensions`.
7579 * Add `Text.Pandoc.Writers.Ms`, exporting `writeMs`.
7581 * Add `Text.Pandoc.Writers.JATS`, exporting `writeJATS`.
7583 * Add `Text.Pandoc.Writers.Muse`, exporting `writeMuse`.
7585 * Add `Text.Pandoc.Readers.Muse`, exporting `readMuse`.
7587 * Add `Text.Pandoc.Readers.TikiWiki`, exporting `readTikiWiki`.
7589 * Add `Text.Pandoc.Readers.Vimwiki`, exporting `readVimwiki`.
7591 * Add `Text.Pandoc.Readers.Creole`, exporting `readCreole`.
7593 * Export `setVerbosity` from `Text.Pandoc`.
7595 * `Text.Pandoc.Pretty`: Add `Eq` instance for `Doc`.
7597 * `Text.Pandoc.XML`: `toEntities`: changed type to `Text -> Text`.
7599 * `Text.Pandoc.UTF8`:
7601 + Export `fromText`, `fromTextLazy`, `toText`, `toTextLazy`.
7602 Define `toString`, `toStringLazy` in terms of them.
7603 + Add new functions parameterized on `Newline`: `writeFileWith`,
7604 `putStrWith`, `putStrLnWith`, `hPutStrWith`, `hPutStrLnWith`.
7606 * `Text.Pandoc.MediaBag`: removed `extractMediaBag`.
7608 * `Text.Pandoc.Highlighting`:
7610 + `highlighting` now returns an Either rather than Maybe.
7611 This allows us to display error information returned by the skylighting
7612 library. Display a warning if the highlighting library throws an error.
7613 + Add parameter for `SyntaxMap` to `highlight`.
7615 * `Text.Pandoc.Writers.Math`:
7617 + Export `defaultMathJaxURL`, `defaultKaTeXURL`. This will ensure that
7618 we only need to update these in one place.
7620 * `Text.Pandoc.SelfContained`:
7622 + Removed `WriterOptions` parameter from `makeSelfContained`.
7623 + Put `makeSelfContained` in PandocMonad instead of IO. This removes
7624 the need to pass MediaBag around and improves exceptions. It also
7625 opens up the possibility of using makeSelfContained purely.
7626 + Export `makeDataURI`.
7628 * `Text.Pandoc.ImageSize`:
7630 + Export `lengthToDim`, new function `scaleDimension`.
7631 + Export `inEm` from ImageSize (#3450).
7632 + Change `showFl` and `show` instance for `Dimension` so
7633 extra decimal places are omitted.
7634 + Added `Em` as a constructor of `Dimension`.
7635 + Add `WriterOptions` parameter to `imageSize` signature (Mauro Bieg).
7637 * `Text.Pandoc.Templates`:
7639 + Change type of `renderTemplate'`. Now it runs in `PandocMonad`
7640 and raises a proper `PandocTemplateError` if there are problems, rather
7641 than failing with uncatchable `error`.
7642 + Change signature of `getDefaultTemplate`. Now it runs in any instance
7643 of `PandocMonad`, and returns a `String` rather than an `Either` value.
7644 And it no longer takes a `datadir` parameter, since this can be
7645 retrieved from `CommonState`.
7647 * `Text.Pandoc.Options`:
7649 + Added `writerEpubSubdirectory` to `WriterOptions` (#3720).
7650 The EPUB writer now takes its EPUB subdirectory from this option.
7651 + In `WriterOptions`, rename `writerLaTeXEngine` to `writerPdfEngine`
7652 and `writerLaTeXArgs` to `writerPdfArgs` (Mauro Bieg, #3909).
7653 + Add `writerSyntaxMap` to `WriterOptions`.
7654 + Removed `writerEpubStylesheet` from `WriterOptions`.
7655 + Remove `writerUserDataDir` from `WriterOptions`. It is now carried
7656 in `CommonState` in `PandocMonad` instances. (And thus it can be used
7657 by readers too.)
7658 + Changed `writerEpubMetadata` to a `Maybe String`.
7659 + Removed `readerApplyMacros` from `ReaderOptions`. Now we just check
7660 the `latex_macros` reader extension.
7661 + FromJSON/ToJSON instances for `ReaderOptions`.
7662 + In `HTMLMathMethod`, the `KaTeX` contsructor now takes only
7663 one string (for the KaTeX base URL), rather than two.
7664 + Removed `writerSourceURL` from `WriterOptions`. We now use
7665 `stSourceURL` in `CommonState`, which is set by `setInputFiles`.
7667 * `Text.Pandoc.Shared`:
7669 + `tabFilter` now takes a `Text`, not `String`.
7670 + `openURL`: Changed type from an Either. Now it will just raise
7671 an exception to be trapped later.
7672 + Remove `normalizeSpaces` (#1530).
7673 + Remove `warn`. (Use `report` from `Text.Pandoc.Class` instead.)
7674 + Export a new function `crFilter`.
7675 + Add `eastAsianLineBreakFilter` (previously in Markdown reader).
7676 + Provide custom `isURI` that rejects unknown schemes.
7677 (Albert Krewinkel, #2713). We also export the set of known
7678 `schemes`. The new function replaces the function of the same name
7679 from `Network.URI`, as the latter did not check whether a scheme is
7680 well-known. All official IANA schemes (as of 2017-05-22) are
7681 included in the set of known schemes. The four non-official schemes
7682 `doi`, `isbn`, `javascript`, and `pmid` are kept.
7683 + Remove `err`.
7684 + Remove `readDataFile`, `readDefaultDataFile`, `getReferenceDocx`,
7685 `getReferenceODT`. These now live in `Text.Pandoc.Class`,
7686 where they are defined in terms of `PandocMonad`
7687 primitives and have different signatures.
7688 + Remove `openURL`. Use `openURL` from `Text.Pandoc.Class` instead.
7689 + Add `underlineSpan`.
7691 * `Text.Pandoc.Readers.HTML`: export new `NamedTag` class.
7693 * `Text.Pandoc.Readers.Markdown`: remove `readDocxWithWarnings`.
7694 With the new API one can simply use `getLog` after running
7695 the reader.
7697 * `Text.Pandoc.Readers.LaTeX`: Changed types for `rawLaTeXInline`
7698 and `rawLaTeXBlock`. (Both now return a `String`, and they are
7699 polymorphic in state.)
7702### Bug fixes and under-the-hood improvements
7704 * TEI writer: Added identifiers on `<div>` elements.
7706 * DokuWiki reader: Better handling for code block in list item (#3824).
7708 * Custom writer: Remove old preprocesesor conditionals (Albert Krewinkel).
7710 * ZimWiki writer: Removed internal formatting from note and table cells,
7711 because ZimWiki does not support it (Alex Ivkin, #3446).
7713 * MediaWiki writer:
7715 + Updated list of syntax highlighting languages (#3461).
7716 Now `r` gets you `<source>` rather than `<code>` (among others).
7717 + Add display attribute on `<math>` tags (#3452). This allows display
7718 math to be rendered properly.
7719 + Remove newline before `</ref>` (#2652).
7720 + Don't softbreak lines inside list items (#3531).
7722 * Org writer:
7724 + Reduce to two spaces after bullets (#3417, Albert Krewinkel).
7725 + Add unit tests (Alexander Krotov).
7726 + Stop using raw HTML to wrap divs (Albert Krewinkel, #3771).
7727 + Do not strip `#` from Org anchor links (Alexander Krotov).
7729 * CommonMark writer:
7731 + Avoid excess blank lines at end of output.
7732 + Prefer pipe tables to HTML tables even if it means losing relative
7733 column width information (#3734).
7734 + Support table, strikethrough extensions, when enabled (as with gfm).
7735 Note that we bypass the commonmark writer from cmark and construct our
7736 own pipe tables, with better results.
7737 + Properly support `--wrap=none`.
7738 + Use smallcaps class for `SmallCaps` (#1592).
7739 + Omit "fig:" prefix in image titles. This is used internally to
7740 indicate internal figures.
7742 * RST writer:
7744 + Properly handle table captions.
7745 + Don't wrap lines in in definition list terms. Wrapping is not allowed.
7746 + Implemented `+/-smart` and improved escaping with `+smart`.
7747 + Add empty comments when needed to avoid including a blockquote
7748 in the indented content of a preceding block (#3675).
7749 + Improve grid table output, fix bug with empty rows (#3516).
7750 Uses the new `gridTable` in Writers.Shared, which is here
7751 improved to better handle 0-width cells.
7752 + Remove space at beginning/end of RST code span (#3496). Otherwise
7753 we get invalid RST. There seems to be no way to escape the space.
7754 + Add header anchors when header has non-standard id (#3937).
7755 + Correctly handle inline code containing backticks, using a `:literal:`
7756 role (#3974).
7757 + Don't backslash-escape word-internal punctuation (#3978).
7759 * Markdown writer:
7761 + Don't include variables in metadata blocks. Previously variables set
7762 on the command line were included in e.g. YAML metadata, contrary to
7763 documentation and intentions.
7764 + Improved escaping with `+smart`.
7765 + Fixed grid tables embedded in grid tables (#2834).
7766 + Use span with class 'smallcaps' for SmallCaps, instead of a style
7767 attribute as before (#1592).
7768 + Escape initial `%` in a paragraph if the `pandoc_title_blocks`
7769 extension is enabled (#3454). Otherwise in a document starting with
7770 a literal `%` the first line is wrongly interpreted as a title.
7771 + Fixed false ordered lists in YAML metadata (#3492, #1685). Now we
7772 properly escape things that would otherwise start ordered lists,
7773 such as
7775 ---
7776 title: 1. inline
7777 ...
7778 + Better handling of tables with empty columns (#3337). We now
7779 calculate the number of columns based on the longest row (or the
7780 length of aligns or widths).
7781 + Escape unordered list markers at beginning of paragraph (#3497), to
7782 avoid false interpretation as a list.
7783 + Escape `|` appropriately.
7784 + Ensure space before list at top level (#3487).
7785 + Avoid spurious blanklines at end of document after tables and list,
7786 for example.
7787 + Fixed bugs in simple/multiline list output (#3384).
7788 Previously we got overlong lists with `--wrap=none`. This is fixed.
7789 Previously a multiline list could become a simple list (and would
7790 always become one with `--wrap=none`).
7791 + Don't emit a simple table if `simple_tables` disabled (#3529).
7792 + Case-insensitive reference links (David A Roberts, #3616).
7793 Ensure that we do not generate reference links whose labels differ only
7794 by case. Also allow implicit reference links when the link
7795 text and label are identical up to case.
7796 + Put space before reference link definitions (Mauro Bieg, #3630).
7797 + Better escaping for links (David A. Roberts, #3619). Previously the
7798 Markdown writer would sometimes create links where there were none
7799 in the source. This is now avoided by selectively escaping bracket
7800 characters when they occur in a place where a link might be created.
7801 + Added missing `\n` (David A. Roberts, #3647).
7802 + Fixed duplicated reference links with `--reference-links`
7803 and `--reference-location=section` (#3674). Also ensure that there
7804 are no empty link references `[]`.
7805 + Avoid inline surround-marking with empty content (#3715).
7806 E.g. we don't want `<strong></strong>` to become `****`.
7807 Similarly for emphasis, super/subscript, strikeout.
7808 + Don't allow soft break in header (#3736).
7809 + Make sure `plain`, `markdown_github`, etc. work for raw.
7810 Previously only `markdown` worked. Note: currently a raw block labeled
7811 `markdown_github` will be printed for any `markdown` format.
7812 + Ensure that `+` and `-` are escaped properly so they don't cause
7813 spurious lists (#3773). Previously they were only
7814 if succeeded by a space, not if they were at end of line.
7815 + Use pipe tables if `raw_html` disabled and `pipe_tables` enabled,
7816 even if the table has relative width information (#3734).
7817 + Markdown writer: don't crash on `Str ""`.
7818 + Make `Span` with null attribute transparent. That is, we don't use
7819 brackets or `<span>` tags to mark spans when there are no attributes;
7820 we simply output the contents.
7821 + Escape pipe characters when `pipe_tables` enabled (#3887).
7822 + Better escaping of `<` and `>`. If `all_symbols_escapable` is set,
7823 we backslash escape these. Otherwise we use entities as before.
7824 + When writing plain, don't use `&nbsp;` to separate list and indented
7825 code. There's no need for it in this context, since this isn't to be
7826 interpreted using Markdown rules.
7827 + Preserve classes in JS obfuscated links (Timm Albers, #2989).
7828 HTML links containing classes originally now preserve them when using
7829 javascript email obfuscation.
7830 + Render `SmallCaps` as a native span when `native_spans` are enabled.
7831 + Always write attributes with `bracketed_spans` (d-dorazio).
7833 * Man writer:
7835 + Fix handling of nested font commands (#3568). Previously pandoc emitted
7836 incorrect markup for bold + italic, for example, or bold + code.
7837 + Avoid error for definition lists with no definitions (#3832).
7839 * DocBook writer:
7841 + Fix internal links with `writerIdentifierPrefix opt`
7842 (#3397, Mauro Bieg).
7844 * Docx writer:
7846 + Don't include bookmarks on headers unless non-null id (#3476).
7847 + Support 9 levels of headers (#1642).
7848 + Allow 9 list levels (#3519).
7849 + Don't take `distArchive` from datadir (#3322). The docx writer takes
7850 components from the distribution's version of `reference.docx` when it
7851 can't find them in a user's custom `reference.docx`. Previously, we
7852 allowed a `reference.docx` in the data directory (e.g. `~/.pandoc`)
7853 to be used as the distribution's reference.docx. This led to a
7854 bizarre situation where pandoc would produce a good docx using
7855 `--template ~/.pandoc/ref.docx`, but if `ref.docx` were moved to
7856 `~/.pandoc/reference.docx`, it would then produce a corrupted docx.
7857 + Fixed handling of soft hyphen (0173) (#3691).
7858 + Better handling of keywords (#3719).
7859 + Cleaner code for handling dir and style attributes for `Div`.
7860 + Use `Set` for dynamic styles to avoid duplicates.
7861 + Removed redundant element from data/docx/word/numbering.xml.
7862 The elements we need are generated when the document is
7863 compiled; this didn't do anything.
7864 + Activate `evenAndOddHeaders` from reference docx (#3901,
7865 Augustín Martín Barbero).
7867 * ODT/OpenDocument writer:
7869 + Calculate aspect ratio for percentage-sized images (Mauro Bieg, #3239).
7870 + Use more widely available bullet characters (#1400). The old
7871 characters weren't available in some font sets. These seem to work
7872 well on Windows and Linux versions of LibreOffice.
7873 + Wider labels for lists (#2421). This avoids overly narrow labels for
7874 ordered lists with `()` delimiters. However, arguably it creates
7875 overly wide labels for bullets. Also, lists now start flush with
7876 the margin, rather than indented.
7877 + Fixed dropped elements in some ordered lists (#2434).
7879 * FB2 writer:
7881 + Don't render `RawBlock` as code.
7882 + Don't fail with an error on interior headers (e.g. in list) (#3750).
7883 Instead, omit them with an INFO message.
7884 + Add support for "lang" metadata (Alexander Krotov, #3625).
7885 + Format `LineBlock` as poem (Alexander Krotov). Previously writer
7886 produced one paragraph with `<empty-line/>` elements, which are not
7887 allowed inside `<p>` according to FB2 schema.
7888 + Replace `concatMap` with `cMap` (Alexander Krotov).
7889 + Write FB2 lists without nesting blocks inside `<p>` (Alexander
7890 Krotov, #4004)
7892 * HTML writer:
7894 + Make sure `html4`, `html5` formats work for raw blocks/inlines.
7895 + Render raw inline environments when `--mathjax` used (#3816).
7896 We previously did this only with raw blocks, on the assumption
7897 that math environments would always be raw blocks. This has changed
7898 since we now parse them as inline environments.
7899 + Ensure we don't get two style attributes for width and height.
7900 + Report when not rendering raw inline/block.
7901 + Issue warning if no title specified and template used (#3473).
7902 + Info message if `lang` is unspecified (#3486).
7903 + Removed unused parameter in `dimensionsToAttributeList`.
7904 + Avoid two class attributes when adding `uri` class (#3716).
7905 + Fix internal links with `writerIdentifierPrefix opt` (#3397, Mauro
7906 Bieg).
7907 + Use revealjs's math plugin for mathjax (#3743). This is a thin
7908 wrapper around mathjax that makes math look better on revealjs.
7909 + Slidy: use h1 for all slides, even if they were originally
7910 level 2 headers (#3566). Otherwise the built-in table of contents
7911 in Slidy breaks.
7913 * LaTeX writer:
7915 + Don't render LaTeX images with data: URIs (#3636). Note that
7916 `--extract-media` can be used when the input contains data: URIs.
7917 + Make highlighted code blocks work in footnotes (Timm Albers).
7918 + Don't use figure inside table cell (#3836).
7919 + Use proper code for list enumerators (#3891). This should fix problems
7920 with lists that don't use arabic numerals.
7921 + Always add hypertarget when there's a non-empty identifier (#2719).
7922 Previously the hypertargets were only added when there was actually
7923 a link to that identifier.
7924 + Use `%` after hypertarget before code block.
7925 + Add `\leavevmode` before hypertarget at start of paragraph (#2704,
7926 fixes formatting problems in beamer citations).
7927 + Don't use `lstinline` in `\item[..]` (#645). If you do, the contents
7928 of item disappear or are misplaced. Use `\texttt` instead.
7929 + Fix problem with escaping in `lstinline` (#1629). Previously the
7930 LaTeX writer created invalid LaTeX when `--listings` was specified and
7931 a code span occurred inside emphasis or another construction.
7932 + Fix error with line breaks after empty content (#2874). LaTeX
7933 requires something before a line break, so we insert a `~` if no
7934 printable content has yet been emitted.
7935 + Use BCP47 parser.
7936 + Fixed detection of otherlangs (#3770). We weren't recursing into
7937 inline contexts.
7938 + Handle language in inline code with `--listings` (#3422).
7939 + Write euro symbol directly in LaTeX (Andrew Dunning, #3801).
7940 The textcomp package allows pdfLaTeX to parse `€` directly, making the
7941 `\euro` command unneeded.
7942 + Fixed footnotes in table captions (#2378). Note that if the table has
7943 a first page header and a continuation page header, the notes will
7944 appear only on the first occurrence of the header.
7945 + In `writeBeamer` output, allow hyperlinks to frames (#3220).
7946 Previously you could link to a header above or below slide level but
7947 not *to* slide level. This commit changes that. Hypertargets are
7948 inserted inside frame titles; technically the reference is to just
7949 after the title, but in normal use (where slides are viewed full
7950 screen in a slide show), this does not matter.
7951 + Remove `\strut` at beginning of table cells (#3436). This fixes a
7952 problem with alignment of lists in table cells. The `\strut` at the
7953 end seems to be enough to avoid the too-close spacing that motivated
7954 addition of the strut in #1573.
7955 + Add partial siunitx Support (Marc Schreiber, #3588).
7957 * ConTeXt writer:
7959 + Refactored to use BCP47 module.
7960 + Remove unnecessary `$` (Alexander Krotov, #3482).
7961 + Use header identifiers for chapters (#3968).
7963 * EPUB writer:
7965 + `title_page.xhtml` is now put in `text/`.
7966 + Don't strip formatting in TOC (#1611).
7968 * Textile reader:
7970 + Fix bug for certain links in table cells (#3667).
7971 + Allow 'pre' code in list item (#3916).
7973 * HTML reader:
7975 + Added warnings for ignored material (#3392).
7976 + Better sanity checks to avoid parsing unintended things as
7977 raw HTML in the Markdown reader (#3257).
7978 + Revise treatment of `li` with `id` attribute (#3596). Previously we
7979 always added an empty div before the list item, but this created
7980 problems with spacing in tight lists. Now we do this: If the list
7981 item contents begin with a `Plain` block, we modify the `Plain`
7982 block by adding a `Span` around its contents. Otherwise, we add a
7983 `Div` around the contents of the list item (instead of adding an
7984 empty `Div` to the beginning, as before).
7985 + Add `details` tag to list of block tags (#3694).
7986 + Removed `button` from block tag list (#3717). It is already in the
7987 `eitherBlockOrInlineTag` list, and should be both places.
7988 + Use `Set`s instead of lists for block tag lookup.
7989 + Rewrote to use `Text` throughout. Effect on memory usage is modest
7990 (< 10%).
7991 + Use the lang value of `<html>` to set the lang meta value (bucklereed,
7992 #3765).
7993 + Ensure that paragraphs are closed properly when the parent block
7994 element closes, even without `</p>` (#3794).
7995 + Parse `<figure>` and `<figcaption>` (Mauro Bieg, #3813).
7996 + Parse `<main>` like `<div role=main>` (bucklereed, #3791).
7997 `<main>` closes `<p>` and behaves like a block element generally
7998 + Support column alignments (#1881). These can be set either
7999 with a `width` attribute or with `text-width` in a `style` attribute.
8000 + Modified state type to be an instance of `HasLogMessages`, so
8001 `registerHeader` can issue warnings.
8002 + `</td>` or `</th>` should close any open block tag (#3991).
8003 + `<td>` should close an open `<th>` or `<td>`.
8004 + `htmlTag` improvements (#3989). We previously failed on cases
8005 where an attribute contained a `>` character. This patch fixes the
8006 bug, which especially affects raw HTML in Markdown.
8008 * Txt2Tags reader:
8010 + Newline is not indentation (Alexander Krotov).
8012 * MediaWiki reader:
8014 + Allow extra hyphens after `|-` in tables (#2649).
8015 + Allow blank line after table start (#2649).
8016 + Fixed more table issues (#2649).
8017 + Ensure that list starts begin at left margin (#2606). Including when
8018 they're in tables or other list items.
8019 + Make smart double quotes depend on `smart` extension (#3585).
8020 + Don't do curly quotes inside `<tt>` contexts (#3585). Even if `+smart`.
8021 + Modified state type to be an instance of `HasLogMessages`, so
8022 `registerHeader` can issue warnings.
8024 * TWiki reader (Alexander Krotov):
8026 + Remove unnecessary `$` (#3597).
8027 + Simplify `linkText` (#3605).
8029 * EPUB reader:
8031 + Minor refactoring, avoiding explicit MediaBag handling.
8032 This all works behind the scenes in CommonState plumbing.
8034 * Docx reader:
8036 + Don't drop smartTag contents (#2242).
8037 + Handle local namespace declarations (#3365). Previously we didn't
8038 recognize math, for example, when the xmlns declaration occurred on
8039 the element and not the root.
8040 + More efficient trimSps (#1530). Replacing `trimLineBreaks`. This
8041 does the work of `normalizeSpaces` as well, so we avoid the need for
8042 that function here.
8043 + Avoid 0-level headers (Jesse Rosenthal, #3830). We used to parse
8044 paragraphs styled with "HeadingN" as "nth-level header." But if a
8045 document has a custom style named "Heading0", this will produce a
8046 0-level header, which shouldn't exist. We only parse this style
8047 if N>0. Otherwise we treat it as a normal style name, and
8048 follow its dependencies, if any.
8049 + Add tests for avoiding zero-level header (Jesse Rosenthal).
8051 * ODT reader:
8053 + Replaced `collectRights` with Rights from `Data.Either`.
8054 + Remove dead code (Albert Krewinkel).
8056 * Org reader (Albert Krewinkel, unless noted).
8058 + Don't allow tables inside list items (John MacFarlane, #3499).
8059 + Disallow tables on list marker lines (#3499).
8060 + Convert markup at beginning of footnotes (John MacFarlane, #3576).
8061 + Allow emphasized text to be followed by `[` (#3577).
8062 + Handle line numbering switch for src blocks.
8063 The line-numbering switch that can be given to source blocks (`-n` with
8064 an start number as an optional parameter) is parsed and translated to a
8065 class/key-value combination used by highlighting and other readers and
8066 writers.
8067 + Stop adding rundoc prefix to src params. Source block parameter names
8068 are no longer prefixed with `rundoc`. This was intended to simplify
8069 working with the rundoc project, a babel runner. However, the rundoc
8070 project is unmaintained, and adding those markers is not the reader's
8071 job anyway. The original language that is specified for a source
8072 element is now retained as the `data-org-language` attribute and only
8073 added if it differs from the translated language.
8074 + Allow multi-word arguments to src block params (#3477). The reader now
8075 correctly parses src block parameter list even if parameter arguments
8076 contain multiple words.
8077 + Avoid creating `nullMeta` by applying `setMeta` directly
8078 (Alexander Krotov).
8079 + Replace `sequence . map` with `mapM`.
8080 + Fix smart parsing behavior. Parsing of smart quotes and special
8081 characters can either be enabled via the `smart` language extension or
8082 the `'` and `-` export options. Smart parsing is active if either the
8083 extension or export option is enabled. Only smart parsing of special
8084 characters (like ellipses and en and em dashes) is enabled by default,
8085 while smart quotes are disabled. Previously, all smart parsing was
8086 disabled unless the language extension was enabled.
8087 + Subject full doc tree to headline transformations (Albert Krewinkel,
8088 #3695). Emacs parses org documents into a tree structure, which is
8089 then post-processed during exporting. The reader is changed to do the
8090 same, turning the document into a single tree of headlines starting
8091 at level 0.
8092 + Fix cite parsing behaviour (Herwig Stuetz). Until now, `org-ref`
8093 cite keys included special characters also at the end. This caused
8094 problems when citations occur right before colons or at the end of
8095 a sentence. With this change, all non alphanumeric characters at
8096 the end of a cite key are ignored. This also adds `,` to the list
8097 of special characters that are legal in cite keys to better mirror
8098 the behaviour of org-export.
8099 + Fix module names in haddock comments. Copy-pasting had lead to
8100 haddock module descriptions containing the wrong module names.
8101 + Recognize babel result blocks with attributes (#3706). Babel
8102 result blocks can have block attributes like captions and names.
8103 Result blocks with attributes were not recognized and were parsed
8104 as normal blocks without attributes.
8105 + Include tags in headlines. The Emacs default is to include tags in the
8106 headline when exporting. Instead of just empty spans, which contain the
8107 tag name as attribute, tags are rendered as small caps and wrapped in
8108 those spans. Non-breaking spaces serve as separators for multiple tags.
8109 + Respect export option for tags (#3713). Tags are appended to
8110 headlines by default, but will be omitted when the `tags` export option
8111 is set to nil.
8112 + Use `tag-name` attribute instead of `data-tag-name`.
8113 + Use `org-language` attribute rather than `data-org-language`.
8114 + Modified state type to be an instance of `HasLogMessages`, so
8115 `registerHeader` can issue warnings.
8116 + End footnotes after two blank lines. Footnotes can not only be
8117 terminated by the start of a new footnote or a header, but also by two
8118 consecutive blank lines.
8119 + Update emphasis border chars (#3933). The org reader was updated to
8120 match current org-mode behavior: the set of characters which are
8121 acceptable to occur as the first or last character in an org emphasis
8122 have been changed and now allows all non-whitespace chars at the
8123 inner border of emphasized text (see `org-emphasis-regexp-components`).
8125 * RST reader:
8127 + Fixed small bug in list parsing (#3432). Previously the parser didn't
8128 handle properly this case:
8130 * - a
8131 - b
8132 * - c
8133 - d
8134 + Handle multiline cells in simple tables (#1166).
8135 + Parse list table directive (Keiichiro Shikano, #3432).
8136 + Make use of `anyLineNewline` (Alexander Krotov, #3686).
8137 + Use `anyLineNewline` in `rawListItem` (Alexander Krotov, #3702).
8138 + Reorganize block parsers for ~20% faster parsing.
8139 + Fixed `..include::` directive (#3880).
8140 + Handle blank lines correctly in line blocks (Alexander Krotov, #3881).
8141 Previously pandoc would sometimes combine two line blocks separated
8142 by blanks, and ignore trailing blank lines within the line block.
8143 + Fix indirect hyperlink targets (#512).
8145 * Markdown reader:
8147 + Allow attributes in reference links to start on next line (#3674).
8148 + Parse YAML metadata in a context that sees footnotes defined in
8149 the body of the document (#1279).
8150 + When splitting pipe table cells, skip tex math (#3481).
8151 You might have a `|` character inside math. (Or for that matter
8152 something that the parser might mistake for raw HTML.)
8153 + Treat span with class `smallcaps` as SmallCaps.
8154 This allows users to specify small caps in Markdown this way:
8155 `[my text]{.smallcaps}` (#1592).
8156 + Fixed internal header links (#2397).
8157 This patch also adds `shortcut_reference_links` to the list
8158 of mmd extensions.
8159 + Treat certain environments as inline
8160 when they occur without space surrounding them (#3309, #2171).
8161 E.g. equation, math. This avoids incorrect vertical space
8162 around equations.
8163 + Optimized `nonindentSpaces`. Makes the benchmark go from 40 to 36 ms.
8164 + Allow latex macro definitions indented 1-3 spaces.
8165 Previously they only worked if nonindented.
8166 + Improved parsing of indented raw HTML blocks (#1841).
8167 Previously we inadvertently interpreted indented HTML as
8168 code blocks. This was a regression. We now seek to determine the
8169 indentation level of the contents of an HTML block, and (optionally)
8170 skip that much indentation. As a side effect, indentation may be
8171 stripped off of raw HTML blocks, if `markdown_in_html_blocks` is
8172 used. This is better than having things interpreted as indented
8173 code blocks.
8174 + Fixed smart quotes after emphasis (#2228). E.g. in `*foo*'s 'foo'`.
8175 + Warn for notes defined but not used (#1718).
8176 + Use `anyLineNewline` (Alexander Krotov).
8177 + Interpret YAML metadata as Inlines when possible (#3755). If
8178 the metadata field is all on one line, we try to interpret it as
8179 Inlines, and only try parsing as Blocks if that fails. If it
8180 extends over one line (including possibly the `|` or `>` character
8181 signaling an indented block), then we parse as Blocks. This was
8182 motivated by some German users finding that `date: '22. Juin 2017'`
8183 got parsed as an ordered list.
8184 + Fixed spurious parsing as citation as reference def (#3840).
8185 We now disallow reference keys starting with `@` if the
8186 `citations` extension is enabled.
8187 + Parse `-@roe` as suppress-author citation (pandoc-citeproc#237).
8188 Previously only `[-@roe]` (with brackets) was recognized as
8189 suppress-author, and `-@roe` was treated the same as `@roe`.
8190 + Fixed parsing of fenced code after list when there is no intervening
8191 blank line (#3733).
8192 + Allow raw latex commands starting with `\start` (#3558). Previously
8193 these weren't allowed because they were interpreted as starting
8194 ConTeXt environments, even without a corresponding `\stop`...
8195 + Added `inlines`, `inlines1`.
8196 + Require nonempty alt text for `implicit_figures` (#2844).
8197 A figure with an empty caption doesn't make sense.
8198 + Removed texmath macro material; now all this is handled
8199 in the LaTeX reader functions.
8200 + Fixed bug with indented code following raw LaTeX (#3947).
8202 * LaTeX reader:
8204 + Rewrote LaTeX reader with proper tokenization (#1390,
8205 #2118, #3236, #3779, #934, #982). This rewrite is primarily
8206 motivated by the need to get macros working properly. A side benefit
8207 is that the reader is significantly faster. We now tokenize the
8208 input text, then parse the token stream. Macros modify the token
8209 stream, so they should now be effective in any context, including
8210 math. Thus, we no longer need the clunky macro processing
8211 capacities of texmath.
8212 + Parse `\,` to `\8198` (six-per-em space) (Henri Werth).
8213 + Allow `\newcommand\foo{blah}` without braces.
8214 + Support `\lstinputlisting` (#2116).
8215 + Issue warnings when skipping unknown latex commands (#3392).
8216 + Include contents of `\parbox`.
8217 + Allow `\hspace` and `\vspace` to count as raw block or inline.
8218 Previously we would refuse to parse anything as raw inline if
8219 it was in the `blockCommands` list. Now we allow exceptions
8220 if they're listed under ignoreInlines in inlineCommands.
8221 This should make it easier e.g. to include an `\hspace`
8222 between two side-by-side raw LaTeX tables.
8223 + Don't drop contents of `\hypertarget`.
8224 + Handle spaces before `\cite` arguments.
8225 + Allow newpage, clearpage, pagebreak in inline contexts as well as
8226 block contexts (#3494).
8227 + Treat `{{xxx}}` the same as `{xxx}` (#2115).
8228 + Use `pMacroDefinition` in macro (for more direct parsing).
8229 Note that this means that `macro` will now parse one
8230 macro at a time, rather than parsing a whole group together.
8231 + Fixed failures on `\ref{}`, `\label{}` with `+raw_tex`. Now these
8232 commands are parsed as raw if `+raw_tex`; otherwise, their argument
8233 is parsed as a bracketed string.
8234 + Don't crash on empty `enumerate` environment (#3707).
8235 + Handle escaped `&` inside table cell (#3708).
8236 + Handle block structure inside table cells (#3709). `minipage` is no
8237 longer required.
8238 + Handle some width specifiers on table columns (#3709). Currently
8239 we only handle the form `0.9\linewidth`. Anything else would have
8240 to be converted to a percentage, using some kind arbitrary assumptions
8241 about line widths.
8242 + Make sure `\write18` is parsed as raw LaTeX. The change is in the
8243 LaTeX reader's treatment of raw commands, but it also affects the
8244 Markdown reader.
8245 + Fixed regression with starred environment names (#3803).
8246 + Handle optional args in raw `\titleformat` (#3804).
8247 + Improved heuristic for raw block/inline. An unknown command at the
8248 beginning of the line that could be either block or inline is
8249 treated as block if we have a sequence of block commands followed by
8250 a newline or a `\startXXX` command (which might start a raw ConTeXt
8251 environment).
8252 + Don't remove macro definitions from the output, even if
8253 `Ext_latex_macros` is set, so that macros will be applied.
8254 Since they're only applied to math in Markdown, removing the macros
8255 can have bad effects. Even for math macros, keeping them should be
8256 harmless.
8257 + Removed `macro`. It is no longer necessary, since the
8258 `rawLaTeXBlock` parser will parse macro definitions. This also avoids
8259 the need for a separate `latexMacro` parser in the Markdown reader.
8260 + Use `label` instead of `data-label` for label in caption (#3639).
8261 + Fixed space after `\figurename` etc.
8262 + Resolve references to section numbers.
8263 + Fix `\let\a=0` case, with single character token.
8264 + Allow `@` as a letter in control sequences. `@` is commonly used
8265 in macros using `\makeatletter`. Ideally we'd make the tokenizer
8266 sensitive to `\makeatletter` and `\makeatother`, but until then this
8267 seems a good change.
8268 + Track header numbers and correlate with labels.
8269 + Allow `]` inside group in option brackets (#3857).
8270 + lstinline with braces can be used (verb cannot be used with braces)
8271 (Marc Schreiber, #3535).
8272 + Fix keyval function: pandoc did not parse options in braces correctly
8273 (Marc Schreiber, #3642).
8274 + When parsing raw LaTeX commands, include trailing space (#1773).
8275 Otherwise things like `\noindent foo` break and turn into
8276 `\noindentfoo`. Affects `-f latex+raw_tex` and `-f markdown` (and other
8277 formats that allow `raw_tex`).
8278 + Don't treat "..." as Quoted (#3958). This caused quotes to be omitted in
8279 `\texttt` contexts.
8280 + Add tests for existing `\includegraphics` behaviour (Ben Firshman).
8281 + Allow space before `=` in bracketd options (Ben Firshman).
8282 + Be more forgiving in parsing command options. This was needed, for
8283 example, to make some minted options work.
8284 + Strip off quotes in `\include` filenames.
8286 * Added `Text.Pandoc.CSV`, simple (unexported) CSV parser.
8288 * `Text.Pandoc.PDF`:
8290 + Got `--resource-path` working with PDF output (#852).
8291 + Fetch images when generating PDF via context (#3380).
8292 To do this, we create the temp directory as a subdirectory
8293 of the working directory. Since context mk IV by default looks
8294 for images in the parent directory, this works.
8295 + Use `report` instead of `warn`, make it sensitive to verbosity settings.
8296 + Use `fillMediaBag` and `extractMedia` to extract media to temp dir.
8297 This reduces code duplication.
8298 + `html2pdf`: use stdin instead of intermediate HTML file
8299 + Removed useless `TEXINPUTS` stuff for `context2pdf`. mkiv context
8300 doesn't use `TEXINPUTS`.
8302 * `Text.Pandoc.Pretty`:
8304 + Simplified definition of `realLength`.
8305 + Don't error for blocks of size < 1. Instead, resize to 1 (see #1785).
8307 * `Text.Pandoc.MIME`:
8309 + Use `application/javascript` (not `application/x-javascript`).
8310 + Added `emf` to mimeTypes with type `application/x-msmetafile` (#1713).
8312 * `Text.Pandoc.ImageSize`:
8314 + Improve SVG image size code (Marc Schreiber, #3580).
8315 + Make `imageSize` recognize basic SVG dimensions (Mauro Bieg, #3462).
8317 * Use `Control.Monad.State.Strict` throughout. This gives 20-30% speedup
8318 and reduction of memory usage in most of the writers.
8320 * Use `foldrWithKey` instead of deprecated `foldWithKey`.
8322 * `Text.Pandoc.SelfContained`:
8324 + Fixed problem with embedded fonts (#3629).
8325 + Refactored getData from `getDataURI` in `SelfContained`.
8326 + Don't use data URIs for script or style (#3423). Instead, just use
8327 script or style tags with the content inside. The old method with
8328 data URIs prevents certain optimizations outside pandoc. Exception:
8329 data URIs are still used when a script contains `</script>` or a
8330 style contains `</`.
8331 + SelfContained: Handle URL inside material retrieved from a URL
8332 (#3629). This can happen e.g. with an @import of a google web font.
8333 (What is imported is some CSS which contains an url reference
8334 to the font itself.) Also, allow unescaped pipe (|) in URL.
8335 + Load resources from `data-src` (needed for lazy loading in
8336 reveal.js slide shows).
8337 + Handle `data-background-image` attribute on section (#3979).
8339 * `Text.Pandoc.Parsing`:
8341 + Added `indentWith` (Alexander Krotov, #3687).
8342 + Added `stateCitations` to `ParserState`.
8343 + Removed `stateChapters` from `ParserState`.
8344 + In `ParserState`, make `stateNotes'` a Map, add `stateNoteRefs`.
8345 + Added `gobbleSpaces` and `gobbleAtMostSpaces`.
8346 + Adjusted type of `insertIncludedFile` so it can be used with token
8347 parser.
8348 + Replace old texmath macro stuff from Parsing. Use Macro from
8349 Text.Pandoc.Readers.LaTeX.Types instead.
8350 + Export `insertIncludedFile`.
8351 + Added `HasLogMessages`, `logMessage`, `reportLogMessages` (#3447).
8352 + Replace partial with total function (Albert Krewinkel).
8353 + Introduce `HasIncludeFiles` type class (Albert Krewinkel). The
8354 `insertIncludeFile` function is generalized to work with all parser
8355 states which are instances of that class.
8356 + Add `insertIncludedFilesF` which returns F blocks (Albert Krewinkel).
8357 The `insertIncludeFiles` function was generalized and renamed
8358 to `insertIncludedFiles'`; the specialized versions are based on that.
8359 + `many1Till`: Check for the end condition before parsing (Herwig
8360 Stuetz). By not checking for the end condition before the first
8361 parse, the parser was applied too often, consuming too much of the
8362 input. This only affects `many1Till p end` where `p` matches on a
8363 prefix of `end`.
8364 + Provide `parseFromString` (#3690). This is a version of
8365 `parseFromString` specialied to ParserState, which resets
8366 `stateLastStrPos` at the end. This is almost always what we want.
8367 This fixes a bug where `_hi_` wasn't treated as emphasis in the
8368 following, because pandoc got confused about the position of the
8369 last word: `- [o] _hi_`.
8370 + Added `takeP`, `takeWhileP` for efficient parsing of `[Char]`.
8371 + Fix `blanklines` documentation (Alexander Krotov, #3843).
8372 + Give less misleading line information with `parseWithString`.
8373 Previously positions would be reported past the end of the chunk.
8374 We now reset the source position within the chunk and report
8375 positions "in chunk."
8376 + Add `anyLineNewline` (Alexander Krotov).
8377 + Provide shared F monad functions for Markdown and Org readers
8378 (Albert Krewinkel). The `F` monads used for delayed evaluation
8379 of certain values in the Markdown and Org readers are based on a
8380 shared data type capturing the common pattern of both `F` types.
8381 + Add `returnF` (Alexander Krotov).
8382 + Avoid parsing `Notes:**` as a bare URI (#3570). This avoids parsing
8383 bare URIs that start with a scheme + colon + `*`, `_`, or `]`.
8384 + Added `readerAbbreviations` to `ParserState`. Markdown reader
8385 now consults this to determine what is an abbreviation.
8386 + Combine grid table parsers (Albert Krewinkel, #3638). The grid table
8387 parsers for markdown and rst was combined into one single
8388 parser `gridTable`, slightly changing parsing behavior of both
8389 parsers: (1) The markdown parser now compactifies block content
8390 cell-wise: pure text blocks in cells are now treated as paragraphs
8391 only if the cell contains multiple paragraphs, and as plain blocks
8392 otherwise. Before, this was true only for single-column tables. (2)
8393 The rst parser now accepts newlines and multiple blocks in header
8394 cells.
8395 + Generalize tableWith, gridTableWith (Albert Krewinkel).
8396 The parsing functions `tableWith` and `gridTableWith` are generalized
8397 to work with more parsers. The parser state only has to be an
8398 instance of the `HasOptions` class instead of requiring a concrete
8399 type. Block parsers are required to return blocks wrapped into a
8400 monad, as this makes it possible to use parsers returning results
8401 wrapped in `Future`s.
8403 * `Text.Pandoc.Shared`:
8405 + Simplify `toRomanNumeral` using guards (Alexander Krotov, #3445)
8406 + `stringify`: handle Quoted better (#3958). Previously we were losing
8407 the quotation marks in Quoted elements.
8409 * `Text.Pandoc.Writers.Shared`:
8411 + Export `metaToJSON'`, `addVariablesToJSON` (#3439).
8412 This allows us to add the variables AFTER using the metadata
8413 to generate a YAML header (in the Markdown writer).
8414 + Added `unsmartify` (previously in RST writer).
8415 Undo literal double curly quotes. Previously we left these.
8416 + Generalize type of `metaToJSON` so it can take a Text. Previously a
8417 String was needed as argument; now any ToJSON instance will do.
8418 + Added `gridTable` (previously in Markdown writer).
8419 + `gridTable`: Refactored to use widths in chars.
8420 + `gridTable`: remove unnecessary extra space in cells.
8421 + Fixed `addVariablesToJSON`. It was previously not allowing multiple
8422 values to become lists.
8423 + Pipe tables: impose minimum cell size (see #3526).
8426### Default template changes
8428 * HTML templates (including EPUB and HTML slide show templates):
8430 + Make default.html5 polyglot markup conformant (John Luke Bentley,
8431 #3473). Polyglot markup is HTML5 that is also valid XHTML. See
8432 <https://www.w3.org/TR/html-polyglot>. With this change, pandoc's
8433 html5 writer creates HTML that is both valid HTML5 and valid XHTML.
8434 + Regularized CSS in html/epub/html slide templates (#3485).
8435 All templates now include `code{white-space: pre-wrap}`
8436 and CSS for `q` if `--html-q-tags` is used. Previously some templates
8437 had `pre` and others `pre-wrap`; the `q` styles were only sometimes
8438 included.
8439 + CSS for `.smallcaps`, (Mauro Bieg, #1592)
8440 + `default.revealjs`: make `history` default to true.
8441 + `default.revealjs`: use lazy loading (#2283).
8442 + `default.revealjs`: add `mathjax` variable and some conditional code
8443 to use the MathJaX plugin.
8444 + `default.slidy` uses `https` instead of `http` (ickc, #3848).
8445 + `default.dzslides`: Load Google Font using HTTPS by default
8446 (Yoan Blanc).
8448 * DocBook5 template: Use `lang` and `subtitle` variables (Jens Getreu,
8449 #3855).
8451 * LaTeX/Beamer template:
8453 + Combine LaTeX/Beamer templates (Andrew Dunning, #3878).
8454 `default.beamer` has been removed; beamer now uses the
8455 `default.latex` template. Beamer-specific parts are conditional
8456 on the `beamer` variable set by the writer. Note that
8457 `pandoc -D beamer` will return this (combined) template.
8458 + Use `xcolor` for `colorlinks` option (Andrew Dunning, #3877).
8459 Beamer loads `xcolor` rather than `color`, and thus the
8460 `dvipsnames` option doesn't take effect. This also provides a wider
8461 range of colour selections with the `svgnames` option.
8462 + Use starred versions of `xcolor` names (Andrew Dunning).
8463 Prevents changes to documents defined using the `dvipsnames` list (e.g.
8464 `Blue` gives a different result with svgnames enabled).
8465 + Load `polyglossia` after header-includes (#3898). It needs to be
8466 loaded as late as possible.
8467 + Use `unicode-math` (Vaclav Haisman). Use `mathspec` with only
8468 XeLaTeX on request.
8469 + Don't load `fontspec` before `unicode-math` (over there).
8470 The `unicode-math` package loads `fontspec` so explict loading of
8471 `fontspec` before `unicode-math` is not necessary.
8472 + Use `unicode-math` by default in default.latex template. mathspec will
8473 be used in xelatex if the `mathspec` variable is set; otherwise
8474 unicode-math will be used (Václav Haisman).
8475 + Use `dvipsnames` options when `colorlinks` specified (otherwise
8476 we get an error for `maroon`) (Thomas Hodgson).
8477 + Added beamer `titlegraphic` and `logo` variables (Thomas Hodgson).
8478 + Fix typo in fix for notes in tables (#2378, zeeMonkeez).
8479 + Fix `hyperref` options clash (Andrew Dunning, #3847) Avoids an options
8480 clash when loading a package (e.g. `tufte-latex`) that uses
8481 `hyperref` settings different from those in the template.
8482 + Add `natbiboptions` variable (#3768).
8483 + Fix links inside captions in LaTeX output with links-as-notes
8484 (Václav Haisman, #3651). Declare our redefined `\href` robust.
8485 + Load `parskip` before `hyperref` (Václav Haisman, #3654).
8486 + Allow setting Japanese fonts when using LuaLaTeX (Václav Haisman,
8487 #3873). by using the `luatexja-fontspec` and `luatexja-preset`
8488 packages. Use existing `CJKmainfont` and `CJKoptions` template
8489 variables. Add `luatexjafontspecoptions` for `luatexja-fontspec`
8490 and `luatexjapresetoptions` for `luatexja-preset`.
8491 + Added `aspectratio` variable to beamer template (Václav Haisman,
8492 #3723).
8493 + Modified template.latex to fix XeLaTex being used with tables
8494 (lwolfsonkin, #3661). Reordered `lang` variable handling to
8495 immediately before `bidi`.
8497 * ConTeXt template: Improved font handling: `simplefonts` is now
8498 obsolete in ConTeXt (Pablo Rodríguez).
8501### Documentation improvements
8503 * MANUAL.txt:
8505 + Add URL for Prince HTML > PDF engine (Ian, #3919).
8506 + Document that content above slide-level will be omitted in
8507 slide shows. See #3460, #2265.
8508 + Explain `--webtex` SVG url (Mauro Bieg, #3471)
8509 + Small clarification in YAML metadata section.
8510 + Document that html4 is technically XHTML 1.0 transitional.
8511 + Remove refs to highlighting-kate (#3672).
8512 + Document ibooks specific epub metadata.
8513 + Clarify that mathml is used for ODT math.
8514 + Mention limitations of Literate Haskell Support (#3410,
8515 Joachim Breitner).
8516 + Add documentation of limitations of grid tables (Stephen
8517 McDowell, #3864).
8518 + Clarify that meta-json contains transformed values (Jakob Voß,
8519 #3491) Make clear that template variable `meta-json` does not
8520 contain plain text values or JSON output format but field values
8521 transformed to the selected output format.
8523 * COPYRIGHT:
8525 + Clarify that templates are dual-licensed.
8526 + Clarify that pandoc-types is BSD3 licensed.
8527 + List new files not written by jgm (Albert Krewinkel).
8528 + Update dates in copyright notices (Albert Krewinkel). This follows
8529 the suggestions given by the FSF for GPL licensed software.
8530 <https://www.gnu.org/prep/maintain/html_node/Copyright-Notices.html>
8532 * INSTALL.md:
8534 + Improved instructions for tests with patterns.
8535 + Put RPM-based distros on separate point (Mauro Bieg, #3449)
8537 * CONTRIBUTING.md:
8539 + Fixed typos (Wandmalfarbe, #3479).
8540 + Add "ask on pandoc-discuss" (Mauro Bieg).
8542 * Add lua filter documentation in `doc/lua-filters.md`. Note that the
8543 end of this document is autogenerated from `data/pandoc.lua`
8544 using `make doc/lua-filters.md`, which uses `tools/ldoc.ltp`
8545 (Albert Krewinkel).
8547 * Add `doc/filters.md`. This is the old scripting tutorial from
8548 the website.
8550 * Add `doc/using-the-pandoc-api.md` (#3289). This gives an introduction
8551 to using pandoc as a Haskell library.
8554### Build infrastructure improvements
8556 * Removed `data/templates` submodule. Templates are now a subtree
8557 in `data/templates`. This removes the need to do `git submodule
8558 update`.
8560 * Renamed `tests` -> `test`.
8562 * Remove `https` flag. Always build with HTTPS support.
8564 * Use `file-embed` instead of `hsb2hs` to embed data files when
8565 `embed_data_files` flag is set. `file-embed` gives us better dependency
8566 tracking: if a data file changes, ghc/stack/cabal know to recompile
8567 the Data module. This also removes `hsb2hs` as a build dependency.
8569 * Add `custom-setup` stanza to pandoc, lowercase field names.
8571 * Add `static` Cabal flag.
8573 * Name change OSX -> MacOS. Add a -MacOS suffix to mac package rather
8574 than -OSX. Changed local names from osx to macos.
8576 * make_macos_package.sh - Use strip to reduce executable size.
8578 * Revised binary linux package. Now a completely static executable
8579 is created, using Docker and alpine. We create both a deb and a
8580 tarball. The old `deb` directory has been replaced with a `linux`
8581 directory. Running `make` in the `linux` directory should
8582 perform the build, putting the binary packages in `artifacts/`.
8584 * `linux/control.in`: add `Replaces:`, so existing pandoc-citeproc and
8585 pandoc-data packages will be uninstalled; this package provides
8586 both (#3822). Add latex packages as 'suggested', update
8587 description.
8589 * Remove cpphs build requirement -- it is no longer needed.
8591 * Replaced `{deb,macos,windows}/stack.yaml` with `stack.pkg.yaml`.
8593 * Name change OSX -> macOS (ickc, #3869).
8595 * Fix casing of Linux, UNIX, and Windows (ickc).
8597 * `.travis.yml`: create a source dist and do cabal build and test there.
8598 That way we catch errors due to files missing from the data
8599 section of pandoc.cabal.
8601 * Makefile:
8603 + Split `make haddock` from `make full`.
8604 + Add BRANCH variable for winpkg.
8605 + Add `lint` target.
8606 + Improve `make full`. Disable optimizations.
8607 Build everything, inc. trypandoc and benchmarks. Use parallel build.
8608 + Allow `make test` to take `TESTARGS`.
8610 * Added new command tests (`Tests.Command`), using small text files
8611 in `test/command/`. Any files added in this directory will be treated
8612 as shell tests (see smart.md for an example). This makes it very easy
8613 to add regression tests etc.
8615 * Test fixes so we can find data files. In old tests & command tests,
8616 we now set the environment variable `pandoc_datadir`. In lua tests,
8617 we set the datadir explicitly.
8619 * Refactored `compareOutput` in docx writer test.
8621 * Consolidated some common functions in `Tests.Helper`.
8623 * Small change to unbalanced bracket test to speed up test suite.
8625 * Speed up Native writer quickcheck tests.
8627 * Use tasty for tests rather than test-framework.
8629 * Add simple Emacs mode to help with Pandoc templates editing.
8630 (Václav Haisman, #3889). `tools/pandoc-template-mode.el`
8633## pandoc 1.19.2.4 (2017-09-10)
8635 * Add dependencies on texmath and skylighting to the executable.
8636 This is needed for dependency version numbers to be available,
8637 with Cabal > 2.
8639## pandoc 1.19.2.3 (2017-09-09)
8641 * Add CPP to Setup.hs so it works with Cabal >= 2 and < 2.
8643## pandoc 1.19.2.2 (2017-09-08)
8645 * Fix build with GHC 8.2.1 (#3876, Peter Simons). Setup.hs does not
8646 compile with Cabal 2.x, so we require an earlier version via
8647 setup-depends. The following packages need newer versions with
8648 GHC 8.2.1 and had their constraints relaxed accordingly:
8649 executable-path, process, syb, and time.
8651## pandoc 1.19.2.1 (2017-01-31)
8653 * Require skylighting >= 0.1.1.4.
8654 * Adjust test output for skylighting version.
8655 * Relax upper bounds on blaze-html and blaze-markup.
8657## pandoc 1.19.2 (2017-01-29)
8659 * Use skylighting library instead of highlighting-kate for syntax
8660 highlighting. Skylighting is faster and more accurate (#3363).
8661 Later we'll be able to add features like warning messages, dynamic
8662 loading of xml syntax definitions, and dynamic loading of themes.
8664 * Added a new highlight style, `breezeDark`.
8666 * Text.Pandoc.Highlighting: Update list of `listings` languages (#3374).
8667 This allows more languages to be used when using the `--listings`
8668 option.
8670 * OpenDocument writer:
8672 + Small refactoring. Removed separate 'parent' parameter in paraStyle.
8673 + Don't profilerate text styles unnecessarily (#3371).
8674 This change makes the writer create only as many temporary
8675 text styles as are absolutely necessary. It also consolidates
8676 adjacent nodes with the same style.
8678 * Org reader (Albert Krewinkel):
8680 + Allow short hand for single-line raw blocks (Albert Krewinkel,
8681 #3366). Single-line raw blocks can be given via `#+FORMAT: raw line`,
8682 where `FORMAT` must be one of `latex`, `beamer`, `html`, or `texinfo`.
8683 + Accept org-ref citations followed by commas (Albert Krewinkel).
8684 Bugfix for an issue which, whenever the citation was immediately
8685 followed by a comma, prevented correct parsing of org-ref citations.
8686 + Ensure emphasis markup can be nested. Nested emphasis markup (e.g.
8687 `/*strong and emphasized*/`) was interpreted incorrectly in that the
8688 inner markup was not recognized.
8689 + Remove pipe char irking the haddock coverage tool (Albert Krewinkel).
8691 * Docx reader: Empty header should be list of lists (Jesse Rosenthal).
8692 In the past, the docx reader wrote an empty header as an empty list. It
8693 should have the same width as a row (and be filled with empty cells).
8695 * MediaWiki reader:
8697 + Improved handling of display math (#3362). Sometimes display math is
8698 indented with more than one colon. Previously we handled these cases
8699 badly, generating definition lists and missing the math.
8700 + Fix quotation mark parsing (#3336, tgkokk). Change MediaWiki reader's
8701 behavior when the smart option is parsed to match other readers'
8702 behavior.
8704 * Markdown reader:
8706 + Fixed `-f markdown_github-hard_line_breaks+escaped_line_breaks`
8707 (#3341). Previously this did not properly enable escaped line breaks.
8708 + Disallow space between inline code and attributes (#3326, #3323,
8709 Mauro Bieg).
8711 * DocBook5 writer: make id attribute xml:id, fixes #3329 (#3330, Mauro Bieg).
8713 * Added some test cases for ODT reader (#3306, #3308, Hubert Plociniczak).
8715 * LaTeX writer: allow tables with empty cells to count as "plain."
8716 This addresses a problem of too-wide tables when empty cells
8717 are used. Thanks to Joost Kremers for reporting the issue.
8719 * Org writer: prefix footnote numbers with `fn:` (Albert Krewinkel).
8720 Unprefixed numbers where used by older org-mode versions, but are no
8721 longer supported.
8723 * HTML writer: don't process pars with empty RawInline, (#1040, #3327,
8724 Mauro Bieg).
8726 * Markdown writer: Fix display math with `--webtex` (#3298).
8728 * Fix sample.lua so it properly handles raw blocks/inlines (#3358,
8729 bumper314).
8731 * Templates:
8733 + default.latex: Moved geometry after hyperref (Václav Haisman).
8734 Otherwise PDF sizes can be wrong in some circumstances.
8735 + Copied a few changes from default.latex to default.beamer
8736 (Wandmalfarbe).
8737 + default.latex, default.beamer: Changed position of `\VerbatimNotes`
8738 and `fancyvrb`. This fixes hyperlinks on footnotes in documents
8739 that contain verbatim in notes (#3361). (Note: the beamer template
8740 was updated to match the LaTeX template, but at this point verbatim
8741 in notes seems not to work in beamer.)
8742 + default.latex: Allow passing `microtypeoptions` to microtype
8743 (Václav Haisman).
8744 + default.latex: Add hyphen option to url package.
8745 + default.docbook5: Fix namespace declarations (Mauro Bieg).
8747 * Moved `make_osx_package.sh` to `osx/` directory.
8749 * Travis continuous integration:
8751 + Fix false positives with dist build.
8752 + Speed improvements (Kolen Cheung, #3304, #3357).
8754 * MANUAL.txt:
8756 + Clarify that blank space is needed around footnotes (#3352).
8757 + Fixed typo (#3351, Alexey Rogechev).
8758 + Note that `--wrap=auto` does not work in HTML output.
8759 + Default `--columns` width is 72, not 80.
8760 + Fixed broken links (#3316, Kolen Cheung).
8761 + Document usage of `@*` in nocite section (#3333, John Muccigrosso).
8763 * INSTALL.md:
8765 + Indent code so it's properly formatted (#3335, Bheesham Persaud).
8766 + Added instructions for extracting binary from OSX, Windows packages.
8768 * CONTRIBUTING.md: Describe labels currently used in issue tracker
8769 (Albert Krewinkel). The labels have changed over time, the list of
8770 labels is updated to reflect the current set of labels used in the
8771 issue tracker.
8773 * Rearrange and extend badges in README (Albert Krewinkel, #3354)
8775 * Bumped version bounds for dependencies.
8778## pandoc 1.19.1 (2016-12-10)
8780 * Set `PANDOC_VERSION` environment variable for filters (#2640).
8781 This allows filters to check the pandoc version that produced
8782 the JSON they are receiving.
8784 * Docx reader: Ensure one-row tables don't have header (#3285,
8785 Jesse Rosenthal). Tables in MS Word are set by default to have
8786 special first-row formatting, which pandoc uses to determine whether
8787 or not they have a header. This means that one-row tables will, by
8788 default, have only a header -- which we imagine is not what people
8789 want. This change ensures that a one-row table is not understood to
8790 be a header only. Note that this means that it is impossible to
8791 produce a header-only table from docx, even though it is legal
8792 pandoc. But we believe that in nearly all cases, it will be an
8793 accidental (and unwelcome) result
8795 * HTML reader:
8797 + Fixed some bad regressions in HTML table parser (#3280).
8798 This regression leads to the introduction of empty rows
8799 in some circumstances.
8800 + Understand `style=width:` as well as `width` in `col` (#3286).
8802 * RST reader:
8804 + Print warnings when keys, substitition, notes not found.
8805 Previously the parsers failed and we got raw text. Now we get a
8806 link with an empty URL, or empty inlines in the case of a note or
8807 substitution.
8809 + Fix hyperlink aliases (#3283).
8811 * Man writer: Ensure that periods are escaped at beginning of line
8812 (#3270).
8814 * LaTeX writer: Fix unnumbered headers when used with `--top-level`
8815 (#3272, Albert Krewinkel). Fix interaction of top-level
8816 divisions `part` or `chapter` with unnumbered headers when
8817 emitting LaTeX. Headers are ensured to be written using
8818 stared commands (like `\subsection*{}`).
8820 * LaTeX template: use comma not semicolon to separate keywords for
8821 `pdfkeywords`. Thanks to Wandmalfarbe.
8823 * Markdown writer: Fixed incorrect word wrapping (#3277).
8824 Previously pandoc would sometimes wrap lines too early due to
8825 this bug.
8827 * Text.Pandoc.Pretty: Added `afterBreak` [API change]. This makes it
8828 possible to insert escape codes for content that needs escaping at the
8829 beginning of a line.
8831 * Removed old MathMLInHTML.js from 2004, which should no longer
8832 be needed for MathML with modern browsers.
8834 * Fixed tests with dynamic linking (#2709).
8836 * Makefile: Use stack instead of cabal for targets. This is just
8837 a convenience for developers.
8839 * Fixed bash completion of filenames with space (#2749).
8841 * MANUAL: improved documentation on how to create a custom
8842 `reference.docx`.
8844 * Fix minor spelling typos in the manual (#3273, Anthony Geoghegan)
8846## pandoc 1.19 (2016-12-01)
8848 * Changed resolution of filter paths.
8850 + We now first treat the argument of `--filter` as a full (absolute
8851 or relative) path, looking for a program there. If it's found, we
8852 run it.
8853 + If not, and if it is a simple program name or a relative path, we
8854 try resolving it relative to `$DATADIR/filters`.
8855 + If this fails, then we treat it as a program name and look in the
8856 user's PATH.
8857 + Removed a hardcoded '/' that may have caused problems with
8858 Windows paths.
8860 Previously if you did `--filter foo` and you had `foo` in your path and
8861 also an executable `foo` in your working directory, the one in the path
8862 would be used. Now the one in the working directory is used.
8864 In addition, when you do `--filter foo/bar.hs`, pandoc will now find a
8865 filter `$DATADIR/filters/foo/bar.hs` -- assuming there isn't a
8866 `foo/bar.hs` relative to the working directory.
8868 * Allow `file://` URIs as arguments (#3196). Also improved default reader
8869 format detection. Previously with a URI ending in .md or .markdown,
8870 pandoc would assume HTML input. Now it treats these as markdown.
8872 * Allow to overwrite top-level division type heuristics (#3258,
8873 Albert Krewinkel). Pandoc uses heuristics to determine the most
8874 reasonable top-level division type when emitting LaTeX or
8875 Docbook markup. It is now possible to overwrite this implicitly set
8876 top-level division via the `top-level-division` command line parameter.
8878 * Text.Pandoc.Options \[API changes\]:
8880 + Removed `writerStandalone` field in `WriterOptions`, made
8881 `writerTemplate` a `Maybe` value. Previously setting
8882 `writerStandalone = True` did nothing unless a template was provided
8883 in writerTemplate. Now a fragment will be generated if
8884 `writerTemplate` is `Nothing`; otherwise, the specified template
8885 will be used and standalone output generated.
8886 + `Division` has been renamed `TopLevelDivision` (#3197). The
8887 `Section`, `Chapter`, and `Part` constructors were renamed to
8888 `TopLevelSection`, `TopLevelChapter`, and
8889 `TopLevelPart`, respectively. An additional `TopLevelDefault`
8890 constructor was added, which is now also the new default value of
8891 the `writerTopLevelDivision` field in `WriterOptions`.
8893 * Improved error if they give wrong arg to `--top-level-division`.
8895 * Use new module from texmath to lookup MS font codepoints in Docx reader.
8896 Removed unexported module Text.Pandoc.Readers.Docx.Fonts. Its code now
8897 lives in texmath (0.9).
8899 * DocBook reader: Fixed xref lookup (#3243). It previously only worked
8900 when the qnames lacked the docbook namespace URI.
8902 * HTML reader:
8904 + Improved table parsing (#3027). We now check explicitly for non-1
8905 rowspan or colspan attributes, and fail when we encounter them.
8906 Previously we checked that each row had the same number of cells,
8907 but that could be true even with rowspans/colspans. And there are
8908 cases where it isn't true in tables that we can handle fine -- e.g.
8909 when a tr element is empty. So now we just pad rows with empty cells
8910 when needed.
8911 + Treat `<math>` as MathML by default unless something else is
8912 explicitly specified in xmlns. Provided it parses as MathML,
8913 of course. Also fixed default which should be to inline math if no
8914 display attribute is used.
8915 + Only treat "a" element as link if it has href (#3226). Otherwise
8916 treat as span.
8918 * Docx reader (Jesse Rosenthal):
8920 + Add a placeholder value for CHART. We wrap `[CHART]` in a
8921 `<span class="chart">`. Note that it maps to inlines because, in
8922 docx, anything in a drawing tag can be part of a larger paragraph.
8923 + Be more specific in parsing images We not only want `w:drawing`,
8924 because that could also include charts. Now we specify
8925 `w:drawing/pic:pic`. This shouldn't change behavior at all, but it's
8926 a first step toward allowing other sorts of drawing data as well.
8927 + Abstract out function to avoid code repetition.
8928 + Update tests for img title and alt (#3204).
8929 + Handle Alt text and titles in images. We use the "description" field
8930 as alt text and the "title" field as title. These can be accessed
8931 through the "Format Picture" dialog in Word.
8932 + Docx reader utils: handle empty namespace in `elemName`. Previously,
8933 if given an empty namespace `(elemName ns "" "foo")` `elemName`
8934 would output a QName with a `Just ""` namespace. This is never what
8935 we want. Now we output a `Nothing`. If someone *does* want a
8936 `Just ""` in the namespace, they can enter the QName
8937 value explicitly.
8939 * ODT reader/writer:
8941 + Inline code when text has a special style (Hubert Plociniczak). When
8942 a piece of text has a text `Source_Text` then we assume that this is
8943 a piece of the document that represents a code that needs to
8944 be inlined. Adapted the writer to also reflect that change.
8945 Previously it was just writing a 'preformatted' text using a
8946 non-distinguishable font style. Code blocks are still not recognized
8947 by the ODT reader. That's a separate issue.
8948 + Infer table's caption from the paragraph (#3224,
8949 Hubert Plociniczak). ODT's reader always put empty captions for the
8950 parsed tables. This commit
8952 1. checks paragraphs that follow the table definition
8953 2. treats specially a paragraph with a style named 'Table'
8954 3. does some postprocessing of the paragraphs that combines tables
8955 followed immediately by captions
8957 The ODT writer used the `TableCaption` style for the caption
8958 paragraph. This commit follows the OpenOffice approach which allows
8959 for appending captions to table but uses a built-in style named
8960 `Table` instead of `TableCaption`. Users of a custom `reference.odt`
8961 should change the style's name from `TableCaption` to `Table`.
8963 * ODT reader: Infer tables' header props from rows (#3199,
8964 Hubert Plociniczak). ODT reader simply provided an empty header list
8965 which meant that the contents of the whole table, even if not empty, was
8966 simply ignored. While we still do not infer headers we at least have to
8967 provide default properties of columns.
8969 * Markdown reader:
8971 + Allow reference link labels starting with `@...` if `citations`
8972 extension disabled (#3209). Example: in
8974 \[link text\]\[@a\]
8976 `link text` isn't hyperlinked because `[@a]` is parsed as
8977 a citation. Previously this happened whether or not the `citations`
8978 extension was enabled. Now it happens only if the `citations`
8979 extension is enabled.
8980 + Allow alignments to be specified in Markdown grid tables. For
8981 example,
8983 +-------+---------------+--------------------+
8984 | Right | Left | Centered |
8985 +=========:+:=================+:=============:+
8986 | Bananas | $1.34 | built-in wrapper |
8987 +-------+---------------+--------------------+
8989 + Allow Small Caps elements to be created using bracketed spans (as
8990 they already can be using HTML-syntax spans) (#3191, Kolen Cheung).
8992 * LaTeX reader:
8994 + Don't treat `\vspace` and `\hspace` as block commands (#3256).
8995 Fixed an error which came up, for example, with `\vspace` inside
8996 a caption. (Captions expect inlines.)
8997 + Improved table handling. We can now parse all of the tables emitted
8998 by pandoc in our tests. The only thing we don't get yet are
8999 alignments and column widths in more complex tables. See #2669.
9000 + Limited support for minipage.
9001 + Allow for `[]`s inside LaTeX optional args. Fixes cases like:
9002 + Handle BVerbatim from fancyvrb (#3203).
9003 + Handle hungarumlaut (#3201).
9004 + Allow beamer-style `<...>` options in raw LaTeX (also in Markdown)
9005 (#3184). This allows use of things like `\only<2,3>{my content}` in
9006 Markdown that is going to be converted to beamer.
9008 * Use pre-wrap for code in dzslides template (Nicolas Porcel). Otherwise
9009 overly long code will appear on every slide.
9011 * Org reader (Albert Krewinkel):
9013 + Respect column width settings (#3246). Table column properties can
9014 optionally specify a column's width with which it is displayed in
9015 the buffer. Some exporters, notably the ODT exporter in org-mode
9016 v9.0, use these values to calculate relative column widths. The org
9017 reader now implements the same behavior. Note that the org-mode
9018 LaTeX and HTML exporters in Emacs don't support this feature yet,
9019 which should be kept in mind by users who use the column
9020 widths parameters.
9021 + Allow HTML attribs on non-figure images (#3222). Images which are
9022 the only element in a paragraph can still be given HTML attributes,
9023 even if the image does not have a caption and is hence not a figure.
9024 The following will add set the `width` attribute of the image to
9025 `50%`:
9027 +ATTR\_HTML: :width 50%
9028 =======================
9030 \[\[file:image.jpg\]\]
9032 + Support `ATTR_HTML` for special blocks (#3182). Special
9033 blocks (i.e. blocks with unrecognized names) can be prefixed with an
9034 `ATTR_HTML` block attribute. The attributes defined in that
9035 meta-directive are added to the `Div` which is used to represent the
9036 special block.
9037 + Support the `todo` export option. The `todo` export option allows to
9038 toggle the inclusion of TODO keywords in the output. Setting this to
9039 `nil` causes TODO keywords to be dropped from headlines. The default
9040 is to include the keywords.
9041 + Add support for todo-markers. Headlines can have optional
9042 todo-markers which can be controlled via the `#+TODO`, `#+SEQ_TODO`,
9043 or `#+TYP_TODO` meta directive. Multiple such directives can be
9044 given, each adding a new set of recognized todo-markers. If no
9045 custom todo-markers are defined, the default `TODO` and `DONE`
9046 markers are used. Todo-markers are conceptually separate from
9047 headline text and are hence excluded when autogenerating
9048 headline IDs. The markers are rendered as spans and labelled with
9049 two classes: One class is the markers name, the other signals the
9050 todo-state of the marker (either `todo` or `done`).
9052 * LaTeX writer:
9054 + Use `\autocites*` when "suppress-author" citation used.
9055 + Ensure that simple tables have simple cells (#2666). If cells
9056 contain more than a single Plain or Para, then we need to set
9057 nonzero widths and put contents into minipages.
9058 + Remove invalid inlines in sections (#3218, Hubert Plociniczak).
9060 * Markdown writer:
9062 + Fix calculation of column widths for aligned multiline tables
9063 (#1911, Björn Peemöller). This also fixes excessive CPU and memory
9064 usage for tables when `--columns` is set in such a way that cells
9065 must be very tiny. Now cells are guaranteed to be big enough so that
9066 single words don't need to line break, even if this pushes the line
9067 length above the column width.
9068 + Use bracketed form for native spans when `bracketed_spans`
9069 enabled (#3229).
9070 + Fixed inconsistent spacing issue (#3232). Previously a tight bullet
9071 sublist got rendered with a blank line after, while a tight ordered
9072 sublist did not. Now we don't get the blank line in either case.
9073 + Fix escaping of spaces in super/subscript (#3225). Previously two
9074 backslashes were inserted, which gave a literal backslash.
9075 + Adjust widths in Markdown grid tables so that they match
9076 on round-trip.
9078 * Docx writer:
9080 + Give full detail when there are errors converting tex math.
9081 + Handle title text in images (Jesse Rosenthal). We already handled
9082 alt text. This just puts the image "title" into the docx
9083 "title" attr.
9084 + Fixed XML markup for empty cells (#3238). Previously the Compact
9085 style wasn't being applied properly to empty cells.
9087 * HTML writer:
9089 + Updated `renderHtml` import from blaze-html.
9091 * Text.Pandoc.Pretty:
9093 + Fixed some bugs that caused blank lines in tables (#3251). The bugs
9094 caused spurious blank lines in grid tables when we had things like
9095 `blankline $$ blankline`.
9096 + Add exported function `minOffet` \[API change\] (Björn Peemöller).
9097 + Added error message for illegal call to `block` (Björn Peemöller).
9099 * Text.Pandoc.Shared:
9101 + Put `warn` in MonadIO.
9102 + `fetchItem`: Better handling of protocol-relative URL (#2635). If
9103 URL starts with `//` and there is no "base URL" (as there would be
9104 if a URL were used on the command line), then default to http:.
9106 * Export Text.Pandoc.getDefaultExtensions \[API change\] (#3178).
9108 * In --version, trap error in `getAppUserDataDirectory` (#3241). This
9109 fixes a crash with `pandoc --version` on unusual systems with no real
9110 user (e.g. SQL Server 2016).
9112 * Added weigh-pandoc for memory usage diagnostics (#3169).
9114 * Use correct mime types for woff and woff2 (#3228).
9116 * Remove make\_travis\_yml.hs (#3235, Kolen Cheung).
9118 * changelog: Moved an item that was misplaced in the 1.17.2 section to the
9119 1.18 section where it belongs.
9121 * CONTRIBUTING.md: minor change in wording and punctuation (#3252,
9122 Kolen Cheung).
9124 * Further revisions to manual for `--version` changes (#3244).
9128## pandoc 1.18 (2016-10-26)
9130 * Added `--list-input-formats`, `--list-output-formats`,
9131 `--list-extensions`, `--list-highlight-languages`, and
9132 `--list-highlight-styles` (#3173). Removed list of highlighting
9133 languages from `--version` output. Removed list of input and output
9134 formats from default `--help` output.
9136 * Added `--reference-location=block|section|document` option
9137 (Jesse Rosenthal). This determines whether Markdown link references
9138 and footnotes are placed at the end of the document, the end of the
9139 section, or the end of the top-level block.
9141 * Added `--top-level-division=section|chapter|part` (Albert Krewinkel).
9142 This determines what a level-1 header corresponds to in LaTeX,
9143 ConTeXt, DocBook, and TEI output. The default is `section`.
9144 The `--chapters` option has been deprecated in favor of
9145 `--top-level-division=chapter`.
9147 * Added `LineBlock` constructor for `Block` (Albert Krewinkel). This
9148 is now used in parsing RST and Markdown line blocks, DocBook
9149 `linegroup`/`line` combinations, and Org-mode `VERSE` blocks.
9150 Previously `Para` blocks with hard linebreaks were used. `LineBlock`s
9151 are handled specially in the following ouput formats: AsciiDoc
9152 (as `[verse]` blocks), ConTeXt (`\startlines`/`\endlines`),
9153 HTML (`div` with a style), Markdown (line blocks if `line_blocks`
9154 is enabled), Org-mode (`VERSE` blocks), RST (line blocks). In
9155 other output formats, a paragraph with hard linebreaks is emitted.
9157 * Allow binary formats to be written to stdout (but not to tty) (#2677).
9158 Only works on posix, since we use the unix library to check whether
9159 output is to tty. On Windows, pandoc works as before and always requires
9160 an output file parameter for binary formats.
9162 * Changed JSON output format (Jesse Rosenthal). Previously we used
9163 generically generated JSON, but this was subject to change depending
9164 on the version of aeson pandoc was compiled with. To ensure stability,
9165 we switched to using manually written ToJSON and FromJSON
9166 instances, and encoding the API version. **Note:** pandoc filter
9167 libraries will need to be revised to handle the format change.
9168 Here is a summary of the essential changes:
9170 + The toplevel JSON format is now `{"pandoc-api-version" :
9171 [MAJ, MIN, REV], "meta" : META, "blocks": BLOCKS}`
9172 instead of `[{"unMeta": META}, [BLOCKS]]`.
9173 Decoding fails if the major and minor version numbers don't
9174 match.
9175 + Leaf nodes no longer have an empty array for their "c" value.
9176 Thus, for example, a `Space` is encoded as `{"t":"Space"}`
9177 rather than `{"t":"Space","c":[]}` as before.
9179 * Removed `tests/Tests/Arbitrary.hs` and added a `Text.Pandoc.Arbitrary`
9180 module to pandoc-types (Jesse Rosenthal). This makes it easier
9181 to use QuickCheck with pandoc types outside of pandoc itself.
9183 * Add `bracketed_spans` Markdown extension, enabled by default
9184 in pandoc `markdown`. This allows you to create a native span
9185 using this syntax: `[Here is my span]{#id .class key="val"}`.
9187 * Added `angle_brackets_escapable` Markdown extension (#2846).
9188 This is needed because github flavored Markdown has a slightly
9189 different set of escapable symbols than original Markdown;
9190 it includes angle brackets.
9192 * Export `Text.Pandoc.Error` in `Text.Pandoc` [API change].
9194 * Print highlighting-kate version in `--version`.
9196 * `Text.Pandoc.Options`:
9198 + `Extension` has new constructors `Ext_brackted_spans` and
9199 `Ext_angle_brackets_escapable` [API change].
9200 + Added `ReferenceLocation` type [API change] (Jesse Rosenthal).
9201 + Added `writerReferenceLocation` field to `WriterOptions` (Jesse
9202 Rosenthal).
9204 * `--filter`: we now check `$DATADIR/filters` for filters before
9205 looking in the path (#3127, Jesse Rosenthal, thanks to Jakob
9206 Voß for the idea). Filters placed in this directory need not
9207 be executable; if the extension is `.hs`, `.php`, `.pl`, `.js`,
9208 or `.rb`, pandoc will run the right interpreter.
9210 * For `--webtex`, replace deprecated Google Chart API by CodeCogs as
9211 default (Kolen Cheung).
9213 * Removed `raw_tex` extension from `markdown_mmd` defaults (Kolen Cheung).
9215 * Execute .js filters with node (Jakob Voß).
9217 * Textile reader:
9219 + Support `bc..` extended code blocks (#3037). Also, remove trailing
9220 newline in code blocks (consistently with Markdown reader).
9221 + Improve table parsing. We now handle cell and row attributes, mostly
9222 by skipping them. However, alignments are now handled properly.
9223 Since in pandoc alignment is per-column, not per-cell, we
9224 try to devine column alignments from cell alignments.
9225 Table captions are also now parsed, and textile indicators
9226 for thead and tfoot no longer cause parse failure. (However,
9227 a row designated as tfoot will just be a regular row in pandoc.)
9228 + Improve definition list parsing. We now allow multiple terms
9229 (which we concatenate with linebreaks). An exponential parsing
9230 bug (#3020) is also fixed.
9231 + Disallow empty URL in explicit link (#3036).
9233 * RST reader:
9235 + Use Div instead of BlockQuote for admonitions (#3031).
9236 The Div has class `admonition` and (if relevant) one of the
9237 following: `attention`, `caution`, `danger`, `error`, `hint`,
9238 `important`, `note`, `tip`, `warning`. **Note:** This will change
9239 the rendering of some RST documents! The word ("Warning", "Attention",
9240 etc.) is no longer added; that must be done with CSS or a filter.
9241 + A Div is now used for `sidebar` as well.
9242 + Skip whitespace before note (Jesse Rosenthal, #3163). RST requires a
9243 space before a footnote marker. We discard those spaces so that footnotes
9244 will be adjacent to the text that comes before it. This is in line with
9245 what rst2latex does.
9246 + Allow empty lines when parsing line blocks (Albert Krewinkel).
9248 * Markdown reader:
9250 + Allow empty lines when parsing line blocks (Albert Krewinkel).
9251 + Allow attributes on autolinks (#3183, Daniele D'Orazio).
9253 * LaTeX reader:
9255 + More robust parsing of unknown environments (#3026).
9256 We no longer fail on things like `^` inside options for tikz.
9257 + Be more forgiving of non-standard characters, e.g. `^` outside of math.
9258 Some custom environments give these a meaning, so we should try not to
9259 fall over when we encounter them.
9260 + Drop duplicate `*` in bibtexKeyChars (Albert Krewinkel)
9262 * MediaWiki reader:
9264 + Fix for unquoted attribute values in mediawiki tables (#3053).
9265 Previously an unquoted attribute value in a table row
9266 could cause parsing problems.
9267 + Improved treatment of verbatim constructions (#3055).
9268 Previously these yielded strings of alternating Code and Space
9269 elements; we now incorporate the spaces into the Code. Emphasis
9270 etc. is still possible inside these.
9271 + Properly interpret XML tags in pre environments (#3042). They are meant
9272 to be interpreted as literal text.
9274 * EPUB reader: don't add root path to data: URIs (#3150).
9275 Thanks to @lep for the bug report and patch.
9277 * Org reader (Albert Krewinkel):
9279 + Preserve indentation of verse lines (#3064). Leading spaces in verse
9280 lines are converted to non-breaking spaces, so indentation is preserved.
9281 + Ensure image sources are proper links. Image sources as those in plain
9282 images, image links, or figures, must be proper URIs or relative file
9283 paths to be recognized as images. This restriction is now enforced
9284 for all image sources. This also fixes the reader's usage of uncleaned
9285 image sources, leading to `file:` prefixes not being deleted from
9286 figure images. Thanks to @bsag for noticing this bug.
9287 + Trim verse lines properly (Albert Krewinkel).
9288 + Extract meta parsing code to module. Parsing of meta-data is well
9289 separable from other block parsing tasks. Moving into new module to
9290 get small files and clearly arranged code.
9291 + Read markup only for special meta keys. Most meta-keys should be read
9292 as normal string values, only a few are interpreted as marked-up text.
9293 + Allow multiple, comma-separated authors. Multiple authors can be
9294 specified in the `#+AUTHOR` meta line if they are given as a
9295 comma-separated list.
9296 + Give precedence to later meta lines. The last meta-line of any given
9297 type is the significant line. Previously the value of the first line
9298 was kept, even if more lines of the same type were encounterd.
9299 + Read LaTeX_header as header-includes. LaTeX-specific header commands
9300 can be defined in `#+LaTeX_header` lines. They are parsed as
9301 format-specific inlines to ensure that they will only show up in LaTeX
9302 output.
9303 + Set documentclass meta from LaTeX_class.
9304 + Set classoption meta from LaTeX_class_options.
9305 + Read HTML_head as header-includes. HTML-specific head content can be
9306 defined in `#+HTML_head` lines. They are parsed as format-specific
9307 inlines to ensure that they will only show up in HTML output.
9308 + Respect `author` export option. The `author` option controls whether
9309 the author should be included in the final markup. Setting
9310 `#+OPTIONS: author:nil` will drop the author from the final meta-data
9311 output.
9312 + Respect `email` export option. The `email` option controls whether the
9313 email meta-field should be included in the final markup. Setting
9314 `#+OPTIONS: email:nil` will drop the email field from the final
9315 meta-data output.
9316 + Respect `creator` export option. The `creator` option controls whether
9317 the creator meta-field should be included in the final markup. Setting
9318 `#+OPTIONS: creator:nil` will drop the creator field from the final
9319 meta-data output. Org-mode recognizes the special value `comment` for
9320 this field, causing the creator to be included in a comment. This is
9321 difficult to translate to Pandoc internals and is hence interpreted the
9322 same as other truish values (i.e. the meta field is kept if it's
9323 present).
9324 + Respect unnumbered header property (#3095). Sections the `unnumbered`
9325 property should, as the name implies, be excluded from the automatic
9326 numbering of section provided by some output formats. The Pandoc
9327 convention for this is to add an "unnumbered" class to the header. The
9328 reader treats properties as key-value pairs per default, so a special
9329 case is added to translate the above property to a class instead.
9330 + Allow figure with empty caption (Albert Krewinkel, #3161).
9331 A `#+CAPTION` attribute before an image is enough to turn an image into
9332 a figure. This wasn't the case because the `parseFromString` function,
9333 which processes the caption value, would fail on empty values. Adding
9334 a newline character to the caption value fixes this.
9336 * Docx reader:
9338 + Use XML convenience functions (Jesse Rosenthal).
9339 The functions `isElem` and `elemName` (defined in Docx/Util.hs) make
9340 the code a lot cleaner than the original XML.Light functions, but they
9341 had been used inconsistently. This puts them in wherever applicable.
9342 + Handle anchor spans with content in headers. Previously, we would only
9343 be able to figure out internal links to a header in a docx if the
9344 anchor span was empty. We change that to read the inlines out of the
9345 first anchor span in a header.
9346 + Let headers use exisiting id. Previously we always generated an id for
9347 headers (since they wouldn't bring one from Docx). Now we let it use an
9348 existing one if possible. This should allow us to recurs through anchor
9349 spans.
9350 + Use all anchor spans for header ids. Previously we only used the first
9351 anchor span to affect header ids. This allows us to use all the anchor
9352 spans in a header, whether they're nested or not (#3088).
9353 + Test for nested anchor spans in header. This ensures that anchor spans
9354 in header with content (or with other anchor spans inside) will resolve
9355 to links to a header id properly.
9357 * ODT reader (Hubert Plociniczak)
9359 + Include list's starting value. Previously the starting value of
9360 the lists' items has been hardcoded to 1. In reality ODT's list
9361 style definition can provide a new starting value in one of its
9362 attributes.
9363 + Infer caption from the text following the image.
9364 Frame can contain other frames with the text boxes.
9365 + Add `fig:` to title for Image with a caption (as expected
9366 by pandoc's writers).
9367 + Basic support for images in ODT documents.
9368 + Don't duplicate text for anchors (#3143). When creating an anchor
9369 element we were adding its representation as well as the original
9370 content, leading to text duplication.
9372 * DocBook writer:
9374 + Include an anchor element when a div or span has an id (#3102).
9375 Note that DocBook does not have a class attribute, but at least this
9376 provides an anchor for internal links.
9378 * LaTeX writer:
9380 + Don't use * for unnumbered paragraph, subparagraph. The starred
9381 variants don't exist. This helps with part of #3058...it gets rid of
9382 the spurious `*`s. But we still have numbers on the 4th and 5th level
9383 headers.
9384 + Properly escape backticks in verbatim (#3121, Jesse Rosenthal).
9385 Otherwise they can cause unintended ligatures like `` ?` ``.
9386 + Handle NARRAOW NO-BREAK SPACE into LaTeX (Vaclav Zeman) as `\,`.
9387 + Don't include `[htbp]` placement for figures (#3103, Václav Haisman).
9388 This allows figure placement defaults to be changed by the user
9389 in the template.
9391 * TEI writer: remove heuristic to detect book template (Albert Krewinkel).
9392 TEI doesn't have `<book>` elements but only generic `<divN>` division
9393 elements. Checking the template for a trailing `</book>` is nonsensical.
9395 * MediaWiki writer: transform filename with underscores in images (#3052).
9396 `foo bar.jpg` becomes `foo_bar.jpg`. This was already done
9397 for internal links, but it also needs to happen for images.
9399 * ICML writer: replace partial function (!!) in table handling (#3175,
9400 Mauro Bieg).
9402 * Man writer: allow section numbers that are not a single digit (#3089).
9404 * AsciiDoc writer: avoid unnecessary use of "unconstrained" emphasis
9405 (#3068). In AsciiDoc, you must use a special form of emphasis
9406 (double `__`) for intraword emphasis. Pandoc was previously using
9407 this more than necessary.
9409 * EPUB writer: use stringify instead of plain writer for metadata
9410 (#3066). This means that underscores won't be used for emphasis,
9411 or CAPS for bold. The metadata fields will just have unadorned
9412 text.
9414 * Docx Writer:
9416 + Implement user-defined styles (Jesse Rosenthal). Divs and Spans
9417 with a `custom-style` key in the attributes will apply the corresponding
9418 key to the contained blocks or inlines.
9419 + Add ReaderT env to the docx writer (Jesse Rosenthal).
9420 + Clean up and streamline RTL behavior (Jesse Rosenthal, #3140).
9421 You can set `dir: rtl` in YAML metadata, or use `-M dir=rtl`
9422 on the command line. For finer-grained control, you can set
9423 the `dir` attribute in Div or Span elements.
9425 * Org writer (Albert Krewinkel):
9427 + Remove blank line after figure caption. Org-mode only treats an image
9428 as a figure if it is directly preceded by a caption.
9429 + Ensure blank line after figure. An Org-mode figure should be surrounded
9430 by blank lines. The figure would be recognized regardless, but images
9431 in the following line would unintentionally be treated as figures as
9432 well.
9433 + Ensure link targets are paths or URLs. Org-mode treats links as
9434 document internal searches unless the link target looks like a URL or
9435 file path, either relative or absolute. This change ensures that this
9436 is always the case.
9437 + Translate language identifiers. Pandoc and Org-mode use different
9438 programming language identifiers. An additional translation between
9439 those identifiers is added to avoid unexpected behavior. This fixes a
9440 problem where language specific source code would sometimes be output
9441 as example code.
9442 + Drop space before footnote markers (Albert Krewinkel, #3162).
9443 The writer no longer adds an extra space before footnote markers.
9445 * Markdown writer:
9447 + Don't emit HTML for tables unless `raw_html` extension is set (#3154).
9448 Emit `[TABLE]` if no suitable table formats are enabled and raw HTML
9449 is disabled.
9450 + Check for the `raw_html` extension before emitting a raw HTML block.
9451 + Abstract out note/ref function (Jesse Rosenthal).
9452 + Add ReaderT monad for environment variables (Jesse Rosenthal).
9454 * HTML, EPUB, slidy, revealjs templates: Use `<p>` instead of `<h1>` for
9455 subtitle, author, date (#3119). Note that, as a result of this change,
9456 authors may need to update CSS.
9458 * revealjs template: Added `notes-server` option
9459 (jgm/pandoc-templates#212, Yoan Blanc).
9461 * Beamer template:
9463 + Restore whitespace between paragraphs. This was
9464 a regression in the last release (jgm/pandoc-templates#207).
9465 + Added `themeoptions` variable (Carsten Gips).
9466 + Added `beamerarticle` variable. This causes the `beamerarticle`
9467 package to be loaded in beamer, to produce an article from beamer
9468 slides. (Carsten Gips)
9469 + Added support for `fontfamilies` structured variable
9470 (Artem Klevtsov).
9471 + Added hypersetup options (Jake Zimmerman).
9473 * LaTeX template:
9475 + Added dummy definition for `\institute`.
9476 This isn't a standard command, and we want to avoid a crash when
9477 `institute` is used with the default template.
9478 + Define default figure placement (Václav Haisman), since pandoc
9479 no longer includes `[htbp]` for figures. Users with custom templates
9480 will want to add this. See #3103.
9481 + Use footnote package to fix notes in tables (jgm/pandoc-templates#208,
9482 Václav Haisman).
9484 * Moved template compiling/rendering code to a separate library.
9485 `doctemplates`. This allows the pandoc templating system to be
9486 used independently.
9488 * Text.Pandoc.Error: Fix out of index error in `handleError`
9489 (Matthew Pickering). The fix is to not try to show the exact line when
9490 it would cause an out-of-bounds error as a result of included files.
9492 * Text.Pandoc.Shared: Add `linesToBlock` function (Albert Krewinkel).
9494 * Text.Pandoc.Parsing.emailAddress: tighten up parsing of email
9495 addresses. Technically `**@user` is a valid email address, but if we
9496 allow things like this, we get bad results in markdown flavors
9497 that autolink raw email addresses (see #2940). So we exclude a few
9498 valid email addresses in order to avoid these more common bad cases.
9500 * Text.Pandoc.PDF: Don't crash with nonexistent image (#3100). Instead,
9501 emit the alt text, emphasized. This accords with what the ODT writer
9502 currently does. The user will still get a warning about a nonexistent
9503 image.
9505 * Fix example in API documentation (#3176, Thomas Weißschuh).
9507 * Tell where to get tarball in INSTALL (#3062).
9509 * Rename README to MANUAL.txt and add GitHub-friendly README.md
9510 (Albert Krewinkel, Kolen Cheung).
9512 * Replace COPYING with Markdown version COPYING.md from GNU (Kolen Cheung).
9514 * MANUAL.txt:
9516 + Put note on structured vars in separate paragraph (#2148, Albert
9517 Krewinkel). Make it clearer that structured author variables require a
9518 custom template
9519 + Note that `--katex` works best with `html5` (#3077).
9520 + Fix the LaTeX and EPUB links in manual (Morton Fox).
9521 + Document `biblio-title` variable.
9523 * Improve spacing of footnotes in `--help` output (Waldir Pimenta).
9525 * Update KaTeX to v0.6.0 (Kolen Cheung).
9527 * Allow latest dependencies.
9529 * Use texmath 0.8.6.6 (#3040).
9531 * Allow http-client 0.4.30, which is the version in stackage lts.
9532 Previously we required 0.5.
9533 Remove CPP conditionals for earlier versions.
9535 * Remove support for GHC < 7.8 (Jesse Rosenthal).
9537 + Remove Compat.Monoid.
9538 + Remove an inline monad compatibility macro.
9539 + Remove Text.Pandoc.Compat.Except.
9540 + Remove directory compat.
9541 + Change constraint on mtl.
9542 + Remove unnecessary CPP condition in UTF8.
9543 + Bump base lower bound to 4.7.
9544 + Remove 7.6 build from .travis.yaml.
9545 + Bump supported ghc version in CONTRIBUTING.md.
9546 + Add note about GHC version support to INSTALL.
9547 + Remove GHC 7.6 from list of tested versions (Albert Krewinkel).
9548 + Remove TagSoup compat.
9549 + Add EOL note to time compat module. Because time 1.4 is a boot library
9550 for GHC 7.8, we will support the compatibility module as long as we
9551 support 7.8. But we should be clear about when we will no longer need
9552 it.
9553 + Remove blaze-html CPP conditional.
9554 + Remove unnecessary CPP in custom Prelude.
9556## pandoc 1.17.2 (2016-07-17)
9558 * Added Zim Wiki writer, template and tests. `zimwiki` is now
9559 a valid output format. (Alex Ivkin)
9561 * Changed email-obfuscation default to no obfuscation (#2988).
9562 + `writerEmailObfuscation` in `defaultWriterOptions` is now
9563 `NoObfuscation`.
9564 + the default for the command-line `--email-obfuscation` option is
9565 now `none`.
9567 * Docbook writer: Declare xlink namespace in Docbook5 output (Ivo Clarysse).
9569 * Org writer:
9571 + Support arbitrary raw inlines (Albert Krewinkel).
9572 Org mode allows arbitrary raw inlines ("export snippets" in Emacs
9573 parlance) to be included as `@@format:raw foreign format text@@`.
9574 + Improve Div handling (Albert Krewinkel). Div blocks handling is
9575 changed to make the output look more like idiomatic org mode:
9576 - Div-wrapped content is output as-is if the div's attribute is the
9577 null attribute.
9578 - Div containers with an id but neither classes nor key-value pairs
9579 are unwrapped and the id is added as an anchor.
9580 - Divs with classes associated with greater block elements are
9581 wrapped in a `#+BEGIN`...`#+END` block.
9582 - The old behavior for Divs with more complex attributes is kept.
9584 * HTML writer: Better support for raw LaTeX environments (#2758).
9585 Previously we just passed all raw TeX through when MathJax
9586 was used for HTML math. This passed through too much.
9587 With this patch, only raw LaTeX environments that MathJax
9588 can handle get passed through.
9589 This patch also causes raw LaTeX environments to be treated
9590 as math, when possible, with MathML and WebTeX output.
9592 * Markdown writer: use raw HTML for simple, pipe tables with linebreaks
9593 (#2993). Markdown line breaks involve a newline, and simple and pipe
9594 tables can't contain one.
9596 * Make --webtex work with the Markdown writer (#1177).
9597 This is a convenient option for people using
9598 websites whose Markdown flavors don't provide for math.
9600 * Docx writer:
9602 + Set paragraph to FirstPara after display math (Jesse Rosenthal).
9603 We treat display math like block quotes, and apply FirstParagraph style
9604 to paragraphs that follow them. These can be styled as the user
9605 wishes. (But, when the user is using indentation, this allows for
9606 paragraphs to continue after display math without indentation.)
9607 + Use actual creation time as doc prop (Jesse Rosenthal).
9608 Previously, we had used the user-supplied date, if available, for Word's
9609 document creation metadata. This could lead to weird results, as in
9610 cases where the user post-dates a document (so the modification might be
9611 prior to the creation). Here we use the actual computer time to set the
9612 document creation.
9614 * LaTeX writer:
9616 + Don't URI-escape image source (#2825). Usually this is a local file,
9617 and replacing spaces with `%20` ruins things.
9618 + Allow 'standout' as a beamer frame option (#3007).
9619 `## Slide title {.standout}`.
9621 * RST reader: Fixed links with no explicit link text. The link
9622 `` `<foo>`_ `` should have `foo` as both its link text and its URL.
9623 See RST spec at <http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#embedded-uris-and-aliases>
9624 Closes Debian #828167 -- reported by Christian Heller.
9626 * Textile reader:
9628 + Fixed attributes (#2984). Attributes can't be followed by
9629 a space. So, `_(class)emph_` but `_(noclass) emph_`.
9630 + Fixed exponential parsing bug (#3020).
9631 + Fix overly aggressive interpretation as images (#2998).
9632 Spaces are not allowed in the image URL in textile.
9634 * LaTeX reader:
9636 + Fix `\cite` so it is a NormalCitation not AuthorInText.
9637 + Strip off double quotes around image source if present (#2825).
9638 Avoids interpreting these as part of the literal filename.
9640 * Org reader:
9642 + Add semicolon to list of special chars (Albert Krewinkel)
9643 Semicolons are used as special characters in citations syntax. This
9644 ensures the correct parsing of Pandoc-style citations: `[prefix; @key;
9645 suffix]`. Previously, parsing would have failed unless there was a space
9646 or other special character as the last <prefix> character.
9647 + Add support for "Berkeley-style" cites (Albert Krewinkel, #1978).
9648 A specification for an official Org-mode citation syntax was drafted by
9649 Richard Lawrence and enhanced with the help of others on the orgmode
9650 mailing list. Basic support for this citation style is added to the
9651 reader.
9652 + Support arbitrary raw inlines (Albert Krewinkel).
9653 Org mode allows arbitrary raw inlines ("export snippets" in Emacs
9654 parlance) to be included as `@@format:raw foreign format text@@`.
9655 + Remove partial functions (Albert Krewinkel, #2991).
9656 Partial functions like `head` lead to avoidable errors and should be
9657 avoided. They are replaced with total functions.
9658 + Support figure labels (Albert Krewinkel, #2496, #2999).
9659 Figure labels given as `#+LABEL: thelabel` are used as the ID of the
9660 respective image. This allows e.g. the LaTeX to add proper `\label`
9661 markup.
9662 + Improve tag and properties type safety (Albert Krewinkel).
9663 Specific newtype definitions are used to replace stringly typing of tags
9664 and properties. Type safety is increased while readability is improved.
9665 + Parse as headlines, convert to blocks (Albert Krewinkel).
9666 Emacs org-mode is based on outline-mode, which treats documents as trees
9667 with headlines are nodes. The reader is refactored to parse into a
9668 similar tree structure. This simplifies transformations acting on
9669 document (sub-)trees.
9670 * Refactor comment tree handling (Albert Krewinkel).
9671 Comment trees were handled after parsing, as pattern matching on lists
9672 is easier than matching on sequences. The new method of reading
9673 documents as trees allows for more elegant subtree removal.
9674 * Support archived trees export options (Albert Krewinkel).
9675 Handling of archived trees can be modified using the `arch` option.
9676 Archived trees are either dropped, exported completely, or collapsed to
9677 include just the header when the `arch` option is nil, non-nil, or
9678 `headline`, respectively.
9679 * Put export setting parser into module (Albert Krewinkel).
9680 Export option parsing is distinct enough from general block parsing to
9681 justify putting it into a separate module.
9682 * Support headline levels export setting (Albert Krewinkel).
9683 The depths of headlines can be modified using the `H` option. Deeper
9684 headlines will be converted to lists.
9685 * Replace ugly code with view pattern (Albert Krewinkel).
9686 Some less-than-smart code required a pragma switching of overlapping
9687 pattern warnings in order to compile seamlessly. Using view patterns
9688 makes the code easier to read and also doesn't require overlapping
9689 pattern checks to be disabled.
9690 * Fix parsing of verbatim inlines (Albert Krewinkel, #3016).
9691 Org rules for allowed characters before or after markup chars were not
9692 checked for verbatim text. This resultet in wrong parsing outcomes of
9693 if the verbatim text contained e.g. space enclosed markup characters as
9694 part of the text (`=is_substr = True=`). Forcing the parser to update
9695 the positions of allowed/forbidden markup border characters fixes this.
9697 * LaTeX template: fix for obscure hyperref/xelatex issue.
9698 Here's a minimal case:
9700 \documentclass[]{article}
9701 \usepackage{hyperref}
9702 \begin{document}
9703 \section{\%á}
9704 \end{document}
9706 Without this change, this fails on the second invocation of xelatex.
9707 This affects inputs this like `# %á` with pdf output via xelatex.
9709 * trypandoc: call results 'html' instead of 'result'.
9710 This is for better compatibility with babelmark2.
9712 * Document MultiMarkdown as input/output format (Albert Krewinkel, #2973).
9713 MultiMarkdown was only mentioned as a supported Markdown dialect but not
9714 as a possible input or output format. A brief mention is added
9715 everywhere the other supported markdown dialects are mentioned.
9717 * Document Org mode as a format containing raw HTML (Albert Krewinkel)
9718 Raw HTML is kept when the output format is Emacs Org mode.
9720 * Implement `RawInline` and `RawBlock` in sample lua custom writer (#2985).
9722 * Text.Pandoc.Shared:
9724 + Introduce blocksToInlines function (Jesse Rosenthal).
9725 This is a lossy function for converting `[Block] -> [Inline]`. Its main
9726 use, at the moment, is for docx comments, which can contain arbitrary
9727 blocks (except for footnotes), but which will be converted to spans.
9728 This is, at the moment, pretty useless for everything but the basic
9729 `Para` and `Plain` comments. It can be improved, but the docx reader
9730 should probably emit a warning if the comment contains more than this.
9731 + Add BlockQuote to blocksToInlines (Jesse Rosenthal).
9732 + Add further formats for `normalizeDate` (Jesse Rosenthal).
9733 We want to avoid illegal dates -- in particular years with greater than
9734 four digits. We attempt to parse series of digits first as `%Y%m%d`, then
9735 `%Y%m`, and finally `%Y`.
9736 + `normalizeDate` should reject illegal years (Jesse Rosenthal).
9737 We only allow years between 1601 and 9999, inclusive. The ISO 8601
9738 actually says that years are supposed to start with 1583, but MS Word
9739 only allows 1601-9999. This should stop corrupted word files if the date
9740 is out of that range, or is parsed incorrectly.
9741 + Improve year sanity check in normalizeDate (Jesse Rosenthal).
9742 Previously we parsed a list of dates, took the first one, and then
9743 tested its year range. That meant that if the first one failed, we
9744 returned nothing, regardless of what the others did. Now we test for
9745 sanity before running `msum` over the list of Maybe values. Anything
9746 failing the test will be Nothing, so will not be a candidate.
9748 * Docx reader:
9750 + Add simple comment functionality. (Jesse Rosenthal).
9751 This adds simple track-changes comment parsing to the docx reader. It is
9752 turned on with `--track-changes=all`. All comments are converted to
9753 inlines, which can list some information. In the future a warning will be
9754 added for comments with formatting that seems like it will be excessively
9755 denatured. Note that comments can extend across blocks. For that reason
9756 there are two spans: `comment-start` and `comment-end`. `comment-start`
9757 will contain the comment. `comment-end` will always be empty. The two
9758 will be associated by a numeric id.
9759 + Enable warnings in top-level reader (Jesse Rosenthal).
9760 Previously we had only allowed for warnings in the parser. Now we allow
9761 for them in the `Docx.hs` as well. The warnings are simply concatenated.
9762 + Add warning for advanced comment formatting. (Jesse Rosenthal).
9763 We can't guarantee we'll convert every comment correctly, though we'll
9764 do the best we can. This warns if the comment includes something other
9765 than Para or Plain.
9766 + Add tests for warnings. (Jesse Rosenthal).
9767 + Add tests for comments (Jesse Rosenthal).
9768 We test for comments, using all track-changes options. Note that we
9769 should only output comments if `--track-changes=all`. We also test for
9770 emitting warnings if there is complicated formatting.
9772 * README: update to include track-changes comments. (Jesse Rosenthal)
9774 * Improved Windows installer - don't ignore properties set on command-line.
9775 See #2708. Needs testing to see if this resolves the issue.
9776 Thanks to @nkalvi.
9778 * Process markdown extensions on command line in L->R order (#2995).
9779 Previously they were processed, very unintuitively, in R->L
9780 order, so that `markdown-tex_math_dollars+tex_math_dollars`
9781 had `tex_math_dollars` disabled.
9783 * Added `secnumdepth` variable to LaTeX template (#2920).
9785 * Include table of contents in README.html in Windows package.
9787 * Writers: treat SoftBreak as space for stripping (Jesse Rosenthal)
9788 In Writers.Shared, we strip leading and trailing spaces for display
9789 math. Since SoftBreak's are treated as spaces, we should strip those
9790 too.
9792 * beamer, latex templates: pass biblatexoptions directly in package load.
9793 This allows runtime optinos to be used. Fixes jgm/pandoc-citeproc#201
9795 * CPP workaround for deprecation of `parseUrl` in http-client.
9797 * Removed some redundant class constraints.
9799 * make_oxs_package.sh - use OSX env variable.
9801 * Added `winpkg` target to Makefile. This downloads the windows package
9802 from appveyor and signs it using the key.
9804 * Document Org mode as a format containing raw TeX (Albert Krewinkel).
9805 Raw TeX is kept verbatim when the output format is Emacs Org mode.
9807 * Support math with haddock-library >= 1.4.
9809 * Removed `-rtsopts` from library stanza. It has no effect, and Hackage
9810 wouldn't accept the package.
9812 * Update library dependency versions.
9814## pandoc 1.17.1 (2016-06-04)
9816 * New output format: `docbook5` (Ivo Clarysse).
9818 * `Text.Pandoc.Options`: Add `writerDocBook5` to `WriterOptions`
9819 (API change).
9821 * Org writer:
9823 + Add :PROPERTIES: drawer support (Albert Krewinkel, #1962).
9824 This allows header attributes to be added to org documents in the form
9825 of `:PROPERTIES:` drawers. All available attributes are stored as
9826 key/value pairs. This reflects the way the org reader handles
9827 `:PROPERTIES:` blocks.
9828 + Add drawer capability (Carlos Sosa). For the implementation of the
9829 Drawer element in the Org Writer, we make use of a generic Block
9830 container with attributes. The presence of a `drawer` class defines
9831 that the `Div` constructor is a drawer. The first class defines the
9832 drawer name to use. The key-value list in the attributes defines
9833 the keys to add inside the Drawer. Lastly, the list of Block elements
9834 contains miscellaneous blocks elements to add inside of the Drawer.
9835 + Use `CUSTOM_ID` in properties (Albert Krewinkel). The `ID` property is
9836 reserved for internal use by Org-mode and should not be used.
9837 The `CUSTOM_ID` property is to be used instead, it is converted to the
9838 `ID` property for certain export format.
9840 * LaTeX writer:
9842 + Ignore `--incremental` unless output format is beamer (#2843).
9843 + Fix polyglossia to babel env mapping (Mauro Bieg, #2728).
9844 Allow for optional argument in square brackets.
9845 + Recognize `la-x-classic` as Classical Latin (Andrew Dunning).
9846 This allows one to access the hyphenation patterns in CTAN's
9847 hyph-utf8.
9848 + Add missing languages from hyph-utf8 (Andrew Dunning).
9849 + Improve use of `\strut` with `\minipage` inside tables
9850 (Jose Luis Duran). This improves spacing in multiline
9851 tables.
9852 + Use `{}` around options containing special chars (#2892).
9853 + Avoid lazy `foldl`.
9854 + Don't escape underscore in labels (#2921). Previously they were
9855 escaped as `ux5f`.
9856 + brazilian -> brazil for polyglossia (#2953).
9858 * HTML writer: Ensure mathjax link is added when math appears in footnote
9859 (#2881). Previously if a document only had math in a footnote, the
9860 MathJax link would not be added.
9862 * EPUB writer: set `navpage` variable on nav page.
9863 This allows templates to treat it differently.
9865 * DocBook writer:
9867 + Use docbook5 if `writerDocbook5` is set (Ivo Clarysse).
9868 + Properly handle `ulink`/`link` (Ivo Clarysse).
9870 * EPUB reader:
9872 + Unescape URIs in spine (#2924).
9873 + EPUB reader: normalise link id (Mauro Bieg).
9875 * Docx Reader:
9877 + Parse `moveTo` and `moveFrom` (Jesse Rosenthal).
9878 `moveTo` and `moveFrom` are track-changes tags that are used when a
9879 block of text is moved in the document. We now recognize these tags and
9880 treat them the same as `insert` and `delete`, respectively. So,
9881 `--track-changes=accept` will show the moved version, while
9882 `--track-changes=reject` will show the original version.
9883 + Tests for track-changes moving (Jesse Rosenthal).
9885 * ODT, EPUB, Docx readers: throw `PandocError` on unzip failure
9886 (Jesse Rosenthal) Previously, `readDocx`, `readEPUB`, and `readOdt`
9887 would error out if zip-archive failed. We change the archive extraction
9888 step from `toArchive` to `toArchiveOrFail`, which returns an Either value.
9890 * Markdown, HTML readers: be more forgiving about unescaped `&` in
9891 HTML (#2410). We are now more forgiving about parsing invalid HTML with
9892 unescaped `&` as raw HTML. (Previously any unescaped `&`
9893 would cause pandoc not to recognize the string as raw HTML.)
9895 * Markdown reader:
9897 + Fix pandoc title blocks with lines ending in 2 spaces (#2799).
9898 + Added `-s` to markdown-reader-more test.
9900 * HTML reader: fixed bug in `pClose`. This caused exponential parsing
9901 behavior in documnets with unclosed tags in `dl`, `dd`, `dt`.
9903 * MediaWiki reader: Allow spaces before `!` in MediaWiki table header
9904 (roblabla).
9906 * RST reader: Support `:class:` option for code block in RST reader
9907 (Sidharth Kapur).
9909 * Org reader (all Albert Krewinkel, except where noted otherwise):
9911 + Stop padding short table rows.
9912 Emacs Org-mode doesn't add any padding to table rows. The first
9913 row (header or first body row) is used to determine the column count,
9914 no other magic is performed.
9915 + Refactor rows-to-table conversion. This refactors
9916 the codes conversing a list table lines to an org table ADT.
9917 The old code was simplified and is now slightly less ugly.
9918 + Fix handling of empty table cells, rows (Albert Krewinkel, #2616).
9919 This fixes Org mode parsing of some corner cases regarding empty cells
9920 and rows. Empty cells weren't parsed correctly, e.g. `|||` should be
9921 two empty cells, but would be parsed as a single cell containing a pipe
9922 character. Empty rows where parsed as alignment rows and dropped from
9923 the output.
9924 + Fix spacing after LaTeX-style symbols.
9925 The org-reader was droping space after unescaped LaTeX-style symbol
9926 commands: `\ForAll \Auml` resulted in `∀Ä` but should give `∀ Ä`
9927 instead. This seems to be because the LaTeX-reader treats the
9928 command-terminating space as part of the command. Dropping the trailing
9929 space from the symbol-command fixes this issue.
9930 + Print empty table rows. Empty table rows should not
9931 be dropped from the output, so row-height is always set to be at least 1.
9932 + Move parser state into separate module.
9933 The org reader code has become large and confusing. Extracting smaller
9934 parts into submodules should help to clean things up.
9935 + Add support for sub/superscript export options.
9936 Org-mode allows to specify export settings via `#+OPTIONS` lines.
9937 Disabling simple sub- and superscripts is one of these export options,
9938 this options is now supported.
9939 + Support special strings export option Parsing of special strings
9940 (like `...` as ellipsis or `--` as en dash) can be toggled using the `-`
9941 option.
9942 + Support emphasized text export option. Parsing of emphasized text can
9943 be toggled using the `*` option. This influences parsing of text marked
9944 as emphasized, strong, strikeout, and underline. Parsing of inline math,
9945 code, and verbatim text is not affected by this option.
9946 + Support smart quotes export option. Reading of smart quotes can be
9947 toggled using the `'` option.
9948 + Parse but ignore export options. All known export options are parsed
9949 but ignored.
9950 + Refactor block attribute handling. A parser state attribute was used
9951 to keep track of block attributes defined in meta-lines. Global state
9952 is undesirable, so block attributes are no longer saved as part of the
9953 parser state. Old functions and the respective part of the parser state
9954 are removed.
9955 + Use custom `anyLine`. Additional state changes need to be made after
9956 a newline is parsed, otherwise markup may not be recognized correctly.
9957 This fixes a bug where markup after certain block-types would not be
9958 recognized.
9959 + Add support for `ATTR_HTML` attributes (#1906).
9960 Arbitrary key-value pairs can be added to some block types using a
9961 `#+ATTR_HTML` line before the block. Emacs Org-mode only includes these
9962 when exporting to HTML, but since we cannot make this distinction here,
9963 the attributes are always added. The functionality is now supported
9964 for figures.
9965 + Add `:PROPERTIES:` drawer support (#1877).
9966 Headers can have optional `:PROPERTIES:` drawers associated with them.
9967 These drawers contain key/value pairs like the header's `id`. The
9968 reader adds all listed pairs to the header's attributes; `id` and
9969 `class` attributes are handled specially to match the way `Attr` are
9970 defined. This also changes behavior of how drawers of unknown type
9971 are handled. Instead of including all unknown drawers, those are not
9972 read/exported, thereby matching current Emacs behavior.
9973 + Use `CUSTOM_ID` in properties. See above on Org writer changes.
9974 + Respect drawer export setting. The `d` export option can be used
9975 to control which drawers are exported and which are discarded.
9976 Basic support for this option is added here.
9977 + Ignore leading space in org code blocks (Emanuel Evans, #2862).
9978 Also fix up tab handling for leading whitespace in code blocks.
9979 + Support new syntax for export blocks. Org-mode version 9
9980 uses a new syntax for export blocks. Instead of `#+BEGIN_<FORMAT>`,
9981 where `<FORMAT>` is the format of the block's content, the new
9982 format uses `#+BEGIN_export <FORMAT>` instead. Both types are
9983 supported.
9984 + Refactor `BEGIN...END` block parsing.
9985 + Fix handling of whitespace in blocks, allowing content to be indented
9986 less then the block header.
9987 + Support org-ref style citations. The *org-ref* package is an
9988 org-mode extension commonly used to manage citations in org
9989 documents. Basic support for the `cite:citeKey` and
9990 `[[cite:citeKey][prefix text::suffix text]]` syntax is added.
9991 + Split code into separate modules, making for cleaner code and
9992 better decoupling.
9994 * Added `docbook5` template.
9996 * `--mathjax` improvements:
9998 + Use new CommonHTML output for MathJax (updated default MathJax URL,
9999 #2858).
10000 + Change default mathjax setup to use `TeX-AMS_CHTML` configuration.
10001 This is designed for cases where the input is always TeX and maximal
10002 conformity with TeX is desired. It seems to be smaller and load faster
10003 than what we used before. See #2858.
10004 + Load the full MathJax config to maximize loading speed (KolenCheung).
10006 * Bumped upper version bounds to allow use of latest packages
10007 and compilation with ghc 8.
10009 * Require texmath 0.8.6.2. Closes several texmath-related bugs (#2775,
10010 #2310, #2310, #2824). This fixes behavior of roots, e.g.
10011 `\sqrt[3]{x}`, and issues with sub/superscript positioning
10012 and matrix column alignment in docx.
10014 * README:
10016 + Clarified documentation of `implicit_header_references` (#2904).
10017 + Improved documentation of `--columns` option.
10019 * Added appveyor setup, with artefacts (Jan Schulz).
10021 * stack.yaml versions: Use proper flags used for texmath, pandoc-citeproc.
10023 * LaTeX template: support for custom font families (vladipus).
10024 Needed for correct polyglossia operation with Cyrillic fonts and perhaps
10025 can find some other usages. Example usage in YAML metadata:
10027 fontfamilies:
10028 - name: \cyrillicfont
10029 font: Liberation Serif
10030 - name: \cyrillicfonttt
10031 options: Scale=MatchLowercase
10032 font: Liberation
10034 * Create unsigned msi as build artifact in appveyor build.
10036 * On travis, test with ghc 8.0.1; drop testing for ghc 7.4.1.
10040## pandoc 1.17.0.3 (2016-03-24)
10042 * LaTeX writer: Fixed position of label in figures (#2813).
10043 Previously the label wasn't in the right place, and `\ref`
10044 wouldn't work properly.
10045 * Added .tei test files to pandoc.cabal so they'll be included
10046 in tarball (#2811).
10047 * Updated copyright dates.
10049## pandoc 1.17.0.2 (2016-03-23)
10051 * Fixed serious regression in `htmlInBalanced`, which caused
10052 newlines to be omitted in some raw HTML blocks in Markdown
10053 (#2804).
10055## pandoc 1.17.0.1 (2016-03-21)
10057 * File scope is no longer used when there are no input files (i.e.,
10058 when input comes from stdin). Previously file scope was triggered
10059 when the `json` reader was specified and input came from `stdin`,
10060 and this caused no output to be produced. (Fix due to Jesse Rosenthal;
10061 thanks to Fedor Sheremetyev for calling the bug to our attention.)
10062 * Improved documentation of templates (#2797).
10064## pandoc 1.17 (2016-03-20)
10066 * Added `--file-scope` option (Jesse Rosenthal).
10067 By default pandoc operates on multiple files by first concatenating
10068 them (around extra line breaks) and then processing the joined file. So
10069 it only parses a multi-file document at the document scope. This has the
10070 benefit that footnotes and links can be in different files, but for
10071 some purposes it is useful to parse the individual files first
10072 and then combine their outputs (e.g. when the files use footnotes
10073 or links with the same labels). The `--file-scope` option causes
10074 pandoc to parse the files first, and then combine the parsed output,
10075 instead of combining before parsing. `--file-scope` is selected
10076 automatically for binary input files (which cannot be concatenated)
10077 and for pandoc json.
10079 * Add TEI Writer (Chris Forster) and `tei` output format.
10081 * Added a general `ByteStringReader` with warnings, used by the docx
10082 reader (API change, Jesse Rosenthal).
10084 * Add `readDocxWithWarnings` (API change, Jesse Rosenthal).
10086 * Changed type of `Shared.uniqueIdent` argument from
10087 `[String]` to `Set String`. This avoids performance problems in documents
10088 with many identically named headers (API change, #2671).
10090 * Removed `tex_math_single_backslash` from `markdown_github` options
10091 (#2707).
10093 * Make language extensions as well as full language names
10094 trigger syntax highlighting. For example, `py` will now work as
10095 well as `python` (jgm/highlighting-kate#83).
10097 * Added `institute` variable to latex, beamer templates (Fraser
10098 Tweedale, Josef Svenningsson).
10100 * Docx reader (Jesse Rosenthal):
10102 + Handle alternate content. Some word functions (especially graphics)
10103 give various choices for content so there can be backwards compatibility.
10104 + Don't turn numbered headers into lists.
10105 + Docx Reader: Add state to the parser, for warnings
10106 + Update feature checklist in source code.
10107 + Get rid of `Modifiable` typeclass.
10108 + Add tests for adjacent hyperlinks.
10109 + Add a "Link" modifier to `Reducible`. We want to make sure that
10110 links have their spaces removed, and are appropriately smushed
10111 together (#2689).
10113 * HTML reader:
10115 + Fixed behavior of base tag (#2777).
10116 If the base path does not end with slash, the last component
10117 will be replaced. E.g. base = `http://example.com/foo`
10118 combines with `bar.html` to give `http://example.com/bar.html`.
10119 If the href begins with a slash, the whole path of the base
10120 is replaced. E.g. base = `http://example.com/foo/` combines
10121 with `/bar.html` to give `http://example.com/bar.html`.
10122 + Rewrote `htmlInBalanced`. This version avoids an exponential
10123 performance problem with `<script>` tags, and it should be faster
10124 in general (#2730).
10125 + Properly handle an empty cell in a simple table (#2718).
10126 + Handle multiple `<meta>` tags with same name. Put them in a list
10127 in the metadata so they are all preserved, rather than (as before)
10128 throwing out all but one..
10130 * Markdown reader:
10132 + Improved pipe table parsing (#2765).
10133 + Allow `+` separators in pipe table cells. We already allowed
10134 them in the header, but not in the body rows, for some reason.
10135 This gives compatibility with org-mode tables.
10136 + Don't cross line boundary parsing pipe table row.
10137 Previously an Emph element could be parsed across the newline
10138 at the end of the pipe table row.
10139 + Use `htmlInBalanced` for `rawVerbatimBlock`, for better
10140 performance (#2730).
10141 + Fixed bug with smart quotes around tex math.
10143 * LaTeX reader:
10145 + Handle interior `$` characters in math (#2743). For example,
10146 `$$\hbox{$i$}$$`.
10147 + `inlineCommand` now gobbles an empty `{}` after any command (#2687).
10148 This gives better results when people write e.g. `\TeX{}` in Markdown.
10149 + Properly handle LaTeX "math" environment as inline math (#2171).
10151 * Textile reader: Support `>`, `<`, `=`, `<>` text alignment attributes.
10152 Closes #2674.
10154 * Org reader (Albert Krewinkel):
10156 + Prefix even empty figure names with "fig:" (#2643). The
10157 convention used by pandoc for figures is to mark them by prefixing
10158 the name with `fig:`. The org reader failed to do this if a figure
10159 had no name.
10160 + Refactor link-target processing (#2684).
10162 * ConTeXt writer: Fix whitespace at line beginning in line blocks (#2744).
10163 Thanks to @c-foster.
10165 * HTML writer: Don't include alignment attribute for default table columns.
10166 Previously these were given "left" alignment. Better to leave off
10167 alignment attributes altogether (#2694).
10169 * Markdown writer: Use hyphens for YAML metadata block bottom line, for
10170 better compatibility with other Markdown flavors (Henrik Tramberend).
10172 * LaTeX writer:
10174 + Use image identifier to create a label and hypertarget for
10175 figures (Mauro Bieg).
10176 + Avoid double toprule in headerless table with caption (#2742).
10177 + Clean up options parser (Jesse Rosenthal).
10178 + Treat `memoir` template with `article` option as article, instead
10179 of treating all `memoir` templates as books.
10180 + Allow more flexible table alignment (Henrik Tramberend, #2665).
10181 New default is not to include `[c]` option (which is the default
10182 anyway if no positioning is specified). Now LaTeX emplates can
10183 control the overall table alignment in a document by setting the
10184 longtable length variables `LTleft` and `LTright`. For example,
10185 `\setlength\LTleft\parindent\setlength\LTright\fill`
10186 will create left-aligned tables that respect paragraph indentation.
10188 * Docx writer: Handle image alt text (#2754, Mauro Bieg).
10190 * Org writer - pass through RawInline with format "org".
10192 * DokuWiki writer: use `$$` for display math.
10194 * Custom writer: Pass attributes parameter to CaptionedImage (#2697).
10196 * Make protocol-relative URIs work again (#2737).
10198 * make_osx_package.sh: Use env variable for developer id certs.
10200 * Raise `tagsoup` lower bound to 0.13.7 to fix entity-related
10201 problems (#2734).
10203 * Allow `zip-archive` 0.3.
10205 * Allow `aeson` 0.11.
10207## pandoc 1.16.0.2 (2016-01-12)
10209 * Depend on deepseq rather than deepseq-generics (fpco/stackage#1096).
10211 * Fixed regression in latex smart quote parsing (#2645).
10212 In cases where a match was not found for a quote, everything
10213 from the open quote to the end of the paragraph was being dropped.
10215## pandoc 1.16.0.1 (2016-01-10)
10217 * Fixed regression with `--latex-engine` (#2618). In 1.16
10218 `--latex-engine` raises an error if a full path is given.
10220 * Org reader: Fix function dropping subtrees tagged `:noexport`
10221 (Albert Krewinkel, #2628):
10223 * Markdown reader: renormalize table column widths if they exceed 100%
10224 (#2626).
10226 * Textile reader: don't allow block HTML tags in inline contexts.
10227 The reader previously did allow this, following redcloth,
10228 which happily parses
10230 Html blocks can be <div>inlined</div> as well.
10234 <p>Html blocks can be <div>inlined</div> as well.</p>
10236 This is invalid HTML. The above sample now produces;
10238 <p>Html blocks can be</p>
10239 <div>
10240 <p>inlined</p>
10241 </div>
10242 <p>as well.</p>
10244 * Improved default template lookup for custom lua scripts (#2625).
10245 Previously, if you tried to do `pandoc -s -t /path/to/lua/script.lua`,
10246 pandoc would look for the template in
10247 `~/.pandoc/templates/default./path/to/lua/script.lua`.
10248 With this change it will look in the more reasonable
10249 `~/.pandoc/templates/default.script.lua`. This makes it possible to
10250 store default templates for custom writers.
10252 * RST, Markdown writers: Fixed rendering of grid tables with blank rows
10253 (#2615).
10255 * LaTeX writer: restore old treatment of Span (#2624). A Span is
10256 now rendered with surrounding `{}`, as it was before 1.16.
10258 * Entity handling fixes: improved handling of entities like
10259 `&lang;` that require a trailing semicolon. Allow uppercase
10260 `x` in numerical hexidecimal character references, working
10261 around a tagsoup bug.
10263 * `stack.yaml` - use lts-4.0, but with older aeson to avoid excessive
10264 memory use on compile. With aeson 0.10 we were getting an out of
10265 memory error on a 2GB Ubuntu 64-bit VM.
10267 * Improved deb package creation script. Made `DPKGVER` work.
10268 Renamed `COMMIT` to `TREE`. You should now be able to do
10269 `TREE=1.16.0.1 DPKGVER=2 make deb`.
10272## pandoc 1.16 (2016-01-02)
10274 * Added `Attr` field to `Link` and `Image` (Mauro Bieg, #261, API change).
10276 + Added syntax for link and image attributes to pandoc's Markdown.
10277 + Updated readers and writers to use link and image attributes
10278 when appropriate.
10279 + Support image attributes in Docx, Textile, RST readers.
10281 * Renamed link attribute extensions. The old `link_attributes` is
10282 now `mmd_link_attributes`, and `link_attributes` now enables the
10283 new pandoc-style link and image attributes (API change).
10284 Note: this change could break some existing workflows.
10286 * Implemented `SoftBreak` and new `--wrap` option (#1701, API change).
10287 Added threefold wrapping option.
10289 + Command line option: deprecated `--no-wrap`, added
10290 `--wrap=[auto|none|preserve]`
10291 + Added `WrapOption`, exported from `Text.Pandoc.Options`
10292 + Changed type of `writerWrapText` in `WriterOptions` from
10293 `Bool` to `WrapOption`.
10294 + Modified `Text.Pandoc.Shared` functions to allow `SoftBreak`.
10295 + Supported `SoftBreak` in readers and writers.
10297 * Text.Pandoc.Options: Added `writerDpi` to `WriterOptions` (API
10298 change, Mauro Bieg).
10300 * Added `--dpi` command-line option (Mauro Bieg).
10302 * Rationalized behavior of `--no-tex-ligatures` and `--smart` (#2541).
10303 This change makes `--no-tex-ligatures` affect the LaTeX reader
10304 as well as the LaTeX and ConTeXt writers. If it is used,
10305 the LaTeX reader will parse characters `` ` ``, `'`, and `-`
10306 literally, rather than parsing ligatures for quotation marks
10307 and dashes. And the LaTeX writer will print unicode quotation
10308 mark and dash characters literally, rather than converting
10309 them to the standard ASCII ligatures. Note that `--smart` has
10310 no effect on the LaTeX reader. `--smart` is still the default
10311 for all input formats when LaTeX or ConTeXt is the output format,
10312 *unless* `--no-tex-ligatures` is used.
10314 Some examples to illustrate the logic:
10316 ```
10317 % echo "'hi'" | pandoc -t latex
10318 `hi'
10319 % echo "'hi'" | pandoc -t latex --no-tex-ligatures
10320 'hi'
10321 % echo "'hi'" | pandoc -t latex --no-tex-ligatures --smart
10322 ‘hi’
10323 % echo "'hi'" | pandoc -f latex --no-tex-ligatures
10324 <p>'hi'</p>
10325 % echo "'hi'" | pandoc -f latex
10326 <p>’hi’</p>
10327 ```
10329 * Removed deprecated options `--offline` and `--html5`.
10331 * Fixed language code for Czech (`cs` not `cz`) (#2597).
10333 * Implemented `east_asian_line_breaks` extension (#2586).
10334 In `Text.Pandoc.Options`, added `Ext_east_asian_line_breaks` constructor
10335 to `Extension` (API change). This extension is like
10336 `ignore_line_breaks`, but smarter -- it only ignores line breaks
10337 between two East Asian wide characters. This makes it better suited
10338 for writing with a mix of East Asian and non-East Asian scripts.
10340 * Added support for PDF creation via `wkhtmltopdf`.
10341 To use this: `pandoc -t html5 -o result.pdf` (and add `--mathjax`
10342 if you have math.) Margins can be set using the variables
10343 `margin-top`, `margin-bottom`, `margin-left`, `margin-right`.
10344 Other styling can be done through CSS.
10346 * Fixed cite key parsing regression (jgm/pandoc-citeproc#201).
10347 We were capturing final colons as in `[@foo: bar]`; the citation id
10348 was being parsed as `@foo:`.
10350 * ICML writer:
10352 + Fixed image syntax for local files (#2589).
10353 + Changed type of `writeICML` (Mauro Bieg).
10354 API change: It is now `WriterOptions -> Pandoc -> IO String`.
10355 Also handle new image attributes.
10356 + Intersperse line breaks instead of appending them to
10357 every `ParagraphStyleRange` (Mauro Bieg, #2501).
10358 + Add `Cite` style to citations (Mauro Bieg).
10359 + Added figure handling (#2590, Mauro Bieg).
10360 + Better handling of math. Instead of just printing the raw tex,
10361 we now try to fake it with unicode characters.
10363 * HTML writer: Include `example` class for example lists (#2524).
10365 * ODT/OpenDocument writer: improved image attributes (Mauro Bieg).
10367 + Support for percentage widths/heights
10368 + Use `Attr` instead of title to get dimensions from ODT walker
10369 to `writeOpenDocument`.
10371 * AsciiDoc writer:
10373 + Support anchors in spans and divs with id elements
10374 (jgm/pandoc-citeproc#143).
10375 + Fixed code blocks (#1861).
10377 * Haddock writer: omit formatting inside links, which isn't supported
10378 by Haddock (#2515).
10380 * MediaWiki writer: Fixed spacing issues in table cells.
10382 + Start cell on new line unless it's a single Para or Plain
10383 (#2606).
10384 + For single Para or Plain, insert a space after the `|` to
10385 avoid problems when the text begins with a character like
10386 `-` (#2604).
10388 * Beamer writer: mark frame as fragile when it contains verbatim (#1613).
10390 * LaTeX writer:
10392 + Add support for GAP highlighting using listings (Raniere Silva).
10393 + Consider `header-includes` content as well as templates
10394 when determining whether to use csquotes (Andreas Lööw).
10395 + Create defaults for geometry using `margin-left` etc.
10396 If `geometry` has no value, but `margin-left`, `margin-right`,
10397 `margin-top`, and/or `-margin-bottom` are given, a default value
10398 for `geometry` is created from these. Note that these variables
10399 already affect PDF production via HTML5 with `wkhtmltopdf`.
10401 * ConTeXt writer: set default layout based on `margin-left`, etc.
10402 This sets up `\setuplayout` based on the variables `margin-left`,
10403 `margin-right`, `margin-bottom`, and `margin-top`, if no layout
10404 is given.
10406 * Docx writer: better handling of PDF images. Previously we tried
10407 to get the image size from the image even if an explicit size was
10408 specified. Since we still can't get image size for PDFs, this made
10409 it impossible to use PDF images in docx. Now we don't try to get
10410 the image size when a size is already explicitly specified.
10412 * Markdown writer: use raw HTML for link/image attributes when
10413 the `link_attributes` extension is unset and `raw_html` is set (#2554).
10415 * MediaWiki reader: interpret markup inside `<tt>`, `<code>` (#2607).
10417 * LaTeX reader:
10419 + Improved smart quote parsing (#2555). This fixes redering of
10420 unmatched quotes.
10421 + Use curly quotes for unmatched ` (#2555).
10422 + Allow blank space between braced arguments of commands (#2592).
10424 * Markdown reader:
10426 + Improved pipe table relative widths. Previously pipe table
10427 columns got relative widths (based on the header underscore lines)
10428 when the source of one of the rows was greater in width than the
10429 column width. This gave bad results in some cases where much of
10430 the width of the row was due to nonprinting material (e.g. link
10431 URLs). Now pandoc only looks at printable width (the width of a
10432 plain string version of the source), which should give better results.
10433 Thanks to John Muccigrosso for bringing up the issue.
10434 + Fixed parsing bug with macros. Previously macro definitions in
10435 indented code blocks were being parsed as macro definitions, not code.
10437 * Textile reader: skip over attribute in image source (#2515).
10438 We don't have a place yet for styles or sizes on images, but
10439 we can skip the attributes rather than incorrectly taking them
10440 to be part of the filename.
10442 * Docx reader: Handle dummy list items (Jesse Rosenthal).
10443 These come up when people create a list item and then delete the
10444 bullet. It doesn't refer to any real list item, and we used to ignore
10445 it.
10447 * CommonMark reader/writer rewritten to use latest `cmark`.
10449 * Fixed Emoji character definitions (#2523). There were many bugs in the
10450 definitions.
10452 * `Text.Pandoc.CSS`:
10454 + Added `pickStylesToKVs` function to extract multiple properties at
10455 once (API change, Mauro Bieg).
10456 + Parse CSS that doesn't contain the optional semicolon (Mauro Bieg).
10458 * `trypandoc`: sort drop-down lists.
10460 * Beamer template:
10462 + Made `\euro` conditional on presence of character.
10463 for xelatex and lualatex, as it is for pdflatex (Andrew Dunning).
10464 + Moved `header-includes` before setting of title (Thomas Hodgson),
10465 to match the LaTeX template (jgm/pandoc-templates#168).
10466 + Added `section-titles` variable (defaults to true)
10467 to enable/suppress section title pages in beamer
10468 slide shows (Thomas Hodgson).
10469 + Moved beamer themes after fonts, so that themes can
10470 change fonts. (Previously the fonts set were being
10471 clobbered by lmodern.sty.) (Thomas Hodgson).
10473 * Beamer/LaTeX template changes (Thomas Hodgson):
10474 + Added `thanks` variable
10475 + Use `parskip.sty` when `indent` isn't set (fall back to using
10476 `setlength` as before if `parskip.sty` isn't available).
10477 + Use `biblio-style` with biblatex.
10478 + Added `biblatexoptions` variable.
10480 * LaTeX template changes:
10482 + Added `paper` after `$papersize$` variable in latex template.
10483 Thus you can say `papersize: a4` and the latex will contain
10484 `a4paper`. This change may break some existing workflows; if
10485 you currently specify `a4paper`, you'll get `a4paperpaper` which
10486 is meaningless. However, the change seems worth it, as it will
10487 make the `papersize` variable work uniformly across ConTeXt, LaTeX,
10488 and html->pdf via wkhtmltopdf.
10489 + Only pass options to color package if `colorlinks` is set
10490 (Andrew Dunning).
10491 + Make definition of `\euro` conditional in xelatex/lualatex,
10492 as it is already for pdflatex (Andrew Dunning).
10493 + Removed setting of `subject` in PDF metadata.
10494 This used to be set to the subtitle, but really the subtitle
10495 need not give the subject. Also, `subtitle` can contain formatting,
10496 so we'd need, at least, a plain text version for this.
10497 + Moved `header-includes` before setting of `\title`, `\author`,
10498 etc. This allows these macros to be redefined.
10499 + Use `\subtitle` command for `subtitle`, instead of tacking it
10500 on to the title as before. We give a no-op fallback definition if it
10501 is not defined. This change should produce much better results
10502 in classes that support `\subtitle`. With the default article
10503 class, which does not define `\subtitle`, subtitles will no
10504 longer be printed unless the user defines `\subtitle` and
10505 redefines `\maketitle`.
10506 + Moved redefinitions of `\paragraph` and `\subparagraph` to
10507 before header-includes.
10509 * Context template:
10511 + Use `simplefonts` for font loading (Paolo Rodríguez). This is
10512 needed for things to work on ConTeXt stable from TeXLive 2015.
10513 + Revert use of `\setuphead` in title block (Andrew Dunning,
10514 Rik Kabel).
10516 * Update LaTeX/ConTeXt link colour usage (Andrew Dunning).
10518 * Fixed man template so disabling hyphenation actually works.
10519 The command needs to come after .TH.
10521 * Added 'navigation' variable to beamer template (#2543).
10522 Valid values are `empty` (the default), `horizontal`, `vertical`,
10523 and `frame`. Note that this changes the default behavior from
10524 `horizontal` to `empty`. Closes #2543.
10526 * Added `toc` to HTML slide format templates (Andrew Dunning),
10527 so that `--toc` creates a contents slide.
10529 * Added `stack.full.yaml` to build `pandoc-citeproc` as well.
10531 * Allow pipe tables with no body rows (#2556).
10532 Previously this raised a runtime error.
10534 * Shared: Improved `fetchItem` so that `C:/Blah/Blah.jpg` isn't treated
10535 as URL. The Haskell URI parsing routines will accept "C:" as a
10536 scheme, so we rule that out manually. This helps with
10537 `--self-contained` and absolute Windows paths.
10539 * Define a `meta-json` variable for all writers (#2019). This contains
10540 a JSON version of all the metadata, in the format selected for the
10541 writer. So, for example, to get just the YAML metadata, you can run
10542 pandoc with the following custom template: `$meta-json$`. The intent
10543 is to make it easier for static site generators and other tools to get
10544 at the metadata.
10546 * Document limitations of --self-contained (#2553).
10548 * Improved Citations section of README (#2551). Added information
10549 about `link-citations` and a link to the pandoc-citeproc man page.
10551 * `ImageSize`: use `safeRead` instead of `readMaybe`, which isn't
10552 in base < 4.6.
10554 * Allow .adoc file extension for AsciiDoc (Andrew Dunning).
10556 * Improved implicit pandoc-citeproc inclusion.
10557 The filter pandoc-citeproc is automatically used when
10558 `--bibliography` is specified on the command line, unless
10559 `--natbib` or `--biblatex` is used. However, previously this
10560 only worked if `--bibliography` was spelled out in full, and not
10561 if `--biblio` was used.
10563 * reveal.js: Interpret pauses correctly for all headers (#2530).
10564 Previously, when using headers below the slide level, pauses are left
10565 uninterpreted into pauses. In my opinion, unexpected behavior but
10566 intentional looking at the code.
10568 * Remove redundant `center` variable for reveal.js (Andrew Dunning).
10570 * Parsing: Add `extractIdClass`, modified type of `KeyTable` (Mauro
10571 Bieg, API change).
10573 * ImageSize: Added functions for converting between image dimensions
10574 (Mauro Bieg).
10576 * Use lts-3.18 in stack.yaml. This avoids Windows build
10577 issues with the HTTP library.
10579 * Bump version bounds for dependencies.
10581## pandoc 1.15.2.1 (2015-11-16)
10583 * Added two missing test files, and `stack.yaml`, to
10584 `extra-source-files` so they're included in the source tarball.
10586 * reveal.js template: Fixed parallaxBackground options.
10587 `parallaxBackgroundHorizontal` and `parallaxBackgroundVertical`
10588 need integer values, not strings. (Vaughn Iverson)
10590## pandoc 1.15.2 (2015-11-15)
10592 * `pandoc my.md -t context -o my.pdf` will now create a PDF using
10593 ConTeXt rather than LaTeX (#2463).
10595 * Fixed omitted `url(...)` in CSS data-uri with `--self-contained` (#2489).
10597 * Added `emoji` Markdown extension, enabled by default in `markdown_github`
10598 (#2523). Added `Ext_emoji` to `Extension` in `Text.Pandoc.Options`
10599 (API change).
10601 * `Text.Pandoc.Readers.HTML.parseTags`: Fixed over-eager raw HTML inline
10602 parsing (#2469). Tightened up the inline HTML parser so it disallows
10603 TagWarnings.
10605 * Derive `Generic` instances for the types in `Text.Pandoc.Options`.
10607 * Org reader:
10609 + Fix paragraph/list interaction (Albert Krewinkel, #2464).
10610 Paragraphs can be followed by lists, even if there is no blank line
10611 between the two blocks. However, this should only be true if the
10612 paragraph is not within a list, were the preceding block should be
10613 parsed as a plain instead of paragraph (to allow for compact lists).
10614 Thanks to @rgaiacs for bringing this up.
10615 + Allow toggling header args (Albert Krewinkel, #2269).
10616 Org-mode allows to skip the argument of a code block header argument if
10617 it's toggling a value. Argument-less headers are now recognized,
10618 avoiding weird parsing errors.
10619 + Fix markup parsing in headers (Albert Krewinkel, #2504).
10620 Markup as the very first item in a header wasn't recognized. This was
10621 caused by an incorrect parser state: positions at which inline markup
10622 can start need to be marked explicitly by changing the parser state.
10623 This wasn't done for headers. The proper function to update the state
10624 is now called at the beginning of the header parser, fixing this issue.
10625 + Fix emphasis rules for smart parsing (Albert Krewinkel, #2513).
10626 Smart quotes, ellipses, and dashes should behave like normal quotes,
10627 single dashes, and dots with respect to text markup parsing.
10628 + Require whitespace around definition list markers (#2518).
10629 This rule was not checked before, resulting in bugs with footnotes
10630 and some link types.
10632 * Markdown reader:
10634 + Pipe tables with long lines now get relative cell widths (#2471).
10635 If a pipe table contains a line longer than the column width (as set by
10636 `--columns` or 80 by default), relative widths are computed based on the
10637 widths of the separator lines relative to the column width. This should
10638 solve persistent problems with long pipe tables in LaTeX/PDF output, and
10639 give more flexibility for determining relative column widths in other
10640 formats, too. For narrower pipe tables, column widths of 0 are used,
10641 telling pandoc not to specify widths explicitly in output formats that
10642 permit this.
10643 + Improved parser for `mmd_title_block`. We now allow blank metadata
10644 fields. These were explicitly disallowed before.
10645 + Citation keys can now contain `://`, so URLs and DOIs can be used
10646 as citation keys (jgm/pandoc-citeproc#166).
10648 * Beamer template: fix incompatibility of section slides with natbib.
10649 Natbib (and presumably biblatex) bibliography commands create
10650 their own section. Since these are in frame environments,
10651 we have an incompatibility with the `\AtBeginSection` macro
10652 which creates a special frame when a new section occurs.
10653 (We can't have a frame inside another frame.) This change disables
10654 `\AtBeginSection` inside bibliography slides. Thinks to Yihui Xie for
10655 bringing the problem to my attention. This supersedes #145. See
10656 discussion there.
10658 * Textile reader: don't do smart punctuation unless explicitly asked
10659 (#2480). Note that although smart punctuation is part of the textile
10660 spec, it's not always wanted when converting from textile
10661 to, say, Markdown. So it seems better to make this an option.
10663 * LaTeX reader: Handle `comment` environment (Arata Mizuki).
10664 The `comment` environment is handled in a similar way to the
10665 `verbatim` environment, except that its content is discarded.
10667 * Docx reader: Follow relationships correctly in foot/endnotes (#2258,
10668 Jesse Rosenthal). This fixes a problem with links in notes.
10670 * LaTeX and ConTeXt writers: support `lang` attribute on divs and spans
10671 (mb21). For LaTeX, also collect `lang` and `dir` attributes on spans and
10672 divs to set the `lang`, `otherlangs` and `dir` variables if they aren’t set
10673 already. See #895.
10675 * LaTeX writer:
10677 + Use proper command for `\textarabic` (mb21).
10678 + Added `de-CH-1901`, fixed `el-polyton` in `toPloyglossia` (Nick Bart).
10679 + Use `\hypertarget` and `\hyperlink` for links. This works correctly
10680 to link to Div or Span elements. We now don't bother defining `\label`
10681 for Div or Span elements. Closes jgm/pandoc-citeproc#174.
10682 + Avoid footnotes in list of figures (#1506).
10683 + Properly handle footnotes in captions (#1506).
10684 + Add `\protect` to `\hyperlink` (#2490). Thanks to Hadrien Mary.
10685 + Set `colorlinks` if `linkcolor`, `urlcolor`, `citecolor`, or
10686 `toccolor` is set (#2508).
10688 * Textile writer: support start number in ordered lists (#2465).
10690 * OpenDocument writer: Allow customization of opendocument
10691 automatic styles. Automatic styles can now be inserted in the
10692 template, which now provides the enclosing `<office:automatic-styles>`
10693 tags (#2520).
10695 * Docx writer: insert space between footnote reference and note (#2527).
10696 This matches Word's default behavior.
10698 * EPUB writer: don't download linked media when `data-external` attribute
10699 set (#2473). By default pandoc downloads all linked media and includes it
10700 in the EPUB container. This can be disabled by setting `data-external` on
10701 the tags linking to media that should not be downloaded. Example:
10703 <audio controls="1">
10704 <source src="http://www.sixbarsjail.it/tmp/bach_toccata.mp3"
10705 type="audio/mpeg"></source>
10706 </audio>
10708 * HTML writer: use width on whole table if col widths sum to < 100%.
10709 Otherwise some browsers display the table with the columns
10710 separated far apart.
10712 * AsciiDoc template: Fix `author` and `date`; add `keywords`,
10713 `abstract` (Andrew Dunning).
10715 * HTML-based templates (Andrew Dunning):
10717 + Use en dash instead of hyphen between title prefix and title.
10718 + Add `keywords` to metadata.
10719 + Add `lang`, `dir`, `quotes` where missing.
10720 + Always make author and date display conditional.
10721 + Updated dzslides template from source.
10723 * Man template: make "generated by" comment conditional.
10725 * LaTeX, Beamer templates:
10727 + Add `babel-otherlangs` for language divs/spans; `babel-newcommands`,
10728 filled by commands that make babel understand the polyglossia-style
10729 language directives (mb21, #137).
10730 + Improved formatting of conditionals; `$for$` is always provided to allow
10731 multiple options (Andrew Dunning, #141).
10732 + Use `Ligatures=TeX` rather than `Mapping=tex-text` with `fontspec`
10733 to improve support for LuaTeX (Andrew Dunning, #135).
10734 + Revise `hyperref` usage (Andrew Dunning, #139, #141):
10735 - use same options for all LaTeX engines;
10736 - add `subtitle` and `keywords` to PDF metadata;
10737 - do not override `hyperref` link coloring without user input, effectively making
10738 the `hidelinks` option the default (removed as a separate variable);
10739 - link colors can be enabled (using a slightly darker version of the old
10740 defaults) using a new `colorlinks` variable, automatically used by
10741 the LaTeX writer when custom colors are specified;
10742 - `pdfborder={0 0 0}` is automatically set by `hyperref` with
10743 `colorlinks`, and is only applied if `colorlinks` is disabled.
10745 * ConTeXt template (Andrew Dunning):
10747 + New variables for controlling styles: `linkstyle`, `linkcolor`,
10748 `linkcontrastcolor`, `layout`, `pagenumbering`, `whitespace`, `indenting`,
10749 `interlinespace`, `headertext`, `footertext`, `mainfont`, `sansfont`,
10750 `monofont`, `mathfont`, `fontsize`.
10751 + Default template no longer supports MkII.
10752 + Improve writing of title block (suppressing numbering of first page).
10753 + Add `title` `subtitle`, `author`, `date`, `keywords` to PDF metadata.
10754 + Support `subtitle`, `abstract`.
10755 + Support list of figures (`lof`), list of tables (`lot`).
10756 + Disable link styling by default.
10757 + Define styles for all section types.
10758 + Enable microtype.
10759 + Improved formatting of conditionals.
10761 * Beamer template: added code to prevent slide breaks inside paragraphs
10762 (#2422, thanks to Nick Bart). This will matter, in practice, only when
10763 `allowframebreaks` is used. It is especially helpful for bibliography
10764 slides.
10766 * OpenDocument template: Add `<office:automatic-styles>` tag around
10767 automatic styles. The writer now longer provides this (see #2520).
10769 * Restored Text.Pandoc.Compat.Monoid.
10771 * Do not export (<>) from custom Prelude. The Prelude now matches
10772 base 4.8 Prelude's API.
10774 * Don't use custom prelude with ghc 7.10. Use the custom prelude
10775 only for earlier versions. This change makes `stack ghci` and
10776 `cabal repl` work (#2503), at least with ghc 7.10.
10778 * Changed § to % in operators from Odt.Arrows.Utils (#2457).
10779 This prevents problems building haddocks with "C" locale.
10781 * Change default for old-locale flag to False.
10783 * Use stack in deb, osx, and Windows package generators.
10785 * Added Vagrantfile for building deb in vm.
10786 This should help in automating binary package creation. 'make package'
10787 will make the package. 'make package COMMIT=blah' will make the package
10788 from commit blah.
10790 * README:
10792 + Consistent capitalization for pandoc and Markdown.
10793 + Fixed `auto_identifiers` examples (Benoit Schweblin).
10794 + Improved documentation of template variables (Andrew Dunning).
10796## pandoc 1.15.1 (2015-10-15)
10798 * `pandocVersion` is now defined in `Text.Pandoc.Shared`
10799 and reexported from `Text.Pandoc` (Alex Vong). This allows
10800 writers to access it. (Alex Vong) (API change)
10802 * For `markdown_mmd`, add: `implicit_figures`, `superscripts`,
10803 `subscripts` (#2401).
10805 * Added `odt` as input format (MarLinn). Added new module
10806 `Text.Pandoc.Reader.ODT` (API change). Fully implemented features:
10807 Paragraphs, Headers, Basic styling, Unordered lists, Ordered lists,
10808 External Links, Internal Links, Footnotes, Endnotes, Blockquotes.
10809 Partly implemented features: Citations, Tables.
10811 * Markdown Reader:
10813 + Add basic tests for each header style (Ophir Lifshitz).
10814 + Add implicit header ref tests for headers with spaces (Ophir Lifshitz).
10815 + Skip spaces in headers (Ophir Lifshitz).
10816 + Handle 'id' and 'class' in parsing key/value attributes (#2396).
10817 `# Header {id="myid" class="foo bar"}`
10818 is now equivalent to `# Header {#myid .foo .bar}`.
10819 + Use '=' instead of '#' for atx-style headers in markdown+lhs.
10820 (Kristof Bastiaensen)
10821 + Pipe tables: allow indented columns. Previously the left-hand column
10822 could not start with 4 or more spaces indent. This was inconvenient
10823 for right-aligned left columns. Note that the first (header column)
10824 must still have 3 or fewer spaces indentation, or the table will be
10825 treated as an indented code block.
10826 + Fix regression: allow HTML comments containing `--`.
10827 Technically this isn't allowed in an HTML comment, but
10828 we've always allowed it, and so do most other implementations.
10829 It is handy if e.g. you want to put command line arguments
10830 in HTML comments.
10832 * LaTeX reader:
10834 + Don't eat excess whitespace after macros with only optional
10835 arguments (#2446).
10836 + Support longtable (#2411).
10837 + Implement `\Cite` (#2335).
10838 + Support abstract environment. The abstract populates an
10839 `abstract` metadata field.
10840 + Properly handle booktabs lines. Lines aren't part of the
10841 pandoc table model, so we just ignore them (#2307).
10843 * HTML reader:
10845 + Handle type attribute on ol, e.g. `<ol type="i">` (#2313).
10846 + Updated for new automatic header attributes.
10847 + Add auto identifiers if not present on headers. This makes
10848 TOC linking work properly.
10849 + Detect `font-variant` with `pickStyleAttrProps` (Ophir Lifshitz).
10850 + Test `<ol>` type, class, and inline list-style(-type) CSS
10851 (Ophir Lifshitz).
10852 + Better handling of "section" elements (#2438). Previously
10853 `<section>` tags were just parsed as raw HTML blocks. With
10854 this change, section elements are parsed as Div elements with
10855 the class "section".
10857 * MediaWiki reader: handle unquoted table attributes (#2355).
10859 * DocBook reader:
10861 + Added proper support for DocBook `xref` elements (Frerich Raabe).
10862 Added `dbContent` field to reader state, so we can lookup
10863 cross refs.
10864 + Handle `informalexample` (#2319).
10866 * Docx Reader:
10868 + Create special punctuation test (Ophir Lifshitz).
10869 + Parse soft, no-break hyphen elements (Ophir Lifshitz).
10870 + Updated headers test (Ophir Lifshitz). Replaced `styles.xml`
10871 in `headers.docx` with pandoc's current `styles.xml`, which
10872 contains styles for Heading 1 through 6. Added Heading 4
10873 through 7 to the test document. Note that Heading 7 is not
10874 parsed as a Heading because there is no Heading 7 style.
10876 * RST reader: better handling of indirect roles.
10877 Previously the parser failed on this kind of case
10879 .. role:: indirect(code)
10881 .. role:: py(indirect)
10882 :language: python
10884 :py:`hi`
10886 Now it correctly recognizes `:py:` as a code role.
10888 * Org reader:
10890 + Add auto identifiers if not present on headers
10891 (#2354, Juliusz Gonera).
10892 + Allow verse blocks to contain empty lines (#2402,
10893 Albert Krewinkel).
10895 * EPUB reader: stop mangling external URLs (#2284).
10897 * RST writer:
10899 + Don't insert `\ ` when complex expression in matched pairs.
10900 E.g. `` [:sup:`3`] `` is okay; you don't need `` [:sup:`3`\ ] ``.
10901 + Ensure that `\ ` is inserted when needed before Cite and Span
10902 elements that begin with a "complex" element (jgm/pandoc-citeproc#157).
10903 + Normalize headers only in "standalone" mode (#2394).
10905 * Haddock writer: escape `*` and `^` (G. Bataille).
10907 * Markdown writer:
10909 + In TOC, add links to headers (#829).
10910 + Use unicode super/subscripts for digits in plain output
10911 (when the `superscripts` and `subscripts` extensions are
10912 not enabled).
10914 * Docx writer:
10916 + Moved invalid character stripping to `formattedString`.
10917 This avoids an inefficient generic traversal (#2356).
10918 + Use user data directory for `reference.docx` archive.
10919 This allows the test suite to work without installing pandoc first.
10920 It also brings the docx writer in line with the odt writer.
10921 + Tests: docx writer tests now use `../data` for data directory.
10922 This allows tests to be run without installing first.
10923 + Tests: Use real jpg (not empty) for docx tests to avoid warning.
10925 * LaTeX writer:
10927 + Fixed detection of 'chapters' from template.
10928 If a documentclass isn't specified in metadata, but the
10929 template has a hardwired bookish documentclass, act as if
10930 `--chapters` was used. This was the default in earlier
10931 versions, but it has been broken for a little while.
10932 + Correctly recognize book documentclass in metadata (#2395).
10933 + Set language-related variables automatically, depending
10934 on the value of the `lang` field, which is now always
10935 assumed to be in BCP47 format (mb21, #1614, #2437).
10936 + Add `\protect` to `\hyperdef` in inline context. This way we
10937 don't get an error when this is used as a moveable argument (#2136).
10938 + Support all frame attributes in Beamer.
10939 + Percent-encode more special characters in URLs (#1640, #2377).
10940 The special characters are '<','>','|','"','{','}','[',']','^', '`'.
10942 * HTML writer:
10944 + Update KaTeX JS and CSS versions (Emily Eisenberg).
10945 + For dzslides, add `role="note"` for speaker notes (#1693).
10946 + Percent-encode more special characters in URLs (#1640, #2377).
10947 The special characters are '<','>','|','"','{','}','[',']','^', '`'.
10948 + Render Div with class `section` as `<section>` in HTML5.
10950 * EPUB writer:
10952 + In TOC, replace literal `<br/>` with space (#2105).
10953 + With `--webtex`, include image file rather than `data:` URI (#2363).
10955 * Native writer: format Div properly, with blocks separated.
10957 * Support bidirectional text output with XeLaTeX, ConTeXt and HTML
10958 (#2191, mb21).
10960 * Reference Docx:
10962 + Add missing Header 6 style (steel blue) (Ophir Lifshitz).
10963 + Correct `outlineLvl` for Header styles (Ophir Lifshitz).
10965 * Templates
10967 + Beamer: Add `innertheme`, `outertheme` variables
10968 (Guilhem Bonnefille, #121). Add space after colon in figure caption.
10969 Integrate recent font and language updates from LaTeX template;
10970 allow use of `mainfont` variable for changing the slide text
10971 in XeTeX and LuaTeX (Andrew Dunning, #131).
10972 + LaTeX: Add `mainfontoptions`, `sansfontoptions`,
10973 `monofontoptions`, `mathfontoptions`, `fontfamilyoptions`
10974 (Andrew Dunning, #122). Support handling of bidirectional
10975 text (mb21, #120). Improve reliability of superscripts/subscripts
10976 under XeTeX and prevent letters and numbers from appearing on a
10977 different baseline by removing use of the `realscripts` package
10978 (via `xltxtra`). To restore use of OpenType characters for these
10979 features under XeTeX or LuaTeX, add `\usepackage{realscripts}` to
10980 `header-includes` (Andrew Dunning, #130). Remove redundant
10981 reference to `xunicode` (Andrew Dunning, #130). Add `fontenc`,
10982 `indent`, `subparagraph` variables (Andrew Dunning).
10983 Allow use of `hidelinks` variable for `hyperref` package (Hugo Roy,
10984 #113). Prevent package clash with `tufte-latex` and other classes that
10985 include `hyperref` or `color` (Xavier Olive, #115).
10986 + ConTeXt: Support handling of bidirectional text (mb21, #120).
10987 + LaTeX and ConTeXt: Use more specific language variables.
10988 Instead of directly using `lang`, we now use `babel-lang` and
10989 `polyglossia-lang` and `context-lang`. These variables are set by
10990 the writers to the necessary values, based on the `lang` variable
10991 (which now always takes a value in BCP47 format). (mb21, #114, #129).
10992 + HTML: Support handling of bidirectional text (mb21, #120).
10993 Move HTML5 shiv after CSS and fix URL (Andrew Dunning).
10994 Add dir attribute in html5 (Andrew Dunning).
10995 + reveal.js: Add `controls`, `progress` variables (Grégoire Pineau, #127).
10996 Add `width`, `height` variables (Anrew Dunning). Update template
10997 from 3.1 source (Andrew Dunning). All configuration options are now
10998 available as variables, but are only be included if set (reveal.js
10999 uses defaults otherwise).
11000 + man: Added comment stating that the page is autogenerated by pandoc,
11001 giving version. Added `adjusting` and `hyphenate` variables
11002 (Alex Vong, #123).
11004 * epub.css: added selectors for nested emphasis (Pablo Rodriguez).
11006 * MediaBag: ensure that `/` is always used as path separator.
11008 * `sample.lua`: define `CaptionedImage`, add newline at end (#2393).
11010 * Added `--bash-completion` option. This generates a bash completion
11011 script. To use: `eval "$(pandoc --bash-completion)"`.
11013 * Text.Pandoc.Error: Define Typeable and Exception instances
11014 for PandocError (#2386).
11016 * Text.Pandoc.Parsing: `toKey`: strip off outer brackets.
11017 This makes keys with extra space at the beginning and end
11018 work: e.g.
11020 [foo]: bar
11022 [ foo ]
11024 will now be a link to bar (it wasn't before).
11026 * Text.Pandoc: disable `auto_identifiers` for epub.
11027 The epub writer inserts its own auto identifiers;
11028 this is more complex due to splitting into "chapter" files.
11030 * Renamed Text.Pandoc.Compat.Locale -> Text.Pandoc.Compat.Time.
11031 It now reexports Data.Time.
11033 * Use custom Prelude to avoid compiler warnings.
11035 + The (non-exported) prelude is in prelude/Prelude.hs.
11036 + It exports Monoid and Applicative, like base 4.8 prelude,
11037 but works with older base versions.
11038 + It exports (<>) for mappend.
11039 + It hides 'catch' on older base versions.
11041 * Added a `stack.ymal` and stack install instructions to INSTALL.
11043 * Clarified what is "out of scope" in README and CONTRIBUTING.md.
11045 * Added note to CONTRIBUTING.md about ghc versions and travis.
11047 * Clarify docs on block quotes. The space after `>` is optional (#2346).
11049 * Removed obsolete reference to default.csl (#2372).
11051 * List all styles in manual for `--reference-docx` (Chris Black)
11053 * Don't capitalize header links in man page.
11055 * Added section on repl to CONTRIBUTING.md.
11057 * README: Added space after backslash in image example (#2329).
11059 * Document details of citation locator terms (Nick Bart).
11061 * Fixed some internal links in README (#2309).
11063 * Improve CSL documentation, variables documentations,
11064 links, and cross-references in README. (Andrew Dunning)
11066 * Fix build failure with `--flags=-https` (Sergei Trofimovich).
11068 * Use `newManager` instead of `withManager` in recent `http-client`.
11069 This avoids a deprecation warning.
11071 * Allow building with latest versions of http-types,
11072 HUnit, criterion, syb, aeson.
11074 * Updated benchmark program for new criterion API.
11076 * Setup.hs: rewrite so as not to use process, directory, filepath.
11077 Using anything outside base is dangerous, since older
11078 versions of ghc may link against two different versions.
11080 * Added appveyor (Windows continuous integration) builds.
11082 * New `.travis.yml`. Autgenerated using `make_travis_yml.hs`.
11083 This script has been modified in a few ways, e.g. to add `GHCOPTS`.
11084 `make .travis.yml` regenerates it based on the tested-with
11085 field of the cabal file.
11087## pandoc 1.15.0.6 (2015-07-15)
11089 * `--self-contained`: Fixed overaggressive CSS minimization
11090 (#2301, 2286). Previously `--self-contained` wiped out all
11091 spaces in CSS, including semantically significant spaces.
11092 This was a regression from 1.14.x.
11094 * Markdown reader: don't allow bare URI links or autolinks in link
11095 label (#2300). Added test cases.
11097 * `Text.Pandoc.Parsing`, `uri`: Improved bare autolink detection (#2299).
11098 Previously we disallowed `-` at the end of an autolink,
11099 and disallowed the combination `=-`. This commit liberalizes the
11100 rules for allowing punctuation in a bare URI, and adds test cases.
11101 One potential drawback is that you can no longer put a bare
11102 URI in em dashes like this:
11103 `this uri---http://example.com---is an example.`
11104 But in this respect we now match github's treatment of bare URIs.
11106 * HTML writer: support speaker notes in dzslides.
11107 With this change `<div class="notes">` and also `<div class="notes"
11108 role="note">` will be output if `-t dzslides` is used. So we can
11109 have speaker notes in dzslides too. Thanks to maybegeek.
11111 * Updated dzslides template.
11113 * Improved documentation of options to print system default files (#2298).
11114 `--print-default-data-file` and `--print-default-template`.
11116 * DokuWiki writer: use `$..$` for Math instead of `<math>..</math>`
11117 (Tiziano Müller). MathJax seems currently to be the only maintained
11118 math rendering extension for DokuWiki.
11120 * `Text.Pandoc.Shared`: Changed `hierarchicalize` so it treats references
11121 div as top-level header (#2294). This fixes a bug with `--section-divs`,
11122 where the final references section added by pandoc-citeproc, enclosed in
11123 its own div, got nested in the div for the section previous to it.
11125 * Allow vector 0.11.
11127 * Require cmark > 0.4.
11129## pandoc 1.15.0.5 (2015-07-10)
11131 * HTML writer: Fixed email javascript obfuscation with `mailto:`
11132 URLs (#2280). This fixes a potential security issue. Because
11133 single quotes weren't being escaped in the link portion, a
11134 specially crafted email address could allow javascript code injection.
11136 * RST reader: allow inline formatting in definition list field
11137 names (Lars-Dominik Braun).
11139 * PDF: Make sure `--latex-engine-opt` goes before the filename
11140 on the command line. LaTeX needs the argument to come after
11141 the options (#1779).
11143 * CommonMark writer: fixed tags used for super/subscript.
11145 * ConTeXt template: activate hanging indent for definition lists
11146 (mb21).
11148 * Make cabal require `hsb2hs` >= 0.3.1 if `embed_data_files` specified.
11149 This is done by adding `hookedPrograms` in `Setup.hs`, which allows us
11150 to include `hsb2hs` in Build-Tools in cabal.
11152 * Improved Windows installer (thanks to nkalvi).
11154 + When per-machine installation is chosen, the system path
11155 is updated instead of the user's.
11156 + An appropriate default is used for per-machine installation
11157 directory.
11158 + Admin privileges are no longer required for a per-user install
11160 * Travis: unpack sdist for build to catch packaging bugs.
11162 * Improved documentation on where user templates go (#2272).
11164## pandoc 1.15.0.4 (2015-07-03)
11166 * Added pandoc.1 man page to the repository. It is no longer
11167 built as part of the cabal build process. (This proved too
11168 fragile.) pandoc.1 can be regenerated (`make man/pandoc.1`)
11169 when `README` is changed.
11171 * Copying of the man page now respects `--destdir` (#2262).
11173 * Improved error messages for filters. User is now informed if
11174 the filter requires an interpreter that isn't found in the path,
11175 or if the filter returns an error status.
11177## pandoc 1.15.0.3 (2015-07-02)
11179 * Ensure target directory is created when installing man page.
11181## pandoc 1.15.0.2 (2015-07-02)
11183 * Added files needed for building man page to Extra-Source-Files.
11185## pandoc 1.15.0.1 (2015-07-01)
11187 * Man page is now built and installed as part of the cabal build
11188 process. Removed Makefile target for man page.
11190## pandoc 1.15 (2015-07-01)
11192 * Man page changes:
11194 + Removed `--man1`, `--man5` options (breaking change).
11195 + Removed `Text.Pandoc.ManPages` module (breaking API change).
11196 + Makefile target for `man/man1/pandoc.1`. This uses pandoc to
11197 create the man page from README using a custom template and filters.
11198 + Added `man/` directory with template and filters needed to build
11199 man page.
11200 + We no longer have two man pages: `pandoc.1` and `pandoc_markdown.5`.
11201 Now there is just pandoc.1, which has all the content from README.
11202 This change was needed because of the extensive cross-references
11203 between parts of the README.
11204 + Removed old `data/pandoc.1.template` and
11205 `data/pandoc_markdown.5.template`.
11207 * OpenDocument writer: Do not add a carriage return after a hard
11208 line break (Michael Chladek).
11210 * ConTeXt writer:
11212 + use `\goto` for internal links.
11213 + Added a `%` at end for `\reference` to avoid spurious space.
11215 * Ignore sandbox on 'make quick'
11217## pandoc 1.14.1 (2015-06-30)
11219 * Added `--man1` and `--man5` options to pandoc, allowing
11220 pandoc to generate its own man pages. Man pages are no longer
11221 automatically generated in the build process (the process for
11222 this was too complex and prone to failure, #2190). The
11223 `make-pandoc-man-pages` executable has been removed. The
11224 `man/` directory has been removed, and man page templates
11225 have been moved to `data/`. NOTE TO PACKAGERS: You will no
11226 longer find pandoc's man pages in `man/`, but you can
11227 generate them using `pandoc --man1 > pandoc.1` and `pandoc
11228 --man5 > pandoc_markdown.5`.
11230 * Added new unexported module: `Text.Pandoc.ManPages`.
11232 * `README` now acts like a data file (even though it isn't in
11233 `data/`). So, for example, `pandoc --print-default-data-file README`
11234 will produce the README.) This change was required for the `--man1`
11235 and `--man5` options, since the man pages are produced from the
11236 README, but it may be useful for other purposes as well.
11238 * Allow `reference.docx` and `reference.odt` to be used with
11239 `--print-default-data-file` and to shadow defaults if placed in
11240 the user data directory. Note that as of 1.14, we no longer
11241 include these files as data files; instead, we include their
11242 components. This change causes pandoc to behave as if it has
11243 these data files; they are constructed on demand when needed
11244 using `getDefaultReferenceDocx` and `getDefaultReferenceODT`.
11246 * Fixed regression in CSS parsing with `--self-contained` (#2224).
11247 Pandoc 1.14.0.x used css-text to parse the CSS, but its parser
11248 silently drops big sections of CSS. This commit replaces the
11249 use of css-text with a small but principled CSS preprocessor,
11250 which removes whitespace and comments and replaces `url()` with
11251 base 64 data when possible.
11253 * Use `https://` instead of `//` for MathJax and KaTeX CDN URLs (#1920).
11254 This will allow math to work when pages are being viewed locally.
11256 * `Text.Pandoc.Options`: Export `plainExtensions`.
11257 These are the extensions used in `plain` output.
11259 * LaTeX reader: Don't parse `_` and `^` as sub/superscript outside of
11260 math mode; treat them as regular inline text. Normally these will
11261 cause an error in LaTeX, but there are contexts (e.g. `alltt`
11262 environments) where they are allowed.
11264 * HTML reader: allow `<body>` to close `<head>`.
11266 * DocBook reader: support `mediaobject`s and `figures` (#2184, mb21).
11268 * RST reader: Fix reference names with special characters
11269 (Lars-Dominik Braun).
11271 * Textile writer: escape `+` and `-` as entities (#2225).
11273 * DokuWiki writer: Use proper `<code>` tags for code blocks (#2213).
11275 * Plain writer: don't use symbols for super/subscript (#2237).
11276 Simplified code by using `plainExtensions`.
11278 * InDesign writer: Properly escape URLs containing more than one
11279 colon character (gohai).
11281 * Docx writer: Make sure we use dist version of `reference.docx`
11282 (and not the user's version) for certain settings. Taking some
11283 settings values from a user-supplied reference.docx can lead to
11284 corruption. This fixes a regression from the last release (#2249).
11286 * `Text.Pandoc.Shared`: exports `getDefaultReferenceDocx` and
11287 `getDefaultReferenceODT` (API change). These functions have been
11288 removed from the Docx and ODT writers.
11290 * LaTeX template (Xavier Olive):
11291 + Added `CJKmainfont` and `CJKoptions` variables.
11292 + Allow dvipsnames (e.g. `MidnightBlue`) for colors (Xavier Olive).
11294 * Epub templates: use `author.role`, not `author.type`.
11296 * Bump cmark version to >= 0.3.4.
11298 * Improved Windows installer (#2205, thanks to nkalvi).
11299 Users can now select a per-user or systemwide install, and can set
11300 the installation path. At the end of installation, the install location
11301 is given. The install location is also now given in the list of
11302 installed programs in Control Panel. Cleaner WiX syntax is used for
11303 setting the path.
11305 * Added `download_stats` target to Makefile.
11307## pandoc 1.14.0.4 (2015-06-02)
11309 * Added missing commonmark template.
11311 * Improved try pandoc (moved button, show raw command).
11313## pandoc 1.14.0.3 (2015-06-01)
11315 * Allow compilation with syb 0.5.*.
11317 * Custom writer: fixed some compiler warnings for ghc < 7.10.
11319## pandoc 1.14.0.2 (2015-05-31)
11321 * Allow building with hslua 0.4.
11323## pandoc 1.14.0.1 (2015-05-28)
11325 * Fixed problem with building of `reference.docx` and `reference.odt`
11326 when the `embed_data_files` flag is used. Instead of having a phase
11327 of the build where `reference.docx` and `reference.odt` are created
11328 from their constituent data files, we now construct these archives
11329 from their constituents when a `docx` or `odt` is built. The
11330 constituent files have been moved from `extra-source-files` to
11331 `data-files`, and `reference.docx` and `reference.odt` have been
11332 removed. Users can create their own `reference.docx` or
11333 `reference.odt` by using pandoc to create a simple `docx` or `odt`.
11334 `make-reference-files.hs` has been removed, simplifying the build
11335 process (#2187)
11337 * Don't include generated man pages in extra-source-files (#2189).
11339 * Bumped upper bound for aeson.
11341 * ConTeXt writer: create internal link anchors for Div elements with
11342 identifiers. (This is needed for linked citations to work.)
11344## pandoc 1.14 (2015-05-27)
11346### New features
11348 * Added `commonmark` as input and output format.
11350 * Added `--verbose` flag for debugging output in PDF production (#1840,
11351 #1653).
11353 * Allow wildcards in `--epub-embed-font` arguments (#1939).
11355 * Added `--latex-engine-opt` option (#969, #1779, Sumit Sahrawat).
11357 * Added `shortcut_reference_links` extension (Konstantin Zudov, #1977).
11358 This is enabled by default for those markdown flavors that
11359 support reading shortcut reference links, namely: `markdown`,
11360 `markdown_strict`, `markdown_github`, `markdown_php`.
11361 If the extension is enabled, the reader parses shortcut reference
11362 links like `[foo]`, and the writer creates such links unless doing
11363 so would cause problems. Users of markdown flavors that support
11364 shortcut reference links should not notice a difference in reading
11365 markdown, but the markdown pandoc produces may differ.
11366 If shortcut links are not desired, the extension can be disabled
11367 in the normal way.
11369### Behavior changes
11371 * `--toc` is now supported for `docx` output (#458, Nikolay Yakimov).
11372 A "dirty" TOC is created at the beginning of document.
11373 It can be regenerated after the document has been opened.
11375 * An implicit `--filter pandoc-citeproc` is now triggered only when the
11376 `--bibliography` option is used, and not when the `bibliography`
11377 field in metadata is specified (#1849).
11379 * Markdown reader:
11381 + Reference links with `implicit_header_references` are no longer
11382 case-sensitive (#1606).
11383 + Definition lists no longer require indentation for first line (#2087).
11384 Previously the body of the definition (after the `:` or `~` marker)
11385 needed to be in column 4. This commit relaxes that requirement,
11386 to better match the behavior of PHP Markdown Extra. So, now
11387 this is a valid definition list:
11389 foo
11390 : bar
11391 + Resolve a potentially ambiguity with table captions:
11393 foo
11395 : bar
11397 -----
11398 table
11399 -----
11401 Is "bar" a definition, or the caption for the table? We'll count
11402 it as a caption for the table.
11403 + Disallow headerless pipe tables (#1996), to conform to GFM and PHP
11404 Markdown Extra. Note: If you have been using headerless pipe tables,
11405 this change may cause existing tables to break.
11406 + Allow pipe tables with header but no body (#2017).
11407 + Allow a digit as first character of a citation key (Matthias Troffaes).
11408 See https://github.com/jgm/pandoc-citeproc/issues/97
11410 * LaTeX reader:
11412 + Don't limit includes to `.tex` extension (#1882).
11413 If the extension is not `.tex`, it must be given explicitly in
11414 the `\input` or `\include`.
11416 * Docx reader:
11418 + Allow numbering in the style file. This allows inherited styles
11419 with numbering (lists) (Jesse Rosenthal).
11421 * Org reader:
11423 + Support smart punctuation (Craig Bosma).
11424 + Drop trees with a :noexport: tag (Albert Krewinkel). Trees having a
11425 `:noexport:` tag set are not exported. This mirrors org-mode.
11426 + Put header tags into empty spans (Albert Krewinkel, #2160).
11427 Org mode allows headers to be tagged: `* Headline :TAG1:TAG2`.
11428 Instead of being interpreted as part of the headline, the tags are now
11429 put into the attributes of empty spans. Spans without textual content
11430 won't be visible by default, but they are detectable by filters. They
11431 can also be styled using CSS when written as HTML.
11432 + Generalize code block result parsing (Albert Krewinkel).
11433 Previously, only code blocks were recognized as result blocks;
11434 now, any kind of block can be the result.
11436 * Append newline to the LineBreak in Dokuwiki, HTML, EPUB,
11437 LaTeX, MediaWiki, OpenDocument, Texinfo writers (#1924, Tim Lin).
11439 * HTML writer:
11441 + Add "inline" or "display" class to math spans (#1914).
11442 This allows inline and display math to be styled differently.
11443 + Include raw latex blocks if `--mathjax` specified (#1938).
11444 + Require highlighting-kate >= 0.5.14 (#1903).
11445 This ensures that all code blocks will be wrapped in a `div`
11446 with class `sourceCode`. Also, the default highlighting CSS
11447 now adds `div.sourceCode { x-overflow: auto; }`, which means
11448 that code blocks (even with line numbers) will acquire a scroll
11449 bar on screens too small to display them (e.g. mobile phones).
11450 See also jgm/highlighting-kate#65.
11452 * LaTeX writer:
11454 + Use a declaration for tight lists (Jose Luis Duran, Joseph
11455 Harriott). Previously, pandoc hard-coded some commands to make
11456 tight lists in LaTeX. Now we use a custom command instead,
11457 allowing the styling to be changed in a macro in the header.
11458 (Note: existing templates may need to be modified to include
11459 the definition of this macro. See the current template.)
11460 + Beamer output: if the header introducing a slide has the
11461 class `fragile`, add the `[fragile]` option to the slide (#2119).
11463 * MediaWiki writer:
11465 + Use `File:` instead of the deprecated `Image:` for images and
11466 other media files (Greg Rundlett).
11468 * DocBook writer:
11470 + Render a `Div (id,_,_) [Para _]` element as a `para` element
11471 with an `id` attribute. This makes links to citations work in
11472 DocBook with pandoc-citeproc.
11474 * RST writer:
11476 + Normalize headings to sequential levels (Nikolay Yakimov).
11477 This is pretty much required by docutils.
11478 + Treat headings in block quotes, etc as rubrics (Nikolay Yakimov).
11479 + Better handling of raw latex inline (#1961). We use
11480 `` :raw-latex:`...` `` and add a definition for this role to
11481 the template.
11483 * EPUB writer:
11485 + Remove `linear=no` from cover `itemref` (#1609).
11486 + Don't use `sup` element for epub footnotes (#1995).
11487 Instead, just use an a element with class `footnoteRef`.
11488 This allows more styling options, and provides better results
11489 in some readers (e.g. iBooks, where anything inside the a
11490 tag breaks popup footnotes).
11491 + Take TOC title from `toc-title` metadata field.
11493 * Docx writer:
11495 + Implemented `FirstParagraph` style (Jesse Rosenthal).
11496 Following the ODT writer, we add the `FirstParagraph` style to the
11497 first text paragraph following an image, blockquote, table, heading,
11498 or beginning of document. This allows it to be styled differently.
11499 The default is for it to be the same as `Normal`.
11500 + Added `BodyText` style (Jesse Rosenthal).
11501 We apply a `BodyText` style to all unstyled paragraphs. This is,
11502 essentially, the same as `Normal`, except that since not everything
11503 inherits from `BodyText` (the metadata won't, for example, or
11504 the headers or footnote numbers), we can change the text in the body
11505 without having to make exceptions for everything. If we do want to
11506 change *everything*, we can still do it through `Normal`.
11507 + Altered `Blockquote` style slightly (Jesse Rosenthal).
11508 Since `BlockQuote` derives from `BodyText`, we just want to specify
11509 by default that it won't indent, regardless of what `BodyText` does.
11510 Note that this will not produce any visible difference in the default
11511 configuration.
11512 + Take TOC title from `toc-title` metadata field (Nikolay Yakimov).
11513 + Added a style to figure images (Nikolay Yakimov).
11514 Figures with empty captions use style `Figure`.
11515 Figures with nonempty captions use style `Figure with Caption`, which
11516 is based on `Figure`, and additionally has `keepNext` set.
11518 * ODT writer:
11520 + Added figure captions (Nikolay Yakimov). The following styles are
11521 used for figures:
11522 `Figure` -- for figure with empty caption),
11523 `FigureWithCaption` (based on `Figure`) -- for figure with caption,
11524 `FigureCaption` (based on `Caption`) -- for figure captions.
11525 Also, `TableCaption` (based on `Caption`) is used for table captions.
11527### API changes
11529 * New `Text.Pandoc.Error` module with `PandocError` type
11530 (Matthew Pickering).
11532 * All readers now return `Either PandocError Pandoc` instead of `Pandoc`
11533 (Matthew Pickering). This allows better handling of errors.
11535 * Added `Text.Pandoc.Writers.CommonMark`, exporting `writeCommonMark`.
11537 * Added `Text.Pandoc.Readers.CommonMark`, exporting `readCommonMark`.
11539 * Derive `Data` and `Typeable` instances for `MediaBag`, `Extension`,
11540 `ReaderOptions`, `EPUBVersion`, `CiteMethod`, `ObfuscationMethod`,
11541 `HTMLSlideVariant`, `TrackChanges`, `WriterOptions` (Shabbaz
11542 Youssefi).
11544 * New `Ext_shortcut_reference_links` constructor for `Extension`
11545 (Konstantin Zudov).
11547### Bug fixes
11549 * Markdown reader:
11551 + Allow smart `'` after inline math (#1909, Nikolay Yakimov).
11552 + Check for tex macros after indented code (#1973).
11553 + Rewrote `charsInBalancedBrackets` for efficiency.
11554 + Make sure a closing `</div>` doesn't get included in a
11555 definition list item (#2127).
11556 + Don't parse bracketed text as citation if it might be a link,
11557 image, or footnote (Nikolay Yakimov).
11558 + Require space after key in mmd title block (#2026, Nikolay
11559 Yakimov). Require space after key-value delimiter colon in mmd title
11560 block.
11561 + Require nonempty value in mmd title block (Nikolay Yakimov).
11562 + Disable all metadata block extensions when parsing
11563 metadata field values (#2026, Nikolay Yakimov). Otherwise we
11564 could get a mmd title block inside YAML metadata, for example.
11566 * HTML reader:
11568 + Improve self-closing tag detection in `htmlInBalanced` (#2146).
11569 + Handle tables with `<th>` in body rows (#1859, mb21).
11570 + Fixed `htmlTag` (#1820). If the tag parses as a comment, we check
11571 to see if the input starts with `<!--`. If not, it's bogus comment
11572 mode and we fail `htmlTag`.
11573 + Handle `base` tag; if it has an `href` value, this is added to
11574 all relative URLs in links and images.
11576 * DocBook reader:
11578 + Look inside "info" elements for section titles (#1931).
11580 * Docx reader:
11582 + Parse images in deprecated vml format (Jesse Rosenthal).
11583 + Allow sub/superscript verbatims (Jesse Rosenthal).
11584 Verbatim usually shuts off all other run styles, but we don't want it
11585 to shut off sub/superscript.
11587 * LaTeX reader:
11589 + Handle `tabular*` environment (#1850).
11590 Note that the table width is not actually parsed or taken into
11591 account, but pandoc no longer chokes on it.
11592 + Ignore options in `\lstinline` rather than raising error (#1997).
11593 + Add some test cases for simple tables (Mathias Schenner).
11594 + Handle valign argument in tables (Mathias Schenner) (currently
11595 we just ignore this).
11596 + Allow non-empty colsep in tables (Mathias Schenner).
11597 The `tabular` environment allows non-empty column separators
11598 with the "@{...}" syntax. Previously, pandoc would fail to
11599 parse tables if a non-empty colsep was present. With this
11600 commit, these separators are still ignored, but the table gets
11601 parsed. A test case is included.
11602 + Recognize `\newpage` as a block command.
11603 + Allow block content in `\title{}` (#2001).
11604 + Check for block-level newcommand aliases in blockCommand (Nikolay
11605 Yakimov).
11606 + Guard against paragraph starting with inline macro (Nikolay Yakimov).
11607 + Properly gobble spaces after `\\` (#2007).
11609 * Textile reader:
11611 + Handle newlines in table cells, and empty cells (#1919).
11613 * Org reader:
11615 + Allow image links with non-image targets (Hans-Peter Deifel).
11616 This matches behavior of Org-Mode for links like
11617 `[[http://example.com][https://www.haskell.org/static/img/logo.png]]`.
11619 * Docbook writer:
11621 + Don't print empty id attributes (thanks to Steve Horne).
11623 * HTML writer:
11625 + Fixed list-style-type for numbered example lists.
11626 Should be "decimal," not "example" (#1902).
11627 + Do not omit missing `alt` attribute on `img` tag (#1131,
11628 Konstantin Zudov).
11629 + Allow multiple colgroups in table (#2122).
11630 + In revealjs, ensure that lists in speaker notes don't add "fragment"
11631 classes, which can cause additional keypresses to be needed to
11632 advance a slide (#1394).
11634 * LaTeX writer:
11636 + Don't escape `$` in URL (#1913).
11637 + Don't use listings in headers (Matthew Pickering, #1963).
11638 + Recognize book documentclass if set in metadata (#1971).
11639 This sets `--chapters` implicitly if the documentclass in metadata
11640 is a book documentclass. Previously this was done only if a book
11641 documentclass was set in a variable.
11642 + Add a `\label` in `\hyperdef` for Div, Span (or links don't work).
11643 + Make `mainlang` work when `lang` is in metadata (#2174).
11645 * Texinfo writer:
11647 + Fix wrapping by using breakable spaces (Tim Lin).
11649 * RST writer:
11651 + Fixed toc depth in RST writer. Previously the depth was being
11652 rendered as a floating point number with a decimal point.
11654 * Markdown writer:
11656 + Improved escaping (#2086). `<` should not be escaped as `\<`, for
11657 compatibility with original Markdown. We now escape `<` and `>`
11658 with entities. Also, we now backslash-escape square brackets.
11659 + Avoid introducing spurious list items through wrapping (#1946).
11660 + Don't emit span tags if plain or raw HTML disabled.
11662 * MediaWiki writer:
11664 + Convert spaces to underscores in wikilink URL (#1982), like MediaWiki.
11666 * AsciiDoc writer:
11668 + Insert some needed blank lines (#1860).
11669 + Avoid wrapping after list marker (#1858).
11671 * EPUB writer:
11673 + Properly handle internal links to IDs in spans, divs (#1884).
11674 + Use plain writer for metadata dc: fields (#2121).
11675 This gives better results when we have, e.g. multiple paragraphs.
11676 Note that tags aren't allowed in these fields.
11677 + Properly handle image links without an extension (#1855).
11678 + Improved chapter splitting and internal link rewriting (#1887,
11679 #2162, #2163). This will ensure that internal links work and
11680 that the references section produced by pandoc-citeproc is
11681 in its own chapter.
11682 + Fixed handling of svg images (#2183).
11684 * ICML writer:
11686 + Better handling of raw blocks and inlines (#1951).
11687 Previously these were always escaped and printed verbatim.
11688 Now they are ignored unless the format is `icml`, in which
11689 case they are passed through unescaped.
11690 + Fixed image URIs in ICML output (gohai).
11692 * Custom writer:
11694 + Raise error if loadstring returns an error status.
11695 + Raise `PandocLuaException` instead of using 'error'.
11696 Eventually we'll change the return type so that no exception
11697 is involved, but at least this can be trapped.
11698 + Use UTF-8 aware bytestring conversion.
11699 + Set foreign encoding to UTF-8 (Nikolay Yakimov, #2101, #1634).
11700 Also factored out ByteString, since it's only used as an intermediate
11701 representation.
11703 * Docx writer:
11705 + Copy hyphenation settings from reference.docx (Nikolay Yakimov).
11706 + Filter out illegal XML characters (#1992, Matthew Pickering).
11707 + Added `noProof` to docx syntax highlighting `SourceCode` style.
11708 + Added footnotes id -1 and 0 (Jesse Rosenthal).
11709 Word uses, by default, footnotes with id -1 and 0 for separators. If a
11710 user modifies `reference.docx`, they will end up with a `settings.xml`
11711 file that references these footnotes, but no such footnotes in the
11712 document. This will produce a corruption error. Here we add these to the
11713 document and `settings.xml` file, so future modifications won't break
11714 the file.
11715 + Handle lists correctly inside table cells (Jesse Rosenthal).
11716 Previously we didn't transform lists inside table cells.
11717 + Set firstRow information in tables (Nikolay Yakimov).
11718 + Don't replace `SourceCode` style in `reference.docx` if it is defined
11719 there (Nikolay Yakimov, #1872). If `--no-highlight` specified, remove
11720 any `SourceCode` and `*Tok` styles in `reference.docx`.
11721 + Attempt to match international style names (#1607, Nikolay Yakimov).
11722 + Set these styles as custom (Nikolay Yakimov): `Author`, `Abstract`,
11723 `Compact`, `Image Caption`, `Table Caption`, `Definition Term`,
11724 `Definition`, `First Paragraph`.
11725 + Rename these styles to correspond with Word `Normal.dotm` (Nikolay
11726 Yakimov): `Block Quote -> Block Text`, `Link -> Hyperlink`,
11727 `Footnote Ref -> Footnote Reference`.
11728 + Added `Caption` style (Nikolay Yakimov).
11729 + Changed these styles' inheritance (Nikolay Yakimov):
11730 `Image Caption <- Caption`, `Table Caption <- Caption`.
11731 + Remove `SourceCode` style from `reference.docx` (#1872).
11732 This is added automatically by the docx writer.
11733 + Added toc heading style to `reference.docx` (Nikolay Yakimov).
11735 * `Text.Pandoc.PDF`
11737 + Don't suggest "Try xelatex" if xelatex already in use (mb21, #1832).
11738 + More comprehensible errors on image conversion (#2067).
11739 EPS can't be supported without shelling out to something like
11740 ImageMagick, but at least we can avoid mysterious error messages.
11742 * `Text.Pandoc.Shared`:
11744 + Make safeRead safe (#1801, Matthew Pickering).
11745 + Addded `mapLeft`, `hush` (Matthew Pickering).
11747 * `Text.Pandoc.Pretty`:
11749 + Remove partial function (Matthew Pickering).
11751 * `Text.Pandoc.SelfContained`:
11753 + Add `;charset=utf-8` to script mime type if missing (#1842).
11754 + Improved building of data URIs (#1940). Now base64 is used except
11755 for `text/*` mime types.
11756 + `cssURLs` no longer tries to fetch fragment URLs (#2121).
11757 + Properly handle data URIs in css urls (#2129).
11758 Use a proper CSS parser (adds dependency on `text-css`).
11760 * `Text.Pandoc.UTF8`:
11762 + Better handling of bare CRs in input files (#2132).
11763 Previously we just stripped them out; now we convert
11764 other line ending styles to LF line endings.
11766 * `Text.Pandoc.ImageSize`:
11768 + Fixed some exif header parsing bugs (#1834).
11769 + Make imageSize return an Either, not a Maybe (#1834).
11770 Use `runGetOrFail` (with `binary >= 0.7`) to return `Left` on
11771 parse failure (rather than `error`).
11772 + Improved warnings when image size can't be determined.
11773 + Removed error landmines (Matthew Pickering).
11775 * Added woff2 to MIME types (Alfred Wechselberger).
11777 * pandoc: When a binary input format is used, warn that file
11778 arguments past the first one are being ignored (Matthew Pickering).
11780### Template changes
11782 * LaTeX template:
11784 + Degrade gracefully if `\paragraph` not defined.
11785 + Include `grffile` together with `graphicx` (#2074).
11786 This properly handles filenames containing spaces and dots.
11787 + Redefine `\paragraph`, `\subparagraph`... to behave more
11788 like section headers (#1658).
11789 + Import hyperref before polyglossia to avoid an error with xelatex,
11790 "please load package hyperref before bidi package" (Nick Bart).
11791 + Added `toccolor` variable to control link color in toc (Kaixhin).
11793 * LaTeX, Beamer templates:
11795 + Provide `\tightlist`, which is now used by the LaTeX writer.
11796 + Use polyglossia in beamer (#85).
11797 + Use `bibliography` instead of `biblio-files`
11798 (#1661). Also use `\addbibresource` instead of `\bibliography` for
11799 biblatex.
11800 + Added `setotherlanguages` in polyglossia. This uses an `otherlang`
11801 variable that is derived from a comma-separated list in `lang`;
11802 the last language is `mainlang` and the others are `otherlang`.
11804 * EPUB templates:
11806 + Use `div`, not `p`, for "rights" on title page.
11807 + Added header-includes, include-before, include-after (#1987).
11809 * OpenDocument template:
11811 + Use `text:p` instead of `text:h` for title.
11812 Using `text:h` causes problems with numbering. Closes #2059.
11813 Thansk to @nkalvi for diagnosing this.
11815 * reveal.js template:
11817 + Link to non-minified css, js. The minified versions no longer
11818 ship with the library.
11819 + Correctly include style CSS (#1949).
11820 + New configurable options options: `center`, `maxScale`, `slideNuber`
11821 (Dmitry Smirnov, pandoc-templates#89).
11822 + Moved custom CSS after theme. This allows custom CSS to modify
11823 themes, instead of being replaced by them.
11824 + Allow `center` to be set to false.
11826### Under the hood improvements
11828 * Removed pre-built `reference.docx` and `reference.odt` (Nikolay
11829 Yakimov). Instead the repository now includes the component text files,
11830 and the zipped binaries are built from these using a helper
11831 program, `make-reference-files`. This should make maintenance of
11832 these components easier going forward.
11834 * `Text.Pandoc.Parsing`:
11836 + Added new `<+?>` combinator (Nikolay Yakimov).
11837 + Added `stateHeaderKeys` to `ParserState`.
11839 * `make_deb.sh` fixes:
11841 + Detect architecture.
11842 + Add Installed-Size to debian package control file (#1900).
11843 + Use `fakeroot` to get permissions right.
11844 + Use `mkdir` and `cp` instead of `install`.
11845 + Set permissions of directories to 755.
11846 + Install in `/usr` rather than `/usr/local`.
11847 + Compress man pages.
11848 + Combine copyright files for `pandoc`, `pandoc-citeproc`.
11850 * Added `Text.Pandoc.Compat.Locale` and `old-locale` flag
11851 to assist with transition to `time` 1.5.
11853 * Updated CONTRIBUTING.md with information about issue tags (Matthew
11854 Pickering).
11856 * Updated travis installs to the new sudo-less syntax (Tim Lin).
11858 * Updated dependency version bounds.
11860 * EPUB tests: don't use `joinPath`, which varies across platforms.
11861 Instead, use a forward-slash to join paths, regardless of the
11862 platform. This matches the way `MediaBag` now works.
11864 * Clarify JSON input and output in usage message (Caleb McDaniel).
11866 * Improved INSTALL instructions.
11868 * Always build man pages. Removed make-pandoc-man-pages flag.
11870 * Makefile: removed man target, now that we generate man pages by default.
11872 * README:
11874 + Fixed typos (J. Lewis Muir).
11875 + Added documentation on backtick_code_blocks (#2135, Nikolay Yakimov).
11876 + Added note on in-field markup in biblio databases (Nick Bart).
11877 + Fixed misleading example of raw HTML block.
11878 + Various minor formatting and consistency fixes for the program
11879 options (Andreas Lööw).
11880 + Made definition lists for options all "loose" for consistency.
11881 + Added YAML biblio format to table, and note on `pandoc-citeproc`'s
11882 `--bib2json` and `--bib2yaml` options (Nick Bart).
11883 + Removed obsolete reference to `mods2yaml` (Nick Bart).
11884 + Added section on syntax highlighting.
11885 + Documented `toccolor` variable.
11887## pandoc 1.13.2.1 (2015-04-15)
11889 * Updated to build with ghc 7.10.1.
11891 * Bumped package upper bounds for filepath, blaze-html, blaze-markup.
11893## pandoc 1.13.2 (2014-12-20)
11895 * TWiki Reader: add new new twiki reader (API chaneg, Alexander Sulfrian).
11897 * Markdown reader:
11899 + Better handling of paragraph in div (#1591).
11900 Previously text that ended a div would be parsed as Plain
11901 unless there was a blank line before the closing div tag.
11902 + Don't treat a citation as a reference link label (#1763).
11903 + Fix autolinks with following punctuation (#1811).
11904 The price of this is that autolinked bare URIs can no longer
11905 contain `>` characters, but this is not a big issue.
11906 + Fix `Ext_lists_without_preceding_blankline` bug (#1636, Artyom).
11907 + Allow `startnum` to work without `fancy_lists`. Formerly
11908 `pandoc -f markdown-fancy_lists+startnum` did not work properly.
11910 * RST reader (all Daniel Bergey):
11912 + Parse quoted literal blocks (#65). RST quoted literal blocks are
11913 the same as indented literal blocks (which pandoc already supports)
11914 except that the quote character is preserved in each line.
11915 + Parse RST class directives. The class directive accepts one or more
11916 class names, and creates a Div value with those classes. If the
11917 directive has an indented body, the body is parsed as the children of
11918 the Div. If not, the first block following the directive is made a
11919 child of the Div. This differs from the behavior of rst2xml, which
11920 does not create a Div element. Instead, the specified classes are
11921 applied to each child of the directive. However, most Pandoc Block
11922 constructors to not take an Attr argument, so we can't duplicate this
11923 behavior.
11924 + Warn about skipped directives.
11925 + Literal role now produces Code. Code role should have "code" class.
11926 + Improved support for custom roles
11928 - Added `sourceCode` to classes for `:code:` role, and anything
11929 inheriting from it.
11930 - Add the name of the custom role to classes if the Inline
11931 constructor supports Attr.
11932 - If the custom role directive does not specify a parent role,
11933 inherit from the `:span:` role.
11935 This differs somewhat from the `rst2xml.py` behavior. If a custom
11936 role inherits from another custom role, Pandoc will attach both
11937 roles' names as classes. `rst2xml.py` will only use the class of
11938 the directly invoked role (though in the case of inheriting from a
11939 `:code:` role with a `:language:` defined, it will also provide the
11940 inherited language as a class).
11941 + Warn about ignored fields in role directives.
11943 * LaTeX reader:
11945 + Parse label after caption into a span instead of
11946 inserting an additional paragraph of bracketed text (#1747).
11947 + Parse math environments as inline when possible (#1821).
11948 + Better handling of `\noindent` and `\greektext` (#1783).
11949 + Handle `\texorpdfstring` more gracefully.
11950 + Handle `\cref` and `\sep` (Wikiwide).
11951 + Support `\smartcite` and `\Smartcite` from biblatex.
11953 * HTML reader:
11955 + Retain display type of MathML output (#1719, Matthew Pickering).
11956 + Recognise `<br>` tags inside `<pre>` blocks (#1620, Matthew Pickering).
11957 + Make `embed` tag either block or inline (#1756).
11959 * DocBook reader:
11961 + Handle `keycombo`, `keycap` (#1815).
11962 + Get string content in inner tags for literal elements (#1816).
11963 + Handle `menuchoice` elements better, with a `>` between (#1817).
11964 + Include `id` on section headers (#1818).
11965 + Document/test "type" as implemented (Brian O'Sullivan).
11966 + Add support for calloutlist and callout (Brian O'Sullivan).
11967 We treat a calloutlist as a bulleted list. This works well in practice.
11968 + Add support for `classname` (Bryan O'Sullivan).
11970 * Docx reader:
11972 + Fix window path for image lookup (Jesse Rosenthal).
11973 Don't use os-sensitive "combine", since we always want the paths in our
11974 zip-archive to use forward-slashes.
11975 + Single-item headers in ordered lists are headers (Jesse Rosenthal).
11976 When users number their headers, Word understands that as a single item
11977 enumerated list. We make the assumption that such a list is, in fact,
11978 a header.
11979 + Rewrite rewriteLink to work with new headers (Jesse Rosenthal).
11980 There could be new top-level headers after making lists, so we have to
11981 rewrite links after that.
11982 + Use polyglot header list (Jesse Rosenthal).
11983 We're just keeping a list of header formats that different languages
11984 use as their default styles. At the moment, we have English, German,
11985 Danish, and French. We can continue to add to this.
11986 This is simpler than parsing the styles file, and perhaps less
11987 error-prone, since there seems to be some variations, even within a
11988 language, of how a style file will define headers.
11989 + Remove header class properly in other langs (Jesse Rosenthal).
11990 When we encounter one of the polyglot header styles, we want to remove
11991 that from the par styles after we convert to a header. To do that, we
11992 have to keep track of the style name, and remove it appropriately.
11993 + Account for external link URLs with anchors. Previously, if a URL
11994 had an anchor, the reader would incorrectly identify it as an
11995 internal link and return only the anchor as URL. (Caleb McDaniel)
11996 + Fix for Issue #1692 (i18n styles) (Nikolay Yakimov).
11998 * Org reader:
12000 + Added state changing blanklines (Jesse Rosenthal).
12001 This allows us to emphasize at the beginning of a new paragraph (or, in
12002 general, after blank lines).
12003 + Fixed bug with bulleted lists:
12005 - a
12006 - b
12007 * c
12009 was being parsed as a list, even though an unindented `*`
12010 should make a heading. See
12011 <http://orgmode.org/manual/Plain-lists.html#fn-1>.
12012 + Org reader: absolute, relative paths in link (#1741, Albert
12013 Krewinkel). The org reader was too restrictive when parsing links;
12014 some relative links and links to files given as absolute paths
12015 were not recognized correctly.
12016 + Org reader: allow empty links (jgm/gitit#471, Albert Krewinkel).
12017 This is important for use in gitit, which uses empty links
12018 for wikilinks.
12019 + Respect indent when parsing Org bullet lists (#1650, Timothy
12020 Humphries). Fixes issue with top-level bullet list parsing.
12021 + Fix indent issue for definition lists (Timothy Humphries,
12022 see #1650, #1698, #1680).
12023 + Parse multi-inline terms correctly in definition list (#1649,
12024 Matthew Pickering).
12025 + Fix rules for emphasis recognition (Albert Krewinkel).
12026 Things like `/hello,/` or `/hi'/` were falsy recognized as emphasised
12027 strings. This is wrong, as `,` and `'` are forbidden border chars and
12028 may not occur on the inner border of emphasized text.
12029 + Drop COMMENT document trees (Albert Krewinkel).
12030 Document trees under a header starting with the word `COMMENT` are
12031 comment trees and should not be exported. Those trees are dropped
12032 silently (#1678).
12033 + Properly handle links to `file:target` (Albert Krewinkel).
12034 Org links like `[[file:target][title]]` were not handled correctly,
12035 parsing the link target verbatim. The org reader is changed such that
12036 the leading `file:` is dropped from the link target (see #756, #1812).
12037 + Parse LaTeX-style MathML entities (#1657, Albert Krewinkel).
12038 Org supports special symbols which can be included using LaTeX syntax,
12039 but are actually MathML entities. Examples for this are
12040 `\nbsp` (non-breaking space), `\Aacute` (the letter A with accent acute)
12041 or `\copy` (the copyright sign ©)
12043 * EPUB reader:
12045 + URI handling improvements. Now we outsource most of the work to
12046 `fetchItem'`. Also, do not include queries in file extensions (#1671).
12048 * LaTeX writer:
12050 + Use `\texorpdfstring` for section captions when needed (Vaclav Zeman).
12051 + Handle consecutive linebreaks (#1733).
12052 + Protect graphics in headers (Jesse Rosenthal).
12053 Graphics in `\section`/`\subsection` etc titles need to be `\protect`ed.
12054 + Put `~` before header in list item text (Jesse Rosenthal).
12055 Because of the built-in line skip, LaTeX can't handle a section header
12056 as the first element in a list item.
12057 + Avoid using reserved characters as `\lstinline` delimiters (#1595).
12058 + Better handling of display math in simple tables (#1754).
12059 We convert display math to inline math in simple tables,
12060 since LaTeX can't deal with display math in simple tables.
12061 + Escape spaces in code (#1694, Bjorn Buckwalter).
12063 * MediaWiki writer:
12065 + Fixed links with URL = text. Previously these were rendered as bare
12066 words, even if the URL was not an absolute URL (#1825).
12068 * ICML writer:
12070 + Don't force all citations into footnotes.
12072 * RTF writer:
12074 + Add blankline at end of output (#1732, Matthew Pickering).
12076 * RST writer:
12078 + Ensure blank line after figure.
12079 + Avoid exces whitespace after last list item (#1777).
12080 + Wrap line blocks with spaces before continuations (#1656).
12081 + Fixed double-rendering of footnotes in RST tables (#1769).
12083 * DokuWiki writer:
12085 + Better handling of block quotes. This change ensures that
12086 multiple paragraph blockquotes are rendered using native `>`
12087 rather than as HTML (#1738).
12088 + Fix external images (#1739). Preface relative links with ":",
12089 absolute URIs without. (Timothy Humphries)
12091 * HTML writer:
12093 + Use protocol-relative URL for mathjax.
12094 + Put newline btw img and caption paragraph.
12095 + MathML now outputted with tex annotation (#1635, Matthew Pickering).
12096 + Add support for KaTeX HTML math (#1626, Matthew Pickering).
12097 This adds `KaTeX` to `HTMLMathMethod` (API change).
12098 + Don't double render when `email-obfuscation=none` (#1625, Matthew
12099 Pickering).
12100 + Make header attributes work outside top level (#1711).
12101 Previously they only appeared on top level header elements.
12102 Now they work e.g. in blockquotes.
12104 * ODT writer:
12106 + Correctly handle images without extensions (#1729).
12107 + Strip querystring in ODT write (#1682, Todd Sifleet).
12109 * FB2 writer:
12111 + Add newline to output.
12113 * EPUB writer:
12115 + Don't add `sourceURL` to absolute URIs (#1669).
12116 + Don't use unsupported `opf:title-type` for epub2.
12117 + Include "landmarks" section in nav document for epub3 (#1757).
12118 + Removed playOrder from navpoint elements in ncx file (#1760).
12119 These aren't required, and they make manual modification of epubs
12120 difficult.
12121 + Extract title even from structured title.
12122 + Don't include nav node in spine unless `--toc` was requested.
12123 Previously we included it in the spine with `linear="no"`, leading
12124 to odd results in some readers (#1593).
12125 + Fixed absolute URI detection (#1672).
12126 + Correctly resolve relative URIs (#1671).
12127 + Use regular page template for `nav.xhtml`, including doctype (#1759).
12129 * Docx writer:
12131 + Put docx table captions above tables (#1641, Nikolay Yakimov).
12132 + Get the page width from the reference docx file, and use
12133 it to scale images that are too large to fit (Grégory Bataille).
12134 + Partial fix for #1607 (Nikolay Yakimov). International heading styles
12135 are inferred based on `<w:name val="heading #">` fallback, if there
12136 are no en-US "Heading#" styles
12137 + Look in user data dir for archive `reference.docx`.
12138 + Renumber header and footer relationships to avoid collisions (Jesse
12139 Rosenthal). We previously took the old relationship names of the
12140 headers and footer in secptr. That led to collisions. We now make
12141 a map of availabl names in the relationships file, and then rename
12142 in secptr.
12144 * ConTeXt writer:
12146 + Add function toLabel (Mark Szepieniec).
12147 This function can be used to sanitize reference labels so that
12148 they do not contain any of the illegal characters \#[]",{}%()|= .
12149 Currently only Links have their labels sanitized, because they
12150 are the only Elements that use passed labels.
12152 * `Text.Pandoc.Shared`:
12154 + Moved import of `toChunks` outside of CPP conditional (#1590).
12155 + Fix `inDirectory` to reset to the original directory in case
12156 an exception occurs (Freiric Barral).
12158 * Templates:
12160 + LaTeX template: load polyglossia before bibtex (jgm/pandoc-templates#70).
12161 Thanks to bluebirch.
12162 + LaTeX template: Added `\VerbatimFootnotes` if there is verbatim in notes
12163 (#1616).
12164 + LaTeX template: Add shorthands=off to babel options (#1648).
12165 + EPUB, EPUB3 templates: Added `id="cover"` to body of cover page.
12166 This aids styling, making it possible for example to set 0 margins
12167 on the title page (#1758).
12168 + EPUB, EPUB3 templates: Handle structured metadata on titlepage.
12169 Previously we just expected 'title', 'subtitle', 'author', 'date'.
12170 Now we still support those, but also support the format recommended
12171 for epub metadata in the pandoc README:
12173 ---
12174 title:
12175 - type: main
12176 text: My Book
12177 - type: subtitle
12178 text: An investigation of metadata
12179 creator:
12180 - role: author
12181 text: John Smith
12182 - role: editor
12183 text: Sarah Jones
12184 identifier:
12185 - scheme: DOI
12186 text: doi:10.234234.234/33
12187 publisher: My Press
12188 rights: (c) 2007 John Smith, CC BY-NC
12189 ...
12191 * `Text.Pandoc.Templates.getDefaultTemplate`:
12192 don't fail when called with "fb2" (#1660).
12194 * `Text.Pandoc.Parsing`:
12196 + Fixed `inlineMath` so it handles `\text{..}` containing `$`.
12197 For example: `$x = \text{the $n$th root of $y$}` (#1677).
12198 + Change `parseFromString` to fail if not all input is consumed.
12199 (Matthew Pickering)
12200 + Moved `addWarning` from Markdown reader to `Parsing`, so it can be
12201 used by more readers (API change, Daniel Bergey).
12203 * `Text.Pandoc.Pretty`:
12205 + Improve performance of `realLength` (Matthew Pickering).
12206 + Make CR + BLANKLINE = BLANKLINE. This fixes an extra blank line we
12207 were getting at the end of markdown fragments (as well as rst, org,
12208 etc.) (#1705).
12210 * `Text.Pandoc.MIME`:
12212 + Add mime type for WebVTT (Jason Ronallo).
12213 + Changed mime type for `otf` to `application/vnd.ms-opentype` (#1761).
12214 This is needed for epub3 validation.
12216 * `Text.Pandoc.MediaBag`:
12218 + Fix Windows specific path problems (#1597).
12220 * `Text.Pandoc.Shared`:
12222 + Make `collapseFilePath` OS-agnostic (Matthew Pickering).
12224 * Link the test suite using `-threaded`.
12225 This allows the test suite to be run using `+RTS -N`.
12227 * Added `network` dependency under `network-uri` flag in test section.
12229 * Give better error messages when someone tries to convert from
12230 pdf, doc, odt (#1683).
12232 * Added `track` to list of tags treated by `--self-contained` (#1664).
12235## pandoc 1.13.1 (2014-08-30)
12237 * Fixed `--self-contained` with Windows paths (#1558).
12238 Previously `C:\foo.js` was being wrongly interpreted as a URI.
12240 * HTML reader: improved handling of tags that can be block or inline.
12241 Previously a section like this would be enclosed in a paragraph,
12242 with RawInline for the video tags (since video is a tag that can
12243 be either block or inline):
12245 <video controls="controls">
12246 <source src="../videos/test.mp4" type="video/mp4" />
12247 <source src="../videos/test.webm" type="video/webm" />
12248 <p>
12249 The videos can not be played back on your system.<br/>
12250 Try viewing on Youtube (requires Internet connection):
12251 <a href="http://youtu.be/etE5urBps_w">Relative Velocity on
12252 Youtube</a>.
12253 </p>
12254 </video>
12256 This change will cause the video and source tags to be parsed
12257 as RawBlock instead, giving better output.
12258 The general change is this: when we're parsing a "plain" sequence
12259 of inlines, we don't parse anything that COULD be a block-level tag.
12261 * Docx reader:
12263 + Be sensitive to user styles. Note that "Hyperlink" is
12264 "blacklisted," as we don't want the default underline styling to be
12265 inherited by all links by default (Jesse Rosenthal).
12266 + Read single paragraph in table cell as `Plain` (Jesse Rosenthal).
12267 This makes to docx reader's native output fit with the way the markdown
12268 reader understands its markdown output.
12270 * Txt2Tags reader:
12272 + Header is now parsed only if standalone flag is set (Matthew Pickering).
12273 + The header is now parsed as meta information. The first line is the
12274 `title`, the second is the `author` and third line is the `date`
12275 (Matthew Pickering).
12276 + Corrected formatting of `%%mtime` macro (Matthew Pickering).
12277 + Fixed crash when reading from stdin.
12279 * Textile writer: Extended the range of cases where native textile
12280 tables will be used (as opposed to raw HTML): we now handle any
12281 alignment type, but only for simple tables with no captions.
12283 * EPUB writer: Don't use page-progression-direction in EPUB2, which
12284 doesn't support it. Also, if page-progression-direction not specified
12285 in metadata, don't include the attribute even in EPUB3; not including it
12286 is the same as including it with the value "default", as we did before.
12287 (#1550)
12289 * Org writer: Accept example lines with indentation at the beginning
12290 (Calvin Beck).
12292 * DokuWiki writer:
12294 + Refactor to use Reader monad (Matthew Pickering).
12295 + Avoid using raw HTML in table cells; instead, use `\\`
12296 instead of newlines (Jesse Rosenthal).
12297 + Properly handle HTML table cell alignments, and use spacing
12298 to make the tables look prettier (#1566).
12300 * Docx writer:
12302 + Bibliography entries get `Bibliography` style (#1559).
12303 + Implement change tracking (Jesse Rosenthal).
12305 * LaTeX writer:
12307 + Fixed a bug that caused a table caption to repeat across all pages
12308 (Jose Luis Duran).
12309 + Improved vertical spacing in tables and made it customizable using
12310 standard lengths set by booktab. See
12311 <https://groups.google.com/forum/#!msg/pandoc-discuss/qMu6_5lYy0o/ZAU7lzAIKw0J>
12312 (Jose Luis Duran).
12313 + Added `\strut` to fix spacing in multiline tables (Jose Luis Duran).
12314 + Use `\tabularnewline` instead of `\\` in table cells (Jose Luis Duran).
12315 + Made horizontal rules more flexible (Jose Luis Duran).
12317 * Text.Pandoc.MIME:
12319 + Added `MimeType` (type synonym for `String`) and `getMimeTypeDef`.
12320 Code cleanups (Artyom Kazak).
12322 * Templates:
12324 + LaTeX template: disable microtype protrusion for typewriter font (#1549,
12325 thanks lemzwerg).
12327 * Improved OSX build procedure.
12329 * Added `network-uri` flag, to deal with split of `network-uri` from
12330 `network`.
12332 * Fix build dependencies for the `trypandoc` flag, so that they are
12333 ignored if `trypandoc` flag is set to False (Gabor Pali).
12335 * Updated README to remove outdated claim that `--self-contained`
12336 looks in the user data directory for missing files.
12338## pandoc 1.13.0.1 (2014-08-17)
12340 * Docx writer:
12342 + Fixed regression which bungled list numbering (#1544), causing
12343 all lists to appear as basic ordered lists.
12344 + Include row width in table rows (Christoffer Ackelman, Viktor Kronvall).
12345 Added a property to all table rows where the sum of column widths
12346 is specified in pct (fraction of 5000). This helps persuade Word
12347 to lay out the table with the widths we specify.
12349 * Fixed a bug in Windows 8 which caused pandoc not to find the
12350 `pandoc-citeproc` filter (#1542).
12352 * Docx reader: miscellaneous under-the-hood improvements (Jesse Rosenthal).
12353 Most significantly, the reader now uses Builder, leading to some
12354 performance improvements.
12356 * HTML reader: Parse appropriately styled span as SmallCaps.
12358 * Markdown writer: don't escape `$`, `^`, `~` when `tex_math_dollars`,
12359 `superscript`, and `subscript` extensions, respectively, are
12360 deactivated (#1127).
12362 * Added `trypandoc` flag to build CGI executable used in the online
12363 demo.
12365 * Makefile: Added 'quick', 'osxpkg' targets.
12367 * Updated README in templates to indicate templates license.
12368 The templates are dual-licensed, BSD3 and GPL2+.
12370## pandoc 1.13 (15 August 2014)
12372### New features
12374 * Added `docx` as an input format (Jesse Rosenthal). The docx
12375 reader includes conversion of native Word equations to pandoc
12376 LaTeX `Math` elements. Metadata is taken from paragraphs at the
12377 beginning of the document with styles `Author`, `Title`, `Subtitle`,
12378 `Date`, and `Abstract`.
12380 * Added `epub` as an input format (Matthew Pickering). The epub
12381 reader includes conversion of MathML to pandoc LaTeX `Math`
12382 elements.
12384 * Added `t2t` (Txt2Tags) as an input format (Matthew Pickering).
12385 Txt2tags is a lightweight markup format described at
12386 <http://txt2tags.org/>.
12388 * Added `dokuwiki` as an output format (Clare Macrae).
12390 * Added `haddock` as an output format.
12392 * Added `--extract-media` option to extract media contained in a zip
12393 container (docx or epub) while adjusting image paths to point to the
12394 extracted images.
12396 * Added a new markdown extension, `compact_definition_lists`, that
12397 restores the syntax for definition lists of pandoc 1.12.x, allowing
12398 tight definition lists with no blank space between items, and
12399 disallowing lazy wrapping. (See below under behavior changes.)
12401 * Added an extension `epub_html_exts` for parsing HTML in EPUBs.
12403 * Added extensions `native_spans` and `native_divs` to activate
12404 parsing of material in HTML span or div tags as Pandoc Span
12405 inlines or Div blocks.
12407 * `--trace` now works with the Markdown, HTML, Haddock, EPUB,
12408 Textile, and MediaWiki readers. This is an option intended
12409 for debugging parsing problems; ordinary users should not need
12410 to use it.
12412### Behavior changes
12414 * Changed behavior of the `markdown_attribute` extension, to bring
12415 it in line with PHP markdown extra and multimarkdown. Setting
12416 `markdown="1"` on an outer tag affects all contained tags,
12417 recursively, until it is reversed with `markdown="0"` (#1378).
12419 * Revised markdown definition list syntax (#1429). Both the reader
12420 and writer are affected. This change brings pandoc's definition list
12421 syntax into alignment with that used in PHP markdown extra and
12422 multimarkdown (with the exception that pandoc is more flexible about
12423 the definition markers, allowing tildes as well as colons). Lazily
12424 wrapped definitions are now allowed. Blank space is required
12425 between list items. The space before a definition is used to determine
12426 whether it is a paragraph or a "plain" element. **WARNING: This change
12427 may break existing documents!** Either check your documents for
12428 definition lists without blank space between items, or use
12429 `markdown+compact_definition_lists` for the old behavior.
12431 * `.numberLines` now works in fenced code blocks even if no language
12432 is given (#1287, jgm/highlighting-kate#40).
12434 * Improvements to `--filter`:
12436 + Don't search PATH for a filter with an explicit path.
12437 This fixed a bug wherein `--filter ./caps.py` would run `caps.py` from
12438 the system path, even if there was a `caps.py` in the working directory.
12439 + Respect shebang if filter is executable (#1389).
12440 + Don't print misleading error message.
12441 Previously pandoc would say that a filter was not found,
12442 even in a case where the filter had a syntax error.
12444 * HTML reader:
12446 + Parse `div` and `span` elements even without `--parse-raw`,
12447 provided `native_divs` and `native_spans` extensions are set.
12448 Motivation: these now generate native pandoc Div and Span
12449 elements, not raw HTML.
12450 + Parse EPUB-specific elements if the `epub_html_exts`
12451 extension is enabled. These include `switch`, `footnote`,
12452 `rearnote`, `noteref`.
12454 * Org reader:
12456 + Support for inline LaTeX. Inline LaTeX is now accepted and parsed by the
12457 org-mode reader. Both math symbols (like `\tau`) and LaTeX commands (like
12458 `\cite{Coffee}`), can be used without any further escaping (Albert
12459 Krewinkel).
12461 * Textile reader and writer:
12463 + The `raw_tex` extension is no longer set by default. You can
12464 enable it with `textile+raw_tex`.
12466 * DocBook reader:
12468 + Support `equation`, `informalequation`, `inlineequation` elements with
12469 `mml:math` content. This is converted into LaTeX and put into a Pandoc
12470 Math inline.
12472 * Revised `plain` output, largely following the style of Project
12473 Gutenberg:
12475 + Emphasis is rendered with `_underscores_`, strong emphasis
12476 with ALL CAPS.
12477 + Headings are rendered differently, with space to set them off,
12478 not with setext style underlines. Level 1 headers are ALL CAPS.
12479 + Math is rendered using unicode when possible, but without the
12480 distracting emphasis markers around variables.
12481 + Footnotes use a regular `[n]` style.
12483 * Markdown writer:
12485 + Horizontal rules are now a line across the whole page.
12486 + Prettier pipe tables. Columns are now aligned (#1323).
12487 + Respect the `raw_html` extension. `pandoc -t markdown-raw_html`
12488 no longer emits any raw HTML, including span and div tags
12489 generated by Span and Div elements.
12490 + Use span with style for `SmallCaps` (#1360).
12492 * HTML writer:
12494 + Autolinks now have class `uri`, and email autolinks have class
12495 `email`, so they can be styled.
12497 * Docx writer:
12499 + Document formatting is carried over from `reference.docx`.
12500 This includes margins, page size, page orientation, header,
12501 and footer, including images in headers and footers.
12502 + Include abstract (if present) with `Abstract` style (#1451).
12503 + Include subtitle (if present) with `Subtitle` style, rather
12504 than tacking it on to the title (#1451).
12506 * Org writer:
12508 + Write empty span elements with an id attribute as org anchors.
12509 For example `Span ("uid",[],[]) []` becomes `<<uid>>`.
12511 * LaTeX writer:
12513 + Put table captions above tables, to match the conventional
12514 standard. (Previously they appeared below tables.)
12515 + Use `\(..\)` instead of `$..$` for inline math (#1464).
12516 + Use `\nolinkurl` in email autolinks. This allows them to be styled
12517 using `\urlstyle{tt}`. Thanks to Ulrike Fischer for the solution.
12518 + Use `\textquotesingle` for `'` in inline code. Otherwise we get
12519 curly quotes in the PDF output (#1364).
12520 + Use `\footnote<.>{..}` for notes in beamer, so that footnotes
12521 do not appear before the overlays in which their markers appear
12522 (#1525).
12523 + Don't produce a `\label{..}` for a Div or Span element. Do produce
12524 a `\hyperdef{..}` (#1519).
12526 * EPUB writer:
12528 + If the metadata includes `page-progression-direction` (which can be
12529 `ltr` or `rtl`, the `page-progression-direction` attribute will
12530 be set in the EPUB spine (#1455).
12532 * Custom lua writers:
12534 + Custom writers now work with `--template`.
12535 + Removed HTML header scaffolding from `sample.lua`.
12536 + Made citation information available in lua writers.
12538 * `--normalize` and `Text.Pandoc.Shared.normalize` now consolidate
12539 adjacent `RawBlock`s when possible.
12541### API changes
12543 * Added `Text.Pandoc.Readers.Docx`, exporting `readDocx` (Jesse Rosenthal).
12545 * Added `Text.Pandoc.Readers.EPUB`, exporting `readEPUB` (Matthew
12546 Pickering).
12548 * Added `Text.Pandoc.Readers.Txt2Tags`, exporting `readTxt2Tags` (Matthew
12549 Pickering).
12551 * Added `Text.Pandoc.Writers.DokuWiki`, exporting `writeDokuWiki`
12552 (Clare Macrae).
12554 * Added `Text.Pandoc.Writers.Haddock`, exporting `writeHaddock`.
12556 * Added `Text.Pandoc.MediaBag`, exporting `MediaBag`, `lookupMedia`,
12557 `insertMedia`, `mediaDirectory`, `extractMediaBag`. The docx and epub
12558 readers return a pair of a `Pandoc` document and a `MediaBag` with
12559 the media resources they contain. This can be extracted using
12560 `--extract-media`. Writers that incorporate media (PDF, Docx,
12561 ODT, EPUB, RTF, or HTML formats with `--self-contained`) will look
12562 for resources in the `MediaBag` generated by the reader, in addition to
12563 the file system or web.
12565 * `Text.Pandoc.Readers.TexMath`: Removed deprecated `readTeXMath`.
12566 Renamed `readTeXMath'` to `texMathToInlines`.
12568 * `Text.Pandoc`: Added `Reader` data type (Matthew Pickering).
12569 `readers` now associates names of readers with `Reader`
12570 structures. This allows inclusion of readers, like the docx
12571 reader, that take binary rather than textual input.
12573 * `Text.Pandoc.Shared`:
12575 + Added `capitalize` (Artyom Kazak), and replaced uses of
12576 `map toUpper` (which give bad results for many languages).
12577 + Added `collapseFilePath`, which removes intermediate `.` and
12578 `..` from a path (Matthew Pickering).
12579 + Added `fetchItem'`, which works like `fetchItem` but searches
12580 a `MediaBag` before looking on the net or file system.
12581 + Added `withTempDir`.
12582 + Added `removeFormatting`.
12583 + Added `extractSpaces` (from HTML reader) and generalized its type
12584 so that it can be used by the docx reader (Matthew Pickering).
12585 + Added `ordNub`.
12586 + Added `normalizeInlines`, `normalizeBlocks`.
12587 + `normalize` is now `Pandoc -> Pandoc` instead of
12588 `Data a :: a -> a`. Some users may need to change their uses of
12589 `normalize` to the newly exported `normalizeInlines` or
12590 `normalizeBlocks`.
12592 * `Text.Pandoc.Options`:
12594 + Added `writerMediaBag` to `WriterOptions`.
12595 + Removed deprecated and no longer used `readerStrict` in
12596 `ReaderOptions`. This is handled by `readerExtensions` now.
12597 + Added `Ext_compact_definition_lists`.
12598 + Added `Ext_epub_html_exts`.
12599 + Added `Ext_native_divs` and `Ext_native_spans`.
12600 This allows users to turn off the default pandoc behavior of
12601 parsing contents of div and span tags in markdown and HTML
12602 as native pandoc Div blocks and Span inlines.
12604 * `Text.Pandoc.Parsing`:
12606 + Generalized `readWith` to `readWithM` (Matthew Pickering).
12607 + Export `runParserT` and `Stream` (Matthew Pickering).
12608 + Added `HasQuoteContext` type class (Matthew Pickering).
12609 + Generalized types of `mathInline`, `smartPunctuation`, `quoted`,
12610 `singleQuoted`, `doubleQuoted`, `failIfInQuoteContext`,
12611 `applyMacros` (Matthew Pickering).
12612 + Added custom `token` (Matthew Pickering).
12613 + Added `stateInHtmlBlock` to `ParserState`. This is used to keep
12614 track of the ending tag we're waiting for when we're parsing inside
12615 HTML block tags.
12616 + Added `stateMarkdownAttribute` to `ParserState`. This is used
12617 to keep track of whether the markdown attribute has been set in
12618 an enclosing tag.
12619 + Generalized type of `registerHeader`, using new type classes
12620 `HasReaderOptions`, `HasIdentifierList`, `HasHeaderMap` (Matthew
12621 Pickering). These allow certain common functions to be reused
12622 even in parsers that use custom state (instead of `ParserState`),
12623 such as the MediaWiki reader.
12624 + Moved `inlineMath`, `displayMath` from Markdown reader to Parsing,
12625 and generalized their types (Matthew Pickering).
12627 * `Text.Pandoc.Pretty`:
12629 + Added `nestle`.
12630 + Added `blanklines`, which guarantees a certain number of blank lines
12631 (and no more).
12633### Bug fixes
12635 * Markdown reader:
12637 + Fixed parsing of indented code in list items. Indented code
12638 at the beginning of a list item must be indented eight spaces
12639 from the margin (or edge of the container), or four spaces
12640 from the list marker, whichever is greater.
12641 + Fixed small bug in HTML parsing with `markdown_attribute`, which
12642 caused incorrect tag nesting for input like
12643 `<aside markdown="1">*hi*</aside>`.
12644 + Fixed regression with intraword underscores (#1121).
12645 + Improved parsing of inline links containing quote characters (#1534).
12646 + Slight rewrite of `enclosure`/`emphOrStrong` code.
12647 + Revamped raw HTML block parsing in markdown (#1330).
12648 We no longer include trailing spaces and newlines in the
12649 raw blocks. We look for closing tags for elements (but without
12650 backtracking). Each block-level tag is its own `RawBlock`;
12651 we no longer try to consolidate them (though `--normalize` will do so).
12652 + Combine consecutive latex environments. This helps when you have
12653 two minipages which can't have blank lines between them (#690, #1196).
12654 + Support smallcaps through span.
12655 `<span style="font-variant:small-caps;">foo</span>` will be
12656 parsed as a `SmallCaps` inline, and will work in all output
12657 formats that support small caps (#1360).
12658 + Prevent spurious line breaks after list items (#1137). When the
12659 `hard_line_breaks` option was specified, pandoc would formerly
12660 produce a spurious line break after a tight list item.
12661 + Fixed table parsing bug (#1333).
12662 + Handle `c++` and `objective-c` as language identifiers in
12663 github-style fenced blocks (#1318).
12664 + Inline math must have nonspace before final `$` (#1313).
12666 * LaTeX reader:
12668 + Handle comments at the end of tables. This resolves the issue
12669 illustrated in <http://stackoverflow.com/questions/24009489>.
12670 + Correctly handle table rows with too few cells. LaTeX seems to
12671 treat them as if they have empty cells at the end (#241).
12672 + Handle leading/trailing spaces in `\emph` better.
12673 `\emph{ hi }` gets parsed as `[Space, Emph [Str "hi"], Space]`
12674 so that we don't get things like `* hi *` in markdown output.
12675 Also applies to `textbf` and some other constructions (#1146).
12676 + Don't assume preamble doesn't contain environments (#1338).
12677 + Allow (and discard) optional argument for `\caption` (James Aspnes).
12679 * HTML reader:
12681 + Fixed major parsing problem with HTML tables. Table cells were
12682 being combined into one cell (#1341).
12683 + Fixed performance issue with malformed HTML tables.
12684 We let a `</table>` tag close an open `<tr>` or `<td>` (#1167).
12685 + Allow space between `<col>` and `</col>`.
12686 + Added `audio` and `source` in `eitherBlockOrInline`.
12687 + Moved `video`, `svg`, `progress`, `script`, `noscript`, `svg` from
12688 `blockTags` to `eitherBlockOrInline`.
12689 + `map` and `object` were mistakenly in both lists; they have been removed
12690 from `blockTags`.
12691 + Ignore `DOCTYPE` and `xml` declarations.
12693 * MediaWiki reader:
12695 + Don't parse backslash escapes inside `<source>` (#1445).
12696 + Tightened up template parsing.
12697 The opening `{{` must be followed by an alphanumeric or `:`.
12698 This prevents the exponential slowdown in #1033.
12699 + Support "Bild" for images.
12701 * DocBook reader:
12703 + Better handle elements inside code environments. Pandoc's document
12704 model does not allow structure inside code blocks, but at least this way
12705 we preserve the text (#1449).
12706 + Support `<?asciidoc-br?>` (#1236).
12708 * Textile reader:
12710 + Fixed list parsing. Lists can now start without an intervening
12711 blank line (#1513).
12712 + HTML block-level tags that do not start a line are parsed as
12713 inline HTML and do not interrupt paragraphs (as in RedCloth).
12715 * Org reader:
12717 + Make tildes create inline code (#1345). Also relabeled `code` and
12718 `verbatim` parsers to accord with the org-mode manual.
12719 + Respect `:exports` header argument in code blocks (Craig Bosma).
12720 + Fixed tight lists with sublists (#1437).
12722 * EPUB writer:
12724 + Avoid excess whitespace in `nav.xhtml`. This should improve
12725 TOC view in iBooks (#1392).
12726 + Fixed regression on cover image.
12727 In 1.12.4 and 1.12.4.2, the cover image would not appear properly,
12728 because the metadata id was not correct. Now we derive the id from the
12729 actual cover image filename, which we preserve rather than using
12730 "cover-image."
12731 + Keep newlines between block elements. This allows
12732 easier diff-ability (#1424).
12733 + Use `stringify` instead of custom `plainify`.
12734 + Use `renderTags'` for all tag rendering. This properly handles tags
12735 that should be self-closing. Previously `<hr/>` would appear in EPUB
12736 output as `<hr></hr>` (#1420).
12737 + Better handle HTML media tags.
12738 + Handle multiple dates with OPF `event` attributes. Note: in EPUB3 we
12739 can have only one dc:date, so only the first one is used.
12741 * LaTeX writer:
12743 + Correctly handle figures in notes. Notes can't contain figures in
12744 LaTeX, so we fake it to avoid an error (#1053).
12745 + Fixed strikeout + highlighted code (#1294).
12746 Previously strikeout highlighted code caused an error.
12748 * ConTeXt writer:
12750 + Improved detection of autolinks with URLs containing escapes.
12752 * RTF writer:
12754 + Improved image embedding: `fetchItem'` is now used to get the
12755 images, and calculated image sizes are indicated in the RTF.
12756 + Avoid extra paragraph tags in metadata (#1421).
12758 * HTML writer:
12760 + Deactivate "incremental" inside slide speaker notes (#1394).
12761 + Don't include empty items in the table of contents for
12762 slide shows. (These would result from creating a slide
12763 using a horizontal rule.)
12765 * MediaWiki writer:
12767 + Minor renaming of `st` prefixed names.
12769 * AsciiDoc writer:
12771 + Double up emphasis and strong emphasis markers in intraword
12772 contexts, as required by asciidoc (#1441).
12774 * Markdown writer:
12776 + Avoid wrapping that might start a list, blockquote, or header (#1013).
12777 + Use Span instead of (hackish) `SmallCaps` in `plainify`.
12778 + Don't use braced attributes for fenced code (#1416).
12779 If `Ext_fenced_code_attributes` is not set, the first class
12780 attribute will be printed after the opening fence as a bare word.
12781 + Separate adjacent lists of the same kind with an HTML comment (#1458).
12783 * PDF writer:
12785 + Fixed treatment of data uris for images (#1062).
12787 * Docx writer:
12789 + Use Compact style for empty table cells (#1353).
12790 Otherwise we get overly tall lines when there are empty
12791 table cells and the other cells are compact.
12792 + Create overrides per-image for `media/` in reference docx.
12793 This should be somewhat more robust and cover more types of images.
12794 + Improved `entryFromArchive` to avoid an unneeded parse.
12795 + Section numbering carries over from reference.docx (#1305).
12796 + Simplified `abstractNumId` numbering. Instead of sequential numbering,
12797 we assign numbers based on the list marker styles.
12799 * `Text.Pandoc.Options`:
12801 + Removed `Ext_fenced_code_attributes` from `markdown_github`
12802 extensions.
12804 * `Text.Pandoc.ImageSize`:
12806 + Use default instead of failing if image size not found
12807 in exif header (#1358).
12808 + ignore unknown exif header tag rather than crashing.
12809 Some images seem to have tag type of 256, which was causing
12810 a runtime error.
12812 * `Text.Pandoc.Shared`:
12814 + `fetchItem`: unescape URI encoding before reading local file (#1427).
12815 + `fetchItem`: strip a fragment like `?#iefix` from the extension before
12816 doing mime lookup, to improve mime type guessing.
12817 + Improved logic of `fetchItem`: absolute URIs are fetched from the net;
12818 other things are treated as relative URIs if `sourceURL` is `Just _`,
12819 otherwise as file paths on the local file system.
12820 + `fetchItem` now properly handles links without a protocol (#1477).
12821 + `fetchItem` now escapes characters not allowed in URIs before trying
12822 to parse the URIs.
12823 + Fixed runtime error with `compactify'DL` on certain lists (#1452).
12825 * `pandoc.hs`: Don't strip path off of `writerSourceURL`: the path is
12826 needed to resolve relative URLs when we fetch resources (#750).
12828 * `Text.Pandoc.Parsing`
12830 + Simplified `dash` and `ellipsis` (#1419).
12831 + Removed `(>>~)` in favor of the equivalent `(<*)` (Matthew Pickering).
12832 + Generalized functions to use `ParsecT` (Matthew Pickering).
12833 + Added `isbn` and `pmid` to list of recognized schemes (Matthew
12834 Pickering).
12836### Template changes
12838 * Added haddock template.
12839 * EPUB3: Added `type` attribute to `link` tags. They are supposed to
12840 be "advisory" in HTML5, but kindlegen seems to require them.
12841 * EPUB3: Put title page in section with `epub:type="titlepage"`.
12842 * LaTeX: Made `\subtitle` work properly (#1327).
12843 * LaTeX/Beamer: remove conditional around date (#1321).
12844 * LaTeX: Added `lot` and `lof` variables, which can be set to
12845 get `\listoftables` and `\listoffigures` (#1407). Note that
12846 these variables can be set at the command line with `-Vlot -Vlof`
12847 or in YAML metadata.
12849### Under the hood improvements
12851 * Rewrote normalize for efficiency (#1385).
12853 * Rewrote Haddock reader to use `haddock-library` (#1346).
12855 + This brings pandoc's rendering of haddock markup in line
12856 with the new haddock.
12857 + Fixed line breaks in `@` code blocks.
12858 + alex and happy are no longer build-depends.
12860 * Added `Text.Pandoc.Compat.Directory` to allow building against
12861 different versions of the `directory` library.
12863 + Added `Text.Pandoc.Compat.Except` to allow building against
12864 different verions of `mtl`.
12866 * Code cleanup in some writers, using Reader monad to avoid
12867 passing options parameter around (Matej Kollar).
12869 * Improved readability in `pandoc.hs`.
12871 * Miscellaneous code cleanups (Artyom Kazak).
12873 * Avoid `import Prelude hiding (catch)` (#1309, thanks to Michael
12874 Thompson).
12876 * Changed `http-conduit` flag to `https`. Depend on `http-client`
12877 and `http-client-tls` instead of `http-conduit`. (Note: pandoc still
12878 depends on `conduit` via `yaml`.)
12880 * Require `highlighting-kate >= 0.5.8.5` (#1271, #1317, Debian #753299).
12881 This change to highlighting-kate means that PHP fragments no longer need
12882 to start with `<?php`. It also fixes a serious bug causing failures with
12883 ocaml and fsharp.
12885 * Require latest `texmath`. This fixes `\tilde{E}` and allows
12886 `\left` to be used with `]`, `)` etc. (#1319), among many other
12887 improvements.
12889 * Require latest `zip-archive`. This has fixes for unicode path names.
12891 * Added tests for plain writer.
12893 * `Text.Pandoc.Templates`:
12895 + Fail informatively on template syntax errors.
12896 With the move from parsec to attoparsec, we lost good error
12897 reporting. In fact, since we weren't testing for end of input,
12898 malformed templates would fail silently. Here we revert back to
12899 Parsec for better error messages.
12900 + Use `ordNub` (#1022).
12902 * Benchmarks:
12904 + Made benchmarks compile again (Artyom Kazak).
12905 + Fixed so that the failure of one benchmark does not prevent others
12906 from running (Artyom Kazak).
12907 + Use `nfIO` instead of the `getLength` trick to force full evaluation.
12908 + Changed benchmark to use only the test suite, so that benchmarks
12909 run more quickly.
12911 * Windows build script:
12913 + Add `-windows` to file name.
12914 + Use one install command for pandoc, pandoc-citeproc.
12915 + Force install of pandoc-citeproc.
12917 * `make_osx_package`: Call zip file `pandoc-VERSION-osx.zip`.
12918 The zip should not be named `SOMETHING.pkg.zip`, or OSX finder
12919 will extract it into a folder named `SOMETHING.pkg`, which it
12920 will interpret as a defective package (#1308).
12922 * `README`:
12924 + Made headers for all extensions so they have IDs and can be
12925 linked to (Beni Cherniavsky-Paskin).
12926 + Fixed typos (Phillip Alday).
12927 + Fixed documentation of attributes (#1315).
12928 + Clarified documentation on small caps (#1360).
12929 + Better documentation for `fenced_code_attributes` extension
12930 (Caleb McDaniel).
12931 + Documented fact that you can put YAML metadata in a separate file
12932 (#1412).
12935## pandoc 1.12.4.2 (2014-05-14)
12937 * Require highlighting-kate >= 0.5.8. Fixes a performance regression.
12939 * Shared: `addMetaValue` now behaves slightly differently:
12940 if both the new and old values are lists, it concatenates their
12941 contents to form a new list.
12943 * LaTeX reader:
12945 + Set `bibliography` in metadata from `\bibliography` or
12946 `\addbibresource` command.
12947 + Don't error on `%foo` with no trailing newline.
12949 * Org reader:
12951 + Support code block headers (`#+BEGIN_SRC ...`) (Albert Krewinkel).
12952 + Fix parsing of blank lines within blocks (Albert Krewinkel).
12953 + Support pandoc citation extension (Albert Krewinkel). This can
12954 be turned off by specifying `org-citation` as the input format.
12956 * Markdown reader:
12958 + `citeKey` moved to `Text.Pandoc.Parsing` so it can be used by
12959 other readers (Albert Krewinkel).
12961 * `Text.Pandoc.Parsing`:
12963 + Added `citeKey` (see above).
12964 + Added `HasLastStrPosition` type class and `updateLastStrPos`
12965 and `notAfterString` functions.
12967 * Updated copyright notices (Albert Krewinkel).
12969 * Added default.icml to data files so it installs with the package.
12971 * OSX package:
12973 + The binary is now built with options to ensure that it can be
12974 used with OSX 10.6+.
12975 + Moved OSX package materials to osx directory.
12976 + Added OSX package uninstall script, included in the zip container
12977 (thanks to Daniel T. Staal).
12979## pandoc 1.12.4 (2014-05-07)
12981 * Made it possible to run filters that aren't executable
12982 (#1096). Pandoc first tries to find the executable (searching
12983 the path if path isn't given). If it fails, but the file
12984 exists and has a `.py`, `.pl`, `.rb`, `.hs`, or `.php`
12985 extension, pandoc runs the filter using the appropriate
12986 interpreter. This should make it easier to use filters on
12987 Windows, and make it more convenient for everyone.
12989 * Added Emacs org-mode reader (Albert Krewinkel).
12991 * Added InDesign ICML Writer (mb21).
12993 * MediaWiki reader:
12995 + Accept image links in more languages (Jaime Marquínez Ferrándiz).
12996 + Fixed bug in certain nested lists (#1213). If a level 2 list was
12997 followed by a level 1 list, the first item of the level 1 list
12998 would be lost.
12999 + Handle table rows containing just an HTML comment (#1230).
13001 * LaTeX reader:
13003 + Give better location information on errors, pointing to line
13004 numbers within included files (#1274).
13005 + LaTeX reader: Better handling of `table` environment (#1204).
13006 Positioning options no longer rendered verbatim.
13007 + Better handling of figure and table with caption (#1204).
13008 + Handle `@{}` and `p{length}` in tabular. The length is not actually
13009 recorded, but at least we get a table (#1180).
13010 + Properly handle `\nocite`. It now adds a `nocite` metadata
13011 field. Citations there will appear in the bibliography but not
13012 in the text (unless you explicitly put a `$nocite$` variable
13013 in your template).
13015 * Markdown reader:
13017 + Ensure that whole numbers in YAML metadata are rendered without
13018 decimal points. (This became necessary with changes to aeson
13019 and yaml libraries. aeson >= 0.7 and yaml >= 0.8.8.2 are now required.)
13020 + Fixed regression on line breaks in strict mode (#1203).
13021 + Small efficiency improvements.
13022 + Improved parsing of nested `div`s. Formerly a closing `div` tag
13023 would be missed if it came right after other block-level tags.
13024 + Avoid backtracking when closing `</div>` not found.
13025 + Fixed bug in reference link parsing in `markdown_mmd`.
13026 + Fixed a bug in list parsing (#1154). When reading a raw list
13027 item, we now strip off up to 4 spaces.
13028 + Fixed parsing of empty reference link definitions (#1186).
13029 + Made one-column pipe tables work (#1218).
13031 * Textile reader:
13033 + Better support for attributes. Instead of being ignored, attributes
13034 are now parsed and included in Span inlines. The output will be a bit
13035 different from stock textile: e.g. for `*(foo)hi*`, we'll get
13036 `<em><span class="foo">hi</span></em>` instead of
13037 `<em class="foo">hi</em>`. But at least the data is not lost.
13038 + Improved treatment of HTML spans (%) (#1115).
13039 + Improved link parsing. In particular we now pick up on attributes.
13040 Since pandoc links can't have attributes, we enclose the whole link in
13041 a span if there are attributes (#1008).
13042 + Implemented correct parsing rules for inline markup (#1175, Matthew
13043 Pickering).
13044 + Use Builder (Matthew Pickering).
13046 * DocBook reader:
13048 + Better treatment of `formalpara`. We now emit the title (if present)
13049 as a separate paragraph with boldface text (#1215).
13050 + Set metadata `author` not `authors`.
13051 + Added recognition of `authorgroup` and `releaseinfo` elements (#1214,
13052 Matthew Pickering).
13053 + Converted current meta information parsing in DocBook to a more
13054 extensible version which is aware of the more recent meta
13055 representation (Matthew Pickering).
13057 * HTML reader:
13059 + Require tagsoup 0.13.1, to fix a bug with parsing of script tags
13060 (#1248).
13061 + Treat processing instructions & declarations as block. Previously
13062 these were treated as inline, and included in paragraph tags in HTML
13063 or DocBook output, which is generally not what is wanted (#1233).
13064 + Updated `closes` with rules from HTML5 spec.
13065 + Use Builder (Matthew Pickering, #1162).
13067 * RST reader:
13069 + Remove duplicate `http` in PEP links (Albert Krewinkel).
13070 + Make rst figures true figures (#1168, CasperVector)
13071 + Enhanced Pandoc's support for rST roles (Merijn Verstaaten).
13072 rST parser now supports: all built-in rST roles, new role definition,
13073 role inheritance, though with some limitations.
13074 + Use `author` rather than `authors` in metadata.
13075 + Better handling of directives. We now correctly handle field
13076 lists that are indented more than three spaces. We treat an
13077 `aafig` directive as a code block with attributes, so it can be
13078 processed in a filter (#1212).
13080 * LaTeX writer:
13082 + Mark span contents with label if span has an ID (Albert Krewinkel).
13083 + Made `--toc-depth` work well with books in latex/pdf output (#1210).
13084 + Handle line breaks in simple table cells (#1217).
13085 + Workaround for level 4-5 headers in quotes. These previously produced
13086 invalid LaTeX: `\paragraph` or `\subparagraph` in a `quote` environment.
13087 This adds an `mbox{}` in these contexts to work around the problem.
13088 See <http://tex.stackexchange.com/a/169833/22451> (#1221).
13089 + Use `\/` to avoid en-dash ligature instead of `-{}-` (Vaclav Zeman).
13090 This is to fix LuaLaTeX output. The `-{}-` sequence does not avoid the
13091 ligature with LuaLaTeX but `\/` does.
13092 + Fixed string escaping in `hyperref` and `hyperdef` (#1130).
13094 * ConTeXt writer: Improved autolinks (#1270).
13096 * DocBook writer:
13098 + Improve handling of hard line breaks in Docbook writer
13099 (Neil Mayhew). Use a `<literallayout>` for the entire paragraph, not
13100 just for the newline character.
13101 + Don't let line breaks inside footnotes influence the enclosing
13102 paragraph (Neil Mayhew).
13103 + Distinguish tight and loose lists in DocBook output, using
13104 `spacing="compact"` (Neil Mayhew, #1250).
13106 * Docx writer: When needed files are not present in the user's
13107 `reference.docx`, fall back on the versions in the `reference.docx`
13108 in pandoc's data files. This fixes a bug that occurs when a
13109 `reference.docx` saved by LibreOffice is used. (#1185)
13111 * EPUB writer:
13113 + Include extension in epub ids. This fixes a problem with duplicate
13114 extensions for fonts and images with the same base name but different
13115 extensions (#1254).
13116 + Handle files linked in raw `img` tags (#1170).
13117 + Handle media in `audio` source tags (#1170).
13118 Note that we now use a `media` directory rather than `images`.
13119 + Incorporate files linked in `video` tags (#1170). `src` and `poster`
13120 will both be incorporated into `content.opf` and the epub container.
13122 * HTML writer:
13124 + Add colgroup around col tags (#877). Also affects EPUB writer.
13125 + Fixed bug with unnumbered section headings. Unnumbered section
13126 headings (with class `unnumbered`) were getting numbers.
13127 + Improved detection of image links. Previously image links with
13128 queries were not recognized, causing `<embed>` to be used instead
13129 of `<img>`.
13131 * Man writer: Ensure that terms in definition lists aren't line wrapped
13132 (#1195).
13134 * Markdown writer:
13136 + Use proper escapes to avoid unwanted lists (#980). Previously we used
13137 0-width spaces, an ugly hack.
13138 + Use longer backtick fences if needed (#1206). If the content contains a
13139 backtick fence and there are attributes, make sure longer fences are
13140 used to delimit the code. Note: This works well in pandoc, but github
13141 markdown is more limited, and will interpret the first string of three
13142 or more backticks as ending the code block.
13144 * RST writer: Avoid stack overflow with certain tables (#1197).
13146 * RTF writer: Fixed table cells containing paragraphs.
13148 * Custom writer:
13150 + Correctly handle UTF-8 in custom lua scripts (#1189).
13151 + Fix bugs with lua scripts with mixed-case filenames and
13152 paths containing `+` or `-` (#1267). Note that `getWriter`
13153 in `Text.Pandoc` no longer returns a custom writer on input
13154 `foo.lua`.
13156 * AsciiDoc writer: Handle multiblock and empty table cells
13157 (#1245, #1246). Added tests.
13159 * `Text.Pandoc.Options`: Added `readerTrace` to `ReaderOptions`
13161 * `Text.Pandoc.Shared`:
13163 + Added `compactify'DL` (formerly in markdown reader) (Albert Krewinkel).
13164 + Fixed bug in `toRomanNumeral`: numbers ending with '9' would
13165 be rendered as Roman numerals ending with 'IXIV' (#1249). Thanks to
13166 Jesse Rosenthal.
13167 + `openURL`: set proxy with value of http_proxy env variable (#1211).
13168 Note: proxies with non-root paths are not supported, due to
13169 limitations in `http-conduit`.
13171 * `Text.Pandoc.PDF`:
13173 + Ensure that temp directories deleted on Windows (#1192). The PDF is
13174 now read as a strict bytestring, ensuring that process ownership will
13175 be terminated, so the temp directory can be deleted.
13176 + Use `/` as path separators in a few places, even on Windows.
13177 This seems to be necessary for texlive (#1151, thanks to Tim Lin).
13178 + Use `;` for `TEXINPUTS` separator on Windows (#1151).
13179 + Changes to error reporting, to handle non-UTF8 error output.
13181 * `Text.Pandoc.Templates`:
13183 + Removed unneeded datatype context (Merijn Verstraaten).
13185 + YAML objects resolve to "true" in conditionals (#1133).
13186 Note: If `address` is a YAML object and you just have `$address$`
13187 in your template, the word `true` will appear, which may be
13188 unexpected. (Previously nothing would appear.)
13190 * `Text.Pandoc.SelfContained`: Handle `poster` attribute in `video`
13191 tags (#1188).
13193 * `Text.Pandoc.Parsing`:
13195 + Made `F` an instance of Applicative (#1138).
13196 + Added `stateCaption`.
13197 + Added `HasMacros`, simplified other typeclasses.
13198 Removed `updateHeaderMap`, `setHeaderMap`, `getHeaderMap`,
13199 `updateIdentifierList`, `setIdentifierList`, `getIdentifierList`.
13200 + Changed the smart punctuation parser to return `Inlines`
13201 rather than `Inline` (Matthew Pickering).
13202 + Changed `HasReaderOptions`, `HasHeaderMap`, `HasIdentifierList`
13203 from typeclasses of monads to typeclasses of states. This simplifies
13204 the instance definitions and provides more flexibility. Generalized
13205 type of `getOption` and added a default definition. Removed
13206 `askReaderOption`. Added `extractReaderOption`. Added
13207 `extractHeaderMap` and `updateHeaderMap` in `HasHeaderMap`.
13208 Gave default definitions for `getHeaderMap`, `putHeaderMap`,
13209 `modifyHeaderMap`. Added `extractIdentifierList` and
13210 `updateIdentifierList` in `HasIdentifierList`. Gave defaults
13211 for `getIdentifierList`, `putIdentifierList`, and
13212 `modifyIdentifierList`. The ultimate goal here is to allow different
13213 parsers to use their own, tailored parser states (instead of
13214 `ParserState`) while still using shared functions.
13216 * Template changes:
13218 + LaTeX template: Use `fontenc` package only with `pdflatex` (#1164).
13219 + LaTeX template: Add `linestretch` and `fontfamily` variables.
13220 + LaTeX template: Conditionalize author and date commands.
13221 + Beamer template: Consistent styles for figure and table captions
13222 (aaronwolen).
13223 + LaTeX and beamer template: Adjust widths correctly for oversized
13224 images. Use `\setkeys{Gin}{}` to set appropriate defaults for
13225 `\includegraphics` (Yihui Xie, Garrick Aden-Buie). Load
13226 `upquote` only after `fontenc` (Yihui Xie).
13227 + Beamer template: Added caption package (#1200).
13228 + Beamer template: changes for better unicode handling (KarolS).
13229 + DocBook template: use `authorgroup` if there are authors.
13230 + revealjs template: Move `include-after` to end (certainlyakey).
13231 + revealjs template: Fixed PDF print function (#1220, kevinkenan).
13233 * Bumped version bounds of dependencies.
13235 * Added a `--trace` command line option, for debugging backtracking
13236 bugs. So far this only works with the markdown reader.
13238 * MathMLinHTML: Fixed deprecation warning (#362, gwern, Albert Krewinkel).
13240 * Updated travis script to test with multiple GHC versions.
13242 * Force failure of a Travis build if GHC produces warnings (Albert
13243 Krewinkel).
13245 * Add `.editorconfig` (Albert Krewinkel).
13246 See <http://editorconfig.org/> for details.
13248 * Give more useful error message if '-t pdf' is specified (#1155).
13250 * Added `Cite`, `SmallCaps` to `Arbitrary` instance (#1269).
13252 * Allow `html4` as a synonym of `html` as a reader (it already works
13253 as a writer).
13255 * README:
13257 + Added an explanation of how to use YAML metadata to
13258 force items to appear in the bibliography without citations in
13259 the text (like LaTeX `\nocite`).
13260 + Added note to `--bibtex/--natbib`: not for use in making PDF
13261 (#1194, thanks to nahoj).
13262 + Added explanatory notes about `--natbib` and `--biblatex`.
13263 + Added specification of legal syntax for citation keys.
13264 + Fixed variable defaults documentation (Albert Krewinkel).
13266 * Removed copyright statements for files that have been removed
13267 (Albert Krewinkel).
13269 * Moved some doc files from `data-files` to `extra-source-files` (#1123).
13270 They aren't needed at runtime. We keep README and COPYRIGHT in data
13271 to ensure that they'll be available on all systems on which pandoc
13272 is installed.
13274 * Use cabal sandboxes in Windows build script.
13276## pandoc 1.12.3.3 (2014-02-03)
13278 * To changes to source; recompiled tarball with latest alex and
13279 happy, so they will work with GHC 7.8.
13281## pandoc 1.12.3.2 (2014-02-03)
13283 * Bumped version bounds for blaze-html, blaze-markup.
13285 * ImageSize: Avoid use of lookAhead, which is not in binary >= 0.6
13286 (#1124).
13288 * Fixed mediawiki ordered list parsing (#1122).
13290 * HTML reader: Fixed bug reading inline math with `$$` (#225).
13292 * Added support for LaTeX style literate Haskell code blocks in rST
13293 (Merijn Verstraaten).
13295## pandoc 1.12.3.1 (2014-01-14)
13297 * Relaxed version constraint on binary, allowing the use of binary 0.5.
13300## pandoc 1.12.3 (2014-01-10)
13302 * The `--bibliography` option now sets the `biblio-files` variable.
13303 So, if you're using `--natbib` or `--biblatex`, you can just use
13304 `--bibliography=foo.bib` instead of `-V bibliofiles=foo`.
13306 * Don't run pandoc-citeproc filter if `--bibliography` is
13307 used together with `--natbib` or `--biblatex` (Florian Eitel).
13309 * Template changes:
13311 + Updated beamer template to include booktabs.
13312 + Added `abstract` variable to LaTeX template.
13313 + Put `header-includes` after `title` in LaTeX template (#908).
13314 + Allow use of `\includegraphics[size]` in beamer.
13315 This just required porting a macro definition from the default
13316 LaTeX template to the default beamer template.
13318 * `reference.docx`: Include `FootnoteText` style.
13319 Otherwise Word ignores the style, even when specified in the `pPr`.
13320 (#901)
13322 * `reference.odt`: Tidied `styles.xml`.
13324 * Relaxed version bounds for dependencies.
13326 * Added `withSocketsDo` around http conduit code in `openURL`,
13327 so it works on Windows (#1080).
13329 * Added `Cite` function to `sample.lua`.
13331 * Markdown reader:
13333 + Fixed regression in title blocks (#1089).
13334 If author field was empty, date was being ignored.
13335 + Allow backslash-newline hard line breaks in grid and
13336 multiline table cells.
13337 + Citation keys may now start with underscores, and may contain
13338 underscores adjacent to internal punctuation.
13340 * LaTeX reader:
13342 + Add support for `Verb` macro (jrnold) (#1090).
13343 + Support babel-style quoting: `` "`..."' ``.
13345 * Properly handle script blocks in strict mode. (That is,
13346 `markdown-markdown_in_html_blocks`.) Previously a spurious
13347 `<p>` tag was being added (#1093).
13349 * Docbook reader: Avoid failure if `tbody` contains no `tr` or `row`
13350 elements.
13352 * LaTeX writer:
13354 + Factored out function for table cell creation.
13355 + Better treatment of footnotes in tables.
13356 Notes now appear in the regular sequence, rather than in the
13357 table cell. (This was a regression in 1.10.)
13359 * HTML reader: Parse name/content pairs from meta tags as metadata.
13360 Closes #1106.
13362 * Moved `fixDisplayMath` from Docx writer to `Writer.Shared`.
13364 * OpenDocument writer: Fixed `RawInline`, `RawBlock` so they don't escape.
13366 * ODT writer: Use mathml for proper rendering of formulas.
13367 Note: LibreOffice's support for this seems a bit buggy. But
13368 it should be better than what we had before.
13370 * RST writer: Ensure no blank line after def in definition list (#992).
13372 * Markdown writer: Don't use tilde code blocks with braced attributes in
13373 `markdown_github` output. A consequence of this change is that the
13374 backtick form will be preferred in general if both are enabled. That
13375 is good, as it is much more widespread than the tilde form. (#1084)
13377 * Docx writer: Fixed problem with some modified reference docx files.
13378 Include `word/_rels/settings.xml.rels` if it exists, as well as other
13379 `rels` files besides the ones pandoc generates explicitly.
13381 * HTML writer:
13383 + With `--toc`, headers no longer link to themselves (#1081).
13384 + Omit footnotes from TOC entries. Otherwise we get doubled
13385 footnotes when headers have notes!
13387 * EPUB writer:
13389 + Avoid duplicate notes when headings contain notes.
13390 This arose because the headings are copied into the metadata
13391 "title" field, and the note gets rendered twice. We strip the
13392 note now before putting the heading in "title".
13393 + Strip out footnotes from toc entries.
13394 + Fixed bug with `--epub-stylesheet`. Now the contents of
13395 `writerEpubStylesheet` (set by `--epub-stylesheet`)
13396 should again work, and take precedence over a stylesheet specified
13397 in the metadata.
13399 * `Text.Pandoc.Pretty`: Added `nestle`. API change.
13401 * `Text.Pandoc.MIME`: Added `wmf`, `emf`.
13403 * `Text.Pandoc.Shared`: `fetchItem` now handles image URLs beginning
13404 with `//`.
13406 * `Text.Pandoc.ImageSize`: Parse EXIF format JPEGs. Previously
13407 we could only get size information for JFIF format, which led
13408 to squished images in Word documents. Closes #976.
13410 * Removed old `MarkdownTest_1.0.3` directory (#1104).
13413## pandoc 1.12.2.1 (2013-12-08)
13415 * Markdown reader: Fixed regression in list parser, involving
13416 continuation lines containing raw HTML (or even verbatim raw HTML).
13418## pandoc 1.12.2 (2013-12-07)
13420 * Metadata may now be included in YAML blocks in a markdown document.
13421 For example,
13423 ---
13424 title:
13425 - type: main
13426 text: My Book
13427 - type: subtitle
13428 text: An investigation of metadata
13429 creator:
13430 - role: author
13431 text: John Smith
13432 - role: editor
13433 text: Sarah Jones
13434 identifier:
13435 - scheme: DOI
13436 text: doi:10.234234.234/33
13437 publisher: My Press
13438 rights: (c) 2007 John Smith, CC BY-NC
13439 cover-image: img/mypic.jpg
13440 stylesheet: style.css
13441 ...
13443 Metadata may still be provided using `--epub-metadata`; it will
13444 be merged with the metadata in YAML blocks.
13446 * EPUB writer:
13448 + `meta` tags are now used instead of `opf` attributes for EPUB3.
13449 + Insert "svg" property as needed in opf (EPUB 3).
13450 + Simplify `imageTypeOf` using `getMimeType`.
13451 + Add properties attribute to `cover-image` item for EPUB 3.
13452 + Don't include node for `cover.xhtml` if no cover!
13453 + Ensure that same identifier is used throughout (#1044).
13454 If an identifier is given in metadata, we use that; otherwise
13455 we generate a random uuid.
13456 + Add cover reference to guide element (EPUB 2) (Shaun Attfield).
13457 Fixes an issue with Calibre putting the cover at the end of the book
13458 if the spine has `linear="no"`. Apparently this is best practice
13459 for other converters as well:
13460 <http://www.idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.6>.
13461 + Allow `stylesheet` in metadata. The value is a path to the stylesheet.
13462 + Allow partial dates: `YYYY`, `YYYY-MM`.
13464 * Markdown writer: Fix rendering of tight sublists (#1050).
13465 Previously a spurious blank line was included after a tight sublist.
13467 * ODT writer: Add `draw:name` attribute to `draw:frame` elements (#1069).
13468 This is reported to be necessary to avoid an error from recent
13469 versions of Libre Office when files contain more than one image
13470 Thanks to wmanley for reporting and diagnosing the problem.
13472 * ConTeXt writer: Don't hardcode figure/table placement and numbering.
13473 Instead, let this be set in the template, using `\setupfloat`.
13474 Thanks to on4aa and Aditya Mahajan for the suggestion (#1067).
13476 * Implemented CSL flipflopping spans in DOCX, LaTeX, and HTML writers.
13478 * Fixed bug with markdown intraword emphasis. Closes #1066.
13480 * Docbook writer: Hierarchicalize block content in metadata.
13481 Previously headers just disappeared from block-level metadata
13482 when it was used in templates. Now we apply the 'hierarchicalize'
13483 transformation. Note that a block headed by a level-2 header will
13484 turn into a `<sect1>` element.
13486 * OpenDocument writer: Skip raw HTML (#1035).
13487 Previously it was erroneously included as verbatim text.
13489 * HTML/EPUB writer, footnotes: Put `<sup>` tag inside `<a>` tags.
13490 This allows better control of formatting, since the `<a>`
13491 tags have a distinguishing class (#1049).
13493 * Docx writer:
13495 + Use mime type info returned by fetchItem.
13496 + Fixed core metadata (#1046).
13497 Don't create empty date nodes if no date given.
13498 Don't create multiple `dc:creator` nodes; instead separate by
13499 semicolons.
13500 + Fix URL for core-properties in `_rels/.rels` (#1046).
13502 * Plain writer: don't print `<span>` tags.
13504 * LaTeX writer:
13506 + Fix definition lists with internal links in terms (#1032).
13507 This fix puts braces around a term that contains an internal
13508 link, to avoid problems with square brackets.
13509 + Properly escape pdftitle, pdfauthor (#1059).
13510 + Use booktabs package for tables (thanks to Jose Luis Duran).
13512 * Updated beamer template. Now references should work properly
13513 (in a slide) when `--biblatex` or `--natbib` is used.
13515 * LaTeX reader:
13517 + Parse contents of curly quotes or matched `"` as quotes.
13518 + Support `\textnormal` as span with class `nodecor`.
13519 This is needed for pandoc-citeproc.
13520 + Improved citation parsing. This fixes a run-time error that occurred
13521 with `\citet{}` (empty list of keys). It also ensures that empty keys
13522 don't get produced.
13524 * MediaWiki reader: Add automatic header identifiers.
13526 * HTML reader:
13528 + Use pandoc `Div` and `Span` for raw `<div>`, `<span>` when
13529 `--parse-raw`.
13530 + Recognize `svg` tags as block level content (thanks to MinRK).
13531 + Parse LaTeX math if appropriate options are set.
13533 * Markdown reader:
13535 + Yaml block must start immediately after `---`. If there's a blank
13536 line after `---`, we interpreted it as a horizontal rule.
13537 + Correctly handle empty bullet list items.
13538 + Stop parsing "list lines" when we hit a block tag.
13539 This fixes exponential slowdown in certain input, e.g.
13540 a series of lists followed by `</div>`.
13542 * Slides: Preserve `<div class="references">` in references slide.
13544 * `Text.Pandoc.Writer.Shared`:
13546 + Fixed bug in `tagWithAttrs`. A space was omitted before key-value
13547 attributes, leading to invalid HTML.
13548 + `normalizeDate`: Allow dates with year only (thanks to Shaun Attfield).
13549 + Fixed bug in `openURL` with `data:` URIs. Previously the base-64
13550 encoded bytestring was returned. We now decode it so it's a proper
13551 image!
13553 * DocBook reader: Handle numerical attributes starting with decimal.
13554 Also use `safeRead` instead of `read`.
13556 * `Text.Pandoc.Parsing`:
13558 + Generalized type of `registerHeader`, using new type classes
13559 `HasReadeOptions`, `HasIdentifierList`, `HasHeaderMap`.
13560 These allow certain common functions to be reused
13561 even in parsers that use custom state (instead of `ParserState`),
13562 such as the MediaWiki reader.
13563 + Moved inlineMath, displayMath from Markdown reader to Parsing.
13564 Generalize their types and export them from Parsing. (API change.)
13566 * `Text.Pandoc.Readers.TexMath`: Export `readTeXMath'`, which attends
13567 to display/inline. Deprecate `readTeXMath`, and use `readTeXMath'`
13568 in all the writers. Require `texmath >= 0.6.5.2`.
13570 * `Text.Pandoc.MIME`:
13572 + Add entry for `jfif`.
13573 + In looking up extensions, drop the encoding info.
13574 E.g. for 'image/jpg;base64' we should lookup 'image/jpg'.
13576 * Templates: Changed how array variables are resolved. Previously if
13577 `foo` is an array (which might be because multiple values were set on
13578 the command line), `$foo$` would resolve to the concatenation of the
13579 elements of foo. This is rarely useful behavior. It has been changed
13580 so that the first value is rendered. Of course, you can still iterate
13581 over the values using `$for(foo)$`. This has the result that you can
13582 override earlier settings using `-V` by putting new values later on the
13583 command line, which is useful for many purposes.
13585 * `Text.Pandoc`: Don't default to `pandocExtensions` for all writers.
13587 * Allow "epub2" as synonym for "epub", "html4" for "html".
13589 * Don't look for slidy files in data files with `--self-contained`.
13591 * Allow `https:` command line arguments to be downloaded.
13593 * Fixed `make_osx_package.sh` so data files embedded in `pandoc-citeproc`.
13595## pandoc 1.12.1 (2013-10-20)
13597 * `Text.Pandoc.Definition`: Changed default JSON serialization format.
13598 Instead of `{"Str": "foo"}`, for example, we now have `{"t": "Str",
13599 "c": "foo"}`. This new format is easier to work with outside of Haskell.
13600 Incidentally, "t" stands for "tag", "c" for "contents".
13602 * MediaWiki reader: Trim contents of `<math>` tags, to avoid problems
13603 when converting to markdown (#1027).
13605 * LaTeX reader:
13607 + Ensure that preamble doesn't contribute to the text of
13608 the document.
13609 + Fixed character escaping in `\url{}`. Previously `\~` wasn't handled
13610 properly, among others.
13611 + Parse `{groups}` as `Span`. This is needed for accurate conversion of
13612 bibtex titles, since we need to know what was protected from
13613 titlecase conversions.
13615 * LaTeX writer:
13617 + Specially escape non-ascii characters in labels.
13618 Otherwise we can get compile errors and other bugs when
13619 compiled with pdflatex (#1007). Thanks to begemotv2718 for the fix.
13620 + Add link anchors for code blocks with identifiers (#1025).
13622 * Throughout the code, use `isURI` instead of `isAbsoluteURI`.
13623 It allows fragments identifiers.
13625 * Slide formats:
13627 + A Div element with class "notes" is treated as speaker
13628 notes. Currently beamer goes to `\note{}`, revealjs to
13629 `<aside class="notes">`, and the notes are simply suppressed in
13630 other formats (#925).
13631 + Fixed `. . .` (pause) on HTML slide formats. Closes #1029.
13632 The old version caused a pause to be inserted before the first
13633 material on a slide. This has been fixed.
13634 + Removed data files for s5, slideous, slidy.
13635 Users of s5 and slideous will have to download the needed
13636 files, as has been documented for some time in the README.
13637 By default, slidy code will be sought on the web, as before.
13639 * HTML writer: Insert command to typeset mathjax only in slideous output
13640 (#966, #1012).
13642 * RST writer: Skip spaces after display math. Otherwise we get indentation
13643 problems, and part of the next paragraph may be rendered as part of the
13644 math.
13646 * OpenDocument writer: Fix formatting of strikeout code (#995),
13647 thanks to wilx. don't use `font-face-decls` variable.
13649 * Fixed test suite so it works with cabal sandboxes.
13651## pandoc 1.12.0.2 (2013-09-20)
13653 * Removed an unused dependency (`stringable`) from pandoc.cabal.
13654 This will help packagers, but users should not need to upgrade.
13656## pandoc 1.12.0.1 (2013-09-20)
13658 * Allow `--metadata` to be repeated for the same key to form a list.
13659 This also has the effect that `--bibliography` can be repeated,
13660 as before.
13662 * Handle boolean values in `--metadata`. Note that anything not parseable
13663 as a YAML boolean or string is treated as a literal string.
13664 You can get a string value with "yes", or any of the strings interpretable
13665 as booleans, by quoting it:
13667 -M boolvalue=yes -M stringvalue='"yes"'
13669 * LaTeX writer: Don't print references if `--natbib` or `--biblatex`
13670 option used.
13672 * DOCX writer: Add `settings.xml` to the zip container. Fixes a bug
13673 in which docx files could not be read by some versions of Word
13674 and LibreOffice (#990).
13676 * Fixed a regression involving slide shows with bibliographies.
13677 The Div container around references messed up the procedure for carving
13678 a document into slides. So we now remove the surrounding Div in
13679 `prepSlides`.
13681 * More informative error message when a filter is not found in path.
13683 * Depend on pandoc-types 1.12.1. This provide `ToJSONFilter`
13684 instances for `Data a => a -> [a]` and `Data a => a -> IO [a]`.
13686 * Don't use unicode_collation in building OSX package:
13687 it adds something like 50MB of dependencies to the package.
13689 * Declare alex and happy as build-tools (#986).
13691## pandoc 1.12 (2013-09-15)
13693### New features
13695 * Much more flexible metadata, including arbitrary fields and structured
13696 values. Metadata can be specified flexibly in pandoc markdown using
13697 YAML metadata blocks, which may occur anywhere in the document:
13699 ---
13700 title: Here is my title.
13701 abstract: |
13702 This is the abstract.
13704 1. It can contain
13705 2. block content
13706 and *inline markup*
13708 tags: [cat, dog, animal]
13709 ...
13711 Metadata fields automatically populate template variables.
13713 * Added `opml` (OPML) as input and output format. The `_note` attribute,
13714 used in OmniOutliner and supported by multimarkdown, is supported.
13715 We treat the contents as markdown blocks under a section header.
13717 * Added `haddock` (Haddock markup) as input format (David Lazar).
13719 * Added `revealjs` output format, for reveal.js HTML 5 slide shows.
13720 (Thanks to Jamie F. Olson for the initial patch.)
13721 Nested vertical stacks are used for hierarchical structure.
13722 Results for more than one level of nesting may be odd.
13724 * Custom writers can now be written in lua.
13726 pandoc -t data/sample.lua
13728 will load the script sample.lua and use it as a custom writer.
13729 (For a sample, do `pandoc --print-default-data-file sample.lua`.)
13730 Note that pandoc embeds a lua interpreter, so lua need not be
13731 installed separately.
13733 * New `--filter/-F` option to make it easier to run "filters"
13734 (Pandoc AST transformations that operate on JSON serializations).
13735 Filters are always passed the name of the output format, so their
13736 behavior can be tailored to it. The repository
13737 <https://github.com/jgm/pandocfilters> contains
13738 a python module for writing pandoc filters in python, with
13739 a number of examples.
13741 * Added `--metadata/-M` option.
13742 This is like `--variable/-V`, but actually adds to metadata, not
13743 just variables.
13745 * Added `--print-default-data-file` option, which allows printing
13746 of any of pandoc's data files. (For example,
13747 `pandoc --print-default-data-file reference.odt` will print
13748 `reference.odt`.)
13750 * Added syntax for "pauses" in slide shows:
13752 This gives
13754 . . .
13756 me pause.
13758 * New markdown extensions:
13760 + `ignore_line_breaks`: causes intra-paragraph line breaks to be ignored,
13761 rather than being treated as hard line breaks or spaces. This is useful
13762 for some East Asian languages, where spaces aren't used between words,
13763 but text is separated into lines for readability.
13764 + `yaml_metadata_block`: Parse YAML metadata blocks. (Default.)
13765 + `ascii_identifiers`: This will force `auto_identifiers` to use ASCII
13766 only. (Default for `markdown_github`.) (#807)
13767 + `lists_without_preceding_blankline`: Allow lists to start without
13768 preceding blank space. (Default for `markdown_github`.) (#972)
13770### Behavior changes
13772 * `--toc-level` no longer implies `--toc`.
13773 Reason: EPUB users who don't want a visible TOC may still want
13774 to set the TOC level for in the book navigation.
13776 * `--help` now prints in and out formats in alphabetical order, and
13777 says something about PDF output (#720).
13779 * `--self-contained` now returns less verbose output (telling you
13780 which URLs it is fetching, but not giving the full header). In
13781 addition, there are better error messages when fetching a URL fails.
13783 * Citation support is no longer baked in to core pandoc. Users who
13784 need citations will need to install and use a separate filter
13785 (`--filter pandoc-citeproc`). This filter will take `bibliography`,
13786 `csl`, and `citation-abbreviations` from the metadata, though it
13787 may still be specified on the command line as before.
13789 * A `Cite` element is now created in parsing markdown whether or not
13790 there is a matching reference.
13792 * The `pandoc-citeproc` script will put the bibliography at the
13793 end of the document, as before. However, it will be put inside a `Div`
13794 element with class "references", allowing users some control
13795 over the styling of references. A final header, if any, will
13796 be included in the `Div`.
13798 * The markdown writer will not print a bibliography if the
13799 `citations` extension is enabled. (If the citations are formatted
13800 as markdown citations, it is redundant to have a bibliography,
13801 since one will be generated automatically.)
13803 * Previously we used to store the directory of the first input file,
13804 even if it was local, and used this as a base directory for finding
13805 images in ODT, EPUB, Docx, and PDF. This has been confusing to many
13806 users. So we now look for images relative to the current
13807 working directory, even if the first file argument is in another
13808 directory. Note that this change may break some existing workflows.
13809 If you have been assuming that relative links will be interpreted
13810 relative to the directory of the first file argument, you'll need
13811 to make that the current directory before running pandoc. (#942)
13813 * Better error reporting in some readers, due to changes in `readWith`:
13814 the line in which the error occurred is printed, with a caret pointing
13815 to the column.
13817 * All slide formats now support incremental slide view for definition lists.
13819 * Parse `\(..\)` and `\[..\]` as math in MediaWiki reader.
13820 Parse `:<math>...</math>` as display math. These notations are used with
13821 the MathJax MediaWiki extension.
13823 * All writers: template variables are set automatically from metadata
13824 fields. However, variables specified on the command line with
13825 `--variable` will completely shadow metadata fields.
13827 * If `--variable` is used to set many variables with the same name,
13828 a list is created.
13830 * Man writer: The `title`, `section`, `header`, and `footer` can now
13831 all be set individually in metadata. The `description` variable has been
13832 removed. Quotes have been added so that spaces are allowed in the
13833 title. If you have a title that begins
13835 COMMAND(1) footer here | header here
13837 pandoc will still parse it into a title, section, header, and
13838 footer. But you can also specify these elements explicitly (#885).
13840 * Markdown reader
13842 + Added support for YAML metadata blocks, which can come anywhere
13843 in the document (not just at the beginning). A document can contain
13844 multiple YAML metadata blocks.
13845 + HTML span and div tags are parsed as pandoc Span and Div elements.
13847 * Markdown writer
13849 + Allow simple tables to be printed as grid tables,
13850 if other table options are disabled. This means you can do
13851 `pandoc -t markdown-pipe_tables-simple_tables-multiline_tables`
13852 and all tables will render as grid tables.
13853 + Support YAML title block (render fields in alphabetical order
13854 to make output predictable).
13856### API changes
13858 * `Meta` in `Text.Pandoc.Definition` has been changed to allow
13859 structured metadata. (Note: existing code that pattern-matches
13860 on `Meta` will have to be revised.) Metadata can now contain
13861 indefinitely many fields, with content that can be a string,
13862 a Boolean, a list of `Inline` elements, a list of `Block`
13863 elements, or a map or list of these.
13865 * A new generic block container (`Div`) has been added to `Block`,
13866 and a generic inline container (`Span`) has been added to `Inline`.
13867 These can take attributes. They will render in HTML, Textile,
13868 MediaWiki, Org, RST and Markdown (with `markdown_in_html`
13869 extension) as HTML `<div>` and `<span>` elements; in other formats
13870 they will simply pass through their contents. But they can be
13871 targeted by scripts.
13873 * `Format` is now a newtype, not an alias for String.
13874 Equality comparisons are case-insensitive.
13876 * Added `Text.Pandoc.Walk`, which exports hand-written tree-walking
13877 functions that are much faster than the SYB functions from
13878 `Text.Pandoc.Generic`. These functions are now used where possible
13879 in pandoc's code. (`Tests.Walk` verifies that `walk` and `query`
13880 match the generic traversals `bottomUp` and `queryWith`.)
13882 * Added `Text.Pandoc.JSON`, which provides `ToJSON` and `FromJSON`
13883 instances for the basic pandoc types. They use GHC generics and
13884 should be faster than the old JSON serialization using
13885 `Data.Aeson.Generic`.
13887 * Added `Text.Pandoc.Process`, exporting `pipeProcess`.
13888 This is a souped-up version of `readProcessWithErrorcode` that
13889 uses lazy bytestrings instead of strings and allows setting
13890 environment variables. (Used in `Text.Pandoc.PDF`.)
13892 * New module `Text.Pandoc.Readers.OPML`.
13894 * New module `Text.Pandoc.Writers.OPML`.
13896 * New module `Text.Pandoc.Readers.Haddock` (David Lazar).
13897 This is based on Haddock's own lexer/parser.
13899 * New module `Text.Pandoc.Writers.Custom`.
13901 * In `Text.Pandoc.Shared`, `openURL` and `fetchItem` now return an
13902 Either, for better error handling.
13904 * Made `stringify` polymorphic in `Text.Pandoc.Shared`.
13906 * Removed `stripTags` from `Text.Pandoc.XML`.
13908 * `Text.Pandoc.Templates`:
13910 + Simplified `Template` type to a newtype.
13911 + Removed `Empty`.
13912 + Changed type of `renderTemplate`: it now takes a JSON context
13913 and a compiled template.
13914 + Export `compileTemplate`.
13915 + Export `renderTemplate'` that takes a string instead of a compiled
13916 template.
13917 + Export `varListToJSON`.
13919 * `Text.Pandoc.PDF` exports `makePDF` instead of `tex2pdf`.
13921 * `Text.Pandoc`:
13923 + Made `toJsonFilter` an alias for `toJSONFilter` from `Text.Pandoc.JSON`.
13924 + Removed `ToJsonFilter` typeclass. `ToJSONFilter` from
13925 `Text.Pandoc.JSON` should be used instead. (Compiling against
13926 pandoc-types instead of pandoc will also produce smaller executables.)
13927 * Removed the deprecated `jsonFilter` function.
13928 + Added `readJSON`, `writeJSON` to the API (#817).
13930 * `Text.Pandoc.Options`:
13932 + Added `Ext_lists_without_preceding_blankline`,
13933 `Ext_ascii_identifiers`, `Ext_ignore_line_breaks`,
13934 `Ext_yaml_metadataBlock` to `Extension`.
13935 + Changed `writerSourceDirectory` to `writerSourceURL` and changed the
13936 type to a `Maybe`. `writerSourceURL` is set to 'Just url' when the
13937 first command-line argument is an absolute URL. (So, relative links
13938 will be resolved in relation to the first page.) Otherwise, 'Nothing'.
13939 + All bibliography-related fields have been removed from
13940 `ReaderOptions` and `WriterOptions`: `writerBiblioFiles`,
13941 `readerReferences`, `readerCitationStyle`.
13943 * The `Text.Pandoc.Biblio` module has been removed. Users of the
13944 pandoc library who want citation support will need to use
13945 `Text.CSL.Pandoc` from `pandoc-citeproc`.
13947### Bug fixes
13949 * In markdown, don't autolink a bare URI that is followed by `</a>`
13950 (#937).
13952 * `Text.Pandoc.Shared`
13954 + `openURL` now follows redirects (#701), properly handles `data:`
13955 URIs, and prints diagnostic output to stderr rather than stdout.
13956 + `readDefaultDataFile`: normalize the paths. This fixes bugs in
13957 `--self-contained` on pandoc compiled with `embed_data_files` (#833).
13958 + Fixed `readDefaultDataFile` so it works on Windows.
13959 + Better error messages for `readDefaultDataFile`. Instead of
13960 listing the last path tried, which can confuse people who are
13961 using `--self-contained`, so now we just list the data file name.
13962 + URL-escape pipe characters. Even though these are legal, `Network.URI`
13963 doesn't regard them as legal in URLs. So we escape them first (#535).
13965 * Mathjax in HTML slide shows: include explicit "Typeset" call.
13966 This seems to be needed for some formats (e.g. slideous) and won't
13967 hurt in others (#966).
13969 * `Text.Pandoc.PDF`
13971 + On Windows, create temdir in working directory, since the system
13972 temp directory path may contain tildes, which can cause
13973 problems in LaTeX (#777).
13974 + Put temporary output directory in `TEXINPUTS` (see #917).
13975 + `makePDF` tries to download images that are not found locally,
13976 if the first argument is a URL (#917).
13977 + If compiling with `pdflatex` yields an encoding error, offer
13978 the suggestion to use `--latex-engine=xelatex`.
13980 * Produce automatic header identifiers in parsing textile, RST,
13981 and LaTeX, unless `auto_identifiers` extension is disabled (#967).
13983 * `Text.Pandoc.SelfContained`: Strip off fragment, query of relative URL
13984 before treating as a filename. This fixes `--self-contained` when used
13985 with CSS files that include web fonts using the method described here:
13986 <http://paulirish.com/2009/bulletproof-font-face-implementation-syntax/>
13987 (#739). Handle `src` in `embed`, `audio`, `source`, `input` tags.
13989 * `Text.Pandoc.Parsing`: `uri` parser no longer treats punctuation before
13990 percent-encoding, or a `+` character, as final punctuation.
13992 * `Text.Pandoc.ImageSize`: Handle EPS (#903). This change will make
13993 EPS images properly sized on conversion to Word.
13995 * Slidy: Use slidy.js rather than slidy.js.gz.
13996 Reason: some browsers have trouble with the gzipped js file,
13997 at least on the local file system (#795).
13999 * Markdown reader
14001 + Properly handle blank line at beginning of input (#882).
14002 + Fixed bug in unmatched reference links. The input
14003 `[*infile*] [*outfile*]` was getting improperly parsed:
14004 "infile" was emphasized, but "*outfile*" was literal (#883).
14005 + Allow internal `+` in citation identifiers (#856).
14006 + Allow `.` or `)` after `#` in ATX headers if no `fancy_lists`.
14007 + Do not generate blank title, author, or date metadata elements.
14008 Leave these out entirely if they aren't present.
14009 + Allow backtick code blocks not to be preceded by blank line (#975).
14011 * Textile reader:
14013 + Correctly handle entities.
14014 + Improved handling of `<pre>` blocks (#927). Remove internal HTML tags
14015 in code blocks, rather than printing them verbatim. Parse attributes
14016 on `<pre>` tag for code blocks.
14018 * HTML reader: Handle non-simple tables (#893). Column widths are read from
14019 `col` tags if present, otherwise divided equally.
14021 * LaTeX reader
14023 + Support alltt environment (#892).
14024 + Support `\textasciitilde`, `\textasciicircum` (#810).
14025 + Treat `\textsl` as emphasized text reader (#850).
14026 + Skip positional options after `\begin{figure}`.
14027 + Support `\v{}` for hacek (#926).
14028 + Don't add spurious ", " to citation suffixes.
14029 This is added when needed in pandoc-citeproc.
14030 + Allow spaces in alignment spec in tables, e.g. `{ l r c }`.
14031 + Improved support for accented characters (thanks to Scott Morrison).
14032 + Parse label after section command and set id (#951).
14034 * RST reader:
14036 + Don't insert paragraphs where docutils doesn't.
14037 `rst2html` doesn't add `<p>` tags to list items (even when they are
14038 separated by blank lines) unless there are multiple paragraphs in the
14039 list. This commit changes the RST reader to conform more closely to
14040 what docutils does (#880).
14041 + Improved metadata. Treat initial field list as metadata when
14042 standalone specified. Previously ALL fields "title", "author",
14043 "date" in field lists were treated as metadata, even if not at
14044 the beginning. Use `subtitle` metadata field for subtitle.
14045 + Fixed 'authors' metadata parsing in reST. Semicolons separate
14046 different authors.
14048 * MediaWiki reader
14050 + Allow space before table rows.
14051 + Fixed regression for `<ref>URL</ref>`.
14052 `<` is no longer allowed in URLs, according to the uri parser
14053 in `Text.Pandoc.Parsing`. Added a test case.
14054 + Correctly handle indented preformatted text without preceding
14055 or following blank line.
14056 + Fixed `|` links inside table cells. Improved attribute parsing.
14057 + Skip attributes on table rows. Previously we just crashed if
14058 rows had attributes, now we ignore them.
14059 + Ignore attributes on headers.
14060 + Allow `Image:` for images (#971).
14061 + Parse an image with caption in a paragraph by itself as a figure.
14063 * LaTeX writer
14065 + Don't use ligatures in escaping inline code.
14066 + Fixed footnote numbers in LaTeX/PDF tables. This fixes a bug
14067 wherein notes were numbered incorrectly in tables (#827).
14068 + Always create labels for sections. Previously the labels were only
14069 created when there were links to the section in the document (#871).
14070 + Stop escaping `|` in LaTeX math.
14071 This caused problems with array environments (#891).
14072 + Change `\` to `/` in paths. `/` works even on Windows in LaTeX.
14073 `\` will cause major problems if unescaped.
14074 + Write id for code block to label attribute in LaTeX when listings
14075 is used (thanks to Florian Eitel).
14076 + Scale LaTeX tables so they don't exceed columnwidth.
14077 + Avoid problem with footnotes in unnumbered headers (#940).
14079 * Beamer writer: when creating beamer slides, add `allowframebreaks` option
14080 to the slide if it is one of the header classes. It is recommended
14081 that your bibliography slide have this attribute:
14083 # References {.allowframebreaks}
14085 This causes multiple slides to be created if necessary, depending
14086 on the length of the bibliography.
14088 * ConTeXt writer: Properly handle tables without captions. The old output
14089 only worked in MkII. This should work in MkIV as well (#837).
14091 * MediaWiki writer: Use native mediawiki tables instead of HTML (#720).
14093 * HTML writer:
14095 + Fixed `--no-highlight` (Alexander Kondratskiy).
14096 + Don't convert to lowercase in email obfuscation (#839).
14097 + Ensure proper escaping in `<title>` and `<meta>` fields.
14099 * AsciiDoc writer:
14101 + Support `--atx-headers` (Max Rydahl Andersen).
14102 + Don't print empty identifier blocks `([[]])` on headers (Max
14103 Rydahl Andersen).
14105 * ODT writer:
14107 + Fixing wrong numbered-list indentation in open document format
14108 (Alexander Kondratskiy) (#369).
14109 + `reference.odt`: Added pandoc as "generator" in `meta.xml`.
14110 + Minor changes for ODF 1.2 conformance (#939). We leave the
14111 nonconforming `contextual-spacing` attribute, which is provided by
14112 LibreOffice itself and seems well supported.
14114 * Docx writer:
14116 + Fixed rendering of display math in lists.
14117 In 1.11 and 1.11.1, display math in lists rendered as a new list
14118 item. Now it always appears centered, just as outside of lists,
14119 and in proper display math style, no matter how far indented the
14120 containing list item is (#784).
14121 + Use `w:br` with `w:type` `textWrapping` for linebreaks.
14122 Previously we used `w:cr` (#873).
14123 + Use Compact style for Plain block elements, to
14124 differentiate between tight and loose lists (#775).
14125 + Ignore most components of `reference.docx`.
14126 We take the `word/styles.xml`, `docProps/app.xml`,
14127 `word/theme/theme1.xml`, and `word/fontTable.xml` from
14128 `reference.docx`, ignoring everything else. This should help
14129 with the corruption problems caused when different versions of
14130 Word resave the reference.docx and reorganize things.
14131 + Made `--no-highlight` work properly.
14133 * EPUB writer
14135 + Don't add `dc:creator` tags if present in EPUB metadata.
14136 + Add `id="toc-title"` to `h1` in `nav.xhtml` (#799).
14137 + Don't put blank title page in reading sequence.
14138 Set `linear="no"` if no title block. Addresses #797.
14139 + Download webtex images and include as data URLs.
14140 This allows you to use `--webtex` in creating EPUBs.
14141 Math with `--webtex` is automatically made self-contained.
14142 + In `data/epub.css`, removed highlighting styles (which
14143 are no longer needed, since styles are added by the HTML
14144 writer according to `--highlighting-style`). Simplified
14145 margin fields.
14146 + If resource not found, skip it, as in Docx writer (#916).
14148 * RTF writer:
14150 + Properly handle characters above the 0000-FFFF range.
14151 Uses surrogate pairs. Thanks to Hiromi Ishii for the patch.
14152 + Fixed regression with RTF table of contents.
14153 + Only autolink absolute URIs. This fixes a regression, #830.
14155 * Markdown writer:
14157 + Only autolink absolute URIs. This fixes a regression, #830.
14158 + Don't wrap attributes in fenced code blocks.
14159 + Write full metadata in MMD style title blocks.
14160 + Put multiple authors on separate lines in pandoc titleblock.
14161 Also, don't wrap long author entries, as new lines get treated
14162 as new authors.
14164 * `Text.Pandoc.Templates`:
14166 + Fixed bug retrieving default template for markdown variants.
14167 + Templates can now contain "record lookups" in variables;
14168 for example, `author.institution` will retrieve the `institution`
14169 field of the `author` variable.
14170 + More consistent behavior of `$for$`. When `foo` is not a list,
14171 `$for(foo)$...$endfor$` should behave like $if(foo)$...$endif$.
14172 So if `foo` resolves to "", no output should be produced.
14173 See pandoc-templates#39.
14175 * Citation processing improvements (now part of pandoc-citeproc):
14177 + Fixed `endWithPunct` The new version correctly sees a sentence
14178 ending in '.)' as ending with punctuation. This fixes a bug which
14179 led such sentences to receive an extra period at the end: '.).'.
14180 Thanks to Steve Petersen for reporting.
14181 + Don't interfere with Notes that aren't citation notes.
14182 This fixes a bug in which notes not generated from citations were
14183 being altered (e.g. first letter capitalized) (#898).
14184 + Only capitalize footnote citations when they have a prefix.
14185 + Changes in suffix parsing. A suffix beginning with a digit gets 'p'
14186 inserted before it before passing to citeproc-hs, so that bare numbers
14187 are treated as page numbers by default. A suffix not beginning with
14188 punctuation has a space added at the beginning (rather than a comma and
14189 space, as was done before for not-author-in-text citations).
14190 The result is that `\citep[23]{item1}` in LaTeX will be interpreted
14191 properly, with '23' treated as a locator of type 'page'.
14192 + Many improvements to citation rendering, due to fixes in citeproc-hs
14193 (thanks to Andrea Rossato).
14194 + Warnings are issued for undefined citations, which are rendered
14195 as `???`.
14196 + Fixed hanging behavior when locale files cannot be found.
14198### Template changes
14200 * DocBook: Use DocBook 4.5 doctype.
14202 * Org: '#+TITLE:' is inserted before the title.
14203 Previously the writer did this.
14205 * LaTeX: Changes to make mathfont work with xelatex.
14206 We need the mathspec library, not just fontspec, for this.
14207 We also need to set options for setmathfont (#734).
14209 * LaTeX: Use `tex-ansi` mapping for `monofont`.
14210 This ensures that straight quotes appear as straight, rather than
14211 being treated as curly. See #889.
14213 * Made `\includegraphics` more flexible in LaTeX template.
14214 Now it can be used with options, if needed. Thanks to Bernhard Weichel.
14216 * LaTeX/Beamer: Added `classoption` variable.
14217 This is intended for class options like `oneside`; it may
14218 be repeated with different options. (Thanks to Oliver Matthews.)
14220 * Beamer: Added `fonttheme` variable. (Thanks to Luis Osa.)
14222 * LaTeX: Added `biblio-style` variable (#920).
14224 * DZSlides: title attribute on title section.
14226 * HTML5: add meta tag to allow scaling by user (Erik Evenson)
14228### Under-the-hood improvements
14230 * Markdown reader:Improved strong/emph parsing, using the strategy of
14231 <https://github.com/jgm/Markdown>. The new parsing algorithm requires
14232 no backtracking, and no keeping track of nesting levels. It will give
14233 different results in some edge cases, but these should not affect normal
14234 uses.
14236 * Added `Text.Pandoc.Compat.Monoid`.
14237 This allows pandoc to compile with `base` < 4.5, where `Data.Monoid`
14238 doesn't export `<>`. Thanks to Dirk Ullirch for the patch.
14240 * Added `Text.Pandoc.Compat.TagSoupEntity`.
14241 This allows pandoc to compile with `tagsoup` 0.13.x.
14242 Thanks to Dirk Ullrich for the patch.
14244 * Most of `Text.Pandoc.Readers.TeXMath` has been moved to the
14245 `texmath` module (0.6.4). (This allows `pandoc-citeproc` to
14246 handle simple math in bibliography fields.)
14248 * Added `Text.Pandoc.Writers.Shared` for shared functions used
14249 only in writers. `metaToJSON` is used in writers to create a
14250 JSON object for use in the templates from the pandoc metadata
14251 and variables. `getField`, `setField`, and `defField` are
14252 for working with JSON template contexts.
14254 * Added `Text.Pandoc.Asciify` utility module.
14255 This exports functions to create ASCII-only versions of identifiers.
14257 * `Text.Pandoc.Parsing`
14259 + Generalized state type on `readWith` (API change).
14260 + Specialize readWith to `String` input. (API change).
14261 + In `ParserState`, replace `stateTitle`, `stateAuthors`, `stateDate`
14262 with `stateMeta` and `stateMeta'`.
14264 * `Text.Pandoc.UTF8`: use strict bytestrings in reading. The use of lazy
14265 bytestrings seemed to cause problems using pandoc on 64-bit Windows
14266 7/8 (#874).
14268 * Factored out `registerHeader` from markdown reader, added to
14269 `Text.Pandoc.Parsing`.
14271 * Removed `blaze_html_0_5` flag, require `blaze-html` >= 0.5.
14272 Reason: < 0.5 does not provide a monoid instance for Attribute,
14273 which is now needed by the HTML writer (#803).
14275 * Added `http-conduit` flag, which allows fetching https resources.
14276 It also brings in a large number of dependencies (`http-conduit`
14277 and its dependencies), which is why for now it is an optional flag
14278 (#820).
14280 * Added CONTRIBUTING.md.
14282 * Improved INSTALL instructions.
14284 * `make-windows-installer.bat`: Removed explicit paths for executables.
14286 * `aeson` is now used instead of `json` for JSON.
14288 * Set default stack size to 16M. This is needed for some large
14289 conversions, esp. if pandoc is compiled with 64-bit ghc.
14291 * Various small documentation improvements.
14292 Thanks to achalddave and drothlis for patches.
14294 * Removed comment that chokes recent versions of CPP (#933).
14296 * Removed support for GHC version < 7.2, since pandoc-types now
14297 requires at least GHC 7.2 for GHC generics.
14300## pandoc 1.11.1 (2013-03-17)
14302 * Markdown reader:
14304 + Fixed regression in which parentheses were lost in link URLs.
14305 Added tests. Closes #786.
14306 + Better handling of unmatched double quotes in `--smart` mode.
14307 These occur frequently in fiction, since it is customary not to
14308 close quotes in dialogue if the speaker does not change between
14309 paragraphs. The unmatched quotes now get turned into literal
14310 left double quotes. (No `Quoted` inline is generated, however.)
14311 Closes #99 (again).
14313 * HTML writer: Fixed numbering mismatch between TOC and sections.
14314 `--number-offset` now affects TOC numbering as well
14315 as section numbering, as it should have all along. Closes #789.
14317 * Markdown writer: Reverted 1.11 change that caused citations to be rendered
14318 as markdown citations, even if `--bibliography` was specified, unless
14319 `citation` extension is disabled. Now, formatted citations are always
14320 printed if `--bibliography` was specified. If you want to reformat
14321 markdown keeping pandoc markdown citations intact, don't use
14322 `--bibliography`. Note that citations parsed from LaTeX documents will
14323 be rendered as pandoc markdown citations when `--bibliography` is not
14324 specified.
14326 * ODT writer: Fixed regression leading to corrupt ODTs.
14327 This was due to a change in the `Show` instance for
14328 `Text.Pandoc.Pretty.Doc`. Closes #780.
14330 * Fixed spacing bugs involving code block attributes in
14331 RST reader and Markdown writer. Closes #763.
14333 * Windows package: Various improvements due to Fyodor Sheremetyev.
14335 + Automatically set installation path (Program Files or Local App Data).
14336 + Set system PATH environment variable when installing for all users.
14337 + Pandoc can installed for all users using the following command.
14338 `msiexec /i pandoc-1.11.msi ALLUSERS=1`.
14340 * Bumped QuickCheck version bound.
14342## pandoc 1.11 (2013-03-09)
14344 * Added `--number-offset` option. (See README for description.)
14346 * Added `--default-image-extension` option. (See README for description.)
14348 * `--number-sections` behavior change: headers with class `unnumbered`
14349 will not be numbered.
14351 * `--version` now reports the default data directory.
14353 * `Text.Pandoc.Parsing` is no longer exposed. (API change.)
14355 * `Text.Pandoc.Highlighting` is no longer exposed. (API change.)
14357 * `Text.Pandoc.Shared`: Changed type of `Element`. `Sec` now includes
14358 a field for `Attr` rather than just `String`. (API change.)
14360 * Added `markdown_github` as input format. This was an accidental
14361 omission in 1.10.
14363 * Added `readerDefaultImageExtension` field to `ReaderOptions`. (API
14364 change.)
14366 * Added `writerNumberOffset` field in `WriterOptions`. (API change.)
14368 * Beamer template:
14370 + Fixed captions with longtable. Thanks to Joost Kremers.
14371 + Provide `\Oldincludegraphics` as in LaTeX template (Benjamin Bannier).
14373 * LaTeX template:
14375 + Load microtype after fonts. Microtype needs to know
14376 what fonts are being used. Thanks to dfc for the patch.
14377 + Set `secnumdepth` to 5 if `--number-sections` specified.
14378 This yields behavior equivalent to the other writers, numbering
14379 level 4 and 5 headers too. Closes #753.
14381 * HTML reader:
14383 + Handle `<colgroup>` tag.
14384 + Preserve all header attributes.
14386 * LaTeX reader:
14388 + Parse `\hrule` as `HorizontalRule`. Closes #746.
14389 + Parse starred variants of `\section` etc. as headers with
14390 attribute `unnumbered`.
14391 + Read optional attributes in `lstlisting` and `Verbatim` environments.
14392 We convert these to pandoc standard names, e.g. `numberLines`
14393 for `numbers=left`, `startFrom=100` from `firstnumber=100`.
14394 + Handle language attribute for lstlistings.
14395 + Better support for Verbatim and minted environments. Closes #763.
14397 * Markdown reader:
14399 + `-` in an attribute context = `.unnumbered`. The point of this
14400 is to provide a way to specify unnumbered headers in non-English
14401 documents.
14402 + Fixed bug parsing key/value attributes. Parsing failed if you
14403 had an unquoted attribute immediately before the final '}'.
14404 + Make backslash escape work in attributes.
14405 + Fix title block parsing. Now if `mmd_title_blocks` is specified,
14406 pandoc will parse a MMD title block if it sees one, even if
14407 `pandoc_title_blocks` is enabled.
14408 + Refactoring: `litChar` now includes entities, so we don't need
14409 to use `fromEntities` e.g. on titles.
14410 + Allow spaces around borders in pipe tables. Closes #772.
14411 + Allow all punctuation in angle-bracket autolinks. Previously
14412 things like `----` were disallowed, because the uri parser
14413 treated them as trailing punctuation. Closes #768.
14414 + Make `implicit_header_references` work properly when
14415 headers are given explicit identifiers.
14416 + Check for tables before line blocks. Otherwise some pipe
14417 tables get treated as line blocks.
14418 + Allow `&` in emails (for entities).
14419 + Properly handle entities in titles and links. A markdown link
14420 `<http://g&ouml;ogle.com>` should be a link to `http://göogle.com`.
14421 Closes #723.
14423 * Textile reader:
14425 + Handle attributes on headers.
14427 * LaTeX reader:
14429 + Add `fig:` as title for images with captions.
14430 This is needed for them to be rendered as figures. Closes #766.
14431 + Never emit an empty paragraph. See #761.
14432 + Handle `\caption` for images in figures. Closes #766.
14433 + Parse `\section*`, etc. as unnumbered sections.
14435 * HTML writer:
14437 + Support header attributes. The attributes go on
14438 the enclosing `section` or `div` tag if `--section-divs` is specified.
14439 + Fixed a regression (only now noticed) in html+lhs output.
14440 Previously the bird tracks were being omitted.
14442 * LaTeX writer:
14444 + Omit lists with no items to avoid LaTeX errors.
14445 + Support line numbering with `--listings`.
14446 If `numberLines` class is present, we add `numbers=left`;
14447 if `startFrom` is present, we add `firstnumber=`. (#763)
14449 * ConTeXt writer:
14451 + Removed `\placecontent`. This produced a duplicate toc,
14452 in conjunction with `\placelist`.
14453 + Use `\title`, `\subject` etc. for headers with
14454 `unnumbered` class.
14456 * Textile writer:
14458 + Support header attributes.
14460 * Markdown writer:
14462 + Use grid tables when needed, and if enabled. Closes #740.
14463 + Render citations as pandoc-markdown citations.
14464 Previously citations were rendered as citeproc-formatted citations
14465 by default. Now we render them as pandoc citations, e.g. `[@item1]`,
14466 unless the `citations` extension is disabled.
14467 If you still want formatted citations in your markdown output,
14468 use `pandoc -t markdown-citations`.
14470 * RST writer:
14472 + Support `:number-lines:` in code blocks.
14474 * Docx writer:
14476 + Better treatment of display math. Display math inside a
14477 paragraph is now put in a separate paragraph, so it will render
14478 properly (centered and without extra blank lines around it).
14479 Partially addresses #742.
14480 + Content types and document rels xml files are now created from
14481 scratch, rather than being taken over from `reference.docx`.
14482 This fixes problems that arise when you edit the `reference.docx`
14483 with Word.
14484 + We also now encode mime types for each individual image rather
14485 than using defaults. This should allow us to handle a wider
14486 range of image types (including PDF). Closes #414.
14487 + Changed style names in `reference docx`.
14488 `FootnoteReference` -> `FootnoteRef`, `Hyperlink` -> `Link`.
14489 The old names got changed by Word when the `reference.docx` was
14490 edited. Closes #414.
14492 * EPUB writer:
14494 + Fix section numbering. Previously the numbering restarted from 1
14495 in each chapter (with `--number-sections`), though the numbers in
14496 the table of contents were correct.
14497 + Headers with "unnumbered" attribute are not numbered. (Nor do they
14498 cause an increment in running numbering.) Section numbers now work
14499 properly, even when there is material before the first numbered section.
14500 + Include HTML TOC, even in epub2. The TOC is included in `<spine>`,
14501 but `linear` is set to `no` unless the `--toc` option is specified.
14502 Include `<guide>` element in OPF. This should allow the TOC to
14503 be useable in Kindles when converted with kindlegen. Closes #773.
14505 * `Text.Pandoc.Parsing`: Optimized `oneOfStringsCI`.
14506 This dramatically reduces the speed penalty that comes from enabling the
14507 `autolink_bare_uris` extension. The penalty is still substantial (in one
14508 test, from 0.33s to 0.44s), but nowhere near what it used to be.
14509 The RST reader is also much faster now, as it autodetects URIs.
14511 * `Text.Pandoc.Shared`: `hierarchicalize` will not number section
14512 with class "unnumbered". Unnumbered sections get `[]` for their
14513 section number.
14515 * `Text.Pandoc.Pretty`:
14517 + Fixed `chomp` so it works inside `Prefixed` elements.
14518 + Changed `Show` instance so it is better for debugging.
14520 * `Text.Pandoc.ImageSize`: Added `Pdf` to `ImageType`.
14522 * `Text.Pandoc.UTF8`: Strip off BOM if present. Closes #743.
14524 * Windows installer improvements:
14526 + The installer is now signed with a certificate (thanks to
14527 Fyodor Sheremetyev).
14528 + WiX is used instead of InnoSetup. The installer is now a
14529 standard msi file.
14530 + The version number is now auto-detected, and need not be
14531 updated separately.
14533 * OSX installer improvements:
14535 + The package and pandoc executable are now signed with a
14536 certificate (thanks to Fyodor Sheremetyev).
14537 + RTF version of license is used.
14538 + Use full path for sysctl in `InstallationCheck` script (jonahbull).
14539 Closes #580.
14541 * Converted COPYING to markdown.
14543 * pandoc.cabal: Require latest versions of highlighting-kate,
14544 texmath, citeproc-hs, zip-archive.
14546## pandoc 1.10.1 (2013-01-23)
14548 * Markdown reader: various optimizations, leading to a
14549 significant performance boost.
14551 * RST reader: Allow anonymous form of inline links:
14552 `` `hello <url>`__ `` Closes #724.
14554 * Mediawiki reader: Don't require newlines after tables.
14555 Thanks to jrunningen for the patch. Closes #733.
14557 * Fixed LaTeX macro parsing. Now LaTeX macro definitions are preserved
14558 when output is LaTeX, and applied when it is another format.
14559 Partially addresses #730.
14561 * Markdown and RST readers: Added parser to `block` that skips blank
14562 lines. This fixes a subtle regression involving grid tables with
14563 empty cells. Also added test for grid table with empty cells.
14564 Closes #732.
14566 * RST writer: Use `.. code:: language` for code blocks with language.
14567 Closes #721.
14569 * DocBook writer: Fixed output for hard line breaks, adding a newline
14570 between `<literallayout>` tags.
14572 * Markdown writer: Use an autolink when link text matches url.
14573 Previously we also checked for a null title, but this
14574 test fails for links produced by citeproc-hs in bibliographies.
14575 So, if the link has a title, it will be lost on conversion
14576 to an autolink, but that seems okay.
14578 * Markdown writer: Set title, author, date variables as before.
14579 These are no longer used in the default template, since we use
14580 titleblock, but we set them anyway for those who use custom templates.
14582 * LaTeX writer: Avoid extra space at start/end of table cell.
14583 Thanks to Nick Bart for the suggestion of using @{}.
14585 * `Text.Pandoc.Parsing`:
14587 + More efficient version of `anyLine`.
14588 + Type of `macro` has changed; the parser now returns `Blocks`
14589 instead of `Block`.
14591 * Relaxed old-time version bound, allowing 1.0.*.
14593 * Removed obsolete `hsmarkdown` script. Those who need `hsmarkdown`
14594 should create a symlink as described in the README.
14596## pandoc 1.10.0.5 (2013-01-23)
14598 * Markdown reader: Try `lhsCodeBlock` before `rawTeXBlock`. Otherwise
14599 `\begin{code}...\end{code}` isn't handled properly in markdown+lhs.
14600 Thanks to Daniel Miot for noticing the bug and suggesting the fix.
14602 * Markdown reader: Fixed bug with headerless grid tables.
14603 The 1.10 code assumed that each table header cell contains exactly one
14604 block. That failed for headerless tables (0) and also for tables with
14605 multiple blocks in a header cell. The code is fixed and tests provided.
14606 Thanks to Andrew Lee for pointing out the bug.
14608 * Markdown reader: Fixed regressions in fenced code blocks. Closes #722.
14610 + Tilde code fences can again take a bare language string
14611 (`~~~ haskell`), not just curly-bracketed attributes
14612 (`~~~ {.haskell}`).
14613 + Backtick code blocks can take the curly-bracketed attributes.
14614 + Backtick code blocks don't *require* a language.
14615 + Consolidated code for the two kinds of fenced code blocks.
14617 * LaTeX template: Use `\urlstyle{same}` to avoid monospace URLs.
14619 * Markdown writer: Use proportional font for email autolinks with
14620 obfuscation. Closes #714.
14622 * Corrected name of `blank_before_blockquote` in README. Closes #718.
14624 * `Text.Pandoc.Shared`: Fixed bug in `uri` parser.
14625 The bug prevented an autolink at the end of a string (e.g.
14626 at the end of a line block line) from counting as a link. Closes #711.
14628 * Use the `hsb2hs` preprocessor instead of TH for embed_data_files.
14629 This should work on Windows, unlike the TH solution with
14630 file-embed.
14632 * Eliminated use of TH in test suite.
14634 * Added `Text.Pandoc.Data` (non-exported) to hold the association
14635 list of embedded data files, if the `embed_data_files` flag is selected.
14636 This isolates the code that needs special treatment with file-embed or
14637 `hsb2hs`.
14639 * Changes to `make-windows-installer.bat`.
14641 + Exit batch file if any of the cabal-dev installs fail.
14642 + There's no longer any need to reinstall `highlighting-kate`.
14643 + Don't start with a `cabal update`; leave that to the user.
14644 + Force reinstall of pandoc.
14646 * Fixed EPUB writer so it builds with blaze-html 0.4.x. Thanks to
14647 Jens Petersen.
14649## pandoc 1.10.0.4 (2013-01-20)
14651 * Fixed bug with escaped % in LaTeX reader. Closes #710.
14653## pandoc 1.10.0.3 (2013-01-20)
14655 * Added further missing fb2 tests to cabal file.
14657## pandoc 1.10.0.2 (2013-01-20)
14659 * Added fb2 tests to cabal file's extra-source-files.
14661## pandoc 1.10.0.1 (2013-01-20)
14663 * Bump version bounds on test-framework packages.
14665## pandoc 1.10 (2013-01-19)
14667### New features
14669 * New input formats: `mediawiki` (MediaWiki markup).
14671 * New output formats: `epub3` (EPUB v3 with MathML),
14672 `fb2` (FictionBook2 ebooks).
14674 * New `--toc-depth` option, specifying how many levels of
14675 headers to include in a table of contents.
14677 * New `--epub-chapter-level` option, specifying the header
14678 level at which to divide EPUBs into separate files.
14679 Note that this normally affects only performance, not the
14680 visual presentation of the EPUB in a reader.
14682 * Removed the `--strict` option. Instead of using `--strict`,
14683 one can now use the format name `markdown_strict` for either input
14684 or output. This gives more fine-grained control that `--strict`
14685 did, allowing one to convert from pandoc's markdown to strict
14686 markdown or vice versa.
14688 * It is now possible to enable or disable specific syntax
14689 extensions by appending them (with `+` or `-`) to the writer
14690 or reader name. For example,
14692 pandoc -f markdown-footnotes+hard_line_breaks
14694 disables footnotes and enables treating newlines as hard
14695 line breaks. The literate Haskell extensions are now implemented
14696 this way as well, using either `+lhs` or `+literate_haskell`.
14697 For a list of extension names, see the README under
14698 "Pandoc's Markdown."
14700 * The following aliases have been introduced for specific
14701 combinations of markdown extensions: `markdown_phpextra`,
14702 `markdown_github`, `markdown_mmd`, `markdown_strict`. These aliases
14703 work just like regular reader and writer names, and can be modified
14704 with extension modifiers as described above. (Note that conversion
14705 from one markdown dialect to another does not work perfectly,
14706 because there are differences in markdown parsers besides
14707 just the extensions, and because pandoc's internal document model is
14708 not rich enough to capture all of the extensions.)
14710 * New `--html-q-tags` option. The previous default was to use `<q>`
14711 tags for smart quotes in HTML5. But `<q>` tags are also valid HTML4.
14712 Moreover, they are not a robust way of typesetting quotes, since
14713 some user agents don't support them, and some CSS resets (e.g.
14714 bootstrap) prevent pandoc's quotes CSS from working properly.
14715 We now just insert literal quote characters by default in both
14716 `html` and `html5` output, but this option is provided for
14717 those who still want `<q>` tags.
14719 * The markdown reader now prints warnings (to stderr) about
14720 duplicate link and note references. Closes #375.
14722 * Markdown syntax extensions:
14724 + Added pipe tables. Thanks to François Gannaz for the initial patch.
14725 These conform to PHP Markdown Extra's pipe table syntax. A subset
14726 of org-mode table syntax is also supported, which means that you can
14727 use org-mode's nice table editor to create tables.
14729 + Added support for RST-style line blocks. These are
14730 useful for verse and addresses.
14732 + Attributes can now be specified for headers, using the same
14733 syntax as in code blocks. (However, currently only the
14734 identifier has any effect in most writers.) For example,
14736 # My header {#foo}
14738 See [the header above](#foo).
14740 + Pandoc will now act as if link references have been defined
14741 for all headers without explicit identifiers.
14742 So, you can do this:
14744 # My header
14746 Link to [My header].
14747 Another link to [it][My header].
14749 Closes #691.
14751 * LaTeX reader:
14753 + Command macros now work everywhere, including non-math.
14754 Environment macros still not supported.
14755 + `\input` now works, as well as `\include`. TEXINPUTS is used.
14756 Pandoc looks recursively into included files for more included files.
14758### Behavior changes
14760 * The Markdown reader no longer puts the text of autolinks in a
14761 `Code` inline. This means that autolinks will no longer appear
14762 in a monospace font.
14764 * The character `/` can now appear in markdown citation keys.
14766 * HTML blocks in strict_markdown are no longer required to begin
14767 at the left margin. Technically this is required, according to
14768 the markdown syntax document, but `Markdown.pl` and other markdown
14769 processors are more liberal.
14771 * The `-V` option has been changed so that if there are duplicate
14772 variables, those specified later on the command line take precedence.
14774 * Tight lists now work in LaTeX and ConTeXt output.
14776 * The LaTeX writer no longer relien on the `enumerate` package.
14777 Instead, it uses standard LaTeX commands to change the list numbering
14778 style.
14780 * The LaTeX writer now uses `longtable` instead of `ctable`. This allows
14781 tables to be split over page boundaries.
14783 * The RST writer now uses a line block to render paragraphs containing
14784 linebreaks (which previously weren't supported at all).
14786 * The markdown writer now applies the `--id-prefix` to footnote IDs.
14787 Closes #614.
14789 * The plain writer no longer uses backslash-escaped line breaks
14790 (which are not very "plain").
14792 * `Text.Pandoc.UTF8`: Better error message for invalid UTF8.
14793 Read bytestring and use `Text`'s decodeUtf8 instead of using
14794 `System.IO.hGetContents`. This way you get a message saying
14795 "invalid UTF-8 stream" instead of "invalid byte sequence."
14796 You are also told which byte caused the problem.
14798 * Docx, ODT, and EPUB writers now download images specified by a URL
14799 instead of skipping them or raising an error.
14801 * EPUB writer:
14803 + The default CSS now left-aligns headers by default, instead of
14804 centering. This is more consistent with the rest of the writers.
14805 + A proper multi-level table of contents is now used in `toc.ncx`.
14806 There is no longer a subsidiary table of contents at the beginning
14807 of each chapter.
14808 + Code highlighting now works by default.
14809 + Section divs are used by default for better semantic markup.
14810 + The title is used instead of "Title Page" in the table of contents.
14811 Otherwise we have a hard-coded English string, which looks
14812 strange in ebooks written in other languages. Closes #572.
14814 * HTML writer:
14816 + Put mathjax in span with class "math". Closes #562.
14817 + Put citations in a span with class "citation." In HTML5, also include
14818 a `data-cite` attribute with a space-separated list of citation
14819 keys.
14821 * `Text.Pandoc.UTF8`: use universalNewlineMode in reading.
14822 This treats both `\r\n` and `\n` as `\n` on input, no matter
14823 what platform we're running on.
14825 * Citation processing is now done in the Markdown and LaTeX
14826 readers, not in `pandoc.hs`. This makes it easier for library users
14827 to use citations.
14829### Template changes
14831 * HTML: Added css to template to preserve spaces in `<code>` tags.
14832 Thanks to Dirk Laurie.
14834 * Beamer: Remove English-centric strings in section pages.
14835 Section pages used to have "Section" and a number as well as the
14836 section title. Now they just have the title. Similarly for part
14837 and subsection. Closes #566.
14839 * LaTeX, ConTeXt: Added papersize variable.
14841 * LaTeX, Beamer templates: Use longtable instead of ctable.
14843 * LaTeX, Beamer templates: Don't require 'float' package for tables.
14844 We don't actually seem to use the '[H]' option.
14846 * Markdown, plain: Fixed titleblock so it is just a single string.
14847 Previously separate title, author, and date variables were used,
14848 but this didn't allow different kinds of title blocks.
14850 * EPUB:
14852 + Rationalized templates. Previously there were three different
14853 templates involved in epub production. There is now just one
14854 template, `default.epub` or `default.epub3`. It can now be
14855 overridden using `--template`, just like other templates.
14856 The titlepage is now folded into the default template.
14857 A `titlepage` variable selects it.
14858 + UTF-8, lang tag, meta tags, title element.
14860 * Added scale-to-width feature to beamer template
14862### API changes
14864 * `Text.Pandoc.Definition`: Added `Attr` field to `Header`.
14865 Previously header identifiers were autogenerated by the writers.
14866 Now they are added in the readers (either automatically or explicitly).
14868 * `Text.Pandoc.Builder`:
14870 + `Inlines` and `Blocks` are now synonyms for `Many Inline` and
14871 `Many Block`. `Many` is a newtype wrapper around `Seq`, with
14872 custom Monoid instances for `Many Inline` and `Many Block. This
14873 allows `Many` to be made an instance of `Foldable` and `Traversable`.
14874 + The old `Listable` class has been removed.
14875 + The module now exports `isNull`, `toList`, `fromList`.
14876 + The old `Read` and `Show` instances have been removed; derived
14877 instances are now used.
14878 + Added `headerWith`.
14880 * The readers now take a `ReaderOptions` rather than a `ParserState`
14881 as a parameter. Indeed, not all parsers use the `ParserState` type;
14882 some have a custom state. The motivation for this change was to separate
14883 user-specifiable options from the accounting functions of parser state.
14885 * New module `Text.Pandoc.Options`. This includes the `WriterOptions`
14886 formerly in `Text.Pandoc.Shared`, and its associated
14887 data types. It also includes a new type `ReaderOptions`, which
14888 contains many options formerly in `ParserState`, and its associated
14889 data types:
14891 + `ParserState.stateParseRaw` -> `ReaderOptions.readerParseRaw`.
14892 + `ParserState.stateColumns` -> `ReaderOptions.readerColumns`.
14893 + `ParserState.stateTabStop` -> `ReaderOptions.readerTabStop`.
14894 + `ParserState.stateOldDashes` -> `ReaderOptions.readerOldDashes`.
14895 + `ParserState.stateLiterateHaskell` -> `ReaderOptions.readerLiterateHaskell`.
14896 + `ParserState.stateCitations` -> `ReaderOptions.readerReferences`.
14897 + `ParserState.stateApplyMacros` -> `ReaderOptions.readerApplyMacros`.
14898 + `ParserState.stateIndentedCodeClasses` ->
14899 `ReaderOptions.readerIndentedCodeClasses`.
14900 + Added `ReaderOptions.readerCitationStyle`.
14902 * `WriterOptions` now includes `writerEpubVersion`, `writerEpubChapterLevel`,
14903 `writerEpubStylesheet`, `writerEpubFonts`, `writerReferenceODT`,
14904 `writerReferenceDocx`, and `writerTOCDepth`. `writerEPUBMetadata` has
14905 been renamed `writerEpubMetadata` for consistency.
14907 * Changed signatures of `writeODT`, `writeDocx`, `writeEPUB`, since they no
14908 longer stylesheet, fonts, reference files as separate parameters.
14910 * Removed `writerLiterateHaskell` from `WriterOptions`, and
14911 `readerLiterateHaskell` from `ReaderOptions`. LHS is now handled
14912 by an extension (`Ext_literate_haskell`).
14914 * Removed deprecated `writerXeTeX`.
14916 * Removed `writerStrict` from `WriterOptions`. Added `writerExtensions`.
14917 Strict is now handled through extensions.
14919 * `Text.Pandoc.Options` exports `pandocExtensions`, `strictExtensions`,
14920 `phpMarkdownExtraExtensions`, `githubMarkdownExtensions`,
14921 and `multimarkdownExtensions`, as well as the `Extensions` type.
14923 * New `Text.Pandoc.Readers.MediaWiki` module, exporting
14924 `readMediaWiki`.
14926 * New `Text.Pandoc.Writers.FB2` module, exporting `writeFB2`
14927 (thanks to Sergey Astanin).
14929 * `Text.Pandoc`:
14931 + Added `getReader`, `getWriter` to `Text.Pandoc`.
14932 + `writers` is now an association list `(String, Writer)`.
14933 A `Writer` can be a `PureStringWriter`, an `IOStringWriter`, or
14934 an `IOByteStringWriter`. ALL writers are now in the 'writers'
14935 list, including the binary writers and FB2 writer. This allows
14936 code in `pandoc.hs` to be simplified.
14937 + Changed type of `readers`, so all readers are in IO.
14938 Users who want pure readers can still get them form the reader
14939 modules; this just affects the function `getReader` that looks up
14940 a reader based on the format name. The point of this change is to
14941 make it possible to print warnings from the parser.
14943 * `Text.Pandoc.Parsing`:
14945 + `Text.Parsec` now exports all Parsec functions used in pandoc code.
14946 No other module directly imports Parsec. This will make it easier
14947 to change the parsing backend in the future, if we want to.
14948 + `Text.Parsec` is used instead of `Text.ParserCombinators.Parsec`.
14949 + Export the type synonym `Parser`.
14950 + Export `widthsFromIndices`, `NoteTable'`, `KeyTable'`, `Key'`, `toKey'`,
14951 `withQuoteContext`, `singleQuoteStart`, `singleQuoteEnd`,
14952 `doubleQuoteStart`, `doubleQuoteEnd`, `ellipses`, `apostrophe`,
14953 `dash`, `nested`, `F(..)`, `askF`, `asksF`, `runF`, `lineBlockLines`.
14954 + `ParserState` is no longer an instance of `Show`.
14955 + Added `stateSubstitutions` and `stateWarnings` to `ParserState`.
14956 + Generalized type of `withQuoteContext`.
14957 + Added `guardEnabled`, `guardDisabled`, `getOption`.
14958 + Removed `failIfStrict`.
14959 + `lookupKeySrc` and `fromKey` are no longer exported.
14961 * `Data.Default` instances are now provided for `ReaderOptions`,
14962 `WriterOptions`, and `ParserState`. `Text.Pandoc` re-exports `def`.
14963 Now you can use `def` (which is re-exported by `Text.Pandoc`) instead
14964 of `defaultWriterOptions` (which is still defined). Closes #546.
14966 * `Text.Pandoc.Shared`:
14968 + Added `safeRead`.
14969 + Renamed `removedLeadingTrailingSpace` to `trim`,
14970 `removeLeadingSpace` to `triml`, and `removeTrailingSpace` to `trimr`.
14971 + Count `\r` as space in `trim` functions.
14972 + Moved `renderTags'` from HTML reader and `Text.Pandoc.SelfContained`
14973 to `Shared`.
14974 + Removed `failUnlessLHS`.
14975 + Export `compactify'`, formerly in Markdown reader.
14976 + Export `isTightList`.
14977 + Do not export `findDataFile`.
14978 + `readDataFile` now returns a strict ByteString.
14979 + Export `readDataFileUTF8` which returns a String, like the
14980 old `readDataFile`.
14981 + Export `fetchItem` and `openURL`.
14983 * `Text.Pandoc.ImageSize`: Use strict, not lazy bytestrings.
14984 Removed `readImageSize`.
14986 * `Text.Pandoc.UTF8`: Export `encodePath`, `decodePath`,
14987 `decodeArg`, `toString`, `fromString`, `toStringLazy`,
14988 `fromStringLazy`.
14990 * `Text.Pandoc.UTF8` is now an exposed module.
14992 * `Text.Pandoc.Biblio`:
14994 + csl parameter now a `String` rather than a `FilePath`.
14995 + Changed type of `processBiblio`. It is no longer in the IO monad.
14996 It now takes a `Maybe Style` argument rather than parameters for CSL
14997 and abbrev filenames. (`pandoc.hs` now calls the functions to parse
14998 the style file and add abbreviations.)
15000 * Markdown reader now exports `readMarkdownWithWarnings`.
15002 * `Text.Pandoc.RTF` now exports `writeRTFWithEmbeddedImages` instead of
15003 `rtfEmbedImage`.
15005### Bug fixes
15007 * Make `--ascii` work properly with `--self-contained`. Closes #568.
15009 * Markdown reader:
15011 + Fixed link parser to avoid exponential slowdowns. Closes #620.
15012 Previously the parser would hang on input like this:
15014 [[[[[[[[[[[[[[[[[[hi
15016 We fixed this by making the link parser parser characters
15017 between balanced brackets (skipping brackets in inline code spans),
15018 then parsing the result as an inline list. One change is that
15020 [hi *there]* bud](/url)
15022 is now no longer parsed as a link. But in this respect pandoc behaved
15023 differently from most other implementations anyway, so that seems okay.
15025 + Look for raw html/latex blocks before tables.
15026 Otherwise the following gets parsed as a table:
15028 \begin{code}
15029 --------------
15030 -- My comment.
15031 \end{code}
15033 Closes #578.
15035 * RST reader:
15037 + Added support for `:target:` on `.. image::` blocks
15038 and substitutions.
15039 + Field list fixes:
15041 - Fixed field lists items with body beginning after a new line
15042 (Denis Laxalde).
15043 - Allow any char but ':' in names of field lists in RST reader
15044 (Denis Laxalde).
15045 - Don't allow line breaks in field names.
15046 - Require whitespace after field list field names.
15047 - Don't create empty definition list for metadata field lists.
15048 Previously a field list consisting only of metadata fields (author,
15049 title, date) would be parsed as an empty DefinitionList, which is
15050 not legal in LaTeX and not needed in any format.
15052 + Don't recognize inline-markup starts inside words.
15053 For example, `2*2 = 4*1` should not contain an emphasized
15054 section. Added test case for "Literal symbols". Closes #569.
15055 + Allow dashes as separator in simple tables. Closes #555.
15056 + Added support for `container`, `compound`, `epigraph`,
15057 `rubric`, `highlights`, `pull-quote`.
15058 + Added support for `.. code::`.
15059 + Made directive labels case-insensitive.
15060 + Removed requirement that directives begin at left margin.
15061 This was (correctly) not in earlier releases; docutils doesn't
15062 make the requirement.
15063 + Added support for `replace::` and `unicode::` substitutions.
15064 + Ignore unknown interpreted roles.
15065 + Renamed image parser to `subst`, since it now handles all
15066 substitution references.
15068 * Textile reader:
15070 + Allow newlines before pipes in table. Closes #654.
15071 + Fixed bug with list items containing line breaks.
15072 Now pandoc correctly handles hard line breaks inside list items.
15073 Previously they broke list parsing.
15074 + Implemented comment blocks.
15075 + Fixed bug affected words ending in hyphen.
15076 + Properly handle links with surrounding brackets.
15077 Square brackets need to be used when the link isn't surrounded by
15078 spaces or punctuation, or when the URL ending may be ambiguous.
15079 Closes #564.
15080 + Removed nullBlock. Better to know about parsing problems than
15081 to skip stuff when we get stuck.
15082 + Allow ID attributes on headers.
15083 + Textile reader: Avoid parsing dashes as strikeout.
15084 Previously the input
15086 text--
15087 text--
15088 text--
15089 text--
15091 would be parsed with strikeouts rather than dashes. This fixes
15092 the problem by requiring that a strikeout delimiting - not be
15093 followed by a -. Closes #631.
15094 + Expanded list of `stringBreakers`.
15095 This fixes a bug on input like "(_hello_)" which should
15096 be a parenthesized emphasized "hello".
15097 The new list is taken from the PHP source of textile 2.4.
15098 + Fixed autolinks. Previously the textile reader and writer
15099 incorrectly implented RST-style autolinks for URLs and email
15100 addresses. This has been fixed. Now an autolink is done this way:
15101 `"$":http://myurl.com`.
15102 + Fixed footnotes bug in textile. This affected notes occurring
15103 before punctuation, e.g. `foo[1].`. Closes #518.
15105 * LaTeX reader:
15107 + Better handling of citation commands.
15108 + Better handling of `\noindent`.
15109 + Added a 'try' in rawLaTeXBlock, so we can handle `\begin` without `{`.
15110 Closes #622.
15111 + Made `rawLaTeXInline` try to parse block commands as well. This
15112 is usually what we want, given how `rawLaTeXInline` is used in
15113 the markdown and textile readers. If a block-level LaTeX command
15114 is used in the middle of a paragraph (e.g. `\subtitle` inside a title),
15115 we can treat it as raw inline LaTeX.
15116 + Handle `\slash` command. Closes #605.
15117 + Basic `\enquote` support.
15118 + Fixed parsing of paragraphs beginning with a group. Closes #606.
15119 + Use curly quotes for bare straight quotes.
15120 + Support obeylines environment. Closes #604.
15121 + Guard against "begin", "end" in inlineCommand and
15122 blockCommand.
15123 + Better error messages for environments. Now it should tell you that
15124 it was looking for \end{env}, instead of giving "unknown parse error."
15126 * HTML reader:
15128 + Added HTML 5 tags to list of block-level tags.
15129 + HTML reader: Fixed bug in `htmlBalanced`, which
15130 caused hangs in parsing certain markdown input using
15131 strict mode.
15132 + Parse `<q>` as `Quoted DoubleQuote`.
15133 + Handle nested `<q>` tags properly.
15134 + Modified `htmlTag` for fewer false positives.
15135 A tag must start with `<` followed by `!`,`?`, `/`, or a letter.
15136 This makes it more useful in the wikimedia and markdown parsers.
15138 * DocBook reader: Support title in "figure" element. Closes #650.
15140 * MediaWiki writer:
15142 + Remove newline after `<br/>` in translation of `LineBreak`
15143 There's no particular need for a newline (other than making the
15144 generated MediaWiki source look nice to a human), and in fact
15145 sometimes it is incorrect: in particular, inside an enumeration, list
15146 items cannot have embedded newline characters. (Brent Yorgey)
15147 + Use `<code>` not `<tt>` for Code.
15149 * Man writer: Escape `-` as `\-`.
15150 Unescaped `-`'s become hyphens, while `\-`'s are left as ascii minus
15151 signs. That is preferable for use with command-line options. See
15152 <http://lintian.debian.org/tags/hyphen-used-as-minus-sign.html>. Thanks
15153 to Andrea Bolognani for bringing the issue to our attention.
15155 * RST writer:
15157 + Improved line block output. Use nonbreaking spaces for
15158 initial indent (otherwise lost in HTML and LaTeX).
15159 Allow multiple paragraphs in a single line block.
15160 Allow soft breaks w continuations in line blocks.
15161 + Properly handle images with no alt text. Closes #678.
15162 + Fixed bug with links with duplicate text. We now (a) use anonymous
15163 links for links with inline URLs, and (b) use an inline link instead
15164 of a reference link if the reference link would require a label that
15165 has already been used for a different link. Closes #511.
15166 + Fixed hyperlinked images. Closes #611. Use `:target:`
15167 field when you have a simple linked image.
15168 + Don't add `:align: center` to figures.
15170 * Texinfo writer: Fixed internal cross-references.
15171 Now we insert anchors after each header, and use `@ref` instead of `@uref`
15172 for links. Commas are now escaped as `@comma{}` only when needed;
15173 previously all commas were escaped. (This change is needed, in part,
15174 because `@ref` commands must be followed by a real comma or period.) Also
15175 insert a blank line in from of `@verbatim` environments.
15177 * DocBook writer:
15179 + Made --id-prefix work in DocBook as well as HTML.
15180 Closes #607.
15181 + Don't include empty captions in figures. Closes #581.
15183 * LaTeX writer:
15185 + Use `\hspace*` for nonbreaking space after line break,
15186 since `~` spaces after a line break are just ignored.
15187 Closes #687.
15188 + Don't escape `_` in URLs or hyperref identifiers.
15189 + Properly escape strings inside `\url{}`. Closes #576.
15190 + Use `[fragile]` only for slides containing code rendered
15191 using listings. Closes #649.
15192 + Escape `|` as `\vert` in LaTeX math. This avoids a clash with
15193 highlighting-kate's macros, which redefine `|` as a short verbatim
15194 delimiter. Thanks to Björn Peemöller for raising this issue.
15195 + Use minipage rather than parbox for block containers in tables.
15196 This allows verbatim code to be included in grid tables.
15197 Closes #663.
15198 + Prevent paragraphs containing only linebreaks or spaces.
15200 * HTML writer:
15202 + Included `highlighting-css` for code spans, too.
15203 Previously it was only included if used in a code block. Closes #653.
15204 + Improved line breaks with `<dd>` tags. We now put a newline between
15205 `</dd>` and `<dd>` when there are multiple definitions.
15206 + Changed mathjax cdn url so it doesn't use https. (This caused
15207 problems when used with `--self-contained`.) See #609.
15209 * EPUB writer:
15211 + `--number-sections` now works properly.
15212 + Don't strip meta and link elements in epub metadata.
15213 Patch from aberrancy. Closes #589.
15214 + Fixed a couple validation bugs.
15215 + Use ch001, ch002, etc. for chapter filenames. This improves sorting
15216 of chapters in some readers, which apparently sort ch2 after ch10.
15217 Closes #610.
15219 * ODT writer: properly set title property (Arlo O'Keeffe).
15221 * Docx writer:
15223 + Fixed bug with nested lists. Previously a list like
15225 1. one
15226 - a
15227 - b
15228 2. two
15230 would come out with a bullet instead of "2."
15231 Thanks to Russell Allen for reporting the bug.
15232 + Use `w:cr` in `w:r` instead of `w:br` for linebreaks.
15233 This seems to fix a problem viewing pandoc-generated
15234 docx files in LibreOffice.
15235 + Use integer ids for bookmarks. Closes #626.
15236 + Added nsid to abstractNum elements. This helps when merging
15237 word documents with numbered or bulleted lists. Closes #627.
15238 + Use separate footnotes.xml for notes.
15239 This seems to help LibreOffice convert the file, even though
15240 it was valid docx before. Closes #637.
15241 + Use rIdNN identifiers for r:embed in images.
15242 + Avoid reading image files again when we've already processed them.
15243 + Fixed typo in `referenc.docx` that prevented image captions from
15244 working. Thanks to Huashan Chen.
15246 * `Text.Pandoc.Parsing`:
15248 + Fixed bug in `withRaw`, which didn't correctly handle the case
15249 where nothing is parsed.
15250 + Made `emailAddress` parser more correct. Now it is based on RFC 822,
15251 though it still doesn't implement quoted strings in email addresses.
15252 + Revised URI parser. It now allows many more schemes, allows
15253 uppercase URIs, and better handles trailing punctuation and
15254 trailing slashes in bare URIs. Added many tests.
15255 + Simplified and improved singleQuoteStart. This makes `'s'`, `'l'`,
15256 etc. parse properly. Formerly we had some English-centric heuristics,
15257 but they are no longer needed. Closes #698.
15259 * `Text.Pandoc.Pretty`: Added wide punctuation range to `charWidth`.
15260 This fixes bug with Chinese commas in markdown and reST tables, and
15261 a bug that caused combining characters to be dropped.
15263 * `Text.Pandoc.MIME`: Added MIME types for .wof and .eot. Closes #640.
15265 * `Text.Pandoc.Biblio`:
15267 + Run `mvPunc` and `deNote` on metadata too.
15268 This fixed a bug with notes on titles using footnote styles.
15269 + Fixed bug in fetching CSL files from CSL data directory.
15271 * `pandoc.hs`: Give correct value to `writerSourceDirectory` when a URL
15272 is provided. It should be the URL up to the path.
15274 * Fixed/simplified diff output for tests.
15275 Biblio: Make sure mvPunc and deNote run on metadata too.
15276 This fixed a bug with notes on titles using footnote styles.
15278### Under the hood improvements
15280 * We no longer depend on `utf8-string`. Instead we use functions
15281 defined in `Text.Pandoc.UTF8` that use `Data.Text`'s conversions.
15283 * Use `safeRead` instead of using `reads` directly (various modules).
15285 * "Implicit figures" (images alone in a paragraph) are now handled
15286 differently. The markdown reader gives their titles the prefix `fig:`; the
15287 writers look for this before treating the image as a figure. Though this
15288 is a bit of a hack, it has two advantages: (i) implicit figures can be
15289 limited to the markdown reader, and (ii) they can be deactivated by turning
15290 off the `implicit_figures` extension.
15292 * `catch` from `Control.Exception` is now used instead of the
15293 old Preface `catch`.
15295 * `Text.Pandoc.Shared`: Improved algorithm for `normalizeSpaces`
15296 and `oneOfStrings` (which is now non-backtracking).
15298 * `Text.Pandoc.Biblio`: Remove workaround for `toCapital`.
15299 Now citeproc-hs is fixed upstream, so this is no longer needed.
15300 Closes #531.
15302 * Textile reader: Improved speed of `hyphenedWords`.
15303 This speeds up the textile reader by about a factor of 4.
15305 * Use `Text.Pandoc.Builder` in RST reader, for more flexibility,
15306 better performance, and automatic normalization.
15308 * Major rewrite of markdown reader:
15310 + Use `Text.Pandoc.Builder` instead of lists. This also
15311 means that everything is normalized automatically.
15312 + Move to a one-pass parsing strategy, returning values in the reader
15313 monad, which are then run (at the end of parsing) against the final
15314 parser state.
15316 * In HTML writer, we now use `toHtml` instead of pre-escaping.
15317 We work around the problem that blaze-html unnecessarily escapes `'`
15318 by pre-escaping just the `'` characters, instead of the whole string.
15319 If blaze-html later stops escaping `'` characters, we can simplify
15320 `strToHtml` to `toHtml`. Closes #629.
15322 * Moved code for embedding images in RTFs from `pandoc.hs` to the
15323 RTF writer (which now exports `writeRTFWithEmbeddedImages`).
15325 * Moved citation processing from `pandoc.hs` into the readers.
15326 This makes things more convenient for library users.
15328 * The man pages are now built by an executable `make-pandoc-man-pages`,
15329 which has its own stanza in the cabal file so that dependencies can be
15330 handled by Cabal. Special treatment in `Setup.hs` ensures that this
15331 executable never gets installed; it is only used to create the man pages.
15333 * The cabal file has been modified so that the pandoc library is used
15334 in building the pandoc executable. (This required moving `pandoc.hs`
15335 from `src` to `.`.) This cuts compile time in half.
15337 * The `executable` and `library` flags have been removed.
15339 * `-threaded` has been removed from ghc-options.
15341 * Version bounds of dependencies have been raised, and the
15342 `blaze_html_0_5` flag now defaults to True. Pandoc now compiles on
15343 GHC 7.6.
15345 * We now require base >= 4.2.
15347 * Integrated the benchmark program into cabal. One can now do:
15349 cabal configure --enable-benchmarks && cabal build
15350 cabal bench --benchmark-option='markdown' --benchmark-option='-s 20'
15352 The benchmark now uses README + testsuite, so benchmark results
15353 from older versions aren't comparable.
15355 * Integrated test suite with cabal.
15356 To run tests, configure with `--enable-tests`, then `cabal test`.
15357 You can specify particular tests using `--test-options='-t markdown'`.
15358 No output is shown unless tests fail. The Haskell test modules
15359 have been moved from `src/` to `tests/`.
15361 * Moved all data files and templates to the `data/` subdirectory.
15363 * Added an `embed_data_files` cabal flag. This causes all
15364 data files to be embedded in the binary, so that the binary
15365 is self-sufficient and can be relocated anywhere, copied on
15366 a USB key, etc. The Windows installer now uses this.
15367 (Since we no longer have the option to build the executable
15368 without the library, this is the only way to get a relocatable
15369 binary on Windows.)
15371 * Removed pcre3.dll from windows package.
15372 It isn't needed unless highlighting-kate is compiled with the
15373 `pcre-light` flag. By default, regex-prce-builtin is used.
15376## pandoc 1.9.4.5 (2012-10-21)
15378 * Raised version bounds on network, base64-bytestring, json,
15379 and template-haskell.
15381## pandoc 1.9.4.4 (2012-10-20)
15383 * Removed `tests` flag and made test suite into a proper cabal
15384 test suite, which can now be enabled using `--enable-tests`
15385 and run with `cabal test`.
15387 * Moved man page creation out of `Setup.hs` and into an
15388 executable built by Cabal, but never installed. This
15389 allows dependencies to be specified, and solves a problem
15390 with 1.9.4.3, which could only be installed if `data-default`
15391 had already been installed.
15393 * Updated `lhs-latex.tex` test for latest highlighting-kate
15394 representation of backticks.
15396## pandoc 1.9.4.3 (2012-10-20)
15398 * Removed `-threaded` from default compile flags.
15400 * Modified modules to compile with GHC 7.6 and latest version of time
15401 package.
15403## pandoc 1.9.4.2 (2012-06-29)
15405 * Don't encode/decode file paths if base >= 4.4.
15406 Prior to base 4.4, filepaths and command line arguments were treated
15407 as unencoded lists of bytes, not unicode strings, so we had to work
15408 around that by encoding and decoding them. This commit adds CPP
15409 checks for the base version that intelligibly enable encoding/decoding
15410 when needed. Fixes a bug with multilingual filenames when pandoc was
15411 compiled with ghc 7.4 (#540).
15413 * Don't generate an empty H1 after hrule slide breaks.
15414 We now use a slide-level header with contents `[Str "\0"]` to mark
15415 an hrule break. This avoids creation of an empty H1 in these
15416 contexts. Closes #484.
15418 * Docbook reader: Added support for "bold" emphasis. Thanks to mb21.
15420 * In make_osx_package.sh, ensure citeproc-hs is built with the
15421 embed_data_files flag.
15423 * MediaWiki writer: Avoid extra blank lines after sublists (Gavin Beatty).
15425 * ConTeXt writer: Don't escape `&`, `^`, `<`, `>`, `_`,
15426 simplified escapes for `}` and `{` to `\{` and `\}` (Aditya Mahajan).
15428 * Fixed handling of absolute URLs in CSS imports with `--self-contained`.
15429 Closes #535.
15431 * Added webm to mime types. Closes #543.
15433 * Added some missing exports and tests to the cabal file
15434 (Alexander V Vershilov).
15436 * Compile with `-rtsopts` and `-threaded` by default.
15438## pandoc 1.9.4.1 (2012-06-08)
15440 * Markdown reader: Added `cf.` and `cp.` to list of likely abbreviations.
15442 * LaTeX template: Added `linkcolor`, `urlcolor` and `links-as-notes`
15443 variables. Make TOC links black.
15445 * LaTeX template improvements.
15447 + Don't print date unless one is given explicitly in the document.
15448 + Simplified templates.
15449 + Use fontenc [T1] by default, and lmodern.
15450 + Use microtype if available.
15452 * Biblio:
15454 + Add comma to beginning of bare suffix, e.g. `@item1 [50]`.
15455 Motivation: `@item1 [50]` should be as close as possible to
15456 `[@item1, 50]`.
15457 + Added workaround for a bug in citeproc-hs 0.3.4 that causes footnotes
15458 beginning with a citation to be empty. Closes #531.
15460 * Fixed documentation on mixed lists. Closes #533.
15462## pandoc 1.9.4 (2012-06-03)
15464 * Simplified `Text.Pandoc.Biblio` and fixed bugs with citations inside
15465 footnotes and captions. We now handle note citations by inserting
15466 footnotes during initial citation processing, and doing a separate
15467 pass later to remove notes inside notes.
15469 * Added 'zenburn' highlight style from highlighting-kate.
15471 * Added Slideous writer. Slideous is an HTML + javascript slide show
15472 format, similar to Slidy, but works with IE 7. (Jonas Smedegaard)
15474 * LaTeX writer:
15476 + Ensure we don't have extra blank lines at ends of cells.
15477 This can cause LaTeX errors, as they are interpreted as new paragraphs.
15478 + More consistent interblock spacing.
15479 + Require highlighting-kate >= 0.5.1, for proper highlighted inline
15480 code in LaTeX. Closes #527.
15481 + Ensure that a Verbatim at the end of a footnote is followed by
15482 a newline. (Fixes a regression in the previous version.)
15483 + In default template, use black for internal links and TOC.
15484 Added commented-out code to use footnotes for links, as would
15485 be suitable in print output.
15487 * Beamer writer: When `--incremental` is used, lists inside
15488 a block quote should appear all at once. (This makes Beamer
15489 output consistent with the HTML slide show formats.)
15491 * ConTeXt writer:
15493 + Escape `%` as `\letterpercent{}` not `\letterpercent `,
15494 to avoid gobbling spaces after the `%` sign.
15495 + Ensure space after `\stopformula`.
15497 * Markdown writer:
15499 + Use `:` form instead of `~` in definition lists, for better
15500 compatibility with other markdown implementations.
15501 + Don't wrap the term, because it breaks definition lists.
15502 + Use a nonzero space to prevent false recognition
15503 of list marker in ordered lists. Closes #516.
15505 * Org writer: Add space before language name. Closes #523.
15507 * Docx writer: Simplified bullet characters so they work properly
15508 with Word 2007. Closes #520.
15510 * LaTeX reader: Support `\centerline`.
15512 * RST reader: handle figures. Closes #522.
15514 * Textile reader: fix for `<notextile>` and `==`. Closes #517.
15515 (Paul Rivier)
15517## pandoc 1.9.3 (2012-05-12)
15519 * Added docbook reader (with contributions from Mauro Bieg).
15521 * Fixed bug in `fromEntities`. The previous version would turn
15522 `hi & low you know;` into `hi &`.
15524 * HTML reader:
15526 + Don't skip nonbreaking spaces.
15527 Previously a paragraph containing just `&nbsp;` would be rendered
15528 as an empty paragraph. Thanks to Paul Vorbach for pointing out the bug.
15529 + Support `<col>` and `<caption>` in tables. Closes #486.
15531 * Markdown reader:
15533 + Don't recognize references inside delimited code blocks.
15534 + Allow list items to begin with lists.
15536 * LaTeX reader:
15538 + Handle `\bgroup`, `\egroup`, `\begingroup`, `\endgroup`.
15539 + Control sequences can't be followed by a letter.
15540 This fixes a bug where `\begingroup` was parsed as `\begin`
15541 followed by `group`.
15542 + Parse 'dimension' arguments to unknown commands. e.g. `\parindent0pt`
15543 + Make `\label` and `\ref` sensitive to `--parse-raw`.
15544 If `--parse-raw` is selected, these will be parsed as raw latex
15545 inlines, rather than bracketed text.
15546 + Don't crash on unknown block commands (like `\vspace{10pt}`)
15547 inside `\author`; just skip them. Closes #505.
15549 * Textile reader:
15551 + Implemented literal escapes with `==` and `<notextile>`. Closes #473.
15552 + Added support for LaTeX blocks and inlines (Paul Rivier).
15553 + Better conformance to RedCloth inline parsing (Paul Rivier).
15554 + Parse '+text+' as emphasized (should be underlined, but this
15555 is better than leaving literal plus characters in the output.
15557 * Docx writer: Fixed multi-paragraph list items. Previously they each
15558 got a list marker. Closes #457.
15560 * LaTeX writer:
15562 + Added `--no-tex-ligatures` option to avoid replacing
15563 quotation marks and dashes with TeX ligatures.
15564 + Use `fixltx2e` package to provide `\textsubscript`.
15565 + Improve spacing around LaTeX block environments:
15566 quote, verbatim, itemize, description, enumerate.
15567 Closes #502.
15568 + Use blue instead of pink for URL links in latex/pdf output.
15570 * ConTeXt writer: Fixed escaping of `%`.
15571 In text, `%` needs to be escaped as `\letterpercent`, not `\%`
15572 Inside URLs, `%` needs to be escaped as `\%`
15573 Thanks to jmarca and adityam for the fix. Closes #492.
15575 * Texinfo writer: Escape special characters in node titles.
15576 This fixes a problem pointed out by Joost Kremers. Pandoc used
15577 to escape an '@' in a chapter title, but not in the corresponding
15578 node title, leading to invalid texinfo.
15580 * Fixed document encoding in texinfo template.
15581 Resolves Debian Bug #667816.
15583 * Markdown writer:
15585 + Don't force delimited code blocks to be flush left.
15586 Fixes bug with delimited code blocks inside lists etc.
15587 + Escape `<` and `$`.
15589 * LaTeX writer: Use `\hyperref[ident]{text}` for internal links.
15590 Previously we used `\href{\#ident}{text}`, which didn't work on
15591 all systems. Thanks to Dirk Laurie.
15593 * RST writer: Don't wrap link references. Closes #487.
15595 * Updated to use latest versions of blaze-html, mtl.
15598## pandoc 1.9.2 (2012-04-05)
15600 * LaTeX reader:
15602 + Made `lstlisting` work as a proper verbatim environment.
15603 + Fixed bug parsing LaTeX tables with one column.
15605 * LaTeX writer:
15607 + Use `{}` around `ctable` caption, so that formatting can be used.
15608 + Don't require eurosym package unless document has a €.
15610 * LaTeX template: Added variables for `geometry`, `romanfont`,
15611 `sansfont`, `mathfont`, `mainfont` so users can more easily
15612 customize fonts.
15614 * PDF writer:
15616 + Run latex engine at least two times, to ensure
15617 that PDFs will have hyperlinked bookmarks.
15618 + Added PDF metadata (title,author) in LaTeX standalone + PDF output.
15620 * Texinfo writer: retain directories in image paths. (Peter Wang)
15622 * RST writer: Better handling of inline formatting, in accord
15623 with docutils' "inline markup recognition rules" (though we don't
15624 implement the unicode rules fully). Now `hi*there*hi` gets
15625 rendered properly as `hi\ *there*\ hi`, and unnecessary
15626 `\ ` are avoided around `:math:`, `:sub:`, `:sup:`.
15628 * RST reader:
15630 + Parse `\ ` as null, not escaped space.
15631 + Allow `` :math:`...` `` even when not followed by blank
15632 or `\`. This does not implement the complex rule docutils follows,
15633 but it should be good enough for most purposes.
15634 + Add support for the rST default-role directive. (Greg Maslov)
15636 * Text.Pandoc.Parsing: Added `stateRstDefaultRole` field to `ParserState`.
15637 (Greg Maslov)
15639 * Markdown reader: Properly handle citations nested in other inline
15640 elements.
15642 * Markdown writer: don't replace empty alt in image with "image".
15644 * DZSlides: Updated template.html and styles in default template.
15645 Removed bizarre CSS for `q` in dzslides template.
15647 * Avoid repeated `id` attribute in section and header in HTML slides.
15649 * README improvements: new instructions on internal links,
15650 removed misleading note on reST math.
15652 * Build system:
15654 + Fixed Windows installer so that dzslides works.
15655 + Removed stripansi.sh.
15656 + Added .travis.yml for Travis continuous integration support..
15657 + Fixed upper bound for zlib (Sergei Trofimovich).
15658 + Fixed upper bound for test-framework.
15659 + Updated haddocks for haddock-2.10 (Sergei Trofimovich).
15662## pandoc 1.9.1.2 (2012-03-09)
15664 * Added `beamer+lhs` as output format.
15666 * Don't escape `<` in `<style>` tags with `--self-contained`.
15667 This fixes a bug which prevented highlighting from working
15668 when using `--self-contained`.
15670 * PDF: run latex engine three times if `--toc` specified.
15671 This fixes page numbers in the table of contents.
15673 * Docx writer: Added TableNormal style to tables.
15675 * LaTeX math environment fixes. `aligned` is now used instead of
15676 the nonexistent `aligned*`. `multline` instead of the nonexistent
15677 `multiline`.
15679 * LaTeX writer: Use `\textasciitilde` for literal `~`.
15681 * HTML writer: Don't escape contents of EQ tags with --gladtex.
15682 This fixes a regression from 1.8.
15684 * Use `<q>` tags for Quoted items for HTML5 output.
15685 The quote style can be changed by modifying the template
15686 or including a css file. A default quote style is included.
15688 * LaTeX reader: Fixed accents (\~{a}, `\c{c}`).
15689 Correctly handle \^{}. Support "minted" as a LaTeX verbatim block.
15691 * Updated LaTeX template for better language support.
15692 Use `polyglossia` instead of `babel` with xetex.
15693 Set `lang` as documentclass option.
15694 `\setmainlanguage` will use the last of a comma-separated
15695 list of languages. Thanks to François Gannaz.
15697 * Fixed default LaTeX template so `\euro` and `€` work. The
15698 `eurosym` package is needed if you are using pdflatex.
15700 * Fixed escaping of period in man writer (thanks to Michael Thompson).
15702 * Fixed list label positions in beamer.
15704 * Set `mainlang` variable in context writer.
15705 This parallels behavior of latex writer. `mainlang` is the last
15706 of a comma-separated list of languages in lang.
15708 * EPUB language metadat: convert e.g. `en_US` from locale to `en-US`.
15710 * Changed `-V` so that you can specify a key without a value.
15711 Such keys get the value `true`.
15713 * Fixed permissions on installed man pages - thanks Magnus Therning.
15715 * Windows installer: require XP or higher. The installer is
15716 now compiled on a Windows 7 machine, which fixes a problem
15717 using citation functions on Windows 7.
15719 * OSX package: Check for 64-bit Intel CPU before installing.
15722## pandoc 1.9.1.1 (2012-02-11)
15724 * Better handling of raw latex environments in markdown. Now
15726 \begin{equation}
15727 a_1
15728 \end{equation}
15730 turns into a raw latex block as expected.
15732 * Improvements to LaTeX reader:
15734 + Skip options after block commands.
15735 + Correctly handle `{\\}` in braced.
15736 + Added a needed 'try'.
15737 + Citations: add `, ` to suffix if it doesn't start with space or
15738 punctuation. Otherwise we get no space between the year and the
15739 suffix in author-date styles.
15741 * Added two needed data files for S5. This fixes a problem with
15742 `pandoc -t s5 --self-contained`. Also removed `slides.min.js`,
15743 which was no longer being used.
15745 * Fixed some minor problems in `reference.docx`:
15746 name on "Date" style, `xCs` instead of `xIs`.
15748 * Fixed a problem creating docx files using a reference docx
15749 modified using Word. The problem seems to be that Word
15750 modifies `_rels/.rels`, changing the Type of the Relationship to
15751 `docProps/core.xml`. Pandoc now changes this back to the correct
15752 value if it has been altered, fixing the problem.
15754 * Fixed html5 template so it works properly with highlighting.
15756## pandoc 1.9.1 (2012-02-09)
15758 * LaTeX reader:
15760 + Fixed regression in 1.9; properly handle escaped $ in latex math.
15761 + Put LaTeX verse environments in blockquotes.
15763 * Markdown reader:
15765 + Limit nesting of strong/emph. This avoids exponential lookahead
15766 in parasitic cases, like `a**a*a**a*a**a*a**a*a**a*a**a*a**a*a**`.
15767 + Improved attributes syntax (in code blocks/spans): (1)
15768 Attributes can contain line breaks. (2) Values in key-value
15769 attributes can be surrounded by either double or single quotes, or
15770 left unquoted if they contain no spaces.
15772 * Headers no longer wrap in markdown or RST writers.
15774 * Added `stateMaxNestingLevel` to `ParserState`.
15775 We set this to 6, so you can still have `Emph` inside `Emph`,
15776 just not indefinitely.
15778 * More efficient implementation of `nowrap` in `Text.Pandoc.Pretty`.
15780 * `Text.Pandoc.PDF`: Only run latex twice if `\tableofcontents`
15781 is present.
15783 * Require highlighting-kate >= 0.5.0.2, texmath >= 0.6.0.2.
15785## pandoc 1.9.0.5 (2012-02-06)
15787 * Changed cabal file so that build-depends for the test program
15788 are not required unless the tests flag is used.
15790 * LaTeX writer: insert `{}` between adjacent hyphens so they don't
15791 form ligatures (dashes) in code spans.
15793## pandoc 1.9.0.4 (2012-02-06)
15795 * Raised version bound on test-framework to avoid problems
15796 compiling tests on GHC 7.4.1.
15798 * LaTeX reader: Use raw LaTeX as fallback inline text for Cites,
15799 so citations don't just disappear unless you process with
15800 citeproc. Ignore `\bibliographystyle`, `\nocite`.
15802 * Simplified tex2pdf; it will always run latex twice to
15803 resolve table of contents and hyperrefs.
15805## pandoc 1.9.0.3 (2012-02-06)
15807 * Require Cabal >= 1.10.
15809 * Tweaked cabal file to meet Cabal 1.10 requirements.
15811## pandoc 1.9.0.2 (2012-02-05)
15813 * Allow build with json 0.4 or 0.5. Otherwise we can't build with
15814 ghc 6.12.
15816## pandoc 1.9 (2012-02-05)
15818### New features
15820 * Added a Microsoft Word `docx` writer. The writer includes support
15821 for highlighted code and for math (which is converted from TeX to OMML,
15822 Office's native math markup language, using texmath's new OMML module).
15823 A new option `--reference-docx` allows the user to customize the
15824 styles.
15826 * Added an `asciidoc` writer (<http://www.methods.co.nz/asciidoc/>).
15828 * Better support for slide shows:
15830 + Added a `dzslides` writer. DZSlides is a lightweight HTML5/javascript
15831 slide show format due to Paul Rouget (<http://paulrouget.com/dzslides/>).
15833 + Added a LaTeX `beamer` writer. Beamer is a LaTeX package for creating
15834 slide presentations.
15836 + New, flexible rules for dividing documents into sections and slides
15837 (see the "Structuring the slide show" in the User's Guide). These
15838 are backward-compatible with the old rules, but they allow slide
15839 shows to be organized into sections and subsections containing
15840 multiple slides.
15842 + A new `--slide-level` option allows users to override defaults
15843 and select a slide level below the first header level with content.
15845 * A new `--self-contained` option produces HTML output that does not
15846 depend on an internet connection or the presence of any external
15847 files. Linked images, CSS, and javascript is downloaded (or fetched
15848 locally) and encoded in `data:` URIs. This is useful for making portable
15849 `HTML slide shows. The --offline` option has been deprecated and is now
15850 `treated as a synonym or --self-contained`.
15852 * Support for PDF output:
15854 + Removed the old `markdown2pdf`.
15855 + `pandoc` can now create PDFs (assuming you have latex and a set of
15856 appropriate packages installed): just specify an output file with the
15857 `.pdf` extension.
15858 + A new option `--latex-engine` allows you to specify `pdflatex`,
15859 `xelatex`, or `lualatex` as the processor.
15861 * Highlighting changes:
15863 + Syntax highlighting is now a standard feature; the `highlighting`
15864 flag is no longer needed when compiling.
15865 + A new `--no-highlight` option allows highlighting to be disabled.
15866 + Highlighting now works in `docx`, `latex`, and `epub`, as well as
15867 `html`, `html5`, `dzslides`, `s5`, and `slidy`.
15868 + A new `--highlight-style` option selects between various highlighting
15869 color themes.
15871 * Internal links to sections now work in ConTeXt and LaTeX as well as HTML.
15873 * LaTeX `\include` and `\usepackage` commands are now processed,
15874 provided the files are in the working directory.
15876 * EPUB improvements:
15878 + Internal and external links now work in EPUB.
15879 + Raw HTML is allowed.
15880 + New `--epub-embed-font` option.
15881 + Customizable templates for EPUB pages offer more control over
15882 formatting: `epub-page.html`, `epub-coverimage.html`,
15883 `epub-titlepage.html`.
15885 * `--mathml` now works with DocBook.
15887 * Added support for math in RST reader and writer. Inline math uses the
15888 `` :math:`...` `` construct. Display math uses
15890 .. math:: ...
15892 or if the math is multiline,
15894 .. math::
15896 ...
15898 These constructions are now supported now by `rst2latex.py`.
15900 * Github syntax for fenced code blocks is supported in pandoc's
15901 markdown. You can now write
15903 ```ruby
15904 x = 2
15905 ```
15907 instead of
15909 ~~~ {.ruby}
15910 x = 2
15911 ~~~~
15913 * Easier scripting: a new `toJsonFilter` function makes it easier to
15914 write Haskell scripts to manipulate the Pandoc AST.
15915 See [Scripting with pandoc](scripting.html#pandoc-1.9-changes).
15917### Behavior changes
15919 * Fixed parsing of consecutive lists in markdown.
15920 Pandoc previously behaved like Markdown.pl for consecutive
15921 lists of different styles. Thus, the following would be parsed
15922 as a single ordered list, rather than an ordered list followed
15923 by an unordered list:
15925 1. one
15926 2. two
15928 - one
15929 - two
15931 This change makes pandoc behave more sensibly, parsing this as
15932 two lists. Any change in list type (ordered/unordered) or in
15933 list number style will trigger a new list. Thus, the following
15934 will also be parsed as two lists:
15936 1. one
15937 2. two
15939 a. one
15940 b. two
15942 Since we regard this as a bug in Markdown.pl, and not something
15943 anyone would ever rely on, we do not preserve the old behavior
15944 even when `--strict` is selected.
15946 * Dashes work differently with `--smart`: `---` is always em-dash,
15947 and `--` is always en-dash. Pandoc no longer tries to guess when
15948 `-` should be en-dash. *Note:* This may change how existing documents
15949 look when processed with pandoc. A new option, `--old-dashes`,
15950 is provided for legacy documents.
15952 * The markdown writer now uses setext headers for levels 1-2.
15953 The old behavior (ATX headers for all levels) can be restored
15954 using the new `--atx-headers` option.
15956 * Links are now allowed in markdown image captions. They are also
15957 allowed in links, but will appear there as regular text. So,
15959 [link with [link](/url)](/url)
15961 will turn into
15963 <p><a href="/url">link with link</a></p>
15965 * Improved handling of citations using `citeproc-hs-0.3.4`.
15966 Added `--citation-abbreviations` option.
15968 * Citation keys can no longer end with a punctuation character.
15969 This means that `@item1.` will be parsed as a citation with key
15970 'item1', followed by a period, instead of a citation with key
15971 'item1.', as was the case previously.
15973 * In HTML output, citations are now put in a span with class `citation`.
15975 * The markdown reader now recognizes DocBook block and inline tags.
15976 It was always possible to include raw DocBook tags in a markdown
15977 document, but now pandoc will be able to distinguish block from
15978 inline tags and behave accordingly. Thus, for example,
15980 <sidebar>
15981 hello
15982 </sidebar>
15984 will not be wrapped in `<para>` tags.
15986 * The LaTeX parser has been completely rewritten; it is now much more
15987 accurate, robust, and extensible. However, there are two important
15988 changes in how it treats unknown LaTeX. (1) Previously, unknown
15989 environments became BlockQuote elements; now, they are treated
15990 as "transparent", so `\begin{unknown}xyz\end{unknown}` is the
15991 same as `xyz`. (2) Previously, arguments of unknown commands
15992 were passed through with their braces; now the braces are stripped
15993 off.
15995 * `--smart` is no longer selected automatically with `man` output.
15997 * The deprecated `--xetex` option has been removed.
15999 * The `--html5`/`-5` option has been deprecated. Use `-t html5`
16000 instead. `html5` and `html5+lhs` are now separate output formats.
16002 * Single quotes are no longer escaped in HTML output. They do not
16003 need to be escaped outside of attributes.
16005 * Pandoc will no longer transform leading newlines in code
16006 blocks to `<br/>` tags.
16008 * The ODT writer now sizes images appropriately, using the image
16009 size and DPI information embedded in the image.
16011 * `--standalone` is once again implicitly for a non-text output format
16012 (ODT, EPUB). You can again do `pandoc test.txt -o test.odt`
16013 and get a standalone ODT file.
16015 * The Docbook writer now uses `<sect1>`, `<sect2>`, etc. instead of
16016 `<section>`.
16018 * The HTML writer now uses `<del>` for strikeout.
16020 * In HTML output with `--section-divs`, the classes `section` and
16021 `level[1,2,..6]` are put on the `div` tags so they can be styled.
16022 In HTML 5 output with `--section-divs`, the classes
16023 `level[1,2,...6]` are put on `section` tags.
16025 * EPUB writer changes:
16027 + The `lang` variable now sets the language
16028 in the metadata (if it is not set, we default to the locale).
16029 + EPUB: UTF-8 is used rather than decimal entities.
16031 * Added `titleslide` class to title slide in S5 template.
16033 * In HTML, EPUB, and docx metadata, the date is normalized into
16034 YYYY-MM-DD format if possible. (This is required for validation.)
16036 * Attributes in highlighted code blocks are now preserved in HTML.
16037 The container element will have the classes, id, and key-value attributes
16038 you specified in the delimited code block. Previously these were stripped
16039 off.
16041 * The reference backlink in the HTML writer no longer has a special
16042 `footnoteBacklink` class.
16044 * The HTML template has been split into `html` and `html5` templates.
16046 * Author and date are treated more consistently in HTML templates.
16047 Authors are now `<h2>`, date `<h3>`.
16049 * URLs are hyphenated in the ConTeXt writer (B. Scott Michel).
16051 * In `Text.Pandoc.Builder`, `+++` has been replaced by `<>`.
16053### Bug fixes
16055 * Better support for combining characters and East Asian wide characters
16056 in markdown and reST.
16058 * Better handling of single quotes with `--smart`.
16059 Previously `D'oh l'*aide*` would be parsed with left and right single
16060 quotes instead of apostrophes. This kind of error is now fixed.
16062 * Highlighting: Use `reads` instead of `read` for better error handling.
16063 Fixes crash on `startNum="abc"`.
16065 * Added blank comment after directives in rst template.
16067 * Unescape entities in citation `refId`. The `refId`s coming
16068 from citeproc contain XML numeric entities, and these don't match with the
16069 citation keys parsed by pandoc. Solution is to unescape them.
16071 * HTML reader: Fixed bug parsing tables with both thead and tbody.
16073 * Markdown reader:
16075 + Better handling of escapes in link URLs and titles.
16076 + Fixed backslash escapes in reference links.
16077 + Fixed bug in table/hrule parsing, by checking that the top
16078 line of a table is not followed by a blank line. This bug caused
16079 slowdowns on some files with hrules and tables, as pandoc tried to
16080 interpret the hrules as the tops of multiline tables.
16081 + Fixed bug in code block attribute parser. Previously the ID attribute
16082 got lost if it didn't come first. Now attributes can come in any order.
16084 * RST reader: allow footnotes followed by newline without space characters.
16086 * LaTeX reader:
16088 + Ignore empty groups {}, { }.
16089 + LaTeX reader: Handle `\@`.
16090 + LaTeX reader: Don't crash on commands like `\itemsep`.
16091 + LaTeX reader: Better handling of letter environments.
16093 * RST writer: Fixed bug involving empty table cells. isSimple was being
16094 calculated in a way that assumed there were no non-empty cells.
16096 * ConTeXt writer:
16098 + Made `--toc` work even without `--number-sections`.
16099 + Escape # in link URLs.
16100 + Use buffering for footnotes containing code blocks.
16101 + Changed 'descr' to 'description', fixed alignment.
16103 * LaTeX writer:
16105 + Escape euro character.
16106 + Don't escape `~` inside `\href{...}`.
16107 + Escape `#` in href URLs.
16108 + Improved detection of book classes. We now check the
16109 `documentclass` variable, and if that is not set, we look through
16110 the template itself. Also, we have added the KOMA classes scrreprt
16111 and scrbook. You can now make a book using
16112 `pandoc -V documentclass:book mybook.txt -o mybook.pdf`
16113 + LHS files now set the "listings" variable, so that the definition
16114 of the `code` environment will be included in the template.
16115 + Links are colored blue by default (this can be changed by
16116 modifying `hyperref` settings in the template).
16117 + Added `lang` variable to LaTeX template.
16119 * HTML writer:
16121 + Fixed bug in HTML template with html5 and mathml.
16122 + Don't use self-closing img, br, hr tags for HTML5.
16123 + Use `<section>` for footnotes if HTML5.
16124 + Update HTML templates to use Content-Style-Type meta tag.
16125 + Use separate variables for meta-date, meta-author.
16126 This makes footnotes work in author and date fields.
16127 + Use 'vertical-align:middle' in WebTeX math for better alignment.
16129 * S5/slidy writer: Make footnotes appear on separate slide at end.
16131 * MIME: Added 'layout-cache' to getMimeType. This ensures that the
16132 META-INF/manifest.xml for ODT files will have everything it needs, so
16133 that ODT files modified by LibreOffice can be used as `--reference-odt`.
16135 * `Text.Pandoc.Templates`: Return empty string for json template.
16137 * `Text.Pandoc.Biblio`:
16139 + Expand citations recursively inside nested inlines.
16140 + Treat `\160` as space when parsing locator and suffix.
16141 This fixes a bug with "p. 33" when `--smart` is used. Previously
16142 the whole "p. 33" would be included in the suffix, with no locator.
16143 + Put whole author-in-text citation in a Cite. Previously just the
16144 date and other info went in the Cite.
16145 + Don't add comma+space to prefix if it ends in punctuation.
16147 * Updated chicago-author-date.csl. The old version did not work
16148 properly for edited volumes with no author.
16150 * EPUB writer:
16152 + Add date to EPUB titlepage and metadata.
16153 + Added TOC identifier in EPUB page template.
16154 + Don't generate superfluous file `cover-image.jpg`.
16156### Under the hood improvements
16158 * Modified `make_osx_package.sh` to use cabal-dev.
16159 Items are no longer installed as root.
16160 Man pages are zipped and given proper permissions.
16162 * Modified windows installer generater to use cabal-dev.
16164 * Setup: Making man pages now works with cabal-dev (at least on OSX). In
16165 Setup.hs we now invoke 'runghc' in a way that points it to the correct
16166 package databases, instead of always falling back to the default user
16167 package db.
16169 * Updated to work with GHC 7.4.1.
16171 * Removed dependency on old-time.
16173 * Removed dependency on dlist.
16175 * New slidy directory for "self-contained."
16177 * TeXMath writer: Use unicode thin spaces for thin spaces.
16179 * Markdown citations: don't strip off initial space in locator.
16181### API changes
16183 * Removed `Apostrophe`, `EmDash`, `EnDash`, and `Ellipses`
16184 from the native `Inline` type in pandoc-types. Now we use `Str`
16185 elements with unicode.
16187 * Improvements to `Text.Pandoc.Builder`:
16189 + `Inlines` and `Blocks` are now newtypes (not synonyms for
16190 sequences).
16191 + Instances are defined for `IsString`, `Show`, `Read`, `Monoid`,
16192 and a new `Listable` class, which allows these to be manipulated
16193 to some extent like lists. Monoid append includes automatic
16194 normalization.
16195 + `+++` has been replaced by `<>` (mappend).
16197 * Use blaze-html instead of xhtml for HTML generation.
16198 This changes the type of `writeHtml`.
16200 * `Text.Pandoc.Shared`:
16202 + Added `warn` and `err`.
16203 + Removed `unescapeURI`, modified `escapeURI`.
16204 (See under [behavior changes], above.)
16206 * Changes in URI escaping: Previously the readers escaped URIs by
16207 converting unicode characters to octets and then percent encoding.
16208 Now unicode characters are left as they are, and `escapeURI` only
16209 percent-encodes space characters. This gives more readable
16210 URIs, and works well with modern user agents. URIs are no longer unescaped
16211 at all on conversion to `markdown`, `asciidoc`, `rst`, `org`.
16213 * New module `Text.Pandoc.SelfContained`.
16215 * New module `Text.Pandoc.Docx`.
16217 * New module `Text.Pandoc.PDF`.
16219 * Added `writerBeamer` to `WriterOptions`.
16221 * Added `normalizeDate` to `Text.Pandoc.Shared`.
16223 * Added `splitStringWithIndices` in `Text.Pandoc.Shared`.
16224 This is like `splitWithIndices`, but it is sensitive to distinctions
16225 between wide, combining, and regular characters.
16227 * `Text.Pandoc.Pretty`:
16229 + Added `chomp` combinator.
16230 + Added `beforeNonBreak` combinator. This allows you to include
16231 something conditionally on it being before a nonblank.
16232 Used for RST inline math.
16233 + Added `charWidth` function. All characters marked W or F in the unicode
16234 spec EastAsianWidth.txt get width 2.
16235 + Added `realLength`, based on `charWidth`. `realLength` is now
16236 used in calculating offsets.
16238 * New module `Text.Pandoc.Slides`, for common functions for breaking
16239 a document into slides.
16241 * Removed `Text.Pandoc.S5`, which is no longer needed.
16243 * Removed `Text.Pandoc.CharacterReferences`. Moved
16244 `characterReference` to `Text.Pandoc.Parsing`.
16245 `decodeCharacterReferences` is replaced by `fromEntities`
16246 in `Text.Pandoc.XML`.
16248 * Added `Text.Pandoc.ImageSize`. This is intened for use
16249 in `docx` and `odt` writers, so the size and dpi of images
16250 can be calculated.
16252 * Removed `writerAscii` in `WriterOptions`.
16254 * Added `writerHighlight` to `WriterOptions`.
16256 * Added `DZSlides` to `HTMLSlideVariant`.
16258 * `writeEPUB` has a new argument for font files to embed.
16260 * Added `stateLastStrPos` to `ParserState`. This lets us keep track
16261 of whether we're parsing the position immediately after a regular
16262 (non-space, non-symbol) string, which is useful for distinguishing
16263 apostrophes from single quote starts.
16265 * `Text.Pandoc.Parsing`:
16267 + `escaped` now returns a `Char`.
16268 + Removed `charsInBalanced'`, added a character parser as
16269 a parameter of `charsInBalanced`. This is needed for
16270 proper handling of escapes, etc.
16271 + Added `withRaw`.
16273 * Added `toEntities` to `Text.Pandoc.XML`.
16275 * `Text.Pandoc.Readers.LaTeX`:
16277 + Export `handleIncludes`.
16278 + Export `rawLaTeXBlock` instead of `rawLaTeXEnvironment'`.
16280 * Added `ToJsonFilter` class and `toJsonFilter` function to
16281 `Text.Pandoc`, deprecating the old `jsonFilter` function.
16283 * `Text.Pandoc.Highlighting`:
16285 + Removed `highlightHtml`, `defaultHighlightingCss`.
16286 + Export `formatLaTeXInline`, `formatLaTeXBlock`, and `highlight`, plus
16287 key functions from highlighting-kate.
16288 + Changed types of highlighting function. `highlight` returns a
16289 `Maybe`, not an `Either`.
16292## pandoc 1.8.2.1 (2011-08-01)
16294 * Adjusted Arbitrary instance to help avoid timeouts in tests.
16296 * Added `Tests.Writers.Markdown` to cabal file.
16298 * Relaxed version bounds on pandoc-types, test-framework.
16300## pandoc 1.8.2 (2011-07-30)
16302 * Added script to produce OS X package.
16304 * Made `templates` directory a git submodule. This should make it
16305 easier for people to revise their custom templates when the default
16306 templates change.
16308 * Changed template naming scheme: `FORMAT.template` -> `default.FORMAT`.
16309 **Note:** If you have existing templates in `~/.pandoc/templates`, you
16310 must rename them to conform to the new scheme!
16312 * Default template improvements:
16314 + HTML: Display author and date after title.
16315 + HTML: Made table of contents more customizable. The container
16316 for the TOC is now in the template, so users can insert a header
16317 or other styling. (Thanks to Bruce D'Arcus for the suggestion.)
16318 + HTML, Slidy, S5: Enclose scripts in CDATA tags.
16319 + Slidy, S5: Added `s5-url` and `slidy-url` variables, instead of
16320 hard-coding. If you want to put your slidy files in the slidy
16321 subdirectory, for example, you can do
16322 `pandoc -t slidy -V slidy-url=slidy -s`.
16323 + LaTeX: Use `\and` to separate authors in LaTeX documents (reader
16324 & writer). Closes #279.
16325 + LaTeX: Set `\emergencystretch` to prevent overfull lines.
16326 + LaTeX: Use different `hyperref` options for `xetex`, fixing
16327 problems with unicode bookmarks (thanks to CircleCode).
16328 + LaTeX: Removed `ucs` package, use `utf8` rather than `utf8x`
16329 with `inputenc`. This covers fewer characters but is more
16330 robust with other packages, and `ucs` is unmaintained. Users
16331 who need better unicode support should use xelatex or lualatex.
16333 * If a template specified with `--template` is not found, look for it
16334 in `datadir`. Also, if no extension is provided, supply one based
16335 on the writer. So now you can put your `special.latex` template in
16336 `~/.pandoc/templates`, and use it from any directory via
16337 `pandoc -t latex --template special`.
16339 * Added `nonspaceChar` to `Text.Pandoc.Parsing`.
16341 * Fixed smart quotes bug, now handling `'...hi'` properly.
16343 * RST reader:
16345 + Partial support for labeled footnotes.
16346 + Improved accuracy of `simpleReferenceName` parser.
16348 * HTML reader:
16350 + Substitute correct unicode characters for
16351 characters in the 128..159 range, which are often found even in
16352 HTML that purports to be UTF-8.
16354 * LaTeX reader: Handle `\subtitle` command (a subtitle is added
16355 to the title, after a colon and linebreak). Closes #280.
16357 * Leaner `reference.odt`.
16359 * Added unexported module `Text.Pandoc.MIME` for use in
16360 the ODT writer.
16362 * ODT writer: Construct `manifest.xml` based on archive contents.
16363 This fixes a bug in ODTs containing images. Recent versions of
16364 LibreOffice would reject these as corrupt, because `manifest.xml`
16365 did not contain a reference to the image files.
16367 * LaTeX writer:
16369 + Make verbatim environments flush to avoid spurious
16370 blank lines. Closes #277.
16371 + Use `\texttt` and escapes insntead of `\verb!...!`, which
16372 is too fragile (doesn't work in command arguments).
16373 + Use `\enquote{}` for quotes if the template includes
16374 the `csquotes` package. This provides better support for
16375 local quoting styles. (Thanks to Andreas Wagner for the idea.)
16377 * ConTeXt writer: Make `\starttyping`/`\stoptyping` flush with
16378 margin, preventing spurious blank lines.
16380 * Slidy writer:
16382 + Use non-minimized version of `slidy.css` with `--offline`
16383 option, so users can more easily edit it.
16384 + Also fixed a bug in the CSS that prevented proper centering
16385 of title (now reported and fixed upstream).
16387 * S5 writer:
16389 + Replaced `s5/default/slides.js.{comment,packed}` with
16390 new compressed `s5/default/slides.min.js`.
16391 + Use `data:` protocol to embed S5 CSS in `<link>` tags,
16392 when `--offline` is specified. Using inline CSS didn't
16393 work with Chrome or Safari. This fixes offline
16394 S5 on those browsers.
16396 * HTML writer: Removed English title on footnote backlinks.
16397 This is incongrous in non-English documents.
16399 * Docbook writer:
16401 + Use CALS tables. (Some older docbook software does not work
16402 well with XHTML tables.) Closes #77.
16403 + Use `programlisting` tags (instead of `screen`) for code blocks.
16405 * `markdown2pdf`:
16407 + Calls latex with `-halt-on-error -interaction nonstopmode` instead
16408 of `-interaction=batchmode`, which essentially just ignored errors,
16409 leading to bad results. Better to know when something is wrong.
16410 + Fixed issues with non-UTF-8 output of `pdflatex`.
16411 + Better error reporting.
16413 * `--mathjax` now takes an optional URL argument. If it is not
16414 provided, pandoc links directly to the (secure) mathjax CDN,
16415 as now recommended (thanks to dsanson).
16417 * Deprecated `--xetex` option in `pandoc`. It is no longer needed,
16418 since the LaTeX writer now produces a file that can be processed by
16419 `latex`, `pdflatex`, `lualatex`, or `xelatex`.
16421 * Introduced `--luatex` option to `markdown2pdf`. This causes `lualatex`
16422 to be used to create the PDF.
16425## pandoc 1.8.1.2 (2011-07-16)
16427 * Added `--epub-cover-image` option.
16429 * Documented `--biblatex` and `--natbib` options.
16431 * Allow `--section-divs` with slidy output. Resolves Issue #296.
16433 * Disallow notes within notes in reST and markdown.
16434 These previously caused infinite looping and stack overflows.
16435 For example:
16437 [^1]
16439 [^1]: See [^1]
16441 Note references are allowed in reST notes, so this isn't a full
16442 implementation of reST. That can come later. For now we need to
16443 prevent the stack overflows. Partially resolves Issue #297.
16445 * EPUB writer: Allow non-plain math methods.
16447 * Forbid ()s in citation item keys. Resolves Issue #304: problems with
16448 `(@item1; @item2)` because the final paren was being parsed as part of
16449 the item key.
16451 * Changed URI parser so it doesn't include trailing punctuation.
16452 So, in RST, `http://google.com.` should be parsed as a link followed by a
16453 period. The parser is smart enough to recognize balanced parentheses, as
16454 often occur in wikipedia links: `http://foo.bar/baz_(bam)`.
16456 * Markdown+lhs reader: Require space after inverse bird tracks, so that
16457 HTML tags can be used freely at the left margin of a markdown+lhs document.
16458 Thanks to Conal Elliot for the suggestion.
16460 * Markdown reader: Fixed bug in footnote order (reported by CircleCode).
16462 * RST reader:
16463 + Fixed bug in in field lists with multi-line items at the
16464 end of the list.
16465 + Added parentheses to RST `specialChars`, so
16466 `(http://google.com)` will be parsed as a link in parens.
16467 Resolves Issue #291.
16468 + Allow `|` followed by newline in RST line block.
16470 * LaTeX reader:
16471 + Support `\dots`.
16472 + Gobble option & space after linebreak `\\[10pt]`.
16474 * Textile reader:
16475 + Make it possible to have colons after links. (qerub)
16476 + Make it possible to have colons after links. (Christoffer Sawicki)
16478 * HTML reader:
16479 + Skip spaces after `<b>`, `<emph>`, etc.
16480 + Handle tbody, thead in simple tables. Closes #274.
16481 + Implicit `Para`s instead of `Plains` in some contexts.
16483 * OpenDocument writer: Use special `First paragraph` style for
16484 first paragraph after most non-paragraph blocks. This allows users to
16485 specify e.g. that only paragraphs after the first paragraph of a block are
16486 to be indented. Thanks to Andrea Rossato for the patch. Closes #20.
16488 * LaTeX writer: use `deVerb` on table and picture captions.
16489 Otherwise LaTeX complains about `\verb` inside command argument.
16490 Thanks to bbanier for reporting the bug.
16492 * Markdown writer: Insert HTML comment btw list and indented code block.
16493 This prevents the code block from being interpreted as part of the list.
16495 * EPUB writer: Add a meta element specify the cover.
16496 Some EPUB e-readers, such as the Nook, require a meta element inside the
16497 OPF metadata block to ensure the cover image is properly displayed.
16498 (Kelsey Hightower)
16500 * HTML writer: Use embed tag for images with non-image extensions.
16501 (e.g. PDFs). Closes #264.
16503 * LaTeX writer: Improved tables.
16505 + More space between lines, top-align cells.
16506 + Use ctable package, which allows footnotes and
16507 provides additional options.
16508 + Made cell alignments work in multiline tables.
16509 + Closes #271, #272.
16511 * Un-URI-escape image filenames in LaTeX, ConTeXt, RTF, Texinfo.
16512 Also do this when copying image files into EPUBs and ODTs.
16513 Closes #263.
16515 * Changed to github issue tracker.
16517 * Added failing emph/strong markdown test case due to Perry Wagle.
16519 * Slidy improvements:
16520 + Updated to use Slidy2.
16521 + Fixed bug, unclosed div tag.
16522 + Added `duration` variable in template.
16523 Setting this activates the timer.
16524 + Use 'titlepage' instead of 'cover' for title div.
16527## pandoc 1.8.1.1 (2011-02-13)
16529 * `markdown2pdf`: Removed some debugging lines accidentally included
16530 in the 1.8.1 release. With those lines, the temp directory is created
16531 in the working directory, and it is not deleted. This fix restores
16532 the original behavior.
16534## pandoc 1.8.1 (2011-02-13)
16536 * Added `--ascii` option. Currently supported only in HTML writer,
16537 which it causes to use numerical entities instead of UTF-8.
16539 * EPUB writer: `--toc` now works to provide a table of contents
16540 at the beginning of each chapter.
16542 * LaTeX writer: Change figure defaults to `htbp`.
16543 This prevents "too many unprocessed floats." Resolves
16544 Issue #285.
16546 * `Text.Pandoc.UTF8`: Encode filenames even when using recent
16547 base.
16549 * `markdown2pdf`: Fixed filename encoding issues. With help from Paulo
16550 Tanimoto. Resolves Issue #286.
16552 * HTML writer: Put line breaks in section divs.
16554 * `Text.Pandoc.Shared`: Make `writerSectionDivs` default to False.
16556## pandoc 1.8.0.3 (2011-02-05)
16558 * Fixed Source-repository stanza in cabal file.
16560## pandoc 1.8.0.2 (2011-02-05)
16562 * HTML writer:
16564 + Stringify alt text instead of converting to HTML.
16565 + Break lines after block elements, not inside tags.
16566 HTML output now closely resembles that of tidy. Resolves Issue #134.
16568 * Markdown reader: Fixed bug in footnote block parser (pointed out
16569 by Jesse Rosenthal). The problem arose when the blank line
16570 at the end of a footnote block contained indenting spaces.
16572 * Shared: Improved 'normalize' function so it normalizes Spaces too.
16573 In normal form, Space elements only occur to separate two non-Space
16574 elements. So, we never have [Space], or [, ..., Space].
16576 * Tests:
16578 + Improved Arbitrary instance.
16579 + Added timeout for test instances.
16581 * README:
16583 + Added section on four-space rule for lists. Resolves Issue #283.
16584 + Clarified optional arguments on math options.
16586 * markdown2pdf: Fixed bug with output file extensions.
16587 Previously `markdown2pdf test.txt -o test.en.pdf` would produce
16588 `test.pdf`, not `test.en.pdf`. Thanks to Paolo Tanimoto for the fix.
16590## pandoc 1.8.0.1 (2011-01-31)
16592 * Revised Interact.hs so that it works with the CPP macros
16593 in the UTF8 module.
16595 * Revised Setup.hs so that we don't call MakeManPage.hs unless
16596 the man pages are out of date.
16598## pandoc 1.8 (2011-01-30)
16600### New features
16602 * Support for citations using Andrea Rossato's `citeproc-hs` 0.3.
16603 You can now write, for example,
16605 Water is wet [see @doe99, pp. 33-35; also @smith04, ch. 1].
16607 and, when you process your document using `pandoc`, specifying
16608 a citation style using `--csl` and a bibliography using `--bibliography`,
16609 the citation will be replaced by an appropriately formatted
16610 citation, and a list of works cited will be added to the end
16611 of the document.
16613 This means that you can switch effortlessly between different citation
16614 and bibliography styles, including footnote, numerical, and author-date
16615 formats. The bibliography can be in any of the following formats: MODS,
16616 BibTeX, BibLaTeX, RIS, EndNote, EndNote XML, ISI, MEDLINE, Copac, or JSON.
16617 See the README for further details.
16619 Citations are supported in the markdown reader, using a special
16620 syntax, and in the LaTeX reader, using natbib or biblatex syntax.
16621 (Thanks to Nathan Gass for the natbib and biblatex support.)
16623 * New `textile` reader and writer. Thanks to Paul Rivier for contributing
16624 the `textile` reader, an almost complete implementation of the textile
16625 syntax used by the ruby [RedCloth library](http://redcloth.org/textile).
16626 Resolves Issue #51.
16628 * New `org` writer, for Emacs Org-mode, contributed by Puneeth Chaganti.
16630 * New `json` reader and writer, for reading and writing a JSON
16631 representation of the native Pandoc AST. These are much faster
16632 than the `native` reader and writer, and should be used for
16633 serializing Pandoc to text. To convert between the JSON representation
16634 and native Pandoc, use `encodeJSON` and `decodeJSON` from
16635 `Text.JSON.Generic`.
16637 * A new `jsonFilter` function in `Text.Pandoc` makes it easy
16638 to write scripts that transform a JSON-encoded pandoc document.
16639 For example:
16641 -- removelinks.hs - removes links from document
16642 import Text.Pandoc
16643 main = interact $ jsonFilter $ bottomUp removeLink
16644 where removeLink (Link xs _) = Emph xs
16645 removeLink x = x
16647 To use this to remove links while translating markdown to LaTeX:
16649 pandoc -t json | runghc removelinks.hs | pandoc -f json -t latex
16651 * Attributes are now allowed in inline `Code` elements, for example:
16653 In this code, `ulist ! [theclass "special"] << elts`{.haskell} is...
16655 The attribute syntax is the same as for delimited code blocks.
16656 `Code` inline has an extra argument place for attributes, just like
16657 `CodeBlock`. Inline code will be highlighted in HTML output, if pandoc
16658 is compiled with highlighting support. Resolves Issue #119.
16660 * New `RawBlock` and `RawInline` elements (replacing `RawHtml`,
16661 `HtmlInline`, and `TeX`) provide lots of flexibility in writing
16662 scripts to transform Pandoc documents. Scripts can now change
16663 how each element is rendered in each output format.
16665 * You can now define LaTeX macros in markdown documents, and pandoc
16666 will apply them to TeX math. For example,
16668 \newcommand{\plus}[2]{#1 + #2}
16669 $\plus{3}{4}$
16671 yields `3+4`. Since the macros are applied in the reader, they
16672 will work in every output format, not just LaTeX.
16674 * LaTeX macros can also be used in LaTeX documents (both in math
16675 and in non-math contexts).
16677 * A new `--mathjax` option has been added for displaying
16678 math in HTML using MathJax. Resolves issue #259.
16680 * Footnotes are now supported in the RST reader. (Note, however,
16681 that unlike docutils, pandoc ignores the numeral or symbol used in
16682 the note; footnotes are put in an auto-numbered ordered list.)
16683 Resolves Issue #258.
16685 * A new `--normalize` option causes pandoc to normalize the AST
16686 before writing the document. This means that, for example,
16687 `*hi**there*` will be rendered as `<em>hithere</em>`
16688 instead of `<em>hi</em><em>there</em>`. This is not the default,
16689 because there is a significant performance penalty.
16691 * A new `--chapters` command-line option causes headers
16692 in DocBook, LaTeX, and ConTeXt to start with "chapter" (level one).
16693 Resolves Issue #265.
16695 * In DocBook output, `<chapter>` is now used for top-level
16696 headers if the template contains `<book>`. Resolves Issue #265.
16698 * A new `--listings` option in `pandoc` and `markdown2pdf` causes
16699 the LaTeX writer to use the listings package for code blocks.
16700 (Thanks to Josef Svennigsson for the pandoc patch, and Etienne
16701 Millon for the markdown2pdf patch.)
16703 * `markdown2pdf` now supports `--data-dir`.
16705 * URLs in autolinks now have class "url" so they can be styled.
16707 * Improved prettyprinting in most formats. Lines will be wrapped
16708 more evenly and duplicate blank lines avoided.
16710 * New `--columns` command-line option sets the column width for
16711 line wrapping and relative width calculations for tables.
16713 * Made `--smart` work in HTML, RST, and Textile readers, as well
16714 as markdown.
16716 * Added `--html5` option for HTML5 output.
16718 * Added support for listings package in LaTeX reader
16719 (Puneeth Chaganti).
16721 * Added support for simple tables in the LaTeX reader.
16723 * Added support for simple tables in the HTML reader.
16725 * Significant performance improvements in many readers and writers.
16727### API and program changes
16729 * Moved `Text.Pandoc.Definition` from the `pandoc` package to a new
16730 auxiliary package, `pandoc-types`. This will make it possible for other
16731 programs to supply output in Pandoc format, without depending on the whole
16732 pandoc package.
16734 * Added `Attr` field to `Code`.
16736 * Removed `RawHtml`, `HtmlInline`, and `TeX` elements; added generic
16737 `RawBlock` and `RawInline`.
16739 * Moved generic functions to `Text.Pandoc.Generic`. Deprecated
16740 `processWith`, replacing it with two functions, `bottomUp` and `topDown`.
16741 Removed previously deprecated functions `processPandoc` and `queryPandoc`.
16743 * Added `Text.Pandoc.Builder`, for building `Pandoc` structures.
16745 * `Text.Pandoc` now exports association lists `readers` and `writers`.
16747 * Added `Text.Pandoc.Readers.Native`, which exports `readNative`.
16748 `readNative` can now read full pandoc documents, block lists, blocks,
16749 inline lists, or inlines. It will interpret `Str "hi"`
16750 as if it were `Pandoc (Meta [] [] []) [Plain [Str "hi"]]`.
16751 This should make testing easier.
16753 * Removed deprecated `-C/--custom-header` option.
16754 Use `--template` instead.
16756 * `--biblio-file` has been replaced by `--bibliography`.
16757 `--biblio-format` has been removed; pandoc now guesses the format
16758 from the file extension (see README).
16760 * pandoc will treat an argument as a URI only if it has an
16761 `http(s)` scheme. Previously pandoc would treat some
16762 Windows pathnames beginning with `C:/` as URIs.
16764 * The `--sanitize-html` option and the `stateSanitize` field in
16765 `ParserState` have been removed. Sanitization is better done in the
16766 resulting HTML using `xss-sanitize`, which is based on pandoc's
16767 sanitization, but improved.
16769 * pandoc now adds a newline to the end of its output in fragment
16770 mode (= not `--standalone`).
16772 * Added support for `lang` in `html` tag in the HTML template,
16773 so you can do `pandoc -s -V lang=es`, for example.
16775 * `highlightHtml` in `Text.Pandoc.Highlighting` now takes
16776 a boolean argument that selects between "inline" and
16777 "block" HTML.
16779 * `Text.Pandoc.Writers.RTF` now exports `rtfEmbedImage`.
16780 Images are embedded in RTF output when possible (png, jpeg).
16781 Resolves Issue #275.
16783 * Added `Text.Pandoc.Pretty`. This is better suited for pandoc than the
16784 `pretty` package. Changed all writers that used
16785 `Text.PrettyPrint.HughesPJ` to use `Text.Pandoc.Pretty` instead.
16787 * Rewrote `writeNative` using the new prettyprinting module. It is
16788 now much faster. The output has been made more consistent and compressed.
16789 `writeNative` is also now sensitive to writerStandalone`, and will simply
16790 `print a block list if writerStandalone` is False.
16792 * Removed `Text.Pandoc.Blocks`. `Text.Pandoc.Pretty` allows you to define
16793 blocks and concatenate them, so a separate module is no longer needed.
16795 * `Text.Pandoc.Shared`:
16797 + Added `writerColumns`, `writerChapters`, and `writerHtml5` to
16798 `WriterOptions`.
16799 + Added `normalize`.
16800 + Removed unneeded prettyprinting functions:
16801 `wrapped`, `wrapIfNeeded`, `wrappedTeX`, `wrapTeXIfNeeded`, `hang'`,
16802 `BlockWrapper`, `wrappedBlocksToDoc`.
16803 + Made `splitBy` take a test instead of an element.
16804 + Added `findDataFile`, refactored `readDataFile`.
16805 + Added `stringify`. Rewrote `inlineListToIdentifier` using `stringify`.
16806 + Fixed `inlineListToIdentifier` to treat `\160` as ' '.
16808 * `Text.Pandoc.Readers.HTML`:
16810 + Removed `rawHtmlBlock`, `anyHtmlBlockTag`, `anyHtmlInlineTag`,
16811 `anyHtmlTag`, `anyHtmlEndTag`, `htmlEndTag`, `extractTagType`,
16812 `htmlBlockElement`, `htmlComment`
16813 + Added `htmlTag`, `htmlInBalanced`, `isInlineTag`, `isBlockTag`,
16814 `isTextTag`
16816 * Moved `smartPunctuation` from `Text.Pandoc.Readers.Markdown`
16817 to `Text.Pandoc.Readers.Parsing`, and parameterized it with
16818 an inline parser.
16820 * Ellipses are no longer allowed to contain spaces.
16821 Previously we allowed '. . .', ' . . . ', etc. This caused
16822 too many complications, and removed author's flexibility in
16823 combining ellipses with spaces and periods.
16825 * Allow linebreaks in URLs (treat as spaces). Also, a string of
16826 consecutive spaces or tabs is now parsed as a single space. If you have
16827 multiple spaces in your URL, use `%20%20`.
16829 * `Text.Pandoc.Parsing`:
16831 + Removed `refsMatch`.
16832 + Hid `Key` constructor.
16833 + Removed custom `Ord` and `Eq` instances for `Key`.
16834 + Added `toKey` and `fromKey` to convert between `Key` and `[Inline]`.
16835 + Generalized type on `readWith`.
16837 * Small change in calculation of relative widths of table columns.
16838 If the size of the header > the specified column width, use
16839 the header size as 100% for purposes of calculating
16840 relative widths of columns.
16842 * Markdown writer now uses some pandoc-specific features when `--strict`
16843 is not specified: `\` newline is used for a hard linebreak instead of
16844 two spaces then a newline. And delimited code blocks are used when
16845 there are attributes.
16847 * HTML writer: improved gladTeX output by setting ENV appropriately
16848 for display or inline math (Jonathan Daugherty).
16850 * LaTeX writer: Use `\paragraph`, `\subparagraph` for level 4,5 headers.
16852 * LaTeX reader:
16854 + `\label{foo}` and `\ref{foo}` now become `{foo}` instead of `(foo)`.
16855 + `\index{}` commands are skipped.
16857 * Added `fontsize` variable to default LaTeX template.
16858 This makes it easy to set the font size using `markdown2pdf`:
16859 `markdown2pdf -V fontsize=12pt input.txt`.
16861 * Fixed problem with strikeout in LaTeX headers when using
16862 hyperref, by adding a command to the default LaTeX template
16863 that disables `\sout` inside pdf strings. Thanks to Joost Kremers
16864 for the fix.
16866 * The `COLUMNS` environment variable no longer has any effect.
16868### Under-the-hood improvements
16870 * Pandoc now compiles with GHC 7. (This alone leads to a
16871 significant performance improvement, 15-20%.)
16873 * Completely rewrote HTML reader using tagsoup as a lexer. The
16874 new reader is faster and more accurate. Unlike the
16875 old reader, it does not get bogged down on some input
16876 (Issues #277, 255). And it handles namespaces in tags
16877 (Issue #274).
16879 * Replaced `escapeStringAsXML` with a faster version.
16881 * Rewrote `spaceChar` and some other parsers in Text.Pandoc.Parsing
16882 for a significant performance boost.
16884 * Improved performance of all readers by rewriting parsers.
16886 * Simplified Text.Pandoc.CharacterReferences by using
16887 entity lookup functions from TagSoup.
16889 * `Text.Pandoc.UTF8` now uses the unicode-aware IO functions
16890 from `System.IO` if base >= 4.2. This gives support for
16891 windows line endings on windows.
16893 * Remove duplications in documentation by generating the
16894 pandoc man page from README, using `MakeManPage.hs`.
16896 * README now includes a full description of markdown syntax,
16897 including non-pandoc-specific parts. A new `pandoc_markdown`
16898 man page is extracted from this, so you can look up markdown
16899 syntax by doing `man pandoc_markdown`.
16901 * Completely revised test framework (with help from Nathan Gass).
16902 The new test framework is built when the `tests` Cabal flag is set. It
16903 includes the old integration tests, but also some new unit and quickcheck
16904 tests. Test output has been much improved, and you can now specify a glob
16905 pattern after `cabal test` to indicate which tests should be run;
16906 for example `cabal test citations` will run all the citation tests.
16908 * Added a shell script, `stripansi.sh`, for filtering ANSI control
16909 sequences from test output: `cabal test | ./stripansi.sh > test.log`.
16911 * Added `Interact.hs` to make it easier to use ghci while developing.
16912 `Interact.hs` loads `ghci` from the `src` directory, specifying
16913 all the options needed to load pandoc modules (including
16914 specific package dependencies, which it gets by parsing
16915 dist/setup-config).
16917 * Added `Benchmark.hs`, testing all readers + writers using criterion.
16919 * Added `stats.sh`, to make it easier to collect and archive
16920 benchmark and lines-of-code stats.
16922 * Added upper bounds to all cabal dependencies.
16924 * Include man pages in extra-source-files. This allows users to
16925 install pandoc from the tarball without needing to build the man
16926 pages.
16928### Bug fixes
16930 * Filenames are encoded as UTF8. Resolves Issue #252.
16932 * Handle curly quotes better in `--smart` mode. Previously, curly quotes
16933 were just parsed literally, leading to problems in some output formats.
16934 Now they are parsed as `Quoted` inlines, if `--smart` is specified.
16935 Resolves Issue #270.
16937 * Text.Pandoc.Parsing: Fixed bug in grid table parser.
16938 Spaces at end of line were not being stripped properly,
16939 resulting in unintended LineBreaks.
16941 * Markdown reader:
16943 + Allow HTML comments as inline elements in markdown.
16944 So, `aaa <!-- comment --> bbb` can be a single paragraph.
16945 + Fixed superscripts with links: `^[link](/foo)^` gets
16946 recognized as a superscripted link, not an inline note followed by
16947 garbage.
16948 + Fixed regression, making markdown reference keys case-insensitive again.
16949 Resolves Issue #272.
16950 + Properly handle abbreviations (like `Mr.`) at the end of a line.
16951 + Better handling of intraword underscores, avoiding exponential
16952 slowdowns in some cases. Resolves Issue #182.
16953 + Fixed bug in alignments in tables with blank rows in the header.
16955 * RST reader:
16957 + Field lists now allow spaces in field names, and
16958 block content in field values. (Thanks to Lachlan Musicman
16959 for pointing out the bug.)
16960 + Definition list items are now always `Para` instead of
16961 `Plain`, matching behavior of `rst2xml.py`.
16962 + In image blocks, the description is parsed properly and
16963 used for the alt attribute, not also the title.
16964 + Skip blank lines at beginning of file. Resolves
16965 Debian #611328.
16967 * LaTeX reader:
16969 + Improved parsing of preamble.
16970 Previously you'd get unexpected behavior on a document that
16971 contained `\begin{document}` in, say, a verbatim block.
16972 + Allow spaces between `\begin` or `\end` and `{`.
16973 + Support `\L` and `\l`.
16974 + Skip comments inside paragraphs.
16976 * LaTeX writer:
16978 + Escape strings in `\href{..}`.
16979 + In nonsimple tables, put cells in `\parbox`.
16981 * OpenDocument writer: don't print raw TeX.
16983 * Markdown writer:
16985 + Fixed bug in `Image`. URI was getting unescaped twice!
16986 + Avoid printing extra blank lines at the end if there are
16987 no notes or references.
16989 * LaTeX and ConTeXt: Escape `[` and `]` as `{[}` and `{]}`.
16990 This avoids unwanted interpretation as an optional argument.
16992 * ConTeXt writer: Fixed problem with inline code. Previously
16993 `}` would be rendered `\type{}}`. Now we check the string for '}' and '{'.
16994 If it contains neither, use `\type{}`; otherwise use `\mono{}`
16995 with an escaped version of the string.
16997 * `:` now allowed in HTML tags. Resolves Issue #274.
17001## pandoc 1.6 (2010-07-24)
17003+ New EPUB and HTML Slidy writers. (Issue #122)
17005 - [EPUB] is a standard ebook format, used in Apple's iBooks for
17006 the iPad and iPhone, Barnes and Noble's nook reader, the Sony
17007 reader, and many other devices, and by online ebook readers like
17008 [bookworm]. (Amazon's Kindle uses a different format, MobiPocket,
17009 but EPUB books can easily be converted to Kindle format.) Now you
17010 can write your book in markdown and produce an ebook with a single
17011 command! I've put up a short [tutorial here].
17012 - [Slidy], like S5, is a system for producing HTML+javascript slide shows.
17014+ All input is assumed to be UTF-8, no matter what the locale and ghc
17015 version, and all output is UTF-8. This reverts to pre-1.5 behavior.
17016 Also, a BOM, if present, is stripped from the input.
17018+ Markdown now supports grid tables, whose cells can contain
17019 arbitrary block elements. (Issue #43)
17021+ Sequentially numbered example lists in markdown with `@` marker.
17023+ Markdown table captions can begin with a bare colon and no longer need
17024 to include the English word "table." Also, a caption can now occur
17025 either before or after the table. (Issue #227)
17027+ New command-line options:
17029 - `--epub-stylesheet` allows you to specify a CSS file that will
17030 be used to style your ebook.
17031 - `--epub-metadata` allows you to specify metadata for the ebook.
17032 - `--offline` causes the generated HTML slideshow to include all
17033 needed scripts and stylesheets.
17034 - `--webtex` causes TeX math to be converted to images using the
17035 Google Charts API (unless a different URL is specified).
17036 - `--section-divs` causes div tags to be added around each section
17037 in an HTML document. (Issue #230, 239)
17039+ Default behavior of S5 writer in standalone mode has changed:
17040 previously, it would include all needed scripts and stylesheets
17041 in the generated HTML; now, only links are included unless
17042 the `--offline` option is used.
17044+ Default behavior of HTML writer has changed. Between 1.2 and 1.5,
17045 pandoc would enclose sections in div tags with identifiers on the
17046 div tags, so that the sections can be manipulated in javascript.
17047 This caused undesirable interactions with raw HTML div tags. So,
17048 starting with 1.6, the default is to put the identifiers directly
17049 on the header tags, and not to include the divs. The `--section-divs`
17050 option selects the 1.2-1.5 behavior.
17052+ API changes:
17054 - `HTMLMathMethod`: Added `WebTeX`, removed `MimeTeX`.
17055 - `WriterOptions`: Added `writerUserDataDir`, `writerSourceDirectory`,
17056 `writerEPUBMetadata` fields. Removed `writerIncludeBefore`,
17057 `writerIncludeAfter`.
17058 - Added `headerShift` to `Text.Pandoc.Shared`.
17059 - Moved parsing code and `ParserState` from `Text.Pandoc.Shared`
17060 to a new module, `Text.Pandoc.Parsing`.
17061 - Added `stateHasChapters` to `ParserState`.
17062 - Added `HTMLSlideVariant`.
17063 - Made `KeyTable` a map instead of an association list.
17064 - Added accessors for `Meta` fields (`docTitle`, `docAuthors`, `docDate`).
17065 - `Pandoc`, `Meta`, `Inline`, and `Block` have been given `Ord` instances.
17066 - Reference keys now have a type of their own (`Key`), with its
17067 own `Ord` instance for case-insensitive comparison.
17068 - Added `Text.Pandoc.Writers.EPUB`.
17069 - Added `Text.Pandoc.UUID`.
17070 - Removed `Text.Pandoc.ODT`, added `Text.Pandoc.Writers.ODT`.
17071 Removed `saveOpenDocumentAsODT`, added `writeODT`.
17072 - Added `Text.Pandoc.Writers.Native` and `writeNative`.
17073 Removed `prettyPandoc`.
17074 - Added `Text.Pandoc.UTF8` for portable UTF8 string IO.
17075 - Removed `Text.Pandoc.Writers.S5` and the `writeS5` function.
17076 Moved `s5Includes` to a new module, `Text.Pandoc.S5`.
17077 To write S5, you now use `writeHtml` with `writerSlideVariant`
17078 set to `S5Slides` or `SlidySlides`.
17080+ Template changes. If you use custom templates, please update them,
17081 particularly if you use syntax highlighting with pandoc. The old HTML
17082 templates hardcoded highlighting CSS that will no longer work with
17083 the most recent version of highlighting-kate.
17085 - HTML template: avoid empty meta tag if no date.
17086 - HTML template: Use default highlighting CSS from highlighting-kate
17087 instead of hard-coding the CSS into the template.
17088 - HTML template: insert-before text goes before the title, and
17089 immediately after the `<body>` tag, as documented. (Issue #241)
17090 - Added slidy and s5 templates.
17091 - Added amssymb to preamble of latex template. (github Issue 1)
17093+ Removed excess newlines at the end of output. Note: because output
17094 will not contain an extra newline, you may need to make adjustments
17095 if you are inserting pandoc's output into a template.
17097+ In S5 and slidy, horizontal rules now cause a new slide, so you
17098 are no longer limited to one slide per section.
17100+ Improved handling of code in man writer. Inline code is now monospace,
17101 not bold, and code blocks now use .nf (no fill) and .IP (indented para).
17103+ HTML reader parses `<tt>` as Code. (Issue #247)
17105+ html+lhs output now contains bird tracks, even when compiled without
17106 highlighting support. (Issue #242)
17108+ Colons are now no longer allowed in autogenerated XML/HTML identifiers,
17109 since they have a special meaning in XML.
17111+ Code improvements in ODT writer. Remote images are now replaced with
17112 their alt text rather than a broken link.
17114+ LaTeX reader improvements:
17116 - Made latex `\section`, `\chapter` parsers more forgiving of whitespace.
17117 - Parse `\chapter{}` in latex.
17118 - Changed `rawLaTeXInline` to accept `\section`, `\begin`, etc.
17119 - Use new `rawLaTeXInline'` in LaTeX reader, and export `rawLaTeXInline`
17120 for use in markdown reader.
17121 - Fixes bug wherein `\section{foo}` was not recognized as raw TeX
17122 in markdown document.
17124+ LaTeX writer: images are automatically shrunk if they would extend
17125 beyond the page margin.
17127+ Plain, markdown, RST writers now use unicode for smart punctuation.
17129+ Man writer converts math to unicode when possible, as in other writers.
17131+ `markdown2pdf` can now recognize citeproc options.
17133+ Command-line arguments are converted to UTF-8. (Issue #234)
17135+ `Text.Pandoc.TeXMath` has been rewritten to use texmath's parser.
17136 This allows it to handle a wider range of formulas. Also, if a formula
17137 cannot be converted, it is left in raw TeX; formulas are no longer
17138 partially converted.
17140+ Unicode curly quotes are left alone when parsing smart quotes. (Issue #143)
17142+ Cabal file changes:
17144 - Removed parsec < 3 restriction.
17145 - Added 'threaded' flag for architectures where GHC lacks a threaded
17146 runtime.
17147 - Use 'threaded' only for markdown2pdf; it is not needed for pandoc.
17148 - Require highlighting-kate 0.2.7.
17150+ Use explicit imports from `Data.Generics`. Otherwise we have a
17151 conflict with the 'empty' symbol, introduced in syb >= 0.2. (Issue #237)
17153+ New data files: slidy/slidy.min.js, slidy/slidy.min.css, epub.css.
17155[EPUB]: http://en.wikipedia.org/wiki/EPUB
17156[Slidy]: http://www.w3.org/Talks/Tools/Slidy
17157[bookworm]: http://bookworm.oreilly.com/
17158[tutorial here]: http://johnmacfarlane.net/pandoc/epub.html
17160## pandoc 1.5.1.1 (2010-03-29)
17162+ Fixed header identifiers (uniqueIdent in Shared) so they
17163 work as advertized in README and are guaranteed to be
17164 valid XHTML names. Thanks to Xyne for reporting the bug.
17166## pandoc 1.5.1 (2010-03-23)
17168+ Fixed treatment of unicode characters in URIs.
17169+ Revised Setup.hs so it works with debian's build process.
17170+ Fixed bug in OpenDocument writer that led to invalid
17171 XML for some input.
17173## pandoc 1.5.0.1 (2010-03-21)
17175+ HTML writer: Fixed error in math writer (with MathML option)
17176 that caused an infinite loop for unparsable MathML.
17178## pandoc 1.5 (2010-03-20)
17180+ Moved repository to [github](http://github.com/jgm/pandoc).
17181+ New `--mathml` option, for display of TeX math as MathML.
17182+ New `--data-dir` option, allowing users to specify a data
17183 directory other than `~/.pandoc`. Files placed in this directory
17184 will be used instead of system defaults.
17185+ New `--base-header-level` option. For example, `--base-header-level=2`
17186 changes level 1 headers to level 2, level 2 to level 3, etc.
17187+ New 'plain' output format: plain text without pictures, hyperlinks,
17188 inline formatting, or anything else that looks even vaguely
17189 markupish.
17190+ Titles and authors in title blocks can now span multiple lines,
17191 as long as the continuation lines begin with a space character.
17192+ When given an absolute URI as a parameter, pandoc will fetch
17193 the content via HTTP.
17194+ The HTML reader has been made much more forgiving. It no
17195 longer requires well-formed xhtml as input.
17196+ `html2markdown` has been removed; it is no longer necessary, given
17197 the last two changes. `pandoc` can be used by itself to convert
17198 web pages to markdown or other formats.
17199+ `hsmarkdown` has also been removed. Use `pandoc --strict` instead.
17200 Or symlink pandoc's executable to `hsmarkdown`; `pandoc` will then
17201 behave like `hsmarkdown` used to.
17202+ An image in a paragraph by itself is now rendered as a figure
17203 in most writers, with the alt text as the caption.
17204+ Incomplete support for reST tables (simple and grid). Thanks to
17205 Eric Kow. Colspans and rowspans not yet supported.
17206+ In mediawiki, links with relative URLs are now formatted as wikilinks.
17207 Also, headers have been promoted: `= head =` is now level 1 instead of
17208 level 2.
17209+ The markdown reader now handles "inverse bird tracks" when parsing
17210 literate haskell. These are used for haskell example code that
17211 is not part of the literate program.
17212+ The `-B` and `-A` options now imply `-s` and no longer work in
17213 fragment mode.
17214+ Headerless tables are now printed properly in all writers.
17215 In addition, tbody, thead, and cols are used in HTML and Docbook
17216 tables.
17217+ Improved build system; removed obsolete Makefile.
17218+ In LaTeX writer, `\chapter` is now used instead of `\section`.
17219 when the documentclass is book, report, or memoir.
17220+ Many small bug fixes. See [changelog] for details.
17222## pandoc 1.4 (2010-01-02)
17224+ New template system replaces old headers, giving users much
17225 more control over pandoc's output in `--standalone` mode.
17226 Added `--template` and `--variable` options. The `--print-default-header`
17227 option is now `--print-default-template`. See README under
17228 "Templates" for details.
17229+ The old `--custom-header` option should still work, but it has
17230 been deprecated.
17231+ New `--reference-odt` option allows users to customize styles
17232 in ODT output.
17233+ Users may now put custom templates, s5 styles, and a reference
17234 ODT in the `~/.pandoc` directory, where they will override system
17235 defaults. See README for details.
17236+ Unicode is now used whenever possible in HTML and XML output. Entities
17237 are used only where necessary (`&gt;`, `&lt;`, `&quot;`, `&amp;`).
17238+ Authors and dates may now include formatting and notes.
17239+ Added `--xetex` option for `pandoc` and `markdown2pdf`.
17240+ Windows installer now includes highlighting support and
17241 `markdown2pdf` and `hsmarkdown` wrappers.
17242+ Pandoc no longer requires Template Haskell, which should make
17243 it more portable.
17244+ Pandoc can now be built on GHC 6.12, as well as earlier versions.
17245+ See README for other small improvements and bug fixes.
17247## pandoc 1.3 (2009-12-10)
17249+ Added `--id-prefix` option to help prevent duplicate
17250 identifiers when you're generating HTML fragments.
17251+ Added `--indented-code-classes` option, which specifies
17252 default highlighting syntax for indented code blocks.
17253+ `--number-sections` now affects HTML output.
17254+ Improved syntax for markdown definition lists.
17255+ Better looking simple tables.
17256+ Markdown tables without headers are now possible.
17257+ New hard line break syntax: backslash followed by newline.
17258+ Improved performance of markdown reader by ~10% by eliminating the
17259 need for a separate parsing pass for notes.
17260+ Improved syntax highlighting for literate Haskell.
17261+ Support for "..code-block" directive in RST reader.
17262+ Windows binary now includes highlighting support.
17263+ Many bug fixes and small improvements. See [changelog]
17264 for details.
17266## pandoc 1.2.1 (2009-07-18)
17268+ Improved the efficiency of the markdown reader's
17269 abbreviation parsing (should give a big performance
17270 boost with `--smart`).
17271+ HTML writer now wraps sections in divs with unique
17272 identifiers, for easier manipulation.
17273+ Improved LaTeX reader's coverage of math modes.
17274+ Added a portable Haskell version of markdown2pdf (thanks
17275 to Paolo Tanimoto).
17276+ Made `--strict` compatible with `--standalone` and `--toc.`
17277+ Many other small improvements and bug fixes.
17278 See [changelog] for details.
17280## pandoc 1.2 (2009-03-01)
17282+ Added support for literate Haskell. lhs support is triggered by
17283 '+lhs' suffixes in formats. For example, 'latex+lhs' is literate
17284 Haskell LaTeX. '.lhs' files are treated by default as literate
17285 markdown.
17286+ Added `--email-obfuscation` option.
17287+ Brought citeproc support up to date for citeproc-hs-0.2.
17288+ Many bugs fixed. See [changelog] for details.
17290## pandoc 1.1 (2008-11-06)
17292+ New `--jsmath` option supporting use of pandoc with [jsMath].
17293+ Classes on HTML table output for better CSS styling.
17294+ Windows installer no longer requires admin privileges.
17295+ Many bugs fixed. See [changelog] for details.
17297## pandoc 1.0 (2008-09-13)
17299+ New writers for MediaWiki, GNU Texinfo (thanks to Peter Wang),
17300 OpenDocument XML (thanks to Andrea Rossato), and ODT (OpenOffice
17301 document).
17302+ New [delimited code blocks](README.html#delimited-code-blocks),
17303 with optional syntax highlighting.
17304+ Reorganized build system: pandoc can now be built using standard
17305 Cabal tools. It can be compiled on Windows without Cygwin.
17306 The tests can also be run without perl or unix tools.
17307+ LaTeXMathML replaces ASCIIMathML for rendering math in HTML.
17308+ Support for "displayed" math.
17309+ Common abbreviations are now handled more intelligently, with
17310 a non-breaking space (and not a sentence-ending space) after
17311 the period.
17312+ Code is -Wall clean.
17313+ Many bug fixes and small improvements. See [changelog] for
17314 full details.
17316## pandoc 0.46 (2008-01-08)
17318+ Added a `--sanitize-html` option (and a corresponding parameter
17319 in `ParserState` for those using the pandoc libraries in programs).
17320 This option causes pandoc to sanitize HTML (in HTML or Markdown
17321 input) using a whitelist method. Possibly harmful HTML elements
17322 are replaced with HTML comments. This should be useful in the
17323 context of web applications, where pandoc may be used to convert
17324 user input into HTML.
17325+ Made -H, -A, and -B options cumulative: if they are specified
17326 multiple times, multiple files will be included.
17327+ Many bug fixes and small improvements. See [changelog] for full
17328 details.
17330## pandoc 0.45 (2007-12-09)
17332+ Many bug fixes and structural improvements. See [changelog] for
17333 full details.
17334+ Improved treatment of math. Math is now rendered using unicode
17335 by default in HTML, RTF, and DocBook output. For more accurate
17336 display of math in HTML, `--gladtex`, `--mimetex`, and `--asciimathml`
17337 options are provided. See the [User's Guide](README.html#math) for
17338 details.
17339+ Removed support for box-style block quotes in markdown.
17340+ More idiomatic ConTeXt output.
17341+ Text wrapping in ConTeXt and LaTeX output.
17342+ Pandoc now correctly handles all standard line endings
17343 (CR, LF, CRLF).
17344+ New `--no-wrap` option that disables line wrapping and minimizes
17345 whitespace in HTML output.
17346+ Build process is now compatible with both GHC 6.8 and GHC 6.6.
17347 GHC and GHC_PKG environment variables may be used to specify
17348 which version of the compiler to use, when multiple versions are
17349 installed.
17351## pandoc 0.44 (2007-09-03)
17353 [ John MacFarlane ]
17355 * Fixed bug in HTML writer: when --toc was used, anchors were put around
17356 headers, which is invalid XHTML (block content within inline element).
17357 Now the anchors are put inside the header tags. Resolves Issue #23.
17359 * Added xmlns attribute to html element in html writer tests.
17360 This attribute is added by more recent versions of the
17361 xhtml library (>= 3000), and is required for valid XHTML.
17363 [ Recai Oktaş ]
17365 * On configure, compile 'Setup.hs' to 'setup' and use 'setup' as the build
17366 command instead of 'runhaskell', which, on some platforms (such as s390,
17367 alpha, m68k), throws the following error:
17369 runhaskell Setup.hs configure --prefix=/usr
17370 ghc-6.6.1: not built for interactive use
17372 This causes a serious FTBFS bug. Closes: #440668.
17374## pandoc 0.43 (2007-09-02)
17376 [ John MacFarlane ]
17378 * The focus of this release is performance. The markdown parser
17379 is about five times faster than in 0.42, based on benchmarks
17380 with the TextMate manual.
17382 * Main.hs: Replaced CRFilter and tabFilter with single function
17383 tabFilter, which operates on the whole string rather than breaking
17384 it into lines, and handles dos-style line-endings as well as tabs.
17386 * Added separate LaTeX reader and native reader tests; removed
17387 round-trip tests.
17389 * Text.Pandoc.Shared:
17391 + Removed tabsToSpaces and tabsInLine (they were used only in Main.hs.)
17392 + General code cleanup (to elimante warnings when compiling with -Wall.)
17393 + Added 'wrapped' function, which helps wrap text into paragraphs,
17394 using the prettyprinting library.
17395 + Rewrote charsInBalanced and charsInBalanced'.
17396 - Documented restriction: open and close must be distinct characters.
17397 - Rearranged options for greater efficiency.
17398 - Bug fix: Changed inner call to charsInBalanced inside
17399 charsInBalanced' to charsInBalanced'.
17400 + anyLine now requires that the line end with a newline (not eof).
17401 This is a harmless assumption, since we always add newlines to the
17402 end of a block before parsing with anyLine, and it yields a 10% speed
17403 boost.
17404 + Removed unnecessary 'try' in anyLine.
17405 + Removed unneeded 'try' from romanNumeral parser.
17406 + Use notFollowedBy instead of notFollowedBy' in charsInBalanced.
17407 + Removed unneeded 'try' in parseFromString.
17408 + Removed unneeded 'try' from stringAnyCase. (Now it behaves
17409 like 'string'.)
17410 + Changed definition of 'enclosed' in Text.Pandoc.Shared so that
17411 'try' is not automatically applied to the 'end' parser. Added
17412 'try' in calls to 'enclosed' where needed. Slight speed increase.
17414 * Writers:
17416 + Replaced individual wrapping routines in RST, Man, and Markdown
17417 writers with 'wrapped' from Text.Pandoc.Shared.
17418 + Rewrote LaTeX writer to use the prettyprinting library,
17419 so we get word wrapping, etc.
17420 + Modified latex writer tests for new latex writer using prettyprinter.
17421 + Fixed bug in LaTeX writer: autolinks would not cause
17422 `\usepackage{url}` to be put in the document header. Also, changes
17423 to state in enumerated list items would be overwritten.
17424 + In Markdown writer, escape paragraphs that begin with ordered list
17425 markers, so they don't get interpreted as ordered lists.
17427 * Text.Pandoc.Reades.LaTeX:
17429 + Fixed bug in LaTeX reader, which wrongly assumed that the roman
17430 numeral after "enum" in "setcounter" would consist entirely of
17431 "i"s. 'enumiv' is legitimate.
17432 + LaTeX command and environment names can't contain numbers.
17433 + Rearranged order of parsers in inline for slight speed improvement.
17434 + Added '`' to special characters and 'unescapedChar'.
17436 * Text.Pandoc.Readers.RST:
17438 + Removed unneeded try's in RST reader; also minor code cleanup.
17439 + Removed tabchar.
17440 + Rearranged parsers in inline (doubled speed).
17442 * Text.Pandoc.Readers.Markdown:
17444 + Skip notes parsing if running in strict mode. (This yields a nice
17445 speed improvement in strict mode.)
17446 + Simplify autolink parsing code, using Network.URI to test for
17447 URIs. Added dependency on network library to debian/control and
17448 pandoc.cabal.
17449 + More perspicuous definition of nonindentSpaces.
17450 + Removed unneeded 'try' in 'rawLine'.
17451 + Combined linebreak and whitespace into a new whitespace parser, to
17452 avoid unnecessary reparsing of space characters.
17453 + Removed unnecessary 'try' in 'codeBlock', 'ellipses', 'noteMarker',
17454 'multilineRow', 'dashedLine', 'rawHtmlBlocks'.
17455 + Use lookAhead in parsers for setext headers and definition lists
17456 to see if the next line begins appropriately; if not, don't waste
17457 any more time parsing.
17458 + Don't require blank lines after code block. (It's sufficient to
17459 end code block with a nonindented line.)
17460 + Changed definition of 'emph': italics with '_' must not
17461 be followed by an alphanumeric character. This is to help
17462 prevent interpretation of e.g. `[LC_TYPE]: my_type` as
17463 `[LC<em>TYPE]:my</em>type`.
17464 + Improved Markdown.pl-compatibility in referenceLink: the two parts
17465 of a reference-style link may be separated by one space, but not
17466 more... [a] [link], [not] [a link].
17467 + Fixed markdown inline code parsing so it better accords with
17468 Markdown.pl: the marker for the end of the code section is a clump
17469 of the same number of `'s with which the section began, followed
17470 by a non-` character. So, for example,
17471 ` h ``` i ` -> `<code>h ``` i</code>`.
17472 + Split 'title' into 'linkTitle' and 'referenceTitle', since the
17473 rules are slightly different.
17474 + Rewrote 'para' for greater efficiency.
17475 + Rewrote link parsers for greater efficiency.
17476 + Removed redundant 'referenceLink' in definition of inline (it's
17477 already in 'link').
17478 + Refactored escapeChar so it doesn't need 'try'.
17479 + Refactored hrule for performance in Markdown reader.
17480 + More intelligent rearranging of 'inline' so that most frequently
17481 used parsers are tried first.
17482 + Removed tabchar parser, as whitespace handles tabs anyway.
17484 * Text.Pandoc.CharacterReferences:
17486 + Refactored.
17487 + Removed unnecessary 'try's for a speed improvement.
17488 + Removed unnecessary '&' and ';' from the entity table.
17490 * Build process:
17492 + Makefile: Get VERSION from cabal file, not Main.hs.
17493 + Modified MacPorts Portfile:
17494 - Depend on haddock
17495 - Build and install libraries and library documentation in
17496 addition to pandoc executable
17497 - Added template item for md5 sum in Portfile.in.
17498 - Incorporated changes from MacPorts repository (r28278).
17499 + FreeBSD port: Don't try to generate distinfo in Makefile.
17500 It can be made using 'make makesum' in FreeBSD.
17501 + Make both freebsd and macports targets depend on tarball.
17503 * Website and documentation:
17505 + Updated INSTALL instructions.
17506 + Added pandocwiki demo to website.
17507 + Removed local references to Portfile, since pandoc is now in the
17508 MacPorts repository.
17510## pandoc 0.42 (2007-08-26)
17512 [ John MacFarlane ]
17514 * Main.hs: Use utf8 conversion on the extra files loaded with
17515 the -H, -C, -B, and -A options. This fixes problems with unicode
17516 characters in these files.
17518 * Exposed Text.Pandoc.ASCIIMathML, since it is imported in
17519 Text.Pandoc.Readers.HTML and without it we get a linking error when
17520 using the library.
17522 * Markdown reader:
17524 + Added new rule for enhanced markdown ordered lists: if the list
17525 marker is a capital letter followed by a period (including a
17526 single-letter capital roman numeral), then it must be followed by
17527 at least two spaces. The point of this is to avoid accidentally
17528 treating people's initials as list markers: a paragraph might begin,
17529 "B. Russell was an English philosopher," and this shouldn't be
17530 treated as a list. Documented change in README.
17531 + Blocks that start with "p. " and a digit are no longer treated
17532 as ordered lists (it's a page number).
17533 + Added a needed 'try' to listItem.
17534 + Removed check for a following setext header in endline.
17535 A full test is too inefficient (doubles benchmark time), and the
17536 substitute we had before is not 100% accurate.
17537 + Don't use Code elements for autolinks if --strict specified.
17539 * LaTeX writer: When a footnote ends with a Verbatim environment, the
17540 close } of the footnote cannot occur on the same line or an error occurs.
17541 Fixed this by adding a newline before the closing } of every footnote.
17543 * HTML writer:
17544 + Removed incorrect "{}" around style information in HTML tables.
17545 Column widths now work properly in HTML.
17546 + If --strict option is specified (and --toc is not), don't include
17547 identifiers in headers, for better Markdown compatibility.
17549 * Build process:
17551 + Separated $(web_dest) and website targets.
17552 + In website, index.txt is now constructed from template index.txt.in.
17553 + Added freebsd target to Markefile. This creates the freebsd Makefile
17554 from Makefile.in, and creates distinfo. Removed Makefile and distinfo
17555 from the repository.
17556 + Added macport target to Makefile. Portfile is built from template
17557 Portfile.in.
17558 + Removed OSX package targets. (Too many difficulties involving
17559 dependencies on dynamic libraries.)
17560 + More complete INSTALL instructions for all architectures.
17562 * Website:
17563 + Added a programming demo, pandocwiki.
17565 [ Recai Oktaş ]
17567 * Do not forget to close pandoc's ITP. Closes: #391666
17569## pandoc 0.41 (2007-08-19)
17571 [ John MacFarlane ]
17573 * Fixed bugs in HTML reader:
17574 + Skip material at end *only if* `</html>` is present (previously,
17575 only part of the document would be parsed if an error was
17576 found; now a proper error message is given).
17577 + Added new constant eitherBlockOrInline with elements that may
17578 count either as block-level or as inline. Modified isInline and
17579 isBlock to take this into account.
17580 + Modified rawHtmlBlock to accept any tag (even an inline tag):
17581 this is innocuous, because rawHtmlBlock is tried only if a regular
17582 inline element can't be parsed.
17583 + Added a necessary 'try' in definition of 'para'.
17585 * Fixed bug in markdown ordered list parsing. The problem was that
17586 anyOrderedListStart did not check for a space following the
17587 ordered list marker. So in 'A.B. 2007' the parser would be
17588 expecting a list item, but would not find one, causing an error.
17589 Fixed a similar bug in the RST reader. Resolves Issue #22.
17591 * Refactored RST and Markdown readers using parseFromString.
17593 * LaTeX reader will now skip anything after \end{document}.
17595 * Fixed blockquote output in markdown writer: previously, block
17596 quotes in indented contexts would be indented only in the first
17597 line.
17599 * Added note to INSTALL about variations in versions of the xhtml
17600 library that can lead to failed tests (thanks to Leif LeBaron).
17602## pandoc 0.4 (2007-01-16)
17604 [ John MacFarlane ]
17606 * Added two new output formats: groff man pages and ConTeXt. By
17607 default, output files with extensions ".ctx" and ".context" are
17608 assumed to be ConTeXt, and output files with single-digit extensions
17609 are assumed to be man pages.
17611 * Enhanced ordered lists (documented in README, under Lists):
17612 + The OrderedList block element now stores information about
17613 list number style, list number delimiter, and starting number.
17614 + The readers parse this information when possible.
17615 + The writers use this information to style ordered lists.
17616 + The enhancement can be disabled using the --strict option.
17618 * Added support for tables (with a new Table block element). Two kinds
17619 of tables are supported: a simple table with one-line rows, and a
17620 more complex variety with multiline rows. All output formats are
17621 supported, but only markdown tables are parsed at the moment. The
17622 syntax is documented in README.
17624 * Added support for definition lists (with a new DefinitionList block
17625 element). All output and input formats are supported. The syntax is
17626 documented in README.
17628 * Added support for superscripts and subscripts (with new Superscript
17629 and Subscript inline elements). All input and output
17630 formats. The syntax is documented in README.
17632 * Added support for strikeout (with a new Strikeout inline element).
17633 All input and output formats are supported. Thanks to Bradley Kuhn,
17634 who contributed a patch. The syntax is documented in README. Resolves
17635 Issue #18.
17637 * Added a --toc|--table-of-contents option. This causes an automatically
17638 generated table of contents (or an instruction that creates one) to
17639 be inserted at the beginning of the document. Not supported in S5,
17640 DocBook, or man page writers.
17642 * Modified the -m|--asciimathml option:
17644 + If an optional URL argument is provided, a link is inserted
17645 instead of the contents of the ASCIIMathML.js script.
17646 + Nothing is inserted unless the document actually contains
17647 LaTeX math.
17649 * Removed Blank block element as unnecessary.
17651 * Removed Key and Note blocks from the Pandoc data structure. All
17652 links are now stored as explicit links, and note contents are
17653 stored with the (inline) notes.
17655 + All link Targets are now explicit (URL, title) pairs; there
17656 is no longer a 'Ref' target.
17657 + Markdown and RST parsers now need to extract data from key and
17658 note blocks and insert them into the relevant inline elements.
17659 Other parsers have been simplified, since there is no longer any need
17660 to construct separate key and note blocks.
17661 + Markdown, RST, and HTML writers need to construct lists of
17662 notes; Markdown and RST writers need to construct lists of link
17663 references (when the --reference-links option is specified); and
17664 the RST writer needs to construct a list of image substitution
17665 references. All writers have been rewritten to use the State monad
17666 when state is required.
17667 + Several functions (generateReference, keyTable,
17668 replaceReferenceLinks, replaceRefLinksBlockList, and some auxiliaries
17669 used by them) have been removed from Text.Pandoc.Shared, since
17670 they are no longer needed. New functions and data structures
17671 (Reference, isNoteBlock, isKeyBlock, isLineClump) have been
17672 added. The functions inTags, selfClosingTag, inTagsSimple, and
17673 inTagsIndented have been moved to the DocBook writer, since that
17674 is now the only module that uses them. NoteTable is now exported
17675 in Text.Pandoc.Shared.
17676 + Added stateKeys and stateNotes to ParserState; removed stateKeyBlocks,
17677 stateKeysUsed, stateNoteBlocks, stateNoteIdentifiers, stateInlineLinks.
17678 + Added writerNotes and writerReferenceLinks to WriterOptions.
17680 * Added Text.Pandoc module that exports basic readers, writers,
17681 definitions, and utility functions. This should export everything
17682 needed for most uses of Pandoc libraries. The haddock documentation
17683 includes a short example program.
17685 * Text.Pandoc.ASCIIMathML is no longer an exported module.
17687 * Added Text.Pandoc.Blocks module to help in printing markdown
17688 and RST tables. This module provides functions for working with
17689 fixed-width blocks of text--e.g., placing them side by side, as
17690 in a table row.
17692 * Refactored to avoid reliance on Haskell's Text.Regex library, which
17693 (a) is slow, and (b) does not properly handle unicode. This fixed
17694 some strange bugs, e.g. in parsing S-cedilla, and improved performance.
17696 + Replaced 'gsub' with a general list function 'substitute'
17697 that does not rely on Text.Regex.
17698 + Rewrote extractTagType in HTML reader so that it doesn't use
17699 regexs.
17700 + In Markdown reader, replaced email regex test with a custom email
17701 autolink parser (autoLinkEmail). Also replaced selfClosingTag regex
17702 with a custom function isSelfClosingTag.
17703 + Modified Docbook writer so that it doesn't rely on Text.Regex for
17704 detecting 'mailto' links.
17705 + Removed escapePreservingRegex and reamped entity-handling
17706 functions in Text.Pandoc.Shared and Text.Pandoc.CharacterReferences to
17707 avoid reliance on Text.Regex (see below on character reference
17708 handling changes).
17710 * Renamed Text.Pandoc.Entities as Text.Pandoc.CharacterReferences.
17712 * Changed handling of XML entities. Entities are now parsed (and unicode
17713 characters returned) in the Markdown and HTML readers, rather than being
17714 handled in the writers. In HTML and Docbook writers, UTF-8 is now used
17715 instead of entities for characters above 128. This makes the HTML and
17716 DocBook output much more readable and more easily editable.
17718 + Removed sgmlHexEntity, sgmlDecimalEntity, sgmlNamedEntity, and
17719 sgmlCharacterEntity regexes from Text.Pandoc.Shared.
17720 + Renamed escapeSGMLChar to escapeCharForXML. Added escapeStringForXML.
17721 Moved both functions to Text.Pandoc.Writers.Docbook.
17722 + Added characterReference parser to Text.Pandoc.CharacterReferences.
17723 This parses a string and return a unicode character.
17724 + Rewrote decodeCharacterReferences to use the new parser instead of
17725 Text.Regex.
17726 + Added new charRef parser for Markdown and HTML, which replaces the
17727 old 'entity' parser. Added '&' as a special character in Markdown reader.
17728 + Modified HTML and Markdown readers to call decodeEntities on all raw
17729 strings (e.g. authors, dates, link titles), to ensure that no
17730 unprocessed entities are included in the native representation of
17731 the document. (In the HTML reader, most of this work is done by a
17732 change in extractAttributeName.)
17733 + In XML and Markdown output, escape unicode nonbreaking space as '&nbsp;',
17734 since a unicode non-breaking space is impossible to distinguish visually
17735 from a regular space. (Resolves Issue #3.)
17736 + Removed encodeEntitiesNumerical.
17737 + Use Data.Map for entityTable and (new) reverseEntityTable, for a
17738 slight performance boost over the old association list.
17739 + Removed unneeded decodeEntities from 'str' parser in HTML and
17740 Markdown readers.
17742 * Text.Pandoc.UTF8: Renamed encodeUTF8 to toUTF8, decodeUTF8 to
17743 fromUTF8, for clarity.
17745 * Replaced old haskell98 module names replaced by hierarchical module
17746 names, e.g. List by Data.List. Removed haskell98 from dependencies
17747 in pandoc.cabal, and added mtl (needed for state monad). Substituted
17748 xhtml for html.
17750 * Refactored and cleaned up character escaping in writers, using
17751 backslashEscapes and escapeStringUsing functions.
17753 * Instead of adding `\n\n` to the end of an input string in Main.hs,
17754 this is now done in the readers. This makes the libraries behave
17755 the way you'd expect from the pandoc program. Resolves Issue #10.
17757 * URLs and email addresses in autolinks are now typeset as Code.
17759 * In Main.hs, changed putStr to putStrLn -- mainly because MacOS X
17760 doesn't display the whole output unless there's a line ending.
17762 * Major code cleanup in all modules, for greater consistency, concision,
17763 and readability.
17765 * HTML reader:
17767 + Fixed several bugs (extractTagType, attribute parsing).
17768 + Remove Null blocks in lists of blocks when possible.
17769 + Allow HTML comments as raw HTML inline.
17771 * Markdown reader:
17773 + Ordered list items may no longer begin with uppercase letters, or
17774 letters greater than 'n'. (This prevents first initials and page
17775 reference, e.g. 'p. 400', from being parsed as beginning lists.)
17776 Also, numbers beginning list items may no longer end with ')',
17777 which is now allowed only after letters. Note: These changes
17778 may cause documents to be parsed differently. Users should take
17779 care in upgrading.
17780 + Changed autoLink parsing to conform better to Markdown.pl's
17781 behavior. `<google.com>` is not treated as a link, but
17782 `<http://google.com>`, `<ftp://google.com>`, and
17783 `<mailto:google@google.com>` are.
17784 + Cleaned up handling of embedded quotes in link titles. Now these are
17785 stored as a '"' character, not as '&quot;'.
17786 + Use lookAhead parser for the 'first pass' (looking for reference keys),
17787 instead of parsing normally, then using setInput to reset input. This
17788 yields a slight performance boost.
17789 + Fixed several bugs in smart quote recognition.
17790 + Fixed bug in indentSpaces (which didn't properly handle
17791 cases with mixed spaces and tabs).
17792 + Consolidated 'text', 'special', and 'inline' into 'inline'.
17793 + Fixed bug which allowed URL and title to be separated by multiple blank
17794 lines in links and reference keys. They can be on separate lines but
17795 can't have blank lines between them.
17796 + Correctly handle bracketed text inside inline footnotes and links,using
17797 new function inlinesInBalanced. Resolves Issue #14.
17798 + Fixed bug in footnotes: links in footnotes were not being
17799 processed. Solution: three-stage parse. First, get all the
17800 reference keys and add information to state. Next, get all the
17801 notes and add information to state. (Reference keys may be needed
17802 at this stage.) Finally, parse everything else.
17803 + Replaced named constants like 'emphStart' with literals.
17804 + Removed an extra occurrence of escapedChar in definition of inline.
17806 * RST reader:
17808 + Allow the URI in a RST hyperlink target to start on the line
17809 after the reference key.
17810 + Added 'try' in front of 'string', where needed, or used a different
17811 parser. This fixes a bug where ````` would not be correctly parsed as
17812 a verbatim `.
17813 + Fixed slow performance in parsing inline literals in RST reader. The
17814 problem was that ``#`` was seen by 'inline' as a potential link or image.
17815 Fix: inserted 'notFollowedBy (char '`')' in link parsers.
17816 Resolves Issue #8.
17817 + Use lookAhead instead of getInput/setInput in RST reader. Removed
17818 unneeded getState call, since lookAhead automatically saves and
17819 restores the parser state.
17820 + Allow hyperlink target URIs to be split over multiple lines, and
17821 to start on the line after the reference. Resolves Issue #7.
17822 + Fixed handling of autolinks.
17824 * LaTeX reader:
17826 + Replaced `choice [(try (string ...), ...]` idiom with `oneOfStrings`,
17827 for clarity.
17828 + Added clauses for tilde and caret. Tilde is `\ensuremath{\sim}`, and
17829 caret is `\^{}`, not `\^` as before.
17830 + Added parsing for `\url`.
17831 + Parse `\texttt{}` as code, provided there's nothing fancy inside.
17833 * HTML writer:
17835 + Modified HTML writer to use the Text.XHtml library. This results
17836 in cleaner, faster code, and it makes it easier to use Pandoc in
17837 other projects, like wikis, which use Text.XHtml. Two functions are
17838 now provided, writeHtml and writeHtmlString: the former outputs an
17839 Html structure, the latter a rendered string. The S5 writer is also
17840 changed, in parallel ways (writeS5, writeS5String).
17841 + The Html header is now written programmatically, so it has been
17842 removed from the 'headers' directory. The S5 header is still
17843 needed, but the doctype and some of the meta declarations have
17844 been removed, since they are written programmatically. This change
17845 introduces a new dependency on the xhtml package.
17846 + Fixed two bugs in email obfuscation involving improper escaping
17847 of '&' in the `<noscript>` section and in `--strict` mode. Resolves
17848 Issue #9.
17849 + Fixed another bug in email obfuscation: If the text to be obfuscated
17850 contains an entity, this needs to be decoded before obfuscation.
17851 Thanks to thsutton for the patch. Resolves Issue #15.
17852 + Changed the way the backlink is displayed in HTML footnotes.
17853 Instead of appearing on a line by itself, it now generally
17854 appears on the last line of the note. (Exception: when the
17855 note does not end with a Plain or Para block.) This saves space
17856 and looks better.
17857 + Added automatic unique identifiers to headers:
17858 - The identifier is derived from the header via a scheme
17859 documented in README.
17860 - WriterState now includes a list of header identifiers and a table
17861 of contents in addition to notes.
17862 - The function uniqueIdentifiers creates a list of unique identifiers
17863 from a list of inline lists (e.g. headers).
17864 - This list is part of WriterState and gets consumed by blockToHtml
17865 each time a header is encountered.
17866 + Include CSS for .strikethrough class in header only if strikethrough
17867 text appears in the document.
17868 + If the 'strict' option is specified, elements that do not appear in
17869 standard markdown (like definition lists) are passed through as
17870 raw HTML.
17871 + Simplified treatment of autolinks, using pattern matching instead of
17872 conditionals.
17874 * Markdown writer:
17876 + Links in markdown output are now printed as inline links by default,
17877 rather than reference links. A --reference-links option has been added
17878 that forces links to be printed as reference links. Resolves Issue #4.
17879 + Use autolinks when possible. Instead of `[site.com](site.com)`,
17880 use `<site.com>`.
17882 * LaTeX writer:
17884 + Rewrote to use the State monad. The preamble now includes only those
17885 packages that are actually required, given the document's content.
17886 Thus, for example, if strikeout is not used, ulem is not required.
17887 Modified LaTeXHeader accordingly.
17888 + Modified LaTeX writer to insert `\,` between consecutive quotes.
17889 + Removed unused function tableRowColumnWidths.
17890 + Simplified code for escaping special characters.
17891 + Leave extra blank line after `\maketitle`.
17892 + Include empty `\author{}` when no author specified to avoid LaTeX
17893 errors.
17894 + Include fancyvrb code in header only if needed -- that is, only
17895 if there is actually code in a footnote.
17896 + Use `\url{}` for autolinks.
17897 + Include [mathletters] option in ucs package, so that basic unicode
17898 Greek letters will work correctly.
17900 * RST writer: Force blank line before lists, so that sublists will
17901 be handled correctly.
17903 * Docbook writer: Fixed a bug: email links with text, like
17904 [foo](me@bar.baz), were being incorrectly treated as autolinks.
17906 * Removed Text.ParserCombinators.Pandoc and moved all its functions to
17907 Text.Pandoc.Shared.
17909 * Text.Pandoc.Shared:
17911 + Added defaultWriterOptions.
17912 + Added writerTableOfContents to WriterOptions.
17913 + Added writerIgnoreNotes option to WriterOptions. This is needed
17914 for processing header blocks for a table of contents, since notes on
17915 headers should not appear in the TOC.
17916 + Added prettyprinting for native Table format.
17917 + Removed some unneeded imports.
17918 + Moved escape and nullBlock parsers from
17919 Text.ParserCombinators.Pandoc, since the latter is for
17920 general-purpose parsers that don't depend on Text.Pandoc.Definition.
17921 + Moved isHeaderBlock from Text.Pandoc.Writers.HTML.
17922 + Moved Element, headerAtLeast, and hierarchicalize from Docbook
17923 writer, because HTML writer now uses these in constructing a table
17924 of contents.
17925 + Added clauses for new inline elements (Strikeout, Superscript,
17926 Subscript) to refsMatch.
17927 + Removed backslashEscape; added new functions escapeStringUsing and
17928 backslashEscapes.
17929 + Moved failIfStrict from markdown reader, since it is now used also
17930 by the HTML reader.
17931 + Added a 'try' to the definition of indentSpaces.
17932 + In definition of 'reference', added check to make sure it's not a note
17933 reference.
17934 + Added functions: camelCaseToHyphenated, toRomanNumeral,
17935 anyOrderedListMarker, orderedListmarker, orderedListMarkers,
17936 charsInBalanced', withHorizDisplacement, romanNumeral
17937 + Fixed a bug in the anyLine parser. Previously it would parse an empty
17938 string "", but it should fail on an empty string, or we get an error
17939 when it is used inside "many" combinators.
17940 + Removed followedBy' parser, replacing it with the lookAhead parser from
17941 Parsec.
17942 + Added some needed 'try's before multicharacter parsers, especially in
17943 'option' contexts.
17944 + Removed the 'try' from the 'end' parser in 'enclosed', so that
17945 'enclosed' behaves like 'option', 'manyTill', etc.
17946 + Added lineClump parser, which parses a raw line block up to and
17947 including any following blank lines.
17948 + Renamed parseFromStr to parseFromString.
17949 + Added a 'try' to the 'end' parser in 'enclosed'. This makes errors in
17950 the use of 'enclosed' less likely. Removed some now-unnecessary 'try's
17951 in calling code.
17952 + Removed unneeded 'try' in blanklines.
17953 + Removed endsWith function and rewrote calling functions to use
17954 isSuffixOf instead.
17955 + Added >>~ combinator.
17956 + Fixed bug in normalizeSpaces: Space:Str "":Space should compress to
17957 Space.
17959 * Refactored runtests.pl; added separate tests for tables.
17961 * Shell scripts:
17963 + Added -asxhtml flag to tidy in html2markdown. This will
17964 perhaps help the parser, which expects closing tags.
17965 + Modified markdown2pdf to run pdflatex a second time if --toc or
17966 --table-of-contents was specified; otherwise the table of
17967 contents won't appear.
17968 + Modified markdown2pdf to print a helpful message if the 'ulem'
17969 LaTeX package is required and not found.
17971 * Changes to build process:
17973 + Dropped support for compilation with GHC 6.4. GHC 6.6 or higher
17974 is now required.
17975 + Removed cabalize and Pandoc.cabal.in. The repository now contains
17976 pandoc.cabal itself.
17977 + Pandoc.cabal has been changed to pandoc.cabal, because HackageDB
17978 likes the cabal file to have the same name as the tarball.
17979 + Expanded and revised the package description in pandoc.cabal.
17980 Revised the package synopsis.
17981 + The tarball built by 'make tarball' now contains files built from
17982 templates (including man pages and shell scripts), so pandoc can
17983 be built directly using Cabal tools, without preprocessing.
17984 + Executable binaries are now stripped before installing.
17985 + Man pages are now generated from markdown sources, using pandoc's
17986 man page writer.
17987 + Use HTML version of README (instead of RTF) in Mac OS X installer.
17988 + Instead of testing for the existence of a pandoc symlink in build-exec,
17989 use ln -f.
17991 * Documentation:
17993 + Updated README and man pages with information on new features.
17994 + Updated INSTALL instructions with some useful clarifications and
17995 links.
17996 + Updated web content.
17998 * Added FreeBSD port.
18000 [ Recai Oktaş ]
18002 * debian/control:
18004 + Changed pandoc's Build-Depends to include libghc6-mtl-dev and
18005 libghc6-xhtml-dev. Removed libghc6-html-dev.
18006 + Suggest texlive-latex-recommended | tetex-extra instead of
18007 tetex-bin. This brings in fancyvrb and unicode support.
18010## pandoc 0.3 (2007-01-05)
18012 [ John MacFarlane ]
18014 * Changes in pandoc options:
18016 + Allow options to follow or precede arguments.
18017 + Changed '--smartypants' to '--smart' and adjusted symbols accordingly.
18018 + Added '--strict' option.
18019 + Added '-o/--output' option.
18020 + Added '--dump-args' and '--ignore-args' options (for use in wrappers).
18021 + Modified '-v' and '-h' output to go to STDERR, not STDOUT, and return
18022 error conditions. This is helpful for writing wrappers.
18023 + Added copyright message to '-v' output, modeled after FSF messages.
18024 + Reformatted usage message so that it doesn't wrap illegibly.
18025 + Removed extra blanks after '-h' and '-D' output.
18027 * Added docbook writer.
18029 * Added implicit setting of default input and output format based
18030 on input and output filename extensions. These defaults are
18031 overridden if explicit input and output formats are specified using
18032 '-t', '-f', '-r', or '-w' options. Documented in pandoc(1) man page
18033 and README.
18035 * Allow ordered list items to begin with (single) letters, as well
18036 as numbers. The list item marker may now be terminated either by
18037 '.' or by ')'. This extension to standard markdown is documented
18038 in README.
18040 * Revised footnote syntax. (See README for full details.) The
18041 '[^1]' format now standard in markdown extensions is supported,
18042 as are inline footnotes with this syntax: `^[My note.]`.
18043 The earlier footnote syntax `^(1)` is no longer supported.
18045 * Improved HTML representation of footnotes. All footnotes
18046 are now auto-numbered and appear in an ordered list at the
18047 end of the HTML document. Since the default appearance is now
18048 acceptable, the old footnote styles have been removed from the
18049 HTML header.
18051 * Bug fixes:
18053 + Fixed a serious bug in the markdown, LaTeX, and RST readers.
18054 These readers ran 'runParser' on processed chunks of text to handle
18055 embedded block lists in lists and quotation blocks. But then
18056 any changes made to the parser state in these chunks was lost,
18057 as the state is local to the parser. So, for example, footnotes
18058 didn't work in quotes or list items. The fix: instead of calling
18059 runParser on some raw text, use setInput to make it the input, then
18060 parse it, then use setInput to restore the input to what it was
18061 before. This is shorter and more elegant, and it fixes the problem.
18062 + Fixed bug in notFollowedBy' combinator (adding 'try' before
18063 'parser'). Adjusted code that uses this combinator accordingly.
18064 + Fixed bug in RTF writer that caused improper indentation on
18065 footnotes occurring in indented blocks like lists.
18066 + Fixed parsing of metadata in LaTeX reader. Now the title, author,
18067 and date are parsed correctly. Everything else in the preamble
18068 is skipped.
18069 + Modified escapedChar in LaTeX reader to allow a `\` at the end of a
18070 line to count as escaped whitespace.
18071 + Modified LaTeX reader to produce inline links rather than reference
18072 links. Otherwise, links in footnotes aren't handled properly.
18073 + Fixed handling of titles in links in Markdown reader, so that
18074 embedded quotation marks are now handled properly.
18075 + Fixed Markdown reader's handling of embedded brackets in links.
18076 + Fixed Markdown reader so that it only parses bracketed material
18077 as a reference link if there is actually a corresponding key.
18078 + Revised inline code parsing in Markdown reader to conform to
18079 markdown standard. Now any number of `s can begin inline code,
18080 which will end with the same number of `s. For example, to
18081 have two backticks as code, write ``` `` ```. Modified Markdown
18082 writer accordingly.
18083 + Fixed bug in text-wrapping routine in Markdown and RST writers.
18084 Now LineBreaks no longer cause wrapping problems.
18085 + Supported hexadecimal numerical entity references as well as
18086 decimal ones.
18087 + Fixed bug in Markdown reader's handling of underscores and other
18088 inline formatting markers inside reference labels: for example,
18089 in '[A_B]: /url/a_b', the material between underscores was being
18090 parsed as emphasized inlines.
18091 + Changed Markdown reader's handling of backslash escapes so that
18092 only non-alphanumeric characters can be escaped. Strict mode
18093 follows Markdown.pl in only allowing a select group of punctuation
18094 characters to be escaped.
18095 + Modified HTML reader to skip a newline following a `<br>` tag.
18096 Otherwise the newline will be treated as a space at the beginning
18097 of the next line.
18099 * Made handling of code blocks more consistent. Previously, some
18100 readers allowed trailing newlines, while others stripped them.
18101 Now, all readers strip trailing newlines in code blocks. Writers
18102 insert a newline at the end of code blocks as needed.
18104 * Modified readers to make spacing at the end of output more consistent.
18106 * Minor improvements to LaTeX reader:
18108 + `\thanks` now treated like a footnote.
18109 + Simplified parsing of LaTeX command arguments and options.
18110 commandArgs now returns a list of arguments OR options (in
18111 whatever order they appear). The brackets are included, and
18112 a new stripFirstAndLast function is provided to strip them off
18113 when needed. This fixes a problem in dealing with \newcommand
18114 and \newenvironment.
18116 * Revised RTF writer:
18118 + Default font is now Helvetica.
18119 + An `\f0` is added to each `\pard`, so that font resizing works
18120 correctly.
18122 * Moved handling of "smart typography" from the writers to the Markdown
18123 and LaTeX readers. This allows great simplification of the writers
18124 and more accurate smart quotes, dashes, and ellipses. DocBook can
18125 now use `<quote>`. The '--smart' option now toggles an option in
18126 the parser state rather than a writer option. Several new kinds
18127 of inline elements have been added: Quoted, Ellipses, Apostrophe,
18128 EmDash, EnDash.
18130 * Changes in HTML writer:
18132 + Include title block in header even when title is null.
18133 + Made javascript obfuscation of emails even more obfuscatory,
18134 by combining it with entity obfuscation.
18136 * Changed default ASCIIMathML text color to black.
18138 * Test suite:
18140 + Added --strip-trailing-cr option to diff in runtests.pl, for
18141 compatibility with Windows.
18142 + Added regression tests with footnotes in quote blocks and lists.
18144 * Makefile changes:
18146 + osx-pkg target creates a Mac OS X package (directory). New osx
18147 directory contains files needed for construction of the package.
18148 + osx-dmg target creates a compressed disk image containing the package.
18149 + win-pkg target creates Windows binary package.
18150 + tarball target creates distribution source tarball.
18151 + website target generates pandoc's website automatically, including
18152 demos. New 'web' directory contains files needed for construction
18153 of the website (which will be created as the 'pandoc' subdirectory
18154 of 'web').
18155 + Makefile checks to see if we're running Windows/Cygwin; if so,
18156 a '.exe' extension is added to each executable in EXECS.
18158 * Removed all wrappers except markdown2pdf and html2markdown.
18160 * Added new wrapper hsmarkdown, to be used as a drop-in replacement
18161 for Markdown.pl. hsmarkdown calls pandoc with the '--strict'
18162 option and disables other options.
18164 * Added code to html2markdown that tries to determine the character
18165 encoding of an HTML file, by parsing the "Content-type" meta tag.
18167 + If the encoding can't be determined, then if the content is local,
18168 the local encoding is used; if it comes from a URL, UTF-8 is used
18169 by default.
18170 + If input is from STDIN, don't try to determine character encoding.
18171 + Encoding can be specified explicitly using '-e' option.
18173 * Improved warning messages in wrappers:
18175 + Print warning if iconv not available
18176 + More user-friendly error messages in markdown2pdf, when
18177 pdflatex fails.
18179 * Code cleanup:
18181 + Renamed 'Text/Pandoc/HtmlEntities' module to
18182 'Text/Pandoc/Entities'. Also changed function names so as
18183 not to be HTML-specific.
18184 + Refactored SGML string escaping functions from HTML and Docbook
18185 writers into Text/Pandoc/Shared. (escapeSGML, stringToSGML)
18186 + Removed 'BlockQuoteContext' from ParserContext, as it isn't
18187 used anywhere.
18188 + Removed splitBySpace and replaced it with a general, polymorphic
18189 splitBy function.
18190 + Refactored LaTeX reader for clarity (added isArg function).
18191 + Converted some CR's to LF's in src/ui/default/print.css.
18192 + Added license text to top of source files.
18193 + Added module data for haddock to source files.
18194 + Reformatted code for consistency.
18196 * Rewrote documentation and man pages. Split README into INSTALL
18197 and README.
18199 * Split LICENSE into COPYING and COPYRIGHT.
18201 * Removed TODO, since we now maintain ToDo on the wiki.
18203 * Made COPYRIGHT in top level a symlink to debian/copyright, to avoid
18204 duplication.
18206 [ Recai Oktaş ]
18208 * Revamped build process to conform to debian standards and created
18209 a proper debian package. Closes: #391666.
18211 * Modified build process to support GHC 6.6.
18213 + The package can still be compiled using GHC 6.4.2, though because
18214 of dependencies the "make deb" target works only with GHC 6.6+.
18215 + The script 'cabalize' is used to create an appropriate
18216 'Pandoc.cabal' from 'Pandoc.cabal.in', depending on the GHC and
18217 Cabal versions.
18219 * Refactored template processing (fillTemplates.pl).
18221 * Modified wrapper scripts to make them more robust and portable.
18222 To avoid code duplication and ensure consistency, wrappers are
18223 generated via a templating system from templates in src/wrappers.
18225 + Wrappers now accept multiple filenames, when appropriate.
18226 + Spaces and tabs allowed in filenames.
18227 + getopts shell builtin is used for portable option parsing.
18228 + Improved html2markdown's web grabber code, making it more robust,
18229 configurable and verbose. Added '-e', '-g' options.
18232## pandoc 0.2 (2006-08-14)
18234 * Fixed unicode/utf-8 translation
18236## pandoc 0.1 (2006-08-14)
18238 * Initial creation of debian package