git.iko.soy/typeable/pandoc
on rc/test-windows-zip-dir help sign in
typeable/pandoc/changelog.md
16968 lines 732 kB history raw
1# Revision history for pandoc
3## pandoc 2.9.1.1 (2020-01-05)
5 * Markdown reader:
7 + Fix parsing bug affected indented code after raw HTML (#6009, #5360).
9 * LaTeX writer:
11 + Fix regression in beamer slide structure with certain slide levels
12 (#6030).
13 + Allow framebreaks for beamer's TOC (Heiko Schlittermann, #6012)
14 + Properly handle unnumbered headings level 4+ (#6018).
15 Previously the `\paragraph` command was used instead of
16 `\paragraph*` for unnumbered level 4 headings.
18 * HTML writer:
20 + Fix revealjs slide structure regression with certain slide levels
21 (#6030).
22 + Add newlines to make slide show output more readable.
24 * Org writer:
26 + Remove extra spaces from table cells (Albert Krewinkel, #6024).
28 * JATS template: Update JATS dtd (Arfon Smith, #6020). Use the archiving
29 and interchange DTD rather than the more restrictive journal publishing
30 DTD (which doesn't permit ext-link as a valid child).
32 * Text.Pandoc.PDF: Fix `runTeXProgram` so that the input source is always
33 overwritten (#6027). Previously it wasn't overridden if the file already
34 existed, which led to bad results on subsequent runs when
35 `pdf-engine-opt=-output-directory=` was used to specify an explicit temp
36 dir.
38 * Text.Pandoc.BCP47: Change `getLang` to handle block-level contents
39 (#6008). Some readers (e.g. RST) will populate the `lang` metadata field
40 with block-level content. `getLang` has been modified to handle this.
41 Previously in these cases the LaTeX writer would not properly set the
42 "main language" of the document.
44 * Fix `test/tables.org` (Albert Krewinkel).
46 * Use HTTPS in copyright message (Felix Yan, #6010)
49## pandoc 2.9.1 (2019-12-23)
51 * Add Jira reader (Albert Krewinkel, #5556).
53 * Jira writer: use jira-wiki-markup renderer (Albert Krewinkel,
54 #5926). The following improvements are included in this change:
56 + non-jira raw blocks are fully discarded instead of showing
57 as blank lines;
58 + table cells can contain multiple blocks;
59 + unnecessary blank lines are removed from the output;
60 + markup chars within words are properly surrounded by
61 braces;
62 + preserving soft linebreaks via `--wrap=preserve` is
63 supported.
65 Note that backslashes are rendered as HTML entities, as there
66 appears no alternative to produce a plain backslash if it is
67 followed by markup. This may cause problems when used with
68 confluence, where rendering seems to fail in this case.
70 * Fix regression with `--number-sections`. Starting with 2.8,
71 `--number-sections` also had the effect of `--section-divs`,
72 even if `--section-divs` was not specified.
74 * Improved table of contents generation in markdown, RTF,
75 commonmark, better handling cases where section headings are
76 enclosed in divs.
78 * Ensure that later default file values for `variable` replace
79 earlier ones (5988).
81 * HTML reader: Add `nav` to list of block-level tags.
83 * Org reader (Albert Krewinkel):
85 + Wrap named table in Div, using name as id (#5984).
86 Tables which are given a name via `#+NAME:` or `#+LABEL:`
87 are wrapped in an additional Div, with the name set as the
88 Div's ID.
89 + Report parsing errors properly.
90 + Fix parsing problem for colons in headline (#5993).
92 * Text.Pandoc.PDF: Ensure UTF8 when printing source in
93 `--verbose` mode, avoiding an error on platforms that
94 default to something other than UTF-8 (#5997).
96 * Text.Pandoc.Templates: Strip directory before trying to find
97 partial in data files (#5987).
99 * Text.Pandoc.Shared: Improve `makeSections` so we don't get
100 doubled "number" attributes in EPUB output (or anywhere
101 else) (#5986).
103 * Added tests for `--toc` and `--section-divs`.
105 * Text.Pandoc.MIME: Added glsl MIME type for WebGL maps (#6000,
106 Jared Lander).
108 * MANUAL: A bit clearer explanation for `--base-header-level`.
109 We now say exactly how to translate between the deprecated
110 `--base-header-level` and `--shift-heading-level-by`.
112 * lua-filters.md:
114 + Remove spurious dot in title (#5996, Mauro Bieg).
115 + Replace metadata example with image centering (#6004,
116 Albert Krewinkel). Thanks to @efx for proposing this filter.
119## pandoc 2.9 (2019-12-11)
121 * Text.Pandoc.Templates [API change]
123 + Add Monad wrappers `WithDefaultPartials` and `WithPartials`.
124 Wrapping these around an instance of `PandocMonad` gives
125 us different instances of `TemplateMonad`, with different
126 search behavior in retrieving partials.
127 To compile a template and limit partial search to pandoc's
128 data files, use `runWithDefaultPartials (compileTemplate ...)`.
129 To compile a template and allow partials to be found locally
130 (either on the file system or via HTTP, in the event that
131 the main template has an absolute URL), ue
132 `runWithPartials (compileTemplate ...)`.
133 + Export `getTemplate`, which seeks a template locally,
134 or via HTTP if the template has an absolute URL, falling
135 back to the data files if not found.
136 + Export `compileDefaultTemplate` -- does `getDefaultTemplate`
137 and compiles the result, raising an error on failure.
139 * Text.Pandoc.Class [API change]
141 + Remove `TemplateMonad` instances for `PandocIO` and `PandocPure`.
142 These were too limiting and caused a bug whereby a local
143 partial could be used even when the default template was requested.
144 We now rely on instances provided in the Templates module.
146 * Text.Pandoc.App.OutputSettings: Simplify template retrieval code.
148 * ConTeXt template: Adjust to title formatting (#5949, Denis Maier).
149 Add `\setupinterlinespace` to `title`, `subtitle`, `date` and `author`
150 elements: otherwise longer titles that run over multiple lines will look
151 squashed as `\tfd` etc. won't adapt the line spacing to the font size.
153 * reveal.js template: Add title-slide-attributes variable (#5981,
154 Frederik Elwert).
156 * More informative JSON parse error (#5973).
158 * Use external emojis package (forked from pandoc). Removed emoji data
159 in Text.Pandoc.Emoji.
161 * Fix regression in `makeSections` (#5965).
162 Previously `hierarchicalize` (the ancestor of `makeSections`) would put
163 header attributes on the containing Div. In 2.8 this behavior changed,
164 which broke some tools depending on pandoc. Here we roll back this change,
165 so that attributes again migrate from the header to the containing Div when
166 `makeSections` is run. Note that attributes are retained on the header as
167 well (unlike before) -- with the exception of the `id` attribute, which of
168 course cannot be duplicated.
170 * Fix `--toc-depth` regression in 2.8 (#5967).
172 * Use doctemplates 0.8. Rename template 'filters' as 'pipes'
173 to avoid confusion with the other notion of filter used by pandoc.
175 * Fix README.md so that relative links from manual become absolute.
176 Previously they'd be broken links when viewed on GitHub or Hackage.
177 So we add the base URL for the pandoc manual.
179 * Document display math syntax in manual.
181## pandoc 2.8.1 (2019-12-05)
183 * Add `ascii_identifiers` as a supported extension for `markdown`.
184 This fixes a regression in 2.8.
186 * Fix regression with behavior of `--variable` (#5962).
187 Previously `-Vfoo=1 -Vfoo=2` would produce a list value for foo;
188 with 2.8 it produced just `2`. This commit restores the earlier
189 behavior.
191 * Roll back part of of `--shift-heading-level-by` change (#5957).
192 With positive heading shifts, starting in 2.8 this option
193 caused metadata titles to be removed and changed to regular
194 headings. This behavior is incompatible with the old
195 behavior of `--base-header-level` and breaks old workflows,
196 so we have rolled back the change. Note that there is now an
197 asymmetry in positive and negative heading level shifts:
198 With positive shifts, the metadata title stays the same and
199 does not get changed to a heading in the body, while with
200 negative shifts, a heading can be converted into the
201 metadata title.
203 * Text.Pandoc.Shared: Fix `makeSections` so it doesn't turn
204 column Divs into sections.
206 * HTML writer: add task-list class to ul if all elements are
207 task list items. This will allow styling unordered task
208 lists in a way that omits the bullet.
210 * HTML-based templates: Add CSS to suppress bullet on unordered task lists.
212 * ConTeXt template: Fix `\startcslreferences` and use ConTeXt syntax
213 conventions (#5945, Denis Maier). The old version had a too large
214 a skip at the beginning of the reference list.
216 * LaTeX template: keep the `\author{}` command even if author is not
217 specified (#5961, Yihui Xie). Avoids a LaTeX warning.
219 * Generate Emoji module with TH.
221 + Add Text.Pandoc.Emoji.TH.
222 + Replace long literal list in Text.Pandoc.Emoji with one-liner
223 generating it from `emoji.json` using TH.
224 + Add Makefile target to download `emoji.json`.
225 + Remove `tools/emoji.hs`.
227 * Increase GC allocation space for compilation in cabal.project.
229 * Clean up manual on PDF generation backend options (#5940).
231 * Update release checklist to include code signing step and update
232 Windows release-candidate builds (#5950).
235## pandoc 2.8.0.1 (2019-11-26)
237 * List `pdf` in `--list-output-formats`.
238 * EPUB writer: Fix regression with `--css` (#5937). In 2.8 `--css`
239 would not have an effect on EPUB output.
240 * RST writer: Use grid tables for one-column tables, since
241 simple tables clash with heading syntax in this case (#5936).
242 * Add unexported module Text.Pandoc.Readers.Metadata (see #5914).
243 * Use doctemplates 0.7.2, which adds the `nowrap` filter to
244 templates.
245 * Update default man template using `nowrap` for .TH heading (#5929).
246 * HTML templates: Add support for `toc-title` variable (#5930,
247 Alexandre Franke).
248 * Remove `grffile` (LaTeX package) requirement in MANUAL.txt
249 (#5927, Ian Max Andolina).
250 * Use skylighting 0.8.3.
252## pandoc 2.8 (2019-11-22)
254 * Improvements in templates system (from doctemplates):
256 + Pandoc templates now support a number of new features that
257 have been added in doctemplates: notably, `elseif`, `it`,
258 partials, filters, and syntax to control nesting and reflowing of
259 text. These changes make pandoc more suitable out of the
260 box for generating plain-text documents from data in YAML
261 metadata. It can create enumerated lists and even tabular
262 structures.
263 + We now used templates parameterized on doclayout Doc types.
264 The main impact of this change is better reflowing of
265 content interpolated into templates. Previously,
266 interpolated variables were rendered independently and
267 intepolated as strings, which could lead to overly long
268 lines. Now the templates interpolated as Doc values which
269 may include breaking spaces, and reflowing occurs after
270 template interpolation rather than before.
271 + Remove code from the LaTeX, Docbook, and JATS writers that
272 looked in the template for strings to determine whether it
273 is a book or an article, or whether csquotes is used. This
274 was always kludgy and unreliable.
275 + Change template code to use new API for doctemplates.
277 * Add `--defaults`/`-d` option. This adds the ability to specify
278 a collection of default values for options in a YAML file. For
279 example, one might define a set of defaults for letters,
280 and then do `pandoc -d letter myletter.md -o myletter.pdf`.
281 See the documentation of this feature in MANUAL.txt.
283 * Raise error on unsupported extensions (#4338).
285 * The `--list-extensions[=FORMAT]` option now lists only
286 extensions that affect the given FORMAT.
288 * Add `-L` option as shortcut for `--lua-filter`.
290 * Add `--shift-heading-level-by` option and deprecate
291 `--base-heading-level` (#5615). The new option does
292 everything the old one does, but also allows negative shifts.
293 It also promotes the document metadata (if not null) to a
294 level-1 heading with a +1 shift, and demotes an initial
295 level-1 heading to document metadata with a -1 shift. This
296 supports converting documents that use an initial level-1
297 heading for the document title.
299 * Allow `--metadata-file` to be used repeatedly to include
300 multiple metadata files (Owen McGrath, #5702). Values in
301 files specified first will be overridden by those in later
302 files.
304 * `--ascii` now uses numerical hex character references (#5718).
306 * Allow PDF output to stdout (#5751). PDF output now behaves like other
307 binary formats: it will not be output to the terminal, but can be
308 sent to stdout using either `-o -` or a pipe. The intermediate format
309 will be determined based on the setting of `--pdf-engine`.
311 * Make some writers sensitive to 'unlisted' class on headings (#1762).
312 If this is present on a heading with the 'unnumbered' class,
313 the heading won't appear in the TOC. This class has no
314 effect if 'unnumbered' is not also specified. This affects HTML-based
315 writers (including slide shows and EPUB), LateX (including beamer), RTF,
316 and PowerPoint. Other writers do not yet support `unlisted`.
318 * Fix `gfm_auto_identifiers` behavior with emojis (#5813). Note that
319 we also now use emoji names for emojis when `ascii_identifiers`
320 is enabled.
322 * When `--ipynb-output` is used with the default "best" format, strip
323 ANSI escape codes for non-ipynb output (#5633). These cause problems
324 in many formats, including LaTeX.
326 * Don't look for template files remotely for remote input (#5579).
327 Previously pandoc would look for the template at a remote URL when a
328 URL was used for the input file, instead of taking it from the
329 data directory.
331 * Allow combining `-Vheader-includes` and `--include-in-header` (#5904).
332 Previously `header-includes` set as a variable would be
333 clobbered by material included using `--include-in-header`.
335 * Change merge behavior for metadata. Previously, if a document
336 contained two YAML metadata blocks that set the same field, the
337 conflict would be resolved in favor of the first. Now it is resolved
338 in favor of the second (due to a change in pandoc-types).
339 This makes the behavior more uniform with other things in pandoc
340 (such as reference links and `--metadata-file`).
342 * Don't add a newline to fragment output if there's already one.
344 * Change exit codes and document in MANUAL.txt:
346 + `PandocAppError` was 1, is now 4
347 + `PandocOptionError` was 2, is now 6
348 + `PandocMakePDFError` was 65, is now 66
350 * Switch to new pandoc-types and use Text instead of String [API change].
351 (Christian Despres, #5884).
353 * HTML reader:
355 + Better handling of `<q>` with cite attribute (#5798, Ole Martin Ruud).
356 If a `<q>` tag has a `cite` attribute, we interpret it as a Quoted
357 element with an inner Span.
358 + Add support for HTML `<samp>` element (#5792, Amogh Rathore).
359 The `<samp>` element is parsed as Code with class `sample`.
360 + Add support for HTML `<var>` element (#5799, Amogh Rathore).
361 The `<var>` element is parsed as Code with class `variable`.
362 + Add support for `<mark>` elements (Florian B, #5797). Parse
363 `<mark>` elements from HTML as Spans with class `mark`.
364 + Add support for `<kbd>` elements, parsing them as Span with class
365 `kbd` (Daniele D'Orazio, #5796).
366 + Add support for `<dfn>`, parsing this as a Span with class `dfn`
367 (#5882, Florian Beeres).
369 * Markdown reader:
371 + Headers: don't parse content over newline boundary (#5714).
372 + Handle inline code more eagerly within lists (Brian Leung, #5627).
373 + Removed some needless lookaheads.
374 + Don't parse footnote body unless extension enabled.
375 + Fix small super/subscript issue (#5878). Superscripts and subscripts
376 cannot contain spaces, but newlines were previously allowed
377 (unintentionally). This led to bad interactions in some cases
378 with footnotes. With this change newlines are also not allowed inside
379 super/subscripts.
380 + Use `take1WhileP` for `str`, table row. This yields a small but
381 measurable performance improvement.
384 * LaTeX reader:
386 + Fix parsing of optional arguments that contain braced text (#5740).
387 + Don't try to parse includes if `raw_tex` is set (#5673).
388 When the `raw_tex` extension is set, we just carry through
389 `\usepackage`, `\input`, etc. verbatim as raw LaTeX.
390 + Properly handle optional arguments for macros (#5682).
391 + Fix `\\` in `\parbox` inside a table cell (#5711).
392 + Improve `withRaw` so it can handle cases where the token string is
393 modified by a parser (e.g. accent when it only takes part of a Word
394 token) (#5686). This fixes a bug that caused the ends of
395 certain documents to be dropped.
396 + Handle `\passthrough` macro used by latex writer (#5659).
397 + Support tex `\tt` command (#5654).
398 + Search for image with list of extensions like latex does, if an
399 extension is not provided (#4933).
400 + Handle `\looseness` command values better (#4439).
401 + Add `mbox` and `hbox` handling (Vasily Alferov, #5586).
402 When `+raw_tex` is enabled, these are passed through literally.
403 Otherwise, they are handled in a way that emulates LaTeX's behavior.
404 + Properly handle `\providecommand` and `\provideenvironment` (#5635).
405 They are now ignored if the corresponding command or environment
406 is already defined.
407 + Support epigraph command in LaTeX Reader (oquechy, #3523).
408 + Ensure that expanded macros in raw LaTeX end with a space
409 if the original did (#4442).
410 + Treat `ly` environment from lilypond as verbatim (Urs Liska, #5671).
411 + Add `tikzcd` to list of special environments (Eigil Rischel).
412 This allows it to be processed by filters, in the same way that
413 one can do for `tikzpicture`.
415 * Roff reader:
417 + Better support for `while`.
418 + More improvements in parsing conditionals.
419 + Fix problem parsing comments before macro.
420 + Improve handling of groups.
421 + Better parsing of groups (#5410). We now allow groups
422 where the closing `\\}` isn't at the beginning of a line.
424 * RST reader:
426 + Keep `name` property in `imgAttr` (Brian Leung, #5619).
427 + Fixed parsing of indented blocks (#5753). We were requiring
428 consistent indentation, but this isn't required by RST.
429 + Use title, not admonition-title, for admonition title.
430 This puts RST reader into alignment with docbook reader.
431 + Don't strip final underscore from absolute URI (#5763).
432 + Avoid spurious warning when resolving links to internal anchors
433 ending with `_` (#5763).
435 * Org reader:
437 + Accept `ATTR_LATEX` in block attributes (Albert Krewinkel, #5648).
438 Attributes for LaTeX output are accepted as valid block attributes;
439 however, their values are ignored.
440 + Modify handling of example blocks (Brian Leung, #5717).
441 + Allow the `-i` switch to ignore leading spaces (Brian Leung).
442 + Handle awkwardly-aligned code blocks within lists (Brian Leung).
443 Code blocks in Org lists must have their `#+BEGIN_` aligned in a
444 reasonable way, but their other components can be
445 positioned otherwise.
446 + Fix parsing of empty comment lines (#5856, Albert Krewinkel).
447 Comment lines in Org-mode can be completely empty.
449 * Muse reader (Alexander Krotov):
451 + Add RTL support (#5551).
452 + Do not allow closing asterisks to be followed by `*`.
453 + Do not split series of asterisks into symbols and emphasis (#5821).
454 + Do not terminate emphasis on `*` not followed by space.
456 * DokuWiki reader:
458 + Parse markup inside monospace ('') (#5916, Alexander Krotov).
460 * Docx reader:
462 + Move style-parsing-specific code to a new unexported module,
463 Text.Pandoc.Readers.Docx.Parse.Styles (Nikolay Yakimov).
464 + Move StyleMap to docx writer (Nikolay Yakimov).
465 + Only use LTR when it is overriding BiDi setting (#5723, Jesse
466 Rosenthal). The left-to-right direction setting in docx is used
467 in the spec only for overriding an explicit right-to-left setting.
468 We only process it when it happens in a paragraph set with BiDi.
469 This is especially important for docs exported from Google Docs,
470 which explicitly (and unnecessarily) set `rtl=0` for every paragraph.
471 + Fix list number resumption for sublists (#4324).
472 The first list item of a sublist should not resume numbering
473 from the number of the last sublist item of the same level,
474 if that sublist was a sublist of a different list item.
476 * Docbook reader:
478 + Richer parse for admonitions (Michael Peyton Jones, #1234).
479 Instead of parsing admonitions as blockquotes, we now parse
480 them as Divs with an appropriate class. We also handle titles
481 for admonitions as a nested Div with the "title" class.
482 + Fix nesting of chapters and sections (#5864, Florian Klink,
483 Félix Baylac-Jacqué).
484 + Fix bug with entities in mathphrase element (#5885).
486 * MediaWiki reader:
488 + Skip optional `{{table}}` template (#5757).
490 * LaTeX reader:
492 + Fix dollar-math parsing to ensure that space is left between a
493 control sequence and a following letter (#5836).
494 + In `untokenize`, ensure space between control sequence
495 and following letter (#5836).
496 + Don't omit macro definitions defined in the preamble.
497 These were formerly omitted (though they still affected macro
498 resolution if `latex_macros` was set). Now they are included in
499 the document body.
500 + Parse macro definitions as raw LaTeX when `latex_macros` is
501 disabled. (When `latex_macros` is enabled, we omit them, since
502 pandoc is applying the macros itself.)
503 + Fix a hang/memory leak in certain circumstances (#5845).
504 + Text.Pandoc.Readers.LaTeX.Parsing: add `[Tok]` parameter to
505 `rawLaTeXParser`. This allows us to repeat retokenizing
506 unnecessarily in e.g. `rawLaTeXBlock`.
507 + Add KOMA-Script metadata commands (#5910, Andrew Dunning).
508 Add all titling commands to existing definition for `\dedication`.
509 + Parse `\micro` siunitx unit command (#5921, Jose Luis Duran).
511 * Markdown writer:
513 + Ensure proper nesting when we have long ordered list markers (#5705).
514 + Make `plain` output plainer (#5741). Previously we used the following
515 Project Gutenberg conventions for plain output: extra space before and
516 after level 1 and 2 headings, all-caps for strong emphasis,
517 underscores surrounding regular emphasis. Now these
518 conventions are used only when the `gutenberg` extension is
519 enabled. By default, Strong and Emph are rendered without
520 special formatting, and headings are rendered without
521 special formatting, and with only one blank line following.
522 To restore the former behavior, use `-t plain+gutenberg`.
523 + Prefer using raw_attribute when enabled (#4311).
524 The `raw_attribute` will be used to mark raw bits, even HTML
525 and LaTeX, and even when `raw_html` and `raw_tex` are
526 enabled, as they are by default. To get the old behavior,
527 disable `raw_attribute` in the writer.
528 + Prefer `pipe_tables` to raw HTML even when we must
529 lose width information (#2608, #4497).
530 + Improve escaping in list items (#5918).
532 * AsciiDoc writer:
534 + Don't include `+` in code blocks for regular asciidoc.
535 This is asciidoctor-specific.
536 + Handle admonitions (#5690).
538 * LaTeX writer:
540 + Add thin space when needed in LaTeX quote ligatures (#5684).
541 + Use `\hspace{0pt}` for 0-width space U+200B (#5756).
542 + Use `cslreferences` environment for csl bibliographies.
543 This allows bibliographies to receive special formatting.
544 The template now contains definition of this environment (enabled
545 only when CSL is used). It also defines a `\cslhangindent` length.
546 This is set to 2em by default when the bibliography style specifies
547 a hanging indent. To override the length, you can use e.g.
548 `\setlength{\cslhangindent}{7em}` in header-includes.
549 See jgm/pandoc-citeproc#410.
550 + Strip off `{}` around locator for biblatex/natbib output (#5722).
551 + Fix line breaks at start of paragraph (#3324).
552 Previously we just omitted these. Now we render them
553 using `\hfill\break` instead of `\\`. This is a revision
554 of a PR by @sabine (#5591) who should be credited with the idea.
555 + We no longer look in the template or header-includes to see if a
556 book or article documentclass is used, or to see whether the
557 `csquotes` package is used. To use `csquotes` for LaTeX, set
558 `csquotes` in your variables or metadata. To specify a book
559 style, use the `documentclass` variable or
560 `--top-level-division`.
561 + Fix horizontal rule (#5801). We change to use 0.5pt rather than
562 `\linethickness`, which apparently only ever worked "by accident"
563 and no longer works with recent updates to texlive.
565 * ConTeXt writer:
567 + Add option to include source files in ConTeXt PDFs (Tristan
568 Stenner, #5578). The metadata field or variable
569 (`includesource`) can be set to attach the source documents
570 to the resulting PDF.
571 + Customizable type of PDF/A for the ConTeXt writer (Karl
572 Pettersson, #5608). The `pdfa` variable may now be set in metadata.
573 Also updated color profile settings in accordance with ConTeXt wiki,
574 and made ICC profile and output intent for PDF/A customizable
575 using `pdfaiccprofile` and `pdfaintent`.
576 + Unit tests: adjust code property to avoid an irrelevant
577 failure involving inline code with two consecutive newlines.
578 + Set `csl-hanging-indent` variable if needed.
579 + Use special environment for CSL references.
580 + Use braces, not start/stop, for inline language tags.
581 This prevents unwanted gobbling of spaces.
583 * HTML writer:
585 + Use numeric character references with `--ascii` (#5718).
586 Previously we used named character references with html5 output.
587 But these aren't valid XML, and we aim to produce html5 that is
588 also valid XHTML (polyglot markup). (This is also needed for epub3.)
589 + Ensure that line numbers in code blocks get id-prefix (#5650).
590 + Ensure TeX formulas are rendered correctly (Philip Pesca,
591 #5658). The web service passed in to `--webtex` may render
592 formulas using inline or display style by default.
593 Prefixing formulas with the appropriate command ensures
594 they are rendered correctly.
595 + Render inline formulas correctly with `--webtex` (Philip
596 Pesca, #5655). We add `\textstyle` to the beginning of the
597 formula to ensure it will be rendered in inline style.
598 + Pass through `aria-` attributes to HTML5 (#5642).
599 + Render a Quoted element with an inner Span with
600 `cite` attribute using a `<q>` tag (#5798, Ole Martin Ruud).
601 + Render a Span with class `mark` using the `<mark>` element
602 (Florian Beeres, #5797).
603 + Render Span with class `dfn` using `<dfn>` element
604 (Florian Beeres, #5882).
605 + Render Span with class `kbd` using `<kbd>` element (Daniele
606 D'Orazio, #5796).
607 + Render Code with class `variable` using `<var>` element
608 (Amogh Rathore, #5799).
609 + Render Code with class `sample` using `<samp>` element
610 (Amogh Rathore, #5799).
612 * EPUB writer:
614 + Improve splitting into chapters (#5761), using `makeSection`.
615 + Avoid issuing warning multiple times when title not set (see #5760).
616 + Use svg tag wrapper for cover image (#5638). In addition, the
617 code generating the image has been moved to the template, to make it
618 more customizable. NOTE: Those who use custom EPUB
619 templates will need to adjust their templates, adding the
620 code to generate the cover image. (Previously this was just
621 inserted into 'body'.)
622 + Improve toChapters, making it work better if there are Divs
623 around sections.
624 + Add support for EPUB2 covers (blmage, #3992).
625 + Do not override existing "fileN" medias when writing to EPUB format
626 (blmage, #4206).
627 + Ensure that `lang` variable is set on all chapters (so that it
628 will add an `xml:lang` attribute on the `html` element).
630 * RST writer:
632 + Removed remnants of `admonition-title`.
633 + Fix handling of `:align:` on figures and images (#4420).
634 When the image has the `align-right` (etc.) class, we now use
635 an `:align:` attribute.
636 + Improve spacing for tables with no width information (#5899).
637 If a simple table would be too wide, we use a grid table.
638 + Fix backslash escaping after strings (Albert Krewinkel, #5906).
639 The check whether a complex inline element following a string must
640 be escaped, now depends on the last character of the string instead
641 of the first.
642 + Ensure there's a blank line before tables (#5898).
644 * Dokuwiki writer:
646 + Handle mixed lists without HTML fallback (#5107).
648 * XWiki writer:
650 + Fix multiline table (Zihang Chen, #5683).
652 * Muse writer:
654 + Add RTL support (Alexander Krotov, #5551).
656 * Man writer:
658 + Suppress non-absolute link URLs (#5770). Absolute URLs are
659 still printed in parentheses following the link text, but relative
660 URLs are suppressed (just as internal links starting with '#'
661 always have been).
662 + Improved definition list term output. Now we boldface code but
663 not other things. This matches the most common style in man pages
664 (particularly option lists).
666 * Ms writer:
668 + Use `.LP` instead of `.PP` for line block (#5588).
669 + Use boldface for definition terms in DefinitionLists.
671 * JATS writer:
673 + Do not emit empty `<fn-group>` (Mauro Bieg, #5595).
674 + Update template to v1.1dtd (#5632, Arfon Smith).
675 + Update `data/jats.csl` to avoid commas between editor
676 name-part elements. (#5629)
677 + Add `abstract` to template (Mauro Bieg).
679 * TEI writer:
681 + Don't strip hash from internal links (#5922).
683 * Jira writer:
685 + Remove escapeStringForJira for code blocks (Jan-Otto Kröpke).
686 + Remove extraneous newline after single-line block quotes
687 (#5858, Albert Krewinkel).
688 + Improve escaping of special characters, using backslash escapes
689 instead of HTML entities (#5858, Albert Krewinkel).
691 * OpenDocument writer:
693 + Avoid duplicate attributes (#4634). We use the innermost
694 attribute in nested cases.
695 + If `native_numbering` extension is set, use native OpenDocument
696 enumeration for figures and tables (Nils Carlson).
697 + Place caption before table (#5681, Dmitry Pogodin).
699 * ODT writer:
701 + Add a test for MathML formulas in ODT documents (blmage).
702 + Improve the parsing of frames in ODT documents (blmage).
704 * Docx writer:
706 + Make handling of styles more robust in localized versions
707 of Word (Nikolay Yakimov, #5523, #5052, #5074). We now use
708 style names, not ids, for assigning semantic meaning, since
709 the ids can change depending on the locale. Style name
710 comparisons are case-insensitive, since those are
711 case-insensitive in Word. Since docx style names can have
712 spaces in them, and pandoc-markdown classes can't, anywhere
713 when style name is used as a class name, spaces are
714 replaced with ASCII dashes `-`. Code styles, i.e. "Source
715 Code" and "Verbatim Char" now honor style inheritance. Docx
716 Reader now honours "Compact" style (used in
717 Pandoc-generated docx). The side-effect is that "Compact"
718 style no longer shows up in docx+styles output. Styles
719 inherited from "Compact" will still show up.
720 + Re-use Readers.Docx.Parse for StyleMap (#5766, Nikolay Yakimov).
721 + Internal improvements and code simplification (Nikolay Yakimov).
722 + Preserve built-in styles in DOCX with custom style (Ben Steinberg,
723 #5670). This change prevents custom styles on divs and spans
724 from overriding styles on certain elements inside them, like
725 headings, blockquotes, and links. On those elements, the
726 "native" style is required for the element to display correctly.
727 This change also allows nesting of custom styles; in order to do so,
728 it removes the default "Compact" style applied to Plain blocks,
729 except when inside a table.
730 + Add `proofState` to list of elements carried over from
731 settings.xml in the reference.docx (Krystof Beuermann, #5703).
732 + Change order of `ilvl` and `numId` in `document.xml` (Agustín
733 Martín Barbero, #5645). Also, make list para properties go first.
734 This reordering of properties shouldn't be necessary but
735 it seems Word Online does not understand the docx correctly otherwise.
737 * PowerPoint writer:
739 + Code formatting is now context dependent (Jeroen de Haas, #5573).
740 This commit alters the way in which the Powerpoint writer treats
741 inline code and code blocks. Inline code is now formatted at
742 the same size as the surrounding text. Code blocks are now given
743 a margin and font size according to their level.
744 Furthermore this commit allows changing the font with which code is
745 formatted via the `monofont` option.
746 + Start numbering at appopriate numbers (Jesse Rosenthal, #5709).
747 Starting numbers for ordered lists were previously ignored. Now
748 we specify the number if it is something other than 1.
750 * Text.Pandoc.Parsing:
752 + Add `manyChar`, `many1Char`, `manyTillChar`, `many1TillChar`,
753 `many1Till`, `manyUntil`, `mantyUntilChar`: these are like their
754 unsuffixed counterparts but pack some or all of their output
755 (Christian Despres, #5884).
756 + Add `stateAllowLineBreaks` to `ParserState` [API change].
757 + Fix inline parsing in grid table cells (#5708).
758 + Change type of `setLastStrPos` so it takes a `Maybe SourcePos`
759 rather than a `SourcePos` [API change].
760 + Make `parseFromString'` and `gridTableWith` and
761 `gridTableWith'` polymorphic in the parser state,
762 constraining it with `HasLastStrPosition` [API change].
763 + `parseFromString'`: reset `stateLastStrPos` to `Nothing` before parse.
764 + Rename takeWhileP -> take1WhileP and clean it up.
765 (It doesn't match the empty sequence.)
767 * Text.Pandoc.PDF:
769 + For PDFs via HTML, ensure temp file is deleted even if the pdf
770 program is not found (#5720).
771 + Better detection of a Cygwin environment (#5451).
772 + Don't assume tex log file is UTF8-encoded (#5872).
773 Fall back to latin1 if it can't be read as UTF-8.
775 * Text.Pandoc.Extensions:
777 + Export new function `getAllExtensions`, which returns the
778 extensions that affect a given format (whether enabled by default
779 or not) [API change].
780 + Change type of `parseFormatSpec` from
781 `Either ParseError (String, Extensions -> Extensions)`
782 to `Either ParseError (String, [Extension], [Extension])`
783 [API change].
784 + Add `Ext_gutenberg` constructor to `Extension` [API change].
785 + Add `Ext_native_numbering` constructor to `Extension` [API change]
786 (Nils Carlson).
788 * Text.Pandoc.Readers, Text.Pandoc.Writers:
790 + Change type of `getReader` and `getWriter` so they return
791 a value in the PandocMonad instance rather than an Either
792 [API change]. Exceptions for unknown formats and unsupported
793 extensions are now raised by these functions.
795 * Text.Pandoc.App
797 + Change `optMetadataFile` type from `Maybe FilePath` to `[FilePath]`
798 (Owen McGrath, #5702) [API change].
800 * Text.Pandoc.Logging:
802 + Add `CouldNotDeduceFormat` constructor to `LogMessage` [API change].
803 Issue this warning when we're falling back to markdown or
804 html because we don't recognize the extension of the input or
805 output files.
806 + Clarify warning for missing title (#5760).
807 + Add `UnusualConversion` constructor to `LogMessage` [API change]
808 (Mauro Bieg, #5736). Emit warning on `-f latex -o out.pdf`.
810 * Lua filters:
812 + Improve function documentation (Albert Krewkinkel).
813 + Traverse nested blocks and inlines in correct order (Albert
814 Krewinkel, #5667). Traversal methods are updated to use the new
815 Walk module so that sequences with nested Inline (or Block) elements
816 are traversed in the order in which they appear in the linearized
817 document.
818 + New unexported module `Text.Pandoc.Lua.Walk` (Albert Krewinkel).
819 Lua filters must be able to traverse sequences of AST
820 elements and to replace elements by splicing sequences back
821 in their place. Special `Walkable` instances can be used for
822 this; those are provided in a new module
823 `Text.Pandoc.Lua.Walk`.
824 + `Attr` values can now be given as normal Lua tables (Albert
825 Krewinkel, #5744). This can be used as a convenient alternative
826 to constructing `Attr` values with `pandoc.Attr`. Identifiers
827 are taken from the `id` field, classes must be given as
828 space separated words in the `class` field. All remaining fields
829 are included as attributes. With this change, the following lines
830 now create equal elements:
831 ```
832 pandoc.Span('test', {id = 'test', class = 'a b', check = 1})
833 pandoc.Span('test', pandoc.Attr('test', {'a','b'}, {check = 1}))
834 ```
835 This also works when using the *attr* setter:
836 ```
837 local span = pandoc.Span 'text'
838 span.attr = {id = 'test', class = 'a b', check = 1}
839 ```
840 Furthermore, the *attributes* field of AST elements can now be a
841 plain key-value table even when using the `attributes` accessor:
842 ```
843 local span = pandoc.Span 'test'
844 span.attributes = {check = 1} -- works as expected now
845 ```
846 + Export `make_sections`, remove `hierarchicalize`. Lua filters that
847 use `hierarchicalize` will need to be rewritten to use
848 `make_sections`.
849 + Add a `clone()` method to all AST elements (Albert Krewinkel, #5568).
850 + Fix Lua function names in pandoc.system (niszet). Change
851 `get_current_directory` to `get_working_directory` and
852 `with_temp_directory` to `with_temporary_directory`, to
853 conform to the manual.
855 * Text.Pandoc.Error:
857 + Add constructors `PandocUnknownReaderError`,
858 `PandocUnknownWriterError`, `PandocUnsupportedExtensionError`.
859 [API change].
860 + Better message for `PandocShouldNeverHappenError`.
861 + Better message for `PandocTemplateError`.
863 * Text.Pandoc.Emoji:
865 + Update emoji list (#5666). Done using new `tools/emojis.hs`,
866 which uses the list from the gem GitHub uses. Future updates
867 can be done with this tool.
869 * Text.Pandoc.PDF:
871 + Pass value of `--dpi` to `rsvg-convert` when converting SVG to PDF
872 in the process of creating a PDF (#5721).
874 * Text.Pandoc.Shared:
876 + Replace `Element` and `makeHierarchical` with `makeSections`.
877 Now that we have Divs, we can use them to represent the
878 structure of sections, and we don't need a special Element type.
879 `makeSections` reorganizes a block list, adding Divs with class
880 `section` around sections, and adding numbering if needed.
881 This change also fixes some longstanding issues recognizing section
882 structure when the document contains Divs (#3057, see also #997).
883 + Remove `Element` type [API change]
884 + Remove `makeHierarchicalize` [API change]
885 + Add `makeSections` [API change]
886 + Export `deLink` [API change]
887 + Make `filterIpynbOutput` strip ANSI escapes from code in output
888 for non-ipynb formats, when the default "best" option is used with
889 `--ipynb-output` (#5633).
890 + Fix `camelCaseToHyphenated` so it handles `ABCDef` better.
891 + Improve `isTight` (#5857). If a list has an empty item,
892 this should not count against its being a tight list.
893 + Export `htmlSpanLikeElements` [API change] (Daniele D'Orazio, #5796).
894 This is a mapping of HTML span-like elements that are internally
895 represented as a Span with a single class.
896 + Change the implementation of `htmlSpanLikeElements` to retain
897 classes and attributes (#5882, Florian Beeres).
899 * Text.Pandoc.Slides: recognize content in Divs when determining
900 slide level.
902 * Text.Pandoc.SelfContained:
904 + Omit content-type on type attribute for `<style>` (#5725).
905 It doesn't seem to be valid for HTML5, and as a result Chrome
906 ignores the style element.
908 * Text.Pandoc.Pretty has been removed [API change].
909 We now use the new external doclayout module instead.
911 * Text.Pandoc.Writers.Shared:
913 + Remove `metaToJSON`, `metaToJSON'` [API change].
914 + Modify `addVariablesToContext`, `defField`, `setField`, `getField`,
915 `resetField` to work with Context rather than JSON values. [API change]
916 + Export new function `endsWithPlain` [API change].
917 + Change `gridTables` so it does better at keeping the widths of
918 columns (#4320) and does better at figuring out column widths
919 when no widths are given (#5899).
921 * Text.Pandoc.Options
923 + Change type of `writerTemplate` to `Maybe Template` instead
924 of `Maybe String`.
925 + Change To/FromJSON instances for `HTMLMathMethod`, `CiteMethod`,
926 `ObfuscationMethod`, `TrackChanges`, `WrapOption`,
927 `TopLevelDivision`, `ReferenceLocation`, `HTMLSlideVariant` (#5790).
928 In each case we use lowercase (or hyphenated lowercase) for
929 constructors to line up more closely with command-line option
930 values. This is a breaking change for those who manually decode or
931 encode JSON for these data types (e.g. for `ReaderOptions` or
932 `WriterOptions`).
934 * Text.Pandoc.Filters:
936 + Add `FromYAML` instance for `Filter`.
937 + `applyFilters`: Add and apply filters in order (not reversed)
938 This changes `applyFilters` from Text.Pandoc.Filter so
939 that it does a left fold rather than a right fold, applying
940 the filters in the order listed.
942 * Text.Pandoc.XML:
944 + Change `toEntities` to emit numerical hex character references
945 (#5718).
947 * Text.Pandoc.Highlighting:
949 + Add additional listings languages (Wandmalfarbe).
951 * Text.Pandoc.MediaBag:
953 + Some of the types using Strings were switched to use FilePath instead
954 (Christian Despres, #5884).
956 * Text.Pandoc.Templates:
958 + Don't import/export `varListToJSON` [API change]. It is removed in
959 doctemplates >= 0.3.
960 + Change type of `renderTemplate'` [API change]. Return value is
961 now Text rather than being polymorphic. This makes room for
962 upcoming removal of the `TemplateTarget` class from doctemplates.
964 * Text.Pandoc.App.Opt [API changes]:
966 + More convenient To/FromJSON instances. Make the field names
967 like `strip-empty-paragraphs` rather than `optStripEmptyParagraphs`.
968 Anyone who is using JSON serialization of Opt will need to adjust
969 things accordingly.
970 + Change `optHighlightStyle` to a `Maybe String` instead of
971 `Maybe Style`. Do the parsing/loading of themes later, after
972 option parsing.
973 + Remove `optBaseHeaderLevel` from `Opt`. We now just use
974 `optShiftHeadingLevelBy`, to avoid redundancy.
975 + Change `optShiftHeadingLevel` to `optShiftHeadingLevelBy` to
976 match the option.
977 + Custom FromJSON instance for `LineEnding`, so either `CRLF`
978 or `crlf` will work.
979 + Change `optVariables` from `[(String, String)]` to `Context Text`.
980 + Change `optMetadata` to `Meta`, to allow structured values.
981 The current behavior of the `--metadata` option stays the same.
982 + Rename `optReader`, `optWriter` as `optFrom`, `optTo`.
983 + Add `FromYAML` instances to `Opt` and to all subsidiary types.
984 + Rename `optMetadataFile` to `optMetadataFiles`.
985 + Rename `optPDFEngineArgs` to `optPDFEngineOpts`.
986 + Rename `optWrapText` to `optWrap`.
987 + Add `IpynbOutput` enumerated type: use this instead of
988 a string for `optIpynbOutput`.
989 + Change optInputFiles to a `Maybe [FilePath]` (#5888) [API change].
990 `Nothing` means: nothing specified.
991 `Just []` means: an empty list specified (e.g. in defaults).
992 + List fields in Opt so they aren't reversed (#5881) [API change].
993 Previously `optIncludeInHeader`, etc. were in reverse order.
994 + The `sourcefile` variable is now always a list. It used to be
995 sometimes a string, sometimes a list (when there was more than one).
997 * Template changes:
999 + default.latex: added code for `cslreferences` environment,
1000 to be used for pandoc-citeproc references. A `csl-hanging-indent`
1001 variable (set automatically if there is a `hanging-ident`
1002 class on the references Div) controls whether contents of this
1003 environment receive a hanging indent.
1004 + default.latex: Add `space` as default option for xeCJK, so that
1005 spaces between words are preserved (#5855, jeongminkim-islab).
1006 This is necessary for Korean.
1007 + default.latex: Remove include of `grffile` (#5848).
1008 This package used to be needed for proper handling of image filenames
1009 containing periods (in addition to the period before the extension).
1010 It no longer works with the latest LaTeX kernel and graphicx,
1011 so we have removed it. Future versions of graphicx will handle
1012 these filenames without the need for `grffile`.
1013 + default.context: add a saner default for page numbers.
1014 Previously they appeared centered at the top of the page;
1015 now we put them centered at the bottom, unless the `pagenumbering`
1016 variable is set.
1017 + default.context: define a start-stop-pair `cslreferences` to
1018 allow for hanging indents in the bibliography (#5875, Denis Maier).
1019 + default.ms: update defaults. Use Palatino font, use slightly
1020 wider interparagraph space, don't indent paragraphs,
1021 and put page numbers on the bottom. This brings ms output
1022 closer to default LaTeX output.
1023 + default.revealjs: add navigationMode (Mauro Bieg, #5657).
1024 + default.muse: handle multiple authors better.
1025 + docbook4, docbook5 templates: add indentation to body.
1026 + HTML-based templates: use `styles.html` partial to avoid
1027 code duplication.
1028 + HTML-based templates: change indentation of styles in template.
1030 * reference.docx (#5820):
1032 + Change Block Text (block quote) style so that the same font
1033 is used as in the body text, and the block text is indented
1034 left and right.
1035 + All headings now have a uniform color.
1036 + Level-1 headings no longer set `w:themeShade="B5"`.
1037 + Level-2 headings are now 14 point rather than 16 point.
1038 + Level-3 headings are now 12 point rather than 14 point.
1039 + Level-4 headings are italic rather than bold.
1041 * epub.css: Add CSS for hanging-indent div to support pandoc-citeproc's
1042 new hanging indents.
1044 * pandoc.cabal:
1046 + Repeat ghc-options in all stanzas.
1047 + Remove conditionals for ghc < 8 (Albert Krewinkel, #5693).
1048 + Compile with `-Wcpp-undef` and `-fhide-source-paths` when possible
1049 (Albert Krewinkel).
1050 + Add cabal.project to extra-source-files (Albert Krewinkel).
1051 + Add dependency on skylighting-core (#5729). Even though it shouldn't
1052 be needed, some tools require it.
1053 + Require latest pandoc-types, texmath, skylighting, haddock-library.
1054 + Ensure TemplateHaskell is added to other-extensions when it is
1055 used (Vanessa McHale, #5728).
1056 + Remove `derive_json_via_th` flag; always use TH. This cuts down
1057 on code duplication and reduces the chance for errors. See #4083.
1059 * Makefile:
1061 + Add ghci target.
1062 + Add ghcid target.
1063 + Remove references to obsolete flag (#5694).
1065 * Benchmarks: fix failure on ipynb.
1067 * Use MathJax 3 (zorkow).
1069 * KaTeX math: respect `classoption=fleqn` variable,
1070 bump KaTeX version to 0.11.1 (#5815, Mauro Bieg).
1072 * Fix redundant constraint compiler warnings (Pete Ryland, #5625).
1074 * Use throwError instead of fail when appropriate.
1076 * Use Prelude.fail to avoid ambiguity with fail from GHC.Base.
1078 * Add `diff-zip.sh` to tools (John MacFarlane, Agustín Martín Barbero).
1079 This is intended to make it easier to test differences in zip
1080 containers, like epub, docx, or odt.
1082 * Add `.gitattributes` (#5747). This ensures that the golden files
1083 in `test/fb2/reader/` don't have newlines converted. This should fix
1084 a test failure on GitHub CI with Windows.
1086 * Reorder options in `--help`.
1088 * Revise code for HsYAML-0.2.0.0 (@vijayphoenix, #5704).
1090 * Remove blank line in code example in Haddocks (Leif Metcalf, #5679).
1092 * Fix trypandoc with `getReader`/`getWriter` changes.
1094 * Allow building pandoc with GHC 8.8.
1096 * linux tarball: add architecture `-amd64` to filename.
1097 Now it will be: `pandoc-VERSION-linux-ARCH.tar.gz`.
1099 * MANUAL.txt:
1101 + Add section for exit codes.
1102 + Document some pptx limitations in slide show section:
1103 No incremental display (#5689). No pause with `. . .` (#5701).
1104 + reveal.js flags (Mauro Bieg, #5653).
1105 + Document addition of `data-` prefix to unknown attributes in HTML5.
1106 + Link to YAML spec (Mauro Bieg, #5687).
1107 + Fix capitalization of "Linux" (#5859, Marcus Stollsteimer).
1108 + Use a table for exit codes.
1109 + Put all template variable docs into one section.
1110 + Use ATX headers consistently.
1111 + Add fuller documentation of templates (#5779), including
1112 new template syntax, partials, etc.
1113 + Add documentation for the variable `hyperrefoptions` (Wandmalfarbe).
1114 + Clarify when macro definitions are passed as raw latex.
1115 In Markdown input, they are always passed through. In LaTeX, only if
1116 `latex_macros` is disabled.
1117 + Clarify that `--dpi` provides a default and doesn't override
1118 dpi values specified in the images themselves (#5721).
1119 + Document how to use custom writers with `--standalone` (#5866).
1120 + Clarify `--preserve-tabs` default.
1122 * INSTALL.md:
1124 + Fix instructions for libicu.
1125 + Add Void Linux instructions (Volodymyr Kozachnyskyi).
1127 * CONTRIBUTING.md:
1129 + Add information on tests (Agustín Martín Barbero, #5652).
1130 + Add information about command test naming to CONTRIBUTING (Florian B).
1132 * Fix typos in changelog and comments (#5896, Brian Wignall).
1134 * doc/lua-filters.md:
1136 + Fix mistakes in mediabag module docs (#5851, Albert Krewinkel).
1137 + Improve metadata replacement example in lua-filters doc (#5851).
1138 + Mention which Lua version is shipped with pandoc (Albert Krewinkel,
1139 #5892).
1141## pandoc 2.7.3 (2019-06-11)
1143 * Add `jira` (Atlassian's Jira wiki markup) as output format (#2497,
1144 Albert Krewinkel).
1146 * Add `tex_math_dollars` to `multimarkdownExtensions` (#5512).
1147 This form is now supported in multimarkdown,
1148 in addition to `tex_math_double_backslash`.
1150 * Fix `--self-contained` so it works when output format has extensions.
1151 Previously if you used `--self-contained` with `html-smart` or
1152 `html+smart`, it wouldn't work.
1154 * Add template variable `curdir` with working directory
1155 from which pandoc is run (#5464).
1157 * Markdown reader: don't create implicit reference for empty header
1158 (#5549).
1160 * Muse reader: allow images inside link descriptions (Alexander Krotov).
1162 * HTML reader: epub related fixes.
1164 + With epub extensions, check for `epub:type` in addition to `type`.
1165 + Fix problem with noteref parsing which caused block-level
1166 content to be eaten with the noteref.
1167 + Rename `pAnyTag` to `pAny`.
1168 + Refactor note resolution.
1169 + Trim definition list terms (Alexander Krotov).
1171 * LaTeX reader:
1173 + Add braces when resolving `\DeclareMathOperator`
1174 (#5441). These seem to be needed for xelatex but not pdflatex.
1175 + Allow newlines in `\mintinline`.
1176 + Pass through unknown listings language as class (#5540).
1177 Previously if the language was not in the list of languages supported
1178 by listings, it would not be added as a class, so highlighting
1179 would not be triggered.
1180 + `rawLaTeXInline`: Include trailing `{}`s in raw latex commands (#5439).
1181 This change affects the markdown reader and other readers that allow raw
1182 LaTeX. Previously, trailing `{}` would be included for unknown
1183 commands, but not for known commands. However, they are sometimes used
1184 to avoid a trailing space after the command. The chances that a `{}`
1185 after a LaTeX command is not part of the command are very small.
1187 * MediaWiki reader: handle multiple attributes in table row (#5471,
1188 chinapedia).
1190 * Docx reader: Add support for `w:rtl` (#5545). Elements with this
1191 property are put into Span inlines with `dir="rtl"`.
1193 * DocBook reader: Issue `IgnoredElement` warnings.
1195 * Org reader (Albert Krewinkel):
1197 + Fix planning elements in headers level 3 and higher
1198 (#5494). Planning info is now always placed before
1199 the subtree contents. Previously, the planning info was placed after
1200 the content if the header's subtree was converted to a list, which
1201 happens with headers of level 3 and higher per default.
1202 + Omit, but warn about unknown export options. Unknown export
1203 options are properly ignored and omitted from the output.
1204 + Prefer plain symbols over math symbols (#5483).
1205 Symbols like `\alpha` are output plain and unemphasized, not as math.
1206 + Recognize emphasis after TODO/DONE keyword (#5484).
1208 * FB2 reader:
1210 + Skip unknown elements rather than throwing errors (#5560).
1211 Sometimes custom elements are used (e.g. `id` element
1212 inside `author`); previously the reader would halt with an error.
1213 Now it skips the element and issues an `IgnoredElement` warning.
1214 + Parse notes (#5493, Alexander Krotov).
1215 + Internal improvements (Alexander Krotov).
1217 * OpenDocument writer: Roll back automatic figure/table numbering
1218 (#5474). This was added in pandoc 2.7.2, but it makes it impossible
1219 to use pandoc-crossref. So this has been rolled back for now,
1220 until we find a good solution to make this behavior optional
1221 (or a creative way to let pandoc-crossref and this feature
1222 to coexist).
1224 * New module Text.Pandoc.Writers.Jira, exporting `writeJira` [API
1225 change] (Albert Krewinkel).
1227 * EPUB writer:
1229 + Don't include 'landmarks' if there aren't any.
1230 Previously we could get an empty ol element, which caused
1231 validation errors with epubcheck.
1232 + Ensure unique ids for styleesheets in content.opf (#5463).
1233 + Make stylesheet link compatible with kindlegen (#5466,
1234 Eric Schrijver). Pandoc omitted `type="text/css"` from both
1235 `<style>` and `<rel="stylesheet">` elements in all templates, which
1236 is valid according to the spec. However, Amazon’s kindlegen software
1237 relies on this attribute on `<link>` elements when detecting
1238 stylesheets to include.
1240 * HTML writer:
1242 + Output video and audio elements depending on file
1243 extension of the image path (Mauro Bieg).
1244 + Emit empty alt tag in figures (#5518, Mauro Bieg).
1245 The same text is already in the <figcaption> and
1246 screen-readers would read it twice, see #4737.
1247 + Don't add variation selector if it's already there.
1248 This fixes round-trip failures.
1249 + Prevent gratuitous emojification on iOS (#5469).
1250 iOS chooses to render a number of Unicode entities, including '↩', as
1251 big colorful emoji. This can be defeated by appending Unicode
1252 VARIATION SELECTOR-15'/'VARIATION SELECTOR-16'. So we now append this
1253 character when escaping strings, for both '↩' and '↔'. If other
1254 characters prove problematic, they can simply be added to
1255 `needsVariationSelector`. + Add `class="heading"` to level 7+ Headers
1256 rendered as `<p>` elements (#5457).
1258 * RST writer: treat Span with no attributes as transparent (#5446).
1259 Previously an Emph inside a Span was being treated as
1260 nested markup and ignored. With this patch, the Span
1261 is just ignored.
1263 * LaTeX writer:
1265 + Include inline code attributes with `--listings` (#5420).
1266 + Don't produce columns environment unless beamer (#5485).
1267 + Fix footnote in image caption. Regression: the fix for #4683 broke
1268 this case.
1269 + Don't highlight code in headings (#5574). This causes
1270 compilation errors.
1271 + Use `\mbox` to get proper behavior inside `\sout` (#5529).
1273 * EPUB writer: Fix document section assignments (#5546).
1274 For example, introduction should go in bodymatter, not frontmatter, and
1275 epigraph, conclusion, and afterward should go in bodymatter, not
1276 backmatter. For the full list of assignments, see the manual.
1278 * Markdown writer:
1280 + Add backslashes to avoid unwanted interpretation of
1281 definition list terms as other kinds of block (#554).
1282 + Ensure the code fence is long enough (#5519).
1283 Previously too few backticks were used when the code block
1284 contained an indented line of backticks. (Ditto tildes.)
1285 + Handle labels with integer names (Jesse Rosenthal, #5495).
1286 Previously if labels had integer names, it could produce a conflict
1287 with auto-labeled reference links. Now we test for a conflict and
1288 find the next available integer. This involves adding a new state
1289 variable `stPrevRefs` to keep track of refs used in other document
1290 parts when using `--reference-location=block|section`
1292 * Textile writer: fix closing tag for math output (Albert Krewinkel).
1293 Opening and closing tag for math output match now.
1295 * Org writer: always indent src blocks content by 2 spaces (#5440, Albert
1296 Krewinkel). Emacs always uses two spaces when indenting the content of
1297 src blocks, e.g., when exiting a `C-c '` edit-buffer. Pandoc used to
1298 indent contents by the space-equivalent of one tab, but now always uses
1299 two spaces, too.
1301 * Asciidoc writer:
1303 + Use `` `+...+` `` form for inline code.
1304 The old `` `a__b__c` `` yields emphasis inside code in asciidoc.
1305 To get a pure literal code span, use `` `+a__b__c+` ``.
1306 + Use proper smart quotes with asciidoctor (#5487).
1307 Asciidoctor has a different format for smart quotes.
1308 + Use doubled ## when necessary for spans (#5566).
1309 + Ensure correct nesting of strong/emph (#5565): strong
1310 must be the outer element.
1312 * JATS writer:
1314 + Wrap elements with p when needed (#5570). The JATS spec restricts
1315 what elements can go inside `fn` and `list-item`. So we wrap other
1316 elements inside `<p specific-use="wrapper">` when needed.
1317 + Properly handle footnotes (#5511) according to "best practice."
1318 (Group them at the end in `<fn-group>` and use `<xref>` elements
1319 to link them.)
1320 + Fix citations with PMID so they validate (#5481). This includes
1321 an update to data/jats.csl.
1322 + Ensure validity of `<pub-date>` by parsing the date and
1323 extracting year, month, and day, as expected. Also add an
1324 iso-8601-date attribute automatically.
1325 + Don't use `<break>` element for LineBreak. It is only
1326 allowed in a few special contexts, and not in `<p>` elements.
1327 + Don't make `<string-name>` a child of `<string>`, which is illegal.
1329 * FB2 writer:
1331 + Do not wrap note references into `<sup>` and brackets
1332 (Alexander Krotov). Existing FB2 readers, such as FBReader, already
1333 display links with type="note" as a superscript.
1334 + Use genre metadata field (#5478).
1336 * Muse writer: do not escape empty line after `<br>` (Alexander Krotov).
1338 * Add unicode code point in "Missing character" warning (#5538).
1339 If the character isn't in the console font, the message is pretty useless,
1340 so we show the code point for anything non-ASCII.
1342 * Lua: add Version type to simplify comparisons (Albert Krewinkel).
1343 Version specifiers like `PANDOC_VERSION` and `PANDOC_API_VERSION` are
1344 turned into `Version` objects. The objects simplify version-appropriate
1345 comparisons while maintaining backward-compatibility.
1346 A function `pandoc.types.Version` is added as part of the newly
1347 introduced module `pandoc.types`, allowing users to create version
1348 objects in scripts.
1350 * pandoc lua module (Albert Krewinkel):
1352 - Fix deletion of nonexistent attributes (#5569).
1353 - Better tests for Attr and AttributeList.
1355 * pandoc.mediabag lua module (Albert Krewinkel):
1357 + Add function `delete` for deleting a single item.
1358 + Add function `empty` for removing all entries.
1359 + Add function `items` for iterating over mediabag.
1361 * Text.Pandoc.Class: Fix handling of `file:` URL scheme in
1362 `downloadOrRead` (#5517, Mauro Bieg). Previously `file:/`
1363 URLs were handled wrongly and pandoc attempted to make HTTP
1364 requests, which failed.
1366 * Text.Pandoc.MIME: add `mediaCategory` [API change] (Mauro Bieg).
1368 * Text.Pandoc.Shared:
1370 + Add `onlySimpleTableCells` [API change]
1371 (Mauro Bieg) and use this to consolidate simple-table detection
1372 (#5524). This fixes an inconsistency in the HTML reader, which did not
1373 treat tables with `<p>` inside cells as simple.
1374 + `metaToJSON`: treat digits starting with 0 as a string, not a number
1375 (#5479). This fixes a regression in YAML metadata in pandoc 2.7.2.
1377 * Text.Pandoc.Logging: Add `IgnoredElement` constructor for
1378 `LogMessage`. `SkippedConetnt` doesn't work for some XML-based
1379 readers which don't have access to parsec source positions.
1381 * Text.Pandoc.Asciify: Add Turkish undotted-i (#5433, Mauro Bieg).
1383 * Improve output of Lua tests (#5499, Albert Krewinkel).
1384 This makes use of tasty-lua, a package to write tests in Lua
1385 and integrate the results into Tasty output. Test output becomes
1386 more informative: individual tests and test groups become visible
1387 in test output. Failures are reported with helpful error messages.
1389 * Lua: add `pandoc.system` module (#5468, Albert Krewinkel).
1390 The `system` Lua module provides utility functions to interact with the
1391 operating- and file system. E.g.
1392 `print(pandoc.system.get_current_directory())`
1393 or
1394 ```lua
1395 pandoc.system.with_temporary_directory('tikz', function (dir)
1396 -- write and compile a TikZ file with pdflatex
1397 end)
1398 ```
1400 * LaTeX template: Add pdflang to hypersetup if lang is set (#5443).
1402 * beamer template: Fix using Beamer with geometry (#5505, Daniel Maslowski).
1403 Beamer already loads geometry, so we need to use the `\geometry`
1404 command to set geometry options.
1406 * EPUB2/3 templates: Move inline styles to default epub.css (#5466).
1407 NOTE: Those who use a custom CSS stylesheet with EPUB should
1408 add these lines:
1410 code{ white-space: pre-wrap; }
1411 span.smallcaps{ font-variant: small-caps; }
1412 span.underline{ text-decoration: underline; }
1413 q { quotes: "“" "”" "‘" "’"; }
1414 div.column{ display: inline-block; vertical-align: top; width: 50%; }
1416 * reveal.js template:
1418 + Updates for revealjs 3.8.0 (#5435, ebiim).
1419 + Remove reference to head.min.js (#5448, Winnie Hellmann).
1420 NOTE: users will need to update reveal.js to at least 3.8.0
1421 for their presentations generated with this version of pandoc
1422 to work correctly.
1424 * Text.Pandoc.PDF:
1426 + Replace `</>` with literal `/` (#5451).
1427 We use forward-slash for a directory separator in tmpDir,
1428 even on Windows (because that's what tex likes). So we
1429 should not put a backslash between the tmpDir and the
1430 filename on Windows. This is harmless enough in normal
1431 Windows setups, but it breaks on Cygwin.
1432 Thanks to @cc2x for noticing and diagnosing the problem.
1433 + Allow use of `-output-directory` in `--pdf-engine-opt` (#5462).
1434 This is currently possible with `mklatex` and `-outdir`, but
1435 was not yet possible with xelatex and `-output-directory`.
1436 + For PDF via ms/pdfroff, make TOC appear at beginning and in
1437 PDF bookmarks (#5553). Previously the TOC appeared at the end
1438 of the document, and was not bookmarked. To keep it at the end,
1439 add `--pdf-engine-opt=--no-toc-relocation` to your command line.
1441 * Fix broken links in documents (#5473, Shim Myeongseob).
1442 Also, use absolute links to pandoc.org when possible, so that
1443 the links can be followed by people viewing these documents
1444 on GitHub.
1446 * Improved sample lua tikz filter in lua-filters docs (#5445,
1447 Matthew Doty). There are three changes:
1449 + It only processes elements which begin with `\begin{tikzpicture}`
1450 + It uses pdf2svg instead of imagemagick to preserve fidelity
1451 + The images produced have transparent backgrounds
1453 * MANUAL.txt:
1455 + Add note about `title-meta`, `author-meta`, `date-meta` (#5486).
1456 + Fix typo (#5489, Christian Krause).
1458 * add test/tables.xwiki to git and pandoc.cabal (#5498, Mauro Bieg).
1460 * Disable missing-home-modules warning in `stack.yaml`.
1461 Otherwise `stack ghci` fails.
1464## pandoc 2.7.2 (2019-04-05)
1466 * Add XWiki writer (#1800, Derek Chen-Becker).
1467 Add `Text.Pandoc.Writers.XWiki`, exporting `writeXWiki` [API change].
1469 * Dokuwiki Reader: parse single curly brace (#5416, Mauro Bieg).
1471 * Vimwiki reader: improve handling of internal links (#5414).
1472 We no longer append `.html` to link targets, and we add a title
1473 `wikilink`. This mirrors behavior of other wiki readers. Generally
1474 the `.html` extension is not wanted. It may be important for output
1475 to HTML in certain circumstances, but it can always be added using a
1476 filter that matches on links with title `wikilink`.
1478 If your workflow requires the current behavior, here is a lua filter
1479 that will add the `.html` extension:
1481 ```lua
1482 function Link(el)
1483 if el.title == 'wikilink' then
1484 el.target = el.target .. ".html"
1485 end
1486 return el
1487 end
1488 ```
1489 * ipynb reader:
1491 + Use format `ipynb` for raw cell where no format given.
1492 + Avoid introducing spurious `.0` on integers in metadata.
1494 * Markdown reader: fenced div takes priority over setext header.
1496 * HTML reader: read `data-foo` attribute into `foo` (#5392).
1497 The HTML writer adds the `data-` prefix for HTML5 for nonstandard
1498 attributes. But the attributes are represented in the AST without
1499 the `data-` prefix, so we should strip this when reading HTML.
1501 * LaTeX reader: Improve autolink detection (#5340).
1503 * PowerPoint writer (Jesse Rosenthal):
1505 + Expand builtin reference doc to model all layouts.
1506 The previous built-in reference doc had only title and content
1507 layouts. Add in a section-header slide and a two-content slide, so
1508 users can more easily modify it to build their own templates.
1509 + Always open up in slide view. When editing a
1510 template/reference-doc, the user might be in Master view, but when
1511 producing a slide show, it is assumed that slide view will be
1512 desired.
1513 + Remove `handoutsMasterList` from template presentation.xml
1514 + Fix numerous errors in templating (#5402). Previously, some templates
1515 produced by Office 365 (MacOS) would not render with `--reference-doc`
1516 correctly. We now apply correct shapes for content, and build
1517 shape trees correctly.
1518 + Make default placeholder type for template lookup.
1519 + Apply speaker notes to metadata slide if applicable.
1520 + Test for speaker notes after breaking header.
1521 + Correctly handle notes after section-title header.
1522 Previously, if notes came after a section-title header (ie, a level-1
1523 header in a slide-level=2 presentation), they would go on the next
1524 slide. This keeps them on the slide with the header.
1525 + Internal improvements.
1527 * ipynb writer:
1529 + Use format `ipynb` for raw cell where no format given.
1530 According to nbformat docs, this is supposed to render in every
1531 format. We don't do that, but we at least preserve it as a raw
1532 block in markdown, so you can round-trip.
1533 + Consolidate adjacent raw blocks. Sometimes pandoc creates two
1534 HTML blocks, e.g. one for the open tag and one for a close tag.
1535 If these aren't consolidated, only one will show up in output cell.
1536 + Fixed carry-over of nbformat from metadata.
1537 + Preserve `nbformat_minor` if it's given. This helps with round-tripping.
1539 * LaTeX writer:
1541 + Avoid inadvertently creating ?` or !` ligatures (#5407).
1542 These are upside down ? and !, resp.
1543 + Fix footnotes in table caption and cells (#5367). This fixes a
1544 bug wherein footnotes appeared in the wrong order, and with
1545 duplicate numbers, when in table captions and cells.
1546 We now use regular `\footnote` commands, even in the table
1547 caption and the minipages containing cells. Apparently
1548 longtable knows how to handle this.
1550 * HTML writer: Don't add data- prefix to RDFa attributes (#5403).
1552 * JATS writer: Ensure that plain strings go inside `<pub-id>` tag (#5397).
1554 * Markdown writer:
1556 + Better rendering of numbers (#5398). If the number is integral,
1557 we render it as an integral not a float.
1558 + Proper rendering of empty map in YAML metadata (#5398). Should
1559 be `{}`, not empty string.
1560 + Properly escape attributes in Markdown writer (#5369).
1561 + Be sure implicit figures work in list contexts (#5368).
1562 Previously they would sometimes not work: e.g., when they
1563 occurred in final paragraphs in lists that were originally
1564 parsed as Plain and converted later using PlainToPara.
1566 * Docx writer: Use `w:br` without attributes for line breaks (#5377).
1567 We previously added the attribute `type="textWrapping"`, but
1568 this causes problems on Word Online.
1570 * LaTeX template (Andrew Dunning):
1572 + Ensure correct heading/table order (#5365). Improve workaround
1573 (#1658) for tables following headings. The new solution works whether
1574 or not the `indent` variable is enabled.
1575 + Remove `subparagraph` variable. The default is now to use run-in
1576 style for level 4 and 5 headings (`\paragraph` and `\subparagraph`).
1577 To get the previous default behavior (where these were formatted as
1578 blocks, like `\subsubsection`), set the `block-headings` variable.
1579 + Add pandoc to PDF metadata (#5388).
1580 + Group graphics-related code (#5389).
1581 + Move `\setstretch` after front matter (#5179). Ensures that
1582 `\maketitle`, `\tableofcontents`, and so forth are not affected by
1583 changes to line spacing.
1585 * Update data/jats.csl to avoid commas between name-part elements
1586 (#5397).
1588 * Add support for golang (`go`) with `--listings` (#5427).
1590 * Text.Pandoc.Shared - improve `metaToJSON` behavior with numbers.
1591 We now do a better job marshalling numbers from MetaString
1592 or MetaInlines into JSON Number.
1594 * Text.Pandoc.Writers.Shared: `metaValueToJSON`: use Number Values for
1595 integers. Pandoc's MetaValue doesn't have a distinguished number type,
1596 so numbers are put in MetaStrings. If the MetaString consists
1597 entirely of digits, we convert it to a Number. We should probably
1598 consider adding a MetaNumber constructor to MetaValue, for better
1599 round-tripping with JSON etc. This change aids round-tripping in
1600 ipynb metadata fields, like `toc_depth`.
1602 * Text.Pandoc.Class: `fetchItem`: don't treat UNC paths as
1603 protocol-relative URLs (#5127). These are paths beginning `//?/UNC/...`.
1605 * Text.Pandoc.ImageSize: Improve `pdfSize` so it handles
1606 a wider range of PDFs (#4322, with help from Richard Davis).
1608 * Text.Pandoc.Pretty: avoid stack overflow by using strict sum (#5401).
1610 * Fix harmless error in file-scope code (#5422).
1612 * MANUAL.txt:
1614 + Improve 'header' and 'heading' usage (#5423, Andrew
1615 Dunning). The term 'header' was being used where 'heading'
1616 is more appropriate.
1617 + Add paragraph on options affecting markdown in ipynb.
1619 * stack.yaml - remove -Wmissing-home-modules
1620 This seems to cause problems with stack ghci. Remove RTS options.
1622 * Add ghc-options to cabal.project.
1624 * appveyor.yml - use ghc 8.6.4. Fixes segfault issues on Windows (#5037).
1626 * linux build process: Remove clone of pandoc-citeproc (#5366).
1627 It wasn't being used; cabal.project specifies the version to use.
1629## pandoc 2.7.1 (2019-03-14)
1631 * Add tectonic as an option for --pdf-engine (#5345, Cormac Relf).
1632 Runs tectonic on STDIN instead of a temporary .tex file, so that it
1633 looks in the working directory for `\include` and `\input` like the rest
1634 of the engines. Allows overriding the output directory
1635 args with `--pdf-engine-opt=--outdir --pdf-engine-opt="$DIR"`.
1637 * Allow `-o/--output` to be used with `--print-default-data-file`,
1638 `--print-highlighting-style`, `--print-default-template`.
1639 Note that `-o` must occur BEFORE the `--print*` command on the command
1640 line (this is documented, #5357).
1642 * LaTeX reader:
1644 + Support `\underline`, `\ul`, `\uline` (#5359, Paul
1645 Tilley). These are parsed as a Span with class `underline`, as
1646 with other readers.
1647 + Ensure that `\Footcite` and `\Footcites` get put in a note.
1649 * ipynb reader:
1651 + Remove sensitivity to `raw_html`, `raw_tex` extensions.
1652 We now include every output format. Pruning is handled by
1653 `--ipynb-output`.
1654 + Better handling of cell metadata. We now include even complex cell
1655 metadata in the Div's attributes (as JSON, in complex cases, or
1656 as plain strings in simple cases).
1658 * ipynb writer:
1660 + Recurse into native divs for output cell data (#5354).
1661 + Render cell metadata fields from div attributes.
1663 * Docx writer: avoid extra copy of abstractNum and num elements
1664 in numbering.xml. This caused pandoc-produced docx files to
1665 be uneditable using Word Online (#5358).
1667 * Markdown writer: improve handling of raw blocks/inline.
1668 We now emit raw content using `raw_attribute` when no more
1669 direct method is available. Use of `raw_attribute` can be
1670 forced by disabling `raw_html` and `raw_tex`.
1672 * LaTeX writer: Add classes for frontmatter support (#5353, Andrew Dunning)
1673 and remove frontmatter from `scrreprt`.
1675 * LaTeX template:
1677 + Improve readability (#5363, Andrew Dunning).
1678 + Robust section numbering removal (#5351, Andrew Dunning).
1679 Ensures that section numbering does not reappear with custom
1680 section levels. See <https://tex.stackexchange.com/questions/473653/>.
1681 + Better handling of front/main/backmatter (#5348).
1682 In pandoc 2.7 we assumed that every class with chapters would accept
1683 `\frontmatter`, `\mainmatter`, and `\backmatter`. This is not so (e.g.
1684 report does not). So pandoc 2.7 breaks on report class by including an
1685 unsupported command. Instead of the `book-class` variable, we use two
1686 variables, `has-chapters` and `has-frontmatter`, and set these
1687 intelligently in the writer.
1689 * Text.Pandoc.Shared: Improve `filterIpynbOutput`. Ensure that
1690 images are prioritized over text. `best` should include everything
1691 for ipynb.
1693 * Tests.Old: specify `--data-dir=../data` to ensure tests can find
1694 data files even if they haven't been installed. Remove old
1695 `pandoc_datadir` environment variable, which hasn't done anything for a
1696 long time.
1698 * MANUAL.txt: Add recommendation to use `raw_attribute` with ipynb (#5354).
1700 * Use cmark-gfm-hs 0.1.8 (note that 0.1.7 is buggy).
1702 * Use latest pandoc-citeproc, texmath.
1705## pandoc 2.7 (2019-03-03)
1707 * Use XDG data directory for user data directory (#3582). Instead of
1708 `$HOME/.pandoc`, the default user data directory is now
1709 `$XDG_DATA_HOME/pandoc`, where `XDG_DATA_HOME` defaults to
1710 `$HOME/.local/share` but can be overridden by setting the
1711 environment variable. If this directory is missing, then
1712 `$HOME/.pandoc` is searched instead, for backwards compatibility.
1713 However, we recommend moving local pandoc data files from
1714 `$HOME/.pandoc` to `$HOME/.local/share/pandoc`. On Windows the
1715 default user data directory remains the same.
1717 * Slide show formats behavior change: content under headers
1718 less than slide level is no longer ignored, but included in
1719 the title slide (for HTML slide shows) or in a slide after
1720 the title slide (for beamer). This change makes possible
1721 2D reveal.js slideshows with content in the top slide on
1722 each stack (#4317, #5237).
1724 * Add command line option `--ipynb-output=all|none|best` (#5339).
1725 Output cells in ipynb notebooks often contain several different
1726 versions of an output, with different MIME types, e.g. an HTML
1727 table and a plain-text fallback. Specifying `--ipynb-output=best`
1728 (the default) ensures that the best version for the output format
1729 is used. `all` includes all versions, and `none` suppresses them
1730 all, leaving output cells empty.
1732 * `asciidoctor` is now an output format separate from `asciidoc`,
1733 to accommodate some minor implementation-specific differences
1734 (currently just in the treatment of display math).
1736 * Add `latexmk` as an option for `--pdf-engine` (#3195).
1737 Note that you can use `--pdf-engine-opt=-outdir=bar` to specify
1738 a persistent temp directory.
1740 * Markdown reader:
1742 + Improve tight/loose list handling (#5285). Previously the
1743 algorithm allowed list items with a mix of Para and Plain, which
1744 is never wanted.
1745 + Add newline when parsing blocks in YAML (#5271). Otherwise last
1746 block gets parsed as a Plain rather than a Para. This is a
1747 regression in pandoc 2.x. This patch restores pandoc 1.19
1748 behavior.
1749 + Make `yamlToMeta` respect extensions (#5272, Mauro Bieg).
1750 This adds a `ReaderOptions` parameter to `yamlToMeta` [API change].
1751 + Fix bug parsing fenced code blocks (#5304). Previously parsing
1752 would break if the code block contained a string of backticks of
1753 sufficient length followed by something other than end of line.
1755 * LaTeX reader: don't let `\egroup` match `{`. `braced` now actually
1756 requires nested braces. Otherwise some legitimate command and
1757 environment definitions can break.
1759 * Docx reader (Jesse Rosenthal):
1761 + Rename `getDocumentPath` as `getDocumentXmlPath`.
1762 + Use field notation for setting `ReaderEnv`.
1763 + Figure out `document.xml` path once at the beginning of parsing, and
1764 add it to the environment, so we can avoid repeated lookups.
1765 + Dynamically determine main document xml path (#5277).
1766 The desktop Word program places the main document file in
1767 `word/document.xml`, but the online word places it in
1768 `word/document2.xml`. This file path is actually stated in the root
1769 `_rels/.rels` file, in the `Relationship` element with an
1770 `http://../officedocument` type.
1771 + Fix paths in archive to prevent Windows failure (#5277).
1772 Some paths in archives are absolute (have an opening slash) which, for
1773 reasons unknown, produces a failure in the test suite on MS
1774 Windows. This fixes that by removing the leading slash if it exists.
1775 + Add comments to aid code readability.
1776 + Trim space inside the last inline (#5273).
1777 + Unwrap sdt elements in footnotes and comments (#5302).
1779 * Muse reader (Alexander Krotov):
1781 + Test that block level markup does not break `<verbatim>`.
1782 + Add secondary note support.
1784 * ipynb reader: handle images referring to attachments. Previously
1785 we didn't strip off the attachment: prefix, so even though the
1786 attachment was available in the mediabag, pandoc couldn't find it.
1788 * JATS reader:
1790 + Fix parsing of figures (#5321). This ensures that a figure
1791 containing a single image is parsed as a pandoc "implicit
1792 figure" (i.e., a Para with a single Image whose title attribute
1793 begins with `fig:`). More complex figures will still be parsed
1794 as divs.
1795 + Support `fig-group` block element (#5317).
1796 + Handle citations with multiple references (#5310). The `rid`
1797 attribute can have a space-separated list of ids.
1799 * AsciiDoc Writer: Add `writeAsciiDoctor` [API change, Tarik Graba].
1800 Handle display math appropriately for Asciidoctor.
1802 * JATS writer: wrap figure caption in `<p>` to fix validation (#5290,
1803 Mauro Bieg).
1805 * HTML writer:
1807 + Implement WAI-ARIA roles for (end)notes, citations, and
1808 bibliography (#4213). Note that doc-biblioref is only used when
1809 link-citations produces links, since it belongs on links.
1810 + Include content (including speaker notes) in title slides
1811 (#4317, #5237).
1813 * ipynb writer:
1815 + Ensure final newline.
1816 + Only include metadata under `jupyter` field.
1817 + Don't create attachments for images with absolute URIs,
1818 including data: URIs (#5303).
1819 + Keep plain text fallbacks in output even if a richer format is
1820 included (#5293). We don't know what output format will be needed.
1821 See the `--ipynb-output` command line option for a way to control
1822 what formats are included in the output.
1824 * Markdown writer: use `markdown="1"` when appropriate for Divs:
1825 when `native_divs` and `markdown_in_html_blocks` are disabled
1826 but `raw_html` and `markdown_attribute` are enabled.
1828 * LaTeX writer:
1830 + Use right fold for `escapeString`. This is more elegant than
1831 the explicit recursive code we were using.
1832 + Avoid `{}` after control sequences when escaping.
1833 `\ldots{}.` doesn't behave as well as `\ldots.` with the latex
1834 ellipsis package. This patch causes pandoc to avoid emitting
1835 the `{}` when it is not necessary. Now `\ldots` and other
1836 control sequences used in escaping will be followed by either
1837 a `{}`, a space, or nothing, depending on context.
1838 + For beamer, include contents under headers superordinate to
1839 slidelevel (#4317). Currently we keep the fancy title slide, and
1840 add a new slide with the same title and whatever content was
1841 under the header.
1843 * Powerpoint writer (Jesse Rosenthal): support underlines.
1844 Use span with single class "underline" as in docx writer.
1846 * Muse writer: escape secondary notes (Alexander Krotov).
1848 * FB2 writer: add section identifiers support (#5229, John KetzerX).
1850 * Make `--fail-if-warnings` work for PDF output (#5343).
1852 * Lua filters (Albert Krewinkel):
1854 + Load module `pandoc` before calling `init.lua` (#5287). The file
1855 `init.lua` in pandoc's data directory is run as part of pandoc's
1856 Lua initialization process. Previously, the `pandoc` module was
1857 loaded in `init.lua`, and the structure for marshaling was
1858 set up after. This allowed simple patching of element
1859 marshaling, but made using `init.lua` more difficult. Now, all
1860 required modules are now loaded before calling `init.lua`. The
1861 file can be used entirely for user customization. Patching
1862 marshaling functions, while discouraged, is still possible via
1863 the `debug` module.
1864 + All Lua modules bundled with pandoc, i.e., `pandoc.List`,
1865 `pandoc.mediabag`, `pandoc.utils`, and `text` are re-exported from the
1866 `pandoc` module. They are assigned to the fields `List`, `mediabag`,
1867 `utils`, and `text`, respectively.
1869 * Text.Pandoc.Lua (Albert Krewinkel):
1871 + Split `StackInstances` into smaller Marshaling modules.
1872 + Get `CommonState` from Lua global. This allows more control over
1873 the common state from within Lua scripts.
1875 * LaTeX template:
1877 + Support the `subject` metadata variable (#5289, Pascal Wagler).
1878 + Add `\frontmatter`, `\mainmatter`, `\backmatter`
1879 for book classes (#5306).
1881 * epub3 template: Add titlepage class to section (#5269).
1883 * HTML5 template: Add ARIA role `doc-toc` for table of contents (#4213).
1885 * Make `--metadata-file` use selected extensions (#5279, #5272, Mauro Bieg).
1887 * Text.Pandoc.Shared:
1889 + Remove `withTempDir` [API change].
1890 + Add new exported function `defaultUserDataDirs` [API change].
1891 + Add `filterIpynbOutput` [API change].
1892 + `compactify`: Avoid lists with a mix of Plain and Para elements
1893 (#5285).
1895 * Text.Pandoc.Translations: reorder alphabetically and remove `Author`
1896 (#5334, Mauro Bieg).
1898 * Text.Pandoc.Extensions:
1900 + More carefully groom ipynb default extensions.
1901 + Add `all_symbols_escapable` to `githubMarkdownExtensions`.
1903 * Text.Pandoc.PDF:
1905 + Use system temp directory when possible (#1192). Previously we
1906 created temp dirs in the working directory, partly (a) because
1907 there were problems using the system temp directory on Windows,
1908 when their pathnames included tildes, and partly (b) because
1909 programs like `epstopdf.pl` would not be allowed to write to
1910 directories outside the working directory in restricted mode. We
1911 now (a) use the system temp dir except when the path includes
1912 tildes, and (b) set `TEXMFOUTPUT` when creating the PDF, so that
1913 subsidiary programs can use the system temp directory. This
1914 addresses problems that occurred when pandoc was used in a
1915 synced directory (such as Dropbox).
1916 + Change types of subsidiary functions to PandocIO, to allow
1917 warnings to be threaded through (#5343).
1919 * Text.Pandoc.MIME: add WebP (#5267, Mauro Bieg).
1921 * Tests: avoid calling `findPandoc` multiple times.
1923 * Old tests: remove need for temp files by using `pipeProcess`.
1925 * Added simple ipynb reader/writer tests (#5274).
1927 * Rearrange `--help` output in a more rational way, with common
1928 options at the beginning and options grouped by function (#5336).
1930 * trypandoc: Add JATS and other missing formats (Arfon Smith, #5291).
1932 * Add missing copyright notices and remove license boilerplate (#4592,
1933 Albert Krewinkel).
1935 * Use latest basement/foundation on 32bit windows.
1937 * Use latest skylighting (#5328). Custom syntax definitions no
1938 longer try to load `language.dtd`.
1940 * Require texmath 0.11.2.1
1942 * Use latest pandoc-citeproc (0.16.1.1).
1944 * MANUAL.txt:
1946 + Clarify variable substitution indentation in templates (#5338,
1947 Agustín Martín Barbero).
1948 + Reorder custom-styles section (#5324, Mauro Bieg).
1950## pandoc 2.6 (2019-01-30)
1952 * Support ipynb (Jupyter notebook) as input and output format.
1954 + Add `ipynb` as input and output format (extension `.ipynb`).
1955 + Added Text.Pandoc.Readers.Ipynb [API change].
1956 + Added Text.Pandoc.Writers.Ipynb [API change].
1957 + Add `PandocIpynbDecodingError` constructor to Text.Pandoc.Error.Error
1958 [API change].
1959 + Depend on ipynb library.
1960 + Note: there is no template for ipynb.
1962 * Add DokuWiki reader (#1792, Alexander Krotov). This adds
1963 Text.Pandoc.Readers.DokuWiki [API change], and adds `dokuwiki`
1964 as an input format.
1966 * Implement task lists (#3051, Mauro Bieg). Added `task_lists`
1967 extension. Task lists are supported from markdown and gfm input.
1968 They should work, to some degree, in all output formats, though in
1969 most formats you'll get a bullet list with a unicode character for
1970 the box. In HTML, you get checkboxes and in LaTeX/PDF output, a
1971 box is used as the list marker. API changes:
1973 + Added constructor `Ext_task_lists` to `Extension`.
1974 + Added `taskListItemFromAscii` and `taskListItemToAscii` to
1975 Text.Pandoc.Shared.
1977 * Allow some command line options to take URL in addition to FILE.
1978 `--include-in-header`, `--include-before-body`, `--include-after-body`.
1980 * HTML reader:
1982 + Handle empty `start` attribute (see #5162).
1983 + Treat `textarea` as a verbatim environment (#5241) and preserve
1984 spacing.
1986 * RST reader:
1988 + Change treatment of `number-lines` directive (Brian Leung,
1989 #5207). Directives of this type without numeric inputs should
1990 not have a `startFrom` attribute; with a blank value, the
1991 writers can produce extra whitespace.
1992 + Removed superfluous `sourceCode` class on code blocks (#5047).
1993 + Handle `sourcecode` directive as synonynm for `code` (#5204).
1995 * Markdown reader:
1997 + Remove `sourceCode` class for literate Haskell code blocks
1998 (#5047). Reverse order of `literate` and `haskell` classes on
1999 code blocks when parsing literate Haskell, so `haskell` is
2000 first.
2001 + Treat `<textarea>` as a verbatim environment (#5241).
2003 * Org reader:
2005 + Handle `minlevel` option differently (#5190, Brian Leung).
2006 When `minlevel` exceeds the original minimum level observed in
2007 the file to be included, every heading should be shifted
2008 rightward.
2009 + Allow for case of `:minlevel == 0` (#5190).
2010 + Fix treatment of links to images (#5191, Albert Krewinkel).
2011 Links with descriptions which are pointing to images are no
2012 longer parsed as inline images, but as links.
2013 + Add support for #+SELECT_TAGS (Brian Leung).
2014 + Separate filtering logic from conversion function (Brian Leung).
2016 * TWiki reader: Fix performance issue with underscores (#3921).
2018 * MediaWiki reader: use `_` instead of `-` in auto-identifiers (#4731).
2019 We may not still be exactly matching mediawiki's algorithm.
2021 * LaTeX reader:
2023 + Remove `sourceCode` class for literate Haskell code blocks
2024 (#5047). Reverse order of `literate` and `haskell` classes on
2025 code blocks when parsing literate Haskell, so `haskell` is
2026 first.
2027 + Support `\DeclareMathOperator` (#5149).
2028 + Support `\inputminted` (#5103).
2029 + Support `\endinput` (#5233).
2030 + Allow includes with dots like `cc_by_4.0`. Previously the `.0`
2031 was interpreted as a file extension, leading pandoc not to add
2032 `.tex` (and thus not to find the file). The new behavior matches
2033 tex more closely.
2035 * Man reader:
2037 + Use `mapLeft` from Shared instead of defining own.
2039 * Docx reader (Jesse Rosenthal):
2041 + Handle level overrides (#5134).
2043 * Docx writer:
2045 + Support custom properties (#3024, #5252, Agustín Martín Barbero).
2046 Also supports additional core properties: `subject`, `lang`,
2047 `category`, `description`.
2048 + Make Level into a real type, instead of an alias for a tuple
2049 (Jesse Rosenthal).
2051 * ICML writer (Mauro Bieg):
2053 + Support custom-styles (#5137, see #2106).
2054 + Support unnumbered headers (#5140).
2056 * Texinfo writer: Use header identifier for anchor if present (#4731).
2057 Previously we were overwriting an existing identifier with a new one.
2059 * Org writer: Preserve line-numbering for example and code blocks
2060 (Brian Leung).
2062 * Man/Ms writers: Don't escape `-` as `\-`. The `\-` gets rendered
2063 in HTML and PDF as a unicode minus sign.
2065 * Ms writer: Ensure we have a newline after .EN in disply math (#5251).
2067 * RST writer: Don't wrap simple table header lines (#5128).
2069 * Asciidoc writer: Shorter delimiters for tables, blockquotes
2070 (#4364). This matches asciidoctor reference docs.
2072 * Dokuwiki writer: Remove automatic `:` prefix before internal image
2073 links (#5183, Damien Clochard). This prevented users from making
2074 relative image links.
2076 * Zimwiki writer: remove automatic colon prefix before internal
2077 images (#5183, Damien Clochard).
2079 * MediaWiki writer: fix caption, use 'thumb' instead of 'frame'
2080 (#5105). Captions used to have the word 'caption' prepended; this
2081 has been removed. Also, 'thumb' is used instead of 'frame' to
2082 allow images to be resized.
2084 * reveal.js writer:
2086 + Ensure that we don't get > 2 levels of section nesting,
2087 even with slide level > 2 (#5168).
2088 + If slide level == N but there is no N-level header, make
2089 sure the next header with level > N gets treated as a slide
2090 and put in a section, rather than remaining loose (#5168).
2092 * Markdown writer:
2094 + Make `plain` RawBlocks pass through in `plain` output.
2095 + Include needed whitespace after HTML figure (#5121).
2096 We use HTML for a figure in markdown dialects that can't
2097 represent it natively.
2099 * Commonmark writer:
2101 + Fix handling of SoftBreak with `hard_line_breaks` (#5195).
2102 + Implement `--toc` (`writerTableOfContents`)
2103 in commonmark/gfm writers (#5172).
2105 * EPUB writer:
2107 + Ensure that picture transforms are done on metadata too.
2108 + Small fixes to `nav.xhtml`:
2109 Add 'landmarks' id attribute to the landmarks nav.
2110 Replace old default CSS removing numbers from ol.toc li
2111 with new rules that match `nav#toc ol, nav#landmarks ol`.
2112 We keep the `toc` class on `ol` for backwards compatibility.
2114 * LaTeX writer:
2116 + Make raw content marked `beamer` pass through in `beamer`
2117 output (pandoc/lua-filters#40).
2118 + Beamer: avoid duplicated `fragile` property in some cases
2119 (#5208).
2120 + Add `#` special characters for listings (#4939).
2121 This character needs special handling in `\lstinline`.
2123 * RTF writer: use `toTableOfContents` from Shared to replace
2124 old duplicated code.
2126 * Pptx writer:
2128 + Support custom properties. Also supports additional core
2129 properties: `subject`, `category`, `description` (#5252,
2130 Agustín Martín Barbero).
2131 + Use `toTableOfContents` from Shared to replace old duplicated code.
2133 * ODT writer (Augustín Martín Barbero):
2135 + Fix typo in custom properties (#2839).
2136 + Improve standard properties, including the following core
2137 properties: `generator` (Pandoc/VERSION), `description`, `subject`,
2138 `keywords`, `initial-creator` (from authors), `creation-date`
2139 (actual creation date) (#5252).
2141 * Custom writers:
2143 + Allow '-' in filenames for custom lua writers (#5187).
2144 + sample.lua: add `SingleQuoted`, `DoubleQuoted` (#5104).
2145 + sample.lua: Add a missing `>` (MichaWiedenmann).
2147 * reveal.js template: Add `zoomKey` config (#4249).
2149 * HTML5 template: Remove unnecessary type="text/css" on style and
2150 link for HTML5 (#5146).
2152 * LaTeX template (Andrew Dunning, except where noted):
2154 + Prevent fontspec from scaling `mainfont` to match the default
2155 font, Latin Modern. A main font set to 12pt could
2156 previously appear between 11pt to 13pt depending on its design.
2157 To return to the earlier rendering, use `-V
2158 mainfontoptions="Scale=MatchLowercase"` (#5212, #5218).
2159 + Display monospaced fonts without TeX ligatures when using
2160 `--pdf-engine=lualatex`. It now matches the behaviour of other
2161 engines (#5212, #5218).
2162 + Remove the deprecated `romanfont` variable. The functionality of
2163 `mainfont` is identical (#5218).
2164 + Render `\subtitle` with the standard document classes.
2165 Previously, `subtitle` only appeared when using the KOMA-Script
2166 classes or Beamer (#5213, #5244).
2167 + Use Babel instead of Polyglossia for LuaLaTeX. This avoids
2168 several language selection problems, notably with retaining
2169 French spacing conventions when switching to a verbatim
2170 environment or another language; and in printing Greek text
2171 without hyphenation (#5193).
2172 + Use the [`xurl`](https://ctan.org/pkg/xurl) package if
2173 available, improving the appearance of URLs by allowing them to
2174 break at additional points (#5193).
2175 + Use [`bookmark`](https://ctan.org/pkg/bookmark) if available
2176 to correct heading levels in PDF bookmarks: see the [KOMA-Script
2177 3.26 release notes](https://komascript.de/release3.26) (#5193).
2178 + Require the [`xcolor`](https://ctan.org/pkg/xcolor) package to
2179 avoid a possible error when using additional packages alongside
2180 footnotes in tables (#5193, closes #4861).
2181 + Remove obsolete `fixltx2e` package, which has no functionality
2182 with TeX Live 2015 or later (#5193).
2183 + Allow multiple `fontfamilies.options` (#5193, closes #5194).
2184 + Restrict `institute` variable to Beamer (#5219).
2185 + Use [`footnotehyper`](https://ctan.org/pkg/footnotehyper)
2186 package if available to make footnotes in tables compatible
2187 with `hyperref` (#5234).
2188 + Number parts and chapters in book classes only if the
2189 `numbersections` variable is set, for consistency with other
2190 output formats. To return to the previous behaviour, use
2191 `-V numbersections -V secnumdepth=0` (#5235).
2192 + Reindent file (#5193).
2193 + Use built-in parskip handling with KOMA-Script classes (#5143, Enno).
2194 + Set default listings language for lua, assembler (#5227, John
2195 MacFarlane). Otherwise we get an error when trying to compile code
2196 with lua or assembler code. To change the default dialect
2197 (currenty 5.3 for lua and x86masm for assembler), you can use
2198 `--include-in-header` to inject something like
2199 `\lstset{defaultdialect=[5.2]Lua}`.
2201 * Text.Pandoc.Readers: Changed types of `readJSON`; it now runs
2202 in an instance of PandocMonad, like the other readers and
2203 writers. [API change]
2205 * Text.Pandoc.Writers: Changed types of `writeJSON`; it now runs
2206 in an instance of PandocMonad, like the other readers and
2207 writers. [API change]
2209 * Text.Pandoc.Error: Added `PandocUTF8DecodingError` constructor
2210 for `PandocError`. [API change]
2212 * Text.Pandoc.Writers.Shared - add `toTableOfContents`. [API change]
2213 This is refactored out from the Markdown writer.
2214 It can be used in other writers to create a table of contents.
2216 * Improve error messages for UTF-8 decoding errors. Now we give
2217 the filename and byte offset (#4765).
2219 * Text.Pandoc.XML: Strip out illegal XML characters in
2220 `escapeXMLString` (#5119).
2222 * Text.Pandoc.Process: update `pipeProcess` (Albert Krewinkel).
2223 The implementation of `pipeProcess` was rewritten to fix sporadic
2224 failures caused by prematurely closed pipes.
2226 * Use `safeRead` instead of `read` everywhere in the code
2227 (John MacFarlane, Mauro Bieg, #5162, #5180).
2229 * Text.Pandoc.SelfContained: Decompress `.svgz` when
2230 converting to `data:` URI (#5163, Alexander Krotov).
2232 * Text.Pandoc.Parsing: Remove unused `HasHeaderMap`
2233 (#5175, Alexander Krotov). [API change]
2235 * Normalize Windows paths to account for change in ghc 8.6 (#5127).
2236 When pandoc is compiled with ghc 8.6, Windows paths are treated
2237 differently, and paths beginning `\\server` no longer work.
2238 This commit rewrites such patsh to `\\?\UNC\server` which works.
2239 The change operates at the level of argument parsing, so it
2240 only affects the command line program.
2242 * Simplify/fix reading of `--metadata` values on command line
2243 to avoid problems relating to hvr/HsYAML#7 (#5177).
2245 * data/pandoc.lua: auto-fix nested constructor arguments (Albert
2246 Krewinkel). Incorrect types to pandoc element constructors are
2247 automatically converted to the correct types when possible. This was
2248 already done for most constructors, but conversions are now also done
2249 for nested types (like lists of lists).
2251 * Removed custom Setup.hs, use build-type: simple. The only thing we
2252 gained from the custom build was automatic installation of the man
2253 page when using 'cabal install'. But custom builds cause problems,
2254 e.g., with cross-compilation. Installation of the man page is
2255 better handled by packagers. Note to packagers (e.g. Debian): it
2256 may be necessary to add a step installing the man page with the
2257 next release.
2259 * Allow latest http-client, tasty, zip-archive, Glob.
2261 * Require skylighting >= 0.7.5, adding support for sml, J,
2262 typescript.
2264 * Tests: Cleaned up `findPandoc` in `Tests.Helpers`, so it
2265 works well with cabal v2.
2267 * INSTALL.md:
2269 + Use button for installer links (John MacFarlane, Mauro Bieg,
2270 #5167).
2271 + Fix links and bump required stack version (max).
2272 + Improve installation notes on associated software (Andrew
2273 Dunning). Includes explanation of how to install related tools
2274 with package managers (since the method of installing
2275 `rsvg-convert` is not obvious).
2277 * doc/org.md: improve documentation of org features (Albert
2278 Krewinkel).
2280 * doc/lua-filters.md: use 3rd level headers for module fields.
2282 * MANUAL:
2284 + Clarify automatic identifiers (#5201). We remove
2285 non-alphanumerics. This includes, e.g., emojis.
2286 + Fix example for Div with id (Geoffrey Ely).
2287 + Update list of LaTeX packages used.
2288 + Make it clear that `hard_line_breaks` works in `gfm` (see #5195).
2289 + Mention `raw_attribute` in documentation for `raw_html` and
2290 `raw_tex` (#5240, thanks to @eiro).
2291 + Clarify that `$sep$` must come right before `$endfor$` in templates
2292 (#5243, Lev Givon).
2293 + Document metadata support for docx, odt, pptx writers (Agustín
2294 Martín Barbero).
2295 + Reorganize template variables (#5249, Andrew Dunning).
2296 Add additional headings to categorize variables, and
2297 alphabetize when there is large number; add more examples.
2298 + Document `date-meta` template variable (#5260, Tristan Stenner).
2300 * trypandoc: Fix CSS and viewport.
2302## pandoc 2.5 (2018-11-27)
2304 * Text.Pandoc.App: split into several unexported submodules (Albert
2305 Krewinkel): Text.Pandoc.App.FormatHeuristics,
2306 Text.Pandoc.App.Opt, Text.Pandoc.App.CommandLineOptions,
2307 Text.Pandoc.App.OutputSettings. This is motivated partly by the
2308 desire to reduce recompilations when something is modified,
2309 since App previously depended on virtually every other module.
2311 * Text.Pandoc.Extensions
2313 + Semantically, `gfm_auto_identifiers` is now a modifier of
2314 `auto_identifiers`; for identifiers to be set, `auto_identifiers` must
2315 be turned on, and then the type of identifier produced depends on
2316 `gfm_auto_identifiers` and `ascii_identifiers` are set. Accordingly,
2317 `auto_identifiers` is now added to `githubMarkdownExtensions` (#5057).
2318 + Remove `ascii_identifiers` from `githubMarkdownExtensions`.
2319 GitHub doesn't seem to strip non-ascii characters any more.
2321 * Text.Pandoc.Lua.Module.Utils (Albert Krewinkel)
2323 + Test AST object equality via Haskell (#5092). Equality of Lua
2324 objects representing pandoc AST elements is tested by unmarshalling
2325 the objects and comparing the result in Haskell.
2326 A new function `equals` which performs this test has been added to the
2327 `pandoc.utils` module.
2328 + Improve stringify. Meta value strings (MetaString)
2329 and booleans (MetaBool) are now converted to the literal string and the
2330 lowercase boolean name, respectively. Previously, all values of these
2331 types were converted to the empty string.
2333 * Text.Pandoc.Parsing: Remove Functor and Applicative constraints where Monad
2334 already exists (Alexander Krotov).
2336 * Text.Pandoc.Pretty: Don't render BreakingSpace at end of line
2337 or beginning of line (#5050).
2339 * Text.Pandoc.Readers.Markdown
2341 + Fix parsing of citations, quotes, and underline emphasis
2342 after symbols. Starting with pandoc 2.4, citations, quoted inlines,
2343 and underline emphasis were no longer recognized after certain
2344 symbols, like parentheses (#5099, #5053).
2345 + In pandoc 2.4, a soft break after an abbreviation would be
2346 relocated before it to allow for insertion of a nonbreaking
2347 space after the abbreviation. This behavior is here reverted.
2348 A soft break after an abbreviation will remain, and no nonbreaking
2349 space will be added. Those who care about this issue should take care not
2350 to end lines with an abbreviation, or to insert nonbreaking spaces
2351 manually.
2353 * Text.Pandoc.Readers.FB2: Do not throw error for unknown elements in
2354 `<body>` (Alexander Krotov). Some libraries include custom elements
2355 in their FB2 files.
2357 * Text.Pandoc.Readers.HTML
2359 + Allow `tfoot` before body rows (#5079).
2360 + Parse `<small>` as a Span with class "small" (#5080).
2361 + Allow thead containing a row with `td` rather than `th` (#5014).
2363 * Text.Pandoc.Readers.LaTeX
2365 + Cleaned up handling of dimension arguments. Allow decimal points,
2366 preceding space.
2367 + Don't allow arguments for verbatim, etc.
2368 + Allow space before bracketed options.
2369 + Allow optional arguments after `\\` in tables.
2370 + Improve parsing of `\tiny`, `\scriptsize`, etc. Parse as raw,
2371 but know that these font changing commands take no arguments.
2373 * Text.Pandoc.Readers.Muse
2375 + Trim whitespace before parsing grid table cells (Alexander Krotov).
2376 + Add grid tables support (Alexander Krotov).
2378 * Text.Pandoc.Shared
2380 + For bibliography match Div with id `refs`, not class `references`.
2381 This was a mismatch between pandoc's docx, epub, latex, and markdown
2382 writers and the behavior of pandoc-citeproc, which actually looks for a
2383 div with id `refs` rather than one with class `references`.
2384 + Exactly match GitHub's identifier generating algorithm (#5057).
2385 + Add parameter for `Extensions` to `uniqueIdent` and
2386 `inlineListToIdentifier` (#5057). [API change]
2387 This allows these functions to be sensitive to the settings of
2388 `Ext_gfm_auto_identifiers` and `Ext_ascii_identifiers`, and allows us to
2389 use `uniqueIdent` in the CommonMark reader, replacing custom code. It
2390 also means that `gfm_auto_identifiers` can now be used in all formats.
2392 * Text.Pandoc.Writers.AsciiDoc
2394 + Use `.`+ as list markers to support nested ordered lists (#5087).
2395 + Support list number styles (#5089).
2396 + Render Spans using `[#id .class]#contents#` (#5080).
2398 * Text.Pandoc.Writers.CommonMark
2400 + Respect `--ascii` (#5043, quasicomputational).
2401 + Make sure `--ascii` affects quotes, super/subscript.
2403 * Text.Pandoc.Writers.Docx
2405 + Fix bookmarks to headers with long titles (#5091).
2406 Word has a 40 character limit for bookmark names. In addition, bookmarks
2407 must begin with a letter. Since pandoc's auto-generated identifiers may
2408 not respect these constraints, some internal links did not work. With
2409 this change, pandoc uses a bookmark name based on the SHA1 hash of the
2410 identifier when the identifier isn't a legal bookmark name.
2411 + Add bookmarks to code blocks (Nikolay Yakimov).
2412 + Add bookmarks to images (Nikolay Yakimov).
2413 + Refactor common bookmark creation code into a function (Nikolay Yakimov).
2415 * Text.Pandoc.Writers.EPUB: Handle calibre metadata (#5098).
2416 Nodes of the form
2418 <meta name="calibre:series" content="Classics on War and Politics"/>
2420 are now included from an epub XML metadata file. You can also include
2421 this information in your YAML metadata, like so:
2423 calibre:
2424 series: Classics on War and Policitics
2426 In addition, ibooks-specific metadata can now be included via an XML
2427 file. (Previously, it could only be included via YAML metadata, see
2428 #2693.)
2430 * Text.Pandoc.Writers.HTML: Use plain `"` instead of `&quot;` outside of
2431 attributes.
2433 * Text.Pandoc.Writers.ICML: Consolidate adjacent strings, inc. spaces.
2434 This avoids splitting up the output unnecessarily into separate elements.
2436 * Text.Pandoc.Writers.LaTeX: Don't emit `[<+->]` unless beamer output, even
2437 if `writerIncremental` is True (#5072).
2439 * Text.Pandoc.Writers.Muse (Alexander Krotov).
2441 + Output tables as grid tables if they have multi-line cells.
2442 + Indent simple tables only on the top level.
2443 + Output tables with one column as grid tables.
2444 + Add support for `--reference-location`.
2445 + Internal improvements.
2447 * Text.Pandoc.Writers.OpenDocument: Fix list indentation (Nils Carlson,
2448 #5095). This was a regression in pandoc 2.4.
2450 * Text.Pandoc.Writers.RTF: Fix warnings for skipped raw inlines.
2452 * Text.Pandoc.Writers.Texinfo: Add blank line before `@menu` section (#5055).
2454 * Text.Pandoc.XML: in `toHtml5Entities`, prefer shorter entities
2455 when there are several choices for a particular character.
2457 * data/abbreviations
2459 + Add additional abbreviations (Andrew Dunning)
2460 Many of these borrowed from the Chicago Manual of Style 10.42,
2461 'Scholarly abbreviations'.
2463 * Templates
2465 + Asciidoc template: add :lang: to title header is lang is set in
2466 metadata (#5088).
2468 * pandoc.cabal: Add cabal flag `derive_json_via_th` (Albert Krewinkel)
2469 Disabling the flag will cause derivation of ToJSON and FromJSON
2470 instances via GHC Generics instead of Template Haskell. The flag is
2471 enabled by default, as deriving via Generics can be slow (see #4083).
2473 * trypandoc:
2475 + Tweaked drop-down lists.
2476 + Put link to site in footer.
2477 + Preselect output format.
2478 + Update on change of in or out format.
2479 + Add man input format.
2481 * MANUAL.txt:
2483 + Fix outdated description of latex_macros extension.
2484 + Clarified placement of bibliography.
2485 + Added "A note on security."
2486 + Fix note on curly brace syntx for locators.
2487 + Document new explicit syntax for citeproc locators.
2488 + Remove confusing cross-links for some extensions.
2489 + Don't put pandoc in code ticks in heading.
2490 + Document that `--ascii` works for gfm and commonmark too.
2491 + Add `man` to `--from` options.
2493 * doc/customizing-pandoc.md: various improvements (Mauro Bieg).
2496## pandoc 2.4 (2018-11-03)
2498### New features
2500 * New input format `man` (Yan Pashkovsky, John MacFarlane).
2502### Behavior changes
2504 * `--ascii` is now implemented in the writers, not in Text.Pandoc.App,
2505 via the new `writerPreferAscii` field in `WriterOptions`.
2506 Now the `write*` functions for Docbook, HTML, ICML, JATS, LaTeX,
2507 Ms, Markdown, and OPML are sensitive to `writerPreferAscii`.
2508 Previously the to-ascii translation was done in Text.Pandoc.App,
2509 and thus not available to those using the writer functions
2510 directly.
2512 * `--ascii` now works with Markdown output. HTML5 character reference
2513 entities are used.
2515 * `--ascii` now works with LaTeX output. 100% ASCII output can't be
2516 guaranteed, but the writer will use commands like `\"{a}` and `\l`
2517 whenever possible, to avoid emitting a non-ASCII character.
2519 * For HTML5 output, `--ascii` now uses HTML5 character reference
2520 entities rather than numerical entities.
2522 * Improved detection of format based on extension (in Text.Pandoc.App).
2523 We now ensure that if someone tries to convert a file for a
2524 format that has a pandoc writer but not a reader, it won't just
2525 default to markdown.
2527 * Add viz. to abbreviations file (#5007, Nick Fleisher).
2529 * AsciiDoc writer: always use single-line section headers,
2530 instead of the old underline style (#5038). Previously the single-line
2531 style would be used if `--atx-headers` was specified, but
2532 now it is always used.
2534 * RST writer: Use simple tables when possible (#4750).
2536 * CommonMark (and gfm) writer: Add plain text fallbacks. (#4528,
2537 quasicomputational). Previously, the writer would unconditionally
2538 emit HTML output for subscripts, superscripts, strikeouts (if the
2539 strikeout extension is disabled) and small caps, even with
2540 `raw_html` disabled. Now there are plain-text (and, where
2541 possible, fancy Unicode) fallbacks for all of these corresponding
2542 (mostly) to the Markdown fallbacks, and the HTML output is only
2543 used when `raw_html` is enabled.
2545 * Powerpoint writer: support raw openxml (Jesse Rosenthal, #4976).
2546 This allows raw openxml blocks and inlines to be used in the pptx
2547 writer. Caveats: (1) It's up to the user to write
2548 well-formed openxml. The chances for corruption, especially with
2549 such a brittle format as pptx, is high. (2) Because of
2550 the tricky way that blocks map onto shapes, if you are using
2551 a raw block, it should be the only block on a slide
2552 (otherwise other text might end up overlapping it). (3) The
2553 pptx ooxml namespace abbreviations are different from the
2554 docx ooxml namespaces. Again, it's up to the user to get it
2555 right. Unzipped document and ooxml specification should be
2556 consulted.
2558 * With `--katex` in HTML formats, do not use the autorenderer (#4946).
2559 We no longer surround formulas with `\(..\)` or `\[..\]`. Instead,
2560 we tell katex to convert the contents of span elements with
2561 class "math". Since math has already been identified, this
2562 avoids wasted time parsing for LaTeX delimiters. Note, however,
2563 that this may yield unexpected results if you have span elements
2564 with class "math" that don't contain LaTeX math.
2565 Also, use latest version of KaTeX by default (0.9.0).
2567 * The man writer now produces ASCII-only output, using groff escapes,
2568 for portability.
2570 * ODT writer:
2572 + Add title, author and date to metadata; any remaining
2573 metadata fields are added as `meta:user-defined` tags.
2574 + Implement table caption numbering (#4949, Nils Carlson).
2575 Captioned tables are numbered and labeled with format "Table 1:
2576 caption", where "Table" is replaced by a translation, depending
2577 on the value of `lang` in metadata. Uncaptioned tables are not
2578 enumerated.
2579 + OpenDocument writer: Implement figure numbering in captions (#4944,
2580 Nils Carlson). Figure captions are now numbered 1, 2, 3, ...
2581 The format in the caption is "Figure 1: caption" and so on
2582 (where "Figure" is replaced by a translation, depending on the
2583 value of `lang` in the metadata). Captioned figures are numbered
2584 consecutively and uncaptioned figures are not enumerated. This
2585 is necessary in order for LibreOffice to generate an
2586 Illustration Index (Table of Figures) for included figures.
2588 * RST reader: Pass through fields in unknown directives as div attributes
2589 (#4715). Support `class` and `name` attributes for all directives.
2591 * Org reader: Add partial support for `#+EXCLUDE_TAGS` option. (#4284,
2592 Brian Leung). Headers with the corresponding tags should not
2593 appear in the output.
2595 * Log warnings about missing title attributes now include a
2596 suggestion about how to fix the problem (#4909).
2598 * Lua filter changes (Albert Krewinkel):
2600 + Report traceback when an error occurs. A proper Lua traceback is
2601 added if either loading of a file or execution of a filter
2602 function fails. This should be of help to authors of Lua filters
2603 who need to debug their code.
2605 + Allow access to pandoc state (#5015). Lua filters and custom
2606 writers now have read-only access to most fields of pandoc's
2607 internal state via the global variable `PANDOC_STATE`.
2609 + Push ListAttributes via constructor (Albert Krewinkel).
2610 This ensures that ListAttributes, as present in OrderedList elements,
2611 have additional accessors (viz. `start`, `style`, and `delimiter`).
2613 + Rename ReaderOptions fields, use snake_case. Snake case is used
2614 in most variable names, using camelCase for these fields was an
2615 oversight. A metatable is added to ensure that the old field
2616 names remain functional.
2618 + Iterate over AST element fields when using `pairs`. This makes
2619 it possible to iterate over all ield names of an AST element by
2620 using a generic `for` loop with pairs`:
2622 for field_name, field_content in pairs(element) do
2623 ...
2624 end
2626 Raw table fields of AST elements should be considered an
2627 implementation detail and might change in the future. Accessing
2628 element properties should always happen through the fields
2629 listed in the Lua filter docs.
2631 Note that the iterator currently excludes the `t`/`tag` field.
2633 + Ensure that MetaList elements behave like Lists. Methods usable
2634 on Lists can also be used on MetaList objects.
2636 + Fix MetaList constructor (Albert Krewinkel). Passing a MetaList
2637 object to the constructor `pandoc.MetaList` now returns the
2638 passed list as a MetaList. This is consistent with the
2639 constructor behavior when passed an (untagged) list.
2641 * Custom writers: Custom writers have access to the global variable
2642 `PANDOC_DOCUMENT`(Albert Krewinkel, #4957). The variable contains
2643 a userdata wrapper around the full pandoc AST and exposes two
2644 fields, `meta` and `blocks`. The field content is only
2645 marshaled on-demand, performance of scripts not accessing the
2646 fields remains unaffected.
2648### API changes
2650 * Text.Pandoc.Options: add `writerPreferAscii` to `WriterOptions`.
2652 * Text.Pandoc.Shared:
2654 + Export `splitSentences`. This was previously duplicated in the Man and
2655 Ms writers.
2656 + Add `ToString` typeclass (Alexander Krotov).
2658 * New exported module Text.Pandoc.Filter (Albert Krewinkel).
2660 * Text.Pandoc.Parsing
2662 + Generalize `gridTableWith` to any `Char` Stream (Alexander Krotov).
2663 + Generalize `readWithM` from `[Char]` to any `Char` Stream
2664 that is a `ToString` instance (Alexander Krotov).
2666 * New exposed module Text.Pandoc.Filter (Albert Krewinkel).
2668 * Text.Pandoc.XML: add `toHtml5Entities`.
2670 * New exported module Text.Pandoc.Readers.Man (Yan Pashkovsky, John
2671 MacFarlane).
2673 * Text.Pandoc.Writers.Shared
2675 + Add exported functions `toSuperscript` and
2676 `toSubscript` (quasicomputational, #4528).
2677 + Remove exported functions `metaValueToInlines`,
2678 `metaValueToString`. Add new exported functions
2679 `lookupMetaBool`, `lookupMetaBlocks`, `lookupMetaInlines`,
2680 `lookupMetaString`. Use these whenever possible for uniformity
2681 in writers (Mauro Bieg, #4907). (Note that
2682 removed function `metaValueToInlines` was in previous
2683 released versions.)
2684 + Add `metaValueToString`.
2686 * Text.Pandoc.Lua
2688 + Expose more useful internals (Albert Krewinkel):
2690 - `runFilterFile` to run a Lua filter from file;
2691 - data type `Global` and its constructors; and
2692 - `setGlobals` to add globals to a Lua environment.
2694 This module also contains `Pushable` and `Peekable` instances
2695 required to get pandoc's data types to and from Lua. Low-level
2696 Lua operation remain hidden in Text.Pandoc.Lua.
2698 + Rename `runPandocLua` to `runLua` (Albert Krewinkel).
2700 + Remove `runLuaFilter`, merging this into Text.Pandoc.Filter.Lua's
2701 `apply` (Albert Krewinkel).
2703### Bug fixes and under-the-hood improvements
2705 * Text.Pandoc.Parsing
2707 + Make `uri` accept any stream with Char tokens (Alexander Krotov).
2708 + Rewrite `uri` without `withRaw` (Alexander Krotov).
2709 + Generalize `parseFromString` and `parseFromString'` to any
2710 streams with Char token (Alexander Krotov)
2711 + Rewrite `nonspaceChar` using `noneOf` (Alexander Krotov)
2713 * Text.Pandoc.Shared: Reimplement `mapLeft` using `Bifunctor.first`
2714 (Alexander Krotov).
2716 * Text.Pandoc.Pretty: Simplify `Text.Pandoc.Pretty.offset`
2717 (Alexander Krotov).
2719 * Text.Pandoc.App
2721 + Work around HXT limitation for --syntax-definition with windows
2722 drive (#4836).
2723 + Always preserve tabs for man format. We need it for tables.
2724 + Split command line parsing code into a separate unexported
2725 module, Text.Pandoc.App.CommandLineOptions (Albert Krewinkel).
2727 * Text.Pandoc.Readers.Roff: new unexported module for tokenizing
2728 roff documents.
2730 * New unexported module Text.Pandoc.RoffChar, provided character
2731 escape tables for roff formats.
2733 * Text.Pandoc.Readers.HTML: Fix `htmlTag` and `isInlineTag` to
2734 accept processing instructions (#3123, regression since 2.0).
2736 * Text.Pandoc.Readers.JATS: Use `foldl'` instead of `maximum` to
2737 account for empty lists (Alexander Krotov).
2739 * Text.Pandoc.Readers.RST: Don't allow single-dash separator in
2740 headerless table (#4382).
2742 * Text.Pandoc.Readers.Org: Parse empty argument array in inline src
2743 blocks (Brian Leung).
2745 * Text.Pandoc.Readers.Vimwiki:
2747 + Get rid of `F`, `runF` and `stateMeta'` in favor of `stateMeta`
2748 (Alexander Krotov).
2749 + Parse `Text` without converting to `[Char]` (Alexander Krotov).
2751 * Text.Pandoc.Readers.Creole: Parse `Text` without converting to
2752 `[Char]` (Alexander Krotov).
2754 * Text.Pandoc.Readers.LaTeX
2756 + Allow space at end of math after `\` (#5010).
2757 + Add support for `nolinkurl` command (#4992, Brian Leung).
2758 + Simplified type on `doMacros'`.
2759 + Tokenize before pulling tokens, rather than after (#4408). This
2760 has some performance penalty but is more reliable.
2761 + Make macroDef polymorphic and allow in inline context.
2762 Otherwise we can't parse something like `\lowercase{\def\x{Foo}}`.
2763 I have actually seen tex like this in the wild.
2764 + Improved parsing of `\def`, `\let`. We now correctly parse:
2765 ```
2766 \def\bar{hello}
2767 \let\fooi\bar
2768 \def\fooii{\bar}
2769 \fooi +\fooii
2771 \def\bar{goodbye}
2772 \fooi +\fooii
2773 ```
2774 + Improve parsing of `\def` argspec.
2775 + Skip `\PackageError` commands (see #4408).
2776 + Fix bugs omitting raw tex (#4527). The default is `-raw_tex`,
2777 so no raw tex should result unless we explicitly say `+raw_tex`.
2778 Previously some raw commands did make it through.
2779 + Moved `isArgTok` to Text.Pandoc.Readers.LaTeX.Parsing.
2780 + Moved `babelLangToBCP`, `polyglossiaLangToBCP` to new module,
2781 Text.Pandoc.Readers.LaTeX.Lang (unexported).
2782 + Simplified accent code using unicode-transforms.
2783 New dependency on unicode-transforms package for normalization.
2784 + Allow verbatim blocks ending with blank lines (#4624).
2785 + Support `breq` math environments: `dmath`, `dgroup`, `darray`.
2786 This collects some of the general-purpose code from the LaTeX reader,
2787 with the aim of making the module smaller.
2789 * Text.Pandoc.Readers.Markdown
2791 + Fix awkward soft break movements before abbreviations (#4635).
2792 + Add updateStrPos in a couple places where needed.
2794 * Text.Pandoc.Readers.Docx: Trigger bold/italic with bCs, iCs
2795 (#4947). These are variants for "complex scripts" like Arabic
2796 and are now treated just like b, i (bold, italic).
2798 * Text.Pandoc.Readers.Muse (Alexander Krotov)
2800 + Try to parse lists before trying to parse table.
2801 This ensures that tables inside lists are parsed correctly.
2802 + Forbid whitespace after opening and before closing markup
2803 elements.
2804 + Parse page breaks.
2805 + Simplify `museToPandocTable` to get rid of partial functions.
2806 + Allow footnotes to start with empty line.
2807 + Make sure that the whole text is parsed.
2808 + Allow empty headers. Previously empty headers caused parser to
2809 terminate without parsing the rest of the document.
2810 + Allow examples to be indented with tabs.
2811 + Remove indentation from examples indicated by `{{{` and `}}}`.
2812 + Fix parsing of empty cells.
2813 + Various changes to internals.
2814 + Rewrite some parsers in applicative style.
2815 + Avoid tagsoup dependency.
2816 + Allow table caption to contain `+`.
2818 * Text.Pandoc.Writers.LaTeX
2820 + Add newline if math ends in a comment (#4880). This prevents the
2821 closing delimiter from being swalled up in the comment.
2822 + With `--listings`, don't pass through org-babel attributes (#4889).
2823 + With `--biblatex`, use `\autocite` when possible (#4960).
2824 `\autocites{a1}{a2}{a3}` will not collapse the entries. So, if
2825 we don't have prefixes and suffixes, we use instead
2826 `\autocite{a1,a2,a3}`.
2827 + Fix description lists contining highlighted code (#4662).
2829 * Text.Pandoc.Writers.Man
2831 + Don't wrap `.SH` and `.SS` lines (#5019).
2832 + Avoid unnecessary `.RS`/`.RE` pair in definition lists with
2833 one paragraph definitions.
2834 + Moved common groff functions to Text.Pandoc.Writers.Groff.
2835 * Fix strong/code combination on man (should be `\f[CB]` not
2836 `\f[BC]`, see #4973).
2837 + Man writer: use `\f[R]` instead of `\f[]` to reset font
2838 (Alexander Krotov, #4973).
2839 + Move `splitSentences` to Text.Pandoc.Shared.
2841 * Text.Pandoc.Writers.Docx
2843 + Add framework for custom properties (#3034). So far, we don't
2844 actually write any custom properties, but we have the
2845 infrastructure to add this.
2847 + Handle tables in table cells (#4953). Although this is not
2848 documented in the spec, some versions of Word require a `w:p`
2849 element inside every table cell. Thus, we add one when the
2850 contents of a cell do not already include one (e.g. when a table
2851 cell contains a table).
2853 * Text.Pandoc.Writers.AsciiDoc: Prevent illegal nestings.
2854 Adjust header levels so that n+1 level headers are only
2855 found under n level headers, and the top level is 1.
2857 * Text.Pandoc.Writers.OpenDocument: Improve bullet/numbering
2858 alignment (#4385). This change eliminates the large gap we used
2859 to have between bullet and text, and also ensures that numbers
2860 in numbered lists will be right-aligned.
2862 * Text.Pandoc.Writers.ZimWiki
2864 + Number ordered list items sequentially, rather than always
2865 with 1 (#4962).
2866 + Remove extra indentation on lists (#4963).
2868 * Text.Pandoc.Writers.EPUB: Use metadata field `css` instead of
2869 `stylesheet` (Mauro Bieg, #4990).
2871 * Text.Pandoc.Writers.Markdown: Ensure blank between raw block and
2872 normal content (#4629). Otherwise a raw block can prevent a
2873 paragraph from being recognized as such.
2875 * Text.Pandoc.Writers.Ms
2877 + Removed old `escapeBar`. We don't need this now that we use
2878 `@` for math delim.
2879 + Moved common code to Text.Pandoc.Writers.Roff and to
2880 Text.Pandoc.RoffChar.
2881 + Move `splitSentences` to Text.Pandoc.Shared (to avoid duplication
2882 with the man writer).
2884 * Text.Pandoc.Writers.Muse (Alexander Krotov).
2886 + Add support for grid tables.
2887 + Fix Muse writer style.
2888 + Use `length` instead of `realLength` to calculate definition
2889 indentation. Muse parsers don't take character width into
2890 account when calculating indentation.
2891 + Do not insert newline before lists.
2892 + Use lightweight markup after `</em>` tag.
2894 * New unexported module Text.Pandoc.Writers.Roff, providing functions
2895 useful for all roff format writers (man, ms).
2897 * Text.Pandoc.Lua
2899 + Move globals handling to separate module Text.Pandoc.Lua.Global
2900 (Albert Krewinkel).
2902 + Lua filter internals: push Shared.Element as userdata (Albert
2903 Krewinkel). Hierarchical Elements were pushed to Lua as plain
2904 tables. This is simple, but has the disadvantage that marshaling
2905 is eager: all child elements will be marshaled as part of the
2906 object. Using a Lua userdata object instead allows lazy access
2907 to fields, causing content marshaling just (but also each time)
2908 when a field is accessed. Filters which do not traverse the full
2909 element contents tree become faster as a result.
2911### Default template changes
2913 * LaTeX template:
2915 + Add variable `hyperrefoptions` (#4925, Mathias Walter).
2916 + Add variable `romanfont`, `romanfontoptions` (#4665, OvidiusCicero).
2918 * AsciiDoc template: use single-line style for title.
2920 * revealjs template: Fix typo in the socket.io javascript plugin (#5006,
2921 Yoan Blanc).
2923 * Text.Pandoc.Lua.Util: add missing docstring to `defineHowTo`
2924 (Albert Krewinkel).
2926 * data/pandoc.lua: add datatype ListAttributes (Albert Krewinkel)
2928 * data/sample.lua: replace custom pipe function with pandoc.utils.pipe
2929 (Albert Krewinkel).
2931### Documentation improvements
2933 * INSTALL.md
2935 + Add chromeos install instructions (#4958) (Evan Pratten).
2936 + Add note about TinyTeX.
2938 * MANUAL.txt
2940 + Change `groff` -> `roff`.
2941 + Implement `--ascii` for Markdown writer.
2942 + Clarify LaTeX image dimensions output (Mauro Bieg).
2944 * doc/customizing-pandoc.md: added skeleton (Mauro Bieg, #3288).
2946 * doc/getting-started.md: Added title to test1.md to avoid warning.
2948 * doc/lua-filters.md: merge type references into main document,
2949 fix description of Code.text (Albert Krewinkel).
2951### Build infrastructure improvements
2953 * Makefile
2955 + Makefile: added quick-cabal, full-cabal targets.
2956 + Make .msi download targets insensitive to order of appveyor builds.
2958 * Update benchmarks for ghc 8.6.1.
2960 * pandoc.cabal:
2962 + Enable more compiler warnings (Albert Krewinkel).
2963 + Make base lower bound 4.8.
2964 + Bump upper bound for QuickCheck.
2965 + Bump upper bound for binary.
2966 + Updated version bounds for containers and haddock-library (#4974).
2967 + Added docx/docPropos/custom.xml to cabal data-files.
2968 + Require skylighting 0.7.4 (#4920).
2969 + New dependency on unicode-transforms package for normalization.
2971 * Improved .travis.yml testing and test with GHC 8.6.1 (Albert Krewinkel).
2973 * Added `tools/changelog-helper.sh`.
2975 * Added test/grofftest.sh for testing the man reader on real man pages.
2977## pandoc 2.3.1 (2018-09-28)
2979 * RST reader:
2981 + Parse RST inlines containing newlines (#4912, Francesco Occhipinti).
2982 This eliminates a regression introduced after pandoc 2.1.1, which
2983 caused inline constructions containing newlines not to be recognized.
2984 + Fix bug with internal link targets (#4919). They were gobbling up
2985 indented content underneath.
2987 * Markdown reader: distinguish autolinks in the AST. With this change,
2988 autolinks are parsed as Links with the `uri` class. (The same is true
2989 for bare links, if the `autolink_bare_uris` extension is enabled.)
2990 Email autolinks are parsed as Links with the `email` class. This
2991 allows the distinction to be represented in the AST.
2993 * Org reader:
2995 + Force inline code blocks to honor export options (Brian Leung).
2996 + Parse empty argument array in inline src blocks (Brian Leung).
2998 * Muse reader (Alexander Krotov):
3000 + Added additional tests.
3001 + Do not allow code markup to be followed by digit.
3002 + Remove heading level limit.
3003 + Simplify `<literal>` tag parsers
3004 + Parse Text instead of String. Benchmark shows 7% improvement.
3005 + Get rid of HTML parser dependency.
3006 + Various code improvements.
3008 * ConTeXt writer: change `\` to `/` in Windows image paths (#4918).
3009 We do this in the LaTeX writer, and it avoids problems.
3010 Note that `/` works as a LaTeX path separator on Windows.
3012 * LaTeX writer:
3014 + Add support for multiprenote and multipostnote arguments
3015 with `--biblatex` (Brian Leung, #4930). The multiprenotes occur before
3016 the first prefix of a multicite, and the multipostnotes follow the
3017 last suffix.
3018 + Fix a use of `last` that might take empty list. If you ran with
3019 `--biblatex` and have an empty document (metadata but no blocks),
3020 pandoc would previously raise an error because of the use of
3021 `last` on an empty list.
3023 * RTF writer: Fix build failure with ghc-8.6.1 caused by missing
3024 MonadFail instance (Jonas Scholl).
3026 * ODT Writer: Improve table header row style handling (Nils Carlson).
3027 This changes the way styles for cells in the header row
3028 and normal rows are handled in ODT tables.
3029 Previously a new (but identical) style was generated for
3030 every table, specifying the style of the cells within the table.
3031 After this change there are two style definitions for table cells,
3032 one for the cells in the header row, one for all other cells.
3033 This doesn't change the actual styles, but makes post-processing
3034 changes to the table styles much simpler as it is no longer
3035 necessary to introduce new styles for header rows and there are
3036 now only two styles where there was previously one per table.
3038 * HTML writer:
3040 + Don't add `uri` class to presumed autolinks. Formerly the `uri`
3041 class was added to autolinks by the HTML writer, but it had to
3042 guess what was an autolink and could not distinguish
3043 `[http://example.com](http://example.com)` from
3044 `<http://example.com>`. It also incorrectly recognized
3045 `[pandoc](pandoc)` as an autolink. Now the HTML writer
3046 simply passes through the `uri` attribute if it is present,
3047 but does not add anything.
3048 + Avoid adding extra section nestings for revealjs.
3049 Previously revealjs title slides at level (slidelevel - 1)
3050 were nested under an extra section element, even when
3051 the section contained no additional (vertical) content.
3052 That caused problems for some transition effects.
3053 + Omit unknown attributes in EPUB2 output. For example,
3054 `epub:type` attributes should not be passed through,
3055 or the epub produced will not validate.
3057 * JATS writer: remove 'role' attribute on 'bold' and 'sc' elements (#4937).
3058 The JATS spec does not allow these.
3060 * Textile writer: don't represent `uri` class explicitly
3061 for autolinks (#4913).
3063 * Lua filters (Albert Krewinkel):
3065 + Cleanup filter execution code.
3066 + Better error on test failure.
3068 * HTML, Muse reader tests: reduce time taken by round-trip test.
3070 * Added cabal.project.
3072 * MANUAL: `epub:type` is only useful for epub3 (Maura Bieg).
3074 * Use hslua v1.0.0 (Albert Krewinkel).
3076 * Fix `translations/ru` to use modern Russian orthography
3077 (Ivan Trubach).
3079 * Build Windows binary using ghc 8.6.1 and cabal new-build. This
3080 fixes issues with segfaults in the 32-bit Windows binaries (#4283).
3082## pandoc 2.3 (2018-09-16)
3084 * Add `--metadata-file` option (Mauro Bieg, #1960), which allows
3085 users to specify metadata in a YAML file, regardless of the
3086 input format (#1960).
3088 * Text.Pandoc.Writers.Shared: export `isDisplayMath` (API change).
3090 * Text.Pandoc.Readers.Markdown: export `yamlToMeta` (API change,
3091 Mauro Bieg).
3093 * Text.Pandoc.Readers.LaTeX.Types:
3095 + New type `ArgSpec` (API change).
3096 + Second parameter of `Macro` constructor is now `[ArgSpec]` instead of
3097 `Int` (API change).
3099 * Markdown reader:
3101 + Use `tex` instead of `latex` for raw tex-ish content. We can't
3102 always tell if it's LaTeX, ConTeXt, or plain TeX. Better just to
3103 use `tex` always. Note that if `context` or `latex` specifically
3104 is desired, you can still force that in a markdown document by
3105 using the raw attribute. Note that this change may affect some
3106 filters, if they assume that raw tex parsed by the Markdown reader
3107 will be RawBlock (Format `latex`). In most cases it should be
3108 trivial to modify the filters to accept `tex` as well.
3109 + Refactor and reorganize YAML code (Mauro Bieg).
3110 + Make `example_lists` work for interrupted lists
3111 without `startnum` (#4908).
3113 * HTML reader:
3115 + Parse `<script type="math/tex` tags as math (#4877).
3116 These are used by MathJax in some configurations.
3117 + Extract spaces inside links instead of trimming them
3118 (Alexander Krotov, #4845).
3119 + Added round-trip tests (Alexander Krotov).
3120 + Make parsing sensitive to the `raw_tex` extension (#1126). This now
3121 allows raw LaTeX environments, `\ref`, and `\eqref` to be parsed
3122 (which is helpful for translation HTML documents using MathJaX).
3124 * Org reader (Albert Krewinkel):
3126 + Respect export option `p` for planning info. Inclusion of planning info
3127 (`*DEADLINE*`, `*SCHEDULED*`, and `*CLOSED*`) can be controlled via the
3128 `p` export option: setting the option to `t` will add all planning
3129 information in a *Plain* block below the respective headline.
3130 + Org reader internals: don't rely on RecordWildCards and ViewPatterns
3131 ghc extensions.
3132 + Strip planning info from output. Planning info is parsed, but not
3133 included in the output (as is the default with Emacs Org-mode, #4867).
3135 * LaTeX reader:
3137 + Handle parameter patterns for `\def` (#4768, #4771).
3138 For example: `\def\foo#1[#2]{#1 and #2}`.
3139 + Allow `%` characters in URLs. This affects `\href` and `\url` (#4832).
3140 + Fixed parsing of `\texorpdfstring`. We were returning the wrong
3141 argument as the content.
3142 + Support `blockcquote`, `foreignblockquote`, `foreigncblockquote`,
3143 `hyphenblockquote`, `hyphencblockquote`, `enquote*`, `foreignquote`,
3144 `hyphenquote` from `csquotes` (#4848). Note that `foreignquote`
3145 will be parsed as a regular Quoted inline (not using the quotes
3146 appropriate to the foreign language).
3147 + Support more text-mode accents (#4652). Add support for `\|`, `\b`, `\G`,
3148 `\h`, `\d`, `\f`, `\r`, `\t`, `\U`, `\i`, `\j`, `\newtie`,
3149 `\textcircled`. Also fall back to combining characters when composed
3150 characters are not available.
3151 + Resolve `\ref` for figure numbers.
3152 + Support `mintinline` (#4365, Marc Schreiber).
3153 + Fix siunitx unit commands so they are only recognized in
3154 siunitx contexts (#4842). For example, `\l` outside of an
3155 siunitx context should be l-slash, not l (for liter).
3156 + Fix double `unnumbered` class (#4838). The `unnumbered` class
3157 was being included twice for starred sections.
3159 * RST reader: Don't skip link definitions after comments (#4860).
3161 * Muse reader (Alexander Krotov):
3163 + Close the `</quote>` in indented tag test.
3164 There is already a separate test for unclosed `</quote>`.
3165 + Autonumber sections in the correct order. Parsing now stops
3166 at each section header to ensure the header is registered before
3167 parsing of the next section starts.
3168 + Move duplicate code into `headingStart` function.
3169 + Allow newline after opening `*` or `**`.
3170 + Don't allow digits after closing marker in lightweight markup
3171 This change makes reader more compatible with Emacs Muse.
3172 + Parse `<verse>` tag in one pass instead of using
3173 `parseFromString`. This change makes it possible to have
3174 verbatim `</verse>` tag inside verse.
3176 * ODT reader: deal gracefully with missing `<office:font-face-decls/>`
3177 (#4336). This allows pandoc to parse ODT document produced by KDE's
3178 Calligra.
3180 * Muse writer (Alexander Krotov):
3182 + Output headers without asterisks if not on the top level.
3183 + Never wrap definition list terms.
3184 + Set `envInsideBlock = True` when rendering notes.
3185 + Use `""` instead of `[]` for empty String.
3186 + Check for whitespace in the beginning and end of Str's.
3187 + Escape `-`, `;` and `>` in the beginning of strings.
3188 + Escape list markers in the beginning of notes.
3189 + Normalize inline list before testing if tags should be used.
3190 + Use tags instead of lightweight markup for empty strings.
3191 + Use lightweight markup when possible.
3192 + Escape empty strings. This guarantees that `conditionalEscapeString`
3193 never returns empty string.
3194 + Wrap conditionalEscapeString result into `Muse` type.
3195 This removes the need to pass `envInsideLinkDescription` to it.
3196 + Separate `shouldEscapeString` function.
3197 + Simplify inline list rendering.
3198 + Replace newlines in strings with spaces.
3200 * Docx writer:
3202 + Add MetaString case for abstract, subtitle (#4900, Mauro Bieg).
3203 + Properly handle display math in spans (#4826). This isn't a
3204 complete solution, since other nestings of display math may still
3205 cause problems, but it should work for what is by far the most
3206 common case.
3208 * HTML writer:
3210 + Always output `<dt>` element, even if it is empty (#4883,
3211 Alexander Krotov).
3212 + Don't prefix `epub:` attributes with `data-`.
3214 * Org writer: Don't escape literal `_`, `^` (#4882). Org doesn't
3215 recognize these escapes.
3217 * ODT writer: Fix percentage image scaling (#4881, Nils Carlson).
3218 Image scaling was broken when a width was set to a percentage.
3220 * EPUB writer: set `epub:type` on body element in each chapter,
3221 depending on the `epub:type` of the first section (#4823). This
3222 only affects epub3. See
3223 http://www.idpf.org/epub/profiles/edu/structure/#h.l0bzsloklt10
3225 * FB2 writer: put `coverpage` element between title and date rather than in
3226 `document-info` element (#4854).
3228 * Markdown writer: Escape `~` if strikeout extension enabled (#4840).
3230 * Haddock writer: Use proper format for latex math in haddock (#4571, Joe
3231 Hermaszewski). Inline math in `\(..\)`, display math in `\[..\]`,
3232 tex is now used. Previously we'd "fake it with unicode" and fall
3233 back to tex when that didn't work. But newer haddock versions
3234 support latex math.
3236 * TEI writer:
3238 + Ensure that title element is always present, even if empty (#4839).
3239 + Put author tags in the template, rather than adding them in
3240 the writer (#4839).
3242 * LaTeX writer/template: be sensitive to `filecolor` variable (#4822).
3243 `linkcolor` only affects internal links, and `urlcolor` only
3244 affects linked URLs. For external links, the option to use is
3245 `filecolor`.
3247 * ConTeXt writer: output raw `tex` blocks as well as `context` (#969).
3249 * RST writer:
3251 + Use `.. raw:: latex` for `tex` content.
3252 + Use `.. container` for generic Divs, instead of raw HTML.
3253 + Render Divs with admonition classes as admonitions (#4833).
3254 Also omit Div with class `admonition-title`. These are generated
3255 by the RST reader and should be omitted on round-trip.
3257 * Text.Pandoc.PDF: fix message printed when rsvg-convert is not available
3258 (#4855, Antonio Terceiro).
3260 * HTML5 template: add the `title-block-header` identifier to the
3261 `header` element, to make it easier to style precisely (#4767,
3262 J. B. Rainsberger).
3264 * OpenDocument template: Remove unnecessary indenting of TOC title (#4798,
3265 José de Mattos Neto).
3267 * latex template: Add support for $toc-title$ to LaTeX (and PDF)
3268 (#4853, Wandmalfarbe).
3270 * TEI template: improve `publicationStmt`. Add support for
3271 `publisher`, `address`, `pubPlace`, and `date` variables.
3273 * beamer template: Support "toc-title" (#4835, Cyril Roelandt).
3275 * Text.Pandoc.Extensions: Fix haddock on `Ext_footnotes` (Chris Martin).
3277 * Lua: cleanup Lua utils, remove unused functions (Albert Krewinkel).
3279 * MANUAL.txt:
3281 + Clarify that `--biblatex/--natbib` don't work directly for PDF
3282 (#4904).
3283 + Document `epub:type` attribute (Mauro Bieg, #4901)
3284 + Clarify when `--resource-path` has an effect.
3285 + More detail on customization in syntax highlighting section.
3286 + Document encoding issue with `--listings` (#4871, Damien Clochard).
3287 + Remove docs on removed `--katex-stylesheet` (Mauro Bieg, #4862).
3288 + Use https for context wiki links (#4910).
3290 * CONTRIBUTING.md:
3292 + Link to lua-filters repository (#4874).
3293 + Fix mistake in REPL instructions for stack. (#4849, Brian Leung).
3295 * lua-filters.md: add links to filters, and to lua-filters repository
3296 (#4874).
3298 * INSTALL.md:
3300 + Indicate that cabal >= 2.0 is needed.
3301 + Added chocolatey installation method (#4844, Miodrag Milić).
3303 * Travis: exclude round-trip tests, except for nightly test which can fail.
3305 * Use latest texmath, pandoc-citeproc.
3307 * Use a patched version of foundation until
3308 https://github.com/haskell-foundation/foundation/pull/503
3309 is fixed.
3311 * Clean up appveyor build and Windows package creation.
3312 We now use 64-bit stack and ghc 8.4.3, lts-12 for the 64-bit build. The
3313 WiX-based msi is now 64-bit for 64-bit builds (fixing #4795).
3315 * Remove obsolete RELEASE-CHECKLIST.md.
3317 * Added additional compiler warnings in Makefile and CI builds.
3319## pandoc 2.2.3.2 (2018-08-07)
3321 * Markdown reader: Properly handle boolean values in YAML metadata (#4819).
3322 This fixes a regression in 2.2.3, which cause boolean values to
3323 be parsed as MetaInlines instead of MetaBool.
3325 We here record another undocumented (but desirable) change in 2.2.3:
3326 numerical metadata fields are now parsed as MetaInlines rather than
3327 MetaString.
3329## pandoc 2.2.3.1 (2018-08-06)
3331 * Markdown reader: Fix parsing of embedded mappings in YAML metadata
3332 (#4817). This fixes a regression in 2.2.3 which caused embedded
3333 mappings (e.g. mappings in sequences) not to work in YAML metadata.
3335## pandoc 2.2.3 (2018-08-05)
3337 * RST reader: improve parsing of inline interpreted text roles (#4811).
3339 + Use a Span with class "title-reference" for the default
3340 title-reference role.
3341 + Use `B.text` to split up contents into `Space`s, `SoftBreak`s,
3342 and `Str`s for `title-reference`.
3343 + Use Code with class "interpreted-text" instead of Span and Str for
3344 unknown roles. (The RST writer has also been modified to round-trip
3345 this properly.)
3346 + Disallow blank lines in interpreted text.
3347 + Backslash-escape now works in interpreted text.
3348 + Backticks followed by alphanumerics no longer end interpreted text.
3349 + Remove support for nested inlines (Francesco Occhipinti).
3350 RST does not allow nested emphasis, links, or other inline
3351 constructs. This fixes several bugs (#4581, #4561, #4792).
3353 * Org reader: fix parsers relying on `parseFromString` (#4784, Albert
3354 Krewinkel). Emphasis was not parsed when it followed directly after
3355 some block types (e.g., lists).
3357 * Markdown reader: Allow unquoted numbers and booleans as YAML mapping
3358 keys. Previously in 2.2.2 you could not do
3359 ```
3360 ---
3361 0: bar
3362 ...
3363 ```
3364 but only
3365 ```
3366 ---
3367 '0': bar
3368 ...
3369 ```
3370 With this change, both forms work.
3372 * DocBook reader: metadata handling improvements.
3373 Now we properly parse title and subtitle elements that are direct
3374 children of book and article (as well as children of bookinfo,
3375 articleinfo, or info). We also now use the `subtitle` metadata
3376 field for subtitles, rather than tacking the subtitle on to the
3377 title.
3379 * RST writer:
3381 + Allow images to be directly nested within links (#4810, Francesco
3382 Occhipinti).
3383 + Use `titleblock` instead of `title` variable for title block (#4803,
3384 Francesco Occhipinti). `titleblock` contains a properly formatted
3385 title and subtitle (using top-level headers). `title` and
3386 `subtitle` variables are still available and just contain the
3387 title and subtitle text. Note that this change will require an
3388 update to custom rst templates.
3389 + Render Code with class "interpreted-text" as interpreted text role.
3391 * MediaWiki writer: Avoid extra blank line in tables with empty cells
3392 (#4794). Note that the old output is semantically identical, but the
3393 new output looks better.
3395 * Lua Utils module: add function `blocks_to_inlines` (#4799, Albert
3396 Krewinkel). Exposes a function converting which flattenes a list of
3397 blocks into a list of inlines. An example use case would be the
3398 conversion of Note elements into other inlines.
3400 * RST template: use `titleblock` instead of `title`. Users of
3401 custom RST templates will want to update this.
3403 * LaTeX template: Moved some beamer code in default.latex template.
3404 This change allows beamer themes to change the template and font (as
3405 Metropolis does) (#4450).
3407 * Better error message on `-t pdf -o out.pdf` (#1155, Mauro Bieg).
3409 * Added test case for #4669 to repository.
3411 * INSTALL.md: Fix broken link for cabal-install (#4806, ChanHoHo).
3413 * MANUAL.txt:
3415 + Add beamer info for slide backgrounds (#4802, John Muccigrosso).
3416 + Clarify when `csquotes` is used in LaTeX writer (#4514).
3417 + Add `commonmark` to list of output formats where `raw_tex` has an
3418 effect (see #4527).
3421## pandoc 2.2.2.1 (2018-07-19)
3423 * Fix regression finding templates in user data directory (#4777).
3424 Under version 2.2.1 and prior pandoc found latex templates in the
3425 templates directory under the data directory, but this broke in 2.2.2.
3427 * Fix for bug in parsing `\input` in `rawLaTeXBlock` and
3428 `rawLaTeXInline` (#4781). (This primarily affects the markdown
3429 reader, and other readers that accept raw tex.)
3430 Starting in 2.2.2, everything after an `\input` (or `\include`)
3431 in a markdown file would be parsed as raw LaTeX.
3433 * MANUAL:
3435 + Clarify `gfm` vs `markdown_github` (#4783, Mauro Bieg).
3436 * Use `keywords` instead of `tags` in YAML metadata example (#4779).
3437 Unlike `tags`, `keywords` is used in some of the writers
3438 and default templates.
3440 * Add missing `rollingLinks` option to revealjs template (#4778,
3441 Igor Khorlo).
3443## pandoc 2.2.2 (2018-07-16)
3445 * Use HsYAML instead of yaml for translations and YAML metadata (#4747).
3446 yaml wraps a C library; HsYAML is pure Haskell. Advances #4535.
3448 Note: HsYAML implements YAML 1.2, in which the valid true
3449 values are `true`, `True`, `TRUE`. This means a change in
3450 the semantics of YAML metadata that could affect users:
3451 `y`, `yes`, and `on` no longer count as true values.
3453 * Fix regression: make `--pdf-engine` work with full paths (#4681, Mauro
3454 Bieg).
3456 * CommonMark reader: Handle `ascii_identifiers` extension (#4742,
3457 Anders Waldenborg). Non-ascii characters were not stripped from
3458 identifiers even if the `ascii_identifiers` extension was
3459 enabled (which is is by default for gfm).
3461 * TikiWiki reader: Improve list parsing (#4722, Mauro Bieg).
3462 Remove trailing Space from list items. Parse lists that have no space
3463 after marker.
3465 * LaTeX reader:
3467 + Treat `lilypond` as a verbatim environment (#4725).
3468 + Parse figure label into Image id (#4700, Mauro Bieg).
3469 + Beamer: Allow "noframenumbering" option (#4696, Raymond Ehlers).
3470 + Allow spaces around `\graphicspath` arguments (#4698).
3471 + Handle includes without surrounding blanklines (#4553).
3472 In addition, `\input` can now be used in an inline context,
3473 e.g. to provide part of a paragraph, as it can in LaTeX.
3474 + In `rawLaTeXBlock`, handle macros that resolve to a
3475 `\begin` or `\end` (#4667).
3476 + In `rawLaTeXBlock`, don't expand macros in macro definitions (#4653).
3477 Note that this only affected LaTeX in markdown.
3478 + Tighten up reading of beamer overlay specifications (#4669).
3479 Ideally we'd turn these on only when reading beamer, but currently
3480 beamer is not distinguished from latex as an input format.
3481 This commit also activates parsing of overlay specifications
3482 after commands in general (e.g. `\item`), since they can occur
3483 in many contexts in beamer.
3484 + Parse more siunitx unit commands (#4296, #4773).
3485 + Be more forgiving in key/value option parsing (#4761).
3487 * Markdown reader:
3489 + Allow empty code spans, e.g. `` ` ` ``.
3490 + Emojis are now wrapped in Spans with class `emoji` and
3491 attribute `data-emoji` (Anders Waldenborg, #4743).
3492 This allows the writer to handle them in a special way
3493 (e.g. using a special font, or just rendering the
3494 emoji name).
3496 * Muse reader (Alexander Krotov, except where indicated):
3498 + Get rid of non-exhaustive pattern match warning (Mauro Bieg).
3499 + Add support for floating images.
3500 + Add support for images with specified width.
3501 + Parse image URLs without "guard" and "takeExtension".
3502 + Split link and image parsing into separate functions.
3503 + Parse links starting with "URL:" explicitly instead of trying to strip
3504 "URL:" prefix after parsing.
3506 * Texinfo writer: Use `@sup` and `@sub` instead of custom macros (#4728,
3507 Alexander Krotov).
3509 * Markdown writer: Preserve `implicit_figures` with attributes, even if
3510 `implicit_attributes` is not set, by rendering in raw HTML (#4677).
3512 * Markdown and commonmark/github writers now respect the `emoji`
3513 extension. So, `-f markdown+emoji -t markdown+emoji` now leaves
3514 `:smile:` as `:smile:` rather than converting it to a smile
3515 character.
3517 * Docx writer: Be sensitive to `toc` in YAML metadata (#4645).
3519 * ODT/OpenDocument writer: Make internal links work (#4358).
3520 This adds proper bookmarks to the headers with non-null IDs.
3522 * EPUB writer: Properly escape pagetitle. Previously we weren't
3523 escaping `&` and other XML characters in the pagetitle, so a title
3524 containing a `&` would be invalid.
3526 * AsciiDoc Writer: Eescape square brackets at start of line (#4545,
3527 Mauro Bieg).
3529 * RST writer:
3531 + Don't treat 'example' as a syntax name (#4748).
3532 This fixes conversions from org with example blocks.
3533 + Support `--number-sections` via the `section-numbering`
3534 directive in standalone output.
3536 * reveal.js writer and template: reuse mathjax URL
3537 provided by the argument to `--mathjax` or the normal pandoc default,
3538 rather than a hard-coded one in the template (#4701).
3540 * LaTeX writer:
3542 + Properly handle footnotes in table captions (#4683).
3543 Refactored code from figure captions to use in both places.
3544 + In beamer output, fix single digit column percentage (#4690, Mauro
3545 Bieg).
3547 * FB2 writer (Alexander Krotov):
3549 + Convert Plain to Para in annotation (#2424).
3550 + Fix order of items in title-info (#2424).
3552 * Custom writer: fix error message on script failure (Albert Krewinkel).
3553 Error messages produced by Lua were not displayed by Pandoc.
3555 * Text.Pandoc.Emoji now exports `emojiToInline`, which returns a Span
3556 inline containing the emoji character and some attributes with metadata
3557 (class `emoji`, attribute `data-emoji` with emoji name). (API change,
3558 Anders Waldenborg, #4743).
3560 * Text.Pandoc.PDF:
3562 + Revert fix for #4484 (only compress images on last run, #4755).
3563 This will mean some increase in the time it takes to
3564 produce an image-heavy PDF with xelatex, but it will
3565 make tables of contents correct, which is more important.
3566 + Fix logic error in `runTeXProgram`. We were running the tex program
3567 one more time than requested. This should speed up PDF production.
3569 * Allow `--template` to take a URL as argument.
3571 * Text.Pandoc.Highlighting: Add missing re-export of `breezeDark`
3572 highlighting style (#4687, Adrian Sieber, API change).
3574 * Clarify macOS install in INSTALL.md (#4661). Make the binary package
3575 installer the recommended method, and note that on some older versions of
3576 macOS, homebrew installs from source and takes a lot of disk space
3577 (#4664, Ian).
3579 * MANUAL:
3581 + Clarify EPUB linked media (#4756, Mauro Bieg)
3582 + Update manual for "true" YAML values. Now that we're using HsYAML and
3583 YAML 1.2, the valid true values are `true`, `True`, `TRUE`. NOTE!
3584 `y`, `yes`, `on` no longer count as true values.
3585 + Document `-F` as alias for `--filter` (thanks to Gandalf Saxe).
3586 + Update manual on how math is rendered in LaTeX.
3587 + Add proxy description (#4131, Mauro Bieg).
3588 + Clarify that `--toc` requires `--standalone` (#4703).
3589 + Update citation styles link (#4699, wiefling).
3591 * In API docs, clarify how `Ext_east_asian_line_breaks` extension works
3592 (kaizshang91). Note that it will not take effect when readers/writers
3593 are called as libraries (#4674).
3595 * Improved translations/fr (#4766, lux-lth).
3597 * Removed inadvertently added `.orig` files from repository (#4648).
3599 * Remove `network-uri` flag and use 'Network.Socket'.
3600 This removes a compiler warning. There is no need for the old
3601 `network-uri` flag, since network 2.6 was released in 2014.
3603 * Add stack.lts10.yaml, stack.lts11.yaml. use lts-12 in stack.yaml.
3605 * Bump upper bounds for dependent packages.
3607 * Exclude foundation 0.0.21 for ghc 7.10. Otherwise cabal gets
3608 confused because of the way ghc 7.10 is excluded in foundation's
3609 cabal file. This can be removed when haskell-foundation/foundation#500
3610 is fixed.
3612 * Require cabal-version >= 2.0. This is needed for haddock-library.
3617## pandoc 2.2.1 (2018-05-10)
3619 * Restored and undeprecated gladtex for HTML math (#4607).
3621 + Added `GladTeX` constructor to `Text.Pandoc.Options.HTMLMathMethod`
3622 [API change, reverts removal in v2.2]
3623 + Restored and undeprecated `--gladtex` option, removed in v2.2.
3625 * LaTeX reader: Handle `$` in `/text{..}` inside math (#4576).
3627 * Org reader: Fix image filename recognition (Albert Krewinkel).
3628 Use a function from the filepath library to check whether a string is a
3629 valid file name. The custom validity checker that was used before gave
3630 wrong results (e.g. for absolute file paths on Windows,
3631 kawabata/ox-pandoc#52).
3633 * FB2 reader: Replace some errors with warnings (Alexander Krotov).
3635 * HTML writer:
3637 + Strip links from headers when creating TOC (#4340).
3638 Otherwise the TOC entries will not link to the sections.
3639 + Fix regression with tex math environments in HTML + MathJax (#4639).
3641 * Muse writer (Alexander Krotov): Add support for left-align and
3642 right-align classes (#4542).
3644 * Docx writer: Support underline (#4633).
3646 * Text.Pandoc.Parsing: Lookahead for non-whitespace after
3647 `singleQuoteStart` and `doubleQuoteStart` (#4637).
3649 * `test-pandoc-utils.lua`: more robust testing on both windows
3650 and \*nix. Previously the pipe tests were only run if
3651 `\bin/false` and `/bin/sed` were present, which they aren't
3652 in default MacOS and Windows systems. Fixed by using `tr`
3653 and `false`, which should always be in the path on a \*nix
3654 system, and `find` and `echo` for Windows.
3656 * Text.Pandoc.Shared: add `uriPathToPath`.
3657 This adjusts the path from a file: URI in a way that is sensitive
3658 to Windows/Linux differences. Thus, on Windows,
3659 `/c:/foo` gets interpreted as `c:/foo`, but on Linux,
3660 `/c:/foo` gets interpreted as `/c:/foo`. See #4613.
3662 * Use `uriPathToPath` with file: URIs (#4613).
3664 * Revert piping HTML to pdf-engine (Mauro Bieg, #4413). Use a temp
3665 file as before.
3667 * Text.Pandoc.Class: Catch IO errors when writing media files
3668 and issue a warning, rather than an error (Francesco Occhipinti, #4559).
3670 * Don't lowercase custom writer filename (Alexander Krotov, #4610).
3672 * MANUAL (Mauro Bieg):
3674 + Clarify truthiness in template variables (#2281).
3675 + Clarify pipe table width calculation (#4520).
3677 * ConTeXt template: New Greek fallback typeface (Pablo Rodríguez, #4405).
3678 CMU Serif gives better typographic results than the previous
3679 Greek fallback DejaVu Serif.
3681 * Make HTML template polyglot (#4606, OvidiusCicero), by making
3682 `<link rel="stylesheet" href="$css$">` self-closing.
3684 * Use texmath 0.11, allowing better translation of non-ASCII
3685 characters in math (#4642).
3688## pandoc 2.2 (2018-04-27)
3690 * New input format: `fb2` (FictionBook2) (Alexander Krotov).
3692 * Make `--ascii` work for all XML formats (ICML, OPML, JATS,...),
3693 and for `ms` and `man`.
3695 * Remove deprecated `--latexmathml`, `--gladtex`, `--mimetex`, `--jsmath`, `-m`,
3696 `--asciimathml` options.
3698 * New module Text.Pandoc.Readers.FB2, exporting readFB2 (Alexander
3699 Krotov, API change).
3701 * Markdown reader:
3703 + Allow empty key-value attributes, like `title=""` (#2944).
3704 + Handle table w/o following blank line in fenced div (#4560).
3705 + Remove "fallback" for `doubleQuote` parser. Previously the
3706 parser tried to be efficient -- if no end double quote was found,
3707 it would just return the contents. But this could backfire in a
3708 case `**this should "be bold**`, since the fallback would return
3709 the content `"be bold**` and the closing boldface delimiter
3710 would never be encountered.
3711 + Improve computation of the relative width of the last column in a
3712 multiline table, so we can round-trip tables without constantly
3713 shrinking the last column.
3715 * EPUB reader:
3717 + Fix images with space in file path (#4344).
3719 * LaTeX reader:
3721 + Properly resolve section numbers with `\ref` and chapters (#4529).
3722 + Parse sloppypar environment (#4517, Marc Schreiber).
3723 + Improve handling of raw LaTeX (for markdown etc.) (#4589, #4594).
3724 Previously there were some bugs in how macros were handled.
3725 + Support `\MakeUppercase`, `\MakeLowercase`, `\uppercase`,
3726 `\lowercase`, and also `\MakeTextUppercase` and
3727 `\MakeTextLowercase` from textcase (#4959).
3729 * Textile reader:
3731 + Fixed tables with no body rows (#4513).
3732 Previously these raised an exception.
3734 * Mediawiki reader:
3736 + Improve table parsing (#4508). This fixes detection of table
3737 attributes and also handles `!` characters in cells.
3739 * DocBook reader:
3741 + Properly handle title in `section` element (#4526).
3742 Previously we just got `section_title` for `section` (though `sect1`,
3743 `sect2`, etc. were handled properly).
3744 + Read tex math as output by asciidoctor (#4569, Joe Hermaszewski).
3746 * Docx reader:
3748 + Combine adjacent CodeBlocks with the same attributes into
3749 a single CodeBlock. This prevents a multiline codeblock in
3750 Word from being read as different paragraphs.
3752 * RST reader:
3754 + Allow < 3 spaces indent under directives (#4579).
3755 + Fix anonymous redirects with backticks (#4598).
3757 * Muse reader (Alexander Krotov):
3759 + Add support for Text::Amuse multiline headings.
3760 + Add `<math>` tag support.
3761 + Add support for `<biblio>` and `<play>` tags.
3762 + Allow links to have empty descriptions.
3763 + Require block `<literal>` tags to be on separate lines.
3764 + Allow `-` in anchors.
3765 + Allow verse to be indented.
3766 + Allow nested footnotes.
3767 + Internal improvements.
3769 * Muse writer (Alexander Krotov):
3771 + Escape `>` only at the beginning of a line.
3772 + Escape `]` in image title.
3773 + Escape `]` brackets in URLs as `%5D`.
3774 + Only escape brackets when necessary.
3775 + Escape ordered list markers.
3776 + Do not escape list markers unless preceded by space.
3777 + Escape strings starting with space.
3778 + Escape semicolons and markers after line break.
3779 + Escape `;` to avoid accidental comments.
3780 + Don't break headers, line blocks and tables with line breaks.
3781 + Correctly output empty headings.
3782 + Escape horizontal rule only if at the beginning of the line.
3783 + Escape definition list terms starting with list markers.
3784 + Place header IDs before header.
3785 + Improve span writing.
3786 + Do not join Spans in normalization.
3787 + Don't align ordered list items.
3788 + Remove key-value pairs from attributes before normalization.
3789 + Enable `--wrap=preserve` for all tests by default.
3790 + Reduced `<verbatim>` tags in output.
3791 + Internal changes.
3793 * RST writer:
3795 + Use more consistent indentation (#4563). Previously we
3796 used an odd mix of 3- and 4-space indentation. Now we use 3-space
3797 indentation, except for ordered lists, where indentation must
3798 depend on the width of the list marker.
3799 + Flatten nested inlines (#4368, Francesco Occhipinti).
3800 Nested inlines are not valid RST syntax, so we flatten them following
3801 some readability criteria discussed in #4368.
3803 * EPUB writer:
3805 + Ensure that `pagetitle` is always set, even when structured titles
3806 are used. This prevents spurious warnings about empty title
3807 elements (#4486).
3809 * FB2 writer (Alexander Krotov):
3811 + Output links inline instead of producing notes. Previously all links
3812 were turned into footnotes with unclickable URLs inside.
3813 + Allow emphasis and notes in titles.
3814 + Don't intersperse paragraph with empty lines.
3815 + Convert metadata value `abstract` to book annotation.
3816 + Use `<empty-line />` for `HorizontalRule` rather than `LineBreak`.
3817 FB2 does not have a way to represent line breaks inside paragraphs;
3818 previously we used `<empty-line />` elements, but these are not allowed
3819 inside paragraphs.
3821 * Powerpoint writer (Jesse Rosenthal):
3823 + Handle Quoted Inlines (#4532).
3824 + Simplify code with `ParseXml`.
3825 + Allow fallback options when looking for placeholder type.
3826 + Check reference-doc for all layouts.
3827 + Simplify speaker notes logic.
3828 + Change notes state to a simpler per-slide value.
3829 + Remove `Maybe` from `SpeakerNotes` in `Slide`. `mempty`
3830 means no speaker notes.
3831 + Add tests for improved speaker notes.
3832 + Handle speaker notes earlier in the conversion process.
3833 + Keep notes with related blocks (#4477). Some blocks automatically
3834 split slides (imgs, tables, `column` divs). We assume that any
3835 speaker notes immediately following these are connected to these
3836 elements, and keep them with the related blocks, splitting after them.
3837 + Remove `docProps/thumbnail.jpeg` in data dir (Jesse Rosenthal, #4588).
3838 It contained a nonfree ICC color calibration profile and is not needed
3839 for production of a powerpoint document.
3841 * Markdown writer:
3843 + Include a blank line at the end of the row in a single-row multiline
3844 table, to prevent it from being interpreted as a simple table (#4578).
3846 * CommonMark writer:
3848 + Correctly ignore LaTeX raw blocks when `raw_tex` is not
3849 enabled (#4527, quasicomputational).
3851 * EPUB writer:
3853 + Add `epub:type="footnotes"` to notes section in EPUB3 (#4489).
3855 * LaTeX writer:
3857 + In beamer, don't use format specifier for default ordered lists
3858 (#4556). This gives better results for styles that put ordered list
3859 markers in boxes or circles.
3860 + Update `\lstinline` delimiters (#4369, Tim Parenti).
3862 * Ms writer:
3864 + Use `\f[R]` rather than `\f[]` to reset font (#4552).
3865 + Use `\f[BI]` and `\f[CB]` in headers, instead of `\f[I]` and `\f[C]`,
3866 since the header font is automatically bold (#4552).
3867 + Use `\f[CB]` rather than `\f[BC]` for monospace bold (#4552).
3868 + Create pdf anchor for a Div with an identifier (#4515).
3869 + Escape `/` character in anchor ids (#4515).
3870 + Improve escaping for anchor ids: we now use _uNNN_ instead of uNNN
3871 to avoid ambiguity.
3873 * Man writer:
3875 + Don't escape U+2019 as `'` (#4550).
3877 * Text.Pandoc.Options:
3879 + Removed `JsMath`, `LaTeXMathML`, and `GladTeX` constructors from
3880 `Text.Pandoc.Options.HTMLMathMethod` [API change].
3882 * Text.Pandoc.Class:
3884 + `writeMedia`: unescape URI-escaping in file path. This avoids
3885 writing things like `file%20one.png` to the file system.
3887 * Text.Pandoc.Parsing:
3889 + Fix `romanNumeral` parser (#4480). We previously accepted 'DDC'
3890 as 1100.
3891 + `uri`: don't treat `*` characters at end as part of URI (#4561).
3893 * Text.Pandoc.MIME:
3895 + Use the alias `application/eps` for EPS (#2067).
3896 This will ensure that we retain the eps extension after reading the
3897 image into a mediabag and writing it again.
3899 * Text.Pandoc.PDF:
3901 + Use `withTempDir` in `html2pdf`.
3902 + With `xelatex`, don't compress images til the last run (#4484).
3903 This saves time for image-heavy documents.
3904 + Don't try to convert EPS files (#2067). `pdflatex` converts them
3905 itself, and JuicyPixels can't do it.
3906 + For `pdflatex`, use a temp directory in the working directory.
3907 Otherwise we can have problems with the EPS conversion pdflatex
3908 tries to do, which can't operate on a file above the working
3909 directory without `--shell-escape`.
3911 * Changes to tests to accommodate changes in pandoc-types.
3912 In <https://github.com/jgm/pandoc-types/pull/36> we changed
3913 the table builder to pad cells. This commit changes tests
3914 (and two readers) to accord with this behavior.
3916 * Set default extensions for `beamer` same as `latex`.
3918 * LaTeX template:
3920 + Add `beameroption` variable (#4359, Étienne Bersac).
3921 + Use `pgfpages` package; this is needed for notes on second
3922 screen in beamer (Étienne Bersac).
3923 + Add `background-image` variable (#4601, John Muccigrosso).
3925 * reveal.js template: Add `background-image` variable (#4600,
3926 John Muccigrosso).
3928 * ms template: Fix date. Previously `.ND` was used, but this only
3929 works if you have a title page, which we don't. Thanks to @teoric.
3931 * Removed pragmas for unused extensions (#4506, Anabra).
3933 * Fix bash completion for `--print-default-data-file` (#4549).
3934 Previously this looked in the filesystem, even if pandoc
3935 was compiled with `embed_data_files` (and sometimes it looked
3936 in a nonexistent build directory). Now the bash completion
3937 script just includes a hard-coded list of data file names.
3939 * MANUAL:
3941 + Clarify template vs metadata variables (#4501, Mauro Bieg).
3942 + Fix raw content example (#4479, Mauro Bieg).
3943 + Specify that you use html for raw output in epub.
3944 + Add examples for raw docx blocks (#4472, Tristan Stenner).
3945 The documentation states that the target format name should match
3946 the output format, which isn't the case for `docx`/`openxml` and
3947 some others.
3948 + Don't say that `empty_paragraphs` affects markdown output (#4540).
3949 + Consolidate input/output format documentation (#4577, Mauro Bieg).
3951 * New README template. Take in/out formats from manual.
3953 * Fix example in lua-filters docs (#4459, HeirOfNorton).
3955 * Use the `-threaded` GHC flag when building benchmarks (#4587,
3956 Francesco Occhipinti).
3958 * Bump temporary upper bound to 1.4.
3960 * Use pandoc-citeproc 0.14.3.1.
3962 * Use texmath-0.10.1.2 (fixes escapes in math in ms, #4597).
3964 * Removed old lib directory. This was used for something long ago,
3965 but plays no role now.
3967 * Removed unneeded data file `LaTeXMathML.js`.
3969 * Create 64- and 32-bit versions of Windows binary packages.
3971## pandoc 2.1.3 (2018-03-18)
3973 * Docx reader (Jesse Rosenthal):
3975 + Add tests for nested smart tags.
3976 + Parse nested smart tags.
3977 + Make unwrapSDT into a general `unwrap` function that can unwrap both
3978 nested SDT tags and smartTags. This makes the SmartTags constructor in
3979 the Docx type unnecessary, so we remove it (#4446).
3980 + Remove unused `docxWarnings` (Alexander Krotov).
3982 * RST reader: Allow unicode bullet characters (#4454).
3984 * Haddock reader: Better table handling, using haddock-library's
3985 new table support, if compiled against a version that
3986 includes it. Note that tables with col/rowspans will not
3987 translate well into Pandoc.
3989 * Muse reader (Alexander Krotov):
3991 + Various internal improvements.
3992 + Require closing tag to have the same indentation as opening.
3993 + Do not reparse blocks inside unclosed block tag (#4425).
3994 + Parse `<class>` tag (supported by Emacs Muse).
3995 + Do not produce empty Str element for unindented verse lines.
3997 * LaTeX reader:
3999 + Add support to parse unit string of `\SI` command (closes #4296,
4000 Marc Schreiber).
4002 * Haddock writer: In the writer, we now render tables always as
4003 grid tables, since Haddock supports these.
4005 * DokuWiki writer: rewrite backSlashLineBreaks (#4445, Mauro Bieg).
4007 * Docx writer: Fixed formatting of `DefaultStyle` ordered lists in
4008 docx writer. We want decimal for the top level, not lower roman.
4010 * RST writer:
4012 + Strip whitespace at beginning and ending of inline containers
4013 (#4327, Francesco Occhipinti).
4014 + Filter out empty inline containers (#4434). There is nothing in
4015 RST that corresponds to e.g. `Emph []`, so we just ignore elements
4016 like this (Francesco Occhipinti).
4018 * Muse writer (Alexander Krotov):
4020 + Support spans with anchors.
4021 + Replace smallcaps with emphasis before normalization.
4022 + Output smallcaps as emphasis.
4023 + Expand Cite before list normalization.
4024 + Write empty inline lists as `<verbatim></verbatim>`.
4025 + Remove empty Str from the beginning of inline lists during normalization.
4026 + Escape "-" to avoid creating bullet lists.
4027 + Fix math expansion for more than one expression per paragraph.
4028 + Expand math before inline list normalization.
4030 * Dokuwiki writer: fix LineBreaks in Tables (#4313, Mauro Bieg).
4032 * Ms writer:
4034 + Asciify pdf anchors, since unicode anchors don't work (#4436).
4035 Internal links should be converted automatically, so this shouldn't
4036 affect users directly.
4037 + Don't escape hyphens as `\-`; that's for a minus sign (#4467).
4039 * Beamer writer: put hyperlink after `\begin{frame}` and not in the title
4040 (#4307). If it's in the title, then we get a titlebar on slides with
4041 the `plain` attribute, when the id is non-null. This fixes a regression
4042 in 2.0.
4044 * EPUB writer: Remove notes from TOC in nav.xhtml (#4453, Mauro Bieg).
4046 * JATS writer: Remove extraneous, significant whitespace (#4335,
4047 Nokome Bentley).
4049 * html2pdf: inject base tag with current working directory (#4413, Mauro
4050 Bieg). This helps ensure that linked resources are included.
4052 * Add Semigroup instances for everything for which we defined a
4053 Monoid instance previously (API change):
4055 + Text.Pandoc.Class.FileTree.
4056 + Text.Pandoc.Translations.Translations.
4057 + Text.Pandoc.Extensions.Extensions.
4058 + Text.Pandoc.Readers.Odt.StyleReader.Styles.
4059 + Text.Pandoc.Pretty.Doc.
4060 + Text.Pandoc.MediaBag.MediaBag.
4062 * Add custom Prelude to give clean code for Monoid and Semigroup
4063 that works with ghc 7.10-8.4. The custom Prelude (`prelude/Prelude`)
4064 is used for ghc versions < 8.4. `NoImplicitPrelude` is used
4065 in all source files, and Prelude is explicitly imported
4066 (this is necessary for ghci to work properly with the custom prelude).
4068 * Text.Pandoc.Writers.Shared (Francesco Occhipinti):
4070 + Export `stripLeadingTrailingSpace`.
4071 + Don't wrap lines in grid tables when `--wrap=none` (#4320).
4072 + `gridTable`: Don't wrap lines in tables when `--wrap=none`. Instead,
4073 expand cells, even if it results in cells that don't respect relative
4074 widths or surpass page column width. This change affects RST,
4075 Markdown, and Haddock writers.
4077 * Raise error if someone tries to print docx, odt, etc. template (#4441).
4079 * LaTeX template: Provide `bidi` package's option using
4080 `\PassOptionsToPackage` (#4357, Václav Haisman). This avoid a
4081 clash when `polyglossia` loads it first and then it is loaded again
4082 for XeLaTeX.
4084 * ConTeXt template: Added `pdfa` variable to generate PDF/A (#4294, Henri
4085 Menke). Instructions on how to install the ICC profiles on ConTeXt
4086 standalone can be found in the wiki:
4087 <http://wiki.contextgarden.net/PDFX#ICC_profiles>.
4088 If the ICC profiles are not available the log will contain error
4089 messages.
4091 * Use latest pandoc-types, skylighting
4093 * Use latest pandoc-citeproc in binary package.
4095 * Bump upper bound for time, criterion, haddock-library, exceptions,
4096 http-types, aeson, haddock-library.
4098 * Bump upper bound tasty-quickcheck 0.10 (#4429, Felix Yan).
4100 * pandoc.cabal: fix up other-extensions and language fields.
4101 Language is now consistently `Haskell2010`, and other-extensions
4102 is consistently `NoImplicitPrelude`. Everything else to be specified
4103 in the module header as needed.
4105 * Removed `old-locale` flag and Text.Pandoc.Compat.Time.
4106 This is no longer necessary since we no longer support ghc 7.8.
4108 * Make `weigh-pandoc` into a benchmark program.
4109 Remove `weigh-pandoc` flag. `weigh-pandoc` is now built (and run)
4110 automatically when you build (and run) benchmarks.
4112 * MANUAL: add instructions for background images reveal.js (#4325, John
4113 Muccigrosso).
4115 * appveyor: use VS 2013 environment instead of VS 2015 for Windows builds.
4117## pandoc 2.1.2 (2018-03-02)
4119 * Markdown reader:
4121 + Fix parsing bug with nested fenced divs (#4281). Previously we allowed
4122 "nonindent spaces" before the opening and closing `:::`, but this
4123 interfered with list parsing, so now we require the fences to be flush with
4124 the margin of the containing block.
4126 * Commonmark reader:
4128 + `raw_html` is now on by default. It can be disabled explicitly
4129 using `-f commonmark-raw_html`.
4131 * Org reader (Albert Krewinkel):
4133 + Move citation tests to separate module.
4134 + Allow changing emphasis syntax (#4378). The characters allowed before
4135 and after emphasis can be configured via `#+pandoc-emphasis-pre` and
4136 `#+pandoc-emphasis-post`, respectively. This allows to change which
4137 strings are recognized as emphasized text on a per-document or even
4138 per-paragraph basis. Example:
4140 #+pandoc-emphasis-pre: "-\t ('\"{"
4141 #+pandoc-emphasis-post: "-\t\n .,:!?;'\")}["
4143 * LaTeX reader:
4145 + Fixed comments inside citations (#4374).
4146 + Fix regression in package options including underscore (#4424).
4147 + Make `--trace` work.
4148 + Fixed parsing of `tabular*` environment (#4279).
4150 * RST reader:
4152 + Fix regression in parsing of headers with trailing space (#4280).
4154 * Muse reader (Alexander Krotov):
4156 + Enable `<literal>` tags even if amuse extension is enabled.
4157 Amusewiki disables <literal> tags for security reasons.
4158 If user wants similar behavior in pandoc, RawBlocks and RawInlines
4159 can be removed or replaced with filters.
4160 + Remove space prefix from `<literal>` tag contents.
4161 + Do not consume whitespace while looking for closing end tag.
4162 + Convert alphabetical list markers to decimal in round-trip test.
4163 Alphabetical lists are an addition of Text::Amuse.
4164 They are not present in Emacs Muse and can be ambiguous
4165 when list starts with "i.", "c." etc.
4166 + Allow `<quote>` and other tags to be indented.
4167 + Allow single colon in definition list term.
4168 + Fix parsing of verse in lists.
4169 + Improved parsing efficiency. Avoid `parseFromString`.
4170 Lists are parsed in linear instead of exponential time now.
4171 + Replace ParserState with MuseState.
4172 + Prioritize lists with roman numerals over alphabetical lists.
4173 This is to make sure "i." starts a roman numbered list,
4174 instead of a list with letter "i" (followed by "j", "k", ...").
4175 + Fix directive parsing.
4176 + Parse definition lists with multiple descriptions.
4177 + Parse next list item before parsing more item contents.
4178 + Fixed a bug: headers did not terminate lists.
4179 + Move indentation parsing from `definitionListItem` to `definitionList`.
4180 + Paragraph indentation does not indicate nested quote.
4181 Muse allows indentation to indicate quotation or alignment,
4182 but only on the top level, not within a <quote> or list.
4183 + Require that block tags are on separate lines.
4184 Text::Amuse already explicitly requires it anyway.
4185 + Fix matching of closing inline tags.
4186 + Various internal changes.
4187 + Fix parsing of nested definition lists.
4188 + Require only one space for nested definition list indentation.
4189 + Do not remove trailing whitespace from `<code>`.
4190 + Fix parsing of trailing whitespace. Newline after whitespace now
4191 results in softbreak instead of space.
4193 * Docx reader (Jesse Rosenthal, except where noted):
4195 + Handle nested sdt tags (#4415).
4196 + Don't look up dependant run styles if `+styles` is enabled.
4197 + Move pandoc inline styling inside custom-style span.
4198 + Read custom styles (#1843). This will read all paragraph and
4199 character classes as divs and spans, respectively. Dependent styles
4200 will still be resolved, but will be wrapped with appropriate style
4201 tags. It is controlled by the `+styles` extension (`-f docx+styles`).
4202 This can be used in conjunction with the `custom-style` feature in the
4203 docx writer for a pandoc-docx editing workflow. Users can convert from
4204 an input docx, reading the custom-styles, and then use that same input
4205 docx file as a reference-doc for producing an output docx file. Styles
4206 will be maintained across the conversion, even if pandoc doesn't
4207 understand them.
4208 + Small change to Fields hyperlink parser. Previously, unquoted string
4209 required a space at the end of the line (and consumed it). Now we
4210 either take a space (and don't consume it), or end of input.
4211 + Pick table width from the longest row or header (Francesco Occhipinti,
4212 #4360).
4214 * Muse writer (Alexander Krotov):
4216 + Change verse markup: `> ` instead of `<verse>` tag.
4217 + Remove empty strings during inline normalization.
4218 + Don't indent nested definition lists.
4219 + Use unicode quotes for quoted text.
4220 + Write image width specified in percent in Text::Amuse mode.
4221 + Don't wrap displayMath into `<verse>`.
4222 + Escape nonbreaking space (`~~`).
4223 + Join code with different attributes during normalization.
4224 + Indent lists inside Div.
4225 + Support definitions with multiple descriptions.
4227 * Powerpoint writer (Jesse Rosenthal):
4229 + Use table styles This will use the default table style in the
4230 reference-doc file. As a result they will be easier when using
4231 in a template, and match the color scheme.
4232 + Remove empty slides. Because of the way that slides were split, these
4233 could be accidentally produced by comments after images. When animations
4234 are added, there will be a way to add an empty slide with either
4235 incremental lists or pauses.
4236 + Implement syntax highlighting. Note that background colors can't
4237 be implemented in PowerPoint, so highlighting styles that require
4238 these will be incomplete.
4239 + New test framework for pptx. We now compare the output of the
4240 Powerpoint writer with files that we know to (a) not be corrupt,
4241 and (b) to show the desired output behavior (details below).
4242 + Add `notesMaster` to `presentation.xml` if necessary.
4243 + Ignore links and (end)notes in speaker notes.
4244 + Output speaker notes.
4245 + Read speaker note templates conditionally. If there are speaker
4246 notes in the presentation, we read in the notesMasters templates
4247 from the reference pptx file.
4248 + Fix deletion track changes (#4303, Jesse Rosenthal).
4250 * Markdown writer: properly escape @ to avoid capture as citation
4251 (#4366).
4253 * LaTeX writer:
4255 + Put hypertarget inside figure environment (#4388).
4256 This works around a problem with the endfloat package and
4257 makes pandoc's output compatible with it.
4258 + Fix image height with percentage (#4389). This previously caused
4259 the image to be resized to a percentage of textwidth, rather than
4260 textheight.
4262 * ConTeXt writer (Henri Menke):
4264 + New section syntax and support `--section-divs` (#2609).
4265 `\section[my-header]{My Header}` ->
4266 `\section[title={My Header},reference={my-header}]`.
4267 The ConTeXt writer now supports the `--section-divs` option to
4268 write sections in the fenced style, with `\startsection` and
4269 `\stopsection`.
4270 + xtables: correct wrong usage of caption (Henri Menke).
4272 * Docx writer:
4274 + Fix image resizing with multiple images (#3930, Andrew Pritchard).
4275 + Use new golden framework (Jesse Rosenthal).
4276 + Make more deterministic to facilitate testing (Jesse Rosenthal).
4277 - `getUniqueId` now calls to the state to get an incremented digit,
4278 instead of calling to P.uniqueHash.
4279 - we always start the PRNG in mkNumbering/mkAbstractNum with the same
4280 seed (1848), so our randoms should be the same each time.
4281 + Fix ids in comment writing (Jesse Rosenthal). Comments from
4282 `--track-changes=all` were producing corrupt docx, because the
4283 writer was trying to get id from the `(ID,_,_)` field of
4284 the attributes, and ignoring the "id" entry in the key-value pairs. We
4285 now check both.
4287 * Ms writer: Added papersize variable.
4289 * TEI writer:
4291 + Use `height` instead of `depth` for images (#4331).
4292 + Ensure that id prefix is always used.
4293 + Don't emit `role` attribute; that was a leftover from the
4294 Docbook writer.
4295 + Use 'xml:id', not 'id' attribute (#4371).
4297 * AsciiDoc writer:
4299 + Do not output implicit heading IDs (#4363, Alexander
4300 Krotov). Convert to `asciidoc-auto_identifiers` for old behaviour.
4302 * RST writer:
4304 + Remove `blockToRST'` moving its logic into `fixBlocks`
4305 (Francesco Occhipinti).
4306 + Insert comment between lists and quotes (#4248, Francesco Occchipinti).
4308 * RST template: remove definition of 'math' role as raw.
4309 This used to be needed prior to v 0.8 of docutils, but
4310 now math support is built-in.
4312 * Slides: Use divs to set incremental/non-incremental (#4381,
4313 Jesse Rosenthal). The old method (list inside blockquote) still
4314 works, but we are encouraging the use of divs with class
4315 `incremental` or `nonincremental`.
4317 * Text.Pandoc.ImageSize:
4319 + Make image size detection for PDFs more robust (#4322).
4320 + Determine image size for PDFs (#4322).
4321 + EMF Image size support (#4375, Andrew Pritchard).
4323 * Text.Pandoc.Extensions:
4325 + Add `Ext_styles` (Jesse Rosenthal, API change). This will be used in
4326 the docx reader (defaulting to off) to read pargraph and character
4327 styles not understood by pandoc (as divs and spans, respectively).
4328 + Made `Ext_raw_html` default for `commonmark` format.
4330 * Text.Pandoc.Parsing:
4332 + Export `manyUntil` (Alexander Krotov, API change).
4333 + Export improved `sepBy1` (Alexander Krotov).
4334 + Export list marker parsers: `upperRoman`, `lowerRoman`,
4335 `decimal`, `lowerAlpha`, `upperAlpha` (Alexander Krotov, API change).
4337 * Tests/Lua: fix tests on windows (Albert Krewinkel).
4339 * Lua: register script name in global variable (#4393). The name of the Lua
4340 script which is executed is made available in the global Lua variable
4341 `PANDOC_SCRIPT_FILE`, both for Lua filters and custom writers.
4343 * Tests: Abstract powerpoint tests out to OOXML tests (Jesse Rosenthal).
4344 There is very little pptx-specific in these tests, so we abstract out
4345 the basic testing function so it can be used for docx as well. This
4346 should allow us to catch some errors in the docx writer that slipped
4347 by the roundtrip testing.
4349 * Lua filters: store constructors in registry (Albert Krewinkel). Lua
4350 functions used to construct AST element values are stored in the Lua
4351 registry for quicker access. Getting a value from the registry is much
4352 faster than getting a global value (partly to idiosyncrasies of hslua);
4353 this change results in a considerable performance boost.
4355 * Documentation:
4357 + `doc/org.md` Add draft of Org-mode documentation (Albert Krewinkel).
4358 + `doc/lua-filters.md`: document global vars set for filters
4359 (Albert Krewinkel).
4360 + INSTALL.md: mention Stack version. (#4343, Adam Brandizzi).
4361 + MANUAL: add documentation on custom styles (Jesse Rosenthal).
4362 + MANUAL.txt: Document incremental and nonincremental divs (Jesse
4363 Rosenthal). Blockquoted lists are still described, but fenced divs are
4364 presented in preference.
4365 + MANUAL.txt: document header and footer variables (newmana).
4366 + MANUAL.txt: self-contained implies standalone (#4304, Daniel Lublin).
4367 + CONTRIBUTING.md: label was renamed. (#4310, Alexander Brandizzi).
4369 * Require tagsoup 0.14.3 (#4282), fixing HTML tokenization bug.
4371 * Use latest texmath.
4373 * Use latest pandoc-citeproc.
4375 * Allow exceptions 0.9.
4377 * Require aeson-pretty 0.8.5 (#4394).
4379 * Bump blaze-markup, blaze-html lower bounds to 0.8, 0.9 (#4334).
4381 * Update tagsoup to 0.14.6 (Alexander Krotov, #4282).
4383 * Removed ghc-prof-options. As of cabal 1.24, sensible defaults are used.
4385 * Update default.nix to current nixpkgs-unstable for hslua-0.9.5 (#4348,
4386 jarlg).
4388## pandoc 2.1.1 (2018-01-18)
4390 * Markdown reader:
4392 + Don't coalesce adjacent raw LaTeX blocks if they are separated by a
4393 blank line. See lierdakil/pandoc-crossref#160.
4394 + Improved `inlinesInBalancedBrackets` (#4272, jgm/pandoc-citeproc#315).
4395 The change both improves performance and fixes a regression whereby
4396 normal citations inside inline notes and figure captions were not
4397 parsed correctly.
4399 * RST reader:
4401 + Better handling for headers with an anchor (#4240). Instead of creating a
4402 Div containing the header, we put the id directly on the header.
4403 This way header promotion will work properly.
4404 + Add aligned environment when needed in math (#4254). `rst2latex.py`
4405 uses an `align*` environment for math in `.. math::` blocks, so this
4406 math may contain line breaks. If it does, we put the math in an
4407 `aligned` environment to simulate `rst2latex.py`'s behavior.
4409 * HTML reader:
4411 + Fix col width parsing for percentages < 10% (#4262, n3fariox).
4413 * LaTeX reader:
4415 + Advance source position at end of stream.
4416 + Pass through macro defs in `rawLaTeXBlock` even if the `latex_macros`
4417 extension is set (#4246). This reverts to earlier behavior and is
4418 probably safer on the whole, since some macros only modify things in
4419 included packages, which pandoc's macro expansion can't modify.
4420 + Fixed pos calculation in tokenizing escaped space.
4421 + Allow macro definitions inside macros (#4253). Previously we went into
4422 an infinite loop with
4423 ```
4424 \newcommand{\noop}[1]{#1}
4425 \noop{\newcommand{\foo}[1]{#1}}
4426 \foo{hi}
4427 ```
4428 + Fix inconsistent column widths (#4238). This fixes a bug whereby column
4429 widths for the body were different from widths for the header in some
4430 tables.
4432 * Docx reader (Jesse Rosenthal):
4434 + Parse hyperlinks in `instrText` tags (#3389, #4266). This was a form of
4435 hyperlink found in older versions of word. The changes introduced for
4436 this, though, create a framework for parsing further fields in MS Word
4437 (see the spec, ECMA-376-1:2016, §17.16.5, for more on these fields).
4438 We introduce a new module, `Text.Pandoc.Readers.Docx.Fields` which
4439 contains a simple parsec parser. At the moment, only simple hyperlink
4440 fields are accepted, but that can be extended in the future.
4442 * Muse reader (Alexander Krotov):
4444 + Parse `~~` as non-breaking space in Text::Amuse mode.
4445 + Refactor list parsing.
4447 * Powerpoint writer (Jesse Rosenthal):
4449 + Change reference to `notesSlide` to `endNotesSlide`.
4450 + Move image sizing into `picProps`.
4451 + Improve table placement.
4452 + Make our own `_rels/.rels` file.
4453 + Import reference-doc images properly.
4454 + Move `Presentation.hs` out of `PandocMonad`.
4455 + Refactor into separate modules. T.P.W.Powerpoint.Presentation
4456 defines the Presentation datatype and goes Pandoc->Presentation;
4457 T.P.W.Pandoc.Output goes Presentation->Archive.
4458 Text.Pandoc.Writers.Powerpoint a thin wrapper around the two modules.
4459 + Avoid overlapping blocks in column output.
4460 + Position images correctly in two-column layout.
4461 + Make content shape retrieval environment-aware.
4462 + Improve image handling. We now determine image and caption placement
4463 by getting the dimensions of the content box in a given layout.
4464 This allows for images to be correctly sized and positioned in a
4465 different template. Note that images without captions and headers are
4466 no longer full-screened. We can't do this dependably in different
4467 layouts, because we don't know where the header is (it could be to
4468 the side of the content, for example).
4469 + Read presentation size from reference file. Our presentation size is
4470 now dependent on the reference/template file we use.
4471 + Handle (sub)headers above slidelevel correctly. Above the slidelevel,
4472 subheaders will be printed in bold and given a bit of extra space
4473 before them. Note that at the moment, no distinction is made between
4474 levels of headers above the slide header, though that can be changed.
4475 + Check for required files. Since we now import from reference/dist
4476 file by glob, we need to make sure that we're getting the files we
4477 need to make a non-corrupt Powerpoint. This performs that check.
4478 + Improve templating using `--reference-doc`. Templating should work
4479 much more reliably now.
4480 + Include Notes slide in TOC.
4481 + Set notes slide header to slide-level.
4482 + Add table of contents. This is triggered by the `--toc` flag. Note
4483 that in a long slide deck this risks overrunning the text box. The user
4484 can address this by setting `--toc-depth=1`.
4485 + Set notes slide number correctly.
4486 + Clean up adding metadata slide. We want to count the slide numbers
4487 correctly if it's in there.
4488 + Add anchor links. For anchor-type links (`[foo](#bar)`) we produce
4489 an anchor link. In powerpoint these are links to slides, so we keep
4490 track of a map relating anchors to the slides they occur on.
4491 + Make the slide number available to the blocks. For anchors,
4492 block-processing functions need to know what slide number
4493 they're in. We make the `envCurSlideId` available to blocks.
4494 + Move `curSlideId` to environment.
4495 + Allow setting `toc-title` in metadata.
4496 + Link notes to endnotes slide.
4498 * Markdown writer:
4500 + Fix cell width calculation (#4265). Previously we could get
4501 ever-lengthening cell widths when a table was run repeatedly through
4502 `pandoc -f markdown -t markdown`.
4504 * LaTeX writer:
4506 + Escape `&` in lstinline (Robert Schütz).
4508 * ConTeXt writer:
4510 + Use xtables instead of Tables (#4223, Henri Menke).
4511 Default to xtables for context output. Natural Tables are used
4512 if the new `ntb` extension is set.
4514 * HTML writer:
4516 + Fixed footnote backlinks with `--id-prefix` (#4235).
4518 * `Text.Pandoc.Extensions`: Added `Ext_ntb` constructor (API change,
4519 Henri Menke).
4521 * `Text.Pandoc.ImageSize`: add derived `Eq` instance to `Dimension`
4522 (Jesse Rosenthal, API change).
4524 * Lua filters (Albert Krewinkel):
4526 + Make `PANDOC_READER_OPTIONS` available.
4527 The options which were used to read the document are made available to
4528 Lua filters via the `PANDOC_READER_OPTIONS` global.
4529 + Add lua module `pandoc.utils.run_json_filter`, which runs a JSON filter
4530 on a Pandoc document.
4531 + Refactor filter-handling code into `Text.Pandoc.Filter.JSON`,
4532 `Text.Pandoc.Filter.Lua`, and `Text.Pandoc.Filter.Path`.
4533 + Improve error messages. Provide more context about the task
4534 which caused an error.
4536 * data/pandoc.lua (Albert Krewinkel):
4538 + Accept singleton inline as a list. Every constructor which accepts a
4539 list of inlines now also accepts a single inline element for
4540 convenience.
4541 + Accept single block as singleton list. Every constructor which accepts
4542 a list of blocks now also accepts a single block element for
4543 convenience. Furthermore, strings are accepted as shorthand for
4544 `{pandoc.Str "text"}` in constructors.
4545 + Add attr, listAttributes accessors. Elements with
4546 attributes got an additional `attr` accessor. Attributes were
4547 accessible only via the `identifier`, `classes`, and `attributes`,
4548 which was in conflict with the documentation, which indirectly states
4549 that such elements have the an `attr` property.
4550 + Drop `_VERSION`. Having a `_VERSION` became superfluous, as this
4551 module is closely tied to the pandoc version, which is available via
4552 `PANDOC_VERSION`.
4553 + Fix access to Attr components. Accessing an Attr value (e.g.,
4554 ` Attr().classes`) was broken; the more common case of accessing it via
4555 an Inline or Block element was unaffected by this.
4557 * Move `metaValueToInlines` to from Docx writer to
4558 `Text.Pandoc.Writers.Shared`, so it can be used by other writers
4559 (Jesse Rosenthal).
4561 * MANUAL.txt:
4563 + Clarify otherlangs in LaTeX (#4072).
4564 + Clarify `latex_macros` extension.
4565 + Recommend use of `raw_attribute` extension in header includes (#4253).
4567 * Allow latest QuickCheck, tasty, criterion.
4569 * Remove custom prelude and ghc 7.8 support.
4571 * Reduce compiler noise (exact paths for compiled modules).
4573## pandoc 2.1 (2018-01-07)
4575 * Allow filters and lua filters to be interspersed (#4196). Previously
4576 we ran all lua filters before JSON filters. Now we run filters in
4577 the order they are presented on the command line, whether lua or JSON.
4578 There are two incompatible API changes: The type of `applyFilters`
4579 has changed, and `applyLuaFilters` has been removed. `Filter` is
4580 also now exported.
4582 * Use latest skylighting and omit the `missingIncludes` check, fixing
4583 a major performance regression in earlier releases of the 2.x series
4584 (#4226). Behavior change: If you use a custom syntax definition that
4585 refers to a syntax you haven't loaded, pandoc will now complain when
4586 it is highlighting the text, rather than doing a check at the start.
4587 This change dramatically speeds up invocations of pandoc on short
4588 inputs.
4590 * Text.Pandoc.Class: make `FileTree` opaque (don't export
4591 `FileTree` constructor). This forces users to interact with it using
4592 `insertInFileTree` and `getFileInfo`, which normalize file names.
4594 * Markdown reader:
4596 + Rewrite `inlinesInBalancedBrackets`. The rewrite is much more
4597 direct, avoiding `parseFromString`. And it performs significantly
4598 better; unfortunately, parsing time still increases exponentially
4599 (see #1735).
4600 + Avoid parsing raw tex unless `\` + letter seen. This seems to
4601 help with the performance problem, #4216.
4603 * LaTeX reader: Simplified a check for raw tex command.
4605 * Muse reader (Alexander Krotov):
4607 + Enable round trip test (#4107).
4608 + Automatically translate `#cover` into `#cover-image`.
4609 Amusewiki uses #cover directive to specify cover image.
4611 * Docx reader (Jesse Rosenthal):
4613 + Allow for insertion/deletion of paragraphs (#3927).
4614 If the paragraph has a deleted or inserted paragraph break (depending
4615 on the track-changes setting) we hold onto it until the next
4616 paragraph. This takes care of accept and reject. For this we introduce
4617 a new state which holds the ils from the previous para if necessary.
4618 For `--track-changes=all`, we add an empty span with class
4619 `paragraph-insertion`/`paragraph-deletion` at the end of the paragraph
4620 prior to the break to be inserted or deleted.
4621 + Remove unused anchors (#3679). Docx produces a lot of anchors with
4622 nothing pointing to them---we now remove these to produce cleaner
4623 output. Note that this has to occur at the end of the process
4624 because it has to follow link/anchor rewriting.
4625 + Read multiple children of `w:sdtContents`.
4626 + Combine adjacent anchors. There isn't any reason to have numerous
4627 anchors in the same place, since we can't maintain docx's
4628 non-nesting overlapping. So we reduce to a single anchor.
4629 + Improved tests.
4631 * Muse writer (Alexander Krotov): don't escape URIs from AST
4633 * Docx writer:
4635 + Removed redundant subtitle in title (Sebastian Talmon).
4636 + `firstRow` table definition compatibility for Word 2016 (Sebastian
4637 Talmon). Word 2016 seems to use a default value of "1" for table
4638 headers, if there is no firstRow definition (although a default
4639 value of 0 is documented), so all tables get the first Row formatted
4640 as header. Setting the parameter to 0 if the table has no header
4641 row fixes this for Word 2016
4642 + Fix custom styles with spaces in the name (#3290).
4644 * Powerpoint writer (Jesse Rosenthal):
4646 + Ignore Notes div for parity with other slide outputs.
4647 + Set default slidelevel correctly. We had previously defaulted to
4648 slideLevel 2. Now we use the correct behavior of defaulting to the
4649 highest level header followed by content. We change an expected test
4650 result to match this behavior.
4651 + Split blocks correctly for linked images.
4652 + Combine adjacent runs.
4653 + Make inline code inherit code size. Previously (a) the code size
4654 wasn't set when we force size, and (b) the properties was set from
4655 the default, instead of inheriting.
4656 + Simplify `replaceNamedChildren` function.
4657 + Allow linked images. The following markdown:
4658 `[![Image Title](image.jpg)](http://www.example.com)`
4659 will now produce a linked image in the resulting PowerPoint file.
4660 + Fix error with empty table cell. We require an empty `<a:p>` tag,
4661 even if the cell contains no paragraphs---otherwise PowerPoint
4662 complains of corruption.
4663 + Implement two-column slides. This uses the columns/column div
4664 format described in the pandoc manual. At the moment, only two
4665 columns (half the screen each) are allowed. Custom widths are not
4666 supported.
4667 + Added more tests.
4669 * OpenDocument/ODT writers: improved rendering of formulas (#4170, oltolm).
4671 * Lua filters (Albert Krewinkel):
4673 + `data/pandoc.lua`: drop 'pandoc-api-version' from Pandoc objects
4674 + The current pandoc-types version is made available to Lua programs in
4675 the global `PANDOC_API_VERSION`. It contains the version as a list of
4676 numbers.
4677 + The pandoc version available as a global `PANDOC_VERSION` (a list
4678 of numbers).
4679 + `data/pandoc.lua`: make `Attr` an `AstElement`.
4680 + `data/pandoc.lua`: make all types subtypes of `AstElement`.
4681 `Pandoc`, `Meta`, and `Citation` were just plain functions and did
4682 not set a metatable on the returned value, which made it difficult
4683 to amend objects of these types with new behavior. They are now
4684 subtypes of AstElement, meaning that all their objects can gain
4685 new features when a method is added to the behavior object
4686 (e.g., `pandoc.Pandoc.behavior`).
4687 + `data/pandoc.lua`: split type and behavior tables. Clearly distinguish
4688 between a type and the behavioral properties of an instance of that
4689 type. The behavior of a type (and all its subtypes) can now be
4690 amended by adding methods to that types `behavior` object, without
4691 exposing the type objects internals. E.g.:
4692 ```lua
4693 pandoc.Inline.behavior.frob = function () print'42' end
4694 local str = pandoc.Str'hello'
4695 str.frob() -- outputs '42'
4696 ```
4697 + `data/pandoc.lua`: fix Element inheritance. Extending all elements
4698 of a given type (e.g., all inline elements) was difficult, as the
4699 table used to lookup unknown methods would be reset every time a
4700 new element of that type was created, preventing recursive property
4701 lookup. This is was changed in that all methods and attributes of
4702 supertypes are now available to their subtypes.
4703 + `data/pandoc.lua`: fix attribute names of Citation (#4222). The
4704 fields were named like the Haskell fields, not like the documented,
4705 shorter version. The names are changed to match the documentation
4706 and Citations are given a shared metatable to enable simple
4707 extensibility.
4708 + `data/pandoc.lua`: drop function `pandoc.global_filter`.
4709 + Bump `hslua` version to 0.9.5. This version fixes a bug that made it
4710 difficult to handle failures while getting lists or a Map from Lua.
4711 A bug in pandoc, which made it necessary to always pass a tag when
4712 using MetaList or MetaBlock, is fixed as a result. Using the pandoc
4713 module's constructor functions for these values is now optional
4714 (if still recommended).
4715 + Stop exporting `pushPandocModule` (API change). The introduction
4716 of `runPandocLua` renders direct use of this function obsolete.
4717 + Update generation of module docs for lua filters.
4718 + `Lua.Module.Utils`: make stringify work on `MetaValues` (John
4719 MacFarlane). I'm sure this was intended in the first place,
4720 but currently only `Meta` is supported.
4722 * Improve benchmarks.
4724 + Set the default extensions properly.
4725 + Improve benchmark argument parsing. You can now say
4726 `make bench BENCHARGS="markdown latex reader"` and both the
4727 markdown and latex readers will be benchmarked.
4729 * MANUAL.txt simplify and add more structure (Mauro Bieg).
4731 * Generate README.md from template and MANUAL.txt.
4732 `make README.md` will generate the README.md after changes
4733 to MANUAL.txt have been made.
4735 * Update copyright notices to include 2018 (Albert Krewinkel).
4737## pandoc 2.0.6 (2017-12-28)
4739 * Added `jats` as an input format.
4741 + Add Text.Pandoc.Readers.JATS, exporting `readJATS` (API
4742 change) (Hamish Mackenzie).
4743 + Improved citation handling in JATS reader. JATS citations
4744 are now converted to pandoc citations, and JATS ref-lists
4745 are converted into a `references` field in metadata, suitable
4746 for use with pandoc-citeproc. Thus a JATS article with embedded
4747 bibliographic information can be processed with pandoc and
4748 pandoc-citeproc to produce a formatted bibliography.
4750 * Allow `--list-extensions` to take an optional FORMAT argument.
4751 This lists the extensions set by default for the selected FORMAT.
4752 The extensions are now alphabetized, and the `+` or `-`
4753 indicating the default setting comes before, rather than after,
4754 the extension.
4756 * Markdown reader:
4758 + Preserve original whitespace between blocks.
4759 + Recognize `\placeformula` as context.
4760 + Be pickier about table captions. A caption starts with a `:` which
4761 can't be followed by punctuation. Otherwise we can falsely interpret
4762 the start of a fenced div, or even a table header line like
4763 `:--:|:--:`, as a caption.
4764 + Always use four space rule for example lists. It would be awkward
4765 to indent example list contents to the first non-space character after
4766 the label, since example list labels are often long. Thanks to
4767 Bernhard Fisseni for the suggestion.
4768 + Improve raw tex parsing. Note that the Markdown reader is also
4769 affected by the `latex_macros` extension changes described below
4770 under the LaTeX reader.
4772 * LaTeX reader:
4774 + `latex_macros` extension changes (#4179). Don't pass through macro
4775 definitions themselves when `latex_macros` is set. The macros
4776 have already been applied. If `latex_macros` is enabled, then
4777 `rawLaTeXBlock` in Text.Pandoc.Readers.LaTeX will succeed in parsing
4778 a macro definition, and will update pandoc's internal macro map
4779 accordingly, but the empty string will be returned.
4780 + Export `tokenize`, `untokenize` (API change).
4781 + Use `applyMacros` in `rawLaTeXBlock`, `rawLaTeXInline`.
4782 + Refactored `inlineCommand`.
4783 + Fix bug in tokenizer. Material following `^^` was
4784 dropped if it wasn't a character escape. This only affected
4785 invalid LaTeX, so we didn't see it in the wild, but it appeared
4786 in a QuickCheck test failure.
4787 + Fix regression in LateX tokenization (#4159). This mainly affects the
4788 Markdown reader when parsing raw LaTeX with escaped spaces.
4789 + Add tests of LaTeX tokenizer.
4790 + Support `\foreignlanguage` from babel.
4791 + Be more tolerant of `&` character (#4208). This allows us to parse
4792 unknown tabular environments as raw LaTeX.
4794 * Muse reader (Alexander Krotov):
4796 + Parse anchors immediately after headings as IDs.
4797 + Require that note references does not start with 0.
4798 + Parse empty comments correctly.
4800 * Org reader (Albert Krewinkel):
4802 + Fix asterisks-related parsing error (#4180).
4803 + Support minlevel option for includes (#4154). The level of headers
4804 in included files can be shifted to a higher level by specifying a
4805 minimum header level via the `:minlevel` parameter. E.g.
4806 `#+include: "tour.org" :minlevel 1` will shift the headers in
4807 tour.org such that the topmost headers become level 1 headers.
4808 + Break-up org reader test file into multiple modules.
4810 * OPML reader:
4812 + Enable raw HTML and other extensions by default for notes
4813 (#4164). This fixes a regression in 2.0. Note that extensions can
4814 now be individually disabled, e.g. `-f opml-smart-raw_html`.
4816 * RST reader:
4818 + Allow empty list items (#4193).
4819 + More accurate parsing of references (#4156). Previously we erroneously
4820 included the enclosing backticks in a reference ID (#4156). This
4821 change also disables interpretation of syntax inside references, as
4822 in docutils. So, there is no emphasis in `` `my *link*`_ ``.
4824 * Docx reader:
4826 + Continue lists after interruption (#4025, Jesse Rosenthal).
4827 Docx expects that lists will continue where they left off after an
4828 interruption and introduces a new id if a list is starting again. So
4829 we keep track of the state of lists and use them to define a "start"
4830 attribute, if necessary.
4831 + Add tests for structured document tags unwrapping (Jesse Rosenthal).
4832 + Preprocess Document body to unwrap `w:sdt` elements (Jesse Rosenthal,
4833 #4190).
4835 * Plain writer:
4837 + Don't linkify table of contents.
4839 * RST writer:
4841 + Fix anchors for headers (#4188). We were missing an `_`.
4843 * PowerPoint writer (Jesse Rosenthal):
4845 + Treat lists inside BlockQuotes as lists. We don't yet produce
4846 incremental lists in PowerPoint, but we should at least treat lists
4847 inside BlockQuotes as lists, for compatibility with other slide formats.
4848 + Add ability to force size. This replaces the more specific
4849 `blockQuote runProp`, which only affected the size of blockquotes. We
4850 can use this for notes, etc.
4851 + Implement notes. This currently prints all notes on a final slide.
4852 Note that at the moment, there is a danger of text overflowing the
4853 note slide, since there is no logic for adding further slides.
4854 + Implement basic definition list functionality to PowerPoint writer.
4855 + Don't look for default template file for Powerpoint (#4181).
4856 + Add pptx to isTextFormat list. This is used to check standalone
4857 and not writing to the terminal.
4858 + Obey slide level option (Jesse Rosenthal).
4859 + Introduce tests.
4861 * Docx writer:
4863 + Ensure that `distArchive` is the one that comes with pandoc
4864 (#4182). Previously a `reference.docx` in `~/.pandoc` (or the user data
4865 dir) would be used instead, and this could cause problems because a
4866 user-modified docx sometimes lacks vital sections that we count
4867 on the `distArchive` to supply.
4869 * Org writer:
4871 + Do not wrap "-" to avoid accidental bullet lists (Alexander Krotov).
4872 + Don't allow fn refs to wrap to beginning of line (#4171, with help from
4873 Alexander Krotov). Otherwise they can be interpreted as footnote
4874 definitions.
4876 * Muse writer (Alexander Krotov):
4878 + Don't wrap note references to the next line (#4172).
4880 * HTML writer:
4882 + Use br elements in line blocks instead of relying on CSS
4883 (#4162). HTML-based templates have had the custom CSS for
4884 `div.line-block` removed. Those maintaining custom templates will want
4885 to remove this too. We still enclose line blocks in a div with class
4886 `line-block`.
4888 * LaTeX writer:
4890 + Use `\renewcommand` for `\textlatin` with babel (#4161).
4891 This avoids a clash with a deprecated `\textlatin` command defined
4892 in Babel.
4893 + Allow fragile=singleslide attribute in beamer slides (#4169).
4894 + Use `\endhead` after `\toprule` in headerless tables (#4207).
4896 * FB2 writer:
4898 + Add cover image specified by `cover-image` meta (Alexander Krotov,
4899 #4195).
4901 * JATS writer (Hamish Mackenzie):
4903 + Support writing `<fig>` and `<table-wrap>` elements
4904 with `<title>` and `<caption>` inside them by using Divs with class set
4905 to one of `fig`, `table-wrap` or `caption` (Hamish Mackenzie). The
4906 title is included as a Heading so the constraint on where Heading can
4907 occur is also relaxed.
4908 + Leave out empty alt attributes on links.
4909 + Deduplicate image mime type code.
4910 + Make `<p>` optional in `<td>` and `<th>` (#4178).
4911 + Self closing tags for empty xref (#4187).
4912 + Improve support for code language.
4914 * Custom writer:
4916 + Use init file to setup Lua interpreter (Albert Krewinkel).
4917 The same init file (`data/init`) that is used to setup the Lua
4918 interpreter for Lua filters is also used to setup the interpreter of
4919 custom writers.lua.
4920 + Define instances for newtype wrapper (Albert Krewinkel). The custom
4921 writer used its own `ToLuaStack` instance definitions, which made
4922 it difficult to share code with Lua filters, as this could result
4923 in conflicting instances. A `Stringify` wrapper is introduced to
4924 avoid this problem.
4925 + Added tests for custom writer.
4926 + Fixed definition lists and tables in `data/sample.lua`.
4928 * Fixed regression: when target is PDF, writer extensions were being
4929 ignored. So, for example, `pandoc -t latex-smart -o file.pdf`
4930 did not work properly.
4932 * Lua modules (Albert Krewinkel):
4934 + Add `pandoc.utils` module, to hold utility functions.
4935 + Create a Haskell module Text.Pandoc.Lua.Module.Pandoc to
4936 define the `pandoc` lua module.
4937 + Make a Haskell module for each Lua module. Move definitions for the
4938 `pandoc.mediabag` modules to a separate Haskell module.
4939 + Move `sha1` from the main `pandoc` module to `pandoc.utils`.
4940 + Add function `pandoc.utils.hierarchicalize` (convert list of
4941 Pandoc blocks into (hierarchical) list of Elements).
4942 + Add function `pandoc.utils.normalize_date` (parses a date and
4943 converts it (if possible) to "YYYY-MM-DD" format).
4944 + Add function `pandoc.utils.to_roman_numeral` (allows conversion
4945 of numbers below 4000 into roman numerals).
4946 + Add function `pandoc.utils.stringify` (converts any AST element
4947 to a string with formatting removed).
4948 + `data/init.lua`: load `pandoc.utils` by default
4949 + Turn pipe, read into full Haskell functions. The `pipe` and `read`
4950 utility functions are converted from hybrid lua/haskell functions
4951 into full Haskell functions. This avoids the need for intermediate
4952 `_pipe`/`_read` helper functions, which have dropped.
4953 + pandoc.lua: re-add missing MetaMap function. This was a bug
4954 introduced in version 2.0.4.
4956 * Text.Pandoc.Class: Add `insertInFileTree` [API change]. This gives
4957 a pure way to insert an ersatz file into a `FileTree`. In addition, we
4958 normalize paths both on insertion and on lookup.
4960 * Text.Pandoc.Shared: export `blocksToInlines'` (API change, Maura Bieg).
4962 * Text.Pandoc.MIME: Add opus to MIME type table as audio/ogg (#4198).
4964 * Text.Pandoc.Extensions: Alphabetical order constructors for
4965 `Extension`. This makes them appear in order in `--list-extensions`.
4967 * Allow lenient decoding of latex error logs, which are not always
4968 properly UTF8-encoded (#4200).
4970 * Update latex template to work with recent versions of beamer.
4971 The old template produced numbered sections with some recent
4972 versions of beamer. Thanks to Thomas Hodgson.
4974 * Updated reference.docx (#4175). Instead of just "Hello, world", the
4975 document now contains exemplars of most of the styles that have an
4976 effect on pandoc documents. This makes it easier to see the effect
4977 of style changes.
4979 * Removed `default.theme` data file (#4096). It is no longer needed now
4980 that we have `--print-highlight-style`.
4982 * Added `stack.lts9.yaml` for building with lts 9 and ghc 8.0.2.
4983 We still need this for the alpine static linux build, since
4984 we don't have ghc 8.2.2 for that yet.
4986 * Removed `stack.pkg.yaml`. We only really need `stack.yaml`; we
4987 can put flag settings for pandoc-citeproc there.
4989 * Makefile: Add 'trypandoc' and 'pandoc-templates' targets to
4990 make releases easier.
4992 * MANUAL.txt:
4994 + Add note on what formats have `+smart` by default.
4995 + Use native syntax for custom-style (#4174, Mauro Bieg).
4996 + Introduce dedicated Extensions section, since some extensions
4997 affect formats other than markdown (Mauro Bieg, #4204).
4998 + Clarify default html output for `--section-divs` (Richard Edwards).
5000 * filters.md: say that Text.Pandoc.JSON comes form pandoc-types.
5001 Closes jgm/pandoc-website#16.
5003 * epub.md: Delete removed `-S` option from command (#4151, Georger Araújo).
5005## pandoc 2.0.5 (2017-12-12)
5007 * Fix a bug in 2.0.4, whereby pandoc could not read the theme files
5008 generated with `--print-highlight-style` (#4133). Improve JSON
5009 serialization of styles.
5011 * Fix CSS issues involving line numbers (#4128).
5012 Highlighted code blocks are now enclosed in a div with class `sourceCode`.
5013 Highlighting CSS no longer sets a generic color for pre and code; we only
5014 set these for class `sourceCode`.
5016 * `--pdf-engine-opt`: fix bug where option order was reversed (#4137).
5018 * Add PowerPoint (pptx) writer (Jesse Rosenthal).
5019 It works following the standard Pandoc conventions for making other
5020 sorts of slides. Caveats:
5022 + Syntax highlighting is not yet implemented. (This is difficult
5023 because there are no character classes in Powerpoint.)
5024 + Footnotes and Definition lists are not yet implemented. (Notes will
5025 usually take the form of a final slide.
5026 + Image placement and auto-resizing has a few glitches.
5027 + Reference powerpoint files don't work dependably from the command
5028 line. This will be implemented, but at the moment users are advised
5029 to change themes from within Powerpoint.
5031 * Create shared Text.Pandoc.Writers.OOXML module (Jesse Rosenthal).
5032 This is for functions used by both Powerpoint and Docx writers.
5034 * Add default pptx data for Powerpoint writer (Jesse Rosenthal).
5036 * Add `empty_paragraphs` extension.
5038 + Deprecate `--strip-empty-paragraphs` option. Instead we now
5039 use an `empty_paragraphs` extension that can be enabled on
5040 the reader or writer. By default, disabled.
5041 + Add `Ext_empty_paragraphs` constructor to `Extension`.
5042 + Revert "Docx reader: don't strip out empty paragraphs."
5043 This reverts commit d6c58eb836f033a48955796de4d9ffb3b30e297b.
5044 + Implement `empty_paragraphs` extension in docx reader and writer,
5045 opendocument writer, html reader and writer.
5046 + Add tests for `empty_paragraphs` extension.
5048 * Markdown reader:
5050 + Don't parse native div as table caption (#4119).
5051 + Improved computation of column widths in pipe tables.
5052 Pipe tables with lines longer than the text width (as set
5053 by `--columns`) are now scaled to text width, with the relative
5054 widths of columns determined by the ratios between the
5055 header lines. Previously we computed column widths using
5056 the ratio of header line lengths to column width, so that
5057 tables with narrow header lines were extremely thin, which
5058 was very rarely the desired result.
5060 * LaTeX reader: fix `\` before newline (#4134). This should be a space,
5061 as long as it's not followed by a blank line. This has been fixed at the
5062 tokenizer level.
5064 * Muse reader (Alexander Krotov):
5066 + Add test for `#disable-tables` directive in Emacs mode.
5067 + Don't allow emphasis to be preceded by letter.
5068 + Add underline support in Emacs Muse mode..
5069 + Support multiline directives in Amusewiki mode
5071 * Man writer: omit internal links (#4136). That is, just print the link
5072 text without the URL.
5074 * Markdown reader: accept processing instructions as raw HTML (#4125).
5076 * Lua filters (Albert Krewinkel):
5078 + Use script to initialize the interpreter. The file `init.lua` is
5079 used to initialize the Lua interpreter which is used in Lua filters.
5080 This gives users the option to require libraries which they want to
5081 use in all of their filters, and to extend default modules.
5082 + Fix package loading for Lua 5.1. The list of package searchers is
5083 named `package.loaders` in Lua 5.1 and LuaJIT, and `package.searchers`
5084 in Lua 5.2 and later.
5085 + Refactor lua module handling. The integration with Lua's package/module
5086 system is improved: A pandoc-specific package searcher is prepended to
5087 the searchers in `package.searchers`. The modules `pandoc` and
5088 `pandoc.mediabag` can now be loaded via `require`.
5089 + Bump lower bound of hslua. The release hslua 0.9.3 contains a new
5090 function which makes using Haskell functions as package loaders much
5091 easier.
5093 * reveal.js template: add title-slide identifier to title slide (#4120).
5094 This allows it to be styled more easily.
5096 * LaTeX template: Added support for `pagestyle` variable (#4135,
5097 Thomas Hodgson)
5099 * Add `-threaded` to ghc-options for executable (#4130, fixes a build
5100 error on linux).
5103## pandoc 2.0.4 (2017-12-03)
5105 * Add `--print-highlight-style` option. This generates a JSON version
5106 of a highlighting style, which can be saved as a `.theme` file, modified,
5107 and used with `--highlight-style` (#4106, #4096).
5109 * Add `--strip-empty-paragraphs` option. This works for any input format.
5110 It is primarily intended for use with docx and odt documents where
5111 empty paragraphs have been used for inter-paragraph spaces.
5113 * Support `--webtex` for `gfm` output.
5115 * Recognize `.muse` file extension.
5117 * Support beamer `\alert` in LaTeX reader. Closes #4091.
5119 * Docx reader: don't strip out empty paragraphs (#2252).
5120 Users who have a conversion pipeline from docx may want to consider adding
5121 `--strip-empty-paragraphs` to the command line.
5123 * Org reader (Albert Krewinkel): Allow empty list items (#4090).
5125 * Muse reader (Alexander Krotov):
5127 + Parse markup in definition list terms.
5128 + Allow definition to end with EOF.
5129 + Make code blocks round trip.
5130 + Drop common space prefix from list items.
5131 + Add partial round trip test.
5132 + Don't interpret XML entities.
5133 + Remove `nested`.
5134 + Parse `~~` as non-breaking space in Emacs mode.
5135 + Correctly remove indentation from notes. Exactly one space is
5136 required and considered to be part of the marker.
5137 + Allow list items to be empty.
5138 + Add ordered list test.
5139 + Add more multiline definition tests.
5140 + Don't allow blockquotes within lists.
5141 + Fix reading of multiline definitions.
5142 + Add inline `<literal>` support.
5143 + Concatenate inlines of the same type
5145 * Docx writer: allow empty paragraphs (#2252).
5147 * CommonMark/gfm writer:
5149 + Use raw html for native divs/spans (#4113). This allows a pandoc
5150 markdown native div or span to be rendered in gfm using raw html tags.
5151 + Implement `raw_html` and `raw_tex` extensions. Note that `raw_html`
5152 is enabled by default for `gfm`, while `raw_tex` is disabled by default.
5154 * Muse writer (Alexander Krotov):
5156 + Test that inline math conversion result is normalized.
5157 Without normalization this test produced
5158 `<em>a</em><em>b</em><em>c</em>`.
5159 + Improve inline list normalization and move to writer.
5160 + Escape hash symbol.
5161 + Escape `----` to avoid accidental horizontal rules.
5162 + Escape only `</code>` inside code tag.
5163 + Additional `<verbatim>` is not needed as `<code>` is verbatim already.
5165 * LaTeX writer:
5167 + Allow specifying just width or height for image size.
5168 Previously both needed to be specified (unless the image was
5169 being resized to be smaller than its original size).
5170 If height but not width is specified, we now set width to
5171 textwidth. If width but not height is specified, we now set
5172 height to textheight. Since we have `keepaspectratio`, this
5173 yields the desired result.
5174 + Escape `~` and `_` in code with `--listings` (#4111).
5176 * HTML writer: export `tagWithAttributes`. This is a helper allowing
5177 other writers to create single HTML tags.
5179 * Let papersizes `a0`, `a1`, `a2`, ... be case-insensitive by
5180 converting the case as needed in LaTeX and ConTeXt writers.
5182 * Change `fixDisplayMath` from `Text.Pandoc.Writers.Shared`
5183 so that it no longer produces empty `Para`'s as an artifact.
5185 * `Text.Pandoc.Shared.blocksToInlines`: rewrote using builder.
5186 This gives us automatic normalization, so we don't get
5187 for example two consecutive Spaces.
5189 * Include default CSS for 'underline' class in HTML-based templates.
5191 * revealjs template: add `tex2jax` configuration for the
5192 math plugin. With the next release of reveal.js, this will
5193 fix the problem of `$`s outside of math contexts being
5194 interpreted as math delimiters (#4027).
5196 * `pandoc.lua` module for use in lua filters (Albert Krewinkel):
5198 + Add basic lua List module (#4099, #4081). The List module is
5199 automatically loaded, but not assigned to a global variable. It can be
5200 included in filters by calling `List = require 'List'`. Lists of blocks,
5201 lists of inlines, and lists of classes are now given `List` as a metatable,
5202 making working with them more convenient. E.g., it is now possible to
5203 concatenate lists of inlines using Lua's concatenation operator `..`
5204 (requires at least one of the operants to have `List` as a metatable):
5206 function Emph (emph)
5207 local s = {pandoc.Space(), pandoc.Str 'emphasized'}
5208 return pandoc.Span(emph.content .. s)
5209 end
5211 The `List` metatable is assigned to the tables which get passed to
5212 the constructors `MetaBlocks`, `MetaInline`, and `MetaList`. This
5213 enables the use of the resulting objects as lists.
5214 + `Lua/StackInstances`: push Pandoc and Meta via constructor.
5215 Pandoc and Meta elements are now pushed by calling the respective
5216 constructor functions of the pandoc Lua module. This makes serialization
5217 consistent with the way blocks and inlines are pushed to lua and allows
5218 to use List methods with the `blocks` value.
5219 + Add documentation for pandoc.List in `lua-filters.md`.
5221 * Use latest tagsoup. This fixes a bug in parsing HTML tags with
5222 `&` (but not a valid entity) following them (#4094, #4088).
5224 * Use skylighting 0.4.4.1, fixing the color of unmarked code text
5225 when `numberLines` is used (#4103).
5227 * Make `normalizeDate` more forgiving (Mauro Bieg, #4101), not
5228 requiring a leading 0 on single-digit days.
5230 * Fix `--help` output for `--highlight-style` to include `FILE` (Mauro
5231 Bieg, #4095).
5233 * Clearer deprecation warning for `--latexmathml, --asciimathml, -m`.
5234 Previously we only mentioned `--latexmathml`, even if `-m` was
5235 used.
5237 * Changelog: fix description of lua filters in 2.0 release
5238 (Albert Krewinkel). Lua filters were initially run *after* conventional
5239 (JSON) filters. However, this was changed later to make it easier to deal
5240 with files in the mediabag. The changelog is updated to describe that
5241 feature of the 2.0 release correctly.
5243 * Change Generic JSON instances to TemplateHaskell (Jasper Van der Jeugt,
5244 #4085). This reduces compile time and memory usage significantly.
5246 * `lua-filters.md`: Added tikz filter example.
5248 * Create alternative zip file for macOS binaries.
5250 * Create alternative zip file for Windows binaries.
5252 * Update INSTALL.md since we now provide zips for binaries.
5254 * Relax `http-types` dependency (Justus Sagemüller, #4084).
5256 * Add `epub.md`, `getting-started.md` to docs. These used to live in
5257 the website repo.
5259 * Add `packages` target to Makefile.
5261 * Bump bounds for binary, http-types, tasty-hunit
5263## pandoc 2.0.3 (2017-11-20)
5265 * Lua filters: preload text module (Albert Krewinkel, #4077).
5266 The `text` module is preloaded in lua. The module contains some UTF-8
5267 aware string functions, implemented in Haskell. The module is loaded on
5268 request only, e.g.:
5270 text = require 'text'
5271 function Str (s)
5272 s.text = text.upper(s.text)
5273 return s
5274 end
5276 * Allow table-like access to attributes in lua filters (Albert Krewinkel,
5277 #4071). Attribute lists are represented as associative lists in Lua. Pure
5278 associative lists are awkward to work with. A metatable is attached to
5279 attribute lists, allowing to access and use the associative list as if
5280 the attributes were stored in as normal key-value pair in table.
5281 Note that this changes the way `pairs` works on attribute lists. Instead
5282 of producing integer keys and two-element tables, the resulting iterator
5283 function now returns the key and value of those pairs. Use `ipairs` to
5284 get the old behavior. Warning: the new iteration mechanism only works if
5285 pandoc has been compiled with Lua 5.2 or later (current default: 5.3).
5287 * Text.Pandoc.Parsing.uri: allow `&` and `=` as word characters (#4068).
5288 This fixes a bug where pandoc would stop parsing a URI with an
5289 empty attribute: for example, `&a=&b=` wolud stop at `a`.
5290 (The uri parser tries to guess which punctuation characters
5291 are part of the URI and which might be punctuation after it.)
5293 * Introduce `HasSyntaxExtensions` typeclass (Alexander Krotov, #4074).
5295 + Added new `HasSyntaxExtensions` typeclass for `ReaderOptions` and
5296 `WriterOptions`.
5297 + Reimplemented `isEnabled` function from `Options.hs` to accept both
5298 `ReaderOptions` and `WriterOptions`.
5299 + Replaced `enabled` from `CommonMark.hs` with new `isEnabled`.
5301 * Add `amuse` extension (Alexander Krotov) to enable Amuse wiki
5302 behavior for `muse`. New `Ext_amuse` constructor for
5303 `Extension`. Note: this is switched on by default; for
5304 Emacs behavior, use `muse-amuse`.
5306 * Muse reader (Alexander Krotov):
5308 + Count only one space as part of list item marker.
5309 + Produce SoftBreaks on newlines. Now wrapping can be preserved
5310 with `--wrap=preserve`.
5311 + Add Text::Amuse footnote extensions. Footnote end is indicated by
5312 indentation, so footnotes can be placed anywhere in the text,
5313 not just at the end of it.
5314 + Accept Emacs Muse definition lists when `-amuse`.
5315 Emacs Muse does not require indentation.
5317 * HTML reader:
5319 + Ensure we don't produce level 0 headers (#4076), even for chapter
5320 sections in epubs. This causes problems because writers aren't set
5321 up to expect these.
5322 + Allow spaces after `\(` and before `\)` with `tex_math_single_backslash`.
5323 Previously `\( \frac{1}{a} < \frac{1}{b} \)` was not parsed as math in
5324 `markdown` or `html` `+tex_math_single_backslash`.
5326 * MANUAL: clarify that math extensions work with HTML.
5327 Clarify that `tex_math_dollars` and `tex_math_single_backslash`
5328 will work with HTML as well as Markdown.
5330 * Creole reader: Fix performance issue for longer lists (Sascha Wilde,
5331 #4067).
5333 * RST reader: better support for 'container' directive (#4066).
5334 Create a div, incorporate name attribute and classes.
5336 * LaTeX reader:
5338 + Support column specs like `*{2}{r}` (#4056). This is equivalent to
5339 `rr`. We now expand it like a macro.
5340 + Allow optional args for parbox (#4056).
5341 + Allow optional arguments on `\footnote` (#4062).
5343 * EPUB writer: Fixed path for cover image (#4069). It was previously
5344 `media/media/imagename`, and should have been `media/imagename`.
5346 * Markdown writer: fix bug with doubled footnotes in grid tables
5347 (#4061).
5349 * LaTeX template: include natbib/biblatex after polyglossia (#4073).
5350 Otherwise we seem to get an error; biblatex wants polyglossia
5351 language to be defined.
5353 * Added examples to lua filters documentation.
5356## pandoc 2.0.2 (2017-11-12)
5358 * Deprecated ancient HTML math methods: `--latexmathml`, `--gladtex`,
5359 `--mimetex`, `--jsmath`.
5361 * Fixed URIs in `data/jats.csl`. They were being rendered twice,
5362 leading to invalid XML in default JATS output with pandoc-citeproc.
5364 * `lua-filters.md`: use real-world man page filter as example.
5366 * Add lua filter functions `walk_inline` and `walk_block`
5367 in the pandoc module, to apply filters inside particular
5368 inline and block elements.
5370 * Refactored some code from `Text.Pandoc.Lua.PandocModule`
5371 into new internal module `Text.Pandoc.Lua.Filter`.
5373 * Markdown reader:
5375 + Allow fenced code blocks to be indented 1-3 spaces (#4011).
5376 This brings our handling of them into alignment with CommonMark's.
5377 + Fix YAML metadata with "chomp" (`|-`). Previously if a
5378 YAML block under `|-` contained a blank line, pandoc would
5379 not parse it as metadata.
5381 * Removed `etc.` from abbreviations file. Often `etc.` ends a
5382 sentence, and we want the period to be treated as a
5383 sentence-ending period.
5385 * Fix regression with `--metadata` (#4054). Values specified with
5386 `--metadata` should replace a metadata value set in the document
5387 itself, rather than creating a list including a new value.
5389 * EPUB writer:
5391 + Fix EPUB OCF structure. #3720 had been improperly implemented.
5392 + Fix modified paths for raw HTML tags (src, poster, etc.)
5393 (#4050, #4055). This had not been updated for the new EPUB
5394 container layout, with a separate text/ subdirectory.
5395 + Fix image paths with empty `--epub-subdirectory`.
5397 * Miscellaneous code cleanup (Alexander Krotov).
5399 * Use pandoc-types 1.17.3, which adds `Walkable` instances
5400 for `[Block] Block` and `[Inline] Inline`.
5402 * Remove obsolete `stack.full.yaml` (#4052).
5404 * Change to using pandoc-citeproc 0.12.1 in binary packages.
5406 * Consolidate math output method documentation (#4049, Mauro Bieg).
5408 * `MANUAL.txt`: fix header level of "Extension: emoji" (Albert Krewinkel).
5410 * Use lua filter to generate man page from `MANUAL.txt`, replacing old
5411 Haskell filters. This is easier and faster.
5413 * Improved `INSTALL.md`.
5415 * Update commands to extract deb archive on Linux (#4043, Salim B).
5418## pandoc 2.0.1.1 (2017-11-04)
5420 * Improved fix to #3989 (parsing of HTML tags containing
5421 `>` in an attribute or comment). The previous fix (in 2.0.1) only
5422 worked in certain cases.
5424 * FB2 writer (Alexander Krotov):
5426 + Add `unrecognised` genre to `<title-info>`
5427 (Alexander Krotov). XML schema requires at least one genre.
5428 + Remove `<annotation>` from `<body>`.
5430 * CommonMark writer: fix strikethrough for `gfm` (#4038).
5432 * Use texmath 0.10, which adds support for a wider range of
5433 symbols and fixes default column alignments in MathML
5434 and OMML.
5436 * Highlighting fixes, using skylighting 0.4.3.2:
5438 + Fix invalid CSS.
5439 + Support `lineAnchors` (or `line-anchors`) in HTML code blocks.
5440 + Ensure that code lines don't get duplicate identifiers (#4031).
5441 The line identifiers are built using the code block's identifier
5442 as a prefix. If the code block has null identifier, we use
5443 `cb1`, `cb2`, etc.
5445 * Added a few abbreviations to `data/abbreviations`,
5446 and sorted the list (#3984, Wandmalfarbe).
5448 * Improved support for columns in HTML writer (#4028).
5450 + Remove `width` attribute from the `div`.
5451 + Remove space between `<div class="column">` elements,
5452 since this prevents columns whose widths sum to 100%
5453 (the space takes up space).
5454 + Move as much as possible of the CSS to the template.
5455 + Ensure that all the HTML-based templates (including epub)
5456 contain the CSS for columns.
5457 + Columns default to 50% width unless they are given a width
5458 attribute. So if you want two equal-width columns, you
5459 can use a div with class `column` and no `width` attribute.
5461 * SelfContained: use `base64` for css links with media attribute (#4026).
5462 This fixes `--self-contained` with S5.
5464 * Improve `pandoc-template-mode.el` (Vaclav Haisman).
5466 * INSTALL.md: MacOS instructions needed xar -f (adam234).
5468 * MANUAL.txt:
5470 + Clarify that --setext-headers doesn't affect gfm output (#4035).
5471 + Clarify what is needed to open and close a div in `fenced_divs`
5472 (#4039, Tristano Ajmone).
5473 + Removed reference to `default.beamer` in docs (#4024).
5474 Also added mention of other templates affecting PDF output
5475 with different settings.
5478## pandoc 2.0.1 (2017-10-31)
5480 * Fixed regression in parsing of HTML comments in markdown and other
5481 non-HTML formats (`Text.Pandoc.Readers.HTML.htmlTag`) (#4019).
5482 The parser stopped at the first `>` character, even if it wasn't
5483 the end of the comment.
5485 * Creole reader (Sascha Wilde):
5487 + Fix some minor typos and formatting.
5488 + Add additional test on nowiki-block after para.
5489 + Fix lists with trailing white space.
5491 * LaTeX reader: handle `%` comment right after command.
5492 For example, `\emph%`.
5494 * Markdown reader: make sure fenced div closers work in lists.
5495 Previously the following failed:
5497 ::: {.class}
5498 1. one
5499 2. two
5500 :::
5502 and you needed a blank line before the closing `:::`.
5504 * Make `fenced_divs` affect the Markdown writer. If `fenced_divs` is
5505 enabled, Divs will be rendered as fenced divs.
5507 * LaTeX/Beamer writer: support "blocks" inside columns and other Divs
5508 (#4016).
5510 * HTML Writer: consistently use dashed class-names (Mauro Bieg, #3556).
5511 Note: this change may require some changes in CSS rules.
5512 `footnoteRef` has become `footnote-ref`, `titleslide` has
5513 become `title-slide`, and `footnoteBack` has become `footnote-back`.
5515 * JATS writer: Properly pass through author metadata (#4020).
5517 * FB2 writer (Alexander Krotov):
5519 + Write blocks outside of `<p>` in definitions.
5520 + Make bullet lists consistent with ordered lists, repeating
5521 the marker for the outer list rather than indenting sublists,
5522 since indentation does not work in readers.
5523 + Add new style FB2 tests.
5525 * `Text.Pandoc.ImageSize`: Add `Millimeter` constructor to `Dimension`
5526 (#4012) [API change]. Now sizes given in 'mm' are no longer converted
5527 to 'cm'.
5529 * Revise documentation of small caps syntax (Andrew Dunning, #4013).
5531 * Fix broken reference links in manual (Andrew Dunning, #4014)
5533 * Fixed example of slide columns structure in changelog (#4015).
5534 Also documented this feature in MANUAL.txt.
5537## pandoc 2.0.0.1 (2017-10-30)
5539 * EPUB writer:
5541 + Fixed filepaths for nonstandard epub-subdirectory values.
5542 + Ensure that epub2 is recognized as a non-text format,
5543 so that a template is used.
5544 + Don't include "prefix" attribute for ibooks for epub2.
5545 It doesn't validate.
5546 + Fix stylesheet paths; previously we had an incorrect
5547 stylesheet path for the cover page and nav page.
5549 * LaTeX reader:
5551 + Insert space when needed in macro expansion (#4007).
5552 Sometimes we need to insert a space after a control sequence
5553 to prevent it merging with a following letter.
5554 + Allow unbraced arguments for macros (#4007).
5555 + Allow body of macro definition to be unbraced (#4007).
5557 * Linux package build: ensure that pandoc-citeproc is statically linked.
5559 * trypandoc: add native, ms.
5562## pandoc 2.0 (2017-10-29)
5564### New features
5566 * New output format `ms` (groff ms). Complete support, including
5567 tables, math, syntax highlighting, and PDF bookmarks. The writer uses
5568 texmath's new eqn writer to convert math to eqn format, so a ms file
5569 produced with this writer should be processed with `groff -ms -e` if
5570 it contains math.
5572 * New output format `jats` (Journal Article Tag Suite). This is an XML
5573 format used in archiving and publishing articles. Note that a
5574 URI-encoded CSL stylesheet (`data/jats.csl`) is added automatically
5575 unless a stylesheet is specified using `--css`.
5577 * New output format `gfm` (GitHub-flavored CommonMark) (#3841).
5578 This uses bindings to GitHub's fork of cmark, so it should parse
5579 gfm exactly as GitHub does (excepting certain postprocessing
5580 steps, involving notifications, emojis, etc.). `markdown_github`
5581 has been deprecated in favor of `gfm`.
5583 * New output format `muse` (Emacs Muse) (Alexander Krotov, #3489).
5585 * New input format `gfm` (GitHub-flavored CommonMark) (#3841).
5586 This uses bindings to GitHub's fork of cmark. `markdown_github`
5587 has been deprecated in favor of `gfm`.
5589 * New input format `muse` (Emacs Muse) reader (Alexander Krotov, #3620).
5591 * New input format `tikiwiki` (TikiWiki markup) (rlpowell, #3800).
5593 * New input format `vimwiki` (Vimwiki markup) (Yuchen Pei, #3705).
5594 Note that there is a new data file, `data/vimwiki.css`, which can
5595 be used to display the HTML produced by this reader and
5596 pandoc's HTML writer in the style of vimwiki's own HTML
5597 export.
5599 * New input format `creole` (Creole 1.0) (#3994, Sascha Wilde).
5601 * New syntax for Divs, with `fenced_divs` extension enabled by
5602 default (#168). This gives an attractive, plain-text way to create
5603 containers for block-level content.
5605 * Added new syntax for including raw content in any output format,
5606 enabled by the `raw_attribute` extension (which is on by default
5607 for `markdown` and `multimarkdown`). The syntax is the same as
5608 for fenced code blocks or code inlines, only with `{=FORMAT}` for
5609 attributes, where `FORMAT` is the name of the output format
5610 (e.g., `ms`, `html`).
5612 * Implement multicolumn support for slide formats (#1710).
5613 The structure expected is:
5615 :::::::::::::: {.columns}
5616 ::: {.column width="40%"}
5617 contents...
5618 :::
5619 ::: {.column width="60%"}
5620 contents...
5621 :::
5622 ::::::::::::::
5624 Support has been added for beamer and all HTML slide formats.
5626 * Allows line comments in templates, beginning with `$--` (#3806).
5627 (Requires doctemplates 0.2.1.)
5629 * Add `--eol=crlf|lf|native` flag and writer option to control line endings
5630 (Stefan Dresselhaus, #3663, #2097).
5632 * Add `--log` option to save log messages in JSON format to a file (#3392).
5634 * Add `--request-header` option, to set request headers when pandoc
5635 makes HTTP requests to fetch external resources. For example:
5636 `--request-header User-Agent:blah`.
5638 * Added lua filters (Albert Krewinkel, #3514). The new `--lua-filter`
5639 option works like `--filter` but takes pathnames of special lua filters
5640 and uses the lua interpreter baked into pandoc, so that no external
5641 interpreter is needed. Note that lua filters are all applied after
5642 regular filters, regardless of their position on the command line.
5643 For documentation of lua filters, see `doc/lua-filters.md`.
5645 * Set `PANDOC_READER_OPTIONS` in environment where filters are run.
5646 This contains a JSON representation of `ReaderOptions`, so filters
5647 can access it.
5649 * Support creation of pdf via groff `ms` and pdfroff.
5650 `pandoc -t ms -o output.pdf input.txt`.
5652 * Support for PDF generation via HTML and `weasyprint` or `prince`
5653 (Mauro Bieg, #3909). `pandoc -t html5 -o output.pdf --pdf-engine=prince`.
5655 * Added `--epub-subdirectory` option (#3720). This specifies the
5656 subdirectory in the OCF container that holds the EPUB specific content.
5657 We now put all EPUB related content in an `EPUB/` subdirectory by default
5658 (later this will be configurable).
5660 ```
5661 mimetype
5662 META-INF/
5663 com.apple.ibooks.display-options.xml
5664 container.xml
5665 EPUB/ <<--configurable-->>
5666 fonts/ <<--static-->>
5667 font.otf
5668 media/ <<--static-->>
5669 cover.jpg
5670 fig1.jpg
5671 styles/ <<--static-->>
5672 stylesheet.css
5673 content.opf
5674 toc.ncx
5675 text/ <<--static-->>
5676 ch001.xhtml
5677 ```
5679 * Added `--resource-path=SEARCHPATH` command line option (#852).
5680 SEARCHPATH is separated by the usual character, depending on OS
5681 (: on unix, ; on windows). Default resource path is just working
5682 directory. However, the working directory must be explicitly
5683 specified if the `--resource-path` option is used.
5685 * Added --abbreviations=FILE option for custom abbreviations file
5686 (#256). Dfault abbreviations file (`data/abbreviations`) contains
5687 a list of strings that will be recognized by pandoc's
5688 Markdown parser as abbreviations. (A nonbreaking space will
5689 be inserted after the period, preventing a sentence space in
5690 formats like LaTeX.) Users can override the default by putting a file
5691 abbreviations in their user data directory (`~/.pandoc` on *nix).
5693 * Allow a theme file as argument to `--highlight-style`.
5694 Also include a sample, `default.theme`, in `data/`.
5696 * Allow `--syntax-definition` option for dynamic loading of syntax
5697 highlighting definitions (#3334).
5699 * Lists in `markdown` by default now use the CommonMark variable
5700 nesting rules (#3511). The indentation required for a block-level
5701 item to be included in a list item is no longer fixed, but is
5702 determined by the first line of the list item. To be included in
5703 the list item, a block must be indented to the level of the first
5704 non-space content after the list marker. Exception: if are 5 or more
5705 spaces after the list marker, then the content is interpreted as an
5706 indented code block, and continuation paragraphs must be indented
5707 two spaces beyond the end of the list marker. See the CommonMark
5708 spec for more details and examples.
5710 Documents that adhere to the four-space rule should, in most cases,
5711 be parsed the same way by the new rules. Here are some examples
5712 of texts that will be parsed differently:
5714 - a
5715 - b
5717 will be parsed as a list item with a sublist; under the four-space
5718 rule, it would be a list with two items.
5720 - a
5722 code
5724 Here we have an indented code block under the list item, even though it
5725 is only indented six spaces from the margin, because it is four spaces
5726 past the point where a continuation paragraph could begin. With the
5727 four-space rule, this would be a regular paragraph rather than a code
5728 block.
5730 - a
5732 code
5734 Here the code block will start with two spaces, whereas under
5735 the four-space rule, it would start with `code`. With the four-space
5736 rule, indented code under a list item always must be indented eight
5737 spaces from the margin, while the new rules require only that it
5738 be indented four spaces from the beginning of the first non-space
5739 text after the list marker (here, `a`).
5741 This change was motivated by a slew of bug reports from people
5742 who expected lists to work differently (#3125, #2367, #2575, #2210,
5743 #1990, #1137, #744, #172, #137, #128) and by the growing prevalance
5744 of CommonMark (now used by GitHub, for example). Those who
5745 prefer the old behavior can use `-f markdown+four_space_rule`.
5747 * Added `four_space_rule` extension. This triggers the old pandoc
5748 parsing rule for content nested under list items (the "four space
5749 rule").
5751 * Added `spaced_reference_links` extension (#2602). It allows whitespace
5752 between the two parts of a reference link: e.g.
5754 [a] [b]
5756 [b]: url
5758 This was previously enabled by default; now it is forbidden by default.
5760 * Add `space_in_atx_header` extension (#3512). This is enabled by default
5761 in pandoc and GitHub markdown but not the other flavors.
5762 This requirse a space between the opening #'s and the header
5763 text in ATX headers (as CommonMark does but many other implementations
5764 do not). This is desirable to avoid falsely capturing things ilke
5766 #hashtag
5768 or
5770 #5
5772 * Add `sourcefile` and `outputfile` template variables (Roland Hieber,
5773 #3431).
5775 * Allow ibooks-specific metadata in epubs (#2693). You can now have
5776 the following fields in your YAML metadata, and it will be treated
5777 appropriately in the generated EPUB:
5779 ```
5780 ibooks:
5781 version: 1.3.4
5782 specified-fonts: false
5783 ipad-orientation-lock: portrait-only
5784 iphone-orientation-lock: landscape-only
5785 binding: true
5786 scroll-axis: vertical
5787 ```
5790### Behavior changes
5792 * Reader functions no longer presuppose that CRs have been
5793 stripped from the input. (They strip CRs themselves, before
5794 parsing, to simplify the parsers.)
5796 * Added support for translations (localization) (#3559).
5797 Currently this only affects the LaTeX reader, for things
5798 like `\figurename`. Translation data files for 46 languages
5799 can be found in `data/translations`.
5801 * Make `--ascii` work with DocBook output too.
5803 * Rename `--latex-engine` to `--pdf-engine`,
5804 and `--latex-engine-opt` to `--pdf-engine-opt`.
5806 * Removed `--parse-raw` and `readerParseRaw`. These were confusing.
5807 Now we rely on the `+raw_tex` or `+raw_html` extension with latex or html
5808 input. Thus, instead of `--parse-raw -f latex` we use `-f latex+raw_tex`,
5809 and instead of `--parse-raw -f html` we use `-f html+raw_html`.
5811 * With `--filter` R filters are now recognized, even if they are
5812 not executable (#3940, #3941, Andrie de Vries).
5814 * Support SVG in PDF output, converting with `rsvg2pdf` (#1793).
5816 * Make epub an alias for epub3, not epub2.
5818 * Removed `--epub-stylesheet`; use `--css` instead (#3472, #847).
5819 Multiple stylesheets may be used. Stylesheets will be taken both from
5820 `--css` and from the `stylesheet` metadata field (which can contain
5821 either a file path or a list of them).
5823 * `--mathml` and MathML in HTMLMathMethod no longer take an argument.
5824 The argument was for a bridge JavaScript that used to be necessary
5825 in 2004. We have removed the script already.
5827 * `--katex` improvements. The latest version is used, and the
5828 autoload script is loaded by default.
5830 * Change MathJax CDN default since old one is shutting down (#3544).
5831 Note: The new URL requires a version number, which we'll have
5832 to update manually in subsequent pandoc releases in order to
5833 take advantage of mathjax improvements.
5835 * `--self-contained`: don't incorporate elements with `data-external="1"`
5836 (#2656). You can leave an external link as it is by adding the attribute
5837 data-external="1" to the element. Pandoc will then not try to
5838 incorporate its content when `--self-contained` is used. This is
5839 similar to a feature already supported by the EPUB writer.
5841 * Allow `--extract-media` to work with non-binary input formats
5842 (#1583, #2289). If `--extract-media` is supplied with a non-binary
5843 input format, pandoc will attempt to extract the contents of all
5844 linked images, whether in local files, data: uris, or external uris.
5845 They will be named based on the sha1 hash of the contents.
5847 * Make `papersize: a4` work regardless of the case of `a4`.
5848 It is converted to `a4` in LaTeX and `A4` in ConTeXt.
5850 * Make `east_asian_line_breaks` affect all readers/writers (#3703).
5852 * Underlined elements are now treated consistently by readers
5853 (#2270, hftf); they are always put in a Span with class `underline`.
5854 This allows the user to treat them differently from other emphasis,
5855 using a filter. Docx, Org, Textile, Txt2Tags, and HTML readers
5856 have been changed.
5858 * Improved behavior of `auto_identifiers` when there are explicit ids
5859 (#1745). Previously only autogenerated ids were added to the list
5860 of header identifiers in state, so explicit ids weren't taken
5861 into account when generating unique identifiers. Duplicated
5862 identifiers could result. This simple fix ensures that explicitly given
5863 identifiers are also taken into account.
5865 * Use `table-of-contents` for contents of toc, make `toc` a boolean
5866 (#2872). Changed markdown, rtf, and HTML-based templates accordingly.
5867 This allows you to set `toc: true` in the metadata; this
5868 previously produced strange results in some output formats.
5869 For backwards compatibility, `toc` is still set to the
5870 toc contents. But it is recommended that you update templates
5871 to use `table-of-contents` for the toc contents and `toc`
5872 for a boolean flag.
5874 * Change behavior with binary format output to stdout.
5875 Previously, for binary formats, output to stdout was disabled
5876 unless we could detect that the output was being piped (and not
5877 sent to the terminal). Unfortunately, such detection is not
5878 possible on Windows, leaving windows users no way to pipe binary
5879 output. So we have changed the behavior in the following way:
5881 + Output to stdout is allowed when it can be determined that
5882 the output is being piped (on non-Windows platforms).
5883 + If the `-o` option is not used, binary output is never sent
5884 to stdout by default; instead, an error is raised.
5885 + If `-o -` is used, binary output is sent to stdout, regardless
5886 of whether it is being piped. This works on Windows too.
5888 * Better error behavior: uses of `error` have been replaced by
5889 raising of `PandocError`, which can be trapped and handled by the
5890 calling program.
5892 * Removed `hard_line_breaks` extension from `markdown_github` (#3594).
5893 GitHub has two Markdown modes, one for long-form documents like READMEs
5894 and one for short things like issue coments. In issue comments, a line
5895 break is treated as a hard line break. In README, wikis, etc., it is
5896 treated as a space as in regular Markdown. Since pandoc is more likely to
5897 be used to convert long-form documents from GitHub Markdown,
5898 `-hard_line_breaks` is a better default.
5900 * Include `backtick_code_blocks` extension in `mardkown_mmd` (#3637).
5902 * Escape `MetaString` values (as added with `-M/--metadata` flag) (#3792).
5903 Previously they would be transmitted to the template without any
5904 escaping. Note that `--M title='*foo*'` yields a different result from
5906 ---
5907 title: *foo*
5908 ---
5910 In the latter case, we have emphasis; in the former case, just
5911 a string with literal asterisks (which will be escaped
5912 in formats, like Markdown, that require it).
5914 * Allow `em`, `cm`, `in` for image height/width in HTML, LaTeX (#3450).
5916 * HTML writer: Insert `data-` in front of unsupported attributes. Thus,
5917 a span with attribute `foo` gets written to HTML5 with `data-foo`, so
5918 it is valid HTML5. HTML4 is not affected. This will allow us to use
5919 custom attributes in pandoc without producing invalid HTML. (With help
5920 from Wandmalfarbe, #3817.)
5922 * Plain writer: improved super/subscript rendering. We now
5923 handle more non-digit characters for which there are
5924 sub/superscripted unicode characters. When unicode
5925 sub/superscripted characters are not available, we use
5926 `_(..)` or `^(..)` (#3518).
5928 * Docbook, JATS, TEI writers: print INFO message when omitting interior
5929 header (#3750). This only applies to section headers inside list items,
5930 e.g., which were otherwise silently omitted.
5932 * Change to `--reference-links` in Markdown writer (#3701). With
5933 `--reference-location` of `section` or `block`, pandoc will now repeat
5934 references that have been used in earlier sections. The Markdown
5935 reader has also been modified, so that *exactly* repeated references
5936 do not generate a warning, only references with the same label but
5937 different targets. The idea is that, with references after every block,
5938 one might want to repeat references sometimes.
5940 * ODT/OpenDocument writer:
5942 + Support `lang` attribute (#1667).
5943 + Added support for `--toc` (#2836). Thanks to @anayrat.
5945 * Docx writer:
5947 + `lang` meta, see #1667 (Mauro Bieg, #3515).
5948 + Change `FigureWithCaption` to `CaptionedFigure` (iandol, #3658).
5949 + Use `Table` rather than `Table Normal` for table style (#3275).
5950 `Table Normal` is the default table style and can't be modified.
5951 + Pass through comments (#2994). We assume that comments are defined as
5952 parsed by the docx reader:
5954 I want <span class="comment-start" id="0" author="Jesse Rosenthal"
5955 date="2016-05-09T16:13:00Z">I left a comment.</span>some text to
5956 have a comment <span class="comment-end" id="0"></span>on it.
5958 We assume also that the id attributes are unique and properly
5959 matched between comment-start and comment-end.
5960 + Bookmark improvements. Bookmark start/end now surrounds content rather
5961 than preceding it. Bookmarks generated for Div with id
5962 (jgm/pandoc-citeproc#205).
5963 + Add `keywords` metadata to docx document properties (Ian).
5965 * RST writer: support unknown interpreted text roles by
5966 parsing them as `Span` with `role` attributes (#3407). This
5967 way they can be manipulated in the AST.
5969 * HTML writer:
5971 + Line block: Use class instead of style attribute (#1623). We now
5972 issue `<div class="line-block">` and include a default definition
5973 for `line-block` in the default templates, instead of hard-coding a
5974 `style` on the div.
5975 + Add class `footnoteBack` to footnote back references (Timm Albers).
5976 This allows for easier CSS styling.
5977 + Render SmallCaps as span with smallcaps class (#1592), rather than
5978 using a style attribute directly. This gives the user more flexibility
5979 in styling small caps in CSS.
5980 + With reveal.js we use `data-src` instead of `src` for images for
5981 lazy loading.
5982 + Special-case `.stretch` class for images in reveal.js (#1291).
5983 Now in reveal.js, an image with class `stretch` in a paragraph
5984 by itself will stretch to fill the whole screen, with no
5985 caption or figure environment.
5987 * Added warnings for non-rendered blocks to writers.
5989 * Writers now raise an error on template failure.
5991 * When creating a PDF via LaTeX, warn if the font is missing some
5992 characters (#3742).
5994 * Remove initial check for PDF-creating program (#3819).
5995 Instead, just try running it and raise the exception if it
5996 isn't found at that point. This improves things for users of Cygwin
5997 on Windows, where the executable won't be found by `findExecutable`
5998 unless `.exe` is added. The same exception is raised as before, but
5999 at a later point.
6001 * Readers issue warning for duplicate header identifiers (#1745).
6002 Autogenerated header identifiers are given suffixes so as not to clash
6003 with previously used header identifiers. But they may still coincide with
6004 an explicit identifier that is given for a header later in the document,
6005 or with an identifier on a div, span, link, or image. We now issue
6006 a warning in this case, so users can supply an explicit identifier.
6008 * CommonMark reader now supports `emoji`, `hard_line_breaks`, `smart`,
6009 and `raw_html` extensions.
6011 * Markdown reader:
6013 + Don't allow backslash + newline to affect block structure (#3730).
6014 Note that as a result of this change, the following, which formerly
6015 produced a header with two lines separated by a line break, will
6016 now produce a header followed by a paragraph:
6018 # Hi\
6019 there
6021 This may affect some existing documents that relied on
6022 this undocumented and unintended behavior. This change makes pandoc
6023 more consistent with other Markdown implementations, and with itself
6024 (since the two-space version of a line break doesn't work inside ATX
6025 headers, and neither version works inside Setext headers).
6028 * Org reader (Albert Krewinkel, unless noted):
6030 + Support `table.el` tables (#3314).
6031 + Support macros (#3401).
6032 + Support the `#+INCLUDE:` file inclusion mechanism (#3510).
6033 Recognized include types are `example`, `export`, `src`, and
6034 normal org file inclusion. Advanced features like line numbers
6035 and level selection are not implemented yet.
6036 + Interpret more meta value as inlines. The values of the following
6037 meta variables are now interpreted using org-markup instead of
6038 treating them as pure strings: `keywords` (comma-separated list of
6039 inlines), `subtitle` (inline values), `nocite` (inline values, can
6040 be repeated).
6041 + Support `\n` export option (#3940). This turns all newlines in the
6042 text into hard linebreaks.
6044 * RST reader:
6046 + Improved admonition support (#223). We no longer add an
6047 `admonition` class, we just use the class for the type of admonition,
6048 `note` for example. We put the word corresponding to the label in
6049 a paragraph inside a `Div` at the beginning of the admonition with
6050 class `admonition-title`. This is about as close as we can get to
6051 RST's own output.
6052 + Initial support of `.. table` directive. This allows adding captions
6053 to tables.
6054 + Support `.. line-block` directive. This is deprecated but may still
6055 be in older documents.
6056 + Support scale and align attributes of images (#2662).
6057 + Implemented implicit internal header links (#3475).
6058 + Support RST-style citations (#853). The citations appear at the end
6059 of the document as a definition list in a special div with id
6060 `citations`. Citations link to the definitions.
6061 + Recurse into bodies of unknown directives (#3432).
6062 In most cases it's better to preserve the content than
6063 to emit it. This isn't guaranteed to have good results;
6064 it will fail spectacularly for unknown raw or verbatim directives.
6065 + Handle chained link definitions (#262). For example,
6067 .. _hello:
6068 .. _goodbye: example.com
6070 Here both `hello` and `goodbye` should link to `example.com`.
6071 + Support anchors (#262). E.g.
6073 `hello`
6075 .. _hello:
6077 paragraph
6079 This is supported by putting "paragraph" in a `Div` with id `hello`.
6080 + Support `:widths:` attribute for table directive.
6081 + Implement csv-table directive (#3533). Most attributes are supported,
6082 including `:file:` and `:url:`.
6083 + Support unknown interpreted text roles by parsing them as Span
6084 with "role" attributes (#3407). This way they can be manipulated in
6085 the AST.
6087 * HTML reader: parse a span with class `smallcaps` as `SmallCaps`.
6089 * LaTeX reader:
6091 + Implemented `\graphicspath` (#736).
6092 + Properly handle column prefixes/suffixes. For example, in
6093 `\begin{tabular}{>{$}l<{$}>{$}l<{$} >{$}l<{$}}`
6094 each cell will be interpreted as if it has a `$`
6095 before its content and a `$` after (math mode).
6096 + Handle komascript `\dedication` (#1845). It now adds a
6097 `dedication` field to metadata. It is up to the user to supply
6098 a template that uses this variable.
6099 + Support all `\textXX` commands, where XX = `rm`, `tt`, `up`, `md`,
6100 `sf`, `bf` (#3488). Spans with a class are used when there is
6101 nothing better.
6102 + Expand `\newenvironment` macros (#987).
6103 + Add support for LaTeX subfiles package (Marc Schreiber, #3530).
6104 + Better support for subfigure package (#3577).
6105 A figure with two subfigures turns into two pandoc
6106 figures; the subcaptions are used and the main caption
6107 ignored, unless there are no subcaptions.
6108 + Add support for `\vdots` (Marc Schreiber, #3607).
6109 + Add basic support for hyphenat package (Marc Schreiber, #3603).
6110 + Add basic `\textcolor` support (Marc Schreiber).
6111 + Add support for `tabularx` environment (Marc Schreiber, #3632).
6112 + Better handling of comments inside math environments (#3113).
6113 This solves a problem with commented out `\end{eqnarray}` inside
6114 an eqnarray (among other things).
6115 + Parse tikzpicture as raw verbatim environment if `raw_tex` extension
6116 is selected (#3692). Otherwise skip with a warning. This is better
6117 than trying to parse it as text!
6118 + Add `\colorbox` support (Marc Schreiber).
6119 + Set identifiers on Spans used for `\label`.
6120 + Have `\setmainlanguage` set `lang` in metadata.
6121 + Support etoolbox's `\ifstrequal`.
6122 + Support `plainbreak`, `fancybreak` et al from the memoir class
6123 (bucklereed, #3833).
6124 + Support `\let`. Also, fix regular macros so they're expanded at the
6125 point of use, and NOT also the point of definition. `\let` macros,
6126 by contrast, are expanded at the point of definition. Added an
6127 `ExpansionPoint` field to `Macro` to track this difference.
6128 + Support simple `\def` macros. Note that we still don't support
6129 macros with fancy parameter delimiters, like `\def\foo#1..#2{...}`.
6130 + Support `\chaptername`, `\partname`, `\abstractname`, etc. (#3559,
6131 obsoletes #3560).
6132 + Put content of `\ref`, `\label`, `\eqref` commands into `Span` with
6133 attributes, so they can be handled in filters (Marc Schreiber, #3639)
6134 + Add Support for `glossaries` and `acronym` package (Marc Schreiber,
6135 #3589). Acronyms are not resolved by the reader, but acronym and
6136 glossary information is put into attributes on Spans so that they
6137 can be processed in filters.
6138 + Use `Link` instead of `Span` for `\ref`. This makes more sense
6139 semantically and avoids unnecessary `Span [Link]` nestings when
6140 references are resolved.
6141 + Rudimentary support for `\hyperlink`.
6142 + Support `\textquoteleft|right`, `\textquotedblleft|right` (#3849).
6143 + Support `\lq`, `\rq`.
6144 + Implement `\newtoggle`, `\iftoggle`, `\toggletrue|false` from etoolbox
6145 (#3853).
6146 + Support `\RN` and `\Rn`, from biblatex (bucklereed, #3854).
6147 + Improved support for `\hyperlink`, `\hypertarget` (#2549).
6148 + Support `\k` ogonek accent.
6149 + Improve handling of accents. Handle ogonek, and fall back correctly
6150 with forms like `\"{}`.
6151 + Better support for ogonek accents.
6152 + Support for `\faCheck` and `\faClose` (Marc Schreiber, #3727).
6153 + Support for `xspace` (Marc Schreiber, #3797).
6154 + Support `\setmainlanguage` or `\setdefaultlanguage` (polyglossia)
6155 and `\figurename`.
6156 + Better handling of `\part` in LaTeX (#1905). Now we parse chapters as
6157 level 0 headers, and parts as level -1 headers. After parsing, we
6158 check for the lowest header level, and if it's less than 1 we bump
6159 everything up so that 1 is the lowest header level. So `\part` will
6160 always produce a header; no command-line options are needed.
6161 + Add block version of `\textcolor` (Marc Schreiber).
6162 + `\textcolor` works as inline and block command (Marc Schreiber).
6163 + `\textcolor` will be parse as span at the beginning of a paragraph
6164 (Marc Schreiber).
6165 + Read polyglossia/babel `\text(LANG){...}` (bucklereed)
6166 + Improved handling of include files in LaTeX reader (#3971).
6167 Previously `\include` wouldn't work if the included file
6168 contained, e.g., a begin without a matching end.
6169 + Support `\expandafter` (#3983).
6170 + Handle `\DeclareRobustCommand` (#3983). Currently it's just treated
6171 as a synonym for `\newcommand`.
6172 + Handle `\lettrine` (Mauro Bieg).
6174 * Math improvements due to updates in texmath:
6176 + Improved handling of accents and upper/lower delimiters.
6177 + Support for output in GNU eqn format (used with *roff).
6178 + Allow `\boldsymbol` + a token without braces, and similarly
6179 with other styling commands.
6180 + Improve parsing of `\mathop` to allow multi-character operator names.
6181 + Add thin space after math operators when "faking it with
6182 unicode."
6184 * `walk` is now used instead of `bottomUp` in the `ToJSONFilter`
6185 instance for `a -> [a]` (pandoc-types). Note that behavior
6186 will be slightly different, since `bottomUp`'s treatment of
6187 a function `[a] -> [a]` is to apply it to each sublist of a
6188 list, while walk applies it only to maximal sublists.
6189 Usually the latter behavior is what is wanted, and the
6190 former can be simulated when needed. But there may be
6191 existing filters that need to be rewritten in light of the
6192 new behavior. Performance should be improved.
6194 * There are some changes to syntax highlighting due to revisions
6195 in the `skylighting` library:
6197 + Support for `powershell` has been added, and many syntax
6198 definitions have been updated.
6199 + Background colors have been added to the `kate` style.
6200 + The way highlighted code blocks are formatted in HTML has
6201 been changed (David Baynard), in ways that may require
6202 changes in hard-coded CSS affecting highlighting.
6203 (If you haven't included hard-coded highlighting CSS in
6204 your template, you needn't change anything.)
6207### API changes
6209 * New module `Text.Pandoc.Class` (Jesse Rosenthal, John MacFarlane).
6210 This contains definitions of the `PandocMonad` typeclass, the
6211 `PandocIO` and `PandocPure` monads, and associated functions.
6213 * Changed types of all writers and readers.
6215 + We now use `Text` instead of `String` in the interface (#3731).
6216 (We have not yet changed the internals of most readers to work
6217 with `Text`, but making this change in the API now opens up a
6218 path to doing that.)
6219 + The result is now of form `m a` with constraint `PandocMonad m`.
6220 Readers and writers can be combined to form monadic values which
6221 can be run using either `runIO` or `runPure`. If `runIO` is used,
6222 then both readers and writers will be able to do IO when needed
6223 (for include files, for example); if `runPure` is used,
6224 then the functions are pure and will not touch IO.
6225 + Where previously you used
6226 `writeRST def (readMarkdown def "[foo](url)")`, now you
6227 would use
6228 `runPure $ readMarkdown def (pack "[foo](url)") >>= writeRST def`.
6230 * New module `Text.Pandoc.Readers` (Albert Krewinkel). This
6231 contains reader helper functions formerly defined in the
6232 top-level `Text.Pandoc` module.
6234 + Changed `StringReader` -> `TextReader`.
6235 + `getReader` now returns a pair of a reader and
6236 `Extensions`, instead of building the extensions into the
6237 reader (#3659). The calling code must explicitly set
6238 `readerExtensions` using the `Extensions` returned. The
6239 point of the change is to make it possible for the calling
6240 code to determine what extensions are being used.
6242 * New module `Text.Pandoc.Writers` (Albert Krewinkel).
6243 This contains writer helper functions formerly defined in the
6244 top-level `Text.Pandoc` module.
6246 + Changed `StringWriter` -> `TextWriter`.
6247 + `getWriter` now retuns a pair of a reader and
6248 `Extensions`, instead of building the extensions into the
6249 reader (#3659). The calling code must explicitly set
6250 `readerExtensions` using the `Extensions` returned. The
6251 point of the change is to make it possible for the calling
6252 code to determine what extensions are being used.
6254 * New module `Text.Pandoc.Lua`, exporting `runLuaFilter` (Albert Krewinkel,
6255 #3514).
6257 * New module `Text.Pandoc.App`. This abstracts out the functionality
6258 of the command line program (`convertWithOpts`), so it can be reproduced
6259 e.g. in a desktop or web application. Instead of exiting, we throw errors
6260 (#3548), which are caught (leading to exit) in pandoc.hs, but allow other
6261 users of `Text.Pandoc.App` to recover. `pandoc.hs` is now a 2-liner.
6262 The module also exports some utility functions for parsing options
6263 and running filters.
6265 * New module `Text.Pandoc.Logging` (exported module) (#3392).
6266 This now contains the `Verbosity` definition previously in
6267 `Text.Pandoc.Options`, as well as a new `LogMessage` datatype that will
6268 eventually be used instead of raw strings for warnings. This will enable
6269 us, among other things, to provide machine-readable warnings if desired.
6270 Include ToJSON instance and showLogMessage. This gives us the possibility
6271 of both machine-readable and human-readable output for log messages.
6273 * New module `Text.Pandoc.BCP47`, with `getLang`, `Lang(..)`, `parseBCP47`.
6275 * New module `Text.Pandoc.Translations`, exporting `Term`,
6276 `Translations`, `readTranslations`.
6278 * New module `Text.Pandoc.Readers.LaTeX.Types', exporting `Macro`, `Tok`,
6279 `TokType`, `Line`, `Column`.
6281 * `Text.Pandoc.Error`: added many new constructors for `PandocError`.
6283 * Expose some previously private modules (#3260). These are often
6284 helpful to people writing their own reader or writer modules:
6286 + `Text.Pandoc.Writers.Shared`
6287 + `Text.Pandoc.Parsing`
6288 + `Text.Pandoc.Asciify`
6289 + `Text.Pandoc.Emoji`
6290 + `Text.Pandoc.ImageSize`
6291 + `Text.Pandoc.Highlighting`
6293 * New module `Text.Pandoc.Extensions` (Albert Krewinkel):
6294 Extension parsing and processing functions were defined in the top-level
6295 `Text.Pandoc` module. These functions are moved to the Extensions
6296 submodule as to enable reuse in other submodules.
6298 * Add `Ext_raw_attribute` constructor for `Extension`.
6300 * Add `Ext_fenced_divs` constructor for `Extension'.
6302 * Add `Ext_four_space_rule` constructor in `Extension`.
6304 * Add `Ext_gfm_auto_identifiers` constructor for `Extension`.
6306 * Add `Monoid` instance for `Extensions`.
6308 * Add `Text.Pandoc.Writers.Ms`, exporting `writeMs`.
6310 * Add `Text.Pandoc.Writers.JATS`, exporting `writeJATS`.
6312 * Add `Text.Pandoc.Writers.Muse`, exporting `writeMuse`.
6314 * Add `Text.Pandoc.Readers.Muse`, exporting `readMuse`.
6316 * Add `Text.Pandoc.Readers.TikiWiki`, exporting `readTikiWiki`.
6318 * Add `Text.Pandoc.Readers.Vimwiki`, exporting `readVimwiki`.
6320 * Add `Text.Pandoc.Readers.Creole`, exporting `readCreole`.
6322 * Export `setVerbosity` from `Text.Pandoc`.
6324 * `Text.Pandoc.Pretty`: Add `Eq` instance for `Doc`.
6326 * `Text.Pandoc.XML`: `toEntities`: changed type to `Text -> Text`.
6328 * `Text.Pandoc.UTF8`:
6330 + Export `fromText`, `fromTextLazy`, `toText`, `toTextLazy`.
6331 Define `toString`, `toStringLazy` in terms of them.
6332 + Add new functions parameterized on `Newline`: `writeFileWith`,
6333 `putStrWith`, `putStrLnWith`, `hPutStrWith`, `hPutStrLnWith`.
6335 * `Text.Pandoc.MediaBag`: removed `extractMediaBag`.
6337 * `Text.Pandoc.Highlighting`:
6339 + `highlighting` now returns an Either rather than Maybe.
6340 This allows us to display error information returned by the skylighting
6341 library. Display a warning if the highlighting library throws an error.
6342 + Add parameter for `SyntaxMap` to `highlight`.
6344 * `Text.Pandoc.Writers.Math`:
6346 + Export `defaultMathJaxURL`, `defaultKaTeXURL`. This will ensure that
6347 we only need to update these in one place.
6349 * `Text.Pandoc.SelfContained`:
6351 + Removed `WriterOptions` parameter from `makeSelfContained`.
6352 + Put `makeSelfContained` in PandocMonad instead of IO. This removes
6353 the need to pass MediaBag around and improves exceptions. It also
6354 opens up the possibility of using makeSelfContained purely.
6355 + Export `makeDataURI`.
6357 * `Text.Pandoc.ImageSize`:
6359 + Export `lengthToDim`, new function `scaleDimension`.
6360 + Export `inEm` from ImageSize (#3450).
6361 + Change `showFl` and `show` instance for `Dimension` so
6362 extra decimal places are omitted.
6363 + Added `Em` as a constructor of `Dimension`.
6364 + Add `WriterOptions` parameter to `imageSize` signature (Mauro Bieg).
6366 * `Text.Pandoc.Templates`:
6368 + Change type of `renderTemplate'`. Now it runs in `PandocMonad`
6369 and raises a proper `PandocTemplateError` if there are problems, rather
6370 than failing with uncatchable `error`.
6371 + Change signature of `getDefaultTemplate`. Now it runs in any instance
6372 of `PandocMonad`, and returns a `String` rather than an `Either` value.
6373 And it no longer takes a `datadir` parameter, since this can be
6374 retrieved from `CommonState`.
6376 * `Text.Pandoc.Options`:
6378 + Added `writerEpubSubdirectory` to `WriterOptions` (#3720).
6379 The EPUB writer now takes its EPUB subdirectory from this option.
6380 + In `WriterOptions`, rename `writerLaTeXEngine` to `writerPdfEngine`
6381 and `writerLaTeXArgs` to `writerPdfArgs` (Mauro Bieg, #3909).
6382 + Add `writerSyntaxMap` to `WriterOptions`.
6383 + Removed `writerEpubStylesheet` from `WriterOptions`.
6384 + Remove `writerUserDataDir` from `WriterOptions`. It is now carried
6385 in `CommonState` in `PandocMonad` instances. (And thus it can be used
6386 by readers too.)
6387 + Changed `writerEpubMetadata` to a `Maybe String`.
6388 + Removed `readerApplyMacros` from `ReaderOptions`. Now we just check
6389 the `latex_macros` reader extension.
6390 + FromJSON/ToJSON instances for `ReaderOptions`.
6391 + In `HTMLMathMethod`, the `KaTeX` contsructor now takes only
6392 one string (for the KaTeX base URL), rather than two.
6393 + Removed `writerSourceURL` from `WriterOptions`. We now use
6394 `stSourceURL` in `CommonState`, which is set by `setInputFiles`.
6396 * `Text.Pandoc.Shared`:
6398 + `tabFilter` now takes a `Text`, not `String`.
6399 + `openURL`: Changed type from an Either. Now it will just raise
6400 an exception to be trapped later.
6401 + Remove `normalizeSpaces` (#1530).
6402 + Remove `warn`. (Use `report` from `Text.Pandoc.Class` instead.)
6403 + Export a new function `crFilter`.
6404 + Add `eastAsianLineBreakFilter` (previously in Markdown reader).
6405 + Provide custom `isURI` that rejects unknown schemes.
6406 (Albert Krewinkel, #2713). We also export the set of known
6407 `schemes`. The new function replaces the function of the same name
6408 from `Network.URI`, as the latter did not check whether a scheme is
6409 well-known. All official IANA schemes (as of 2017-05-22) are
6410 included in the set of known schemes. The four non-official schemes
6411 `doi`, `isbn`, `javascript`, and `pmid` are kept.
6412 + Remove `err`.
6413 + Remove `readDataFile`, `readDefaultDataFile`, `getReferenceDocx`,
6414 `getReferenceODT`. These now live in `Text.Pandoc.Class`,
6415 where they are defined in terms of `PandocMonad`
6416 primitives and have different signatures.
6417 + Remove `openURL`. Use `openURL` from `Text.Pandoc.Class` instead.
6418 + Add `underlineSpan`.
6420 * `Text.Pandoc.Readers.HTML`: export new `NamedTag` class.
6422 * `Text.Pandoc.Readers.Markdown`: remove `readDocxWithWarnings`.
6423 With the new API one can simply use `getLog` after running
6424 the reader.
6426 * `Text.Pandoc.Readers.LaTeX`: Changed types for `rawLaTeXInline`
6427 and `rawLaTeXBlock`. (Both now return a `String`, and they are
6428 polymorphic in state.)
6431### Bug fixes and under-the-hood improvements
6433 * TEI writer: Added identifiers on `<div>` elements.
6435 * DokuWiki reader: Better handling for code block in list item (#3824).
6437 * Custom writer: Remove old preprocesesor conditionals (Albert Krewinkel).
6439 * ZimWiki writer: Removed internal formatting from note and table cells,
6440 because ZimWiki does not support it (Alex Ivkin, #3446).
6442 * MediaWiki writer:
6444 + Updated list of syntax highlighting languages (#3461).
6445 Now `r` gets you `<source>` rather than `<code>` (among others).
6446 + Add display attribute on `<math>` tags (#3452). This allows display
6447 math to be rendered properly.
6448 + Remove newline before `</ref>` (#2652).
6449 + Don't softbreak lines inside list items (#3531).
6451 * Org writer:
6453 + Reduce to two spaces after bullets (#3417, Albert Krewinkel).
6454 + Add unit tests (Alexander Krotov).
6455 + Stop using raw HTML to wrap divs (Albert Krewinkel, #3771).
6456 + Do not strip `#` from Org anchor links (Alexander Krotov).
6458 * CommonMark writer:
6460 + Avoid excess blank lines at end of output.
6461 + Prefer pipe tables to HTML tables even if it means losing relative
6462 column width information (#3734).
6463 + Support table, strikethrough extensions, when enabled (as with gfm).
6464 Note that we bypass the commonmark writer from cmark and construct our
6465 own pipe tables, with better results.
6466 + Properly support `--wrap=none`.
6467 + Use smallcaps class for `SmallCaps` (#1592).
6468 + Omit "fig:" prefix in image titles. This is used internally to
6469 indicate internal figures.
6471 * RST writer:
6473 + Properly handle table captions.
6474 + Don't wrap lines in in definition list terms. Wrapping is not allowed.
6475 + Implemented `+/-smart` and improved escaping with `+smart`.
6476 + Add empty comments when needed to avoid including a blockquote
6477 in the indented content of a preceding block (#3675).
6478 + Improve grid table output, fix bug with empty rows (#3516).
6479 Uses the new `gridTable` in Writers.Shared, which is here
6480 improved to better handle 0-width cells.
6481 + Remove space at beginning/end of RST code span (#3496). Otherwise
6482 we get invalid RST. There seems to be no way to escape the space.
6483 + Add header anchors when header has non-standard id (#3937).
6484 + Correctly handle inline code containing backticks, using a `:literal:`
6485 role (#3974).
6486 + Don't backslash-escape word-internal punctuation (#3978).
6488 * Markdown writer:
6490 + Don't include variables in metadata blocks. Previously variables set
6491 on the command line were included in e.g. YAML metadata, contrary to
6492 documentation and intentions.
6493 + Improved escaping with `+smart`.
6494 + Fixed grid tables embedded in grid tables (#2834).
6495 + Use span with class 'smallcaps' for SmallCaps, instead of a style
6496 attribute as before (#1592).
6497 + Escape initial `%` in a paragraph if the `pandoc_title_blocks`
6498 extension is enabled (#3454). Otherwise in a document starting with
6499 a literal `%` the first line is wrongly interpreted as a title.
6500 + Fixed false ordered lists in YAML metadata (#3492, #1685). Now we
6501 properly escape things that would otherwise start ordered lists,
6502 such as
6504 ---
6505 title: 1. inline
6506 ...
6507 + Better handling of tables with empty columns (#3337). We now
6508 calculate the number of columns based on the longest row (or the
6509 length of aligns or widths).
6510 + Escape unordered list markers at beginning of paragraph (#3497), to
6511 avoid false interpretation as a list.
6512 + Escape `|` appropriately.
6513 + Ensure space before list at top level (#3487).
6514 + Avoid spurious blanklines at end of document after tables and list,
6515 for example.
6516 + Fixed bugs in simple/multiline list output (#3384).
6517 Previously we got overlong lists with `--wrap=none`. This is fixed.
6518 Previously a multiline list could become a simple list (and would
6519 always become one with `--wrap=none`).
6520 + Don't emit a simple table if `simple_tables` disabled (#3529).
6521 + Case-insensitive reference links (David A Roberts, #3616).
6522 Ensure that we do not generate reference links whose labels differ only
6523 by case. Also allow implicit reference links when the link
6524 text and label are identical up to case.
6525 + Put space before reference link definitions (Mauro Bieg, #3630).
6526 + Better escaping for links (David A. Roberts, #3619). Previously the
6527 Markdown writer would sometimes create links where there were none
6528 in the source. This is now avoided by selectively escaping bracket
6529 characters when they occur in a place where a link might be created.
6530 + Added missing `\n` (David A. Roberts, #3647).
6531 + Fixed duplicated reference links with `--reference-links`
6532 and `--reference-location=section` (#3674). Also ensure that there
6533 are no empty link references `[]`.
6534 + Avoid inline surround-marking with empty content (#3715).
6535 E.g. we don't want `<strong></strong>` to become `****`.
6536 Similarly for emphasis, super/subscript, strikeout.
6537 + Don't allow soft break in header (#3736).
6538 + Make sure `plain`, `markdown_github`, etc. work for raw.
6539 Previously only `markdown` worked. Note: currently a raw block labeled
6540 `markdown_github` will be printed for any `markdown` format.
6541 + Ensure that `+` and `-` are escaped properly so they don't cause
6542 spurious lists (#3773). Previously they were only
6543 if succeeded by a space, not if they were at end of line.
6544 + Use pipe tables if `raw_html` disabled and `pipe_tables` enabled,
6545 even if the table has relative width information (#3734).
6546 + Markdown writer: don't crash on `Str ""`.
6547 + Make `Span` with null attribute transparent. That is, we don't use
6548 brackets or `<span>` tags to mark spans when there are no attributes;
6549 we simply output the contents.
6550 + Escape pipe characters when `pipe_tables` enabled (#3887).
6551 + Better escaping of `<` and `>`. If `all_symbols_escapable` is set,
6552 we backslash escape these. Otherwise we use entities as before.
6553 + When writing plain, don't use `&nbsp;` to separate list and indented
6554 code. There's no need for it in this context, since this isn't to be
6555 interpreted using Markdown rules.
6556 + Preserve classes in JS obfuscated links (Timm Albers, #2989).
6557 HTML links containing classes originally now preserve them when using
6558 javascript email obfuscation.
6559 + Render `SmallCaps` as a native span when `native_spans` are enabled.
6560 + Always write attributes with `bracketed_spans` (d-dorazio).
6562 * Man writer:
6564 + Fix handling of nested font commands (#3568). Previously pandoc emitted
6565 incorrect markup for bold + italic, for example, or bold + code.
6566 + Avoid error for definition lists with no definitions (#3832).
6568 * DocBook writer:
6570 + Fix internal links with `writerIdentifierPrefix opt`
6571 (#3397, Mauro Bieg).
6573 * Docx writer:
6575 + Don't include bookmarks on headers unless non-null id (#3476).
6576 + Support 9 levels of headers (#1642).
6577 + Allow 9 list levels (#3519).
6578 + Don't take `distArchive` from datadir (#3322). The docx writer takes
6579 components from the distribution's version of `reference.docx` when it
6580 can't find them in a user's custom `reference.docx`. Previously, we
6581 allowed a `reference.docx` in the data directory (e.g. `~/.pandoc`)
6582 to be used as the distribution's reference.docx. This led to a
6583 bizarre situation where pandoc would produce a good docx using
6584 `--template ~/.pandoc/ref.docx`, but if `ref.docx` were moved to
6585 `~/.pandoc/reference.docx`, it would then produce a corrupted docx.
6586 + Fixed handling of soft hyphen (0173) (#3691).
6587 + Better handling of keywords (#3719).
6588 + Cleaner code for handling dir and style attributes for `Div`.
6589 + Use `Set` for dynamic styles to avoid duplicates.
6590 + Removed redundant element from data/docx/word/numbering.xml.
6591 The elements we need are generated when the document is
6592 compiled; this didn't do anything.
6593 + Activate `evenAndOddHeaders` from reference docx (#3901,
6594 Augustín Martín Barbero).
6596 * ODT/OpenDocument writer:
6598 + Calculate aspect ratio for percentage-sized images (Mauro Bieg, #3239).
6599 + Use more widely available bullet characters (#1400). The old
6600 characters weren't available in some font sets. These seem to work
6601 well on Windows and Linux versions of LibreOffice.
6602 + Wider labels for lists (#2421). This avoids overly narrow labels for
6603 ordered lists with `()` delimiters. However, arguably it creates
6604 overly wide labels for bullets. Also, lists now start flush with
6605 the margin, rather than indented.
6606 + Fixed dropped elements in some ordered lists (#2434).
6608 * FB2 writer:
6610 + Don't render `RawBlock` as code.
6611 + Don't fail with an error on interior headers (e.g. in list) (#3750).
6612 Instead, omit them with an INFO message.
6613 + Add support for "lang" metadata (Alexander Krotov, #3625).
6614 + Format `LineBlock` as poem (Alexander Krotov). Previously writer
6615 produced one paragraph with `<empty-line/>` elements, which are not
6616 allowed inside `<p>` according to FB2 schema.
6617 + Replace `concatMap` with `cMap` (Alexander Krotov).
6618 + Write FB2 lists without nesting blocks inside `<p>` (Alexander
6619 Krotov, #4004)
6621 * HTML writer:
6623 + Make sure `html4`, `html5` formats work for raw blocks/inlines.
6624 + Render raw inline environments when `--mathjax` used (#3816).
6625 We previously did this only with raw blocks, on the assumption
6626 that math environments would always be raw blocks. This has changed
6627 since we now parse them as inline environments.
6628 + Ensure we don't get two style attributes for width and height.
6629 + Report when not rendering raw inline/block.
6630 + Issue warning if no title specified and template used (#3473).
6631 + Info message if `lang` is unspecified (#3486).
6632 + Removed unused parameter in `dimensionsToAttributeList`.
6633 + Avoid two class attributes when adding `uri` class (#3716).
6634 + Fix internal links with `writerIdentifierPrefix opt` (#3397, Mauro
6635 Bieg).
6636 + Use revealjs's math plugin for mathjax (#3743). This is a thin
6637 wrapper around mathjax that makes math look better on revealjs.
6638 + Slidy: use h1 for all slides, even if they were originally
6639 level 2 headers (#3566). Otherwise the built-in table of contents
6640 in Slidy breaks.
6642 * LaTeX writer:
6644 + Don't render LaTeX images with data: URIs (#3636). Note that
6645 `--extract-media` can be used when the input contains data: URIs.
6646 + Make highlighted code blocks work in footnotes (Timm Albers).
6647 + Don't use figure inside table cell (#3836).
6648 + Use proper code for list enumerators (#3891). This should fix problems
6649 with lists that don't use arabic numerals.
6650 + Always add hypertarget when there's a non-empty identifier (#2719).
6651 Previously the hypertargets were only added when there was actually
6652 a link to that identifier.
6653 + Use `%` after hypertarget before code block.
6654 + Add `\leavevmode` before hypertarget at start of paragraph (#2704,
6655 fixes formatting problems in beamer citations).
6656 + Don't use `lstinline` in `\item[..]` (#645). If you do, the contents
6657 of item disappear or are misplaced. Use `\texttt` instead.
6658 + Fix problem with escaping in `lstinline` (#1629). Previously the
6659 LaTeX writer created invalid LaTeX when `--listings` was specified and
6660 a code span occurred inside emphasis or another construction.
6661 + Fix error with line breaks after empty content (#2874). LaTeX
6662 requires something before a line break, so we insert a `~` if no
6663 printable content has yet been emitted.
6664 + Use BCP47 parser.
6665 + Fixed detection of otherlangs (#3770). We weren't recursing into
6666 inline contexts.
6667 + Handle language in inline code with `--listings` (#3422).
6668 + Write euro symbol directly in LaTeX (Andrew Dunning, #3801).
6669 The textcomp package allows pdfLaTeX to parse `€` directly, making the
6670 `\euro` command unneeded.
6671 + Fixed footnotes in table captions (#2378). Note that if the table has
6672 a first page header and a continuation page header, the notes will
6673 appear only on the first occurrence of the header.
6674 + In `writeBeamer` output, allow hyperlinks to frames (#3220).
6675 Previously you could link to a header above or below slide level but
6676 not *to* slide level. This commit changes that. Hypertargets are
6677 inserted inside frame titles; technically the reference is to just
6678 after the title, but in normal use (where slides are viewed full
6679 screen in a slide show), this does not matter.
6680 + Remove `\strut` at beginning of table cells (#3436). This fixes a
6681 problem with alignment of lists in table cells. The `\strut` at the
6682 end seems to be enough to avoid the too-close spacing that motivated
6683 addition of the strut in #1573.
6684 + Add partial siunitx Support (Marc Schreiber, #3588).
6686 * ConTeXt writer:
6688 + Refactored to use BCP47 module.
6689 + Remove unnecessary `$` (Alexander Krotov, #3482).
6690 + Use header identifiers for chapters (#3968).
6692 * EPUB writer:
6694 + `title_page.xhtml` is now put in `text/`.
6695 + Don't strip formatting in TOC (#1611).
6697 * Textile reader:
6699 + Fix bug for certain links in table cells (#3667).
6700 + Allow 'pre' code in list item (#3916).
6702 * HTML reader:
6704 + Added warnings for ignored material (#3392).
6705 + Better sanity checks to avoid parsing unintended things as
6706 raw HTML in the Markdown reader (#3257).
6707 + Revise treatment of `li` with `id` attribute (#3596). Previously we
6708 always added an empty div before the list item, but this created
6709 problems with spacing in tight lists. Now we do this: If the list
6710 item contents begin with a `Plain` block, we modify the `Plain`
6711 block by adding a `Span` around its contents. Otherwise, we add a
6712 `Div` around the contents of the list item (instead of adding an
6713 empty `Div` to the beginning, as before).
6714 + Add `details` tag to list of block tags (#3694).
6715 + Removed `button` from block tag list (#3717). It is already in the
6716 `eitherBlockOrInlineTag` list, and should be both places.
6717 + Use `Set`s instead of lists for block tag lookup.
6718 + Rewrote to use `Text` throughout. Effect on memory usage is modest
6719 (< 10%).
6720 + Use the lang value of `<html>` to set the lang meta value (bucklereed,
6721 #3765).
6722 + Ensure that paragraphs are closed properly when the parent block
6723 element closes, even without `</p>` (#3794).
6724 + Parse `<figure>` and `<figcaption>` (Mauro Bieg, #3813).
6725 + Parse `<main>` like `<div role=main>` (bucklereed, #3791).
6726 `<main>` closes `<p>` and behaves like a block element generally
6727 + Support column alignments (#1881). These can be set either
6728 with a `width` attribute or with `text-width` in a `style` attribute.
6729 + Modified state type to be an instance of `HasLogMessages`, so
6730 `registerHeader` can issue warnings.
6731 + `</td>` or `</th>` should close any open block tag (#3991).
6732 + `<td>` should close an open `<th>` or `<td>`.
6733 + `htmlTag` improvements (#3989). We previously failed on cases
6734 where an attribute contained a `>` character. This patch fixes the
6735 bug, which especially affects raw HTML in Markdown.
6737 * Txt2Tags reader:
6739 + Newline is not indentation (Alexander Krotov).
6741 * MediaWiki reader:
6743 + Allow extra hyphens after `|-` in tables (#2649).
6744 + Allow blank line after table start (#2649).
6745 + Fixed more table issues (#2649).
6746 + Ensure that list starts begin at left margin (#2606). Including when
6747 they're in tables or other list items.
6748 + Make smart double quotes depend on `smart` extension (#3585).
6749 + Don't do curly quotes inside `<tt>` contexts (#3585). Even if `+smart`.
6750 + Modified state type to be an instance of `HasLogMessages`, so
6751 `registerHeader` can issue warnings.
6753 * TWiki reader (Alexander Krotov):
6755 + Remove unnecessary `$` (#3597).
6756 + Simplify `linkText` (#3605).
6758 * EPUB reader:
6760 + Minor refactoring, avoiding explicit MediaBag handling.
6761 This all works behind the scenes in CommonState plumbing.
6763 * Docx reader:
6765 + Don't drop smartTag contents (#2242).
6766 + Handle local namespace declarations (#3365). Previously we didn't
6767 recognize math, for example, when the xmlns declaration occurred on
6768 the element and not the root.
6769 + More efficient trimSps (#1530). Replacing `trimLineBreaks`. This
6770 does the work of `normalizeSpaces` as well, so we avoid the need for
6771 that function here.
6772 + Avoid 0-level headers (Jesse Rosenthal, #3830). We used to parse
6773 paragraphs styled with "HeadingN" as "nth-level header." But if a
6774 document has a custom style named "Heading0", this will produce a
6775 0-level header, which shouldn't exist. We only parse this style
6776 if N>0. Otherwise we treat it as a normal style name, and
6777 follow its dependencies, if any.
6778 + Add tests for avoiding zero-level header (Jesse Rosenthal).
6780 * ODT reader:
6782 + Replaced `collectRights` with Rights from `Data.Either`.
6783 + Remove dead code (Albert Krewinkel).
6785 * Org reader (Albert Krewinkel, unless noted).
6787 + Don't allow tables inside list items (John MacFarlane, #3499).
6788 + Disallow tables on list marker lines (#3499).
6789 + Convert markup at beginning of footnotes (John MacFarlane, #3576).
6790 + Allow emphasized text to be followed by `[` (#3577).
6791 + Handle line numbering switch for src blocks.
6792 The line-numbering switch that can be given to source blocks (`-n` with
6793 an start number as an optional parameter) is parsed and translated to a
6794 class/key-value combination used by highlighting and other readers and
6795 writers.
6796 + Stop adding rundoc prefix to src params. Source block parameter names
6797 are no longer prefixed with `rundoc`. This was intended to simplify
6798 working with the rundoc project, a babel runner. However, the rundoc
6799 project is unmaintained, and adding those markers is not the reader's
6800 job anyway. The original language that is specified for a source
6801 element is now retained as the `data-org-language` attribute and only
6802 added if it differs from the translated language.
6803 + Allow multi-word arguments to src block params (#3477). The reader now
6804 correctly parses src block parameter list even if parameter arguments
6805 contain multiple words.
6806 + Avoid creating `nullMeta` by applying `setMeta` directly
6807 (Alexander Krotov).
6808 + Replace `sequence . map` with `mapM`.
6809 + Fix smart parsing behavior. Parsing of smart quotes and special
6810 characters can either be enabled via the `smart` language extension or
6811 the `'` and `-` export options. Smart parsing is active if either the
6812 extension or export option is enabled. Only smart parsing of special
6813 characters (like ellipses and en and em dashes) is enabled by default,
6814 while smart quotes are disabled. Previously, all smart parsing was
6815 disabled unless the language extension was enabled.
6816 + Subject full doc tree to headline transformations (Albert Krewinkel,
6817 #3695). Emacs parses org documents into a tree structure, which is
6818 then post-processed during exporting. The reader is changed to do the
6819 same, turning the document into a single tree of headlines starting
6820 at level 0.
6821 + Fix cite parsing behaviour (Herwig Stuetz). Until now, `org-ref`
6822 cite keys included special characters also at the end. This caused
6823 problems when citations occur right before colons or at the end of
6824 a sentence. With this change, all non alphanumeric characters at
6825 the end of a cite key are ignored. This also adds `,` to the list
6826 of special characters that are legal in cite keys to better mirror
6827 the behaviour of org-export.
6828 + Fix module names in haddock comments. Copy-pasting had lead to
6829 haddock module descriptions containing the wrong module names.
6830 + Recognize babel result blocks with attributes (#3706). Babel
6831 result blocks can have block attributes like captions and names.
6832 Result blocks with attributes were not recognized and were parsed
6833 as normal blocks without attributes.
6834 + Include tags in headlines. The Emacs default is to include tags in the
6835 headline when exporting. Instead of just empty spans, which contain the
6836 tag name as attribute, tags are rendered as small caps and wrapped in
6837 those spans. Non-breaking spaces serve as separators for multiple tags.
6838 + Respect export option for tags (#3713). Tags are appended to
6839 headlines by default, but will be omitted when the `tags` export option
6840 is set to nil.
6841 + Use `tag-name` attribute instead of `data-tag-name`.
6842 + Use `org-language` attribute rather than `data-org-language`.
6843 + Modified state type to be an instance of `HasLogMessages`, so
6844 `registerHeader` can issue warnings.
6845 + End footnotes after two blank lines. Footnotes can not only be
6846 terminated by the start of a new footnote or a header, but also by two
6847 consecutive blank lines.
6848 + Update emphasis border chars (#3933). The org reader was updated to
6849 match current org-mode behavior: the set of characters which are
6850 acceptable to occur as the first or last character in an org emphasis
6851 have been changed and now allows all non-whitespace chars at the
6852 inner border of emphasized text (see `org-emphasis-regexp-components`).
6854 * RST reader:
6856 + Fixed small bug in list parsing (#3432). Previously the parser didn't
6857 handle properly this case:
6859 * - a
6860 - b
6861 * - c
6862 - d
6863 + Handle multiline cells in simple tables (#1166).
6864 + Parse list table directive (Keiichiro Shikano, #3432).
6865 + Make use of `anyLineNewline` (Alexander Krotov, #3686).
6866 + Use `anyLineNewline` in `rawListItem` (Alexander Krotov, #3702).
6867 + Reorganize block parsers for ~20% faster parsing.
6868 + Fixed `..include::` directive (#3880).
6869 + Handle blank lines correctly in line blocks (Alexander Krotov, #3881).
6870 Previously pandoc would sometimes combine two line blocks separated
6871 by blanks, and ignore trailing blank lines within the line block.
6872 + Fix indirect hyperlink targets (#512).
6874 * Markdown reader:
6876 + Allow attributes in reference links to start on next line (#3674).
6877 + Parse YAML metadata in a context that sees footnotes defined in
6878 the body of the document (#1279).
6879 + When splitting pipe table cells, skip tex math (#3481).
6880 You might have a `|` character inside math. (Or for that matter
6881 something that the parser might mistake for raw HTML.)
6882 + Treat span with class `smallcaps` as SmallCaps.
6883 This allows users to specify small caps in Markdown this way:
6884 `[my text]{.smallcaps}` (#1592).
6885 + Fixed internal header links (#2397).
6886 This patch also adds `shortcut_reference_links` to the list
6887 of mmd extensions.
6888 + Treat certain environments as inline
6889 when they occur without space surrounding them (#3309, #2171).
6890 E.g. equation, math. This avoids incorrect vertical space
6891 around equations.
6892 + Optimized `nonindentSpaces`. Makes the benchmark go from 40 to 36 ms.
6893 + Allow latex macro definitions indented 1-3 spaces.
6894 Previously they only worked if nonindented.
6895 + Improved parsing of indented raw HTML blocks (#1841).
6896 Previously we inadvertently interpreted indented HTML as
6897 code blocks. This was a regression. We now seek to determine the
6898 indentation level of the contents of an HTML block, and (optionally)
6899 skip that much indentation. As a side effect, indentation may be
6900 stripped off of raw HTML blocks, if `markdown_in_html_blocks` is
6901 used. This is better than having things interpreted as indented
6902 code blocks.
6903 + Fixed smart quotes after emphasis (#2228). E.g. in `*foo*'s 'foo'`.
6904 + Warn for notes defined but not used (#1718).
6905 + Use `anyLineNewline` (Alexander Krotov).
6906 + Interpret YAML metadata as Inlines when possible (#3755). If
6907 the metadata field is all on one line, we try to interpret it as
6908 Inlines, and only try parsing as Blocks if that fails. If it
6909 extends over one line (including possibly the `|` or `>` character
6910 signaling an indented block), then we parse as Blocks. This was
6911 motivated by some German users finding that `date: '22. Juin 2017'`
6912 got parsed as an ordered list.
6913 + Fixed spurious parsing as citation as reference def (#3840).
6914 We now disallow reference keys starting with `@` if the
6915 `citations` extension is enabled.
6916 + Parse `-@roe` as suppress-author citation (pandoc-citeproc#237).
6917 Previously only `[-@roe]` (with brackets) was recognized as
6918 suppress-author, and `-@roe` was treated the same as `@roe`.
6919 + Fixed parsing of fenced code after list when there is no intervening
6920 blank line (#3733).
6921 + Allow raw latex commands starting with `\start` (#3558). Previously
6922 these weren't allowed because they were interpreted as starting
6923 ConTeXt environments, even without a corresponding `\stop`...
6924 + Added `inlines`, `inlines1`.
6925 + Require nonempty alt text for `implicit_figures` (#2844).
6926 A figure with an empty caption doesn't make sense.
6927 + Removed texmath macro material; now all this is handled
6928 in the LaTeX reader functions.
6929 + Fixed bug with indented code following raw LaTeX (#3947).
6931 * LaTeX reader:
6933 + Rewrote LaTeX reader with proper tokenization (#1390,
6934 #2118, #3236, #3779, #934, #982). This rewrite is primarily
6935 motivated by the need to get macros working properly. A side benefit
6936 is that the reader is significantly faster. We now tokenize the
6937 input text, then parse the token stream. Macros modify the token
6938 stream, so they should now be effective in any context, including
6939 math. Thus, we no longer need the clunky macro processing
6940 capacities of texmath.
6941 + Parse `\,` to `\8198` (six-per-em space) (Henri Werth).
6942 + Allow `\newcommand\foo{blah}` without braces.
6943 + Support `\lstinputlisting` (#2116).
6944 + Issue warnings when skipping unknown latex commands (#3392).
6945 + Include contents of `\parbox`.
6946 + Allow `\hspace` and `\vspace` to count as raw block or inline.
6947 Previously we would refuse to parse anything as raw inline if
6948 it was in the `blockCommands` list. Now we allow exceptions
6949 if they're listed under ignoreInlines in inlineCommands.
6950 This should make it easier e.g. to include an `\hspace`
6951 between two side-by-side raw LaTeX tables.
6952 + Don't drop contents of `\hypertarget`.
6953 + Handle spaces before `\cite` arguments.
6954 + Allow newpage, clearpage, pagebreak in inline contexts as well as
6955 block contexts (#3494).
6956 + Treat `{{xxx}}` the same as `{xxx}` (#2115).
6957 + Use `pMacroDefinition` in macro (for more direct parsing).
6958 Note that this means that `macro` will now parse one
6959 macro at a time, rather than parsing a whole group together.
6960 + Fixed failures on `\ref{}`, `\label{}` with `+raw_tex`. Now these
6961 commands are parsed as raw if `+raw_tex`; otherwise, their argument
6962 is parsed as a bracketed string.
6963 + Don't crash on empty `enumerate` environment (#3707).
6964 + Handle escaped `&` inside table cell (#3708).
6965 + Handle block structure inside table cells (#3709). `minipage` is no
6966 longer required.
6967 + Handle some width specifiers on table columns (#3709). Currently
6968 we only handle the form `0.9\linewidth`. Anything else would have
6969 to be converted to a percentage, using some kind arbitrary assumptions
6970 about line widths.
6971 + Make sure `\write18` is parsed as raw LaTeX. The change is in the
6972 LaTeX reader's treatment of raw commands, but it also affects the
6973 Markdown reader.
6974 + Fixed regression with starred environment names (#3803).
6975 + Handle optional args in raw `\titleformat` (#3804).
6976 + Improved heuristic for raw block/inline. An unknown command at the
6977 beginning of the line that could be either block or inline is
6978 treated as block if we have a sequence of block commands followed by
6979 a newline or a `\startXXX` command (which might start a raw ConTeXt
6980 environment).
6981 + Don't remove macro definitions from the output, even if
6982 `Ext_latex_macros` is set, so that macros will be applied.
6983 Since they're only applied to math in Markdown, removing the macros
6984 can have bad effects. Even for math macros, keeping them should be
6985 harmless.
6986 + Removed `macro`. It is no longer necessary, since the
6987 `rawLaTeXBlock` parser will parse macro definitions. This also avoids
6988 the need for a separate `latexMacro` parser in the Markdown reader.
6989 + Use `label` instead of `data-label` for label in caption (#3639).
6990 + Fixed space after `\figurename` etc.
6991 + Resolve references to section numbers.
6992 + Fix `\let\a=0` case, with single character token.
6993 + Allow `@` as a letter in control sequences. `@` is commonly used
6994 in macros using `\makeatletter`. Ideally we'd make the tokenizer
6995 sensitive to `\makeatletter` and `\makeatother`, but until then this
6996 seems a good change.
6997 + Track header numbers and correlate with labels.
6998 + Allow `]` inside group in option brackets (#3857).
6999 + lstinline with braces can be used (verb cannot be used with braces)
7000 (Marc Schreiber, #3535).
7001 + Fix keyval function: pandoc did not parse options in braces correctly
7002 (Marc Schreiber, #3642).
7003 + When parsing raw LaTeX commands, include trailing space (#1773).
7004 Otherwise things like `\noindent foo` break and turn into
7005 `\noindentfoo`. Affects `-f latex+raw_tex` and `-f markdown` (and other
7006 formats that allow `raw_tex`).
7007 + Don't treat "..." as Quoted (#3958). This caused quotes to be omitted in
7008 `\texttt` contexts.
7009 + Add tests for existing `\includegraphics` behaviour (Ben Firshman).
7010 + Allow space before `=` in bracketd options (Ben Firshman).
7011 + Be more forgiving in parsing command options. This was needed, for
7012 example, to make some minted options work.
7013 + Strip off quotes in `\include` filenames.
7015 * Added `Text.Pandoc.CSV`, simple (unexported) CSV parser.
7017 * `Text.Pandoc.PDF`:
7019 + Got `--resource-path` working with PDF output (#852).
7020 + Fetch images when generating PDF via context (#3380).
7021 To do this, we create the temp directory as a subdirectory
7022 of the working directory. Since context mk IV by default looks
7023 for images in the parent directory, this works.
7024 + Use `report` instead of `warn`, make it sensitive to verbosity settings.
7025 + Use `fillMediaBag` and `extractMedia` to extract media to temp dir.
7026 This reduces code duplication.
7027 + `html2pdf`: use stdin instead of intermediate HTML file
7028 + Removed useless `TEXINPUTS` stuff for `context2pdf`. mkiv context
7029 doesn't use `TEXINPUTS`.
7031 * `Text.Pandoc.Pretty`:
7033 + Simplified definition of `realLength`.
7034 + Don't error for blocks of size < 1. Instead, resize to 1 (see #1785).
7036 * `Text.Pandoc.MIME`:
7038 + Use `application/javascript` (not `application/x-javascript`).
7039 + Added `emf` to mimeTypes with type `application/x-msmetafile` (#1713).
7041 * `Text.Pandoc.ImageSize`:
7043 + Improve SVG image size code (Marc Schreiber, #3580).
7044 + Make `imageSize` recognize basic SVG dimensions (Mauro Bieg, #3462).
7046 * Use `Control.Monad.State.Strict` throughout. This gives 20-30% speedup
7047 and reduction of memory usage in most of the writers.
7049 * Use `foldrWithKey` instead of deprecated `foldWithKey`.
7051 * `Text.Pandoc.SelfContained`:
7053 + Fixed problem with embedded fonts (#3629).
7054 + Refactored getData from `getDataURI` in `SelfContained`.
7055 + Don't use data URIs for script or style (#3423). Instead, just use
7056 script or style tags with the content inside. The old method with
7057 data URIs prevents certain optimizations outside pandoc. Exception:
7058 data URIs are still used when a script contains `</script>` or a
7059 style contains `</`.
7060 + SelfContained: Handle URL inside material retrieved from a URL
7061 (#3629). This can happen e.g. with an @import of a google web font.
7062 (What is imported is some CSS which contains an url reference
7063 to the font itself.) Also, allow unescaped pipe (|) in URL.
7064 + Load resources from `data-src` (needed for lazy loading in
7065 reveal.js slide shows).
7066 + Handle `data-background-image` attribute on section (#3979).
7068 * `Text.Pandoc.Parsing`:
7070 + Added `indentWith` (Alexander Krotov, #3687).
7071 + Added `stateCitations` to `ParserState`.
7072 + Removed `stateChapters` from `ParserState`.
7073 + In `ParserState`, make `stateNotes'` a Map, add `stateNoteRefs`.
7074 + Added `gobbleSpaces` and `gobbleAtMostSpaces`.
7075 + Adjusted type of `insertIncludedFile` so it can be used with token
7076 parser.
7077 + Replace old texmath macro stuff from Parsing. Use Macro from
7078 Text.Pandoc.Readers.LaTeX.Types instead.
7079 + Export `insertIncludedFile`.
7080 + Added `HasLogMessages`, `logMessage`, `reportLogMessages` (#3447).
7081 + Replace partial with total function (Albert Krewinkel).
7082 + Introduce `HasIncludeFiles` type class (Albert Krewinkel). The
7083 `insertIncludeFile` function is generalized to work with all parser
7084 states which are instances of that class.
7085 + Add `insertIncludedFilesF` which returns F blocks (Albert Krewinkel).
7086 The `insertIncludeFiles` function was generalized and renamed
7087 to `insertIncludedFiles'`; the specialized versions are based on that.
7088 + `many1Till`: Check for the end condition before parsing (Herwig
7089 Stuetz). By not checking for the end condition before the first
7090 parse, the parser was applied too often, consuming too much of the
7091 input. This only affects `many1Till p end` where `p` matches on a
7092 prefix of `end`.
7093 + Provide `parseFromString` (#3690). This is a version of
7094 `parseFromString` specialied to ParserState, which resets
7095 `stateLastStrPos` at the end. This is almost always what we want.
7096 This fixes a bug where `_hi_` wasn't treated as emphasis in the
7097 following, because pandoc got confused about the position of the
7098 last word: `- [o] _hi_`.
7099 + Added `takeP`, `takeWhileP` for efficient parsing of `[Char]`.
7100 + Fix `blanklines` documentation (Alexander Krotov, #3843).
7101 + Give less misleading line information with `parseWithString`.
7102 Previously positions would be reported past the end of the chunk.
7103 We now reset the source position within the chunk and report
7104 positions "in chunk."
7105 + Add `anyLineNewline` (Alexander Krotov).
7106 + Provide shared F monad functions for Markdown and Org readers
7107 (Albert Krewinkel). The `F` monads used for delayed evaluation
7108 of certain values in the Markdown and Org readers are based on a
7109 shared data type capturing the common pattern of both `F` types.
7110 + Add `returnF` (Alexander Krotov).
7111 + Avoid parsing `Notes:**` as a bare URI (#3570). This avoids parsing
7112 bare URIs that start with a scheme + colon + `*`, `_`, or `]`.
7113 + Added `readerAbbreviations` to `ParserState`. Markdown reader
7114 now consults this to determine what is an abbreviation.
7115 + Combine grid table parsers (Albert Krewinkel, #3638). The grid table
7116 parsers for markdown and rst was combined into one single
7117 parser `gridTable`, slightly changing parsing behavior of both
7118 parsers: (1) The markdown parser now compactifies block content
7119 cell-wise: pure text blocks in cells are now treated as paragraphs
7120 only if the cell contains multiple paragraphs, and as plain blocks
7121 otherwise. Before, this was true only for single-column tables. (2)
7122 The rst parser now accepts newlines and multiple blocks in header
7123 cells.
7124 + Generalize tableWith, gridTableWith (Albert Krewinkel).
7125 The parsing functions `tableWith` and `gridTableWith` are generalized
7126 to work with more parsers. The parser state only has to be an
7127 instance of the `HasOptions` class instead of requiring a concrete
7128 type. Block parsers are required to return blocks wrapped into a
7129 monad, as this makes it possible to use parsers returning results
7130 wrapped in `Future`s.
7132 * `Text.Pandoc.Shared`:
7134 + Simplify `toRomanNumeral` using guards (Alexander Krotov, #3445)
7135 + `stringify`: handle Quoted better (#3958). Previously we were losing
7136 the quotation marks in Quoted elements.
7138 * `Text.Pandoc.Writers.Shared`:
7140 + Export `metaToJSON'`, `addVariablesToJSON` (#3439).
7141 This allows us to add the variables AFTER using the metadata
7142 to generate a YAML header (in the Markdown writer).
7143 + Added `unsmartify` (previously in RST writer).
7144 Undo literal double curly quotes. Previously we left these.
7145 + Generalize type of `metaToJSON` so it can take a Text. Previously a
7146 String was needed as argument; now any ToJSON instance will do.
7147 + Added `gridTable` (previously in Markdown writer).
7148 + `gridTable`: Refactored to use widths in chars.
7149 + `gridTable`: remove unnecessary extra space in cells.
7150 + Fixed `addVariablesToJSON`. It was previously not allowing multiple
7151 values to become lists.
7152 + Pipe tables: impose minimum cell size (see #3526).
7155### Default template changes
7157 * HTML templates (including EPUB and HTML slide show templates):
7159 + Make default.html5 polyglot markup conformant (John Luke Bentley,
7160 #3473). Polyglot markup is HTML5 that is also valid XHTML. See
7161 <https://www.w3.org/TR/html-polyglot>. With this change, pandoc's
7162 html5 writer creates HTML that is both valid HTML5 and valid XHTML.
7163 + Regularized CSS in html/epub/html slide templates (#3485).
7164 All templates now include `code{white-space: pre-wrap}`
7165 and CSS for `q` if `--html-q-tags` is used. Previously some templates
7166 had `pre` and others `pre-wrap`; the `q` styles were only sometimes
7167 included.
7168 + CSS for `.smallcaps`, (Mauro Bieg, #1592)
7169 + `default.revealjs`: make `history` default to true.
7170 + `default.revealjs`: use lazy loading (#2283).
7171 + `default.revealjs`: add `mathjax` variable and some conditional code
7172 to use the MathJaX plugin.
7173 + `default.slidy` uses `https` instead of `http` (ickc, #3848).
7174 + `default.dzslides`: Load Google Font using HTTPS by default
7175 (Yoan Blanc).
7177 * DocBook5 template: Use `lang` and `subtitle` variables (Jens Getreu,
7178 #3855).
7180 * LaTeX/Beamer template:
7182 + Combine LaTeX/Beamer templates (Andrew Dunning, #3878).
7183 `default.beamer` has been removed; beamer now uses the
7184 `default.latex` template. Beamer-specific parts are conditional
7185 on the `beamer` variable set by the writer. Note that
7186 `pandoc -D beamer` will return this (combined) template.
7187 + Use `xcolor` for `colorlinks` option (Andrew Dunning, #3877).
7188 Beamer loads `xcolor` rather than `color`, and thus the
7189 `dvipsnames` option doesn't take effect. This also provides a wider
7190 range of colour selections with the `svgnames` option.
7191 + Use starred versions of `xcolor` names (Andrew Dunning).
7192 Prevents changes to documents defined using the `dvipsnames` list (e.g.
7193 `Blue` gives a different result with svgnames enabled).
7194 + Load `polyglossia` after header-includes (#3898). It needs to be
7195 loaded as late as possible.
7196 + Use `unicode-math` (Vaclav Haisman). Use `mathspec` with only
7197 XeLaTeX on request.
7198 + Don't load `fontspec` before `unicode-math` (over there).
7199 The `unicode-math` package loads `fontspec` so explict loading of
7200 `fontspec` before `unicode-math` is not necessary.
7201 + Use `unicode-math` by default in default.latex template. mathspec will
7202 be used in xelatex if the `mathspec` variable is set; otherwise
7203 unicode-math will be used (Václav Haisman).
7204 + Use `dvipsnames` options when `colorlinks` specified (otherwise
7205 we get an error for `maroon`) (Thomas Hodgson).
7206 + Added beamer `titlegraphic` and `logo` variables (Thomas Hodgson).
7207 + Fix typo in fix for notes in tables (#2378, zeeMonkeez).
7208 + Fix `hyperref` options clash (Andrew Dunning, #3847) Avoids an options
7209 clash when loading a package (e.g. `tufte-latex`) that uses
7210 `hyperref` settings different from those in the template.
7211 + Add `natbiboptions` variable (#3768).
7212 + Fix links inside captions in LaTeX output with links-as-notes
7213 (Václav Haisman, #3651). Declare our redefined `\href` robust.
7214 + Load `parskip` before `hyperref` (Václav Haisman, #3654).
7215 + Allow setting Japanese fonts when using LuaLaTeX (Václav Haisman,
7216 #3873). by using the `luatexja-fontspec` and `luatexja-preset`
7217 packages. Use existing `CJKmainfont` and `CJKoptions` template
7218 variables. Add `luatexjafontspecoptions` for `luatexja-fontspec`
7219 and `luatexjapresetoptions` for `luatexja-preset`.
7220 + Added `aspectratio` variable to beamer template (Václav Haisman,
7221 #3723).
7222 + Modified template.latex to fix XeLaTex being used with tables
7223 (lwolfsonkin, #3661). Reordered `lang` variable handling to
7224 immediately before `bidi`.
7226 * ConTeXt template: Improved font handling: `simplefonts` is now
7227 obsolete in ConTeXt (Pablo Rodríguez).
7230### Documentation improvements
7232 * MANUAL.txt:
7234 + Add URL for Prince HTML > PDF engine (Ian, #3919).
7235 + Document that content above slide-level will be omitted in
7236 slide shows. See #3460, #2265.
7237 + Explain `--webtex` SVG url (Mauro Bieg, #3471)
7238 + Small clarification in YAML metadata section.
7239 + Document that html4 is technically XHTML 1.0 transitional.
7240 + Remove refs to highlighting-kate (#3672).
7241 + Document ibooks specific epub metadata.
7242 + Clarify that mathml is used for ODT math.
7243 + Mention limitations of Literate Haskell Support (#3410,
7244 Joachim Breitner).
7245 + Add documentation of limitations of grid tables (Stephen
7246 McDowell, #3864).
7247 + Clarify that meta-json contains transformed values (Jakob Voß,
7248 #3491) Make clear that template variable `meta-json` does not
7249 contain plain text values or JSON output format but field values
7250 transformed to the selected output format.
7252 * COPYRIGHT:
7254 + Clarify that templates are dual-licensed.
7255 + Clarify that pandoc-types is BSD3 licensed.
7256 + List new files not written by jgm (Albert Krewinkel).
7257 + Update dates in copyright notices (Albert Krewinkel). This follows
7258 the suggestions given by the FSF for GPL licensed software.
7259 <https://www.gnu.org/prep/maintain/html_node/Copyright-Notices.html>
7261 * INSTALL.md:
7263 + Improved instructions for tests with patterns.
7264 + Put RPM-based distros on separate point (Mauro Bieg, #3449)
7266 * CONTRIBUTING.md:
7268 + Fixed typos (Wandmalfarbe, #3479).
7269 + Add "ask on pandoc-discuss" (Mauro Bieg).
7271 * Add lua filter documentation in `doc/lua-filters.md`. Note that the
7272 end of this document is autogenerated from `data/pandoc.lua`
7273 using `make doc/lua-filters.md`, which uses `tools/ldoc.ltp`
7274 (Albert Krewinkel).
7276 * Add `doc/filters.md`. This is the old scripting tutorial from
7277 the website.
7279 * Add `doc/using-the-pandoc-api.md` (#3289). This gives an introduction
7280 to using pandoc as a Haskell library.
7283### Build infrastructure improvements
7285 * Removed `data/templates` submodule. Templates are now a subtree
7286 in `data/templates`. This removes the need to do `git submodule
7287 update`.
7289 * Renamed `tests` -> `test`.
7291 * Remove `https` flag. Always build with HTTPS support.
7293 * Use `file-embed` instead of `hsb2hs` to embed data files when
7294 `embed_data_files` flag is set. `file-embed` gives us better dependency
7295 tracking: if a data file changes, ghc/stack/cabal know to recompile
7296 the Data module. This also removes `hsb2hs` as a build dependency.
7298 * Add `custom-setup` stanza to pandoc, lowercase field names.
7300 * Add `static` Cabal flag.
7302 * Name change OSX -> MacOS. Add a -MacOS suffix to mac package rather
7303 than -OSX. Changed local names from osx to macos.
7305 * make_macos_package.sh - Use strip to reduce executable size.
7307 * Revised binary linux package. Now a completely static executable
7308 is created, using Docker and alpine. We create both a deb and a
7309 tarball. The old `deb` directory has been replaced with a `linux`
7310 directory. Running `make` in the `linux` directory should
7311 perform the build, putting the binary packages in `artifacts/`.
7313 * `linux/control.in`: add `Replaces:`, so existing pandoc-citeproc and
7314 pandoc-data packages will be uninstalled; this package provides
7315 both (#3822). Add latex packages as 'suggested', update
7316 description.
7318 * Remove cpphs build requirement -- it is no longer needed.
7320 * Replaced `{deb,macos,windows}/stack.yaml` with `stack.pkg.yaml`.
7322 * Name change OSX -> macOS (ickc, #3869).
7324 * Fix casing of Linux, UNIX, and Windows (ickc).
7326 * `.travis.yml`: create a source dist and do cabal build and test there.
7327 That way we catch errors due to files missing from the data
7328 section of pandoc.cabal.
7330 * Makefile:
7332 + Split `make haddock` from `make full`.
7333 + Add BRANCH variable for winpkg.
7334 + Add `lint` target.
7335 + Improve `make full`. Disable optimizations.
7336 Build everything, inc. trypandoc and benchmarks. Use parallel build.
7337 + Allow `make test` to take `TESTARGS`.
7339 * Added new command tests (`Tests.Command`), using small text files
7340 in `test/command/`. Any files added in this directory will be treated
7341 as shell tests (see smart.md for an example). This makes it very easy
7342 to add regression tests etc.
7344 * Test fixes so we can find data files. In old tests & command tests,
7345 we now set the environment variable `pandoc_datadir`. In lua tests,
7346 we set the datadir explicitly.
7348 * Refactored `compareOutput` in docx writer test.
7350 * Consolidated some common functions in `Tests.Helper`.
7352 * Small change to unbalanced bracket test to speed up test suite.
7354 * Speed up Native writer quickcheck tests.
7356 * Use tasty for tests rather than test-framework.
7358 * Add simple Emacs mode to help with Pandoc templates editing.
7359 (Václav Haisman, #3889). `tools/pandoc-template-mode.el`
7362## pandoc 1.19.2.4 (2017-09-10)
7364 * Add dependencies on texmath and skylighting to the executable.
7365 This is needed for dependency version numbers to be available,
7366 with Cabal > 2.
7368## pandoc 1.19.2.3 (2017-09-09)
7370 * Add CPP to Setup.hs so it works with Cabal >= 2 and < 2.
7372## pandoc 1.19.2.2 (2017-09-08)
7374 * Fix build with GHC 8.2.1 (#3876, Peter Simons). Setup.hs does not
7375 compile with Cabal 2.x, so we require an earlier version via
7376 setup-depends. The following packages need newer versions with
7377 GHC 8.2.1 and had their constraints relaxed accordingly:
7378 executable-path, process, syb, and time.
7380## pandoc 1.19.2.1 (2017-01-31)
7382 * Require skylighting >= 0.1.1.4.
7383 * Adjust test output for skylighting version.
7384 * Relax upper bounds on blaze-html and blaze-markup.
7386## pandoc 1.19.2 (2017-01-29)
7388 * Use skylighting library instead of highlighting-kate for syntax
7389 highlighting. Skylighting is faster and more accurate (#3363).
7390 Later we'll be able to add features like warning messages, dynamic
7391 loading of xml syntax definitions, and dynamic loading of themes.
7393 * Added a new highlight style, `breezeDark`.
7395 * Text.Pandoc.Highlighting: Update list of `listings` languages (#3374).
7396 This allows more languages to be used when using the `--listings`
7397 option.
7399 * OpenDocument writer:
7401 + Small refactoring. Removed separate 'parent' parameter in paraStyle.
7402 + Don't profilerate text styles unnecessarily (#3371).
7403 This change makes the writer create only as many temporary
7404 text styles as are absolutely necessary. It also consolidates
7405 adjacent nodes with the same style.
7407 * Org reader (Albert Krewinkel):
7409 + Allow short hand for single-line raw blocks (Albert Krewinkel,
7410 #3366). Single-line raw blocks can be given via `#+FORMAT: raw line`,
7411 where `FORMAT` must be one of `latex`, `beamer`, `html`, or `texinfo`.
7412 + Accept org-ref citations followed by commas (Albert Krewinkel).
7413 Bugfix for an issue which, whenever the citation was immediately
7414 followed by a comma, prevented correct parsing of org-ref citations.
7415 + Ensure emphasis markup can be nested. Nested emphasis markup (e.g.
7416 `/*strong and emphasized*/`) was interpreted incorrectly in that the
7417 inner markup was not recognized.
7418 + Remove pipe char irking the haddock coverage tool (Albert Krewinkel).
7420 * Docx reader: Empty header should be list of lists (Jesse Rosenthal).
7421 In the past, the docx reader wrote an empty header as an empty list. It
7422 should have the same width as a row (and be filled with empty cells).
7424 * MediaWiki reader:
7426 + Improved handling of display math (#3362). Sometimes display math is
7427 indented with more than one colon. Previously we handled these cases
7428 badly, generating definition lists and missing the math.
7429 + Fix quotation mark parsing (#3336, tgkokk). Change MediaWiki reader's
7430 behavior when the smart option is parsed to match other readers'
7431 behavior.
7433 * Markdown reader:
7435 + Fixed `-f markdown_github-hard_line_breaks+escaped_line_breaks`
7436 (#3341). Previously this did not properly enable escaped line breaks.
7437 + Disallow space between inline code and attributes (#3326, #3323,
7438 Mauro Bieg).
7440 * DocBook5 writer: make id attribute xml:id, fixes #3329 (#3330, Mauro Bieg).
7442 * Added some test cases for ODT reader (#3306, #3308, Hubert Plociniczak).
7444 * LaTeX writer: allow tables with empty cells to count as "plain."
7445 This addresses a problem of too-wide tables when empty cells
7446 are used. Thanks to Joost Kremers for reporting the issue.
7448 * Org writer: prefix footnote numbers with `fn:` (Albert Krewinkel).
7449 Unprefixed numbers where used by older org-mode versions, but are no
7450 longer supported.
7452 * HTML writer: don't process pars with empty RawInline, (#1040, #3327,
7453 Mauro Bieg).
7455 * Markdown writer: Fix display math with `--webtex` (#3298).
7457 * Fix sample.lua so it properly handles raw blocks/inlines (#3358,
7458 bumper314).
7460 * Templates:
7462 + default.latex: Moved geometry after hyperref (Václav Haisman).
7463 Otherwise PDF sizes can be wrong in some circumstances.
7464 + Copied a few changes from default.latex to default.beamer
7465 (Wandmalfarbe).
7466 + default.latex, default.beamer: Changed position of `\VerbatimNotes`
7467 and `fancyvrb`. This fixes hyperlinks on footnotes in documents
7468 that contain verbatim in notes (#3361). (Note: the beamer template
7469 was updated to match the LaTeX template, but at this point verbatim
7470 in notes seems not to work in beamer.)
7471 + default.latex: Allow passing `microtypeoptions` to microtype
7472 (Václav Haisman).
7473 + default.latex: Add hyphen option to url package.
7474 + default.docbook5: Fix namespace declarations (Mauro Bieg).
7476 * Moved `make_osx_package.sh` to `osx/` directory.
7478 * Travis continuous integration:
7480 + Fix false positives with dist build.
7481 + Speed improvements (Kolen Cheung, #3304, #3357).
7483 * MANUAL.txt:
7485 + Clarify that blank space is needed around footnotes (#3352).
7486 + Fixed typo (#3351, Alexey Rogechev).
7487 + Note that `--wrap=auto` does not work in HTML output.
7488 + Default `--columns` width is 72, not 80.
7489 + Fixed broken links (#3316, Kolen Cheung).
7490 + Document usage of `@*` in nocite section (#3333, John Muccigrosso).
7492 * INSTALL.md:
7494 + Indent code so it's properly formatted (#3335, Bheesham Persaud).
7495 + Added instructions for extracting binary from OSX, Windows packages.
7497 * CONTRIBUTING.md: Describe labels currently used in issue tracker
7498 (Albert Krewinkel). The labels have changed over time, the list of
7499 labels is updated to reflect the current set of labels used in the
7500 issue tracker.
7502 * Rearrange and extend badges in README (Albert Krewinkel, #3354)
7504 * Bumped version bounds for dependencies.
7507## pandoc 1.19.1 (2016-12-10)
7509 * Set `PANDOC_VERSION` environment variable for filters (#2640).
7510 This allows filters to check the pandoc version that produced
7511 the JSON they are receiving.
7513 * Docx reader: Ensure one-row tables don't have header (#3285,
7514 Jesse Rosenthal). Tables in MS Word are set by default to have
7515 special first-row formatting, which pandoc uses to determine whether
7516 or not they have a header. This means that one-row tables will, by
7517 default, have only a header -- which we imagine is not what people
7518 want. This change ensures that a one-row table is not understood to
7519 be a header only. Note that this means that it is impossible to
7520 produce a header-only table from docx, even though it is legal
7521 pandoc. But we believe that in nearly all cases, it will be an
7522 accidental (and unwelcome) result
7524 * HTML reader:
7526 + Fixed some bad regressions in HTML table parser (#3280).
7527 This regression leads to the introduction of empty rows
7528 in some circumstances.
7529 + Understand `style=width:` as well as `width` in `col` (#3286).
7531 * RST reader:
7533 + Print warnings when keys, substitition, notes not found.
7534 Previously the parsers failed and we got raw text. Now we get a
7535 link with an empty URL, or empty inlines in the case of a note or
7536 substitution.
7538 + Fix hyperlink aliases (#3283).
7540 * Man writer: Ensure that periods are escaped at beginning of line
7541 (#3270).
7543 * LaTeX writer: Fix unnumbered headers when used with `--top-level`
7544 (#3272, Albert Krewinkel). Fix interaction of top-level
7545 divisions `part` or `chapter` with unnumbered headers when
7546 emitting LaTeX. Headers are ensured to be written using
7547 stared commands (like `\subsection*{}`).
7549 * LaTeX template: use comma not semicolon to separate keywords for
7550 `pdfkeywords`. Thanks to Wandmalfarbe.
7552 * Markdown writer: Fixed incorrect word wrapping (#3277).
7553 Previously pandoc would sometimes wrap lines too early due to
7554 this bug.
7556 * Text.Pandoc.Pretty: Added `afterBreak` [API change]. This makes it
7557 possible to insert escape codes for content that needs escaping at the
7558 beginning of a line.
7560 * Removed old MathMLInHTML.js from 2004, which should no longer
7561 be needed for MathML with modern browsers.
7563 * Fixed tests with dynamic linking (#2709).
7565 * Makefile: Use stack instead of cabal for targets. This is just
7566 a convenience for developers.
7568 * Fixed bash completion of filenames with space (#2749).
7570 * MANUAL: improved documentation on how to create a custom
7571 `reference.docx`.
7573 * Fix minor spelling typos in the manual (#3273, Anthony Geoghegan)
7575## pandoc 1.19 (2016-12-01)
7577 * Changed resolution of filter paths.
7579 + We now first treat the argument of `--filter` as a full (absolute
7580 or relative) path, looking for a program there. If it's found, we
7581 run it.
7582 + If not, and if it is a simple program name or a relative path, we
7583 try resolving it relative to `$DATADIR/filters`.
7584 + If this fails, then we treat it as a program name and look in the
7585 user's PATH.
7586 + Removed a hardcoded '/' that may have caused problems with
7587 Windows paths.
7589 Previously if you did `--filter foo` and you had `foo` in your path and
7590 also an executable `foo` in your working directory, the one in the path
7591 would be used. Now the one in the working directory is used.
7593 In addition, when you do `--filter foo/bar.hs`, pandoc will now find a
7594 filter `$DATADIR/filters/foo/bar.hs` -- assuming there isn't a
7595 `foo/bar.hs` relative to the working directory.
7597 * Allow `file://` URIs as arguments (#3196). Also improved default reader
7598 format detection. Previously with a URI ending in .md or .markdown,
7599 pandoc would assume HTML input. Now it treats these as markdown.
7601 * Allow to overwrite top-level division type heuristics (#3258,
7602 Albert Krewinkel). Pandoc uses heuristics to determine the most
7603 reasonable top-level division type when emitting LaTeX or
7604 Docbook markup. It is now possible to overwrite this implicitly set
7605 top-level division via the `top-level-division` command line parameter.
7607 * Text.Pandoc.Options \[API changes\]:
7609 + Removed `writerStandalone` field in `WriterOptions`, made
7610 `writerTemplate` a `Maybe` value. Previously setting
7611 `writerStandalone = True` did nothing unless a template was provided
7612 in writerTemplate. Now a fragment will be generated if
7613 `writerTemplate` is `Nothing`; otherwise, the specified template
7614 will be used and standalone output generated.
7615 + `Division` has been renamed `TopLevelDivision` (#3197). The
7616 `Section`, `Chapter`, and `Part` constructors were renamed to
7617 `TopLevelSection`, `TopLevelChapter`, and
7618 `TopLevelPart`, respectively. An additional `TopLevelDefault`
7619 constructor was added, which is now also the new default value of
7620 the `writerTopLevelDivision` field in `WriterOptions`.
7622 * Improved error if they give wrong arg to `--top-level-division`.
7624 * Use new module from texmath to lookup MS font codepoints in Docx reader.
7625 Removed unexported module Text.Pandoc.Readers.Docx.Fonts. Its code now
7626 lives in texmath (0.9).
7628 * DocBook reader: Fixed xref lookup (#3243). It previously only worked
7629 when the qnames lacked the docbook namespace URI.
7631 * HTML reader:
7633 + Improved table parsing (#3027). We now check explicitly for non-1
7634 rowspan or colspan attributes, and fail when we encounter them.
7635 Previously we checked that each row had the same number of cells,
7636 but that could be true even with rowspans/colspans. And there are
7637 cases where it isn't true in tables that we can handle fine -- e.g.
7638 when a tr element is empty. So now we just pad rows with empty cells
7639 when needed.
7640 + Treat `<math>` as MathML by default unless something else is
7641 explicitly specified in xmlns. Provided it parses as MathML,
7642 of course. Also fixed default which should be to inline math if no
7643 display attribute is used.
7644 + Only treat "a" element as link if it has href (#3226). Otherwise
7645 treat as span.
7647 * Docx reader (Jesse Rosenthal):
7649 + Add a placeholder value for CHART. We wrap `[CHART]` in a
7650 `<span class="chart">`. Note that it maps to inlines because, in
7651 docx, anything in a drawing tag can be part of a larger paragraph.
7652 + Be more specific in parsing images We not only want `w:drawing`,
7653 because that could also include charts. Now we specify
7654 `w:drawing/pic:pic`. This shouldn't change behavior at all, but it's
7655 a first step toward allowing other sorts of drawing data as well.
7656 + Abstract out function to avoid code repetition.
7657 + Update tests for img title and alt (#3204).
7658 + Handle Alt text and titles in images. We use the "description" field
7659 as alt text and the "title" field as title. These can be accessed
7660 through the "Format Picture" dialog in Word.
7661 + Docx reader utils: handle empty namespace in `elemName`. Previously,
7662 if given an empty namespace `(elemName ns "" "foo")` `elemName`
7663 would output a QName with a `Just ""` namespace. This is never what
7664 we want. Now we output a `Nothing`. If someone *does* want a
7665 `Just ""` in the namespace, they can enter the QName
7666 value explicitly.
7668 * ODT reader/writer:
7670 + Inline code when text has a special style (Hubert Plociniczak). When
7671 a piece of text has a text `Source_Text` then we assume that this is
7672 a piece of the document that represents a code that needs to
7673 be inlined. Adapted the writer to also reflect that change.
7674 Previously it was just writing a 'preformatted' text using a
7675 non-distinguishable font style. Code blocks are still not recognized
7676 by the ODT reader. That's a separate issue.
7677 + Infer table's caption from the paragraph (#3224,
7678 Hubert Plociniczak). ODT's reader always put empty captions for the
7679 parsed tables. This commit
7681 1. checks paragraphs that follow the table definition
7682 2. treats specially a paragraph with a style named 'Table'
7683 3. does some postprocessing of the paragraphs that combines tables
7684 followed immediately by captions
7686 The ODT writer used the `TableCaption` style for the caption
7687 paragraph. This commit follows the OpenOffice approach which allows
7688 for appending captions to table but uses a built-in style named
7689 `Table` instead of `TableCaption`. Users of a custom `reference.odt`
7690 should change the style's name from `TableCaption` to `Table`.
7692 * ODT reader: Infer tables' header props from rows (#3199,
7693 Hubert Plociniczak). ODT reader simply provided an empty header list
7694 which meant that the contents of the whole table, even if not empty, was
7695 simply ignored. While we still do not infer headers we at least have to
7696 provide default properties of columns.
7698 * Markdown reader:
7700 + Allow reference link labels starting with `@...` if `citations`
7701 extension disabled (#3209). Example: in
7703 \[link text\]\[@a\]
7705 `link text` isn't hyperlinked because `[@a]` is parsed as
7706 a citation. Previously this happened whether or not the `citations`
7707 extension was enabled. Now it happens only if the `citations`
7708 extension is enabled.
7709 + Allow alignments to be specified in Markdown grid tables. For
7710 example,
7712 +-------+---------------+--------------------+
7713 | Right | Left | Centered |
7714 +=========:+:=================+:=============:+
7715 | Bananas | $1.34 | built-in wrapper |
7716 +-------+---------------+--------------------+
7718 + Allow Small Caps elements to be created using bracketed spans (as
7719 they already can be using HTML-syntax spans) (#3191, Kolen Cheung).
7721 * LaTeX reader:
7723 + Don't treat `\vspace` and `\hspace` as block commands (#3256).
7724 Fixed an error which came up, for example, with `\vspace` inside
7725 a caption. (Captions expect inlines.)
7726 + Improved table handling. We can now parse all of the tables emitted
7727 by pandoc in our tests. The only thing we don't get yet are
7728 alignments and column widths in more complex tables. See #2669.
7729 + Limited support for minipage.
7730 + Allow for `[]`s inside LaTeX optional args. Fixes cases like:
7731 + Handle BVerbatim from fancyvrb (#3203).
7732 + Handle hungarumlaut (#3201).
7733 + Allow beamer-style `<...>` options in raw LaTeX (also in Markdown)
7734 (#3184). This allows use of things like `\only<2,3>{my content}` in
7735 Markdown that is going to be converted to beamer.
7737 * Use pre-wrap for code in dzslides template (Nicolas Porcel). Otherwise
7738 overly long code will appear on every slide.
7740 * Org reader (Albert Krewinkel):
7742 + Respect column width settings (#3246). Table column properties can
7743 optionally specify a column's width with which it is displayed in
7744 the buffer. Some exporters, notably the ODT exporter in org-mode
7745 v9.0, use these values to calculate relative column widths. The org
7746 reader now implements the same behavior. Note that the org-mode
7747 LaTeX and HTML exporters in Emacs don't support this feature yet,
7748 which should be kept in mind by users who use the column
7749 widths parameters.
7750 + Allow HTML attribs on non-figure images (#3222). Images which are
7751 the only element in a paragraph can still be given HTML attributes,
7752 even if the image does not have a caption and is hence not a figure.
7753 The following will add set the `width` attribute of the image to
7754 `50%`:
7756 +ATTR\_HTML: :width 50%
7757 =======================
7759 \[\[file:image.jpg\]\]
7761 + Support `ATTR_HTML` for special blocks (#3182). Special
7762 blocks (i.e. blocks with unrecognized names) can be prefixed with an
7763 `ATTR_HTML` block attribute. The attributes defined in that
7764 meta-directive are added to the `Div` which is used to represent the
7765 special block.
7766 + Support the `todo` export option. The `todo` export option allows to
7767 toggle the inclusion of TODO keywords in the output. Setting this to
7768 `nil` causes TODO keywords to be dropped from headlines. The default
7769 is to include the keywords.
7770 + Add support for todo-markers. Headlines can have optional
7771 todo-markers which can be controlled via the `#+TODO`, `#+SEQ_TODO`,
7772 or `#+TYP_TODO` meta directive. Multiple such directives can be
7773 given, each adding a new set of recognized todo-markers. If no
7774 custom todo-markers are defined, the default `TODO` and `DONE`
7775 markers are used. Todo-markers are conceptually separate from
7776 headline text and are hence excluded when autogenerating
7777 headline IDs. The markers are rendered as spans and labelled with
7778 two classes: One class is the markers name, the other signals the
7779 todo-state of the marker (either `todo` or `done`).
7781 * LaTeX writer:
7783 + Use `\autocites*` when "suppress-author" citation used.
7784 + Ensure that simple tables have simple cells (#2666). If cells
7785 contain more than a single Plain or Para, then we need to set
7786 nonzero widths and put contents into minipages.
7787 + Remove invalid inlines in sections (#3218, Hubert Plociniczak).
7789 * Markdown writer:
7791 + Fix calculation of column widths for aligned multiline tables
7792 (#1911, Björn Peemöller). This also fixes excessive CPU and memory
7793 usage for tables when `--columns` is set in such a way that cells
7794 must be very tiny. Now cells are guaranteed to be big enough so that
7795 single words don't need to line break, even if this pushes the line
7796 length above the column width.
7797 + Use bracketed form for native spans when `bracketed_spans`
7798 enabled (#3229).
7799 + Fixed inconsistent spacing issue (#3232). Previously a tight bullet
7800 sublist got rendered with a blank line after, while a tight ordered
7801 sublist did not. Now we don't get the blank line in either case.
7802 + Fix escaping of spaces in super/subscript (#3225). Previously two
7803 backslashes were inserted, which gave a literal backslash.
7804 + Adjust widths in Markdown grid tables so that they match
7805 on round-trip.
7807 * Docx writer:
7809 + Give full detail when there are errors converting tex math.
7810 + Handle title text in images (Jesse Rosenthal). We already handled
7811 alt text. This just puts the image "title" into the docx
7812 "title" attr.
7813 + Fixed XML markup for empty cells (#3238). Previously the Compact
7814 style wasn't being applied properly to empty cells.
7816 * HTML writer:
7818 + Updated `renderHtml` import from blaze-html.
7820 * Text.Pandoc.Pretty:
7822 + Fixed some bugs that caused blank lines in tables (#3251). The bugs
7823 caused spurious blank lines in grid tables when we had things like
7824 `blankline $$ blankline`.
7825 + Add exported function `minOffet` \[API change\] (Björn Peemöller).
7826 + Added error message for illegal call to `block` (Björn Peemöller).
7828 * Text.Pandoc.Shared:
7830 + Put `warn` in MonadIO.
7831 + `fetchItem`: Better handling of protocol-relative URL (#2635). If
7832 URL starts with `//` and there is no "base URL" (as there would be
7833 if a URL were used on the command line), then default to http:.
7835 * Export Text.Pandoc.getDefaultExtensions \[API change\] (#3178).
7837 * In --version, trap error in `getAppUserDataDirectory` (#3241). This
7838 fixes a crash with `pandoc --version` on unusual systems with no real
7839 user (e.g. SQL Server 2016).
7841 * Added weigh-pandoc for memory usage diagnostics (#3169).
7843 * Use correct mime types for woff and woff2 (#3228).
7845 * Remove make\_travis\_yml.hs (#3235, Kolen Cheung).
7847 * changelog: Moved an item that was misplaced in the 1.17.2 section to the
7848 1.18 section where it belongs.
7850 * CONTRIBUTING.md: minor change in wording and punctuation (#3252,
7851 Kolen Cheung).
7853 * Further revisions to manual for `--version` changes (#3244).
7857## pandoc 1.18 (2016-10-26)
7859 * Added `--list-input-formats`, `--list-output-formats`,
7860 `--list-extensions`, `--list-highlight-languages`, and
7861 `--list-highlight-styles` (#3173). Removed list of highlighting
7862 languages from `--version` output. Removed list of input and output
7863 formats from default `--help` output.
7865 * Added `--reference-location=block|section|document` option
7866 (Jesse Rosenthal). This determines whether Markdown link references
7867 and footnotes are placed at the end of the document, the end of the
7868 section, or the end of the top-level block.
7870 * Added `--top-level-division=section|chapter|part` (Albert Krewinkel).
7871 This determines what a level-1 header corresponds to in LaTeX,
7872 ConTeXt, DocBook, and TEI output. The default is `section`.
7873 The `--chapters` option has been deprecated in favor of
7874 `--top-level-division=chapter`.
7876 * Added `LineBlock` constructor for `Block` (Albert Krewinkel). This
7877 is now used in parsing RST and Markdown line blocks, DocBook
7878 `linegroup`/`line` combinations, and Org-mode `VERSE` blocks.
7879 Previously `Para` blocks with hard linebreaks were used. `LineBlock`s
7880 are handled specially in the following ouput formats: AsciiDoc
7881 (as `[verse]` blocks), ConTeXt (`\startlines`/`\endlines`),
7882 HTML (`div` with a style), Markdown (line blocks if `line_blocks`
7883 is enabled), Org-mode (`VERSE` blocks), RST (line blocks). In
7884 other output formats, a paragraph with hard linebreaks is emitted.
7886 * Allow binary formats to be written to stdout (but not to tty) (#2677).
7887 Only works on posix, since we use the unix library to check whether
7888 output is to tty. On Windows, pandoc works as before and always requires
7889 an output file parameter for binary formats.
7891 * Changed JSON output format (Jesse Rosenthal). Previously we used
7892 generically generated JSON, but this was subject to change depending
7893 on the version of aeson pandoc was compiled with. To ensure stability,
7894 we switched to using manually written ToJSON and FromJSON
7895 instances, and encoding the API version. **Note:** pandoc filter
7896 libraries will need to be revised to handle the format change.
7897 Here is a summary of the essential changes:
7899 + The toplevel JSON format is now `{"pandoc-api-version" :
7900 [MAJ, MIN, REV], "meta" : META, "blocks": BLOCKS}`
7901 instead of `[{"unMeta": META}, [BLOCKS]]`.
7902 Decoding fails if the major and minor version numbers don't
7903 match.
7904 + Leaf nodes no longer have an empty array for their "c" value.
7905 Thus, for example, a `Space` is encoded as `{"t":"Space"}`
7906 rather than `{"t":"Space","c":[]}` as before.
7908 * Removed `tests/Tests/Arbitrary.hs` and added a `Text.Pandoc.Arbitrary`
7909 module to pandoc-types (Jesse Rosenthal). This makes it easier
7910 to use QuickCheck with pandoc types outside of pandoc itself.
7912 * Add `bracketed_spans` Markdown extension, enabled by default
7913 in pandoc `markdown`. This allows you to create a native span
7914 using this syntax: `[Here is my span]{#id .class key="val"}`.
7916 * Added `angle_brackets_escapable` Markdown extension (#2846).
7917 This is needed because github flavored Markdown has a slightly
7918 different set of escapable symbols than original Markdown;
7919 it includes angle brackets.
7921 * Export `Text.Pandoc.Error` in `Text.Pandoc` [API change].
7923 * Print highlighting-kate version in `--version`.
7925 * `Text.Pandoc.Options`:
7927 + `Extension` has new constructors `Ext_brackted_spans` and
7928 `Ext_angle_brackets_escapable` [API change].
7929 + Added `ReferenceLocation` type [API change] (Jesse Rosenthal).
7930 + Added `writerReferenceLocation` field to `WriterOptions` (Jesse
7931 Rosenthal).
7933 * `--filter`: we now check `$DATADIR/filters` for filters before
7934 looking in the path (#3127, Jesse Rosenthal, thanks to Jakob
7935 Voß for the idea). Filters placed in this directory need not
7936 be executable; if the extension is `.hs`, `.php`, `.pl`, `.js`,
7937 or `.rb`, pandoc will run the right interpreter.
7939 * For `--webtex`, replace deprecated Google Chart API by CodeCogs as
7940 default (Kolen Cheung).
7942 * Removed `raw_tex` extension from `markdown_mmd` defaults (Kolen Cheung).
7944 * Execute .js filters with node (Jakob Voß).
7946 * Textile reader:
7948 + Support `bc..` extended code blocks (#3037). Also, remove trailing
7949 newline in code blocks (consistently with Markdown reader).
7950 + Improve table parsing. We now handle cell and row attributes, mostly
7951 by skipping them. However, alignments are now handled properly.
7952 Since in pandoc alignment is per-column, not per-cell, we
7953 try to devine column alignments from cell alignments.
7954 Table captions are also now parsed, and textile indicators
7955 for thead and tfoot no longer cause parse failure. (However,
7956 a row designated as tfoot will just be a regular row in pandoc.)
7957 + Improve definition list parsing. We now allow multiple terms
7958 (which we concatenate with linebreaks). An exponential parsing
7959 bug (#3020) is also fixed.
7960 + Disallow empty URL in explicit link (#3036).
7962 * RST reader:
7964 + Use Div instead of BlockQuote for admonitions (#3031).
7965 The Div has class `admonition` and (if relevant) one of the
7966 following: `attention`, `caution`, `danger`, `error`, `hint`,
7967 `important`, `note`, `tip`, `warning`. **Note:** This will change
7968 the rendering of some RST documents! The word ("Warning", "Attention",
7969 etc.) is no longer added; that must be done with CSS or a filter.
7970 + A Div is now used for `sidebar` as well.
7971 + Skip whitespace before note (Jesse Rosenthal, #3163). RST requires a
7972 space before a footnote marker. We discard those spaces so that footnotes
7973 will be adjacent to the text that comes before it. This is in line with
7974 what rst2latex does.
7975 + Allow empty lines when parsing line blocks (Albert Krewinkel).
7977 * Markdown reader:
7979 + Allow empty lines when parsing line blocks (Albert Krewinkel).
7980 + Allow attributes on autolinks (#3183, Daniele D'Orazio).
7982 * LaTeX reader:
7984 + More robust parsing of unknown environments (#3026).
7985 We no longer fail on things like `^` inside options for tikz.
7986 + Be more forgiving of non-standard characters, e.g. `^` outside of math.
7987 Some custom environments give these a meaning, so we should try not to
7988 fall over when we encounter them.
7989 + Drop duplicate `*` in bibtexKeyChars (Albert Krewinkel)
7991 * MediaWiki reader:
7993 + Fix for unquoted attribute values in mediawiki tables (#3053).
7994 Previously an unquoted attribute value in a table row
7995 could cause parsing problems.
7996 + Improved treatment of verbatim constructions (#3055).
7997 Previously these yielded strings of alternating Code and Space
7998 elements; we now incorporate the spaces into the Code. Emphasis
7999 etc. is still possible inside these.
8000 + Properly interpret XML tags in pre environments (#3042). They are meant
8001 to be interpreted as literal text.
8003 * EPUB reader: don't add root path to data: URIs (#3150).
8004 Thanks to @lep for the bug report and patch.
8006 * Org reader (Albert Krewinkel):
8008 + Preserve indentation of verse lines (#3064). Leading spaces in verse
8009 lines are converted to non-breaking spaces, so indentation is preserved.
8010 + Ensure image sources are proper links. Image sources as those in plain
8011 images, image links, or figures, must be proper URIs or relative file
8012 paths to be recognized as images. This restriction is now enforced
8013 for all image sources. This also fixes the reader's usage of uncleaned
8014 image sources, leading to `file:` prefixes not being deleted from
8015 figure images. Thanks to @bsag for noticing this bug.
8016 + Trim verse lines properly (Albert Krewinkel).
8017 + Extract meta parsing code to module. Parsing of meta-data is well
8018 separable from other block parsing tasks. Moving into new module to
8019 get small files and clearly arranged code.
8020 + Read markup only for special meta keys. Most meta-keys should be read
8021 as normal string values, only a few are interpreted as marked-up text.
8022 + Allow multiple, comma-separated authors. Multiple authors can be
8023 specified in the `#+AUTHOR` meta line if they are given as a
8024 comma-separated list.
8025 + Give precedence to later meta lines. The last meta-line of any given
8026 type is the significant line. Previously the value of the first line
8027 was kept, even if more lines of the same type were encounterd.
8028 + Read LaTeX_header as header-includes. LaTeX-specific header commands
8029 can be defined in `#+LaTeX_header` lines. They are parsed as
8030 format-specific inlines to ensure that they will only show up in LaTeX
8031 output.
8032 + Set documentclass meta from LaTeX_class.
8033 + Set classoption meta from LaTeX_class_options.
8034 + Read HTML_head as header-includes. HTML-specific head content can be
8035 defined in `#+HTML_head` lines. They are parsed as format-specific
8036 inlines to ensure that they will only show up in HTML output.
8037 + Respect `author` export option. The `author` option controls whether
8038 the author should be included in the final markup. Setting
8039 `#+OPTIONS: author:nil` will drop the author from the final meta-data
8040 output.
8041 + Respect `email` export option. The `email` option controls whether the
8042 email meta-field should be included in the final markup. Setting
8043 `#+OPTIONS: email:nil` will drop the email field from the final
8044 meta-data output.
8045 + Respect `creator` export option. The `creator` option controls whether
8046 the creator meta-field should be included in the final markup. Setting
8047 `#+OPTIONS: creator:nil` will drop the creator field from the final
8048 meta-data output. Org-mode recognizes the special value `comment` for
8049 this field, causing the creator to be included in a comment. This is
8050 difficult to translate to Pandoc internals and is hence interpreted the
8051 same as other truish values (i.e. the meta field is kept if it's
8052 present).
8053 + Respect unnumbered header property (#3095). Sections the `unnumbered`
8054 property should, as the name implies, be excluded from the automatic
8055 numbering of section provided by some output formats. The Pandoc
8056 convention for this is to add an "unnumbered" class to the header. The
8057 reader treats properties as key-value pairs per default, so a special
8058 case is added to translate the above property to a class instead.
8059 + Allow figure with empty caption (Albert Krewinkel, #3161).
8060 A `#+CAPTION` attribute before an image is enough to turn an image into
8061 a figure. This wasn't the case because the `parseFromString` function,
8062 which processes the caption value, would fail on empty values. Adding
8063 a newline character to the caption value fixes this.
8065 * Docx reader:
8067 + Use XML convenience functions (Jesse Rosenthal).
8068 The functions `isElem` and `elemName` (defined in Docx/Util.hs) make
8069 the code a lot cleaner than the original XML.Light functions, but they
8070 had been used inconsistently. This puts them in wherever applicable.
8071 + Handle anchor spans with content in headers. Previously, we would only
8072 be able to figure out internal links to a header in a docx if the
8073 anchor span was empty. We change that to read the inlines out of the
8074 first anchor span in a header.
8075 + Let headers use exisiting id. Previously we always generated an id for
8076 headers (since they wouldn't bring one from Docx). Now we let it use an
8077 existing one if possible. This should allow us to recurs through anchor
8078 spans.
8079 + Use all anchor spans for header ids. Previously we only used the first
8080 anchor span to affect header ids. This allows us to use all the anchor
8081 spans in a header, whether they're nested or not (#3088).
8082 + Test for nested anchor spans in header. This ensures that anchor spans
8083 in header with content (or with other anchor spans inside) will resolve
8084 to links to a header id properly.
8086 * ODT reader (Hubert Plociniczak)
8088 + Include list's starting value. Previously the starting value of
8089 the lists' items has been hardcoded to 1. In reality ODT's list
8090 style definition can provide a new starting value in one of its
8091 attributes.
8092 + Infer caption from the text following the image.
8093 Frame can contain other frames with the text boxes.
8094 + Add `fig:` to title for Image with a caption (as expected
8095 by pandoc's writers).
8096 + Basic support for images in ODT documents.
8097 + Don't duplicate text for anchors (#3143). When creating an anchor
8098 element we were adding its representation as well as the original
8099 content, leading to text duplication.
8101 * DocBook writer:
8103 + Include an anchor element when a div or span has an id (#3102).
8104 Note that DocBook does not have a class attribute, but at least this
8105 provides an anchor for internal links.
8107 * LaTeX writer:
8109 + Don't use * for unnumbered paragraph, subparagraph. The starred
8110 variants don't exist. This helps with part of #3058...it gets rid of
8111 the spurious `*`s. But we still have numbers on the 4th and 5th level
8112 headers.
8113 + Properly escape backticks in verbatim (#3121, Jesse Rosenthal).
8114 Otherwise they can cause unintended ligatures like `` ?` ``.
8115 + Handle NARRAOW NO-BREAK SPACE into LaTeX (Vaclav Zeman) as `\,`.
8116 + Don't include `[htbp]` placement for figures (#3103, Václav Haisman).
8117 This allows figure placement defaults to be changed by the user
8118 in the template.
8120 * TEI writer: remove heuristic to detect book template (Albert Krewinkel).
8121 TEI doesn't have `<book>` elements but only generic `<divN>` division
8122 elements. Checking the template for a trailing `</book>` is nonsensical.
8124 * MediaWiki writer: transform filename with underscores in images (#3052).
8125 `foo bar.jpg` becomes `foo_bar.jpg`. This was already done
8126 for internal links, but it also needs to happen for images.
8128 * ICML writer: replace partial function (!!) in table handling (#3175,
8129 Mauro Bieg).
8131 * Man writer: allow section numbers that are not a single digit (#3089).
8133 * AsciiDoc writer: avoid unnecessary use of "unconstrained" emphasis
8134 (#3068). In AsciiDoc, you must use a special form of emphasis
8135 (double `__`) for intraword emphasis. Pandoc was previously using
8136 this more than necessary.
8138 * EPUB writer: use stringify instead of plain writer for metadata
8139 (#3066). This means that underscores won't be used for emphasis,
8140 or CAPS for bold. The metadata fields will just have unadorned
8141 text.
8143 * Docx Writer:
8145 + Implement user-defined styles (Jesse Rosenthal). Divs and Spans
8146 with a `custom-style` key in the attributes will apply the corresponding
8147 key to the contained blocks or inlines.
8148 + Add ReaderT env to the docx writer (Jesse Rosenthal).
8149 + Clean up and streamline RTL behavior (Jesse Rosenthal, #3140).
8150 You can set `dir: rtl` in YAML metadata, or use `-M dir=rtl`
8151 on the command line. For finer-grained control, you can set
8152 the `dir` attribute in Div or Span elements.
8154 * Org writer (Albert Krewinkel):
8156 + Remove blank line after figure caption. Org-mode only treats an image
8157 as a figure if it is directly preceded by a caption.
8158 + Ensure blank line after figure. An Org-mode figure should be surrounded
8159 by blank lines. The figure would be recognized regardless, but images
8160 in the following line would unintentionally be treated as figures as
8161 well.
8162 + Ensure link targets are paths or URLs. Org-mode treats links as
8163 document internal searches unless the link target looks like a URL or
8164 file path, either relative or absolute. This change ensures that this
8165 is always the case.
8166 + Translate language identifiers. Pandoc and Org-mode use different
8167 programming language identifiers. An additional translation between
8168 those identifiers is added to avoid unexpected behavior. This fixes a
8169 problem where language specific source code would sometimes be output
8170 as example code.
8171 + Drop space before footnote markers (Albert Krewinkel, #3162).
8172 The writer no longer adds an extra space before footnote markers.
8174 * Markdown writer:
8176 + Don't emit HTML for tables unless `raw_html` extension is set (#3154).
8177 Emit `[TABLE]` if no suitable table formats are enabled and raw HTML
8178 is disabled.
8179 + Check for the `raw_html` extension before emitting a raw HTML block.
8180 + Abstract out note/ref function (Jesse Rosenthal).
8181 + Add ReaderT monad for environment variables (Jesse Rosenthal).
8183 * HTML, EPUB, slidy, revealjs templates: Use `<p>` instead of `<h1>` for
8184 subtitle, author, date (#3119). Note that, as a result of this change,
8185 authors may need to update CSS.
8187 * revealjs template: Added `notes-server` option
8188 (jgm/pandoc-templates#212, Yoan Blanc).
8190 * Beamer template:
8192 + Restore whitespace between paragraphs. This was
8193 a regression in the last release (jgm/pandoc-templates#207).
8194 + Added `themeoptions` variable (Carsten Gips).
8195 + Added `beamerarticle` variable. This causes the `beamerarticle`
8196 package to be loaded in beamer, to produce an article from beamer
8197 slides. (Carsten Gips)
8198 + Added support for `fontfamilies` structured variable
8199 (Artem Klevtsov).
8200 + Added hypersetup options (Jake Zimmerman).
8202 * LaTeX template:
8204 + Added dummy definition for `\institute`.
8205 This isn't a standard command, and we want to avoid a crash when
8206 `institute` is used with the default template.
8207 + Define default figure placement (Václav Haisman), since pandoc
8208 no longer includes `[htbp]` for figures. Users with custom templates
8209 will want to add this. See #3103.
8210 + Use footnote package to fix notes in tables (jgm/pandoc-templates#208,
8211 Václav Haisman).
8213 * Moved template compiling/rendering code to a separate library.
8214 `doctemplates`. This allows the pandoc templating system to be
8215 used independently.
8217 * Text.Pandoc.Error: Fix out of index error in `handleError`
8218 (Matthew Pickering). The fix is to not try to show the exact line when
8219 it would cause an out-of-bounds error as a result of included files.
8221 * Text.Pandoc.Shared: Add `linesToBlock` function (Albert Krewinkel).
8223 * Text.Pandoc.Parsing.emailAddress: tighten up parsing of email
8224 addresses. Technically `**@user` is a valid email address, but if we
8225 allow things like this, we get bad results in markdown flavors
8226 that autolink raw email addresses (see #2940). So we exclude a few
8227 valid email addresses in order to avoid these more common bad cases.
8229 * Text.Pandoc.PDF: Don't crash with nonexistent image (#3100). Instead,
8230 emit the alt text, emphasized. This accords with what the ODT writer
8231 currently does. The user will still get a warning about a nonexistent
8232 image.
8234 * Fix example in API documentation (#3176, Thomas Weißschuh).
8236 * Tell where to get tarball in INSTALL (#3062).
8238 * Rename README to MANUAL.txt and add GitHub-friendly README.md
8239 (Albert Krewinkel, Kolen Cheung).
8241 * Replace COPYING with Markdown version COPYING.md from GNU (Kolen Cheung).
8243 * MANUAL.txt:
8245 + Put note on structured vars in separate paragraph (#2148, Albert
8246 Krewinkel). Make it clearer that structured author variables require a
8247 custom template
8248 + Note that `--katex` works best with `html5` (#3077).
8249 + Fix the LaTeX and EPUB links in manual (Morton Fox).
8250 + Document `biblio-title` variable.
8252 * Improve spacing of footnotes in `--help` output (Waldir Pimenta).
8254 * Update KaTeX to v0.6.0 (Kolen Cheung).
8256 * Allow latest dependencies.
8258 * Use texmath 0.8.6.6 (#3040).
8260 * Allow http-client 0.4.30, which is the version in stackage lts.
8261 Previously we required 0.5.
8262 Remove CPP conditionals for earlier versions.
8264 * Remove support for GHC < 7.8 (Jesse Rosenthal).
8266 + Remove Compat.Monoid.
8267 + Remove an inline monad compatibility macro.
8268 + Remove Text.Pandoc.Compat.Except.
8269 + Remove directory compat.
8270 + Change constraint on mtl.
8271 + Remove unnecessary CPP condition in UTF8.
8272 + Bump base lower bound to 4.7.
8273 + Remove 7.6 build from .travis.yaml.
8274 + Bump supported ghc version in CONTRIBUTING.md.
8275 + Add note about GHC version support to INSTALL.
8276 + Remove GHC 7.6 from list of tested versions (Albert Krewinkel).
8277 + Remove TagSoup compat.
8278 + Add EOL note to time compat module. Because time 1.4 is a boot library
8279 for GHC 7.8, we will support the compatibility module as long as we
8280 support 7.8. But we should be clear about when we will no longer need
8281 it.
8282 + Remove blaze-html CPP conditional.
8283 + Remove unnecessary CPP in custom Prelude.
8285## pandoc 1.17.2 (2016-07-17)
8287 * Added Zim Wiki writer, template and tests. `zimwiki` is now
8288 a valid output format. (Alex Ivkin)
8290 * Changed email-obfuscation default to no obfuscation (#2988).
8291 + `writerEmailObfuscation` in `defaultWriterOptions` is now
8292 `NoObfuscation`.
8293 + the default for the command-line `--email-obfuscation` option is
8294 now `none`.
8296 * Docbook writer: Declare xlink namespace in Docbook5 output (Ivo Clarysse).
8298 * Org writer:
8300 + Support arbitrary raw inlines (Albert Krewinkel).
8301 Org mode allows arbitrary raw inlines ("export snippets" in Emacs
8302 parlance) to be included as `@@format:raw foreign format text@@`.
8303 + Improve Div handling (Albert Krewinkel). Div blocks handling is
8304 changed to make the output look more like idiomatic org mode:
8305 - Div-wrapped content is output as-is if the div's attribute is the
8306 null attribute.
8307 - Div containers with an id but neither classes nor key-value pairs
8308 are unwrapped and the id is added as an anchor.
8309 - Divs with classes associated with greater block elements are
8310 wrapped in a `#+BEGIN`...`#+END` block.
8311 - The old behavior for Divs with more complex attributes is kept.
8313 * HTML writer: Better support for raw LaTeX environments (#2758).
8314 Previously we just passed all raw TeX through when MathJax
8315 was used for HTML math. This passed through too much.
8316 With this patch, only raw LaTeX environments that MathJax
8317 can handle get passed through.
8318 This patch also causes raw LaTeX environments to be treated
8319 as math, when possible, with MathML and WebTeX output.
8321 * Markdown writer: use raw HTML for simple, pipe tables with linebreaks
8322 (#2993). Markdown line breaks involve a newline, and simple and pipe
8323 tables can't contain one.
8325 * Make --webtex work with the Markdown writer (#1177).
8326 This is a convenient option for people using
8327 websites whose Markdown flavors don't provide for math.
8329 * Docx writer:
8331 + Set paragraph to FirstPara after display math (Jesse Rosenthal).
8332 We treat display math like block quotes, and apply FirstParagraph style
8333 to paragraphs that follow them. These can be styled as the user
8334 wishes. (But, when the user is using indentation, this allows for
8335 paragraphs to continue after display math without indentation.)
8336 + Use actual creation time as doc prop (Jesse Rosenthal).
8337 Previously, we had used the user-supplied date, if available, for Word's
8338 document creation metadata. This could lead to weird results, as in
8339 cases where the user post-dates a document (so the modification might be
8340 prior to the creation). Here we use the actual computer time to set the
8341 document creation.
8343 * LaTeX writer:
8345 + Don't URI-escape image source (#2825). Usually this is a local file,
8346 and replacing spaces with `%20` ruins things.
8347 + Allow 'standout' as a beamer frame option (#3007).
8348 `## Slide title {.standout}`.
8350 * RST reader: Fixed links with no explicit link text. The link
8351 `` `<foo>`_ `` should have `foo` as both its link text and its URL.
8352 See RST spec at <http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#embedded-uris-and-aliases>
8353 Closes Debian #828167 -- reported by Christian Heller.
8355 * Textile reader:
8357 + Fixed attributes (#2984). Attributes can't be followed by
8358 a space. So, `_(class)emph_` but `_(noclass) emph_`.
8359 + Fixed exponential parsing bug (#3020).
8360 + Fix overly aggressive interpretation as images (#2998).
8361 Spaces are not allowed in the image URL in textile.
8363 * LaTeX reader:
8365 + Fix `\cite` so it is a NormalCitation not AuthorInText.
8366 + Strip off double quotes around image source if present (#2825).
8367 Avoids interpreting these as part of the literal filename.
8369 * Org reader:
8371 + Add semicolon to list of special chars (Albert Krewinkel)
8372 Semicolons are used as special characters in citations syntax. This
8373 ensures the correct parsing of Pandoc-style citations: `[prefix; @key;
8374 suffix]`. Previously, parsing would have failed unless there was a space
8375 or other special character as the last <prefix> character.
8376 + Add support for "Berkeley-style" cites (Albert Krewinkel, #1978).
8377 A specification for an official Org-mode citation syntax was drafted by
8378 Richard Lawrence and enhanced with the help of others on the orgmode
8379 mailing list. Basic support for this citation style is added to the
8380 reader.
8381 + Support arbitrary raw inlines (Albert Krewinkel).
8382 Org mode allows arbitrary raw inlines ("export snippets" in Emacs
8383 parlance) to be included as `@@format:raw foreign format text@@`.
8384 + Remove partial functions (Albert Krewinkel, #2991).
8385 Partial functions like `head` lead to avoidable errors and should be
8386 avoided. They are replaced with total functions.
8387 + Support figure labels (Albert Krewinkel, #2496, #2999).
8388 Figure labels given as `#+LABEL: thelabel` are used as the ID of the
8389 respective image. This allows e.g. the LaTeX to add proper `\label`
8390 markup.
8391 + Improve tag and properties type safety (Albert Krewinkel).
8392 Specific newtype definitions are used to replace stringly typing of tags
8393 and properties. Type safety is increased while readability is improved.
8394 + Parse as headlines, convert to blocks (Albert Krewinkel).
8395 Emacs org-mode is based on outline-mode, which treats documents as trees
8396 with headlines are nodes. The reader is refactored to parse into a
8397 similar tree structure. This simplifies transformations acting on
8398 document (sub-)trees.
8399 * Refactor comment tree handling (Albert Krewinkel).
8400 Comment trees were handled after parsing, as pattern matching on lists
8401 is easier than matching on sequences. The new method of reading
8402 documents as trees allows for more elegant subtree removal.
8403 * Support archived trees export options (Albert Krewinkel).
8404 Handling of archived trees can be modified using the `arch` option.
8405 Archived trees are either dropped, exported completely, or collapsed to
8406 include just the header when the `arch` option is nil, non-nil, or
8407 `headline`, respectively.
8408 * Put export setting parser into module (Albert Krewinkel).
8409 Export option parsing is distinct enough from general block parsing to
8410 justify putting it into a separate module.
8411 * Support headline levels export setting (Albert Krewinkel).
8412 The depths of headlines can be modified using the `H` option. Deeper
8413 headlines will be converted to lists.
8414 * Replace ugly code with view pattern (Albert Krewinkel).
8415 Some less-than-smart code required a pragma switching of overlapping
8416 pattern warnings in order to compile seamlessly. Using view patterns
8417 makes the code easier to read and also doesn't require overlapping
8418 pattern checks to be disabled.
8419 * Fix parsing of verbatim inlines (Albert Krewinkel, #3016).
8420 Org rules for allowed characters before or after markup chars were not
8421 checked for verbatim text. This resultet in wrong parsing outcomes of
8422 if the verbatim text contained e.g. space enclosed markup characters as
8423 part of the text (`=is_substr = True=`). Forcing the parser to update
8424 the positions of allowed/forbidden markup border characters fixes this.
8426 * LaTeX template: fix for obscure hyperref/xelatex issue.
8427 Here's a minimal case:
8429 \documentclass[]{article}
8430 \usepackage{hyperref}
8431 \begin{document}
8432 \section{\%á}
8433 \end{document}
8435 Without this change, this fails on the second invocation of xelatex.
8436 This affects inputs this like `# %á` with pdf output via xelatex.
8438 * trypandoc: call results 'html' instead of 'result'.
8439 This is for better compatibility with babelmark2.
8441 * Document MultiMarkdown as input/output format (Albert Krewinkel, #2973).
8442 MultiMarkdown was only mentioned as a supported Markdown dialect but not
8443 as a possible input or output format. A brief mention is added
8444 everywhere the other supported markdown dialects are mentioned.
8446 * Document Org mode as a format containing raw HTML (Albert Krewinkel)
8447 Raw HTML is kept when the output format is Emacs Org mode.
8449 * Implement `RawInline` and `RawBlock` in sample lua custom writer (#2985).
8451 * Text.Pandoc.Shared:
8453 + Introduce blocksToInlines function (Jesse Rosenthal).
8454 This is a lossy function for converting `[Block] -> [Inline]`. Its main
8455 use, at the moment, is for docx comments, which can contain arbitrary
8456 blocks (except for footnotes), but which will be converted to spans.
8457 This is, at the moment, pretty useless for everything but the basic
8458 `Para` and `Plain` comments. It can be improved, but the docx reader
8459 should probably emit a warning if the comment contains more than this.
8460 + Add BlockQuote to blocksToInlines (Jesse Rosenthal).
8461 + Add further formats for `normalizeDate` (Jesse Rosenthal).
8462 We want to avoid illegal dates -- in particular years with greater than
8463 four digits. We attempt to parse series of digits first as `%Y%m%d`, then
8464 `%Y%m`, and finally `%Y`.
8465 + `normalizeDate` should reject illegal years (Jesse Rosenthal).
8466 We only allow years between 1601 and 9999, inclusive. The ISO 8601
8467 actually says that years are supposed to start with 1583, but MS Word
8468 only allows 1601-9999. This should stop corrupted word files if the date
8469 is out of that range, or is parsed incorrectly.
8470 + Improve year sanity check in normalizeDate (Jesse Rosenthal).
8471 Previously we parsed a list of dates, took the first one, and then
8472 tested its year range. That meant that if the first one failed, we
8473 returned nothing, regardless of what the others did. Now we test for
8474 sanity before running `msum` over the list of Maybe values. Anything
8475 failing the test will be Nothing, so will not be a candidate.
8477 * Docx reader:
8479 + Add simple comment functionality. (Jesse Rosenthal).
8480 This adds simple track-changes comment parsing to the docx reader. It is
8481 turned on with `--track-changes=all`. All comments are converted to
8482 inlines, which can list some information. In the future a warning will be
8483 added for comments with formatting that seems like it will be excessively
8484 denatured. Note that comments can extend across blocks. For that reason
8485 there are two spans: `comment-start` and `comment-end`. `comment-start`
8486 will contain the comment. `comment-end` will always be empty. The two
8487 will be associated by a numeric id.
8488 + Enable warnings in top-level reader (Jesse Rosenthal).
8489 Previously we had only allowed for warnings in the parser. Now we allow
8490 for them in the `Docx.hs` as well. The warnings are simply concatenated.
8491 + Add warning for advanced comment formatting. (Jesse Rosenthal).
8492 We can't guarantee we'll convert every comment correctly, though we'll
8493 do the best we can. This warns if the comment includes something other
8494 than Para or Plain.
8495 + Add tests for warnings. (Jesse Rosenthal).
8496 + Add tests for comments (Jesse Rosenthal).
8497 We test for comments, using all track-changes options. Note that we
8498 should only output comments if `--track-changes=all`. We also test for
8499 emitting warnings if there is complicated formatting.
8501 * README: update to include track-changes comments. (Jesse Rosenthal)
8503 * Improved Windows installer - don't ignore properties set on command-line.
8504 See #2708. Needs testing to see if this resolves the issue.
8505 Thanks to @nkalvi.
8507 * Process markdown extensions on command line in L->R order (#2995).
8508 Previously they were processed, very unintuitively, in R->L
8509 order, so that `markdown-tex_math_dollars+tex_math_dollars`
8510 had `tex_math_dollars` disabled.
8512 * Added `secnumdepth` variable to LaTeX template (#2920).
8514 * Include table of contents in README.html in Windows package.
8516 * Writers: treat SoftBreak as space for stripping (Jesse Rosenthal)
8517 In Writers.Shared, we strip leading and trailing spaces for display
8518 math. Since SoftBreak's are treated as spaces, we should strip those
8519 too.
8521 * beamer, latex templates: pass biblatexoptions directly in package load.
8522 This allows runtime optinos to be used. Fixes jgm/pandoc-citeproc#201
8524 * CPP workaround for deprecation of `parseUrl` in http-client.
8526 * Removed some redundant class constraints.
8528 * make_oxs_package.sh - use OSX env variable.
8530 * Added `winpkg` target to Makefile. This downloads the windows package
8531 from appveyor and signs it using the key.
8533 * Document Org mode as a format containing raw TeX (Albert Krewinkel).
8534 Raw TeX is kept verbatim when the output format is Emacs Org mode.
8536 * Support math with haddock-library >= 1.4.
8538 * Removed `-rtsopts` from library stanza. It has no effect, and Hackage
8539 wouldn't accept the package.
8541 * Update library dependency versions.
8543## pandoc 1.17.1 (2016-06-04)
8545 * New output format: `docbook5` (Ivo Clarysse).
8547 * `Text.Pandoc.Options`: Add `writerDocBook5` to `WriterOptions`
8548 (API change).
8550 * Org writer:
8552 + Add :PROPERTIES: drawer support (Albert Krewinkel, #1962).
8553 This allows header attributes to be added to org documents in the form
8554 of `:PROPERTIES:` drawers. All available attributes are stored as
8555 key/value pairs. This reflects the way the org reader handles
8556 `:PROPERTIES:` blocks.
8557 + Add drawer capability (Carlos Sosa). For the implementation of the
8558 Drawer element in the Org Writer, we make use of a generic Block
8559 container with attributes. The presence of a `drawer` class defines
8560 that the `Div` constructor is a drawer. The first class defines the
8561 drawer name to use. The key-value list in the attributes defines
8562 the keys to add inside the Drawer. Lastly, the list of Block elements
8563 contains miscellaneous blocks elements to add inside of the Drawer.
8564 + Use `CUSTOM_ID` in properties (Albert Krewinkel). The `ID` property is
8565 reserved for internal use by Org-mode and should not be used.
8566 The `CUSTOM_ID` property is to be used instead, it is converted to the
8567 `ID` property for certain export format.
8569 * LaTeX writer:
8571 + Ignore `--incremental` unless output format is beamer (#2843).
8572 + Fix polyglossia to babel env mapping (Mauro Bieg, #2728).
8573 Allow for optional argument in square brackets.
8574 + Recognize `la-x-classic` as Classical Latin (Andrew Dunning).
8575 This allows one to access the hyphenation patterns in CTAN's
8576 hyph-utf8.
8577 + Add missing languages from hyph-utf8 (Andrew Dunning).
8578 + Improve use of `\strut` with `\minipage` inside tables
8579 (Jose Luis Duran). This improves spacing in multiline
8580 tables.
8581 + Use `{}` around options containing special chars (#2892).
8582 + Avoid lazy `foldl`.
8583 + Don't escape underscore in labels (#2921). Previously they were
8584 escaped as `ux5f`.
8585 + brazilian -> brazil for polyglossia (#2953).
8587 * HTML writer: Ensure mathjax link is added when math appears in footnote
8588 (#2881). Previously if a document only had math in a footnote, the
8589 MathJax link would not be added.
8591 * EPUB writer: set `navpage` variable on nav page.
8592 This allows templates to treat it differently.
8594 * DocBook writer:
8596 + Use docbook5 if `writerDocbook5` is set (Ivo Clarysse).
8597 + Properly handle `ulink`/`link` (Ivo Clarysse).
8599 * EPUB reader:
8601 + Unescape URIs in spine (#2924).
8602 + EPUB reader: normalise link id (Mauro Bieg).
8604 * Docx Reader:
8606 + Parse `moveTo` and `moveFrom` (Jesse Rosenthal).
8607 `moveTo` and `moveFrom` are track-changes tags that are used when a
8608 block of text is moved in the document. We now recognize these tags and
8609 treat them the same as `insert` and `delete`, respectively. So,
8610 `--track-changes=accept` will show the moved version, while
8611 `--track-changes=reject` will show the original version.
8612 + Tests for track-changes moving (Jesse Rosenthal).
8614 * ODT, EPUB, Docx readers: throw `PandocError` on unzip failure
8615 (Jesse Rosenthal) Previously, `readDocx`, `readEPUB`, and `readOdt`
8616 would error out if zip-archive failed. We change the archive extraction
8617 step from `toArchive` to `toArchiveOrFail`, which returns an Either value.
8619 * Markdown, HTML readers: be more forgiving about unescaped `&` in
8620 HTML (#2410). We are now more forgiving about parsing invalid HTML with
8621 unescaped `&` as raw HTML. (Previously any unescaped `&`
8622 would cause pandoc not to recognize the string as raw HTML.)
8624 * Markdown reader:
8626 + Fix pandoc title blocks with lines ending in 2 spaces (#2799).
8627 + Added `-s` to markdown-reader-more test.
8629 * HTML reader: fixed bug in `pClose`. This caused exponential parsing
8630 behavior in documnets with unclosed tags in `dl`, `dd`, `dt`.
8632 * MediaWiki reader: Allow spaces before `!` in MediaWiki table header
8633 (roblabla).
8635 * RST reader: Support `:class:` option for code block in RST reader
8636 (Sidharth Kapur).
8638 * Org reader (all Albert Krewinkel, except where noted otherwise):
8640 + Stop padding short table rows.
8641 Emacs Org-mode doesn't add any padding to table rows. The first
8642 row (header or first body row) is used to determine the column count,
8643 no other magic is performed.
8644 + Refactor rows-to-table conversion. This refactors
8645 the codes conversing a list table lines to an org table ADT.
8646 The old code was simplified and is now slightly less ugly.
8647 + Fix handling of empty table cells, rows (Albert Krewinkel, #2616).
8648 This fixes Org mode parsing of some corner cases regarding empty cells
8649 and rows. Empty cells weren't parsed correctly, e.g. `|||` should be
8650 two empty cells, but would be parsed as a single cell containing a pipe
8651 character. Empty rows where parsed as alignment rows and dropped from
8652 the output.
8653 + Fix spacing after LaTeX-style symbols.
8654 The org-reader was droping space after unescaped LaTeX-style symbol
8655 commands: `\ForAll \Auml` resulted in `∀Ä` but should give `∀ Ä`
8656 instead. This seems to be because the LaTeX-reader treats the
8657 command-terminating space as part of the command. Dropping the trailing
8658 space from the symbol-command fixes this issue.
8659 + Print empty table rows. Empty table rows should not
8660 be dropped from the output, so row-height is always set to be at least 1.
8661 + Move parser state into separate module.
8662 The org reader code has become large and confusing. Extracting smaller
8663 parts into submodules should help to clean things up.
8664 + Add support for sub/superscript export options.
8665 Org-mode allows to specify export settings via `#+OPTIONS` lines.
8666 Disabling simple sub- and superscripts is one of these export options,
8667 this options is now supported.
8668 + Support special strings export option Parsing of special strings
8669 (like `...` as ellipsis or `--` as en dash) can be toggled using the `-`
8670 option.
8671 + Support emphasized text export option. Parsing of emphasized text can
8672 be toggled using the `*` option. This influences parsing of text marked
8673 as emphasized, strong, strikeout, and underline. Parsing of inline math,
8674 code, and verbatim text is not affected by this option.
8675 + Support smart quotes export option. Reading of smart quotes can be
8676 toggled using the `'` option.
8677 + Parse but ignore export options. All known export options are parsed
8678 but ignored.
8679 + Refactor block attribute handling. A parser state attribute was used
8680 to keep track of block attributes defined in meta-lines. Global state
8681 is undesirable, so block attributes are no longer saved as part of the
8682 parser state. Old functions and the respective part of the parser state
8683 are removed.
8684 + Use custom `anyLine`. Additional state changes need to be made after
8685 a newline is parsed, otherwise markup may not be recognized correctly.
8686 This fixes a bug where markup after certain block-types would not be
8687 recognized.
8688 + Add support for `ATTR_HTML` attributes (#1906).
8689 Arbitrary key-value pairs can be added to some block types using a
8690 `#+ATTR_HTML` line before the block. Emacs Org-mode only includes these
8691 when exporting to HTML, but since we cannot make this distinction here,
8692 the attributes are always added. The functionality is now supported
8693 for figures.
8694 + Add `:PROPERTIES:` drawer support (#1877).
8695 Headers can have optional `:PROPERTIES:` drawers associated with them.
8696 These drawers contain key/value pairs like the header's `id`. The
8697 reader adds all listed pairs to the header's attributes; `id` and
8698 `class` attributes are handled specially to match the way `Attr` are
8699 defined. This also changes behavior of how drawers of unknown type
8700 are handled. Instead of including all unknown drawers, those are not
8701 read/exported, thereby matching current Emacs behavior.
8702 + Use `CUSTOM_ID` in properties. See above on Org writer changes.
8703 + Respect drawer export setting. The `d` export option can be used
8704 to control which drawers are exported and which are discarded.
8705 Basic support for this option is added here.
8706 + Ignore leading space in org code blocks (Emanuel Evans, #2862).
8707 Also fix up tab handling for leading whitespace in code blocks.
8708 + Support new syntax for export blocks. Org-mode version 9
8709 uses a new syntax for export blocks. Instead of `#+BEGIN_<FORMAT>`,
8710 where `<FORMAT>` is the format of the block's content, the new
8711 format uses `#+BEGIN_export <FORMAT>` instead. Both types are
8712 supported.
8713 + Refactor `BEGIN...END` block parsing.
8714 + Fix handling of whitespace in blocks, allowing content to be indented
8715 less then the block header.
8716 + Support org-ref style citations. The *org-ref* package is an
8717 org-mode extension commonly used to manage citations in org
8718 documents. Basic support for the `cite:citeKey` and
8719 `[[cite:citeKey][prefix text::suffix text]]` syntax is added.
8720 + Split code into separate modules, making for cleaner code and
8721 better decoupling.
8723 * Added `docbook5` template.
8725 * `--mathjax` improvements:
8727 + Use new CommonHTML output for MathJax (updated default MathJax URL,
8728 #2858).
8729 + Change default mathjax setup to use `TeX-AMS_CHTML` configuration.
8730 This is designed for cases where the input is always TeX and maximal
8731 conformity with TeX is desired. It seems to be smaller and load faster
8732 than what we used before. See #2858.
8733 + Load the full MathJax config to maximize loading speed (KolenCheung).
8735 * Bumped upper version bounds to allow use of latest packages
8736 and compilation with ghc 8.
8738 * Require texmath 0.8.6.2. Closes several texmath-related bugs (#2775,
8739 #2310, #2310, #2824). This fixes behavior of roots, e.g.
8740 `\sqrt[3]{x}`, and issues with sub/superscript positioning
8741 and matrix column alignment in docx.
8743 * README:
8745 + Clarified documentation of `implicit_header_references` (#2904).
8746 + Improved documentation of `--columns` option.
8748 * Added appveyor setup, with artefacts (Jan Schulz).
8750 * stack.yaml versions: Use proper flags used for texmath, pandoc-citeproc.
8752 * LaTeX template: support for custom font families (vladipus).
8753 Needed for correct polyglossia operation with Cyrillic fonts and perhaps
8754 can find some other usages. Example usage in YAML metadata:
8756 fontfamilies:
8757 - name: \cyrillicfont
8758 font: Liberation Serif
8759 - name: \cyrillicfonttt
8760 options: Scale=MatchLowercase
8761 font: Liberation
8763 * Create unsigned msi as build artifact in appveyor build.
8765 * On travis, test with ghc 8.0.1; drop testing for ghc 7.4.1.
8769## pandoc 1.17.0.3 (2016-03-24)
8771 * LaTeX writer: Fixed position of label in figures (#2813).
8772 Previously the label wasn't in the right place, and `\ref`
8773 wouldn't work properly.
8774 * Added .tei test files to pandoc.cabal so they'll be included
8775 in tarball (#2811).
8776 * Updated copyright dates.
8778## pandoc 1.17.0.2 (2016-03-23)
8780 * Fixed serious regression in `htmlInBalanced`, which caused
8781 newlines to be omitted in some raw HTML blocks in Markdown
8782 (#2804).
8784## pandoc 1.17.0.1 (2016-03-21)
8786 * File scope is no longer used when there are no input files (i.e.,
8787 when input comes from stdin). Previously file scope was triggered
8788 when the `json` reader was specified and input came from `stdin`,
8789 and this caused no output to be produced. (Fix due to Jesse Rosenthal;
8790 thanks to Fedor Sheremetyev for calling the bug to our attention.)
8791 * Improved documentation of templates (#2797).
8793## pandoc 1.17 (2016-03-20)
8795 * Added `--file-scope` option (Jesse Rosenthal).
8796 By default pandoc operates on multiple files by first concatenating
8797 them (around extra line breaks) and then processing the joined file. So
8798 it only parses a multi-file document at the document scope. This has the
8799 benefit that footnotes and links can be in different files, but for
8800 some purposes it is useful to parse the individual files first
8801 and then combine their outputs (e.g. when the files use footnotes
8802 or links with the same labels). The `--file-scope` option causes
8803 pandoc to parse the files first, and then combine the parsed output,
8804 instead of combining before parsing. `--file-scope` is selected
8805 automatically for binary input files (which cannot be concatenated)
8806 and for pandoc json.
8808 * Add TEI Writer (Chris Forster) and `tei` output format.
8810 * Added a general `ByteStringReader` with warnings, used by the docx
8811 reader (API change, Jesse Rosenthal).
8813 * Add `readDocxWithWarnings` (API change, Jesse Rosenthal).
8815 * Changed type of `Shared.uniqueIdent` argument from
8816 `[String]` to `Set String`. This avoids performance problems in documents
8817 with many identically named headers (API change, #2671).
8819 * Removed `tex_math_single_backslash` from `markdown_github` options
8820 (#2707).
8822 * Make language extensions as well as full language names
8823 trigger syntax highlighting. For example, `py` will now work as
8824 well as `python` (jgm/highlighting-kate#83).
8826 * Added `institute` variable to latex, beamer templates (Fraser
8827 Tweedale, Josef Svenningsson).
8829 * Docx reader (Jesse Rosenthal):
8831 + Handle alternate content. Some word functions (especially graphics)
8832 give various choices for content so there can be backwards compatibility.
8833 + Don't turn numbered headers into lists.
8834 + Docx Reader: Add state to the parser, for warnings
8835 + Update feature checklist in source code.
8836 + Get rid of `Modifiable` typeclass.
8837 + Add tests for adjacent hyperlinks.
8838 + Add a "Link" modifier to `Reducible`. We want to make sure that
8839 links have their spaces removed, and are appropriately smushed
8840 together (#2689).
8842 * HTML reader:
8844 + Fixed behavior of base tag (#2777).
8845 If the base path does not end with slash, the last component
8846 will be replaced. E.g. base = `http://example.com/foo`
8847 combines with `bar.html` to give `http://example.com/bar.html`.
8848 If the href begins with a slash, the whole path of the base
8849 is replaced. E.g. base = `http://example.com/foo/` combines
8850 with `/bar.html` to give `http://example.com/bar.html`.
8851 + Rewrote `htmlInBalanced`. This version avoids an exponential
8852 performance problem with `<script>` tags, and it should be faster
8853 in general (#2730).
8854 + Properly handle an empty cell in a simple table (#2718).
8855 + Handle multiple `<meta>` tags with same name. Put them in a list
8856 in the metadata so they are all preserved, rather than (as before)
8857 throwing out all but one..
8859 * Markdown reader:
8861 + Improved pipe table parsing (#2765).
8862 + Allow `+` separators in pipe table cells. We already allowed
8863 them in the header, but not in the body rows, for some reason.
8864 This gives compatibility with org-mode tables.
8865 + Don't cross line boundary parsing pipe table row.
8866 Previously an Emph element could be parsed across the newline
8867 at the end of the pipe table row.
8868 + Use `htmlInBalanced` for `rawVerbatimBlock`, for better
8869 performance (#2730).
8870 + Fixed bug with smart quotes around tex math.
8872 * LaTeX reader:
8874 + Handle interior `$` characters in math (#2743). For example,
8875 `$$\hbox{$i$}$$`.
8876 + `inlineCommand` now gobbles an empty `{}` after any command (#2687).
8877 This gives better results when people write e.g. `\TeX{}` in Markdown.
8878 + Properly handle LaTeX "math" environment as inline math (#2171).
8880 * Textile reader: Support `>`, `<`, `=`, `<>` text alignment attributes.
8881 Closes #2674.
8883 * Org reader (Albert Krewinkel):
8885 + Prefix even empty figure names with "fig:" (#2643). The
8886 convention used by pandoc for figures is to mark them by prefixing
8887 the name with `fig:`. The org reader failed to do this if a figure
8888 had no name.
8889 + Refactor link-target processing (#2684).
8891 * ConTeXt writer: Fix whitespace at line beginning in line blocks (#2744).
8892 Thanks to @c-foster.
8894 * HTML writer: Don't include alignment attribute for default table columns.
8895 Previously these were given "left" alignment. Better to leave off
8896 alignment attributes altogether (#2694).
8898 * Markdown writer: Use hyphens for YAML metadata block bottom line, for
8899 better compatibility with other Markdown flavors (Henrik Tramberend).
8901 * LaTeX writer:
8903 + Use image identifier to create a label and hypertarget for
8904 figures (Mauro Bieg).
8905 + Avoid double toprule in headerless table with caption (#2742).
8906 + Clean up options parser (Jesse Rosenthal).
8907 + Treat `memoir` template with `article` option as article, instead
8908 of treating all `memoir` templates as books.
8909 + Allow more flexible table alignment (Henrik Tramberend, #2665).
8910 New default is not to include `[c]` option (which is the default
8911 anyway if no positioning is specified). Now LaTeX emplates can
8912 control the overall table alignment in a document by setting the
8913 longtable length variables `LTleft` and `LTright`. For example,
8914 `\setlength\LTleft\parindent\setlength\LTright\fill`
8915 will create left-aligned tables that respect paragraph indentation.
8917 * Docx writer: Handle image alt text (#2754, Mauro Bieg).
8919 * Org writer - pass through RawInline with format "org".
8921 * DokuWiki writer: use `$$` for display math.
8923 * Custom writer: Pass attributes parameter to CaptionedImage (#2697).
8925 * Make protocol-relative URIs work again (#2737).
8927 * make_osx_package.sh: Use env variable for developer id certs.
8929 * Raise `tagsoup` lower bound to 0.13.7 to fix entity-related
8930 problems (#2734).
8932 * Allow `zip-archive` 0.3.
8934 * Allow `aeson` 0.11.
8936## pandoc 1.16.0.2 (2016-01-12)
8938 * Depend on deepseq rather than deepseq-generics (fpco/stackage#1096).
8940 * Fixed regression in latex smart quote parsing (#2645).
8941 In cases where a match was not found for a quote, everything
8942 from the open quote to the end of the paragraph was being dropped.
8944## pandoc 1.16.0.1 (2016-01-10)
8946 * Fixed regression with `--latex-engine` (#2618). In 1.16
8947 `--latex-engine` raises an error if a full path is given.
8949 * Org reader: Fix function dropping subtrees tagged `:noexport`
8950 (Albert Krewinkel, #2628):
8952 * Markdown reader: renormalize table column widths if they exceed 100%
8953 (#2626).
8955 * Textile reader: don't allow block HTML tags in inline contexts.
8956 The reader previously did allow this, following redcloth,
8957 which happily parses
8959 Html blocks can be <div>inlined</div> as well.
8961 as
8963 <p>Html blocks can be <div>inlined</div> as well.</p>
8965 This is invalid HTML. The above sample now produces;
8967 <p>Html blocks can be</p>
8968 <div>
8969 <p>inlined</p>
8970 </div>
8971 <p>as well.</p>
8973 * Improved default template lookup for custom lua scripts (#2625).
8974 Previously, if you tried to do `pandoc -s -t /path/to/lua/script.lua`,
8975 pandoc would look for the template in
8976 `~/.pandoc/templates/default./path/to/lua/script.lua`.
8977 With this change it will look in the more reasonable
8978 `~/.pandoc/templates/default.script.lua`. This makes it possible to
8979 store default templates for custom writers.
8981 * RST, Markdown writers: Fixed rendering of grid tables with blank rows
8982 (#2615).
8984 * LaTeX writer: restore old treatment of Span (#2624). A Span is
8985 now rendered with surrounding `{}`, as it was before 1.16.
8987 * Entity handling fixes: improved handling of entities like
8988 `&lang;` that require a trailing semicolon. Allow uppercase
8989 `x` in numerical hexidecimal character references, working
8990 around a tagsoup bug.
8992 * `stack.yaml` - use lts-4.0, but with older aeson to avoid excessive
8993 memory use on compile. With aeson 0.10 we were getting an out of
8994 memory error on a 2GB Ubuntu 64-bit VM.
8996 * Improved deb package creation script. Made `DPKGVER` work.
8997 Renamed `COMMIT` to `TREE`. You should now be able to do
8998 `TREE=1.16.0.1 DPKGVER=2 make deb`.
9001## pandoc 1.16 (2016-01-02)
9003 * Added `Attr` field to `Link` and `Image` (Mauro Bieg, #261, API change).
9005 + Added syntax for link and image attributes to pandoc's Markdown.
9006 + Updated readers and writers to use link and image attributes
9007 when appropriate.
9008 + Support image attributes in Docx, Textile, RST readers.
9010 * Renamed link attribute extensions. The old `link_attributes` is
9011 now `mmd_link_attributes`, and `link_attributes` now enables the
9012 new pandoc-style link and image attributes (API change).
9013 Note: this change could break some existing workflows.
9015 * Implemented `SoftBreak` and new `--wrap` option (#1701, API change).
9016 Added threefold wrapping option.
9018 + Command line option: deprecated `--no-wrap`, added
9019 `--wrap=[auto|none|preserve]`
9020 + Added `WrapOption`, exported from `Text.Pandoc.Options`
9021 + Changed type of `writerWrapText` in `WriterOptions` from
9022 `Bool` to `WrapOption`.
9023 + Modified `Text.Pandoc.Shared` functions to allow `SoftBreak`.
9024 + Supported `SoftBreak` in readers and writers.
9026 * Text.Pandoc.Options: Added `writerDpi` to `WriterOptions` (API
9027 change, Mauro Bieg).
9029 * Added `--dpi` command-line option (Mauro Bieg).
9031 * Rationalized behavior of `--no-tex-ligatures` and `--smart` (#2541).
9032 This change makes `--no-tex-ligatures` affect the LaTeX reader
9033 as well as the LaTeX and ConTeXt writers. If it is used,
9034 the LaTeX reader will parse characters `` ` ``, `'`, and `-`
9035 literally, rather than parsing ligatures for quotation marks
9036 and dashes. And the LaTeX writer will print unicode quotation
9037 mark and dash characters literally, rather than converting
9038 them to the standard ASCII ligatures. Note that `--smart` has
9039 no effect on the LaTeX reader. `--smart` is still the default
9040 for all input formats when LaTeX or ConTeXt is the output format,
9041 *unless* `--no-tex-ligatures` is used.
9043 Some examples to illustrate the logic:
9045 ```
9046 % echo "'hi'" | pandoc -t latex
9047 `hi'
9048 % echo "'hi'" | pandoc -t latex --no-tex-ligatures
9049 'hi'
9050 % echo "'hi'" | pandoc -t latex --no-tex-ligatures --smart
9051 ‘hi’
9052 % echo "'hi'" | pandoc -f latex --no-tex-ligatures
9053 <p>'hi'</p>
9054 % echo "'hi'" | pandoc -f latex
9055 <p>’hi’</p>
9056 ```
9058 * Removed deprecated options `--offline` and `--html5`.
9060 * Fixed language code for Czech (`cs` not `cz`) (#2597).
9062 * Implemented `east_asian_line_breaks` extension (#2586).
9063 In `Text.Pandoc.Options`, added `Ext_east_asian_line_breaks` constructor
9064 to `Extension` (API change). This extension is like
9065 `ignore_line_breaks`, but smarter -- it only ignores line breaks
9066 between two East Asian wide characters. This makes it better suited
9067 for writing with a mix of East Asian and non-East Asian scripts.
9069 * Added support for PDF creation via `wkhtmltopdf`.
9070 To use this: `pandoc -t html5 -o result.pdf` (and add `--mathjax`
9071 if you have math.) Margins can be set using the variables
9072 `margin-top`, `margin-bottom`, `margin-left`, `margin-right`.
9073 Other styling can be done through CSS.
9075 * Fixed cite key parsing regression (jgm/pandoc-citeproc#201).
9076 We were capturing final colons as in `[@foo: bar]`; the citation id
9077 was being parsed as `@foo:`.
9079 * ICML writer:
9081 + Fixed image syntax for local files (#2589).
9082 + Changed type of `writeICML` (Mauro Bieg).
9083 API change: It is now `WriterOptions -> Pandoc -> IO String`.
9084 Also handle new image attributes.
9085 + Intersperse line breaks instead of appending them to
9086 every `ParagraphStyleRange` (Mauro Bieg, #2501).
9087 + Add `Cite` style to citations (Mauro Bieg).
9088 + Added figure handling (#2590, Mauro Bieg).
9089 + Better handling of math. Instead of just printing the raw tex,
9090 we now try to fake it with unicode characters.
9092 * HTML writer: Include `example` class for example lists (#2524).
9094 * ODT/OpenDocument writer: improved image attributes (Mauro Bieg).
9096 + Support for percentage widths/heights
9097 + Use `Attr` instead of title to get dimensions from ODT walker
9098 to `writeOpenDocument`.
9100 * AsciiDoc writer:
9102 + Support anchors in spans and divs with id elements
9103 (jgm/pandoc-citeproc#143).
9104 + Fixed code blocks (#1861).
9106 * Haddock writer: omit formatting inside links, which isn't supported
9107 by Haddock (#2515).
9109 * MediaWiki writer: Fixed spacing issues in table cells.
9111 + Start cell on new line unless it's a single Para or Plain
9112 (#2606).
9113 + For single Para or Plain, insert a space after the `|` to
9114 avoid problems when the text begins with a character like
9115 `-` (#2604).
9117 * Beamer writer: mark frame as fragile when it contains verbatim (#1613).
9119 * LaTeX writer:
9121 + Add support for GAP highlighting using listings (Raniere Silva).
9122 + Consider `header-includes` content as well as templates
9123 when determining whether to use csquotes (Andreas Lööw).
9124 + Create defaults for geometry using `margin-left` etc.
9125 If `geometry` has no value, but `margin-left`, `margin-right`,
9126 `margin-top`, and/or `-margin-bottom` are given, a default value
9127 for `geometry` is created from these. Note that these variables
9128 already affect PDF production via HTML5 with `wkhtmltopdf`.
9130 * ConTeXt writer: set default layout based on `margin-left`, etc.
9131 This sets up `\setuplayout` based on the variables `margin-left`,
9132 `margin-right`, `margin-bottom`, and `margin-top`, if no layout
9133 is given.
9135 * Docx writer: better handling of PDF images. Previously we tried
9136 to get the image size from the image even if an explicit size was
9137 specified. Since we still can't get image size for PDFs, this made
9138 it impossible to use PDF images in docx. Now we don't try to get
9139 the image size when a size is already explicitly specified.
9141 * Markdown writer: use raw HTML for link/image attributes when
9142 the `link_attributes` extension is unset and `raw_html` is set (#2554).
9144 * MediaWiki reader: interpret markup inside `<tt>`, `<code>` (#2607).
9146 * LaTeX reader:
9148 + Improved smart quote parsing (#2555). This fixes redering of
9149 unmatched quotes.
9150 + Use curly quotes for unmatched ` (#2555).
9151 + Allow blank space between braced arguments of commands (#2592).
9153 * Markdown reader:
9155 + Improved pipe table relative widths. Previously pipe table
9156 columns got relative widths (based on the header underscore lines)
9157 when the source of one of the rows was greater in width than the
9158 column width. This gave bad results in some cases where much of
9159 the width of the row was due to nonprinting material (e.g. link
9160 URLs). Now pandoc only looks at printable width (the width of a
9161 plain string version of the source), which should give better results.
9162 Thanks to John Muccigrosso for bringing up the issue.
9163 + Fixed parsing bug with macros. Previously macro definitions in
9164 indented code blocks were being parsed as macro definitions, not code.
9166 * Textile reader: skip over attribute in image source (#2515).
9167 We don't have a place yet for styles or sizes on images, but
9168 we can skip the attributes rather than incorrectly taking them
9169 to be part of the filename.
9171 * Docx reader: Handle dummy list items (Jesse Rosenthal).
9172 These come up when people create a list item and then delete the
9173 bullet. It doesn't refer to any real list item, and we used to ignore
9174 it.
9176 * CommonMark reader/writer rewritten to use latest `cmark`.
9178 * Fixed Emoji character definitions (#2523). There were many bugs in the
9179 definitions.
9181 * `Text.Pandoc.CSS`:
9183 + Added `pickStylesToKVs` function to extract multiple properties at
9184 once (API change, Mauro Bieg).
9185 + Parse CSS that doesn't contain the optional semicolon (Mauro Bieg).
9187 * `trypandoc`: sort drop-down lists.
9189 * Beamer template:
9191 + Made `\euro` conditional on presence of character.
9192 for xelatex and lualatex, as it is for pdflatex (Andrew Dunning).
9193 + Moved `header-includes` before setting of title (Thomas Hodgson),
9194 to match the LaTeX template (jgm/pandoc-templates#168).
9195 + Added `section-titles` variable (defaults to true)
9196 to enable/suppress section title pages in beamer
9197 slide shows (Thomas Hodgson).
9198 + Moved beamer themes after fonts, so that themes can
9199 change fonts. (Previously the fonts set were being
9200 clobbered by lmodern.sty.) (Thomas Hodgson).
9202 * Beamer/LaTeX template changes (Thomas Hodgson):
9203 + Added `thanks` variable
9204 + Use `parskip.sty` when `indent` isn't set (fall back to using
9205 `setlength` as before if `parskip.sty` isn't available).
9206 + Use `biblio-style` with biblatex.
9207 + Added `biblatexoptions` variable.
9209 * LaTeX template changes:
9211 + Added `paper` after `$papersize$` variable in latex template.
9212 Thus you can say `papersize: a4` and the latex will contain
9213 `a4paper`. This change may break some existing workflows; if
9214 you currently specify `a4paper`, you'll get `a4paperpaper` which
9215 is meaningless. However, the change seems worth it, as it will
9216 make the `papersize` variable work uniformly across ConTeXt, LaTeX,
9217 and html->pdf via wkhtmltopdf.
9218 + Only pass options to color package if `colorlinks` is set
9219 (Andrew Dunning).
9220 + Make definition of `\euro` conditional in xelatex/lualatex,
9221 as it is already for pdflatex (Andrew Dunning).
9222 + Removed setting of `subject` in PDF metadata.
9223 This used to be set to the subtitle, but really the subtitle
9224 need not give the subject. Also, `subtitle` can contain formatting,
9225 so we'd need, at least, a plain text version for this.
9226 + Moved `header-includes` before setting of `\title`, `\author`,
9227 etc. This allows these macros to be redefined.
9228 + Use `\subtitle` command for `subtitle`, instead of tacking it
9229 on to the title as before. We give a no-op fallback definition if it
9230 is not defined. This change should produce much better results
9231 in classes that support `\subtitle`. With the default article
9232 class, which does not define `\subtitle`, subtitles will no
9233 longer be printed unless the user defines `\subtitle` and
9234 redefines `\maketitle`.
9235 + Moved redefinitions of `\paragraph` and `\subparagraph` to
9236 before header-includes.
9238 * Context template:
9240 + Use `simplefonts` for font loading (Paolo Rodríguez). This is
9241 needed for things to work on ConTeXt stable from TeXLive 2015.
9242 + Revert use of `\setuphead` in title block (Andrew Dunning,
9243 Rik Kabel).
9245 * Update LaTeX/ConTeXt link colour usage (Andrew Dunning).
9247 * Fixed man template so disabling hyphenation actually works.
9248 The command needs to come after .TH.
9250 * Added 'navigation' variable to beamer template (#2543).
9251 Valid values are `empty` (the default), `horizontal`, `vertical`,
9252 and `frame`. Note that this changes the default behavior from
9253 `horizontal` to `empty`. Closes #2543.
9255 * Added `toc` to HTML slide format templates (Andrew Dunning),
9256 so that `--toc` creates a contents slide.
9258 * Added `stack.full.yaml` to build `pandoc-citeproc` as well.
9260 * Allow pipe tables with no body rows (#2556).
9261 Previously this raised a runtime error.
9263 * Shared: Improved `fetchItem` so that `C:/Blah/Blah.jpg` isn't treated
9264 as URL. The Haskell URI parsing routines will accept "C:" as a
9265 scheme, so we rule that out manually. This helps with
9266 `--self-contained` and absolute Windows paths.
9268 * Define a `meta-json` variable for all writers (#2019). This contains
9269 a JSON version of all the metadata, in the format selected for the
9270 writer. So, for example, to get just the YAML metadata, you can run
9271 pandoc with the following custom template: `$meta-json$`. The intent
9272 is to make it easier for static site generators and other tools to get
9273 at the metadata.
9275 * Document limitations of --self-contained (#2553).
9277 * Improved Citations section of README (#2551). Added information
9278 about `link-citations` and a link to the pandoc-citeproc man page.
9280 * `ImageSize`: use `safeRead` instead of `readMaybe`, which isn't
9281 in base < 4.6.
9283 * Allow .adoc file extension for AsciiDoc (Andrew Dunning).
9285 * Improved implicit pandoc-citeproc inclusion.
9286 The filter pandoc-citeproc is automatically used when
9287 `--bibliography` is specified on the command line, unless
9288 `--natbib` or `--biblatex` is used. However, previously this
9289 only worked if `--bibliography` was spelled out in full, and not
9290 if `--biblio` was used.
9292 * reveal.js: Interpret pauses correctly for all headers (#2530).
9293 Previously, when using headers below the slide level, pauses are left
9294 uninterpreted into pauses. In my opinion, unexpected behavior but
9295 intentional looking at the code.
9297 * Remove redundant `center` variable for reveal.js (Andrew Dunning).
9299 * Parsing: Add `extractIdClass`, modified type of `KeyTable` (Mauro
9300 Bieg, API change).
9302 * ImageSize: Added functions for converting between image dimensions
9303 (Mauro Bieg).
9305 * Use lts-3.18 in stack.yaml. This avoids Windows build
9306 issues with the HTTP library.
9308 * Bump version bounds for dependencies.
9310## pandoc 1.15.2.1 (2015-11-16)
9312 * Added two missing test files, and `stack.yaml`, to
9313 `extra-source-files` so they're included in the source tarball.
9315 * reveal.js template: Fixed parallaxBackground options.
9316 `parallaxBackgroundHorizontal` and `parallaxBackgroundVertical`
9317 need integer values, not strings. (Vaughn Iverson)
9319## pandoc 1.15.2 (2015-11-15)
9321 * `pandoc my.md -t context -o my.pdf` will now create a PDF using
9322 ConTeXt rather than LaTeX (#2463).
9324 * Fixed omitted `url(...)` in CSS data-uri with `--self-contained` (#2489).
9326 * Added `emoji` Markdown extension, enabled by default in `markdown_github`
9327 (#2523). Added `Ext_emoji` to `Extension` in `Text.Pandoc.Options`
9328 (API change).
9330 * `Text.Pandoc.Readers.HTML.parseTags`: Fixed over-eager raw HTML inline
9331 parsing (#2469). Tightened up the inline HTML parser so it disallows
9332 TagWarnings.
9334 * Derive `Generic` instances for the types in `Text.Pandoc.Options`.
9336 * Org reader:
9338 + Fix paragraph/list interaction (Albert Krewinkel, #2464).
9339 Paragraphs can be followed by lists, even if there is no blank line
9340 between the two blocks. However, this should only be true if the
9341 paragraph is not within a list, were the preceding block should be
9342 parsed as a plain instead of paragraph (to allow for compact lists).
9343 Thanks to @rgaiacs for bringing this up.
9344 + Allow toggling header args (Albert Krewinkel, #2269).
9345 Org-mode allows to skip the argument of a code block header argument if
9346 it's toggling a value. Argument-less headers are now recognized,
9347 avoiding weird parsing errors.
9348 + Fix markup parsing in headers (Albert Krewinkel, #2504).
9349 Markup as the very first item in a header wasn't recognized. This was
9350 caused by an incorrect parser state: positions at which inline markup
9351 can start need to be marked explicitly by changing the parser state.
9352 This wasn't done for headers. The proper function to update the state
9353 is now called at the beginning of the header parser, fixing this issue.
9354 + Fix emphasis rules for smart parsing (Albert Krewinkel, #2513).
9355 Smart quotes, ellipses, and dashes should behave like normal quotes,
9356 single dashes, and dots with respect to text markup parsing.
9357 + Require whitespace around definition list markers (#2518).
9358 This rule was not checked before, resulting in bugs with footnotes
9359 and some link types.
9361 * Markdown reader:
9363 + Pipe tables with long lines now get relative cell widths (#2471).
9364 If a pipe table contains a line longer than the column width (as set by
9365 `--columns` or 80 by default), relative widths are computed based on the
9366 widths of the separator lines relative to the column width. This should
9367 solve persistent problems with long pipe tables in LaTeX/PDF output, and
9368 give more flexibility for determining relative column widths in other
9369 formats, too. For narrower pipe tables, column widths of 0 are used,
9370 telling pandoc not to specify widths explicitly in output formats that
9371 permit this.
9372 + Improved parser for `mmd_title_block`. We now allow blank metadata
9373 fields. These were explicitly disallowed before.
9374 + Citation keys can now contain `://`, so URLs and DOIs can be used
9375 as citation keys (jgm/pandoc-citeproc#166).
9377 * Beamer template: fix incompatibility of section slides with natbib.
9378 Natbib (and presumably biblatex) bibliography commands create
9379 their own section. Since these are in frame environments,
9380 we have an incompatibility with the `\AtBeginSection` macro
9381 which creates a special frame when a new section occurs.
9382 (We can't have a frame inside another frame.) This change disables
9383 `\AtBeginSection` inside bibliography slides. Thinks to Yihui Xie for
9384 bringing the problem to my attention. This supersedes #145. See
9385 discussion there.
9387 * Textile reader: don't do smart punctuation unless explicitly asked
9388 (#2480). Note that although smart punctuation is part of the textile
9389 spec, it's not always wanted when converting from textile
9390 to, say, Markdown. So it seems better to make this an option.
9392 * LaTeX reader: Handle `comment` environment (Arata Mizuki).
9393 The `comment` environment is handled in a similar way to the
9394 `verbatim` environment, except that its content is discarded.
9396 * Docx reader: Follow relationships correctly in foot/endnotes (#2258,
9397 Jesse Rosenthal). This fixes a problem with links in notes.
9399 * LaTeX and ConTeXt writers: support `lang` attribute on divs and spans
9400 (mb21). For LaTeX, also collect `lang` and `dir` attributes on spans and
9401 divs to set the `lang`, `otherlangs` and `dir` variables if they aren’t set
9402 already. See #895.
9404 * LaTeX writer:
9406 + Use proper command for `\textarabic` (mb21).
9407 + Added `de-CH-1901`, fixed `el-polyton` in `toPloyglossia` (Nick Bart).
9408 + Use `\hypertarget` and `\hyperlink` for links. This works correctly
9409 to link to Div or Span elements. We now don't bother defining `\label`
9410 for Div or Span elements. Closes jgm/pandoc-citeproc#174.
9411 + Avoid footnotes in list of figures (#1506).
9412 + Properly handle footnotes in captions (#1506).
9413 + Add `\protect` to `\hyperlink` (#2490). Thanks to Hadrien Mary.
9414 + Set `colorlinks` if `linkcolor`, `urlcolor`, `citecolor`, or
9415 `toccolor` is set (#2508).
9417 * Textile writer: support start number in ordered lists (#2465).
9419 * OpenDocument writer: Allow customization of opendocument
9420 automatic styles. Automatic styles can now be inserted in the
9421 template, which now provides the enclosing `<office:automatic-styles>`
9422 tags (#2520).
9424 * Docx writer: insert space between footnote reference and note (#2527).
9425 This matches Word's default behavior.
9427 * EPUB writer: don't download linked media when `data-external` attribute
9428 set (#2473). By default pandoc downloads all linked media and includes it
9429 in the EPUB container. This can be disabled by setting `data-external` on
9430 the tags linking to media that should not be downloaded. Example:
9432 <audio controls="1">
9433 <source src="http://www.sixbarsjail.it/tmp/bach_toccata.mp3"
9434 type="audio/mpeg"></source>
9435 </audio>
9437 * HTML writer: use width on whole table if col widths sum to < 100%.
9438 Otherwise some browsers display the table with the columns
9439 separated far apart.
9441 * AsciiDoc template: Fix `author` and `date`; add `keywords`,
9442 `abstract` (Andrew Dunning).
9444 * HTML-based templates (Andrew Dunning):
9446 + Use en dash instead of hyphen between title prefix and title.
9447 + Add `keywords` to metadata.
9448 + Add `lang`, `dir`, `quotes` where missing.
9449 + Always make author and date display conditional.
9450 + Updated dzslides template from source.
9452 * Man template: make "generated by" comment conditional.
9454 * LaTeX, Beamer templates:
9456 + Add `babel-otherlangs` for language divs/spans; `babel-newcommands`,
9457 filled by commands that make babel understand the polyglossia-style
9458 language directives (mb21, #137).
9459 + Improved formatting of conditionals; `$for$` is always provided to allow
9460 multiple options (Andrew Dunning, #141).
9461 + Use `Ligatures=TeX` rather than `Mapping=tex-text` with `fontspec`
9462 to improve support for LuaTeX (Andrew Dunning, #135).
9463 + Revise `hyperref` usage (Andrew Dunning, #139, #141):
9464 - use same options for all LaTeX engines;
9465 - add `subtitle` and `keywords` to PDF metadata;
9466 - do not override `hyperref` link coloring without user input, effectively making
9467 the `hidelinks` option the default (removed as a separate variable);
9468 - link colors can be enabled (using a slightly darker version of the old
9469 defaults) using a new `colorlinks` variable, automatically used by
9470 the LaTeX writer when custom colors are specified;
9471 - `pdfborder={0 0 0}` is automatically set by `hyperref` with
9472 `colorlinks`, and is only applied if `colorlinks` is disabled.
9474 * ConTeXt template (Andrew Dunning):
9476 + New variables for controlling styles: `linkstyle`, `linkcolor`,
9477 `linkcontrastcolor`, `layout`, `pagenumbering`, `whitespace`, `indenting`,
9478 `interlinespace`, `headertext`, `footertext`, `mainfont`, `sansfont`,
9479 `monofont`, `mathfont`, `fontsize`.
9480 + Default template no longer supports MkII.
9481 + Improve writing of title block (suppressing numbering of first page).
9482 + Add `title` `subtitle`, `author`, `date`, `keywords` to PDF metadata.
9483 + Support `subtitle`, `abstract`.
9484 + Support list of figures (`lof`), list of tables (`lot`).
9485 + Disable link styling by default.
9486 + Define styles for all section types.
9487 + Enable microtype.
9488 + Improved formatting of conditionals.
9490 * Beamer template: added code to prevent slide breaks inside paragraphs
9491 (#2422, thanks to Nick Bart). This will matter, in practice, only when
9492 `allowframebreaks` is used. It is especially helpful for bibliography
9493 slides.
9495 * OpenDocument template: Add `<office:automatic-styles>` tag around
9496 automatic styles. The writer now longer provides this (see #2520).
9498 * Restored Text.Pandoc.Compat.Monoid.
9500 * Do not export (<>) from custom Prelude. The Prelude now matches
9501 base 4.8 Prelude's API.
9503 * Don't use custom prelude with ghc 7.10. Use the custom prelude
9504 only for earlier versions. This change makes `stack ghci` and
9505 `cabal repl` work (#2503), at least with ghc 7.10.
9507 * Changed § to % in operators from Odt.Arrows.Utils (#2457).
9508 This prevents problems building haddocks with "C" locale.
9510 * Change default for old-locale flag to False.
9512 * Use stack in deb, osx, and Windows package generators.
9514 * Added Vagrantfile for building deb in vm.
9515 This should help in automating binary package creation. 'make package'
9516 will make the package. 'make package COMMIT=blah' will make the package
9517 from commit blah.
9519 * README:
9521 + Consistent capitalization for pandoc and Markdown.
9522 + Fixed `auto_identifiers` examples (Benoit Schweblin).
9523 + Improved documentation of template variables (Andrew Dunning).
9525## pandoc 1.15.1 (2015-10-15)
9527 * `pandocVersion` is now defined in `Text.Pandoc.Shared`
9528 and reexported from `Text.Pandoc` (Alex Vong). This allows
9529 writers to access it. (Alex Vong) (API change)
9531 * For `markdown_mmd`, add: `implicit_figures`, `superscripts`,
9532 `subscripts` (#2401).
9534 * Added `odt` as input format (MarLinn). Added new module
9535 `Text.Pandoc.Reader.ODT` (API change). Fully implemented features:
9536 Paragraphs, Headers, Basic styling, Unordered lists, Ordered lists,
9537 External Links, Internal Links, Footnotes, Endnotes, Blockquotes.
9538 Partly implemented features: Citations, Tables.
9540 * Markdown Reader:
9542 + Add basic tests for each header style (Ophir Lifshitz).
9543 + Add implicit header ref tests for headers with spaces (Ophir Lifshitz).
9544 + Skip spaces in headers (Ophir Lifshitz).
9545 + Handle 'id' and 'class' in parsing key/value attributes (#2396).
9546 `# Header {id="myid" class="foo bar"}`
9547 is now equivalent to `# Header {#myid .foo .bar}`.
9548 + Use '=' instead of '#' for atx-style headers in markdown+lhs.
9549 (Kristof Bastiaensen)
9550 + Pipe tables: allow indented columns. Previously the left-hand column
9551 could not start with 4 or more spaces indent. This was inconvenient
9552 for right-aligned left columns. Note that the first (header column)
9553 must still have 3 or fewer spaces indentation, or the table will be
9554 treated as an indented code block.
9555 + Fix regression: allow HTML comments containing `--`.
9556 Technically this isn't allowed in an HTML comment, but
9557 we've always allowed it, and so do most other implementations.
9558 It is handy if e.g. you want to put command line arguments
9559 in HTML comments.
9561 * LaTeX reader:
9563 + Don't eat excess whitespace after macros with only optional
9564 arguments (#2446).
9565 + Support longtable (#2411).
9566 + Implement `\Cite` (#2335).
9567 + Support abstract environment. The abstract populates an
9568 `abstract` metadata field.
9569 + Properly handle booktabs lines. Lines aren't part of the
9570 pandoc table model, so we just ignore them (#2307).
9572 * HTML reader:
9574 + Handle type attribute on ol, e.g. `<ol type="i">` (#2313).
9575 + Updated for new automatic header attributes.
9576 + Add auto identifiers if not present on headers. This makes
9577 TOC linking work properly.
9578 + Detect `font-variant` with `pickStyleAttrProps` (Ophir Lifshitz).
9579 + Test `<ol>` type, class, and inline list-style(-type) CSS
9580 (Ophir Lifshitz).
9581 + Better handling of "section" elements (#2438). Previously
9582 `<section>` tags were just parsed as raw HTML blocks. With
9583 this change, section elements are parsed as Div elements with
9584 the class "section".
9586 * MediaWiki reader: handle unquoted table attributes (#2355).
9588 * DocBook reader:
9590 + Added proper support for DocBook `xref` elements (Frerich Raabe).
9591 Added `dbContent` field to reader state, so we can lookup
9592 cross refs.
9593 + Handle `informalexample` (#2319).
9595 * Docx Reader:
9597 + Create special punctuation test (Ophir Lifshitz).
9598 + Parse soft, no-break hyphen elements (Ophir Lifshitz).
9599 + Updated headers test (Ophir Lifshitz). Replaced `styles.xml`
9600 in `headers.docx` with pandoc's current `styles.xml`, which
9601 contains styles for Heading 1 through 6. Added Heading 4
9602 through 7 to the test document. Note that Heading 7 is not
9603 parsed as a Heading because there is no Heading 7 style.
9605 * RST reader: better handling of indirect roles.
9606 Previously the parser failed on this kind of case
9608 .. role:: indirect(code)
9610 .. role:: py(indirect)
9611 :language: python
9613 :py:`hi`
9615 Now it correctly recognizes `:py:` as a code role.
9617 * Org reader:
9619 + Add auto identifiers if not present on headers
9620 (#2354, Juliusz Gonera).
9621 + Allow verse blocks to contain empty lines (#2402,
9622 Albert Krewinkel).
9624 * EPUB reader: stop mangling external URLs (#2284).
9626 * RST writer:
9628 + Don't insert `\ ` when complex expression in matched pairs.
9629 E.g. `` [:sup:`3`] `` is okay; you don't need `` [:sup:`3`\ ] ``.
9630 + Ensure that `\ ` is inserted when needed before Cite and Span
9631 elements that begin with a "complex" element (jgm/pandoc-citeproc#157).
9632 + Normalize headers only in "standalone" mode (#2394).
9634 * Haddock writer: escape `*` and `^` (G. Bataille).
9636 * Markdown writer:
9638 + In TOC, add links to headers (#829).
9639 + Use unicode super/subscripts for digits in plain output
9640 (when the `superscripts` and `subscripts` extensions are
9641 not enabled).
9643 * Docx writer:
9645 + Moved invalid character stripping to `formattedString`.
9646 This avoids an inefficient generic traversal (#2356).
9647 + Use user data directory for `reference.docx` archive.
9648 This allows the test suite to work without installing pandoc first.
9649 It also brings the docx writer in line with the odt writer.
9650 + Tests: docx writer tests now use `../data` for data directory.
9651 This allows tests to be run without installing first.
9652 + Tests: Use real jpg (not empty) for docx tests to avoid warning.
9654 * LaTeX writer:
9656 + Fixed detection of 'chapters' from template.
9657 If a documentclass isn't specified in metadata, but the
9658 template has a hardwired bookish documentclass, act as if
9659 `--chapters` was used. This was the default in earlier
9660 versions, but it has been broken for a little while.
9661 + Correctly recognize book documentclass in metadata (#2395).
9662 + Set language-related variables automatically, depending
9663 on the value of the `lang` field, which is now always
9664 assumed to be in BCP47 format (mb21, #1614, #2437).
9665 + Add `\protect` to `\hyperdef` in inline context. This way we
9666 don't get an error when this is used as a moveable argument (#2136).
9667 + Support all frame attributes in Beamer.
9668 + Percent-encode more special characters in URLs (#1640, #2377).
9669 The special characters are '<','>','|','"','{','}','[',']','^', '`'.
9671 * HTML writer:
9673 + Update KaTeX JS and CSS versions (Emily Eisenberg).
9674 + For dzslides, add `role="note"` for speaker notes (#1693).
9675 + Percent-encode more special characters in URLs (#1640, #2377).
9676 The special characters are '<','>','|','"','{','}','[',']','^', '`'.
9677 + Render Div with class `section` as `<section>` in HTML5.
9679 * EPUB writer:
9681 + In TOC, replace literal `<br/>` with space (#2105).
9682 + With `--webtex`, include image file rather than `data:` URI (#2363).
9684 * Native writer: format Div properly, with blocks separated.
9686 * Support bidirectional text output with XeLaTeX, ConTeXt and HTML
9687 (#2191, mb21).
9689 * Reference Docx:
9691 + Add missing Header 6 style (steel blue) (Ophir Lifshitz).
9692 + Correct `outlineLvl` for Header styles (Ophir Lifshitz).
9694 * Templates
9696 + Beamer: Add `innertheme`, `outertheme` variables
9697 (Guilhem Bonnefille, #121). Add space after colon in figure caption.
9698 Integrate recent font and language updates from LaTeX template;
9699 allow use of `mainfont` variable for changing the slide text
9700 in XeTeX and LuaTeX (Andrew Dunning, #131).
9701 + LaTeX: Add `mainfontoptions`, `sansfontoptions`,
9702 `monofontoptions`, `mathfontoptions`, `fontfamilyoptions`
9703 (Andrew Dunning, #122). Support handling of bidirectional
9704 text (mb21, #120). Improve reliability of superscripts/subscripts
9705 under XeTeX and prevent letters and numbers from appearing on a
9706 different baseline by removing use of the `realscripts` package
9707 (via `xltxtra`). To restore use of OpenType characters for these
9708 features under XeTeX or LuaTeX, add `\usepackage{realscripts}` to
9709 `header-includes` (Andrew Dunning, #130). Remove redundant
9710 reference to `xunicode` (Andrew Dunning, #130). Add `fontenc`,
9711 `indent`, `subparagraph` variables (Andrew Dunning).
9712 Allow use of `hidelinks` variable for `hyperref` package (Hugo Roy,
9713 #113). Prevent package clash with `tufte-latex` and other classes that
9714 include `hyperref` or `color` (Xavier Olive, #115).
9715 + ConTeXt: Support handling of bidirectional text (mb21, #120).
9716 + LaTeX and ConTeXt: Use more specific language variables.
9717 Instead of directly using `lang`, we now use `babel-lang` and
9718 `polyglossia-lang` and `context-lang`. These variables are set by
9719 the writers to the necessary values, based on the `lang` variable
9720 (which now always takes a value in BCP47 format). (mb21, #114, #129).
9721 + HTML: Support handling of bidirectional text (mb21, #120).
9722 Move HTML5 shiv after CSS and fix URL (Andrew Dunning).
9723 Add dir attribute in html5 (Andrew Dunning).
9724 + reveal.js: Add `controls`, `progress` variables (Grégoire Pineau, #127).
9725 Add `width`, `height` variables (Anrew Dunning). Update template
9726 from 3.1 source (Andrew Dunning). All configuration options are now
9727 available as variables, but are only be included if set (reveal.js
9728 uses defaults otherwise).
9729 + man: Added comment stating that the page is autogenerated by pandoc,
9730 giving version. Added `adjusting` and `hyphenate` variables
9731 (Alex Vong, #123).
9733 * epub.css: added selectors for nested emphasis (Pablo Rodriguez).
9735 * MediaBag: ensure that `/` is always used as path separator.
9737 * `sample.lua`: define `CaptionedImage`, add newline at end (#2393).
9739 * Added `--bash-completion` option. This generates a bash completion
9740 script. To use: `eval "$(pandoc --bash-completion)"`.
9742 * Text.Pandoc.Error: Define Typeable and Exception instances
9743 for PandocError (#2386).
9745 * Text.Pandoc.Parsing: `toKey`: strip off outer brackets.
9746 This makes keys with extra space at the beginning and end
9747 work: e.g.
9749 [foo]: bar
9751 [ foo ]
9753 will now be a link to bar (it wasn't before).
9755 * Text.Pandoc: disable `auto_identifiers` for epub.
9756 The epub writer inserts its own auto identifiers;
9757 this is more complex due to splitting into "chapter" files.
9759 * Renamed Text.Pandoc.Compat.Locale -> Text.Pandoc.Compat.Time.
9760 It now reexports Data.Time.
9762 * Use custom Prelude to avoid compiler warnings.
9764 + The (non-exported) prelude is in prelude/Prelude.hs.
9765 + It exports Monoid and Applicative, like base 4.8 prelude,
9766 but works with older base versions.
9767 + It exports (<>) for mappend.
9768 + It hides 'catch' on older base versions.
9770 * Added a `stack.ymal` and stack install instructions to INSTALL.
9772 * Clarified what is "out of scope" in README and CONTRIBUTING.md.
9774 * Added note to CONTRIBUTING.md about ghc versions and travis.
9776 * Clarify docs on block quotes. The space after `>` is optional (#2346).
9778 * Removed obsolete reference to default.csl (#2372).
9780 * List all styles in manual for `--reference-docx` (Chris Black)
9782 * Don't capitalize header links in man page.
9784 * Added section on repl to CONTRIBUTING.md.
9786 * README: Added space after backslash in image example (#2329).
9788 * Document details of citation locator terms (Nick Bart).
9790 * Fixed some internal links in README (#2309).
9792 * Improve CSL documentation, variables documentations,
9793 links, and cross-references in README. (Andrew Dunning)
9795 * Fix build failure with `--flags=-https` (Sergei Trofimovich).
9797 * Use `newManager` instead of `withManager` in recent `http-client`.
9798 This avoids a deprecation warning.
9800 * Allow building with latest versions of http-types,
9801 HUnit, criterion, syb, aeson.
9803 * Updated benchmark program for new criterion API.
9805 * Setup.hs: rewrite so as not to use process, directory, filepath.
9806 Using anything outside base is dangerous, since older
9807 versions of ghc may link against two different versions.
9809 * Added appveyor (Windows continuous integration) builds.
9811 * New `.travis.yml`. Autgenerated using `make_travis_yml.hs`.
9812 This script has been modified in a few ways, e.g. to add `GHCOPTS`.
9813 `make .travis.yml` regenerates it based on the tested-with
9814 field of the cabal file.
9816## pandoc 1.15.0.6 (2015-07-15)
9818 * `--self-contained`: Fixed overaggressive CSS minimization
9819 (#2301, 2286). Previously `--self-contained` wiped out all
9820 spaces in CSS, including semantically significant spaces.
9821 This was a regression from 1.14.x.
9823 * Markdown reader: don't allow bare URI links or autolinks in link
9824 label (#2300). Added test cases.
9826 * `Text.Pandoc.Parsing`, `uri`: Improved bare autolink detection (#2299).
9827 Previously we disallowed `-` at the end of an autolink,
9828 and disallowed the combination `=-`. This commit liberalizes the
9829 rules for allowing punctuation in a bare URI, and adds test cases.
9830 One potential drawback is that you can no longer put a bare
9831 URI in em dashes like this:
9832 `this uri---http://example.com---is an example.`
9833 But in this respect we now match github's treatment of bare URIs.
9835 * HTML writer: support speaker notes in dzslides.
9836 With this change `<div class="notes">` and also `<div class="notes"
9837 role="note">` will be output if `-t dzslides` is used. So we can
9838 have speaker notes in dzslides too. Thanks to maybegeek.
9840 * Updated dzslides template.
9842 * Improved documentation of options to print system default files (#2298).
9843 `--print-default-data-file` and `--print-default-template`.
9845 * DokuWiki writer: use `$..$` for Math instead of `<math>..</math>`
9846 (Tiziano Müller). MathJax seems currently to be the only maintained
9847 math rendering extension for DokuWiki.
9849 * `Text.Pandoc.Shared`: Changed `hierarchicalize` so it treats references
9850 div as top-level header (#2294). This fixes a bug with `--section-divs`,
9851 where the final references section added by pandoc-citeproc, enclosed in
9852 its own div, got nested in the div for the section previous to it.
9854 * Allow vector 0.11.
9856 * Require cmark > 0.4.
9858## pandoc 1.15.0.5 (2015-07-10)
9860 * HTML writer: Fixed email javascript obfuscation with `mailto:`
9861 URLs (#2280). This fixes a potential security issue. Because
9862 single quotes weren't being escaped in the link portion, a
9863 specially crafted email address could allow javascript code injection.
9865 * RST reader: allow inline formatting in definition list field
9866 names (Lars-Dominik Braun).
9868 * PDF: Make sure `--latex-engine-opt` goes before the filename
9869 on the command line. LaTeX needs the argument to come after
9870 the options (#1779).
9872 * CommonMark writer: fixed tags used for super/subscript.
9874 * ConTeXt template: activate hanging indent for definition lists
9875 (mb21).
9877 * Make cabal require `hsb2hs` >= 0.3.1 if `embed_data_files` specified.
9878 This is done by adding `hookedPrograms` in `Setup.hs`, which allows us
9879 to include `hsb2hs` in Build-Tools in cabal.
9881 * Improved Windows installer (thanks to nkalvi).
9883 + When per-machine installation is chosen, the system path
9884 is updated instead of the user's.
9885 + An appropriate default is used for per-machine installation
9886 directory.
9887 + Admin privileges are no longer required for a per-user install
9889 * Travis: unpack sdist for build to catch packaging bugs.
9891 * Improved documentation on where user templates go (#2272).
9893## pandoc 1.15.0.4 (2015-07-03)
9895 * Added pandoc.1 man page to the repository. It is no longer
9896 built as part of the cabal build process. (This proved too
9897 fragile.) pandoc.1 can be regenerated (`make man/pandoc.1`)
9898 when `README` is changed.
9900 * Copying of the man page now respects `--destdir` (#2262).
9902 * Improved error messages for filters. User is now informed if
9903 the filter requires an interpreter that isn't found in the path,
9904 or if the filter returns an error status.
9906## pandoc 1.15.0.3 (2015-07-02)
9908 * Ensure target directory is created when installing man page.
9910## pandoc 1.15.0.2 (2015-07-02)
9912 * Added files needed for building man page to Extra-Source-Files.
9914## pandoc 1.15.0.1 (2015-07-01)
9916 * Man page is now built and installed as part of the cabal build
9917 process. Removed Makefile target for man page.
9919## pandoc 1.15 (2015-07-01)
9921 * Man page changes:
9923 + Removed `--man1`, `--man5` options (breaking change).
9924 + Removed `Text.Pandoc.ManPages` module (breaking API change).
9925 + Makefile target for `man/man1/pandoc.1`. This uses pandoc to
9926 create the man page from README using a custom template and filters.
9927 + Added `man/` directory with template and filters needed to build
9928 man page.
9929 + We no longer have two man pages: `pandoc.1` and `pandoc_markdown.5`.
9930 Now there is just pandoc.1, which has all the content from README.
9931 This change was needed because of the extensive cross-references
9932 between parts of the README.
9933 + Removed old `data/pandoc.1.template` and
9934 `data/pandoc_markdown.5.template`.
9936 * OpenDocument writer: Do not add a carriage return after a hard
9937 line break (Michael Chladek).
9939 * ConTeXt writer:
9941 + use `\goto` for internal links.
9942 + Added a `%` at end for `\reference` to avoid spurious space.
9944 * Ignore sandbox on 'make quick'
9946## pandoc 1.14.1 (2015-06-30)
9948 * Added `--man1` and `--man5` options to pandoc, allowing
9949 pandoc to generate its own man pages. Man pages are no longer
9950 automatically generated in the build process (the process for
9951 this was too complex and prone to failure, #2190). The
9952 `make-pandoc-man-pages` executable has been removed. The
9953 `man/` directory has been removed, and man page templates
9954 have been moved to `data/`. NOTE TO PACKAGERS: You will no
9955 longer find pandoc's man pages in `man/`, but you can
9956 generate them using `pandoc --man1 > pandoc.1` and `pandoc
9957 --man5 > pandoc_markdown.5`.
9959 * Added new unexported module: `Text.Pandoc.ManPages`.
9961 * `README` now acts like a data file (even though it isn't in
9962 `data/`). So, for example, `pandoc --print-default-data-file README`
9963 will produce the README.) This change was required for the `--man1`
9964 and `--man5` options, since the man pages are produced from the
9965 README, but it may be useful for other purposes as well.
9967 * Allow `reference.docx` and `reference.odt` to be used with
9968 `--print-default-data-file` and to shadow defaults if placed in
9969 the user data directory. Note that as of 1.14, we no longer
9970 include these files as data files; instead, we include their
9971 components. This change causes pandoc to behave as if it has
9972 these data files; they are constructed on demand when needed
9973 using `getDefaultReferenceDocx` and `getDefaultReferenceODT`.
9975 * Fixed regression in CSS parsing with `--self-contained` (#2224).
9976 Pandoc 1.14.0.x used css-text to parse the CSS, but its parser
9977 silently drops big sections of CSS. This commit replaces the
9978 use of css-text with a small but principled CSS preprocessor,
9979 which removes whitespace and comments and replaces `url()` with
9980 base 64 data when possible.
9982 * Use `https://` instead of `//` for MathJax and KaTeX CDN URLs (#1920).
9983 This will allow math to work when pages are being viewed locally.
9985 * `Text.Pandoc.Options`: Export `plainExtensions`.
9986 These are the extensions used in `plain` output.
9988 * LaTeX reader: Don't parse `_` and `^` as sub/superscript outside of
9989 math mode; treat them as regular inline text. Normally these will
9990 cause an error in LaTeX, but there are contexts (e.g. `alltt`
9991 environments) where they are allowed.
9993 * HTML reader: allow `<body>` to close `<head>`.
9995 * DocBook reader: support `mediaobject`s and `figures` (#2184, mb21).
9997 * RST reader: Fix reference names with special characters
9998 (Lars-Dominik Braun).
10000 * Textile writer: escape `+` and `-` as entities (#2225).
10002 * DokuWiki writer: Use proper `<code>` tags for code blocks (#2213).
10004 * Plain writer: don't use symbols for super/subscript (#2237).
10005 Simplified code by using `plainExtensions`.
10007 * InDesign writer: Properly escape URLs containing more than one
10008 colon character (gohai).
10010 * Docx writer: Make sure we use dist version of `reference.docx`
10011 (and not the user's version) for certain settings. Taking some
10012 settings values from a user-supplied reference.docx can lead to
10013 corruption. This fixes a regression from the last release (#2249).
10015 * `Text.Pandoc.Shared`: exports `getDefaultReferenceDocx` and
10016 `getDefaultReferenceODT` (API change). These functions have been
10017 removed from the Docx and ODT writers.
10019 * LaTeX template (Xavier Olive):
10020 + Added `CJKmainfont` and `CJKoptions` variables.
10021 + Allow dvipsnames (e.g. `MidnightBlue`) for colors (Xavier Olive).
10023 * Epub templates: use `author.role`, not `author.type`.
10025 * Bump cmark version to >= 0.3.4.
10027 * Improved Windows installer (#2205, thanks to nkalvi).
10028 Users can now select a per-user or systemwide install, and can set
10029 the installation path. At the end of installation, the install location
10030 is given. The install location is also now given in the list of
10031 installed programs in Control Panel. Cleaner WiX syntax is used for
10032 setting the path.
10034 * Added `download_stats` target to Makefile.
10036## pandoc 1.14.0.4 (2015-06-02)
10038 * Added missing commonmark template.
10040 * Improved try pandoc (moved button, show raw command).
10042## pandoc 1.14.0.3 (2015-06-01)
10044 * Allow compilation with syb 0.5.*.
10046 * Custom writer: fixed some compiler warnings for ghc < 7.10.
10048## pandoc 1.14.0.2 (2015-05-31)
10050 * Allow building with hslua 0.4.
10052## pandoc 1.14.0.1 (2015-05-28)
10054 * Fixed problem with building of `reference.docx` and `reference.odt`
10055 when the `embed_data_files` flag is used. Instead of having a phase
10056 of the build where `reference.docx` and `reference.odt` are created
10057 from their constituent data files, we now construct these archives
10058 from their constituents when a `docx` or `odt` is built. The
10059 constituent files have been moved from `extra-source-files` to
10060 `data-files`, and `reference.docx` and `reference.odt` have been
10061 removed. Users can create their own `reference.docx` or
10062 `reference.odt` by using pandoc to create a simple `docx` or `odt`.
10063 `make-reference-files.hs` has been removed, simplifying the build
10064 process (#2187)
10066 * Don't include generated man pages in extra-source-files (#2189).
10068 * Bumped upper bound for aeson.
10070 * ConTeXt writer: create internal link anchors for Div elements with
10071 identifiers. (This is needed for linked citations to work.)
10073## pandoc 1.14 (2015-05-27)
10075### New features
10077 * Added `commonmark` as input and output format.
10079 * Added `--verbose` flag for debugging output in PDF production (#1840,
10080 #1653).
10082 * Allow wildcards in `--epub-embed-font` arguments (#1939).
10084 * Added `--latex-engine-opt` option (#969, #1779, Sumit Sahrawat).
10086 * Added `shortcut_reference_links` extension (Konstantin Zudov, #1977).
10087 This is enabled by default for those markdown flavors that
10088 support reading shortcut reference links, namely: `markdown`,
10089 `markdown_strict`, `markdown_github`, `markdown_php`.
10090 If the extension is enabled, the reader parses shortcut reference
10091 links like `[foo]`, and the writer creates such links unless doing
10092 so would cause problems. Users of markdown flavors that support
10093 shortcut reference links should not notice a difference in reading
10094 markdown, but the markdown pandoc produces may differ.
10095 If shortcut links are not desired, the extension can be disabled
10096 in the normal way.
10098### Behavior changes
10100 * `--toc` is now supported for `docx` output (#458, Nikolay Yakimov).
10101 A "dirty" TOC is created at the beginning of document.
10102 It can be regenerated after the document has been opened.
10104 * An implicit `--filter pandoc-citeproc` is now triggered only when the
10105 `--bibliography` option is used, and not when the `bibliography`
10106 field in metadata is specified (#1849).
10108 * Markdown reader:
10110 + Reference links with `implicit_header_references` are no longer
10111 case-sensitive (#1606).
10112 + Definition lists no longer require indentation for first line (#2087).
10113 Previously the body of the definition (after the `:` or `~` marker)
10114 needed to be in column 4. This commit relaxes that requirement,
10115 to better match the behavior of PHP Markdown Extra. So, now
10116 this is a valid definition list:
10118 foo
10119 : bar
10120 + Resolve a potentially ambiguity with table captions:
10122 foo
10124 : bar
10126 -----
10127 table
10128 -----
10130 Is "bar" a definition, or the caption for the table? We'll count
10131 it as a caption for the table.
10132 + Disallow headerless pipe tables (#1996), to conform to GFM and PHP
10133 Markdown Extra. Note: If you have been using headerless pipe tables,
10134 this change may cause existing tables to break.
10135 + Allow pipe tables with header but no body (#2017).
10136 + Allow a digit as first character of a citation key (Matthias Troffaes).
10137 See https://github.com/jgm/pandoc-citeproc/issues/97
10139 * LaTeX reader:
10141 + Don't limit includes to `.tex` extension (#1882).
10142 If the extension is not `.tex`, it must be given explicitly in
10143 the `\input` or `\include`.
10145 * Docx reader:
10147 + Allow numbering in the style file. This allows inherited styles
10148 with numbering (lists) (Jesse Rosenthal).
10150 * Org reader:
10152 + Support smart punctuation (Craig Bosma).
10153 + Drop trees with a :noexport: tag (Albert Krewinkel). Trees having a
10154 `:noexport:` tag set are not exported. This mirrors org-mode.
10155 + Put header tags into empty spans (Albert Krewinkel, #2160).
10156 Org mode allows headers to be tagged: `* Headline :TAG1:TAG2`.
10157 Instead of being interpreted as part of the headline, the tags are now
10158 put into the attributes of empty spans. Spans without textual content
10159 won't be visible by default, but they are detectable by filters. They
10160 can also be styled using CSS when written as HTML.
10161 + Generalize code block result parsing (Albert Krewinkel).
10162 Previously, only code blocks were recognized as result blocks;
10163 now, any kind of block can be the result.
10165 * Append newline to the LineBreak in Dokuwiki, HTML, EPUB,
10166 LaTeX, MediaWiki, OpenDocument, Texinfo writers (#1924, Tim Lin).
10168 * HTML writer:
10170 + Add "inline" or "display" class to math spans (#1914).
10171 This allows inline and display math to be styled differently.
10172 + Include raw latex blocks if `--mathjax` specified (#1938).
10173 + Require highlighting-kate >= 0.5.14 (#1903).
10174 This ensures that all code blocks will be wrapped in a `div`
10175 with class `sourceCode`. Also, the default highlighting CSS
10176 now adds `div.sourceCode { x-overflow: auto; }`, which means
10177 that code blocks (even with line numbers) will acquire a scroll
10178 bar on screens too small to display them (e.g. mobile phones).
10179 See also jgm/highlighting-kate#65.
10181 * LaTeX writer:
10183 + Use a declaration for tight lists (Jose Luis Duran, Joseph
10184 Harriott). Previously, pandoc hard-coded some commands to make
10185 tight lists in LaTeX. Now we use a custom command instead,
10186 allowing the styling to be changed in a macro in the header.
10187 (Note: existing templates may need to be modified to include
10188 the definition of this macro. See the current template.)
10189 + Beamer output: if the header introducing a slide has the
10190 class `fragile`, add the `[fragile]` option to the slide (#2119).
10192 * MediaWiki writer:
10194 + Use `File:` instead of the deprecated `Image:` for images and
10195 other media files (Greg Rundlett).
10197 * DocBook writer:
10199 + Render a `Div (id,_,_) [Para _]` element as a `para` element
10200 with an `id` attribute. This makes links to citations work in
10201 DocBook with pandoc-citeproc.
10203 * RST writer:
10205 + Normalize headings to sequential levels (Nikolay Yakimov).
10206 This is pretty much required by docutils.
10207 + Treat headings in block quotes, etc as rubrics (Nikolay Yakimov).
10208 + Better handling of raw latex inline (#1961). We use
10209 `` :raw-latex:`...` `` and add a definition for this role to
10210 the template.
10212 * EPUB writer:
10214 + Remove `linear=no` from cover `itemref` (#1609).
10215 + Don't use `sup` element for epub footnotes (#1995).
10216 Instead, just use an a element with class `footnoteRef`.
10217 This allows more styling options, and provides better results
10218 in some readers (e.g. iBooks, where anything inside the a
10219 tag breaks popup footnotes).
10220 + Take TOC title from `toc-title` metadata field.
10222 * Docx writer:
10224 + Implemented `FirstParagraph` style (Jesse Rosenthal).
10225 Following the ODT writer, we add the `FirstParagraph` style to the
10226 first text paragraph following an image, blockquote, table, heading,
10227 or beginning of document. This allows it to be styled differently.
10228 The default is for it to be the same as `Normal`.
10229 + Added `BodyText` style (Jesse Rosenthal).
10230 We apply a `BodyText` style to all unstyled paragraphs. This is,
10231 essentially, the same as `Normal`, except that since not everything
10232 inherits from `BodyText` (the metadata won't, for example, or
10233 the headers or footnote numbers), we can change the text in the body
10234 without having to make exceptions for everything. If we do want to
10235 change *everything*, we can still do it through `Normal`.
10236 + Altered `Blockquote` style slightly (Jesse Rosenthal).
10237 Since `BlockQuote` derives from `BodyText`, we just want to specify
10238 by default that it won't indent, regardless of what `BodyText` does.
10239 Note that this will not produce any visible difference in the default
10240 configuration.
10241 + Take TOC title from `toc-title` metadata field (Nikolay Yakimov).
10242 + Added a style to figure images (Nikolay Yakimov).
10243 Figures with empty captions use style `Figure`.
10244 Figures with nonempty captions use style `Figure with Caption`, which
10245 is based on `Figure`, and additionally has `keepNext` set.
10247 * ODT writer:
10249 + Added figure captions (Nikolay Yakimov). The following styles are
10250 used for figures:
10251 `Figure` -- for figure with empty caption),
10252 `FigureWithCaption` (based on `Figure`) -- for figure with caption,
10253 `FigureCaption` (based on `Caption`) -- for figure captions.
10254 Also, `TableCaption` (based on `Caption`) is used for table captions.
10256### API changes
10258 * New `Text.Pandoc.Error` module with `PandocError` type
10259 (Matthew Pickering).
10261 * All readers now return `Either PandocError Pandoc` instead of `Pandoc`
10262 (Matthew Pickering). This allows better handling of errors.
10264 * Added `Text.Pandoc.Writers.CommonMark`, exporting `writeCommonMark`.
10266 * Added `Text.Pandoc.Readers.CommonMark`, exporting `readCommonMark`.
10268 * Derive `Data` and `Typeable` instances for `MediaBag`, `Extension`,
10269 `ReaderOptions`, `EPUBVersion`, `CiteMethod`, `ObfuscationMethod`,
10270 `HTMLSlideVariant`, `TrackChanges`, `WriterOptions` (Shabbaz
10271 Youssefi).
10273 * New `Ext_shortcut_reference_links` constructor for `Extension`
10274 (Konstantin Zudov).
10276### Bug fixes
10278 * Markdown reader:
10280 + Allow smart `'` after inline math (#1909, Nikolay Yakimov).
10281 + Check for tex macros after indented code (#1973).
10282 + Rewrote `charsInBalancedBrackets` for efficiency.
10283 + Make sure a closing `</div>` doesn't get included in a
10284 definition list item (#2127).
10285 + Don't parse bracketed text as citation if it might be a link,
10286 image, or footnote (Nikolay Yakimov).
10287 + Require space after key in mmd title block (#2026, Nikolay
10288 Yakimov). Require space after key-value delimiter colon in mmd title
10289 block.
10290 + Require nonempty value in mmd title block (Nikolay Yakimov).
10291 + Disable all metadata block extensions when parsing
10292 metadata field values (#2026, Nikolay Yakimov). Otherwise we
10293 could get a mmd title block inside YAML metadata, for example.
10295 * HTML reader:
10297 + Improve self-closing tag detection in `htmlInBalanced` (#2146).
10298 + Handle tables with `<th>` in body rows (#1859, mb21).
10299 + Fixed `htmlTag` (#1820). If the tag parses as a comment, we check
10300 to see if the input starts with `<!--`. If not, it's bogus comment
10301 mode and we fail `htmlTag`.
10302 + Handle `base` tag; if it has an `href` value, this is added to
10303 all relative URLs in links and images.
10305 * DocBook reader:
10307 + Look inside "info" elements for section titles (#1931).
10309 * Docx reader:
10311 + Parse images in deprecated vml format (Jesse Rosenthal).
10312 + Allow sub/superscript verbatims (Jesse Rosenthal).
10313 Verbatim usually shuts off all other run styles, but we don't want it
10314 to shut off sub/superscript.
10316 * LaTeX reader:
10318 + Handle `tabular*` environment (#1850).
10319 Note that the table width is not actually parsed or taken into
10320 account, but pandoc no longer chokes on it.
10321 + Ignore options in `\lstinline` rather than raising error (#1997).
10322 + Add some test cases for simple tables (Mathias Schenner).
10323 + Handle valign argument in tables (Mathias Schenner) (currently
10324 we just ignore this).
10325 + Allow non-empty colsep in tables (Mathias Schenner).
10326 The `tabular` environment allows non-empty column separators
10327 with the "@{...}" syntax. Previously, pandoc would fail to
10328 parse tables if a non-empty colsep was present. With this
10329 commit, these separators are still ignored, but the table gets
10330 parsed. A test case is included.
10331 + Recognize `\newpage` as a block command.
10332 + Allow block content in `\title{}` (#2001).
10333 + Check for block-level newcommand aliases in blockCommand (Nikolay
10334 Yakimov).
10335 + Guard against paragraph starting with inline macro (Nikolay Yakimov).
10336 + Properly gobble spaces after `\\` (#2007).
10338 * Textile reader:
10340 + Handle newlines in table cells, and empty cells (#1919).
10342 * Org reader:
10344 + Allow image links with non-image targets (Hans-Peter Deifel).
10345 This matches behavior of Org-Mode for links like
10346 `[[http://example.com][https://www.haskell.org/static/img/logo.png]]`.
10348 * Docbook writer:
10350 + Don't print empty id attributes (thanks to Steve Horne).
10352 * HTML writer:
10354 + Fixed list-style-type for numbered example lists.
10355 Should be "decimal," not "example" (#1902).
10356 + Do not omit missing `alt` attribute on `img` tag (#1131,
10357 Konstantin Zudov).
10358 + Allow multiple colgroups in table (#2122).
10359 + In revealjs, ensure that lists in speaker notes don't add "fragment"
10360 classes, which can cause additional keypresses to be needed to
10361 advance a slide (#1394).
10363 * LaTeX writer:
10365 + Don't escape `$` in URL (#1913).
10366 + Don't use listings in headers (Matthew Pickering, #1963).
10367 + Recognize book documentclass if set in metadata (#1971).
10368 This sets `--chapters` implicitly if the documentclass in metadata
10369 is a book documentclass. Previously this was done only if a book
10370 documentclass was set in a variable.
10371 + Add a `\label` in `\hyperdef` for Div, Span (or links don't work).
10372 + Make `mainlang` work when `lang` is in metadata (#2174).
10374 * Texinfo writer:
10376 + Fix wrapping by using breakable spaces (Tim Lin).
10378 * RST writer:
10380 + Fixed toc depth in RST writer. Previously the depth was being
10381 rendered as a floating point number with a decimal point.
10383 * Markdown writer:
10385 + Improved escaping (#2086). `<` should not be escaped as `\<`, for
10386 compatibility with original Markdown. We now escape `<` and `>`
10387 with entities. Also, we now backslash-escape square brackets.
10388 + Avoid introducing spurious list items through wrapping (#1946).
10389 + Don't emit span tags if plain or raw HTML disabled.
10391 * MediaWiki writer:
10393 + Convert spaces to underscores in wikilink URL (#1982), like MediaWiki.
10395 * AsciiDoc writer:
10397 + Insert some needed blank lines (#1860).
10398 + Avoid wrapping after list marker (#1858).
10400 * EPUB writer:
10402 + Properly handle internal links to IDs in spans, divs (#1884).
10403 + Use plain writer for metadata dc: fields (#2121).
10404 This gives better results when we have, e.g. multiple paragraphs.
10405 Note that tags aren't allowed in these fields.
10406 + Properly handle image links without an extension (#1855).
10407 + Improved chapter splitting and internal link rewriting (#1887,
10408 #2162, #2163). This will ensure that internal links work and
10409 that the references section produced by pandoc-citeproc is
10410 in its own chapter.
10411 + Fixed handling of svg images (#2183).
10413 * ICML writer:
10415 + Better handling of raw blocks and inlines (#1951).
10416 Previously these were always escaped and printed verbatim.
10417 Now they are ignored unless the format is `icml`, in which
10418 case they are passed through unescaped.
10419 + Fixed image URIs in ICML output (gohai).
10421 * Custom writer:
10423 + Raise error if loadstring returns an error status.
10424 + Raise `PandocLuaException` instead of using 'error'.
10425 Eventually we'll change the return type so that no exception
10426 is involved, but at least this can be trapped.
10427 + Use UTF-8 aware bytestring conversion.
10428 + Set foreign encoding to UTF-8 (Nikolay Yakimov, #2101, #1634).
10429 Also factored out ByteString, since it's only used as an intermediate
10430 representation.
10432 * Docx writer:
10434 + Copy hyphenation settings from reference.docx (Nikolay Yakimov).
10435 + Filter out illegal XML characters (#1992, Matthew Pickering).
10436 + Added `noProof` to docx syntax highlighting `SourceCode` style.
10437 + Added footnotes id -1 and 0 (Jesse Rosenthal).
10438 Word uses, by default, footnotes with id -1 and 0 for separators. If a
10439 user modifies `reference.docx`, they will end up with a `settings.xml`
10440 file that references these footnotes, but no such footnotes in the
10441 document. This will produce a corruption error. Here we add these to the
10442 document and `settings.xml` file, so future modifications won't break
10443 the file.
10444 + Handle lists correctly inside table cells (Jesse Rosenthal).
10445 Previously we didn't transform lists inside table cells.
10446 + Set firstRow information in tables (Nikolay Yakimov).
10447 + Don't replace `SourceCode` style in `reference.docx` if it is defined
10448 there (Nikolay Yakimov, #1872). If `--no-highlight` specified, remove
10449 any `SourceCode` and `*Tok` styles in `reference.docx`.
10450 + Attempt to match international style names (#1607, Nikolay Yakimov).
10451 + Set these styles as custom (Nikolay Yakimov): `Author`, `Abstract`,
10452 `Compact`, `Image Caption`, `Table Caption`, `Definition Term`,
10453 `Definition`, `First Paragraph`.
10454 + Rename these styles to correspond with Word `Normal.dotm` (Nikolay
10455 Yakimov): `Block Quote -> Block Text`, `Link -> Hyperlink`,
10456 `Footnote Ref -> Footnote Reference`.
10457 + Added `Caption` style (Nikolay Yakimov).
10458 + Changed these styles' inheritance (Nikolay Yakimov):
10459 `Image Caption <- Caption`, `Table Caption <- Caption`.
10460 + Remove `SourceCode` style from `reference.docx` (#1872).
10461 This is added automatically by the docx writer.
10462 + Added toc heading style to `reference.docx` (Nikolay Yakimov).
10464 * `Text.Pandoc.PDF`
10466 + Don't suggest "Try xelatex" if xelatex already in use (mb21, #1832).
10467 + More comprehensible errors on image conversion (#2067).
10468 EPS can't be supported without shelling out to something like
10469 ImageMagick, but at least we can avoid mysterious error messages.
10471 * `Text.Pandoc.Shared`:
10473 + Make safeRead safe (#1801, Matthew Pickering).
10474 + Addded `mapLeft`, `hush` (Matthew Pickering).
10476 * `Text.Pandoc.Pretty`:
10478 + Remove partial function (Matthew Pickering).
10480 * `Text.Pandoc.SelfContained`:
10482 + Add `;charset=utf-8` to script mime type if missing (#1842).
10483 + Improved building of data URIs (#1940). Now base64 is used except
10484 for `text/*` mime types.
10485 + `cssURLs` no longer tries to fetch fragment URLs (#2121).
10486 + Properly handle data URIs in css urls (#2129).
10487 Use a proper CSS parser (adds dependency on `text-css`).
10489 * `Text.Pandoc.UTF8`:
10491 + Better handling of bare CRs in input files (#2132).
10492 Previously we just stripped them out; now we convert
10493 other line ending styles to LF line endings.
10495 * `Text.Pandoc.ImageSize`:
10497 + Fixed some exif header parsing bugs (#1834).
10498 + Make imageSize return an Either, not a Maybe (#1834).
10499 Use `runGetOrFail` (with `binary >= 0.7`) to return `Left` on
10500 parse failure (rather than `error`).
10501 + Improved warnings when image size can't be determined.
10502 + Removed error landmines (Matthew Pickering).
10504 * Added woff2 to MIME types (Alfred Wechselberger).
10506 * pandoc: When a binary input format is used, warn that file
10507 arguments past the first one are being ignored (Matthew Pickering).
10509### Template changes
10511 * LaTeX template:
10513 + Degrade gracefully if `\paragraph` not defined.
10514 + Include `grffile` together with `graphicx` (#2074).
10515 This properly handles filenames containing spaces and dots.
10516 + Redefine `\paragraph`, `\subparagraph`... to behave more
10517 like section headers (#1658).
10518 + Import hyperref before polyglossia to avoid an error with xelatex,
10519 "please load package hyperref before bidi package" (Nick Bart).
10520 + Added `toccolor` variable to control link color in toc (Kaixhin).
10522 * LaTeX, Beamer templates:
10524 + Provide `\tightlist`, which is now used by the LaTeX writer.
10525 + Use polyglossia in beamer (#85).
10526 + Use `bibliography` instead of `biblio-files`
10527 (#1661). Also use `\addbibresource` instead of `\bibliography` for
10528 biblatex.
10529 + Added `setotherlanguages` in polyglossia. This uses an `otherlang`
10530 variable that is derived from a comma-separated list in `lang`;
10531 the last language is `mainlang` and the others are `otherlang`.
10533 * EPUB templates:
10535 + Use `div`, not `p`, for "rights" on title page.
10536 + Added header-includes, include-before, include-after (#1987).
10538 * OpenDocument template:
10540 + Use `text:p` instead of `text:h` for title.
10541 Using `text:h` causes problems with numbering. Closes #2059.
10542 Thansk to @nkalvi for diagnosing this.
10544 * reveal.js template:
10546 + Link to non-minified css, js. The minified versions no longer
10547 ship with the library.
10548 + Correctly include style CSS (#1949).
10549 + New configurable options options: `center`, `maxScale`, `slideNuber`
10550 (Dmitry Smirnov, pandoc-templates#89).
10551 + Moved custom CSS after theme. This allows custom CSS to modify
10552 themes, instead of being replaced by them.
10553 + Allow `center` to be set to false.
10555### Under the hood improvements
10557 * Removed pre-built `reference.docx` and `reference.odt` (Nikolay
10558 Yakimov). Instead the repository now includes the component text files,
10559 and the zipped binaries are built from these using a helper
10560 program, `make-reference-files`. This should make maintenance of
10561 these components easier going forward.
10563 * `Text.Pandoc.Parsing`:
10565 + Added new `<+?>` combinator (Nikolay Yakimov).
10566 + Added `stateHeaderKeys` to `ParserState`.
10568 * `make_deb.sh` fixes:
10570 + Detect architecture.
10571 + Add Installed-Size to debian package control file (#1900).
10572 + Use `fakeroot` to get permissions right.
10573 + Use `mkdir` and `cp` instead of `install`.
10574 + Set permissions of directories to 755.
10575 + Install in `/usr` rather than `/usr/local`.
10576 + Compress man pages.
10577 + Combine copyright files for `pandoc`, `pandoc-citeproc`.
10579 * Added `Text.Pandoc.Compat.Locale` and `old-locale` flag
10580 to assist with transition to `time` 1.5.
10582 * Updated CONTRIBUTING.md with information about issue tags (Matthew
10583 Pickering).
10585 * Updated travis installs to the new sudo-less syntax (Tim Lin).
10587 * Updated dependency version bounds.
10589 * EPUB tests: don't use `joinPath`, which varies across platforms.
10590 Instead, use a forward-slash to join paths, regardless of the
10591 platform. This matches the way `MediaBag` now works.
10593 * Clarify JSON input and output in usage message (Caleb McDaniel).
10595 * Improved INSTALL instructions.
10597 * Always build man pages. Removed make-pandoc-man-pages flag.
10599 * Makefile: removed man target, now that we generate man pages by default.
10601 * README:
10603 + Fixed typos (J. Lewis Muir).
10604 + Added documentation on backtick_code_blocks (#2135, Nikolay Yakimov).
10605 + Added note on in-field markup in biblio databases (Nick Bart).
10606 + Fixed misleading example of raw HTML block.
10607 + Various minor formatting and consistency fixes for the program
10608 options (Andreas Lööw).
10609 + Made definition lists for options all "loose" for consistency.
10610 + Added YAML biblio format to table, and note on `pandoc-citeproc`'s
10611 `--bib2json` and `--bib2yaml` options (Nick Bart).
10612 + Removed obsolete reference to `mods2yaml` (Nick Bart).
10613 + Added section on syntax highlighting.
10614 + Documented `toccolor` variable.
10616## pandoc 1.13.2.1 (2015-04-15)
10618 * Updated to build with ghc 7.10.1.
10620 * Bumped package upper bounds for filepath, blaze-html, blaze-markup.
10622## pandoc 1.13.2 (2014-12-20)
10624 * TWiki Reader: add new new twiki reader (API chaneg, Alexander Sulfrian).
10626 * Markdown reader:
10628 + Better handling of paragraph in div (#1591).
10629 Previously text that ended a div would be parsed as Plain
10630 unless there was a blank line before the closing div tag.
10631 + Don't treat a citation as a reference link label (#1763).
10632 + Fix autolinks with following punctuation (#1811).
10633 The price of this is that autolinked bare URIs can no longer
10634 contain `>` characters, but this is not a big issue.
10635 + Fix `Ext_lists_without_preceding_blankline` bug (#1636, Artyom).
10636 + Allow `startnum` to work without `fancy_lists`. Formerly
10637 `pandoc -f markdown-fancy_lists+startnum` did not work properly.
10639 * RST reader (all Daniel Bergey):
10641 + Parse quoted literal blocks (#65). RST quoted literal blocks are
10642 the same as indented literal blocks (which pandoc already supports)
10643 except that the quote character is preserved in each line.
10644 + Parse RST class directives. The class directive accepts one or more
10645 class names, and creates a Div value with those classes. If the
10646 directive has an indented body, the body is parsed as the children of
10647 the Div. If not, the first block following the directive is made a
10648 child of the Div. This differs from the behavior of rst2xml, which
10649 does not create a Div element. Instead, the specified classes are
10650 applied to each child of the directive. However, most Pandoc Block
10651 constructors to not take an Attr argument, so we can't duplicate this
10652 behavior.
10653 + Warn about skipped directives.
10654 + Literal role now produces Code. Code role should have "code" class.
10655 + Improved support for custom roles
10657 - Added `sourceCode` to classes for `:code:` role, and anything
10658 inheriting from it.
10659 - Add the name of the custom role to classes if the Inline
10660 constructor supports Attr.
10661 - If the custom role directive does not specify a parent role,
10662 inherit from the `:span:` role.
10664 This differs somewhat from the `rst2xml.py` behavior. If a custom
10665 role inherits from another custom role, Pandoc will attach both
10666 roles' names as classes. `rst2xml.py` will only use the class of
10667 the directly invoked role (though in the case of inheriting from a
10668 `:code:` role with a `:language:` defined, it will also provide the
10669 inherited language as a class).
10670 + Warn about ignored fields in role directives.
10672 * LaTeX reader:
10674 + Parse label after caption into a span instead of
10675 inserting an additional paragraph of bracketed text (#1747).
10676 + Parse math environments as inline when possible (#1821).
10677 + Better handling of `\noindent` and `\greektext` (#1783).
10678 + Handle `\texorpdfstring` more gracefully.
10679 + Handle `\cref` and `\sep` (Wikiwide).
10680 + Support `\smartcite` and `\Smartcite` from biblatex.
10682 * HTML reader:
10684 + Retain display type of MathML output (#1719, Matthew Pickering).
10685 + Recognise `<br>` tags inside `<pre>` blocks (#1620, Matthew Pickering).
10686 + Make `embed` tag either block or inline (#1756).
10688 * DocBook reader:
10690 + Handle `keycombo`, `keycap` (#1815).
10691 + Get string content in inner tags for literal elements (#1816).
10692 + Handle `menuchoice` elements better, with a `>` between (#1817).
10693 + Include `id` on section headers (#1818).
10694 + Document/test "type" as implemented (Brian O'Sullivan).
10695 + Add support for calloutlist and callout (Brian O'Sullivan).
10696 We treat a calloutlist as a bulleted list. This works well in practice.
10697 + Add support for `classname` (Bryan O'Sullivan).
10699 * Docx reader:
10701 + Fix window path for image lookup (Jesse Rosenthal).
10702 Don't use os-sensitive "combine", since we always want the paths in our
10703 zip-archive to use forward-slashes.
10704 + Single-item headers in ordered lists are headers (Jesse Rosenthal).
10705 When users number their headers, Word understands that as a single item
10706 enumerated list. We make the assumption that such a list is, in fact,
10707 a header.
10708 + Rewrite rewriteLink to work with new headers (Jesse Rosenthal).
10709 There could be new top-level headers after making lists, so we have to
10710 rewrite links after that.
10711 + Use polyglot header list (Jesse Rosenthal).
10712 We're just keeping a list of header formats that different languages
10713 use as their default styles. At the moment, we have English, German,
10714 Danish, and French. We can continue to add to this.
10715 This is simpler than parsing the styles file, and perhaps less
10716 error-prone, since there seems to be some variations, even within a
10717 language, of how a style file will define headers.
10718 + Remove header class properly in other langs (Jesse Rosenthal).
10719 When we encounter one of the polyglot header styles, we want to remove
10720 that from the par styles after we convert to a header. To do that, we
10721 have to keep track of the style name, and remove it appropriately.
10722 + Account for external link URLs with anchors. Previously, if a URL
10723 had an anchor, the reader would incorrectly identify it as an
10724 internal link and return only the anchor as URL. (Caleb McDaniel)
10725 + Fix for Issue #1692 (i18n styles) (Nikolay Yakimov).
10727 * Org reader:
10729 + Added state changing blanklines (Jesse Rosenthal).
10730 This allows us to emphasize at the beginning of a new paragraph (or, in
10731 general, after blank lines).
10732 + Fixed bug with bulleted lists:
10734 - a
10735 - b
10736 * c
10738 was being parsed as a list, even though an unindented `*`
10739 should make a heading. See
10740 <http://orgmode.org/manual/Plain-lists.html#fn-1>.
10741 + Org reader: absolute, relative paths in link (#1741, Albert
10742 Krewinkel). The org reader was too restrictive when parsing links;
10743 some relative links and links to files given as absolute paths
10744 were not recognized correctly.
10745 + Org reader: allow empty links (jgm/gitit#471, Albert Krewinkel).
10746 This is important for use in gitit, which uses empty links
10747 for wikilinks.
10748 + Respect indent when parsing Org bullet lists (#1650, Timothy
10749 Humphries). Fixes issue with top-level bullet list parsing.
10750 + Fix indent issue for definition lists (Timothy Humphries,
10751 see #1650, #1698, #1680).
10752 + Parse multi-inline terms correctly in definition list (#1649,
10753 Matthew Pickering).
10754 + Fix rules for emphasis recognition (Albert Krewinkel).
10755 Things like `/hello,/` or `/hi'/` were falsy recognized as emphasised
10756 strings. This is wrong, as `,` and `'` are forbidden border chars and
10757 may not occur on the inner border of emphasized text.
10758 + Drop COMMENT document trees (Albert Krewinkel).
10759 Document trees under a header starting with the word `COMMENT` are
10760 comment trees and should not be exported. Those trees are dropped
10761 silently (#1678).
10762 + Properly handle links to `file:target` (Albert Krewinkel).
10763 Org links like `[[file:target][title]]` were not handled correctly,
10764 parsing the link target verbatim. The org reader is changed such that
10765 the leading `file:` is dropped from the link target (see #756, #1812).
10766 + Parse LaTeX-style MathML entities (#1657, Albert Krewinkel).
10767 Org supports special symbols which can be included using LaTeX syntax,
10768 but are actually MathML entities. Examples for this are
10769 `\nbsp` (non-breaking space), `\Aacute` (the letter A with accent acute)
10770 or `\copy` (the copyright sign ©)
10772 * EPUB reader:
10774 + URI handling improvements. Now we outsource most of the work to
10775 `fetchItem'`. Also, do not include queries in file extensions (#1671).
10777 * LaTeX writer:
10779 + Use `\texorpdfstring` for section captions when needed (Vaclav Zeman).
10780 + Handle consecutive linebreaks (#1733).
10781 + Protect graphics in headers (Jesse Rosenthal).
10782 Graphics in `\section`/`\subsection` etc titles need to be `\protect`ed.
10783 + Put `~` before header in list item text (Jesse Rosenthal).
10784 Because of the built-in line skip, LaTeX can't handle a section header
10785 as the first element in a list item.
10786 + Avoid using reserved characters as `\lstinline` delimiters (#1595).
10787 + Better handling of display math in simple tables (#1754).
10788 We convert display math to inline math in simple tables,
10789 since LaTeX can't deal with display math in simple tables.
10790 + Escape spaces in code (#1694, Bjorn Buckwalter).
10792 * MediaWiki writer:
10794 + Fixed links with URL = text. Previously these were rendered as bare
10795 words, even if the URL was not an absolute URL (#1825).
10797 * ICML writer:
10799 + Don't force all citations into footnotes.
10801 * RTF writer:
10803 + Add blankline at end of output (#1732, Matthew Pickering).
10805 * RST writer:
10807 + Ensure blank line after figure.
10808 + Avoid exces whitespace after last list item (#1777).
10809 + Wrap line blocks with spaces before continuations (#1656).
10810 + Fixed double-rendering of footnotes in RST tables (#1769).
10812 * DokuWiki writer:
10814 + Better handling of block quotes. This change ensures that
10815 multiple paragraph blockquotes are rendered using native `>`
10816 rather than as HTML (#1738).
10817 + Fix external images (#1739). Preface relative links with ":",
10818 absolute URIs without. (Timothy Humphries)
10820 * HTML writer:
10822 + Use protocol-relative URL for mathjax.
10823 + Put newline btw img and caption paragraph.
10824 + MathML now outputted with tex annotation (#1635, Matthew Pickering).
10825 + Add support for KaTeX HTML math (#1626, Matthew Pickering).
10826 This adds `KaTeX` to `HTMLMathMethod` (API change).
10827 + Don't double render when `email-obfuscation=none` (#1625, Matthew
10828 Pickering).
10829 + Make header attributes work outside top level (#1711).
10830 Previously they only appeared on top level header elements.
10831 Now they work e.g. in blockquotes.
10833 * ODT writer:
10835 + Correctly handle images without extensions (#1729).
10836 + Strip querystring in ODT write (#1682, Todd Sifleet).
10838 * FB2 writer:
10840 + Add newline to output.
10842 * EPUB writer:
10844 + Don't add `sourceURL` to absolute URIs (#1669).
10845 + Don't use unsupported `opf:title-type` for epub2.
10846 + Include "landmarks" section in nav document for epub3 (#1757).
10847 + Removed playOrder from navpoint elements in ncx file (#1760).
10848 These aren't required, and they make manual modification of epubs
10849 difficult.
10850 + Extract title even from structured title.
10851 + Don't include nav node in spine unless `--toc` was requested.
10852 Previously we included it in the spine with `linear="no"`, leading
10853 to odd results in some readers (#1593).
10854 + Fixed absolute URI detection (#1672).
10855 + Correctly resolve relative URIs (#1671).
10856 + Use regular page template for `nav.xhtml`, including doctype (#1759).
10858 * Docx writer:
10860 + Put docx table captions above tables (#1641, Nikolay Yakimov).
10861 + Get the page width from the reference docx file, and use
10862 it to scale images that are too large to fit (Grégory Bataille).
10863 + Partial fix for #1607 (Nikolay Yakimov). International heading styles
10864 are inferred based on `<w:name val="heading #">` fallback, if there
10865 are no en-US "Heading#" styles
10866 + Look in user data dir for archive `reference.docx`.
10867 + Renumber header and footer relationships to avoid collisions (Jesse
10868 Rosenthal). We previously took the old relationship names of the
10869 headers and footer in secptr. That led to collisions. We now make
10870 a map of availabl names in the relationships file, and then rename
10871 in secptr.
10873 * ConTeXt writer:
10875 + Add function toLabel (Mark Szepieniec).
10876 This function can be used to sanitize reference labels so that
10877 they do not contain any of the illegal characters \#[]",{}%()|= .
10878 Currently only Links have their labels sanitized, because they
10879 are the only Elements that use passed labels.
10881 * `Text.Pandoc.Shared`:
10883 + Moved import of `toChunks` outside of CPP conditional (#1590).
10884 + Fix `inDirectory` to reset to the original directory in case
10885 an exception occurs (Freiric Barral).
10887 * Templates:
10889 + LaTeX template: load polyglossia before bibtex (jgm/pandoc-templates#70).
10890 Thanks to bluebirch.
10891 + LaTeX template: Added `\VerbatimFootnotes` if there is verbatim in notes
10892 (#1616).
10893 + LaTeX template: Add shorthands=off to babel options (#1648).
10894 + EPUB, EPUB3 templates: Added `id="cover"` to body of cover page.
10895 This aids styling, making it possible for example to set 0 margins
10896 on the title page (#1758).
10897 + EPUB, EPUB3 templates: Handle structured metadata on titlepage.
10898 Previously we just expected 'title', 'subtitle', 'author', 'date'.
10899 Now we still support those, but also support the format recommended
10900 for epub metadata in the pandoc README:
10902 ---
10903 title:
10904 - type: main
10905 text: My Book
10906 - type: subtitle
10907 text: An investigation of metadata
10908 creator:
10909 - role: author
10910 text: John Smith
10911 - role: editor
10912 text: Sarah Jones
10913 identifier:
10914 - scheme: DOI
10915 text: doi:10.234234.234/33
10916 publisher: My Press
10917 rights: (c) 2007 John Smith, CC BY-NC
10918 ...
10920 * `Text.Pandoc.Templates.getDefaultTemplate`:
10921 don't fail when called with "fb2" (#1660).
10923 * `Text.Pandoc.Parsing`:
10925 + Fixed `inlineMath` so it handles `\text{..}` containing `$`.
10926 For example: `$x = \text{the $n$th root of $y$}` (#1677).
10927 + Change `parseFromString` to fail if not all input is consumed.
10928 (Matthew Pickering)
10929 + Moved `addWarning` from Markdown reader to `Parsing`, so it can be
10930 used by more readers (API change, Daniel Bergey).
10932 * `Text.Pandoc.Pretty`:
10934 + Improve performance of `realLength` (Matthew Pickering).
10935 + Make CR + BLANKLINE = BLANKLINE. This fixes an extra blank line we
10936 were getting at the end of markdown fragments (as well as rst, org,
10937 etc.) (#1705).
10939 * `Text.Pandoc.MIME`:
10941 + Add mime type for WebVTT (Jason Ronallo).
10942 + Changed mime type for `otf` to `application/vnd.ms-opentype` (#1761).
10943 This is needed for epub3 validation.
10945 * `Text.Pandoc.MediaBag`:
10947 + Fix Windows specific path problems (#1597).
10949 * `Text.Pandoc.Shared`:
10951 + Make `collapseFilePath` OS-agnostic (Matthew Pickering).
10953 * Link the test suite using `-threaded`.
10954 This allows the test suite to be run using `+RTS -N`.
10956 * Added `network` dependency under `network-uri` flag in test section.
10958 * Give better error messages when someone tries to convert from
10959 pdf, doc, odt (#1683).
10961 * Added `track` to list of tags treated by `--self-contained` (#1664).
10964## pandoc 1.13.1 (2014-08-30)
10966 * Fixed `--self-contained` with Windows paths (#1558).
10967 Previously `C:\foo.js` was being wrongly interpreted as a URI.
10969 * HTML reader: improved handling of tags that can be block or inline.
10970 Previously a section like this would be enclosed in a paragraph,
10971 with RawInline for the video tags (since video is a tag that can
10972 be either block or inline):
10974 <video controls="controls">
10975 <source src="../videos/test.mp4" type="video/mp4" />
10976 <source src="../videos/test.webm" type="video/webm" />
10977 <p>
10978 The videos can not be played back on your system.<br/>
10979 Try viewing on Youtube (requires Internet connection):
10980 <a href="http://youtu.be/etE5urBps_w">Relative Velocity on
10981 Youtube</a>.
10982 </p>
10983 </video>
10985 This change will cause the video and source tags to be parsed
10986 as RawBlock instead, giving better output.
10987 The general change is this: when we're parsing a "plain" sequence
10988 of inlines, we don't parse anything that COULD be a block-level tag.
10990 * Docx reader:
10992 + Be sensitive to user styles. Note that "Hyperlink" is
10993 "blacklisted," as we don't want the default underline styling to be
10994 inherited by all links by default (Jesse Rosenthal).
10995 + Read single paragraph in table cell as `Plain` (Jesse Rosenthal).
10996 This makes to docx reader's native output fit with the way the markdown
10997 reader understands its markdown output.
10999 * Txt2Tags reader:
11001 + Header is now parsed only if standalone flag is set (Matthew Pickering).
11002 + The header is now parsed as meta information. The first line is the
11003 `title`, the second is the `author` and third line is the `date`
11004 (Matthew Pickering).
11005 + Corrected formatting of `%%mtime` macro (Matthew Pickering).
11006 + Fixed crash when reading from stdin.
11008 * Textile writer: Extended the range of cases where native textile
11009 tables will be used (as opposed to raw HTML): we now handle any
11010 alignment type, but only for simple tables with no captions.
11012 * EPUB writer: Don't use page-progression-direction in EPUB2, which
11013 doesn't support it. Also, if page-progression-direction not specified
11014 in metadata, don't include the attribute even in EPUB3; not including it
11015 is the same as including it with the value "default", as we did before.
11016 (#1550)
11018 * Org writer: Accept example lines with indentation at the beginning
11019 (Calvin Beck).
11021 * DokuWiki writer:
11023 + Refactor to use Reader monad (Matthew Pickering).
11024 + Avoid using raw HTML in table cells; instead, use `\\`
11025 instead of newlines (Jesse Rosenthal).
11026 + Properly handle HTML table cell alignments, and use spacing
11027 to make the tables look prettier (#1566).
11029 * Docx writer:
11031 + Bibliography entries get `Bibliography` style (#1559).
11032 + Implement change tracking (Jesse Rosenthal).
11034 * LaTeX writer:
11036 + Fixed a bug that caused a table caption to repeat across all pages
11037 (Jose Luis Duran).
11038 + Improved vertical spacing in tables and made it customizable using
11039 standard lengths set by booktab. See
11040 <https://groups.google.com/forum/#!msg/pandoc-discuss/qMu6_5lYy0o/ZAU7lzAIKw0J>
11041 (Jose Luis Duran).
11042 + Added `\strut` to fix spacing in multiline tables (Jose Luis Duran).
11043 + Use `\tabularnewline` instead of `\\` in table cells (Jose Luis Duran).
11044 + Made horizontal rules more flexible (Jose Luis Duran).
11046 * Text.Pandoc.MIME:
11048 + Added `MimeType` (type synonym for `String`) and `getMimeTypeDef`.
11049 Code cleanups (Artyom Kazak).
11051 * Templates:
11053 + LaTeX template: disable microtype protrusion for typewriter font (#1549,
11054 thanks lemzwerg).
11056 * Improved OSX build procedure.
11058 * Added `network-uri` flag, to deal with split of `network-uri` from
11059 `network`.
11061 * Fix build dependencies for the `trypandoc` flag, so that they are
11062 ignored if `trypandoc` flag is set to False (Gabor Pali).
11064 * Updated README to remove outdated claim that `--self-contained`
11065 looks in the user data directory for missing files.
11067## pandoc 1.13.0.1 (2014-08-17)
11069 * Docx writer:
11071 + Fixed regression which bungled list numbering (#1544), causing
11072 all lists to appear as basic ordered lists.
11073 + Include row width in table rows (Christoffer Ackelman, Viktor Kronvall).
11074 Added a property to all table rows where the sum of column widths
11075 is specified in pct (fraction of 5000). This helps persuade Word
11076 to lay out the table with the widths we specify.
11078 * Fixed a bug in Windows 8 which caused pandoc not to find the
11079 `pandoc-citeproc` filter (#1542).
11081 * Docx reader: miscellaneous under-the-hood improvements (Jesse Rosenthal).
11082 Most significantly, the reader now uses Builder, leading to some
11083 performance improvements.
11085 * HTML reader: Parse appropriately styled span as SmallCaps.
11087 * Markdown writer: don't escape `$`, `^`, `~` when `tex_math_dollars`,
11088 `superscript`, and `subscript` extensions, respectively, are
11089 deactivated (#1127).
11091 * Added `trypandoc` flag to build CGI executable used in the online
11092 demo.
11094 * Makefile: Added 'quick', 'osxpkg' targets.
11096 * Updated README in templates to indicate templates license.
11097 The templates are dual-licensed, BSD3 and GPL2+.
11099## pandoc 1.13 (15 August 2014)
11101### New features
11103 * Added `docx` as an input format (Jesse Rosenthal). The docx
11104 reader includes conversion of native Word equations to pandoc
11105 LaTeX `Math` elements. Metadata is taken from paragraphs at the
11106 beginning of the document with styles `Author`, `Title`, `Subtitle`,
11107 `Date`, and `Abstract`.
11109 * Added `epub` as an input format (Matthew Pickering). The epub
11110 reader includes conversion of MathML to pandoc LaTeX `Math`
11111 elements.
11113 * Added `t2t` (Txt2Tags) as an input format (Matthew Pickering).
11114 Txt2tags is a lightweight markup format described at
11115 <http://txt2tags.org/>.
11117 * Added `dokuwiki` as an output format (Clare Macrae).
11119 * Added `haddock` as an output format.
11121 * Added `--extract-media` option to extract media contained in a zip
11122 container (docx or epub) while adjusting image paths to point to the
11123 extracted images.
11125 * Added a new markdown extension, `compact_definition_lists`, that
11126 restores the syntax for definition lists of pandoc 1.12.x, allowing
11127 tight definition lists with no blank space between items, and
11128 disallowing lazy wrapping. (See below under behavior changes.)
11130 * Added an extension `epub_html_exts` for parsing HTML in EPUBs.
11132 * Added extensions `native_spans` and `native_divs` to activate
11133 parsing of material in HTML span or div tags as Pandoc Span
11134 inlines or Div blocks.
11136 * `--trace` now works with the Markdown, HTML, Haddock, EPUB,
11137 Textile, and MediaWiki readers. This is an option intended
11138 for debugging parsing problems; ordinary users should not need
11139 to use it.
11141### Behavior changes
11143 * Changed behavior of the `markdown_attribute` extension, to bring
11144 it in line with PHP markdown extra and multimarkdown. Setting
11145 `markdown="1"` on an outer tag affects all contained tags,
11146 recursively, until it is reversed with `markdown="0"` (#1378).
11148 * Revised markdown definition list syntax (#1429). Both the reader
11149 and writer are affected. This change brings pandoc's definition list
11150 syntax into alignment with that used in PHP markdown extra and
11151 multimarkdown (with the exception that pandoc is more flexible about
11152 the definition markers, allowing tildes as well as colons). Lazily
11153 wrapped definitions are now allowed. Blank space is required
11154 between list items. The space before a definition is used to determine
11155 whether it is a paragraph or a "plain" element. **WARNING: This change
11156 may break existing documents!** Either check your documents for
11157 definition lists without blank space between items, or use
11158 `markdown+compact_definition_lists` for the old behavior.
11160 * `.numberLines` now works in fenced code blocks even if no language
11161 is given (#1287, jgm/highlighting-kate#40).
11163 * Improvements to `--filter`:
11165 + Don't search PATH for a filter with an explicit path.
11166 This fixed a bug wherein `--filter ./caps.py` would run `caps.py` from
11167 the system path, even if there was a `caps.py` in the working directory.
11168 + Respect shebang if filter is executable (#1389).
11169 + Don't print misleading error message.
11170 Previously pandoc would say that a filter was not found,
11171 even in a case where the filter had a syntax error.
11173 * HTML reader:
11175 + Parse `div` and `span` elements even without `--parse-raw`,
11176 provided `native_divs` and `native_spans` extensions are set.
11177 Motivation: these now generate native pandoc Div and Span
11178 elements, not raw HTML.
11179 + Parse EPUB-specific elements if the `epub_html_exts`
11180 extension is enabled. These include `switch`, `footnote`,
11181 `rearnote`, `noteref`.
11183 * Org reader:
11185 + Support for inline LaTeX. Inline LaTeX is now accepted and parsed by the
11186 org-mode reader. Both math symbols (like `\tau`) and LaTeX commands (like
11187 `\cite{Coffee}`), can be used without any further escaping (Albert
11188 Krewinkel).
11190 * Textile reader and writer:
11192 + The `raw_tex` extension is no longer set by default. You can
11193 enable it with `textile+raw_tex`.
11195 * DocBook reader:
11197 + Support `equation`, `informalequation`, `inlineequation` elements with
11198 `mml:math` content. This is converted into LaTeX and put into a Pandoc
11199 Math inline.
11201 * Revised `plain` output, largely following the style of Project
11202 Gutenberg:
11204 + Emphasis is rendered with `_underscores_`, strong emphasis
11205 with ALL CAPS.
11206 + Headings are rendered differently, with space to set them off,
11207 not with setext style underlines. Level 1 headers are ALL CAPS.
11208 + Math is rendered using unicode when possible, but without the
11209 distracting emphasis markers around variables.
11210 + Footnotes use a regular `[n]` style.
11212 * Markdown writer:
11214 + Horizontal rules are now a line across the whole page.
11215 + Prettier pipe tables. Columns are now aligned (#1323).
11216 + Respect the `raw_html` extension. `pandoc -t markdown-raw_html`
11217 no longer emits any raw HTML, including span and div tags
11218 generated by Span and Div elements.
11219 + Use span with style for `SmallCaps` (#1360).
11221 * HTML writer:
11223 + Autolinks now have class `uri`, and email autolinks have class
11224 `email`, so they can be styled.
11226 * Docx writer:
11228 + Document formatting is carried over from `reference.docx`.
11229 This includes margins, page size, page orientation, header,
11230 and footer, including images in headers and footers.
11231 + Include abstract (if present) with `Abstract` style (#1451).
11232 + Include subtitle (if present) with `Subtitle` style, rather
11233 than tacking it on to the title (#1451).
11235 * Org writer:
11237 + Write empty span elements with an id attribute as org anchors.
11238 For example `Span ("uid",[],[]) []` becomes `<<uid>>`.
11240 * LaTeX writer:
11242 + Put table captions above tables, to match the conventional
11243 standard. (Previously they appeared below tables.)
11244 + Use `\(..\)` instead of `$..$` for inline math (#1464).
11245 + Use `\nolinkurl` in email autolinks. This allows them to be styled
11246 using `\urlstyle{tt}`. Thanks to Ulrike Fischer for the solution.
11247 + Use `\textquotesingle` for `'` in inline code. Otherwise we get
11248 curly quotes in the PDF output (#1364).
11249 + Use `\footnote<.>{..}` for notes in beamer, so that footnotes
11250 do not appear before the overlays in which their markers appear
11251 (#1525).
11252 + Don't produce a `\label{..}` for a Div or Span element. Do produce
11253 a `\hyperdef{..}` (#1519).
11255 * EPUB writer:
11257 + If the metadata includes `page-progression-direction` (which can be
11258 `ltr` or `rtl`, the `page-progression-direction` attribute will
11259 be set in the EPUB spine (#1455).
11261 * Custom lua writers:
11263 + Custom writers now work with `--template`.
11264 + Removed HTML header scaffolding from `sample.lua`.
11265 + Made citation information available in lua writers.
11267 * `--normalize` and `Text.Pandoc.Shared.normalize` now consolidate
11268 adjacent `RawBlock`s when possible.
11270### API changes
11272 * Added `Text.Pandoc.Readers.Docx`, exporting `readDocx` (Jesse Rosenthal).
11274 * Added `Text.Pandoc.Readers.EPUB`, exporting `readEPUB` (Matthew
11275 Pickering).
11277 * Added `Text.Pandoc.Readers.Txt2Tags`, exporting `readTxt2Tags` (Matthew
11278 Pickering).
11280 * Added `Text.Pandoc.Writers.DokuWiki`, exporting `writeDokuWiki`
11281 (Clare Macrae).
11283 * Added `Text.Pandoc.Writers.Haddock`, exporting `writeHaddock`.
11285 * Added `Text.Pandoc.MediaBag`, exporting `MediaBag`, `lookupMedia`,
11286 `insertMedia`, `mediaDirectory`, `extractMediaBag`. The docx and epub
11287 readers return a pair of a `Pandoc` document and a `MediaBag` with
11288 the media resources they contain. This can be extracted using
11289 `--extract-media`. Writers that incorporate media (PDF, Docx,
11290 ODT, EPUB, RTF, or HTML formats with `--self-contained`) will look
11291 for resources in the `MediaBag` generated by the reader, in addition to
11292 the file system or web.
11294 * `Text.Pandoc.Readers.TexMath`: Removed deprecated `readTeXMath`.
11295 Renamed `readTeXMath'` to `texMathToInlines`.
11297 * `Text.Pandoc`: Added `Reader` data type (Matthew Pickering).
11298 `readers` now associates names of readers with `Reader`
11299 structures. This allows inclusion of readers, like the docx
11300 reader, that take binary rather than textual input.
11302 * `Text.Pandoc.Shared`:
11304 + Added `capitalize` (Artyom Kazak), and replaced uses of
11305 `map toUpper` (which give bad results for many languages).
11306 + Added `collapseFilePath`, which removes intermediate `.` and
11307 `..` from a path (Matthew Pickering).
11308 + Added `fetchItem'`, which works like `fetchItem` but searches
11309 a `MediaBag` before looking on the net or file system.
11310 + Added `withTempDir`.
11311 + Added `removeFormatting`.
11312 + Added `extractSpaces` (from HTML reader) and generalized its type
11313 so that it can be used by the docx reader (Matthew Pickering).
11314 + Added `ordNub`.
11315 + Added `normalizeInlines`, `normalizeBlocks`.
11316 + `normalize` is now `Pandoc -> Pandoc` instead of
11317 `Data a :: a -> a`. Some users may need to change their uses of
11318 `normalize` to the newly exported `normalizeInlines` or
11319 `normalizeBlocks`.
11321 * `Text.Pandoc.Options`:
11323 + Added `writerMediaBag` to `WriterOptions`.
11324 + Removed deprecated and no longer used `readerStrict` in
11325 `ReaderOptions`. This is handled by `readerExtensions` now.
11326 + Added `Ext_compact_definition_lists`.
11327 + Added `Ext_epub_html_exts`.
11328 + Added `Ext_native_divs` and `Ext_native_spans`.
11329 This allows users to turn off the default pandoc behavior of
11330 parsing contents of div and span tags in markdown and HTML
11331 as native pandoc Div blocks and Span inlines.
11333 * `Text.Pandoc.Parsing`:
11335 + Generalized `readWith` to `readWithM` (Matthew Pickering).
11336 + Export `runParserT` and `Stream` (Matthew Pickering).
11337 + Added `HasQuoteContext` type class (Matthew Pickering).
11338 + Generalized types of `mathInline`, `smartPunctuation`, `quoted`,
11339 `singleQuoted`, `doubleQuoted`, `failIfInQuoteContext`,
11340 `applyMacros` (Matthew Pickering).
11341 + Added custom `token` (Matthew Pickering).
11342 + Added `stateInHtmlBlock` to `ParserState`. This is used to keep
11343 track of the ending tag we're waiting for when we're parsing inside
11344 HTML block tags.
11345 + Added `stateMarkdownAttribute` to `ParserState`. This is used
11346 to keep track of whether the markdown attribute has been set in
11347 an enclosing tag.
11348 + Generalized type of `registerHeader`, using new type classes
11349 `HasReaderOptions`, `HasIdentifierList`, `HasHeaderMap` (Matthew
11350 Pickering). These allow certain common functions to be reused
11351 even in parsers that use custom state (instead of `ParserState`),
11352 such as the MediaWiki reader.
11353 + Moved `inlineMath`, `displayMath` from Markdown reader to Parsing,
11354 and generalized their types (Matthew Pickering).
11356 * `Text.Pandoc.Pretty`:
11358 + Added `nestle`.
11359 + Added `blanklines`, which guarantees a certain number of blank lines
11360 (and no more).
11362### Bug fixes
11364 * Markdown reader:
11366 + Fixed parsing of indented code in list items. Indented code
11367 at the beginning of a list item must be indented eight spaces
11368 from the margin (or edge of the container), or four spaces
11369 from the list marker, whichever is greater.
11370 + Fixed small bug in HTML parsing with `markdown_attribute`, which
11371 caused incorrect tag nesting for input like
11372 `<aside markdown="1">*hi*</aside>`.
11373 + Fixed regression with intraword underscores (#1121).
11374 + Improved parsing of inline links containing quote characters (#1534).
11375 + Slight rewrite of `enclosure`/`emphOrStrong` code.
11376 + Revamped raw HTML block parsing in markdown (#1330).
11377 We no longer include trailing spaces and newlines in the
11378 raw blocks. We look for closing tags for elements (but without
11379 backtracking). Each block-level tag is its own `RawBlock`;
11380 we no longer try to consolidate them (though `--normalize` will do so).
11381 + Combine consecutive latex environments. This helps when you have
11382 two minipages which can't have blank lines between them (#690, #1196).
11383 + Support smallcaps through span.
11384 `<span style="font-variant:small-caps;">foo</span>` will be
11385 parsed as a `SmallCaps` inline, and will work in all output
11386 formats that support small caps (#1360).
11387 + Prevent spurious line breaks after list items (#1137). When the
11388 `hard_line_breaks` option was specified, pandoc would formerly
11389 produce a spurious line break after a tight list item.
11390 + Fixed table parsing bug (#1333).
11391 + Handle `c++` and `objective-c` as language identifiers in
11392 github-style fenced blocks (#1318).
11393 + Inline math must have nonspace before final `$` (#1313).
11395 * LaTeX reader:
11397 + Handle comments at the end of tables. This resolves the issue
11398 illustrated in <http://stackoverflow.com/questions/24009489>.
11399 + Correctly handle table rows with too few cells. LaTeX seems to
11400 treat them as if they have empty cells at the end (#241).
11401 + Handle leading/trailing spaces in `\emph` better.
11402 `\emph{ hi }` gets parsed as `[Space, Emph [Str "hi"], Space]`
11403 so that we don't get things like `* hi *` in markdown output.
11404 Also applies to `textbf` and some other constructions (#1146).
11405 + Don't assume preamble doesn't contain environments (#1338).
11406 + Allow (and discard) optional argument for `\caption` (James Aspnes).
11408 * HTML reader:
11410 + Fixed major parsing problem with HTML tables. Table cells were
11411 being combined into one cell (#1341).
11412 + Fixed performance issue with malformed HTML tables.
11413 We let a `</table>` tag close an open `<tr>` or `<td>` (#1167).
11414 + Allow space between `<col>` and `</col>`.
11415 + Added `audio` and `source` in `eitherBlockOrInline`.
11416 + Moved `video`, `svg`, `progress`, `script`, `noscript`, `svg` from
11417 `blockTags` to `eitherBlockOrInline`.
11418 + `map` and `object` were mistakenly in both lists; they have been removed
11419 from `blockTags`.
11420 + Ignore `DOCTYPE` and `xml` declarations.
11422 * MediaWiki reader:
11424 + Don't parse backslash escapes inside `<source>` (#1445).
11425 + Tightened up template parsing.
11426 The opening `{{` must be followed by an alphanumeric or `:`.
11427 This prevents the exponential slowdown in #1033.
11428 + Support "Bild" for images.
11430 * DocBook reader:
11432 + Better handle elements inside code environments. Pandoc's document
11433 model does not allow structure inside code blocks, but at least this way
11434 we preserve the text (#1449).
11435 + Support `<?asciidoc-br?>` (#1236).
11437 * Textile reader:
11439 + Fixed list parsing. Lists can now start without an intervening
11440 blank line (#1513).
11441 + HTML block-level tags that do not start a line are parsed as
11442 inline HTML and do not interrupt paragraphs (as in RedCloth).
11444 * Org reader:
11446 + Make tildes create inline code (#1345). Also relabeled `code` and
11447 `verbatim` parsers to accord with the org-mode manual.
11448 + Respect `:exports` header argument in code blocks (Craig Bosma).
11449 + Fixed tight lists with sublists (#1437).
11451 * EPUB writer:
11453 + Avoid excess whitespace in `nav.xhtml`. This should improve
11454 TOC view in iBooks (#1392).
11455 + Fixed regression on cover image.
11456 In 1.12.4 and 1.12.4.2, the cover image would not appear properly,
11457 because the metadata id was not correct. Now we derive the id from the
11458 actual cover image filename, which we preserve rather than using
11459 "cover-image."
11460 + Keep newlines between block elements. This allows
11461 easier diff-ability (#1424).
11462 + Use `stringify` instead of custom `plainify`.
11463 + Use `renderTags'` for all tag rendering. This properly handles tags
11464 that should be self-closing. Previously `<hr/>` would appear in EPUB
11465 output as `<hr></hr>` (#1420).
11466 + Better handle HTML media tags.
11467 + Handle multiple dates with OPF `event` attributes. Note: in EPUB3 we
11468 can have only one dc:date, so only the first one is used.
11470 * LaTeX writer:
11472 + Correctly handle figures in notes. Notes can't contain figures in
11473 LaTeX, so we fake it to avoid an error (#1053).
11474 + Fixed strikeout + highlighted code (#1294).
11475 Previously strikeout highlighted code caused an error.
11477 * ConTeXt writer:
11479 + Improved detection of autolinks with URLs containing escapes.
11481 * RTF writer:
11483 + Improved image embedding: `fetchItem'` is now used to get the
11484 images, and calculated image sizes are indicated in the RTF.
11485 + Avoid extra paragraph tags in metadata (#1421).
11487 * HTML writer:
11489 + Deactivate "incremental" inside slide speaker notes (#1394).
11490 + Don't include empty items in the table of contents for
11491 slide shows. (These would result from creating a slide
11492 using a horizontal rule.)
11494 * MediaWiki writer:
11496 + Minor renaming of `st` prefixed names.
11498 * AsciiDoc writer:
11500 + Double up emphasis and strong emphasis markers in intraword
11501 contexts, as required by asciidoc (#1441).
11503 * Markdown writer:
11505 + Avoid wrapping that might start a list, blockquote, or header (#1013).
11506 + Use Span instead of (hackish) `SmallCaps` in `plainify`.
11507 + Don't use braced attributes for fenced code (#1416).
11508 If `Ext_fenced_code_attributes` is not set, the first class
11509 attribute will be printed after the opening fence as a bare word.
11510 + Separate adjacent lists of the same kind with an HTML comment (#1458).
11512 * PDF writer:
11514 + Fixed treatment of data uris for images (#1062).
11516 * Docx writer:
11518 + Use Compact style for empty table cells (#1353).
11519 Otherwise we get overly tall lines when there are empty
11520 table cells and the other cells are compact.
11521 + Create overrides per-image for `media/` in reference docx.
11522 This should be somewhat more robust and cover more types of images.
11523 + Improved `entryFromArchive` to avoid an unneeded parse.
11524 + Section numbering carries over from reference.docx (#1305).
11525 + Simplified `abstractNumId` numbering. Instead of sequential numbering,
11526 we assign numbers based on the list marker styles.
11528 * `Text.Pandoc.Options`:
11530 + Removed `Ext_fenced_code_attributes` from `markdown_github`
11531 extensions.
11533 * `Text.Pandoc.ImageSize`:
11535 + Use default instead of failing if image size not found
11536 in exif header (#1358).
11537 + ignore unknown exif header tag rather than crashing.
11538 Some images seem to have tag type of 256, which was causing
11539 a runtime error.
11541 * `Text.Pandoc.Shared`:
11543 + `fetchItem`: unescape URI encoding before reading local file (#1427).
11544 + `fetchItem`: strip a fragment like `?#iefix` from the extension before
11545 doing mime lookup, to improve mime type guessing.
11546 + Improved logic of `fetchItem`: absolute URIs are fetched from the net;
11547 other things are treated as relative URIs if `sourceURL` is `Just _`,
11548 otherwise as file paths on the local file system.
11549 + `fetchItem` now properly handles links without a protocol (#1477).
11550 + `fetchItem` now escapes characters not allowed in URIs before trying
11551 to parse the URIs.
11552 + Fixed runtime error with `compactify'DL` on certain lists (#1452).
11554 * `pandoc.hs`: Don't strip path off of `writerSourceURL`: the path is
11555 needed to resolve relative URLs when we fetch resources (#750).
11557 * `Text.Pandoc.Parsing`
11559 + Simplified `dash` and `ellipsis` (#1419).
11560 + Removed `(>>~)` in favor of the equivalent `(<*)` (Matthew Pickering).
11561 + Generalized functions to use `ParsecT` (Matthew Pickering).
11562 + Added `isbn` and `pmid` to list of recognized schemes (Matthew
11563 Pickering).
11565### Template changes
11567 * Added haddock template.
11568 * EPUB3: Added `type` attribute to `link` tags. They are supposed to
11569 be "advisory" in HTML5, but kindlegen seems to require them.
11570 * EPUB3: Put title page in section with `epub:type="titlepage"`.
11571 * LaTeX: Made `\subtitle` work properly (#1327).
11572 * LaTeX/Beamer: remove conditional around date (#1321).
11573 * LaTeX: Added `lot` and `lof` variables, which can be set to
11574 get `\listoftables` and `\listoffigures` (#1407). Note that
11575 these variables can be set at the command line with `-Vlot -Vlof`
11576 or in YAML metadata.
11578### Under the hood improvements
11580 * Rewrote normalize for efficiency (#1385).
11582 * Rewrote Haddock reader to use `haddock-library` (#1346).
11584 + This brings pandoc's rendering of haddock markup in line
11585 with the new haddock.
11586 + Fixed line breaks in `@` code blocks.
11587 + alex and happy are no longer build-depends.
11589 * Added `Text.Pandoc.Compat.Directory` to allow building against
11590 different versions of the `directory` library.
11592 + Added `Text.Pandoc.Compat.Except` to allow building against
11593 different verions of `mtl`.
11595 * Code cleanup in some writers, using Reader monad to avoid
11596 passing options parameter around (Matej Kollar).
11598 * Improved readability in `pandoc.hs`.
11600 * Miscellaneous code cleanups (Artyom Kazak).
11602 * Avoid `import Prelude hiding (catch)` (#1309, thanks to Michael
11603 Thompson).
11605 * Changed `http-conduit` flag to `https`. Depend on `http-client`
11606 and `http-client-tls` instead of `http-conduit`. (Note: pandoc still
11607 depends on `conduit` via `yaml`.)
11609 * Require `highlighting-kate >= 0.5.8.5` (#1271, #1317, Debian #753299).
11610 This change to highlighting-kate means that PHP fragments no longer need
11611 to start with `<?php`. It also fixes a serious bug causing failures with
11612 ocaml and fsharp.
11614 * Require latest `texmath`. This fixes `\tilde{E}` and allows
11615 `\left` to be used with `]`, `)` etc. (#1319), among many other
11616 improvements.
11618 * Require latest `zip-archive`. This has fixes for unicode path names.
11620 * Added tests for plain writer.
11622 * `Text.Pandoc.Templates`:
11624 + Fail informatively on template syntax errors.
11625 With the move from parsec to attoparsec, we lost good error
11626 reporting. In fact, since we weren't testing for end of input,
11627 malformed templates would fail silently. Here we revert back to
11628 Parsec for better error messages.
11629 + Use `ordNub` (#1022).
11631 * Benchmarks:
11633 + Made benchmarks compile again (Artyom Kazak).
11634 + Fixed so that the failure of one benchmark does not prevent others
11635 from running (Artyom Kazak).
11636 + Use `nfIO` instead of the `getLength` trick to force full evaluation.
11637 + Changed benchmark to use only the test suite, so that benchmarks
11638 run more quickly.
11640 * Windows build script:
11642 + Add `-windows` to file name.
11643 + Use one install command for pandoc, pandoc-citeproc.
11644 + Force install of pandoc-citeproc.
11646 * `make_osx_package`: Call zip file `pandoc-VERSION-osx.zip`.
11647 The zip should not be named `SOMETHING.pkg.zip`, or OSX finder
11648 will extract it into a folder named `SOMETHING.pkg`, which it
11649 will interpret as a defective package (#1308).
11651 * `README`:
11653 + Made headers for all extensions so they have IDs and can be
11654 linked to (Beni Cherniavsky-Paskin).
11655 + Fixed typos (Phillip Alday).
11656 + Fixed documentation of attributes (#1315).
11657 + Clarified documentation on small caps (#1360).
11658 + Better documentation for `fenced_code_attributes` extension
11659 (Caleb McDaniel).
11660 + Documented fact that you can put YAML metadata in a separate file
11661 (#1412).
11664## pandoc 1.12.4.2 (2014-05-14)
11666 * Require highlighting-kate >= 0.5.8. Fixes a performance regression.
11668 * Shared: `addMetaValue` now behaves slightly differently:
11669 if both the new and old values are lists, it concatenates their
11670 contents to form a new list.
11672 * LaTeX reader:
11674 + Set `bibliography` in metadata from `\bibliography` or
11675 `\addbibresource` command.
11676 + Don't error on `%foo` with no trailing newline.
11678 * Org reader:
11680 + Support code block headers (`#+BEGIN_SRC ...`) (Albert Krewinkel).
11681 + Fix parsing of blank lines within blocks (Albert Krewinkel).
11682 + Support pandoc citation extension (Albert Krewinkel). This can
11683 be turned off by specifying `org-citation` as the input format.
11685 * Markdown reader:
11687 + `citeKey` moved to `Text.Pandoc.Parsing` so it can be used by
11688 other readers (Albert Krewinkel).
11690 * `Text.Pandoc.Parsing`:
11692 + Added `citeKey` (see above).
11693 + Added `HasLastStrPosition` type class and `updateLastStrPos`
11694 and `notAfterString` functions.
11696 * Updated copyright notices (Albert Krewinkel).
11698 * Added default.icml to data files so it installs with the package.
11700 * OSX package:
11702 + The binary is now built with options to ensure that it can be
11703 used with OSX 10.6+.
11704 + Moved OSX package materials to osx directory.
11705 + Added OSX package uninstall script, included in the zip container
11706 (thanks to Daniel T. Staal).
11708## pandoc 1.12.4 (2014-05-07)
11710 * Made it possible to run filters that aren't executable
11711 (#1096). Pandoc first tries to find the executable (searching
11712 the path if path isn't given). If it fails, but the file
11713 exists and has a `.py`, `.pl`, `.rb`, `.hs`, or `.php`
11714 extension, pandoc runs the filter using the appropriate
11715 interpreter. This should make it easier to use filters on
11716 Windows, and make it more convenient for everyone.
11718 * Added Emacs org-mode reader (Albert Krewinkel).
11720 * Added InDesign ICML Writer (mb21).
11722 * MediaWiki reader:
11724 + Accept image links in more languages (Jaime Marquínez Ferrándiz).
11725 + Fixed bug in certain nested lists (#1213). If a level 2 list was
11726 followed by a level 1 list, the first item of the level 1 list
11727 would be lost.
11728 + Handle table rows containing just an HTML comment (#1230).
11730 * LaTeX reader:
11732 + Give better location information on errors, pointing to line
11733 numbers within included files (#1274).
11734 + LaTeX reader: Better handling of `table` environment (#1204).
11735 Positioning options no longer rendered verbatim.
11736 + Better handling of figure and table with caption (#1204).
11737 + Handle `@{}` and `p{length}` in tabular. The length is not actually
11738 recorded, but at least we get a table (#1180).
11739 + Properly handle `\nocite`. It now adds a `nocite` metadata
11740 field. Citations there will appear in the bibliography but not
11741 in the text (unless you explicitly put a `$nocite$` variable
11742 in your template).
11744 * Markdown reader:
11746 + Ensure that whole numbers in YAML metadata are rendered without
11747 decimal points. (This became necessary with changes to aeson
11748 and yaml libraries. aeson >= 0.7 and yaml >= 0.8.8.2 are now required.)
11749 + Fixed regression on line breaks in strict mode (#1203).
11750 + Small efficiency improvements.
11751 + Improved parsing of nested `div`s. Formerly a closing `div` tag
11752 would be missed if it came right after other block-level tags.
11753 + Avoid backtracking when closing `</div>` not found.
11754 + Fixed bug in reference link parsing in `markdown_mmd`.
11755 + Fixed a bug in list parsing (#1154). When reading a raw list
11756 item, we now strip off up to 4 spaces.
11757 + Fixed parsing of empty reference link definitions (#1186).
11758 + Made one-column pipe tables work (#1218).
11760 * Textile reader:
11762 + Better support for attributes. Instead of being ignored, attributes
11763 are now parsed and included in Span inlines. The output will be a bit
11764 different from stock textile: e.g. for `*(foo)hi*`, we'll get
11765 `<em><span class="foo">hi</span></em>` instead of
11766 `<em class="foo">hi</em>`. But at least the data is not lost.
11767 + Improved treatment of HTML spans (%) (#1115).
11768 + Improved link parsing. In particular we now pick up on attributes.
11769 Since pandoc links can't have attributes, we enclose the whole link in
11770 a span if there are attributes (#1008).
11771 + Implemented correct parsing rules for inline markup (#1175, Matthew
11772 Pickering).
11773 + Use Builder (Matthew Pickering).
11775 * DocBook reader:
11777 + Better treatment of `formalpara`. We now emit the title (if present)
11778 as a separate paragraph with boldface text (#1215).
11779 + Set metadata `author` not `authors`.
11780 + Added recognition of `authorgroup` and `releaseinfo` elements (#1214,
11781 Matthew Pickering).
11782 + Converted current meta information parsing in DocBook to a more
11783 extensible version which is aware of the more recent meta
11784 representation (Matthew Pickering).
11786 * HTML reader:
11788 + Require tagsoup 0.13.1, to fix a bug with parsing of script tags
11789 (#1248).
11790 + Treat processing instructions & declarations as block. Previously
11791 these were treated as inline, and included in paragraph tags in HTML
11792 or DocBook output, which is generally not what is wanted (#1233).
11793 + Updated `closes` with rules from HTML5 spec.
11794 + Use Builder (Matthew Pickering, #1162).
11796 * RST reader:
11798 + Remove duplicate `http` in PEP links (Albert Krewinkel).
11799 + Make rst figures true figures (#1168, CasperVector)
11800 + Enhanced Pandoc's support for rST roles (Merijn Verstaaten).
11801 rST parser now supports: all built-in rST roles, new role definition,
11802 role inheritance, though with some limitations.
11803 + Use `author` rather than `authors` in metadata.
11804 + Better handling of directives. We now correctly handle field
11805 lists that are indented more than three spaces. We treat an
11806 `aafig` directive as a code block with attributes, so it can be
11807 processed in a filter (#1212).
11809 * LaTeX writer:
11811 + Mark span contents with label if span has an ID (Albert Krewinkel).
11812 + Made `--toc-depth` work well with books in latex/pdf output (#1210).
11813 + Handle line breaks in simple table cells (#1217).
11814 + Workaround for level 4-5 headers in quotes. These previously produced
11815 invalid LaTeX: `\paragraph` or `\subparagraph` in a `quote` environment.
11816 This adds an `mbox{}` in these contexts to work around the problem.
11817 See <http://tex.stackexchange.com/a/169833/22451> (#1221).
11818 + Use `\/` to avoid en-dash ligature instead of `-{}-` (Vaclav Zeman).
11819 This is to fix LuaLaTeX output. The `-{}-` sequence does not avoid the
11820 ligature with LuaLaTeX but `\/` does.
11821 + Fixed string escaping in `hyperref` and `hyperdef` (#1130).
11823 * ConTeXt writer: Improved autolinks (#1270).
11825 * DocBook writer:
11827 + Improve handling of hard line breaks in Docbook writer
11828 (Neil Mayhew). Use a `<literallayout>` for the entire paragraph, not
11829 just for the newline character.
11830 + Don't let line breaks inside footnotes influence the enclosing
11831 paragraph (Neil Mayhew).
11832 + Distinguish tight and loose lists in DocBook output, using
11833 `spacing="compact"` (Neil Mayhew, #1250).
11835 * Docx writer: When needed files are not present in the user's
11836 `reference.docx`, fall back on the versions in the `reference.docx`
11837 in pandoc's data files. This fixes a bug that occurs when a
11838 `reference.docx` saved by LibreOffice is used. (#1185)
11840 * EPUB writer:
11842 + Include extension in epub ids. This fixes a problem with duplicate
11843 extensions for fonts and images with the same base name but different
11844 extensions (#1254).
11845 + Handle files linked in raw `img` tags (#1170).
11846 + Handle media in `audio` source tags (#1170).
11847 Note that we now use a `media` directory rather than `images`.
11848 + Incorporate files linked in `video` tags (#1170). `src` and `poster`
11849 will both be incorporated into `content.opf` and the epub container.
11851 * HTML writer:
11853 + Add colgroup around col tags (#877). Also affects EPUB writer.
11854 + Fixed bug with unnumbered section headings. Unnumbered section
11855 headings (with class `unnumbered`) were getting numbers.
11856 + Improved detection of image links. Previously image links with
11857 queries were not recognized, causing `<embed>` to be used instead
11858 of `<img>`.
11860 * Man writer: Ensure that terms in definition lists aren't line wrapped
11861 (#1195).
11863 * Markdown writer:
11865 + Use proper escapes to avoid unwanted lists (#980). Previously we used
11866 0-width spaces, an ugly hack.
11867 + Use longer backtick fences if needed (#1206). If the content contains a
11868 backtick fence and there are attributes, make sure longer fences are
11869 used to delimit the code. Note: This works well in pandoc, but github
11870 markdown is more limited, and will interpret the first string of three
11871 or more backticks as ending the code block.
11873 * RST writer: Avoid stack overflow with certain tables (#1197).
11875 * RTF writer: Fixed table cells containing paragraphs.
11877 * Custom writer:
11879 + Correctly handle UTF-8 in custom lua scripts (#1189).
11880 + Fix bugs with lua scripts with mixed-case filenames and
11881 paths containing `+` or `-` (#1267). Note that `getWriter`
11882 in `Text.Pandoc` no longer returns a custom writer on input
11883 `foo.lua`.
11885 * AsciiDoc writer: Handle multiblock and empty table cells
11886 (#1245, #1246). Added tests.
11888 * `Text.Pandoc.Options`: Added `readerTrace` to `ReaderOptions`
11890 * `Text.Pandoc.Shared`:
11892 + Added `compactify'DL` (formerly in markdown reader) (Albert Krewinkel).
11893 + Fixed bug in `toRomanNumeral`: numbers ending with '9' would
11894 be rendered as Roman numerals ending with 'IXIV' (#1249). Thanks to
11895 Jesse Rosenthal.
11896 + `openURL`: set proxy with value of http_proxy env variable (#1211).
11897 Note: proxies with non-root paths are not supported, due to
11898 limitations in `http-conduit`.
11900 * `Text.Pandoc.PDF`:
11902 + Ensure that temp directories deleted on Windows (#1192). The PDF is
11903 now read as a strict bytestring, ensuring that process ownership will
11904 be terminated, so the temp directory can be deleted.
11905 + Use `/` as path separators in a few places, even on Windows.
11906 This seems to be necessary for texlive (#1151, thanks to Tim Lin).
11907 + Use `;` for `TEXINPUTS` separator on Windows (#1151).
11908 + Changes to error reporting, to handle non-UTF8 error output.
11910 * `Text.Pandoc.Templates`:
11912 + Removed unneeded datatype context (Merijn Verstraaten).
11914 + YAML objects resolve to "true" in conditionals (#1133).
11915 Note: If `address` is a YAML object and you just have `$address$`
11916 in your template, the word `true` will appear, which may be
11917 unexpected. (Previously nothing would appear.)
11919 * `Text.Pandoc.SelfContained`: Handle `poster` attribute in `video`
11920 tags (#1188).
11922 * `Text.Pandoc.Parsing`:
11924 + Made `F` an instance of Applicative (#1138).
11925 + Added `stateCaption`.
11926 + Added `HasMacros`, simplified other typeclasses.
11927 Removed `updateHeaderMap`, `setHeaderMap`, `getHeaderMap`,
11928 `updateIdentifierList`, `setIdentifierList`, `getIdentifierList`.
11929 + Changed the smart punctuation parser to return `Inlines`
11930 rather than `Inline` (Matthew Pickering).
11931 + Changed `HasReaderOptions`, `HasHeaderMap`, `HasIdentifierList`
11932 from typeclasses of monads to typeclasses of states. This simplifies
11933 the instance definitions and provides more flexibility. Generalized
11934 type of `getOption` and added a default definition. Removed
11935 `askReaderOption`. Added `extractReaderOption`. Added
11936 `extractHeaderMap` and `updateHeaderMap` in `HasHeaderMap`.
11937 Gave default definitions for `getHeaderMap`, `putHeaderMap`,
11938 `modifyHeaderMap`. Added `extractIdentifierList` and
11939 `updateIdentifierList` in `HasIdentifierList`. Gave defaults
11940 for `getIdentifierList`, `putIdentifierList`, and
11941 `modifyIdentifierList`. The ultimate goal here is to allow different
11942 parsers to use their own, tailored parser states (instead of
11943 `ParserState`) while still using shared functions.
11945 * Template changes:
11947 + LaTeX template: Use `fontenc` package only with `pdflatex` (#1164).
11948 + LaTeX template: Add `linestretch` and `fontfamily` variables.
11949 + LaTeX template: Conditionalize author and date commands.
11950 + Beamer template: Consistent styles for figure and table captions
11951 (aaronwolen).
11952 + LaTeX and beamer template: Adjust widths correctly for oversized
11953 images. Use `\setkeys{Gin}{}` to set appropriate defaults for
11954 `\includegraphics` (Yihui Xie, Garrick Aden-Buie). Load
11955 `upquote` only after `fontenc` (Yihui Xie).
11956 + Beamer template: Added caption package (#1200).
11957 + Beamer template: changes for better unicode handling (KarolS).
11958 + DocBook template: use `authorgroup` if there are authors.
11959 + revealjs template: Move `include-after` to end (certainlyakey).
11960 + revealjs template: Fixed PDF print function (#1220, kevinkenan).
11962 * Bumped version bounds of dependencies.
11964 * Added a `--trace` command line option, for debugging backtracking
11965 bugs. So far this only works with the markdown reader.
11967 * MathMLinHTML: Fixed deprecation warning (#362, gwern, Albert Krewinkel).
11969 * Updated travis script to test with multiple GHC versions.
11971 * Force failure of a Travis build if GHC produces warnings (Albert
11972 Krewinkel).
11974 * Add `.editorconfig` (Albert Krewinkel).
11975 See <http://editorconfig.org/> for details.
11977 * Give more useful error message if '-t pdf' is specified (#1155).
11979 * Added `Cite`, `SmallCaps` to `Arbitrary` instance (#1269).
11981 * Allow `html4` as a synonym of `html` as a reader (it already works
11982 as a writer).
11984 * README:
11986 + Added an explanation of how to use YAML metadata to
11987 force items to appear in the bibliography without citations in
11988 the text (like LaTeX `\nocite`).
11989 + Added note to `--bibtex/--natbib`: not for use in making PDF
11990 (#1194, thanks to nahoj).
11991 + Added explanatory notes about `--natbib` and `--biblatex`.
11992 + Added specification of legal syntax for citation keys.
11993 + Fixed variable defaults documentation (Albert Krewinkel).
11995 * Removed copyright statements for files that have been removed
11996 (Albert Krewinkel).
11998 * Moved some doc files from `data-files` to `extra-source-files` (#1123).
11999 They aren't needed at runtime. We keep README and COPYRIGHT in data
12000 to ensure that they'll be available on all systems on which pandoc
12001 is installed.
12003 * Use cabal sandboxes in Windows build script.
12005## pandoc 1.12.3.3 (2014-02-03)
12007 * To changes to source; recompiled tarball with latest alex and
12008 happy, so they will work with GHC 7.8.
12010## pandoc 1.12.3.2 (2014-02-03)
12012 * Bumped version bounds for blaze-html, blaze-markup.
12014 * ImageSize: Avoid use of lookAhead, which is not in binary >= 0.6
12015 (#1124).
12017 * Fixed mediawiki ordered list parsing (#1122).
12019 * HTML reader: Fixed bug reading inline math with `$$` (#225).
12021 * Added support for LaTeX style literate Haskell code blocks in rST
12022 (Merijn Verstraaten).
12024## pandoc 1.12.3.1 (2014-01-14)
12026 * Relaxed version constraint on binary, allowing the use of binary 0.5.
12029## pandoc 1.12.3 (2014-01-10)
12031 * The `--bibliography` option now sets the `biblio-files` variable.
12032 So, if you're using `--natbib` or `--biblatex`, you can just use
12033 `--bibliography=foo.bib` instead of `-V bibliofiles=foo`.
12035 * Don't run pandoc-citeproc filter if `--bibliography` is
12036 used together with `--natbib` or `--biblatex` (Florian Eitel).
12038 * Template changes:
12040 + Updated beamer template to include booktabs.
12041 + Added `abstract` variable to LaTeX template.
12042 + Put `header-includes` after `title` in LaTeX template (#908).
12043 + Allow use of `\includegraphics[size]` in beamer.
12044 This just required porting a macro definition from the default
12045 LaTeX template to the default beamer template.
12047 * `reference.docx`: Include `FootnoteText` style.
12048 Otherwise Word ignores the style, even when specified in the `pPr`.
12049 (#901)
12051 * `reference.odt`: Tidied `styles.xml`.
12053 * Relaxed version bounds for dependencies.
12055 * Added `withSocketsDo` around http conduit code in `openURL`,
12056 so it works on Windows (#1080).
12058 * Added `Cite` function to `sample.lua`.
12060 * Markdown reader:
12062 + Fixed regression in title blocks (#1089).
12063 If author field was empty, date was being ignored.
12064 + Allow backslash-newline hard line breaks in grid and
12065 multiline table cells.
12066 + Citation keys may now start with underscores, and may contain
12067 underscores adjacent to internal punctuation.
12069 * LaTeX reader:
12071 + Add support for `Verb` macro (jrnold) (#1090).
12072 + Support babel-style quoting: `` "`..."' ``.
12074 * Properly handle script blocks in strict mode. (That is,
12075 `markdown-markdown_in_html_blocks`.) Previously a spurious
12076 `<p>` tag was being added (#1093).
12078 * Docbook reader: Avoid failure if `tbody` contains no `tr` or `row`
12079 elements.
12081 * LaTeX writer:
12083 + Factored out function for table cell creation.
12084 + Better treatment of footnotes in tables.
12085 Notes now appear in the regular sequence, rather than in the
12086 table cell. (This was a regression in 1.10.)
12088 * HTML reader: Parse name/content pairs from meta tags as metadata.
12089 Closes #1106.
12091 * Moved `fixDisplayMath` from Docx writer to `Writer.Shared`.
12093 * OpenDocument writer: Fixed `RawInline`, `RawBlock` so they don't escape.
12095 * ODT writer: Use mathml for proper rendering of formulas.
12096 Note: LibreOffice's support for this seems a bit buggy. But
12097 it should be better than what we had before.
12099 * RST writer: Ensure no blank line after def in definition list (#992).
12101 * Markdown writer: Don't use tilde code blocks with braced attributes in
12102 `markdown_github` output. A consequence of this change is that the
12103 backtick form will be preferred in general if both are enabled. That
12104 is good, as it is much more widespread than the tilde form. (#1084)
12106 * Docx writer: Fixed problem with some modified reference docx files.
12107 Include `word/_rels/settings.xml.rels` if it exists, as well as other
12108 `rels` files besides the ones pandoc generates explicitly.
12110 * HTML writer:
12112 + With `--toc`, headers no longer link to themselves (#1081).
12113 + Omit footnotes from TOC entries. Otherwise we get doubled
12114 footnotes when headers have notes!
12116 * EPUB writer:
12118 + Avoid duplicate notes when headings contain notes.
12119 This arose because the headings are copied into the metadata
12120 "title" field, and the note gets rendered twice. We strip the
12121 note now before putting the heading in "title".
12122 + Strip out footnotes from toc entries.
12123 + Fixed bug with `--epub-stylesheet`. Now the contents of
12124 `writerEpubStylesheet` (set by `--epub-stylesheet`)
12125 should again work, and take precedence over a stylesheet specified
12126 in the metadata.
12128 * `Text.Pandoc.Pretty`: Added `nestle`. API change.
12130 * `Text.Pandoc.MIME`: Added `wmf`, `emf`.
12132 * `Text.Pandoc.Shared`: `fetchItem` now handles image URLs beginning
12133 with `//`.
12135 * `Text.Pandoc.ImageSize`: Parse EXIF format JPEGs. Previously
12136 we could only get size information for JFIF format, which led
12137 to squished images in Word documents. Closes #976.
12139 * Removed old `MarkdownTest_1.0.3` directory (#1104).
12142## pandoc 1.12.2.1 (2013-12-08)
12144 * Markdown reader: Fixed regression in list parser, involving
12145 continuation lines containing raw HTML (or even verbatim raw HTML).
12147## pandoc 1.12.2 (2013-12-07)
12149 * Metadata may now be included in YAML blocks in a markdown document.
12150 For example,
12152 ---
12153 title:
12154 - type: main
12155 text: My Book
12156 - type: subtitle
12157 text: An investigation of metadata
12158 creator:
12159 - role: author
12160 text: John Smith
12161 - role: editor
12162 text: Sarah Jones
12163 identifier:
12164 - scheme: DOI
12165 text: doi:10.234234.234/33
12166 publisher: My Press
12167 rights: (c) 2007 John Smith, CC BY-NC
12168 cover-image: img/mypic.jpg
12169 stylesheet: style.css
12170 ...
12172 Metadata may still be provided using `--epub-metadata`; it will
12173 be merged with the metadata in YAML blocks.
12175 * EPUB writer:
12177 + `meta` tags are now used instead of `opf` attributes for EPUB3.
12178 + Insert "svg" property as needed in opf (EPUB 3).
12179 + Simplify `imageTypeOf` using `getMimeType`.
12180 + Add properties attribute to `cover-image` item for EPUB 3.
12181 + Don't include node for `cover.xhtml` if no cover!
12182 + Ensure that same identifier is used throughout (#1044).
12183 If an identifier is given in metadata, we use that; otherwise
12184 we generate a random uuid.
12185 + Add cover reference to guide element (EPUB 2) (Shaun Attfield).
12186 Fixes an issue with Calibre putting the cover at the end of the book
12187 if the spine has `linear="no"`. Apparently this is best practice
12188 for other converters as well:
12189 <http://www.idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.6>.
12190 + Allow `stylesheet` in metadata. The value is a path to the stylesheet.
12191 + Allow partial dates: `YYYY`, `YYYY-MM`.
12193 * Markdown writer: Fix rendering of tight sublists (#1050).
12194 Previously a spurious blank line was included after a tight sublist.
12196 * ODT writer: Add `draw:name` attribute to `draw:frame` elements (#1069).
12197 This is reported to be necessary to avoid an error from recent
12198 versions of Libre Office when files contain more than one image
12199 Thanks to wmanley for reporting and diagnosing the problem.
12201 * ConTeXt writer: Don't hardcode figure/table placement and numbering.
12202 Instead, let this be set in the template, using `\setupfloat`.
12203 Thanks to on4aa and Aditya Mahajan for the suggestion (#1067).
12205 * Implemented CSL flipflopping spans in DOCX, LaTeX, and HTML writers.
12207 * Fixed bug with markdown intraword emphasis. Closes #1066.
12209 * Docbook writer: Hierarchicalize block content in metadata.
12210 Previously headers just disappeared from block-level metadata
12211 when it was used in templates. Now we apply the 'hierarchicalize'
12212 transformation. Note that a block headed by a level-2 header will
12213 turn into a `<sect1>` element.
12215 * OpenDocument writer: Skip raw HTML (#1035).
12216 Previously it was erroneously included as verbatim text.
12218 * HTML/EPUB writer, footnotes: Put `<sup>` tag inside `<a>` tags.
12219 This allows better control of formatting, since the `<a>`
12220 tags have a distinguishing class (#1049).
12222 * Docx writer:
12224 + Use mime type info returned by fetchItem.
12225 + Fixed core metadata (#1046).
12226 Don't create empty date nodes if no date given.
12227 Don't create multiple `dc:creator` nodes; instead separate by
12228 semicolons.
12229 + Fix URL for core-properties in `_rels/.rels` (#1046).
12231 * Plain writer: don't print `<span>` tags.
12233 * LaTeX writer:
12235 + Fix definition lists with internal links in terms (#1032).
12236 This fix puts braces around a term that contains an internal
12237 link, to avoid problems with square brackets.
12238 + Properly escape pdftitle, pdfauthor (#1059).
12239 + Use booktabs package for tables (thanks to Jose Luis Duran).
12241 * Updated beamer template. Now references should work properly
12242 (in a slide) when `--biblatex` or `--natbib` is used.
12244 * LaTeX reader:
12246 + Parse contents of curly quotes or matched `"` as quotes.
12247 + Support `\textnormal` as span with class `nodecor`.
12248 This is needed for pandoc-citeproc.
12249 + Improved citation parsing. This fixes a run-time error that occurred
12250 with `\citet{}` (empty list of keys). It also ensures that empty keys
12251 don't get produced.
12253 * MediaWiki reader: Add automatic header identifiers.
12255 * HTML reader:
12257 + Use pandoc `Div` and `Span` for raw `<div>`, `<span>` when
12258 `--parse-raw`.
12259 + Recognize `svg` tags as block level content (thanks to MinRK).
12260 + Parse LaTeX math if appropriate options are set.
12262 * Markdown reader:
12264 + Yaml block must start immediately after `---`. If there's a blank
12265 line after `---`, we interpreted it as a horizontal rule.
12266 + Correctly handle empty bullet list items.
12267 + Stop parsing "list lines" when we hit a block tag.
12268 This fixes exponential slowdown in certain input, e.g.
12269 a series of lists followed by `</div>`.
12271 * Slides: Preserve `<div class="references">` in references slide.
12273 * `Text.Pandoc.Writer.Shared`:
12275 + Fixed bug in `tagWithAttrs`. A space was omitted before key-value
12276 attributes, leading to invalid HTML.
12277 + `normalizeDate`: Allow dates with year only (thanks to Shaun Attfield).
12278 + Fixed bug in `openURL` with `data:` URIs. Previously the base-64
12279 encoded bytestring was returned. We now decode it so it's a proper
12280 image!
12282 * DocBook reader: Handle numerical attributes starting with decimal.
12283 Also use `safeRead` instead of `read`.
12285 * `Text.Pandoc.Parsing`:
12287 + Generalized type of `registerHeader`, using new type classes
12288 `HasReadeOptions`, `HasIdentifierList`, `HasHeaderMap`.
12289 These allow certain common functions to be reused
12290 even in parsers that use custom state (instead of `ParserState`),
12291 such as the MediaWiki reader.
12292 + Moved inlineMath, displayMath from Markdown reader to Parsing.
12293 Generalize their types and export them from Parsing. (API change.)
12295 * `Text.Pandoc.Readers.TexMath`: Export `readTeXMath'`, which attends
12296 to display/inline. Deprecate `readTeXMath`, and use `readTeXMath'`
12297 in all the writers. Require `texmath >= 0.6.5.2`.
12299 * `Text.Pandoc.MIME`:
12301 + Add entry for `jfif`.
12302 + In looking up extensions, drop the encoding info.
12303 E.g. for 'image/jpg;base64' we should lookup 'image/jpg'.
12305 * Templates: Changed how array variables are resolved. Previously if
12306 `foo` is an array (which might be because multiple values were set on
12307 the command line), `$foo$` would resolve to the concatenation of the
12308 elements of foo. This is rarely useful behavior. It has been changed
12309 so that the first value is rendered. Of course, you can still iterate
12310 over the values using `$for(foo)$`. This has the result that you can
12311 override earlier settings using `-V` by putting new values later on the
12312 command line, which is useful for many purposes.
12314 * `Text.Pandoc`: Don't default to `pandocExtensions` for all writers.
12316 * Allow "epub2" as synonym for "epub", "html4" for "html".
12318 * Don't look for slidy files in data files with `--self-contained`.
12320 * Allow `https:` command line arguments to be downloaded.
12322 * Fixed `make_osx_package.sh` so data files embedded in `pandoc-citeproc`.
12324## pandoc 1.12.1 (2013-10-20)
12326 * `Text.Pandoc.Definition`: Changed default JSON serialization format.
12327 Instead of `{"Str": "foo"}`, for example, we now have `{"t": "Str",
12328 "c": "foo"}`. This new format is easier to work with outside of Haskell.
12329 Incidentally, "t" stands for "tag", "c" for "contents".
12331 * MediaWiki reader: Trim contents of `<math>` tags, to avoid problems
12332 when converting to markdown (#1027).
12334 * LaTeX reader:
12336 + Ensure that preamble doesn't contribute to the text of
12337 the document.
12338 + Fixed character escaping in `\url{}`. Previously `\~` wasn't handled
12339 properly, among others.
12340 + Parse `{groups}` as `Span`. This is needed for accurate conversion of
12341 bibtex titles, since we need to know what was protected from
12342 titlecase conversions.
12344 * LaTeX writer:
12346 + Specially escape non-ascii characters in labels.
12347 Otherwise we can get compile errors and other bugs when
12348 compiled with pdflatex (#1007). Thanks to begemotv2718 for the fix.
12349 + Add link anchors for code blocks with identifiers (#1025).
12351 * Throughout the code, use `isURI` instead of `isAbsoluteURI`.
12352 It allows fragments identifiers.
12354 * Slide formats:
12356 + A Div element with class "notes" is treated as speaker
12357 notes. Currently beamer goes to `\note{}`, revealjs to
12358 `<aside class="notes">`, and the notes are simply suppressed in
12359 other formats (#925).
12360 + Fixed `. . .` (pause) on HTML slide formats. Closes #1029.
12361 The old version caused a pause to be inserted before the first
12362 material on a slide. This has been fixed.
12363 + Removed data files for s5, slideous, slidy.
12364 Users of s5 and slideous will have to download the needed
12365 files, as has been documented for some time in the README.
12366 By default, slidy code will be sought on the web, as before.
12368 * HTML writer: Insert command to typeset mathjax only in slideous output
12369 (#966, #1012).
12371 * RST writer: Skip spaces after display math. Otherwise we get indentation
12372 problems, and part of the next paragraph may be rendered as part of the
12373 math.
12375 * OpenDocument writer: Fix formatting of strikeout code (#995),
12376 thanks to wilx. don't use `font-face-decls` variable.
12378 * Fixed test suite so it works with cabal sandboxes.
12380## pandoc 1.12.0.2 (2013-09-20)
12382 * Removed an unused dependency (`stringable`) from pandoc.cabal.
12383 This will help packagers, but users should not need to upgrade.
12385## pandoc 1.12.0.1 (2013-09-20)
12387 * Allow `--metadata` to be repeated for the same key to form a list.
12388 This also has the effect that `--bibliography` can be repeated,
12389 as before.
12391 * Handle boolean values in `--metadata`. Note that anything not parseable
12392 as a YAML boolean or string is treated as a literal string.
12393 You can get a string value with "yes", or any of the strings interpretable
12394 as booleans, by quoting it:
12396 -M boolvalue=yes -M stringvalue='"yes"'
12398 * LaTeX writer: Don't print references if `--natbib` or `--biblatex`
12399 option used.
12401 * DOCX writer: Add `settings.xml` to the zip container. Fixes a bug
12402 in which docx files could not be read by some versions of Word
12403 and LibreOffice (#990).
12405 * Fixed a regression involving slide shows with bibliographies.
12406 The Div container around references messed up the procedure for carving
12407 a document into slides. So we now remove the surrounding Div in
12408 `prepSlides`.
12410 * More informative error message when a filter is not found in path.
12412 * Depend on pandoc-types 1.12.1. This provide `ToJSONFilter`
12413 instances for `Data a => a -> [a]` and `Data a => a -> IO [a]`.
12415 * Don't use unicode_collation in building OSX package:
12416 it adds something like 50MB of dependencies to the package.
12418 * Declare alex and happy as build-tools (#986).
12420## pandoc 1.12 (2013-09-15)
12422### New features
12424 * Much more flexible metadata, including arbitrary fields and structured
12425 values. Metadata can be specified flexibly in pandoc markdown using
12426 YAML metadata blocks, which may occur anywhere in the document:
12428 ---
12429 title: Here is my title.
12430 abstract: |
12431 This is the abstract.
12433 1. It can contain
12434 2. block content
12435 and *inline markup*
12437 tags: [cat, dog, animal]
12438 ...
12440 Metadata fields automatically populate template variables.
12442 * Added `opml` (OPML) as input and output format. The `_note` attribute,
12443 used in OmniOutliner and supported by multimarkdown, is supported.
12444 We treat the contents as markdown blocks under a section header.
12446 * Added `haddock` (Haddock markup) as input format (David Lazar).
12448 * Added `revealjs` output format, for reveal.js HTML 5 slide shows.
12449 (Thanks to Jamie F. Olson for the initial patch.)
12450 Nested vertical stacks are used for hierarchical structure.
12451 Results for more than one level of nesting may be odd.
12453 * Custom writers can now be written in lua.
12455 pandoc -t data/sample.lua
12457 will load the script sample.lua and use it as a custom writer.
12458 (For a sample, do `pandoc --print-default-data-file sample.lua`.)
12459 Note that pandoc embeds a lua interpreter, so lua need not be
12460 installed separately.
12462 * New `--filter/-F` option to make it easier to run "filters"
12463 (Pandoc AST transformations that operate on JSON serializations).
12464 Filters are always passed the name of the output format, so their
12465 behavior can be tailored to it. The repository
12466 <https://github.com/jgm/pandocfilters> contains
12467 a python module for writing pandoc filters in python, with
12468 a number of examples.
12470 * Added `--metadata/-M` option.
12471 This is like `--variable/-V`, but actually adds to metadata, not
12472 just variables.
12474 * Added `--print-default-data-file` option, which allows printing
12475 of any of pandoc's data files. (For example,
12476 `pandoc --print-default-data-file reference.odt` will print
12477 `reference.odt`.)
12479 * Added syntax for "pauses" in slide shows:
12481 This gives
12483 . . .
12485 me pause.
12487 * New markdown extensions:
12489 + `ignore_line_breaks`: causes intra-paragraph line breaks to be ignored,
12490 rather than being treated as hard line breaks or spaces. This is useful
12491 for some East Asian languages, where spaces aren't used between words,
12492 but text is separated into lines for readability.
12493 + `yaml_metadata_block`: Parse YAML metadata blocks. (Default.)
12494 + `ascii_identifiers`: This will force `auto_identifiers` to use ASCII
12495 only. (Default for `markdown_github`.) (#807)
12496 + `lists_without_preceding_blankline`: Allow lists to start without
12497 preceding blank space. (Default for `markdown_github`.) (#972)
12499### Behavior changes
12501 * `--toc-level` no longer implies `--toc`.
12502 Reason: EPUB users who don't want a visible TOC may still want
12503 to set the TOC level for in the book navigation.
12505 * `--help` now prints in and out formats in alphabetical order, and
12506 says something about PDF output (#720).
12508 * `--self-contained` now returns less verbose output (telling you
12509 which URLs it is fetching, but not giving the full header). In
12510 addition, there are better error messages when fetching a URL fails.
12512 * Citation support is no longer baked in to core pandoc. Users who
12513 need citations will need to install and use a separate filter
12514 (`--filter pandoc-citeproc`). This filter will take `bibliography`,
12515 `csl`, and `citation-abbreviations` from the metadata, though it
12516 may still be specified on the command line as before.
12518 * A `Cite` element is now created in parsing markdown whether or not
12519 there is a matching reference.
12521 * The `pandoc-citeproc` script will put the bibliography at the
12522 end of the document, as before. However, it will be put inside a `Div`
12523 element with class "references", allowing users some control
12524 over the styling of references. A final header, if any, will
12525 be included in the `Div`.
12527 * The markdown writer will not print a bibliography if the
12528 `citations` extension is enabled. (If the citations are formatted
12529 as markdown citations, it is redundant to have a bibliography,
12530 since one will be generated automatically.)
12532 * Previously we used to store the directory of the first input file,
12533 even if it was local, and used this as a base directory for finding
12534 images in ODT, EPUB, Docx, and PDF. This has been confusing to many
12535 users. So we now look for images relative to the current
12536 working directory, even if the first file argument is in another
12537 directory. Note that this change may break some existing workflows.
12538 If you have been assuming that relative links will be interpreted
12539 relative to the directory of the first file argument, you'll need
12540 to make that the current directory before running pandoc. (#942)
12542 * Better error reporting in some readers, due to changes in `readWith`:
12543 the line in which the error occurred is printed, with a caret pointing
12544 to the column.
12546 * All slide formats now support incremental slide view for definition lists.
12548 * Parse `\(..\)` and `\[..\]` as math in MediaWiki reader.
12549 Parse `:<math>...</math>` as display math. These notations are used with
12550 the MathJax MediaWiki extension.
12552 * All writers: template variables are set automatically from metadata
12553 fields. However, variables specified on the command line with
12554 `--variable` will completely shadow metadata fields.
12556 * If `--variable` is used to set many variables with the same name,
12557 a list is created.
12559 * Man writer: The `title`, `section`, `header`, and `footer` can now
12560 all be set individually in metadata. The `description` variable has been
12561 removed. Quotes have been added so that spaces are allowed in the
12562 title. If you have a title that begins
12564 COMMAND(1) footer here | header here
12566 pandoc will still parse it into a title, section, header, and
12567 footer. But you can also specify these elements explicitly (#885).
12569 * Markdown reader
12571 + Added support for YAML metadata blocks, which can come anywhere
12572 in the document (not just at the beginning). A document can contain
12573 multiple YAML metadata blocks.
12574 + HTML span and div tags are parsed as pandoc Span and Div elements.
12576 * Markdown writer
12578 + Allow simple tables to be printed as grid tables,
12579 if other table options are disabled. This means you can do
12580 `pandoc -t markdown-pipe_tables-simple_tables-multiline_tables`
12581 and all tables will render as grid tables.
12582 + Support YAML title block (render fields in alphabetical order
12583 to make output predictable).
12585### API changes
12587 * `Meta` in `Text.Pandoc.Definition` has been changed to allow
12588 structured metadata. (Note: existing code that pattern-matches
12589 on `Meta` will have to be revised.) Metadata can now contain
12590 indefinitely many fields, with content that can be a string,
12591 a Boolean, a list of `Inline` elements, a list of `Block`
12592 elements, or a map or list of these.
12594 * A new generic block container (`Div`) has been added to `Block`,
12595 and a generic inline container (`Span`) has been added to `Inline`.
12596 These can take attributes. They will render in HTML, Textile,
12597 MediaWiki, Org, RST and Markdown (with `markdown_in_html`
12598 extension) as HTML `<div>` and `<span>` elements; in other formats
12599 they will simply pass through their contents. But they can be
12600 targeted by scripts.
12602 * `Format` is now a newtype, not an alias for String.
12603 Equality comparisons are case-insensitive.
12605 * Added `Text.Pandoc.Walk`, which exports hand-written tree-walking
12606 functions that are much faster than the SYB functions from
12607 `Text.Pandoc.Generic`. These functions are now used where possible
12608 in pandoc's code. (`Tests.Walk` verifies that `walk` and `query`
12609 match the generic traversals `bottomUp` and `queryWith`.)
12611 * Added `Text.Pandoc.JSON`, which provides `ToJSON` and `FromJSON`
12612 instances for the basic pandoc types. They use GHC generics and
12613 should be faster than the old JSON serialization using
12614 `Data.Aeson.Generic`.
12616 * Added `Text.Pandoc.Process`, exporting `pipeProcess`.
12617 This is a souped-up version of `readProcessWithErrorcode` that
12618 uses lazy bytestrings instead of strings and allows setting
12619 environment variables. (Used in `Text.Pandoc.PDF`.)
12621 * New module `Text.Pandoc.Readers.OPML`.
12623 * New module `Text.Pandoc.Writers.OPML`.
12625 * New module `Text.Pandoc.Readers.Haddock` (David Lazar).
12626 This is based on Haddock's own lexer/parser.
12628 * New module `Text.Pandoc.Writers.Custom`.
12630 * In `Text.Pandoc.Shared`, `openURL` and `fetchItem` now return an
12631 Either, for better error handling.
12633 * Made `stringify` polymorphic in `Text.Pandoc.Shared`.
12635 * Removed `stripTags` from `Text.Pandoc.XML`.
12637 * `Text.Pandoc.Templates`:
12639 + Simplified `Template` type to a newtype.
12640 + Removed `Empty`.
12641 + Changed type of `renderTemplate`: it now takes a JSON context
12642 and a compiled template.
12643 + Export `compileTemplate`.
12644 + Export `renderTemplate'` that takes a string instead of a compiled
12645 template.
12646 + Export `varListToJSON`.
12648 * `Text.Pandoc.PDF` exports `makePDF` instead of `tex2pdf`.
12650 * `Text.Pandoc`:
12652 + Made `toJsonFilter` an alias for `toJSONFilter` from `Text.Pandoc.JSON`.
12653 + Removed `ToJsonFilter` typeclass. `ToJSONFilter` from
12654 `Text.Pandoc.JSON` should be used instead. (Compiling against
12655 pandoc-types instead of pandoc will also produce smaller executables.)
12656 * Removed the deprecated `jsonFilter` function.
12657 + Added `readJSON`, `writeJSON` to the API (#817).
12659 * `Text.Pandoc.Options`:
12661 + Added `Ext_lists_without_preceding_blankline`,
12662 `Ext_ascii_identifiers`, `Ext_ignore_line_breaks`,
12663 `Ext_yaml_metadataBlock` to `Extension`.
12664 + Changed `writerSourceDirectory` to `writerSourceURL` and changed the
12665 type to a `Maybe`. `writerSourceURL` is set to 'Just url' when the
12666 first command-line argument is an absolute URL. (So, relative links
12667 will be resolved in relation to the first page.) Otherwise, 'Nothing'.
12668 + All bibliography-related fields have been removed from
12669 `ReaderOptions` and `WriterOptions`: `writerBiblioFiles`,
12670 `readerReferences`, `readerCitationStyle`.
12672 * The `Text.Pandoc.Biblio` module has been removed. Users of the
12673 pandoc library who want citation support will need to use
12674 `Text.CSL.Pandoc` from `pandoc-citeproc`.
12676### Bug fixes
12678 * In markdown, don't autolink a bare URI that is followed by `</a>`
12679 (#937).
12681 * `Text.Pandoc.Shared`
12683 + `openURL` now follows redirects (#701), properly handles `data:`
12684 URIs, and prints diagnostic output to stderr rather than stdout.
12685 + `readDefaultDataFile`: normalize the paths. This fixes bugs in
12686 `--self-contained` on pandoc compiled with `embed_data_files` (#833).
12687 + Fixed `readDefaultDataFile` so it works on Windows.
12688 + Better error messages for `readDefaultDataFile`. Instead of
12689 listing the last path tried, which can confuse people who are
12690 using `--self-contained`, so now we just list the data file name.
12691 + URL-escape pipe characters. Even though these are legal, `Network.URI`
12692 doesn't regard them as legal in URLs. So we escape them first (#535).
12694 * Mathjax in HTML slide shows: include explicit "Typeset" call.
12695 This seems to be needed for some formats (e.g. slideous) and won't
12696 hurt in others (#966).
12698 * `Text.Pandoc.PDF`
12700 + On Windows, create temdir in working directory, since the system
12701 temp directory path may contain tildes, which can cause
12702 problems in LaTeX (#777).
12703 + Put temporary output directory in `TEXINPUTS` (see #917).
12704 + `makePDF` tries to download images that are not found locally,
12705 if the first argument is a URL (#917).
12706 + If compiling with `pdflatex` yields an encoding error, offer
12707 the suggestion to use `--latex-engine=xelatex`.
12709 * Produce automatic header identifiers in parsing textile, RST,
12710 and LaTeX, unless `auto_identifiers` extension is disabled (#967).
12712 * `Text.Pandoc.SelfContained`: Strip off fragment, query of relative URL
12713 before treating as a filename. This fixes `--self-contained` when used
12714 with CSS files that include web fonts using the method described here:
12715 <http://paulirish.com/2009/bulletproof-font-face-implementation-syntax/>
12716 (#739). Handle `src` in `embed`, `audio`, `source`, `input` tags.
12718 * `Text.Pandoc.Parsing`: `uri` parser no longer treats punctuation before
12719 percent-encoding, or a `+` character, as final punctuation.
12721 * `Text.Pandoc.ImageSize`: Handle EPS (#903). This change will make
12722 EPS images properly sized on conversion to Word.
12724 * Slidy: Use slidy.js rather than slidy.js.gz.
12725 Reason: some browsers have trouble with the gzipped js file,
12726 at least on the local file system (#795).
12728 * Markdown reader
12730 + Properly handle blank line at beginning of input (#882).
12731 + Fixed bug in unmatched reference links. The input
12732 `[*infile*] [*outfile*]` was getting improperly parsed:
12733 "infile" was emphasized, but "*outfile*" was literal (#883).
12734 + Allow internal `+` in citation identifiers (#856).
12735 + Allow `.` or `)` after `#` in ATX headers if no `fancy_lists`.
12736 + Do not generate blank title, author, or date metadata elements.
12737 Leave these out entirely if they aren't present.
12738 + Allow backtick code blocks not to be preceded by blank line (#975).
12740 * Textile reader:
12742 + Correctly handle entities.
12743 + Improved handling of `<pre>` blocks (#927). Remove internal HTML tags
12744 in code blocks, rather than printing them verbatim. Parse attributes
12745 on `<pre>` tag for code blocks.
12747 * HTML reader: Handle non-simple tables (#893). Column widths are read from
12748 `col` tags if present, otherwise divided equally.
12750 * LaTeX reader
12752 + Support alltt environment (#892).
12753 + Support `\textasciitilde`, `\textasciicircum` (#810).
12754 + Treat `\textsl` as emphasized text reader (#850).
12755 + Skip positional options after `\begin{figure}`.
12756 + Support `\v{}` for hacek (#926).
12757 + Don't add spurious ", " to citation suffixes.
12758 This is added when needed in pandoc-citeproc.
12759 + Allow spaces in alignment spec in tables, e.g. `{ l r c }`.
12760 + Improved support for accented characters (thanks to Scott Morrison).
12761 + Parse label after section command and set id (#951).
12763 * RST reader:
12765 + Don't insert paragraphs where docutils doesn't.
12766 `rst2html` doesn't add `<p>` tags to list items (even when they are
12767 separated by blank lines) unless there are multiple paragraphs in the
12768 list. This commit changes the RST reader to conform more closely to
12769 what docutils does (#880).
12770 + Improved metadata. Treat initial field list as metadata when
12771 standalone specified. Previously ALL fields "title", "author",
12772 "date" in field lists were treated as metadata, even if not at
12773 the beginning. Use `subtitle` metadata field for subtitle.
12774 + Fixed 'authors' metadata parsing in reST. Semicolons separate
12775 different authors.
12777 * MediaWiki reader
12779 + Allow space before table rows.
12780 + Fixed regression for `<ref>URL</ref>`.
12781 `<` is no longer allowed in URLs, according to the uri parser
12782 in `Text.Pandoc.Parsing`. Added a test case.
12783 + Correctly handle indented preformatted text without preceding
12784 or following blank line.
12785 + Fixed `|` links inside table cells. Improved attribute parsing.
12786 + Skip attributes on table rows. Previously we just crashed if
12787 rows had attributes, now we ignore them.
12788 + Ignore attributes on headers.
12789 + Allow `Image:` for images (#971).
12790 + Parse an image with caption in a paragraph by itself as a figure.
12792 * LaTeX writer
12794 + Don't use ligatures in escaping inline code.
12795 + Fixed footnote numbers in LaTeX/PDF tables. This fixes a bug
12796 wherein notes were numbered incorrectly in tables (#827).
12797 + Always create labels for sections. Previously the labels were only
12798 created when there were links to the section in the document (#871).
12799 + Stop escaping `|` in LaTeX math.
12800 This caused problems with array environments (#891).
12801 + Change `\` to `/` in paths. `/` works even on Windows in LaTeX.
12802 `\` will cause major problems if unescaped.
12803 + Write id for code block to label attribute in LaTeX when listings
12804 is used (thanks to Florian Eitel).
12805 + Scale LaTeX tables so they don't exceed columnwidth.
12806 + Avoid problem with footnotes in unnumbered headers (#940).
12808 * Beamer writer: when creating beamer slides, add `allowframebreaks` option
12809 to the slide if it is one of the header classes. It is recommended
12810 that your bibliography slide have this attribute:
12812 # References {.allowframebreaks}
12814 This causes multiple slides to be created if necessary, depending
12815 on the length of the bibliography.
12817 * ConTeXt writer: Properly handle tables without captions. The old output
12818 only worked in MkII. This should work in MkIV as well (#837).
12820 * MediaWiki writer: Use native mediawiki tables instead of HTML (#720).
12822 * HTML writer:
12824 + Fixed `--no-highlight` (Alexander Kondratskiy).
12825 + Don't convert to lowercase in email obfuscation (#839).
12826 + Ensure proper escaping in `<title>` and `<meta>` fields.
12828 * AsciiDoc writer:
12830 + Support `--atx-headers` (Max Rydahl Andersen).
12831 + Don't print empty identifier blocks `([[]])` on headers (Max
12832 Rydahl Andersen).
12834 * ODT writer:
12836 + Fixing wrong numbered-list indentation in open document format
12837 (Alexander Kondratskiy) (#369).
12838 + `reference.odt`: Added pandoc as "generator" in `meta.xml`.
12839 + Minor changes for ODF 1.2 conformance (#939). We leave the
12840 nonconforming `contextual-spacing` attribute, which is provided by
12841 LibreOffice itself and seems well supported.
12843 * Docx writer:
12845 + Fixed rendering of display math in lists.
12846 In 1.11 and 1.11.1, display math in lists rendered as a new list
12847 item. Now it always appears centered, just as outside of lists,
12848 and in proper display math style, no matter how far indented the
12849 containing list item is (#784).
12850 + Use `w:br` with `w:type` `textWrapping` for linebreaks.
12851 Previously we used `w:cr` (#873).
12852 + Use Compact style for Plain block elements, to
12853 differentiate between tight and loose lists (#775).
12854 + Ignore most components of `reference.docx`.
12855 We take the `word/styles.xml`, `docProps/app.xml`,
12856 `word/theme/theme1.xml`, and `word/fontTable.xml` from
12857 `reference.docx`, ignoring everything else. This should help
12858 with the corruption problems caused when different versions of
12859 Word resave the reference.docx and reorganize things.
12860 + Made `--no-highlight` work properly.
12862 * EPUB writer
12864 + Don't add `dc:creator` tags if present in EPUB metadata.
12865 + Add `id="toc-title"` to `h1` in `nav.xhtml` (#799).
12866 + Don't put blank title page in reading sequence.
12867 Set `linear="no"` if no title block. Addresses #797.
12868 + Download webtex images and include as data URLs.
12869 This allows you to use `--webtex` in creating EPUBs.
12870 Math with `--webtex` is automatically made self-contained.
12871 + In `data/epub.css`, removed highlighting styles (which
12872 are no longer needed, since styles are added by the HTML
12873 writer according to `--highlighting-style`). Simplified
12874 margin fields.
12875 + If resource not found, skip it, as in Docx writer (#916).
12877 * RTF writer:
12879 + Properly handle characters above the 0000-FFFF range.
12880 Uses surrogate pairs. Thanks to Hiromi Ishii for the patch.
12881 + Fixed regression with RTF table of contents.
12882 + Only autolink absolute URIs. This fixes a regression, #830.
12884 * Markdown writer:
12886 + Only autolink absolute URIs. This fixes a regression, #830.
12887 + Don't wrap attributes in fenced code blocks.
12888 + Write full metadata in MMD style title blocks.
12889 + Put multiple authors on separate lines in pandoc titleblock.
12890 Also, don't wrap long author entries, as new lines get treated
12891 as new authors.
12893 * `Text.Pandoc.Templates`:
12895 + Fixed bug retrieving default template for markdown variants.
12896 + Templates can now contain "record lookups" in variables;
12897 for example, `author.institution` will retrieve the `institution`
12898 field of the `author` variable.
12899 + More consistent behavior of `$for$`. When `foo` is not a list,
12900 `$for(foo)$...$endfor$` should behave like $if(foo)$...$endif$.
12901 So if `foo` resolves to "", no output should be produced.
12902 See pandoc-templates#39.
12904 * Citation processing improvements (now part of pandoc-citeproc):
12906 + Fixed `endWithPunct` The new version correctly sees a sentence
12907 ending in '.)' as ending with punctuation. This fixes a bug which
12908 led such sentences to receive an extra period at the end: '.).'.
12909 Thanks to Steve Petersen for reporting.
12910 + Don't interfere with Notes that aren't citation notes.
12911 This fixes a bug in which notes not generated from citations were
12912 being altered (e.g. first letter capitalized) (#898).
12913 + Only capitalize footnote citations when they have a prefix.
12914 + Changes in suffix parsing. A suffix beginning with a digit gets 'p'
12915 inserted before it before passing to citeproc-hs, so that bare numbers
12916 are treated as page numbers by default. A suffix not beginning with
12917 punctuation has a space added at the beginning (rather than a comma and
12918 space, as was done before for not-author-in-text citations).
12919 The result is that `\citep[23]{item1}` in LaTeX will be interpreted
12920 properly, with '23' treated as a locator of type 'page'.
12921 + Many improvements to citation rendering, due to fixes in citeproc-hs
12922 (thanks to Andrea Rossato).
12923 + Warnings are issued for undefined citations, which are rendered
12924 as `???`.
12925 + Fixed hanging behavior when locale files cannot be found.
12927### Template changes
12929 * DocBook: Use DocBook 4.5 doctype.
12931 * Org: '#+TITLE:' is inserted before the title.
12932 Previously the writer did this.
12934 * LaTeX: Changes to make mathfont work with xelatex.
12935 We need the mathspec library, not just fontspec, for this.
12936 We also need to set options for setmathfont (#734).
12938 * LaTeX: Use `tex-ansi` mapping for `monofont`.
12939 This ensures that straight quotes appear as straight, rather than
12940 being treated as curly. See #889.
12942 * Made `\includegraphics` more flexible in LaTeX template.
12943 Now it can be used with options, if needed. Thanks to Bernhard Weichel.
12945 * LaTeX/Beamer: Added `classoption` variable.
12946 This is intended for class options like `oneside`; it may
12947 be repeated with different options. (Thanks to Oliver Matthews.)
12949 * Beamer: Added `fonttheme` variable. (Thanks to Luis Osa.)
12951 * LaTeX: Added `biblio-style` variable (#920).
12953 * DZSlides: title attribute on title section.
12955 * HTML5: add meta tag to allow scaling by user (Erik Evenson)
12957### Under-the-hood improvements
12959 * Markdown reader:Improved strong/emph parsing, using the strategy of
12960 <https://github.com/jgm/Markdown>. The new parsing algorithm requires
12961 no backtracking, and no keeping track of nesting levels. It will give
12962 different results in some edge cases, but these should not affect normal
12963 uses.
12965 * Added `Text.Pandoc.Compat.Monoid`.
12966 This allows pandoc to compile with `base` < 4.5, where `Data.Monoid`
12967 doesn't export `<>`. Thanks to Dirk Ullirch for the patch.
12969 * Added `Text.Pandoc.Compat.TagSoupEntity`.
12970 This allows pandoc to compile with `tagsoup` 0.13.x.
12971 Thanks to Dirk Ullrich for the patch.
12973 * Most of `Text.Pandoc.Readers.TeXMath` has been moved to the
12974 `texmath` module (0.6.4). (This allows `pandoc-citeproc` to
12975 handle simple math in bibliography fields.)
12977 * Added `Text.Pandoc.Writers.Shared` for shared functions used
12978 only in writers. `metaToJSON` is used in writers to create a
12979 JSON object for use in the templates from the pandoc metadata
12980 and variables. `getField`, `setField`, and `defField` are
12981 for working with JSON template contexts.
12983 * Added `Text.Pandoc.Asciify` utility module.
12984 This exports functions to create ASCII-only versions of identifiers.
12986 * `Text.Pandoc.Parsing`
12988 + Generalized state type on `readWith` (API change).
12989 + Specialize readWith to `String` input. (API change).
12990 + In `ParserState`, replace `stateTitle`, `stateAuthors`, `stateDate`
12991 with `stateMeta` and `stateMeta'`.
12993 * `Text.Pandoc.UTF8`: use strict bytestrings in reading. The use of lazy
12994 bytestrings seemed to cause problems using pandoc on 64-bit Windows
12995 7/8 (#874).
12997 * Factored out `registerHeader` from markdown reader, added to
12998 `Text.Pandoc.Parsing`.
13000 * Removed `blaze_html_0_5` flag, require `blaze-html` >= 0.5.
13001 Reason: < 0.5 does not provide a monoid instance for Attribute,
13002 which is now needed by the HTML writer (#803).
13004 * Added `http-conduit` flag, which allows fetching https resources.
13005 It also brings in a large number of dependencies (`http-conduit`
13006 and its dependencies), which is why for now it is an optional flag
13007 (#820).
13009 * Added CONTRIBUTING.md.
13011 * Improved INSTALL instructions.
13013 * `make-windows-installer.bat`: Removed explicit paths for executables.
13015 * `aeson` is now used instead of `json` for JSON.
13017 * Set default stack size to 16M. This is needed for some large
13018 conversions, esp. if pandoc is compiled with 64-bit ghc.
13020 * Various small documentation improvements.
13021 Thanks to achalddave and drothlis for patches.
13023 * Removed comment that chokes recent versions of CPP (#933).
13025 * Removed support for GHC version < 7.2, since pandoc-types now
13026 requires at least GHC 7.2 for GHC generics.
13029## pandoc 1.11.1 (2013-03-17)
13031 * Markdown reader:
13033 + Fixed regression in which parentheses were lost in link URLs.
13034 Added tests. Closes #786.
13035 + Better handling of unmatched double quotes in `--smart` mode.
13036 These occur frequently in fiction, since it is customary not to
13037 close quotes in dialogue if the speaker does not change between
13038 paragraphs. The unmatched quotes now get turned into literal
13039 left double quotes. (No `Quoted` inline is generated, however.)
13040 Closes #99 (again).
13042 * HTML writer: Fixed numbering mismatch between TOC and sections.
13043 `--number-offset` now affects TOC numbering as well
13044 as section numbering, as it should have all along. Closes #789.
13046 * Markdown writer: Reverted 1.11 change that caused citations to be rendered
13047 as markdown citations, even if `--bibliography` was specified, unless
13048 `citation` extension is disabled. Now, formatted citations are always
13049 printed if `--bibliography` was specified. If you want to reformat
13050 markdown keeping pandoc markdown citations intact, don't use
13051 `--bibliography`. Note that citations parsed from LaTeX documents will
13052 be rendered as pandoc markdown citations when `--bibliography` is not
13053 specified.
13055 * ODT writer: Fixed regression leading to corrupt ODTs.
13056 This was due to a change in the `Show` instance for
13057 `Text.Pandoc.Pretty.Doc`. Closes #780.
13059 * Fixed spacing bugs involving code block attributes in
13060 RST reader and Markdown writer. Closes #763.
13062 * Windows package: Various improvements due to Fyodor Sheremetyev.
13064 + Automatically set installation path (Program Files or Local App Data).
13065 + Set system PATH environment variable when installing for all users.
13066 + Pandoc can installed for all users using the following command.
13067 `msiexec /i pandoc-1.11.msi ALLUSERS=1`.
13069 * Bumped QuickCheck version bound.
13071## pandoc 1.11 (2013-03-09)
13073 * Added `--number-offset` option. (See README for description.)
13075 * Added `--default-image-extension` option. (See README for description.)
13077 * `--number-sections` behavior change: headers with class `unnumbered`
13078 will not be numbered.
13080 * `--version` now reports the default data directory.
13082 * `Text.Pandoc.Parsing` is no longer exposed. (API change.)
13084 * `Text.Pandoc.Highlighting` is no longer exposed. (API change.)
13086 * `Text.Pandoc.Shared`: Changed type of `Element`. `Sec` now includes
13087 a field for `Attr` rather than just `String`. (API change.)
13089 * Added `markdown_github` as input format. This was an accidental
13090 omission in 1.10.
13092 * Added `readerDefaultImageExtension` field to `ReaderOptions`. (API
13093 change.)
13095 * Added `writerNumberOffset` field in `WriterOptions`. (API change.)
13097 * Beamer template:
13099 + Fixed captions with longtable. Thanks to Joost Kremers.
13100 + Provide `\Oldincludegraphics` as in LaTeX template (Benjamin Bannier).
13102 * LaTeX template:
13104 + Load microtype after fonts. Microtype needs to know
13105 what fonts are being used. Thanks to dfc for the patch.
13106 + Set `secnumdepth` to 5 if `--number-sections` specified.
13107 This yields behavior equivalent to the other writers, numbering
13108 level 4 and 5 headers too. Closes #753.
13110 * HTML reader:
13112 + Handle `<colgroup>` tag.
13113 + Preserve all header attributes.
13115 * LaTeX reader:
13117 + Parse `\hrule` as `HorizontalRule`. Closes #746.
13118 + Parse starred variants of `\section` etc. as headers with
13119 attribute `unnumbered`.
13120 + Read optional attributes in `lstlisting` and `Verbatim` environments.
13121 We convert these to pandoc standard names, e.g. `numberLines`
13122 for `numbers=left`, `startFrom=100` from `firstnumber=100`.
13123 + Handle language attribute for lstlistings.
13124 + Better support for Verbatim and minted environments. Closes #763.
13126 * Markdown reader:
13128 + `-` in an attribute context = `.unnumbered`. The point of this
13129 is to provide a way to specify unnumbered headers in non-English
13130 documents.
13131 + Fixed bug parsing key/value attributes. Parsing failed if you
13132 had an unquoted attribute immediately before the final '}'.
13133 + Make backslash escape work in attributes.
13134 + Fix title block parsing. Now if `mmd_title_blocks` is specified,
13135 pandoc will parse a MMD title block if it sees one, even if
13136 `pandoc_title_blocks` is enabled.
13137 + Refactoring: `litChar` now includes entities, so we don't need
13138 to use `fromEntities` e.g. on titles.
13139 + Allow spaces around borders in pipe tables. Closes #772.
13140 + Allow all punctuation in angle-bracket autolinks. Previously
13141 things like `----` were disallowed, because the uri parser
13142 treated them as trailing punctuation. Closes #768.
13143 + Make `implicit_header_references` work properly when
13144 headers are given explicit identifiers.
13145 + Check for tables before line blocks. Otherwise some pipe
13146 tables get treated as line blocks.
13147 + Allow `&` in emails (for entities).
13148 + Properly handle entities in titles and links. A markdown link
13149 `<http://g&ouml;ogle.com>` should be a link to `http://göogle.com`.
13150 Closes #723.
13152 * Textile reader:
13154 + Handle attributes on headers.
13156 * LaTeX reader:
13158 + Add `fig:` as title for images with captions.
13159 This is needed for them to be rendered as figures. Closes #766.
13160 + Never emit an empty paragraph. See #761.
13161 + Handle `\caption` for images in figures. Closes #766.
13162 + Parse `\section*`, etc. as unnumbered sections.
13164 * HTML writer:
13166 + Support header attributes. The attributes go on
13167 the enclosing `section` or `div` tag if `--section-divs` is specified.
13168 + Fixed a regression (only now noticed) in html+lhs output.
13169 Previously the bird tracks were being omitted.
13171 * LaTeX writer:
13173 + Omit lists with no items to avoid LaTeX errors.
13174 + Support line numbering with `--listings`.
13175 If `numberLines` class is present, we add `numbers=left`;
13176 if `startFrom` is present, we add `firstnumber=`. (#763)
13178 * ConTeXt writer:
13180 + Removed `\placecontent`. This produced a duplicate toc,
13181 in conjunction with `\placelist`.
13182 + Use `\title`, `\subject` etc. for headers with
13183 `unnumbered` class.
13185 * Textile writer:
13187 + Support header attributes.
13189 * Markdown writer:
13191 + Use grid tables when needed, and if enabled. Closes #740.
13192 + Render citations as pandoc-markdown citations.
13193 Previously citations were rendered as citeproc-formatted citations
13194 by default. Now we render them as pandoc citations, e.g. `[@item1]`,
13195 unless the `citations` extension is disabled.
13196 If you still want formatted citations in your markdown output,
13197 use `pandoc -t markdown-citations`.
13199 * RST writer:
13201 + Support `:number-lines:` in code blocks.
13203 * Docx writer:
13205 + Better treatment of display math. Display math inside a
13206 paragraph is now put in a separate paragraph, so it will render
13207 properly (centered and without extra blank lines around it).
13208 Partially addresses #742.
13209 + Content types and document rels xml files are now created from
13210 scratch, rather than being taken over from `reference.docx`.
13211 This fixes problems that arise when you edit the `reference.docx`
13212 with Word.
13213 + We also now encode mime types for each individual image rather
13214 than using defaults. This should allow us to handle a wider
13215 range of image types (including PDF). Closes #414.
13216 + Changed style names in `reference docx`.
13217 `FootnoteReference` -> `FootnoteRef`, `Hyperlink` -> `Link`.
13218 The old names got changed by Word when the `reference.docx` was
13219 edited. Closes #414.
13221 * EPUB writer:
13223 + Fix section numbering. Previously the numbering restarted from 1
13224 in each chapter (with `--number-sections`), though the numbers in
13225 the table of contents were correct.
13226 + Headers with "unnumbered" attribute are not numbered. (Nor do they
13227 cause an increment in running numbering.) Section numbers now work
13228 properly, even when there is material before the first numbered section.
13229 + Include HTML TOC, even in epub2. The TOC is included in `<spine>`,
13230 but `linear` is set to `no` unless the `--toc` option is specified.
13231 Include `<guide>` element in OPF. This should allow the TOC to
13232 be useable in Kindles when converted with kindlegen. Closes #773.
13234 * `Text.Pandoc.Parsing`: Optimized `oneOfStringsCI`.
13235 This dramatically reduces the speed penalty that comes from enabling the
13236 `autolink_bare_uris` extension. The penalty is still substantial (in one
13237 test, from 0.33s to 0.44s), but nowhere near what it used to be.
13238 The RST reader is also much faster now, as it autodetects URIs.
13240 * `Text.Pandoc.Shared`: `hierarchicalize` will not number section
13241 with class "unnumbered". Unnumbered sections get `[]` for their
13242 section number.
13244 * `Text.Pandoc.Pretty`:
13246 + Fixed `chomp` so it works inside `Prefixed` elements.
13247 + Changed `Show` instance so it is better for debugging.
13249 * `Text.Pandoc.ImageSize`: Added `Pdf` to `ImageType`.
13251 * `Text.Pandoc.UTF8`: Strip off BOM if present. Closes #743.
13253 * Windows installer improvements:
13255 + The installer is now signed with a certificate (thanks to
13256 Fyodor Sheremetyev).
13257 + WiX is used instead of InnoSetup. The installer is now a
13258 standard msi file.
13259 + The version number is now auto-detected, and need not be
13260 updated separately.
13262 * OSX installer improvements:
13264 + The package and pandoc executable are now signed with a
13265 certificate (thanks to Fyodor Sheremetyev).
13266 + RTF version of license is used.
13267 + Use full path for sysctl in `InstallationCheck` script (jonahbull).
13268 Closes #580.
13270 * Converted COPYING to markdown.
13272 * pandoc.cabal: Require latest versions of highlighting-kate,
13273 texmath, citeproc-hs, zip-archive.
13275## pandoc 1.10.1 (2013-01-23)
13277 * Markdown reader: various optimizations, leading to a
13278 significant performance boost.
13280 * RST reader: Allow anonymous form of inline links:
13281 `` `hello <url>`__ `` Closes #724.
13283 * Mediawiki reader: Don't require newlines after tables.
13284 Thanks to jrunningen for the patch. Closes #733.
13286 * Fixed LaTeX macro parsing. Now LaTeX macro definitions are preserved
13287 when output is LaTeX, and applied when it is another format.
13288 Partially addresses #730.
13290 * Markdown and RST readers: Added parser to `block` that skips blank
13291 lines. This fixes a subtle regression involving grid tables with
13292 empty cells. Also added test for grid table with empty cells.
13293 Closes #732.
13295 * RST writer: Use `.. code:: language` for code blocks with language.
13296 Closes #721.
13298 * DocBook writer: Fixed output for hard line breaks, adding a newline
13299 between `<literallayout>` tags.
13301 * Markdown writer: Use an autolink when link text matches url.
13302 Previously we also checked for a null title, but this
13303 test fails for links produced by citeproc-hs in bibliographies.
13304 So, if the link has a title, it will be lost on conversion
13305 to an autolink, but that seems okay.
13307 * Markdown writer: Set title, author, date variables as before.
13308 These are no longer used in the default template, since we use
13309 titleblock, but we set them anyway for those who use custom templates.
13311 * LaTeX writer: Avoid extra space at start/end of table cell.
13312 Thanks to Nick Bart for the suggestion of using @{}.
13314 * `Text.Pandoc.Parsing`:
13316 + More efficient version of `anyLine`.
13317 + Type of `macro` has changed; the parser now returns `Blocks`
13318 instead of `Block`.
13320 * Relaxed old-time version bound, allowing 1.0.*.
13322 * Removed obsolete `hsmarkdown` script. Those who need `hsmarkdown`
13323 should create a symlink as described in the README.
13325## pandoc 1.10.0.5 (2013-01-23)
13327 * Markdown reader: Try `lhsCodeBlock` before `rawTeXBlock`. Otherwise
13328 `\begin{code}...\end{code}` isn't handled properly in markdown+lhs.
13329 Thanks to Daniel Miot for noticing the bug and suggesting the fix.
13331 * Markdown reader: Fixed bug with headerless grid tables.
13332 The 1.10 code assumed that each table header cell contains exactly one
13333 block. That failed for headerless tables (0) and also for tables with
13334 multiple blocks in a header cell. The code is fixed and tests provided.
13335 Thanks to Andrew Lee for pointing out the bug.
13337 * Markdown reader: Fixed regressions in fenced code blocks. Closes #722.
13339 + Tilde code fences can again take a bare language string
13340 (`~~~ haskell`), not just curly-bracketed attributes
13341 (`~~~ {.haskell}`).
13342 + Backtick code blocks can take the curly-bracketed attributes.
13343 + Backtick code blocks don't *require* a language.
13344 + Consolidated code for the two kinds of fenced code blocks.
13346 * LaTeX template: Use `\urlstyle{same}` to avoid monospace URLs.
13348 * Markdown writer: Use proportional font for email autolinks with
13349 obfuscation. Closes #714.
13351 * Corrected name of `blank_before_blockquote` in README. Closes #718.
13353 * `Text.Pandoc.Shared`: Fixed bug in `uri` parser.
13354 The bug prevented an autolink at the end of a string (e.g.
13355 at the end of a line block line) from counting as a link. Closes #711.
13357 * Use the `hsb2hs` preprocessor instead of TH for embed_data_files.
13358 This should work on Windows, unlike the TH solution with
13359 file-embed.
13361 * Eliminated use of TH in test suite.
13363 * Added `Text.Pandoc.Data` (non-exported) to hold the association
13364 list of embedded data files, if the `embed_data_files` flag is selected.
13365 This isolates the code that needs special treatment with file-embed or
13366 `hsb2hs`.
13368 * Changes to `make-windows-installer.bat`.
13370 + Exit batch file if any of the cabal-dev installs fail.
13371 + There's no longer any need to reinstall `highlighting-kate`.
13372 + Don't start with a `cabal update`; leave that to the user.
13373 + Force reinstall of pandoc.
13375 * Fixed EPUB writer so it builds with blaze-html 0.4.x. Thanks to
13376 Jens Petersen.
13378## pandoc 1.10.0.4 (2013-01-20)
13380 * Fixed bug with escaped % in LaTeX reader. Closes #710.
13382## pandoc 1.10.0.3 (2013-01-20)
13384 * Added further missing fb2 tests to cabal file.
13386## pandoc 1.10.0.2 (2013-01-20)
13388 * Added fb2 tests to cabal file's extra-source-files.
13390## pandoc 1.10.0.1 (2013-01-20)
13392 * Bump version bounds on test-framework packages.
13394## pandoc 1.10 (2013-01-19)
13396### New features
13398 * New input formats: `mediawiki` (MediaWiki markup).
13400 * New output formats: `epub3` (EPUB v3 with MathML),
13401 `fb2` (FictionBook2 ebooks).
13403 * New `--toc-depth` option, specifying how many levels of
13404 headers to include in a table of contents.
13406 * New `--epub-chapter-level` option, specifying the header
13407 level at which to divide EPUBs into separate files.
13408 Note that this normally affects only performance, not the
13409 visual presentation of the EPUB in a reader.
13411 * Removed the `--strict` option. Instead of using `--strict`,
13412 one can now use the format name `markdown_strict` for either input
13413 or output. This gives more fine-grained control that `--strict`
13414 did, allowing one to convert from pandoc's markdown to strict
13415 markdown or vice versa.
13417 * It is now possible to enable or disable specific syntax
13418 extensions by appending them (with `+` or `-`) to the writer
13419 or reader name. For example,
13421 pandoc -f markdown-footnotes+hard_line_breaks
13423 disables footnotes and enables treating newlines as hard
13424 line breaks. The literate Haskell extensions are now implemented
13425 this way as well, using either `+lhs` or `+literate_haskell`.
13426 For a list of extension names, see the README under
13427 "Pandoc's Markdown."
13429 * The following aliases have been introduced for specific
13430 combinations of markdown extensions: `markdown_phpextra`,
13431 `markdown_github`, `markdown_mmd`, `markdown_strict`. These aliases
13432 work just like regular reader and writer names, and can be modified
13433 with extension modifiers as described above. (Note that conversion
13434 from one markdown dialect to another does not work perfectly,
13435 because there are differences in markdown parsers besides
13436 just the extensions, and because pandoc's internal document model is
13437 not rich enough to capture all of the extensions.)
13439 * New `--html-q-tags` option. The previous default was to use `<q>`
13440 tags for smart quotes in HTML5. But `<q>` tags are also valid HTML4.
13441 Moreover, they are not a robust way of typesetting quotes, since
13442 some user agents don't support them, and some CSS resets (e.g.
13443 bootstrap) prevent pandoc's quotes CSS from working properly.
13444 We now just insert literal quote characters by default in both
13445 `html` and `html5` output, but this option is provided for
13446 those who still want `<q>` tags.
13448 * The markdown reader now prints warnings (to stderr) about
13449 duplicate link and note references. Closes #375.
13451 * Markdown syntax extensions:
13453 + Added pipe tables. Thanks to François Gannaz for the initial patch.
13454 These conform to PHP Markdown Extra's pipe table syntax. A subset
13455 of org-mode table syntax is also supported, which means that you can
13456 use org-mode's nice table editor to create tables.
13458 + Added support for RST-style line blocks. These are
13459 useful for verse and addresses.
13461 + Attributes can now be specified for headers, using the same
13462 syntax as in code blocks. (However, currently only the
13463 identifier has any effect in most writers.) For example,
13465 # My header {#foo}
13467 See [the header above](#foo).
13469 + Pandoc will now act as if link references have been defined
13470 for all headers without explicit identifiers.
13471 So, you can do this:
13473 # My header
13475 Link to [My header].
13476 Another link to [it][My header].
13478 Closes #691.
13480 * LaTeX reader:
13482 + Command macros now work everywhere, including non-math.
13483 Environment macros still not supported.
13484 + `\input` now works, as well as `\include`. TEXINPUTS is used.
13485 Pandoc looks recursively into included files for more included files.
13487### Behavior changes
13489 * The Markdown reader no longer puts the text of autolinks in a
13490 `Code` inline. This means that autolinks will no longer appear
13491 in a monospace font.
13493 * The character `/` can now appear in markdown citation keys.
13495 * HTML blocks in strict_markdown are no longer required to begin
13496 at the left margin. Technically this is required, according to
13497 the markdown syntax document, but `Markdown.pl` and other markdown
13498 processors are more liberal.
13500 * The `-V` option has been changed so that if there are duplicate
13501 variables, those specified later on the command line take precedence.
13503 * Tight lists now work in LaTeX and ConTeXt output.
13505 * The LaTeX writer no longer relien on the `enumerate` package.
13506 Instead, it uses standard LaTeX commands to change the list numbering
13507 style.
13509 * The LaTeX writer now uses `longtable` instead of `ctable`. This allows
13510 tables to be split over page boundaries.
13512 * The RST writer now uses a line block to render paragraphs containing
13513 linebreaks (which previously weren't supported at all).
13515 * The markdown writer now applies the `--id-prefix` to footnote IDs.
13516 Closes #614.
13518 * The plain writer no longer uses backslash-escaped line breaks
13519 (which are not very "plain").
13521 * `Text.Pandoc.UTF8`: Better error message for invalid UTF8.
13522 Read bytestring and use `Text`'s decodeUtf8 instead of using
13523 `System.IO.hGetContents`. This way you get a message saying
13524 "invalid UTF-8 stream" instead of "invalid byte sequence."
13525 You are also told which byte caused the problem.
13527 * Docx, ODT, and EPUB writers now download images specified by a URL
13528 instead of skipping them or raising an error.
13530 * EPUB writer:
13532 + The default CSS now left-aligns headers by default, instead of
13533 centering. This is more consistent with the rest of the writers.
13534 + A proper multi-level table of contents is now used in `toc.ncx`.
13535 There is no longer a subsidiary table of contents at the beginning
13536 of each chapter.
13537 + Code highlighting now works by default.
13538 + Section divs are used by default for better semantic markup.
13539 + The title is used instead of "Title Page" in the table of contents.
13540 Otherwise we have a hard-coded English string, which looks
13541 strange in ebooks written in other languages. Closes #572.
13543 * HTML writer:
13545 + Put mathjax in span with class "math". Closes #562.
13546 + Put citations in a span with class "citation." In HTML5, also include
13547 a `data-cite` attribute with a space-separated list of citation
13548 keys.
13550 * `Text.Pandoc.UTF8`: use universalNewlineMode in reading.
13551 This treats both `\r\n` and `\n` as `\n` on input, no matter
13552 what platform we're running on.
13554 * Citation processing is now done in the Markdown and LaTeX
13555 readers, not in `pandoc.hs`. This makes it easier for library users
13556 to use citations.
13558### Template changes
13560 * HTML: Added css to template to preserve spaces in `<code>` tags.
13561 Thanks to Dirk Laurie.
13563 * Beamer: Remove English-centric strings in section pages.
13564 Section pages used to have "Section" and a number as well as the
13565 section title. Now they just have the title. Similarly for part
13566 and subsection. Closes #566.
13568 * LaTeX, ConTeXt: Added papersize variable.
13570 * LaTeX, Beamer templates: Use longtable instead of ctable.
13572 * LaTeX, Beamer templates: Don't require 'float' package for tables.
13573 We don't actually seem to use the '[H]' option.
13575 * Markdown, plain: Fixed titleblock so it is just a single string.
13576 Previously separate title, author, and date variables were used,
13577 but this didn't allow different kinds of title blocks.
13579 * EPUB:
13581 + Rationalized templates. Previously there were three different
13582 templates involved in epub production. There is now just one
13583 template, `default.epub` or `default.epub3`. It can now be
13584 overridden using `--template`, just like other templates.
13585 The titlepage is now folded into the default template.
13586 A `titlepage` variable selects it.
13587 + UTF-8, lang tag, meta tags, title element.
13589 * Added scale-to-width feature to beamer template
13591### API changes
13593 * `Text.Pandoc.Definition`: Added `Attr` field to `Header`.
13594 Previously header identifiers were autogenerated by the writers.
13595 Now they are added in the readers (either automatically or explicitly).
13597 * `Text.Pandoc.Builder`:
13599 + `Inlines` and `Blocks` are now synonyms for `Many Inline` and
13600 `Many Block`. `Many` is a newtype wrapper around `Seq`, with
13601 custom Monoid instances for `Many Inline` and `Many Block. This
13602 allows `Many` to be made an instance of `Foldable` and `Traversable`.
13603 + The old `Listable` class has been removed.
13604 + The module now exports `isNull`, `toList`, `fromList`.
13605 + The old `Read` and `Show` instances have been removed; derived
13606 instances are now used.
13607 + Added `headerWith`.
13609 * The readers now take a `ReaderOptions` rather than a `ParserState`
13610 as a parameter. Indeed, not all parsers use the `ParserState` type;
13611 some have a custom state. The motivation for this change was to separate
13612 user-specifiable options from the accounting functions of parser state.
13614 * New module `Text.Pandoc.Options`. This includes the `WriterOptions`
13615 formerly in `Text.Pandoc.Shared`, and its associated
13616 data types. It also includes a new type `ReaderOptions`, which
13617 contains many options formerly in `ParserState`, and its associated
13618 data types:
13620 + `ParserState.stateParseRaw` -> `ReaderOptions.readerParseRaw`.
13621 + `ParserState.stateColumns` -> `ReaderOptions.readerColumns`.
13622 + `ParserState.stateTabStop` -> `ReaderOptions.readerTabStop`.
13623 + `ParserState.stateOldDashes` -> `ReaderOptions.readerOldDashes`.
13624 + `ParserState.stateLiterateHaskell` -> `ReaderOptions.readerLiterateHaskell`.
13625 + `ParserState.stateCitations` -> `ReaderOptions.readerReferences`.
13626 + `ParserState.stateApplyMacros` -> `ReaderOptions.readerApplyMacros`.
13627 + `ParserState.stateIndentedCodeClasses` ->
13628 `ReaderOptions.readerIndentedCodeClasses`.
13629 + Added `ReaderOptions.readerCitationStyle`.
13631 * `WriterOptions` now includes `writerEpubVersion`, `writerEpubChapterLevel`,
13632 `writerEpubStylesheet`, `writerEpubFonts`, `writerReferenceODT`,
13633 `writerReferenceDocx`, and `writerTOCDepth`. `writerEPUBMetadata` has
13634 been renamed `writerEpubMetadata` for consistency.
13636 * Changed signatures of `writeODT`, `writeDocx`, `writeEPUB`, since they no
13637 longer stylesheet, fonts, reference files as separate parameters.
13639 * Removed `writerLiterateHaskell` from `WriterOptions`, and
13640 `readerLiterateHaskell` from `ReaderOptions`. LHS is now handled
13641 by an extension (`Ext_literate_haskell`).
13643 * Removed deprecated `writerXeTeX`.
13645 * Removed `writerStrict` from `WriterOptions`. Added `writerExtensions`.
13646 Strict is now handled through extensions.
13648 * `Text.Pandoc.Options` exports `pandocExtensions`, `strictExtensions`,
13649 `phpMarkdownExtraExtensions`, `githubMarkdownExtensions`,
13650 and `multimarkdownExtensions`, as well as the `Extensions` type.
13652 * New `Text.Pandoc.Readers.MediaWiki` module, exporting
13653 `readMediaWiki`.
13655 * New `Text.Pandoc.Writers.FB2` module, exporting `writeFB2`
13656 (thanks to Sergey Astanin).
13658 * `Text.Pandoc`:
13660 + Added `getReader`, `getWriter` to `Text.Pandoc`.
13661 + `writers` is now an association list `(String, Writer)`.
13662 A `Writer` can be a `PureStringWriter`, an `IOStringWriter`, or
13663 an `IOByteStringWriter`. ALL writers are now in the 'writers'
13664 list, including the binary writers and FB2 writer. This allows
13665 code in `pandoc.hs` to be simplified.
13666 + Changed type of `readers`, so all readers are in IO.
13667 Users who want pure readers can still get them form the reader
13668 modules; this just affects the function `getReader` that looks up
13669 a reader based on the format name. The point of this change is to
13670 make it possible to print warnings from the parser.
13672 * `Text.Pandoc.Parsing`:
13674 + `Text.Parsec` now exports all Parsec functions used in pandoc code.
13675 No other module directly imports Parsec. This will make it easier
13676 to change the parsing backend in the future, if we want to.
13677 + `Text.Parsec` is used instead of `Text.ParserCombinators.Parsec`.
13678 + Export the type synonym `Parser`.
13679 + Export `widthsFromIndices`, `NoteTable'`, `KeyTable'`, `Key'`, `toKey'`,
13680 `withQuoteContext`, `singleQuoteStart`, `singleQuoteEnd`,
13681 `doubleQuoteStart`, `doubleQuoteEnd`, `ellipses`, `apostrophe`,
13682 `dash`, `nested`, `F(..)`, `askF`, `asksF`, `runF`, `lineBlockLines`.
13683 + `ParserState` is no longer an instance of `Show`.
13684 + Added `stateSubstitutions` and `stateWarnings` to `ParserState`.
13685 + Generalized type of `withQuoteContext`.
13686 + Added `guardEnabled`, `guardDisabled`, `getOption`.
13687 + Removed `failIfStrict`.
13688 + `lookupKeySrc` and `fromKey` are no longer exported.
13690 * `Data.Default` instances are now provided for `ReaderOptions`,
13691 `WriterOptions`, and `ParserState`. `Text.Pandoc` re-exports `def`.
13692 Now you can use `def` (which is re-exported by `Text.Pandoc`) instead
13693 of `defaultWriterOptions` (which is still defined). Closes #546.
13695 * `Text.Pandoc.Shared`:
13697 + Added `safeRead`.
13698 + Renamed `removedLeadingTrailingSpace` to `trim`,
13699 `removeLeadingSpace` to `triml`, and `removeTrailingSpace` to `trimr`.
13700 + Count `\r` as space in `trim` functions.
13701 + Moved `renderTags'` from HTML reader and `Text.Pandoc.SelfContained`
13702 to `Shared`.
13703 + Removed `failUnlessLHS`.
13704 + Export `compactify'`, formerly in Markdown reader.
13705 + Export `isTightList`.
13706 + Do not export `findDataFile`.
13707 + `readDataFile` now returns a strict ByteString.
13708 + Export `readDataFileUTF8` which returns a String, like the
13709 old `readDataFile`.
13710 + Export `fetchItem` and `openURL`.
13712 * `Text.Pandoc.ImageSize`: Use strict, not lazy bytestrings.
13713 Removed `readImageSize`.
13715 * `Text.Pandoc.UTF8`: Export `encodePath`, `decodePath`,
13716 `decodeArg`, `toString`, `fromString`, `toStringLazy`,
13717 `fromStringLazy`.
13719 * `Text.Pandoc.UTF8` is now an exposed module.
13721 * `Text.Pandoc.Biblio`:
13723 + csl parameter now a `String` rather than a `FilePath`.
13724 + Changed type of `processBiblio`. It is no longer in the IO monad.
13725 It now takes a `Maybe Style` argument rather than parameters for CSL
13726 and abbrev filenames. (`pandoc.hs` now calls the functions to parse
13727 the style file and add abbreviations.)
13729 * Markdown reader now exports `readMarkdownWithWarnings`.
13731 * `Text.Pandoc.RTF` now exports `writeRTFWithEmbeddedImages` instead of
13732 `rtfEmbedImage`.
13734### Bug fixes
13736 * Make `--ascii` work properly with `--self-contained`. Closes #568.
13738 * Markdown reader:
13740 + Fixed link parser to avoid exponential slowdowns. Closes #620.
13741 Previously the parser would hang on input like this:
13743 [[[[[[[[[[[[[[[[[[hi
13745 We fixed this by making the link parser parser characters
13746 between balanced brackets (skipping brackets in inline code spans),
13747 then parsing the result as an inline list. One change is that
13749 [hi *there]* bud](/url)
13751 is now no longer parsed as a link. But in this respect pandoc behaved
13752 differently from most other implementations anyway, so that seems okay.
13754 + Look for raw html/latex blocks before tables.
13755 Otherwise the following gets parsed as a table:
13757 \begin{code}
13758 --------------
13759 -- My comment.
13760 \end{code}
13762 Closes #578.
13764 * RST reader:
13766 + Added support for `:target:` on `.. image::` blocks
13767 and substitutions.
13768 + Field list fixes:
13770 - Fixed field lists items with body beginning after a new line
13771 (Denis Laxalde).
13772 - Allow any char but ':' in names of field lists in RST reader
13773 (Denis Laxalde).
13774 - Don't allow line breaks in field names.
13775 - Require whitespace after field list field names.
13776 - Don't create empty definition list for metadata field lists.
13777 Previously a field list consisting only of metadata fields (author,
13778 title, date) would be parsed as an empty DefinitionList, which is
13779 not legal in LaTeX and not needed in any format.
13781 + Don't recognize inline-markup starts inside words.
13782 For example, `2*2 = 4*1` should not contain an emphasized
13783 section. Added test case for "Literal symbols". Closes #569.
13784 + Allow dashes as separator in simple tables. Closes #555.
13785 + Added support for `container`, `compound`, `epigraph`,
13786 `rubric`, `highlights`, `pull-quote`.
13787 + Added support for `.. code::`.
13788 + Made directive labels case-insensitive.
13789 + Removed requirement that directives begin at left margin.
13790 This was (correctly) not in earlier releases; docutils doesn't
13791 make the requirement.
13792 + Added support for `replace::` and `unicode::` substitutions.
13793 + Ignore unknown interpreted roles.
13794 + Renamed image parser to `subst`, since it now handles all
13795 substitution references.
13797 * Textile reader:
13799 + Allow newlines before pipes in table. Closes #654.
13800 + Fixed bug with list items containing line breaks.
13801 Now pandoc correctly handles hard line breaks inside list items.
13802 Previously they broke list parsing.
13803 + Implemented comment blocks.
13804 + Fixed bug affected words ending in hyphen.
13805 + Properly handle links with surrounding brackets.
13806 Square brackets need to be used when the link isn't surrounded by
13807 spaces or punctuation, or when the URL ending may be ambiguous.
13808 Closes #564.
13809 + Removed nullBlock. Better to know about parsing problems than
13810 to skip stuff when we get stuck.
13811 + Allow ID attributes on headers.
13812 + Textile reader: Avoid parsing dashes as strikeout.
13813 Previously the input
13815 text--
13816 text--
13817 text--
13818 text--
13820 would be parsed with strikeouts rather than dashes. This fixes
13821 the problem by requiring that a strikeout delimiting - not be
13822 followed by a -. Closes #631.
13823 + Expanded list of `stringBreakers`.
13824 This fixes a bug on input like "(_hello_)" which should
13825 be a parenthesized emphasized "hello".
13826 The new list is taken from the PHP source of textile 2.4.
13827 + Fixed autolinks. Previously the textile reader and writer
13828 incorrectly implented RST-style autolinks for URLs and email
13829 addresses. This has been fixed. Now an autolink is done this way:
13830 `"$":http://myurl.com`.
13831 + Fixed footnotes bug in textile. This affected notes occurring
13832 before punctuation, e.g. `foo[1].`. Closes #518.
13834 * LaTeX reader:
13836 + Better handling of citation commands.
13837 + Better handling of `\noindent`.
13838 + Added a 'try' in rawLaTeXBlock, so we can handle `\begin` without `{`.
13839 Closes #622.
13840 + Made `rawLaTeXInline` try to parse block commands as well. This
13841 is usually what we want, given how `rawLaTeXInline` is used in
13842 the markdown and textile readers. If a block-level LaTeX command
13843 is used in the middle of a paragraph (e.g. `\subtitle` inside a title),
13844 we can treat it as raw inline LaTeX.
13845 + Handle `\slash` command. Closes #605.
13846 + Basic `\enquote` support.
13847 + Fixed parsing of paragraphs beginning with a group. Closes #606.
13848 + Use curly quotes for bare straight quotes.
13849 + Support obeylines environment. Closes #604.
13850 + Guard against "begin", "end" in inlineCommand and
13851 blockCommand.
13852 + Better error messages for environments. Now it should tell you that
13853 it was looking for \end{env}, instead of giving "unknown parse error."
13855 * HTML reader:
13857 + Added HTML 5 tags to list of block-level tags.
13858 + HTML reader: Fixed bug in `htmlBalanced`, which
13859 caused hangs in parsing certain markdown input using
13860 strict mode.
13861 + Parse `<q>` as `Quoted DoubleQuote`.
13862 + Handle nested `<q>` tags properly.
13863 + Modified `htmlTag` for fewer false positives.
13864 A tag must start with `<` followed by `!`,`?`, `/`, or a letter.
13865 This makes it more useful in the wikimedia and markdown parsers.
13867 * DocBook reader: Support title in "figure" element. Closes #650.
13869 * MediaWiki writer:
13871 + Remove newline after `<br/>` in translation of `LineBreak`
13872 There's no particular need for a newline (other than making the
13873 generated MediaWiki source look nice to a human), and in fact
13874 sometimes it is incorrect: in particular, inside an enumeration, list
13875 items cannot have embedded newline characters. (Brent Yorgey)
13876 + Use `<code>` not `<tt>` for Code.
13878 * Man writer: Escape `-` as `\-`.
13879 Unescaped `-`'s become hyphens, while `\-`'s are left as ascii minus
13880 signs. That is preferable for use with command-line options. See
13881 <http://lintian.debian.org/tags/hyphen-used-as-minus-sign.html>. Thanks
13882 to Andrea Bolognani for bringing the issue to our attention.
13884 * RST writer:
13886 + Improved line block output. Use nonbreaking spaces for
13887 initial indent (otherwise lost in HTML and LaTeX).
13888 Allow multiple paragraphs in a single line block.
13889 Allow soft breaks w continuations in line blocks.
13890 + Properly handle images with no alt text. Closes #678.
13891 + Fixed bug with links with duplicate text. We now (a) use anonymous
13892 links for links with inline URLs, and (b) use an inline link instead
13893 of a reference link if the reference link would require a label that
13894 has already been used for a different link. Closes #511.
13895 + Fixed hyperlinked images. Closes #611. Use `:target:`
13896 field when you have a simple linked image.
13897 + Don't add `:align: center` to figures.
13899 * Texinfo writer: Fixed internal cross-references.
13900 Now we insert anchors after each header, and use `@ref` instead of `@uref`
13901 for links. Commas are now escaped as `@comma{}` only when needed;
13902 previously all commas were escaped. (This change is needed, in part,
13903 because `@ref` commands must be followed by a real comma or period.) Also
13904 insert a blank line in from of `@verbatim` environments.
13906 * DocBook writer:
13908 + Made --id-prefix work in DocBook as well as HTML.
13909 Closes #607.
13910 + Don't include empty captions in figures. Closes #581.
13912 * LaTeX writer:
13914 + Use `\hspace*` for nonbreaking space after line break,
13915 since `~` spaces after a line break are just ignored.
13916 Closes #687.
13917 + Don't escape `_` in URLs or hyperref identifiers.
13918 + Properly escape strings inside `\url{}`. Closes #576.
13919 + Use `[fragile]` only for slides containing code rendered
13920 using listings. Closes #649.
13921 + Escape `|` as `\vert` in LaTeX math. This avoids a clash with
13922 highlighting-kate's macros, which redefine `|` as a short verbatim
13923 delimiter. Thanks to Björn Peemöller for raising this issue.
13924 + Use minipage rather than parbox for block containers in tables.
13925 This allows verbatim code to be included in grid tables.
13926 Closes #663.
13927 + Prevent paragraphs containing only linebreaks or spaces.
13929 * HTML writer:
13931 + Included `highlighting-css` for code spans, too.
13932 Previously it was only included if used in a code block. Closes #653.
13933 + Improved line breaks with `<dd>` tags. We now put a newline between
13934 `</dd>` and `<dd>` when there are multiple definitions.
13935 + Changed mathjax cdn url so it doesn't use https. (This caused
13936 problems when used with `--self-contained`.) See #609.
13938 * EPUB writer:
13940 + `--number-sections` now works properly.
13941 + Don't strip meta and link elements in epub metadata.
13942 Patch from aberrancy. Closes #589.
13943 + Fixed a couple validation bugs.
13944 + Use ch001, ch002, etc. for chapter filenames. This improves sorting
13945 of chapters in some readers, which apparently sort ch2 after ch10.
13946 Closes #610.
13948 * ODT writer: properly set title property (Arlo O'Keeffe).
13950 * Docx writer:
13952 + Fixed bug with nested lists. Previously a list like
13954 1. one
13955 - a
13956 - b
13957 2. two
13959 would come out with a bullet instead of "2."
13960 Thanks to Russell Allen for reporting the bug.
13961 + Use `w:cr` in `w:r` instead of `w:br` for linebreaks.
13962 This seems to fix a problem viewing pandoc-generated
13963 docx files in LibreOffice.
13964 + Use integer ids for bookmarks. Closes #626.
13965 + Added nsid to abstractNum elements. This helps when merging
13966 word documents with numbered or bulleted lists. Closes #627.
13967 + Use separate footnotes.xml for notes.
13968 This seems to help LibreOffice convert the file, even though
13969 it was valid docx before. Closes #637.
13970 + Use rIdNN identifiers for r:embed in images.
13971 + Avoid reading image files again when we've already processed them.
13972 + Fixed typo in `referenc.docx` that prevented image captions from
13973 working. Thanks to Huashan Chen.
13975 * `Text.Pandoc.Parsing`:
13977 + Fixed bug in `withRaw`, which didn't correctly handle the case
13978 where nothing is parsed.
13979 + Made `emailAddress` parser more correct. Now it is based on RFC 822,
13980 though it still doesn't implement quoted strings in email addresses.
13981 + Revised URI parser. It now allows many more schemes, allows
13982 uppercase URIs, and better handles trailing punctuation and
13983 trailing slashes in bare URIs. Added many tests.
13984 + Simplified and improved singleQuoteStart. This makes `'s'`, `'l'`,
13985 etc. parse properly. Formerly we had some English-centric heuristics,
13986 but they are no longer needed. Closes #698.
13988 * `Text.Pandoc.Pretty`: Added wide punctuation range to `charWidth`.
13989 This fixes bug with Chinese commas in markdown and reST tables, and
13990 a bug that caused combining characters to be dropped.
13992 * `Text.Pandoc.MIME`: Added MIME types for .wof and .eot. Closes #640.
13994 * `Text.Pandoc.Biblio`:
13996 + Run `mvPunc` and `deNote` on metadata too.
13997 This fixed a bug with notes on titles using footnote styles.
13998 + Fixed bug in fetching CSL files from CSL data directory.
14000 * `pandoc.hs`: Give correct value to `writerSourceDirectory` when a URL
14001 is provided. It should be the URL up to the path.
14003 * Fixed/simplified diff output for tests.
14004 Biblio: Make sure mvPunc and deNote run on metadata too.
14005 This fixed a bug with notes on titles using footnote styles.
14007### Under the hood improvements
14009 * We no longer depend on `utf8-string`. Instead we use functions
14010 defined in `Text.Pandoc.UTF8` that use `Data.Text`'s conversions.
14012 * Use `safeRead` instead of using `reads` directly (various modules).
14014 * "Implicit figures" (images alone in a paragraph) are now handled
14015 differently. The markdown reader gives their titles the prefix `fig:`; the
14016 writers look for this before treating the image as a figure. Though this
14017 is a bit of a hack, it has two advantages: (i) implicit figures can be
14018 limited to the markdown reader, and (ii) they can be deactivated by turning
14019 off the `implicit_figures` extension.
14021 * `catch` from `Control.Exception` is now used instead of the
14022 old Preface `catch`.
14024 * `Text.Pandoc.Shared`: Improved algorithm for `normalizeSpaces`
14025 and `oneOfStrings` (which is now non-backtracking).
14027 * `Text.Pandoc.Biblio`: Remove workaround for `toCapital`.
14028 Now citeproc-hs is fixed upstream, so this is no longer needed.
14029 Closes #531.
14031 * Textile reader: Improved speed of `hyphenedWords`.
14032 This speeds up the textile reader by about a factor of 4.
14034 * Use `Text.Pandoc.Builder` in RST reader, for more flexibility,
14035 better performance, and automatic normalization.
14037 * Major rewrite of markdown reader:
14039 + Use `Text.Pandoc.Builder` instead of lists. This also
14040 means that everything is normalized automatically.
14041 + Move to a one-pass parsing strategy, returning values in the reader
14042 monad, which are then run (at the end of parsing) against the final
14043 parser state.
14045 * In HTML writer, we now use `toHtml` instead of pre-escaping.
14046 We work around the problem that blaze-html unnecessarily escapes `'`
14047 by pre-escaping just the `'` characters, instead of the whole string.
14048 If blaze-html later stops escaping `'` characters, we can simplify
14049 `strToHtml` to `toHtml`. Closes #629.
14051 * Moved code for embedding images in RTFs from `pandoc.hs` to the
14052 RTF writer (which now exports `writeRTFWithEmbeddedImages`).
14054 * Moved citation processing from `pandoc.hs` into the readers.
14055 This makes things more convenient for library users.
14057 * The man pages are now built by an executable `make-pandoc-man-pages`,
14058 which has its own stanza in the cabal file so that dependencies can be
14059 handled by Cabal. Special treatment in `Setup.hs` ensures that this
14060 executable never gets installed; it is only used to create the man pages.
14062 * The cabal file has been modified so that the pandoc library is used
14063 in building the pandoc executable. (This required moving `pandoc.hs`
14064 from `src` to `.`.) This cuts compile time in half.
14066 * The `executable` and `library` flags have been removed.
14068 * `-threaded` has been removed from ghc-options.
14070 * Version bounds of dependencies have been raised, and the
14071 `blaze_html_0_5` flag now defaults to True. Pandoc now compiles on
14072 GHC 7.6.
14074 * We now require base >= 4.2.
14076 * Integrated the benchmark program into cabal. One can now do:
14078 cabal configure --enable-benchmarks && cabal build
14079 cabal bench --benchmark-option='markdown' --benchmark-option='-s 20'
14081 The benchmark now uses README + testsuite, so benchmark results
14082 from older versions aren't comparable.
14084 * Integrated test suite with cabal.
14085 To run tests, configure with `--enable-tests`, then `cabal test`.
14086 You can specify particular tests using `--test-options='-t markdown'`.
14087 No output is shown unless tests fail. The Haskell test modules
14088 have been moved from `src/` to `tests/`.
14090 * Moved all data files and templates to the `data/` subdirectory.
14092 * Added an `embed_data_files` cabal flag. This causes all
14093 data files to be embedded in the binary, so that the binary
14094 is self-sufficient and can be relocated anywhere, copied on
14095 a USB key, etc. The Windows installer now uses this.
14096 (Since we no longer have the option to build the executable
14097 without the library, this is the only way to get a relocatable
14098 binary on Windows.)
14100 * Removed pcre3.dll from windows package.
14101 It isn't needed unless highlighting-kate is compiled with the
14102 `pcre-light` flag. By default, regex-prce-builtin is used.
14105## pandoc 1.9.4.5 (2012-10-21)
14107 * Raised version bounds on network, base64-bytestring, json,
14108 and template-haskell.
14110## pandoc 1.9.4.4 (2012-10-20)
14112 * Removed `tests` flag and made test suite into a proper cabal
14113 test suite, which can now be enabled using `--enable-tests`
14114 and run with `cabal test`.
14116 * Moved man page creation out of `Setup.hs` and into an
14117 executable built by Cabal, but never installed. This
14118 allows dependencies to be specified, and solves a problem
14119 with 1.9.4.3, which could only be installed if `data-default`
14120 had already been installed.
14122 * Updated `lhs-latex.tex` test for latest highlighting-kate
14123 representation of backticks.
14125## pandoc 1.9.4.3 (2012-10-20)
14127 * Removed `-threaded` from default compile flags.
14129 * Modified modules to compile with GHC 7.6 and latest version of time
14130 package.
14132## pandoc 1.9.4.2 (2012-06-29)
14134 * Don't encode/decode file paths if base >= 4.4.
14135 Prior to base 4.4, filepaths and command line arguments were treated
14136 as unencoded lists of bytes, not unicode strings, so we had to work
14137 around that by encoding and decoding them. This commit adds CPP
14138 checks for the base version that intelligibly enable encoding/decoding
14139 when needed. Fixes a bug with multilingual filenames when pandoc was
14140 compiled with ghc 7.4 (#540).
14142 * Don't generate an empty H1 after hrule slide breaks.
14143 We now use a slide-level header with contents `[Str "\0"]` to mark
14144 an hrule break. This avoids creation of an empty H1 in these
14145 contexts. Closes #484.
14147 * Docbook reader: Added support for "bold" emphasis. Thanks to mb21.
14149 * In make_osx_package.sh, ensure citeproc-hs is built with the
14150 embed_data_files flag.
14152 * MediaWiki writer: Avoid extra blank lines after sublists (Gavin Beatty).
14154 * ConTeXt writer: Don't escape `&`, `^`, `<`, `>`, `_`,
14155 simplified escapes for `}` and `{` to `\{` and `\}` (Aditya Mahajan).
14157 * Fixed handling of absolute URLs in CSS imports with `--self-contained`.
14158 Closes #535.
14160 * Added webm to mime types. Closes #543.
14162 * Added some missing exports and tests to the cabal file
14163 (Alexander V Vershilov).
14165 * Compile with `-rtsopts` and `-threaded` by default.
14167## pandoc 1.9.4.1 (2012-06-08)
14169 * Markdown reader: Added `cf.` and `cp.` to list of likely abbreviations.
14171 * LaTeX template: Added `linkcolor`, `urlcolor` and `links-as-notes`
14172 variables. Make TOC links black.
14174 * LaTeX template improvements.
14176 + Don't print date unless one is given explicitly in the document.
14177 + Simplified templates.
14178 + Use fontenc [T1] by default, and lmodern.
14179 + Use microtype if available.
14181 * Biblio:
14183 + Add comma to beginning of bare suffix, e.g. `@item1 [50]`.
14184 Motivation: `@item1 [50]` should be as close as possible to
14185 `[@item1, 50]`.
14186 + Added workaround for a bug in citeproc-hs 0.3.4 that causes footnotes
14187 beginning with a citation to be empty. Closes #531.
14189 * Fixed documentation on mixed lists. Closes #533.
14191## pandoc 1.9.4 (2012-06-03)
14193 * Simplified `Text.Pandoc.Biblio` and fixed bugs with citations inside
14194 footnotes and captions. We now handle note citations by inserting
14195 footnotes during initial citation processing, and doing a separate
14196 pass later to remove notes inside notes.
14198 * Added 'zenburn' highlight style from highlighting-kate.
14200 * Added Slideous writer. Slideous is an HTML + javascript slide show
14201 format, similar to Slidy, but works with IE 7. (Jonas Smedegaard)
14203 * LaTeX writer:
14205 + Ensure we don't have extra blank lines at ends of cells.
14206 This can cause LaTeX errors, as they are interpreted as new paragraphs.
14207 + More consistent interblock spacing.
14208 + Require highlighting-kate >= 0.5.1, for proper highlighted inline
14209 code in LaTeX. Closes #527.
14210 + Ensure that a Verbatim at the end of a footnote is followed by
14211 a newline. (Fixes a regression in the previous version.)
14212 + In default template, use black for internal links and TOC.
14213 Added commented-out code to use footnotes for links, as would
14214 be suitable in print output.
14216 * Beamer writer: When `--incremental` is used, lists inside
14217 a block quote should appear all at once. (This makes Beamer
14218 output consistent with the HTML slide show formats.)
14220 * ConTeXt writer:
14222 + Escape `%` as `\letterpercent{}` not `\letterpercent `,
14223 to avoid gobbling spaces after the `%` sign.
14224 + Ensure space after `\stopformula`.
14226 * Markdown writer:
14228 + Use `:` form instead of `~` in definition lists, for better
14229 compatibility with other markdown implementations.
14230 + Don't wrap the term, because it breaks definition lists.
14231 + Use a nonzero space to prevent false recognition
14232 of list marker in ordered lists. Closes #516.
14234 * Org writer: Add space before language name. Closes #523.
14236 * Docx writer: Simplified bullet characters so they work properly
14237 with Word 2007. Closes #520.
14239 * LaTeX reader: Support `\centerline`.
14241 * RST reader: handle figures. Closes #522.
14243 * Textile reader: fix for `<notextile>` and `==`. Closes #517.
14244 (Paul Rivier)
14246## pandoc 1.9.3 (2012-05-12)
14248 * Added docbook reader (with contributions from Mauro Bieg).
14250 * Fixed bug in `fromEntities`. The previous version would turn
14251 `hi & low you know;` into `hi &`.
14253 * HTML reader:
14255 + Don't skip nonbreaking spaces.
14256 Previously a paragraph containing just `&nbsp;` would be rendered
14257 as an empty paragraph. Thanks to Paul Vorbach for pointing out the bug.
14258 + Support `<col>` and `<caption>` in tables. Closes #486.
14260 * Markdown reader:
14262 + Don't recognize references inside delimited code blocks.
14263 + Allow list items to begin with lists.
14265 * LaTeX reader:
14267 + Handle `\bgroup`, `\egroup`, `\begingroup`, `\endgroup`.
14268 + Control sequences can't be followed by a letter.
14269 This fixes a bug where `\begingroup` was parsed as `\begin`
14270 followed by `group`.
14271 + Parse 'dimension' arguments to unknown commands. e.g. `\parindent0pt`
14272 + Make `\label` and `\ref` sensitive to `--parse-raw`.
14273 If `--parse-raw` is selected, these will be parsed as raw latex
14274 inlines, rather than bracketed text.
14275 + Don't crash on unknown block commands (like `\vspace{10pt}`)
14276 inside `\author`; just skip them. Closes #505.
14278 * Textile reader:
14280 + Implemented literal escapes with `==` and `<notextile>`. Closes #473.
14281 + Added support for LaTeX blocks and inlines (Paul Rivier).
14282 + Better conformance to RedCloth inline parsing (Paul Rivier).
14283 + Parse '+text+' as emphasized (should be underlined, but this
14284 is better than leaving literal plus characters in the output.
14286 * Docx writer: Fixed multi-paragraph list items. Previously they each
14287 got a list marker. Closes #457.
14289 * LaTeX writer:
14291 + Added `--no-tex-ligatures` option to avoid replacing
14292 quotation marks and dashes with TeX ligatures.
14293 + Use `fixltx2e` package to provide `\textsubscript`.
14294 + Improve spacing around LaTeX block environments:
14295 quote, verbatim, itemize, description, enumerate.
14296 Closes #502.
14297 + Use blue instead of pink for URL links in latex/pdf output.
14299 * ConTeXt writer: Fixed escaping of `%`.
14300 In text, `%` needs to be escaped as `\letterpercent`, not `\%`
14301 Inside URLs, `%` needs to be escaped as `\%`
14302 Thanks to jmarca and adityam for the fix. Closes #492.
14304 * Texinfo writer: Escape special characters in node titles.
14305 This fixes a problem pointed out by Joost Kremers. Pandoc used
14306 to escape an '@' in a chapter title, but not in the corresponding
14307 node title, leading to invalid texinfo.
14309 * Fixed document encoding in texinfo template.
14310 Resolves Debian Bug #667816.
14312 * Markdown writer:
14314 + Don't force delimited code blocks to be flush left.
14315 Fixes bug with delimited code blocks inside lists etc.
14316 + Escape `<` and `$`.
14318 * LaTeX writer: Use `\hyperref[ident]{text}` for internal links.
14319 Previously we used `\href{\#ident}{text}`, which didn't work on
14320 all systems. Thanks to Dirk Laurie.
14322 * RST writer: Don't wrap link references. Closes #487.
14324 * Updated to use latest versions of blaze-html, mtl.
14327## pandoc 1.9.2 (2012-04-05)
14329 * LaTeX reader:
14331 + Made `lstlisting` work as a proper verbatim environment.
14332 + Fixed bug parsing LaTeX tables with one column.
14334 * LaTeX writer:
14336 + Use `{}` around `ctable` caption, so that formatting can be used.
14337 + Don't require eurosym package unless document has a €.
14339 * LaTeX template: Added variables for `geometry`, `romanfont`,
14340 `sansfont`, `mathfont`, `mainfont` so users can more easily
14341 customize fonts.
14343 * PDF writer:
14345 + Run latex engine at least two times, to ensure
14346 that PDFs will have hyperlinked bookmarks.
14347 + Added PDF metadata (title,author) in LaTeX standalone + PDF output.
14349 * Texinfo writer: retain directories in image paths. (Peter Wang)
14351 * RST writer: Better handling of inline formatting, in accord
14352 with docutils' "inline markup recognition rules" (though we don't
14353 implement the unicode rules fully). Now `hi*there*hi` gets
14354 rendered properly as `hi\ *there*\ hi`, and unnecessary
14355 `\ ` are avoided around `:math:`, `:sub:`, `:sup:`.
14357 * RST reader:
14359 + Parse `\ ` as null, not escaped space.
14360 + Allow `` :math:`...` `` even when not followed by blank
14361 or `\`. This does not implement the complex rule docutils follows,
14362 but it should be good enough for most purposes.
14363 + Add support for the rST default-role directive. (Greg Maslov)
14365 * Text.Pandoc.Parsing: Added `stateRstDefaultRole` field to `ParserState`.
14366 (Greg Maslov)
14368 * Markdown reader: Properly handle citations nested in other inline
14369 elements.
14371 * Markdown writer: don't replace empty alt in image with "image".
14373 * DZSlides: Updated template.html and styles in default template.
14374 Removed bizarre CSS for `q` in dzslides template.
14376 * Avoid repeated `id` attribute in section and header in HTML slides.
14378 * README improvements: new instructions on internal links,
14379 removed misleading note on reST math.
14381 * Build system:
14383 + Fixed Windows installer so that dzslides works.
14384 + Removed stripansi.sh.
14385 + Added .travis.yml for Travis continuous integration support..
14386 + Fixed upper bound for zlib (Sergei Trofimovich).
14387 + Fixed upper bound for test-framework.
14388 + Updated haddocks for haddock-2.10 (Sergei Trofimovich).
14391## pandoc 1.9.1.2 (2012-03-09)
14393 * Added `beamer+lhs` as output format.
14395 * Don't escape `<` in `<style>` tags with `--self-contained`.
14396 This fixes a bug which prevented highlighting from working
14397 when using `--self-contained`.
14399 * PDF: run latex engine three times if `--toc` specified.
14400 This fixes page numbers in the table of contents.
14402 * Docx writer: Added TableNormal style to tables.
14404 * LaTeX math environment fixes. `aligned` is now used instead of
14405 the nonexistent `aligned*`. `multline` instead of the nonexistent
14406 `multiline`.
14408 * LaTeX writer: Use `\textasciitilde` for literal `~`.
14410 * HTML writer: Don't escape contents of EQ tags with --gladtex.
14411 This fixes a regression from 1.8.
14413 * Use `<q>` tags for Quoted items for HTML5 output.
14414 The quote style can be changed by modifying the template
14415 or including a css file. A default quote style is included.
14417 * LaTeX reader: Fixed accents (\~{a}, `\c{c}`).
14418 Correctly handle \^{}. Support "minted" as a LaTeX verbatim block.
14420 * Updated LaTeX template for better language support.
14421 Use `polyglossia` instead of `babel` with xetex.
14422 Set `lang` as documentclass option.
14423 `\setmainlanguage` will use the last of a comma-separated
14424 list of languages. Thanks to François Gannaz.
14426 * Fixed default LaTeX template so `\euro` and `€` work. The
14427 `eurosym` package is needed if you are using pdflatex.
14429 * Fixed escaping of period in man writer (thanks to Michael Thompson).
14431 * Fixed list label positions in beamer.
14433 * Set `mainlang` variable in context writer.
14434 This parallels behavior of latex writer. `mainlang` is the last
14435 of a comma-separated list of languages in lang.
14437 * EPUB language metadat: convert e.g. `en_US` from locale to `en-US`.
14439 * Changed `-V` so that you can specify a key without a value.
14440 Such keys get the value `true`.
14442 * Fixed permissions on installed man pages - thanks Magnus Therning.
14444 * Windows installer: require XP or higher. The installer is
14445 now compiled on a Windows 7 machine, which fixes a problem
14446 using citation functions on Windows 7.
14448 * OSX package: Check for 64-bit Intel CPU before installing.
14451## pandoc 1.9.1.1 (2012-02-11)
14453 * Better handling of raw latex environments in markdown. Now
14455 \begin{equation}
14456 a_1
14457 \end{equation}
14459 turns into a raw latex block as expected.
14461 * Improvements to LaTeX reader:
14463 + Skip options after block commands.
14464 + Correctly handle `{\\}` in braced.
14465 + Added a needed 'try'.
14466 + Citations: add `, ` to suffix if it doesn't start with space or
14467 punctuation. Otherwise we get no space between the year and the
14468 suffix in author-date styles.
14470 * Added two needed data files for S5. This fixes a problem with
14471 `pandoc -t s5 --self-contained`. Also removed `slides.min.js`,
14472 which was no longer being used.
14474 * Fixed some minor problems in `reference.docx`:
14475 name on "Date" style, `xCs` instead of `xIs`.
14477 * Fixed a problem creating docx files using a reference docx
14478 modified using Word. The problem seems to be that Word
14479 modifies `_rels/.rels`, changing the Type of the Relationship to
14480 `docProps/core.xml`. Pandoc now changes this back to the correct
14481 value if it has been altered, fixing the problem.
14483 * Fixed html5 template so it works properly with highlighting.
14485## pandoc 1.9.1 (2012-02-09)
14487 * LaTeX reader:
14489 + Fixed regression in 1.9; properly handle escaped $ in latex math.
14490 + Put LaTeX verse environments in blockquotes.
14492 * Markdown reader:
14494 + Limit nesting of strong/emph. This avoids exponential lookahead
14495 in parasitic cases, like `a**a*a**a*a**a*a**a*a**a*a**a*a**a*a**`.
14496 + Improved attributes syntax (in code blocks/spans): (1)
14497 Attributes can contain line breaks. (2) Values in key-value
14498 attributes can be surrounded by either double or single quotes, or
14499 left unquoted if they contain no spaces.
14501 * Headers no longer wrap in markdown or RST writers.
14503 * Added `stateMaxNestingLevel` to `ParserState`.
14504 We set this to 6, so you can still have `Emph` inside `Emph`,
14505 just not indefinitely.
14507 * More efficient implementation of `nowrap` in `Text.Pandoc.Pretty`.
14509 * `Text.Pandoc.PDF`: Only run latex twice if `\tableofcontents`
14510 is present.
14512 * Require highlighting-kate >= 0.5.0.2, texmath >= 0.6.0.2.
14514## pandoc 1.9.0.5 (2012-02-06)
14516 * Changed cabal file so that build-depends for the test program
14517 are not required unless the tests flag is used.
14519 * LaTeX writer: insert `{}` between adjacent hyphens so they don't
14520 form ligatures (dashes) in code spans.
14522## pandoc 1.9.0.4 (2012-02-06)
14524 * Raised version bound on test-framework to avoid problems
14525 compiling tests on GHC 7.4.1.
14527 * LaTeX reader: Use raw LaTeX as fallback inline text for Cites,
14528 so citations don't just disappear unless you process with
14529 citeproc. Ignore `\bibliographystyle`, `\nocite`.
14531 * Simplified tex2pdf; it will always run latex twice to
14532 resolve table of contents and hyperrefs.
14534## pandoc 1.9.0.3 (2012-02-06)
14536 * Require Cabal >= 1.10.
14538 * Tweaked cabal file to meet Cabal 1.10 requirements.
14540## pandoc 1.9.0.2 (2012-02-05)
14542 * Allow build with json 0.4 or 0.5. Otherwise we can't build with
14543 ghc 6.12.
14545## pandoc 1.9 (2012-02-05)
14547### New features
14549 * Added a Microsoft Word `docx` writer. The writer includes support
14550 for highlighted code and for math (which is converted from TeX to OMML,
14551 Office's native math markup language, using texmath's new OMML module).
14552 A new option `--reference-docx` allows the user to customize the
14553 styles.
14555 * Added an `asciidoc` writer (<http://www.methods.co.nz/asciidoc/>).
14557 * Better support for slide shows:
14559 + Added a `dzslides` writer. DZSlides is a lightweight HTML5/javascript
14560 slide show format due to Paul Rouget (<http://paulrouget.com/dzslides/>).
14562 + Added a LaTeX `beamer` writer. Beamer is a LaTeX package for creating
14563 slide presentations.
14565 + New, flexible rules for dividing documents into sections and slides
14566 (see the "Structuring the slide show" in the User's Guide). These
14567 are backward-compatible with the old rules, but they allow slide
14568 shows to be organized into sections and subsections containing
14569 multiple slides.
14571 + A new `--slide-level` option allows users to override defaults
14572 and select a slide level below the first header level with content.
14574 * A new `--self-contained` option produces HTML output that does not
14575 depend on an internet connection or the presence of any external
14576 files. Linked images, CSS, and javascript is downloaded (or fetched
14577 locally) and encoded in `data:` URIs. This is useful for making portable
14578 `HTML slide shows. The --offline` option has been deprecated and is now
14579 `treated as a synonym or --self-contained`.
14581 * Support for PDF output:
14583 + Removed the old `markdown2pdf`.
14584 + `pandoc` can now create PDFs (assuming you have latex and a set of
14585 appropriate packages installed): just specify an output file with the
14586 `.pdf` extension.
14587 + A new option `--latex-engine` allows you to specify `pdflatex`,
14588 `xelatex`, or `lualatex` as the processor.
14590 * Highlighting changes:
14592 + Syntax highlighting is now a standard feature; the `highlighting`
14593 flag is no longer needed when compiling.
14594 + A new `--no-highlight` option allows highlighting to be disabled.
14595 + Highlighting now works in `docx`, `latex`, and `epub`, as well as
14596 `html`, `html5`, `dzslides`, `s5`, and `slidy`.
14597 + A new `--highlight-style` option selects between various highlighting
14598 color themes.
14600 * Internal links to sections now work in ConTeXt and LaTeX as well as HTML.
14602 * LaTeX `\include` and `\usepackage` commands are now processed,
14603 provided the files are in the working directory.
14605 * EPUB improvements:
14607 + Internal and external links now work in EPUB.
14608 + Raw HTML is allowed.
14609 + New `--epub-embed-font` option.
14610 + Customizable templates for EPUB pages offer more control over
14611 formatting: `epub-page.html`, `epub-coverimage.html`,
14612 `epub-titlepage.html`.
14614 * `--mathml` now works with DocBook.
14616 * Added support for math in RST reader and writer. Inline math uses the
14617 `` :math:`...` `` construct. Display math uses
14619 .. math:: ...
14621 or if the math is multiline,
14623 .. math::
14625 ...
14627 These constructions are now supported now by `rst2latex.py`.
14629 * Github syntax for fenced code blocks is supported in pandoc's
14630 markdown. You can now write
14632 ```ruby
14633 x = 2
14634 ```
14636 instead of
14638 ~~~ {.ruby}
14639 x = 2
14640 ~~~~
14642 * Easier scripting: a new `toJsonFilter` function makes it easier to
14643 write Haskell scripts to manipulate the Pandoc AST.
14644 See [Scripting with pandoc](scripting.html#pandoc-1.9-changes).
14646### Behavior changes
14648 * Fixed parsing of consecutive lists in markdown.
14649 Pandoc previously behaved like Markdown.pl for consecutive
14650 lists of different styles. Thus, the following would be parsed
14651 as a single ordered list, rather than an ordered list followed
14652 by an unordered list:
14654 1. one
14655 2. two
14657 - one
14658 - two
14660 This change makes pandoc behave more sensibly, parsing this as
14661 two lists. Any change in list type (ordered/unordered) or in
14662 list number style will trigger a new list. Thus, the following
14663 will also be parsed as two lists:
14665 1. one
14666 2. two
14668 a. one
14669 b. two
14671 Since we regard this as a bug in Markdown.pl, and not something
14672 anyone would ever rely on, we do not preserve the old behavior
14673 even when `--strict` is selected.
14675 * Dashes work differently with `--smart`: `---` is always em-dash,
14676 and `--` is always en-dash. Pandoc no longer tries to guess when
14677 `-` should be en-dash. *Note:* This may change how existing documents
14678 look when processed with pandoc. A new option, `--old-dashes`,
14679 is provided for legacy documents.
14681 * The markdown writer now uses setext headers for levels 1-2.
14682 The old behavior (ATX headers for all levels) can be restored
14683 using the new `--atx-headers` option.
14685 * Links are now allowed in markdown image captions. They are also
14686 allowed in links, but will appear there as regular text. So,
14688 [link with [link](/url)](/url)
14690 will turn into
14692 <p><a href="/url">link with link</a></p>
14694 * Improved handling of citations using `citeproc-hs-0.3.4`.
14695 Added `--citation-abbreviations` option.
14697 * Citation keys can no longer end with a punctuation character.
14698 This means that `@item1.` will be parsed as a citation with key
14699 'item1', followed by a period, instead of a citation with key
14700 'item1.', as was the case previously.
14702 * In HTML output, citations are now put in a span with class `citation`.
14704 * The markdown reader now recognizes DocBook block and inline tags.
14705 It was always possible to include raw DocBook tags in a markdown
14706 document, but now pandoc will be able to distinguish block from
14707 inline tags and behave accordingly. Thus, for example,
14709 <sidebar>
14710 hello
14711 </sidebar>
14713 will not be wrapped in `<para>` tags.
14715 * The LaTeX parser has been completely rewritten; it is now much more
14716 accurate, robust, and extensible. However, there are two important
14717 changes in how it treats unknown LaTeX. (1) Previously, unknown
14718 environments became BlockQuote elements; now, they are treated
14719 as "transparent", so `\begin{unknown}xyz\end{unknown}` is the
14720 same as `xyz`. (2) Previously, arguments of unknown commands
14721 were passed through with their braces; now the braces are stripped
14722 off.
14724 * `--smart` is no longer selected automatically with `man` output.
14726 * The deprecated `--xetex` option has been removed.
14728 * The `--html5`/`-5` option has been deprecated. Use `-t html5`
14729 instead. `html5` and `html5+lhs` are now separate output formats.
14731 * Single quotes are no longer escaped in HTML output. They do not
14732 need to be escaped outside of attributes.
14734 * Pandoc will no longer transform leading newlines in code
14735 blocks to `<br/>` tags.
14737 * The ODT writer now sizes images appropriately, using the image
14738 size and DPI information embedded in the image.
14740 * `--standalone` is once again implicitly for a non-text output format
14741 (ODT, EPUB). You can again do `pandoc test.txt -o test.odt`
14742 and get a standalone ODT file.
14744 * The Docbook writer now uses `<sect1>`, `<sect2>`, etc. instead of
14745 `<section>`.
14747 * The HTML writer now uses `<del>` for strikeout.
14749 * In HTML output with `--section-divs`, the classes `section` and
14750 `level[1,2,..6]` are put on the `div` tags so they can be styled.
14751 In HTML 5 output with `--section-divs`, the classes
14752 `level[1,2,...6]` are put on `section` tags.
14754 * EPUB writer changes:
14756 + The `lang` variable now sets the language
14757 in the metadata (if it is not set, we default to the locale).
14758 + EPUB: UTF-8 is used rather than decimal entities.
14760 * Added `titleslide` class to title slide in S5 template.
14762 * In HTML, EPUB, and docx metadata, the date is normalized into
14763 YYYY-MM-DD format if possible. (This is required for validation.)
14765 * Attributes in highlighted code blocks are now preserved in HTML.
14766 The container element will have the classes, id, and key-value attributes
14767 you specified in the delimited code block. Previously these were stripped
14768 off.
14770 * The reference backlink in the HTML writer no longer has a special
14771 `footnoteBacklink` class.
14773 * The HTML template has been split into `html` and `html5` templates.
14775 * Author and date are treated more consistently in HTML templates.
14776 Authors are now `<h2>`, date `<h3>`.
14778 * URLs are hyphenated in the ConTeXt writer (B. Scott Michel).
14780 * In `Text.Pandoc.Builder`, `+++` has been replaced by `<>`.
14782### Bug fixes
14784 * Better support for combining characters and East Asian wide characters
14785 in markdown and reST.
14787 * Better handling of single quotes with `--smart`.
14788 Previously `D'oh l'*aide*` would be parsed with left and right single
14789 quotes instead of apostrophes. This kind of error is now fixed.
14791 * Highlighting: Use `reads` instead of `read` for better error handling.
14792 Fixes crash on `startNum="abc"`.
14794 * Added blank comment after directives in rst template.
14796 * Unescape entities in citation `refId`. The `refId`s coming
14797 from citeproc contain XML numeric entities, and these don't match with the
14798 citation keys parsed by pandoc. Solution is to unescape them.
14800 * HTML reader: Fixed bug parsing tables with both thead and tbody.
14802 * Markdown reader:
14804 + Better handling of escapes in link URLs and titles.
14805 + Fixed backslash escapes in reference links.
14806 + Fixed bug in table/hrule parsing, by checking that the top
14807 line of a table is not followed by a blank line. This bug caused
14808 slowdowns on some files with hrules and tables, as pandoc tried to
14809 interpret the hrules as the tops of multiline tables.
14810 + Fixed bug in code block attribute parser. Previously the ID attribute
14811 got lost if it didn't come first. Now attributes can come in any order.
14813 * RST reader: allow footnotes followed by newline without space characters.
14815 * LaTeX reader:
14817 + Ignore empty groups {}, { }.
14818 + LaTeX reader: Handle `\@`.
14819 + LaTeX reader: Don't crash on commands like `\itemsep`.
14820 + LaTeX reader: Better handling of letter environments.
14822 * RST writer: Fixed bug involving empty table cells. isSimple was being
14823 calculated in a way that assumed there were no non-empty cells.
14825 * ConTeXt writer:
14827 + Made `--toc` work even without `--number-sections`.
14828 + Escape # in link URLs.
14829 + Use buffering for footnotes containing code blocks.
14830 + Changed 'descr' to 'description', fixed alignment.
14832 * LaTeX writer:
14834 + Escape euro character.
14835 + Don't escape `~` inside `\href{...}`.
14836 + Escape `#` in href URLs.
14837 + Improved detection of book classes. We now check the
14838 `documentclass` variable, and if that is not set, we look through
14839 the template itself. Also, we have added the KOMA classes scrreprt
14840 and scrbook. You can now make a book using
14841 `pandoc -V documentclass:book mybook.txt -o mybook.pdf`
14842 + LHS files now set the "listings" variable, so that the definition
14843 of the `code` environment will be included in the template.
14844 + Links are colored blue by default (this can be changed by
14845 modifying `hyperref` settings in the template).
14846 + Added `lang` variable to LaTeX template.
14848 * HTML writer:
14850 + Fixed bug in HTML template with html5 and mathml.
14851 + Don't use self-closing img, br, hr tags for HTML5.
14852 + Use `<section>` for footnotes if HTML5.
14853 + Update HTML templates to use Content-Style-Type meta tag.
14854 + Use separate variables for meta-date, meta-author.
14855 This makes footnotes work in author and date fields.
14856 + Use 'vertical-align:middle' in WebTeX math for better alignment.
14858 * S5/slidy writer: Make footnotes appear on separate slide at end.
14860 * MIME: Added 'layout-cache' to getMimeType. This ensures that the
14861 META-INF/manifest.xml for ODT files will have everything it needs, so
14862 that ODT files modified by LibreOffice can be used as `--reference-odt`.
14864 * `Text.Pandoc.Templates`: Return empty string for json template.
14866 * `Text.Pandoc.Biblio`:
14868 + Expand citations recursively inside nested inlines.
14869 + Treat `\160` as space when parsing locator and suffix.
14870 This fixes a bug with "p. 33" when `--smart` is used. Previously
14871 the whole "p. 33" would be included in the suffix, with no locator.
14872 + Put whole author-in-text citation in a Cite. Previously just the
14873 date and other info went in the Cite.
14874 + Don't add comma+space to prefix if it ends in punctuation.
14876 * Updated chicago-author-date.csl. The old version did not work
14877 properly for edited volumes with no author.
14879 * EPUB writer:
14881 + Add date to EPUB titlepage and metadata.
14882 + Added TOC identifier in EPUB page template.
14883 + Don't generate superfluous file `cover-image.jpg`.
14885### Under the hood improvements
14887 * Modified `make_osx_package.sh` to use cabal-dev.
14888 Items are no longer installed as root.
14889 Man pages are zipped and given proper permissions.
14891 * Modified windows installer generater to use cabal-dev.
14893 * Setup: Making man pages now works with cabal-dev (at least on OSX). In
14894 Setup.hs we now invoke 'runghc' in a way that points it to the correct
14895 package databases, instead of always falling back to the default user
14896 package db.
14898 * Updated to work with GHC 7.4.1.
14900 * Removed dependency on old-time.
14902 * Removed dependency on dlist.
14904 * New slidy directory for "self-contained."
14906 * TeXMath writer: Use unicode thin spaces for thin spaces.
14908 * Markdown citations: don't strip off initial space in locator.
14910### API changes
14912 * Removed `Apostrophe`, `EmDash`, `EnDash`, and `Ellipses`
14913 from the native `Inline` type in pandoc-types. Now we use `Str`
14914 elements with unicode.
14916 * Improvements to `Text.Pandoc.Builder`:
14918 + `Inlines` and `Blocks` are now newtypes (not synonyms for
14919 sequences).
14920 + Instances are defined for `IsString`, `Show`, `Read`, `Monoid`,
14921 and a new `Listable` class, which allows these to be manipulated
14922 to some extent like lists. Monoid append includes automatic
14923 normalization.
14924 + `+++` has been replaced by `<>` (mappend).
14926 * Use blaze-html instead of xhtml for HTML generation.
14927 This changes the type of `writeHtml`.
14929 * `Text.Pandoc.Shared`:
14931 + Added `warn` and `err`.
14932 + Removed `unescapeURI`, modified `escapeURI`.
14933 (See under [behavior changes], above.)
14935 * Changes in URI escaping: Previously the readers escaped URIs by
14936 converting unicode characters to octets and then percent encoding.
14937 Now unicode characters are left as they are, and `escapeURI` only
14938 percent-encodes space characters. This gives more readable
14939 URIs, and works well with modern user agents. URIs are no longer unescaped
14940 at all on conversion to `markdown`, `asciidoc`, `rst`, `org`.
14942 * New module `Text.Pandoc.SelfContained`.
14944 * New module `Text.Pandoc.Docx`.
14946 * New module `Text.Pandoc.PDF`.
14948 * Added `writerBeamer` to `WriterOptions`.
14950 * Added `normalizeDate` to `Text.Pandoc.Shared`.
14952 * Added `splitStringWithIndices` in `Text.Pandoc.Shared`.
14953 This is like `splitWithIndices`, but it is sensitive to distinctions
14954 between wide, combining, and regular characters.
14956 * `Text.Pandoc.Pretty`:
14958 + Added `chomp` combinator.
14959 + Added `beforeNonBreak` combinator. This allows you to include
14960 something conditionally on it being before a nonblank.
14961 Used for RST inline math.
14962 + Added `charWidth` function. All characters marked W or F in the unicode
14963 spec EastAsianWidth.txt get width 2.
14964 + Added `realLength`, based on `charWidth`. `realLength` is now
14965 used in calculating offsets.
14967 * New module `Text.Pandoc.Slides`, for common functions for breaking
14968 a document into slides.
14970 * Removed `Text.Pandoc.S5`, which is no longer needed.
14972 * Removed `Text.Pandoc.CharacterReferences`. Moved
14973 `characterReference` to `Text.Pandoc.Parsing`.
14974 `decodeCharacterReferences` is replaced by `fromEntities`
14975 in `Text.Pandoc.XML`.
14977 * Added `Text.Pandoc.ImageSize`. This is intened for use
14978 in `docx` and `odt` writers, so the size and dpi of images
14979 can be calculated.
14981 * Removed `writerAscii` in `WriterOptions`.
14983 * Added `writerHighlight` to `WriterOptions`.
14985 * Added `DZSlides` to `HTMLSlideVariant`.
14987 * `writeEPUB` has a new argument for font files to embed.
14989 * Added `stateLastStrPos` to `ParserState`. This lets us keep track
14990 of whether we're parsing the position immediately after a regular
14991 (non-space, non-symbol) string, which is useful for distinguishing
14992 apostrophes from single quote starts.
14994 * `Text.Pandoc.Parsing`:
14996 + `escaped` now returns a `Char`.
14997 + Removed `charsInBalanced'`, added a character parser as
14998 a parameter of `charsInBalanced`. This is needed for
14999 proper handling of escapes, etc.
15000 + Added `withRaw`.
15002 * Added `toEntities` to `Text.Pandoc.XML`.
15004 * `Text.Pandoc.Readers.LaTeX`:
15006 + Export `handleIncludes`.
15007 + Export `rawLaTeXBlock` instead of `rawLaTeXEnvironment'`.
15009 * Added `ToJsonFilter` class and `toJsonFilter` function to
15010 `Text.Pandoc`, deprecating the old `jsonFilter` function.
15012 * `Text.Pandoc.Highlighting`:
15014 + Removed `highlightHtml`, `defaultHighlightingCss`.
15015 + Export `formatLaTeXInline`, `formatLaTeXBlock`, and `highlight`, plus
15016 key functions from highlighting-kate.
15017 + Changed types of highlighting function. `highlight` returns a
15018 `Maybe`, not an `Either`.
15021## pandoc 1.8.2.1 (2011-08-01)
15023 * Adjusted Arbitrary instance to help avoid timeouts in tests.
15025 * Added `Tests.Writers.Markdown` to cabal file.
15027 * Relaxed version bounds on pandoc-types, test-framework.
15029## pandoc 1.8.2 (2011-07-30)
15031 * Added script to produce OS X package.
15033 * Made `templates` directory a git submodule. This should make it
15034 easier for people to revise their custom templates when the default
15035 templates change.
15037 * Changed template naming scheme: `FORMAT.template` -> `default.FORMAT`.
15038 **Note:** If you have existing templates in `~/.pandoc/templates`, you
15039 must rename them to conform to the new scheme!
15041 * Default template improvements:
15043 + HTML: Display author and date after title.
15044 + HTML: Made table of contents more customizable. The container
15045 for the TOC is now in the template, so users can insert a header
15046 or other styling. (Thanks to Bruce D'Arcus for the suggestion.)
15047 + HTML, Slidy, S5: Enclose scripts in CDATA tags.
15048 + Slidy, S5: Added `s5-url` and `slidy-url` variables, instead of
15049 hard-coding. If you want to put your slidy files in the slidy
15050 subdirectory, for example, you can do
15051 `pandoc -t slidy -V slidy-url=slidy -s`.
15052 + LaTeX: Use `\and` to separate authors in LaTeX documents (reader
15053 & writer). Closes #279.
15054 + LaTeX: Set `\emergencystretch` to prevent overfull lines.
15055 + LaTeX: Use different `hyperref` options for `xetex`, fixing
15056 problems with unicode bookmarks (thanks to CircleCode).
15057 + LaTeX: Removed `ucs` package, use `utf8` rather than `utf8x`
15058 with `inputenc`. This covers fewer characters but is more
15059 robust with other packages, and `ucs` is unmaintained. Users
15060 who need better unicode support should use xelatex or lualatex.
15062 * If a template specified with `--template` is not found, look for it
15063 in `datadir`. Also, if no extension is provided, supply one based
15064 on the writer. So now you can put your `special.latex` template in
15065 `~/.pandoc/templates`, and use it from any directory via
15066 `pandoc -t latex --template special`.
15068 * Added `nonspaceChar` to `Text.Pandoc.Parsing`.
15070 * Fixed smart quotes bug, now handling `'...hi'` properly.
15072 * RST reader:
15074 + Partial support for labeled footnotes.
15075 + Improved accuracy of `simpleReferenceName` parser.
15077 * HTML reader:
15079 + Substitute correct unicode characters for
15080 characters in the 128..159 range, which are often found even in
15081 HTML that purports to be UTF-8.
15083 * LaTeX reader: Handle `\subtitle` command (a subtitle is added
15084 to the title, after a colon and linebreak). Closes #280.
15086 * Leaner `reference.odt`.
15088 * Added unexported module `Text.Pandoc.MIME` for use in
15089 the ODT writer.
15091 * ODT writer: Construct `manifest.xml` based on archive contents.
15092 This fixes a bug in ODTs containing images. Recent versions of
15093 LibreOffice would reject these as corrupt, because `manifest.xml`
15094 did not contain a reference to the image files.
15096 * LaTeX writer:
15098 + Make verbatim environments flush to avoid spurious
15099 blank lines. Closes #277.
15100 + Use `\texttt` and escapes insntead of `\verb!...!`, which
15101 is too fragile (doesn't work in command arguments).
15102 + Use `\enquote{}` for quotes if the template includes
15103 the `csquotes` package. This provides better support for
15104 local quoting styles. (Thanks to Andreas Wagner for the idea.)
15106 * ConTeXt writer: Make `\starttyping`/`\stoptyping` flush with
15107 margin, preventing spurious blank lines.
15109 * Slidy writer:
15111 + Use non-minimized version of `slidy.css` with `--offline`
15112 option, so users can more easily edit it.
15113 + Also fixed a bug in the CSS that prevented proper centering
15114 of title (now reported and fixed upstream).
15116 * S5 writer:
15118 + Replaced `s5/default/slides.js.{comment,packed}` with
15119 new compressed `s5/default/slides.min.js`.
15120 + Use `data:` protocol to embed S5 CSS in `<link>` tags,
15121 when `--offline` is specified. Using inline CSS didn't
15122 work with Chrome or Safari. This fixes offline
15123 S5 on those browsers.
15125 * HTML writer: Removed English title on footnote backlinks.
15126 This is incongrous in non-English documents.
15128 * Docbook writer:
15130 + Use CALS tables. (Some older docbook software does not work
15131 well with XHTML tables.) Closes #77.
15132 + Use `programlisting` tags (instead of `screen`) for code blocks.
15134 * `markdown2pdf`:
15136 + Calls latex with `-halt-on-error -interaction nonstopmode` instead
15137 of `-interaction=batchmode`, which essentially just ignored errors,
15138 leading to bad results. Better to know when something is wrong.
15139 + Fixed issues with non-UTF-8 output of `pdflatex`.
15140 + Better error reporting.
15142 * `--mathjax` now takes an optional URL argument. If it is not
15143 provided, pandoc links directly to the (secure) mathjax CDN,
15144 as now recommended (thanks to dsanson).
15146 * Deprecated `--xetex` option in `pandoc`. It is no longer needed,
15147 since the LaTeX writer now produces a file that can be processed by
15148 `latex`, `pdflatex`, `lualatex`, or `xelatex`.
15150 * Introduced `--luatex` option to `markdown2pdf`. This causes `lualatex`
15151 to be used to create the PDF.
15154## pandoc 1.8.1.2 (2011-07-16)
15156 * Added `--epub-cover-image` option.
15158 * Documented `--biblatex` and `--natbib` options.
15160 * Allow `--section-divs` with slidy output. Resolves Issue #296.
15162 * Disallow notes within notes in reST and markdown.
15163 These previously caused infinite looping and stack overflows.
15164 For example:
15166 [^1]
15168 [^1]: See [^1]
15170 Note references are allowed in reST notes, so this isn't a full
15171 implementation of reST. That can come later. For now we need to
15172 prevent the stack overflows. Partially resolves Issue #297.
15174 * EPUB writer: Allow non-plain math methods.
15176 * Forbid ()s in citation item keys. Resolves Issue #304: problems with
15177 `(@item1; @item2)` because the final paren was being parsed as part of
15178 the item key.
15180 * Changed URI parser so it doesn't include trailing punctuation.
15181 So, in RST, `http://google.com.` should be parsed as a link followed by a
15182 period. The parser is smart enough to recognize balanced parentheses, as
15183 often occur in wikipedia links: `http://foo.bar/baz_(bam)`.
15185 * Markdown+lhs reader: Require space after inverse bird tracks, so that
15186 HTML tags can be used freely at the left margin of a markdown+lhs document.
15187 Thanks to Conal Elliot for the suggestion.
15189 * Markdown reader: Fixed bug in footnote order (reported by CircleCode).
15191 * RST reader:
15192 + Fixed bug in in field lists with multi-line items at the
15193 end of the list.
15194 + Added parentheses to RST `specialChars`, so
15195 `(http://google.com)` will be parsed as a link in parens.
15196 Resolves Issue #291.
15197 + Allow `|` followed by newline in RST line block.
15199 * LaTeX reader:
15200 + Support `\dots`.
15201 + Gobble option & space after linebreak `\\[10pt]`.
15203 * Textile reader:
15204 + Make it possible to have colons after links. (qerub)
15205 + Make it possible to have colons after links. (Christoffer Sawicki)
15207 * HTML reader:
15208 + Skip spaces after `<b>`, `<emph>`, etc.
15209 + Handle tbody, thead in simple tables. Closes #274.
15210 + Implicit `Para`s instead of `Plains` in some contexts.
15212 * OpenDocument writer: Use special `First paragraph` style for
15213 first paragraph after most non-paragraph blocks. This allows users to
15214 specify e.g. that only paragraphs after the first paragraph of a block are
15215 to be indented. Thanks to Andrea Rossato for the patch. Closes #20.
15217 * LaTeX writer: use `deVerb` on table and picture captions.
15218 Otherwise LaTeX complains about `\verb` inside command argument.
15219 Thanks to bbanier for reporting the bug.
15221 * Markdown writer: Insert HTML comment btw list and indented code block.
15222 This prevents the code block from being interpreted as part of the list.
15224 * EPUB writer: Add a meta element specify the cover.
15225 Some EPUB e-readers, such as the Nook, require a meta element inside the
15226 OPF metadata block to ensure the cover image is properly displayed.
15227 (Kelsey Hightower)
15229 * HTML writer: Use embed tag for images with non-image extensions.
15230 (e.g. PDFs). Closes #264.
15232 * LaTeX writer: Improved tables.
15234 + More space between lines, top-align cells.
15235 + Use ctable package, which allows footnotes and
15236 provides additional options.
15237 + Made cell alignments work in multiline tables.
15238 + Closes #271, #272.
15240 * Un-URI-escape image filenames in LaTeX, ConTeXt, RTF, Texinfo.
15241 Also do this when copying image files into EPUBs and ODTs.
15242 Closes #263.
15244 * Changed to github issue tracker.
15246 * Added failing emph/strong markdown test case due to Perry Wagle.
15248 * Slidy improvements:
15249 + Updated to use Slidy2.
15250 + Fixed bug, unclosed div tag.
15251 + Added `duration` variable in template.
15252 Setting this activates the timer.
15253 + Use 'titlepage' instead of 'cover' for title div.
15256## pandoc 1.8.1.1 (2011-02-13)
15258 * `markdown2pdf`: Removed some debugging lines accidentally included
15259 in the 1.8.1 release. With those lines, the temp directory is created
15260 in the working directory, and it is not deleted. This fix restores
15261 the original behavior.
15263## pandoc 1.8.1 (2011-02-13)
15265 * Added `--ascii` option. Currently supported only in HTML writer,
15266 which it causes to use numerical entities instead of UTF-8.
15268 * EPUB writer: `--toc` now works to provide a table of contents
15269 at the beginning of each chapter.
15271 * LaTeX writer: Change figure defaults to `htbp`.
15272 This prevents "too many unprocessed floats." Resolves
15273 Issue #285.
15275 * `Text.Pandoc.UTF8`: Encode filenames even when using recent
15276 base.
15278 * `markdown2pdf`: Fixed filename encoding issues. With help from Paulo
15279 Tanimoto. Resolves Issue #286.
15281 * HTML writer: Put line breaks in section divs.
15283 * `Text.Pandoc.Shared`: Make `writerSectionDivs` default to False.
15285## pandoc 1.8.0.3 (2011-02-05)
15287 * Fixed Source-repository stanza in cabal file.
15289## pandoc 1.8.0.2 (2011-02-05)
15291 * HTML writer:
15293 + Stringify alt text instead of converting to HTML.
15294 + Break lines after block elements, not inside tags.
15295 HTML output now closely resembles that of tidy. Resolves Issue #134.
15297 * Markdown reader: Fixed bug in footnote block parser (pointed out
15298 by Jesse Rosenthal). The problem arose when the blank line
15299 at the end of a footnote block contained indenting spaces.
15301 * Shared: Improved 'normalize' function so it normalizes Spaces too.
15302 In normal form, Space elements only occur to separate two non-Space
15303 elements. So, we never have [Space], or [, ..., Space].
15305 * Tests:
15307 + Improved Arbitrary instance.
15308 + Added timeout for test instances.
15310 * README:
15312 + Added section on four-space rule for lists. Resolves Issue #283.
15313 + Clarified optional arguments on math options.
15315 * markdown2pdf: Fixed bug with output file extensions.
15316 Previously `markdown2pdf test.txt -o test.en.pdf` would produce
15317 `test.pdf`, not `test.en.pdf`. Thanks to Paolo Tanimoto for the fix.
15319## pandoc 1.8.0.1 (2011-01-31)
15321 * Revised Interact.hs so that it works with the CPP macros
15322 in the UTF8 module.
15324 * Revised Setup.hs so that we don't call MakeManPage.hs unless
15325 the man pages are out of date.
15327## pandoc 1.8 (2011-01-30)
15329### New features
15331 * Support for citations using Andrea Rossato's `citeproc-hs` 0.3.
15332 You can now write, for example,
15334 Water is wet [see @doe99, pp. 33-35; also @smith04, ch. 1].
15336 and, when you process your document using `pandoc`, specifying
15337 a citation style using `--csl` and a bibliography using `--bibliography`,
15338 the citation will be replaced by an appropriately formatted
15339 citation, and a list of works cited will be added to the end
15340 of the document.
15342 This means that you can switch effortlessly between different citation
15343 and bibliography styles, including footnote, numerical, and author-date
15344 formats. The bibliography can be in any of the following formats: MODS,
15345 BibTeX, BibLaTeX, RIS, EndNote, EndNote XML, ISI, MEDLINE, Copac, or JSON.
15346 See the README for further details.
15348 Citations are supported in the markdown reader, using a special
15349 syntax, and in the LaTeX reader, using natbib or biblatex syntax.
15350 (Thanks to Nathan Gass for the natbib and biblatex support.)
15352 * New `textile` reader and writer. Thanks to Paul Rivier for contributing
15353 the `textile` reader, an almost complete implementation of the textile
15354 syntax used by the ruby [RedCloth library](http://redcloth.org/textile).
15355 Resolves Issue #51.
15357 * New `org` writer, for Emacs Org-mode, contributed by Puneeth Chaganti.
15359 * New `json` reader and writer, for reading and writing a JSON
15360 representation of the native Pandoc AST. These are much faster
15361 than the `native` reader and writer, and should be used for
15362 serializing Pandoc to text. To convert between the JSON representation
15363 and native Pandoc, use `encodeJSON` and `decodeJSON` from
15364 `Text.JSON.Generic`.
15366 * A new `jsonFilter` function in `Text.Pandoc` makes it easy
15367 to write scripts that transform a JSON-encoded pandoc document.
15368 For example:
15370 -- removelinks.hs - removes links from document
15371 import Text.Pandoc
15372 main = interact $ jsonFilter $ bottomUp removeLink
15373 where removeLink (Link xs _) = Emph xs
15374 removeLink x = x
15376 To use this to remove links while translating markdown to LaTeX:
15378 pandoc -t json | runghc removelinks.hs | pandoc -f json -t latex
15380 * Attributes are now allowed in inline `Code` elements, for example:
15382 In this code, `ulist ! [theclass "special"] << elts`{.haskell} is...
15384 The attribute syntax is the same as for delimited code blocks.
15385 `Code` inline has an extra argument place for attributes, just like
15386 `CodeBlock`. Inline code will be highlighted in HTML output, if pandoc
15387 is compiled with highlighting support. Resolves Issue #119.
15389 * New `RawBlock` and `RawInline` elements (replacing `RawHtml`,
15390 `HtmlInline`, and `TeX`) provide lots of flexibility in writing
15391 scripts to transform Pandoc documents. Scripts can now change
15392 how each element is rendered in each output format.
15394 * You can now define LaTeX macros in markdown documents, and pandoc
15395 will apply them to TeX math. For example,
15397 \newcommand{\plus}[2]{#1 + #2}
15398 $\plus{3}{4}$
15400 yields `3+4`. Since the macros are applied in the reader, they
15401 will work in every output format, not just LaTeX.
15403 * LaTeX macros can also be used in LaTeX documents (both in math
15404 and in non-math contexts).
15406 * A new `--mathjax` option has been added for displaying
15407 math in HTML using MathJax. Resolves issue #259.
15409 * Footnotes are now supported in the RST reader. (Note, however,
15410 that unlike docutils, pandoc ignores the numeral or symbol used in
15411 the note; footnotes are put in an auto-numbered ordered list.)
15412 Resolves Issue #258.
15414 * A new `--normalize` option causes pandoc to normalize the AST
15415 before writing the document. This means that, for example,
15416 `*hi**there*` will be rendered as `<em>hithere</em>`
15417 instead of `<em>hi</em><em>there</em>`. This is not the default,
15418 because there is a significant performance penalty.
15420 * A new `--chapters` command-line option causes headers
15421 in DocBook, LaTeX, and ConTeXt to start with "chapter" (level one).
15422 Resolves Issue #265.
15424 * In DocBook output, `<chapter>` is now used for top-level
15425 headers if the template contains `<book>`. Resolves Issue #265.
15427 * A new `--listings` option in `pandoc` and `markdown2pdf` causes
15428 the LaTeX writer to use the listings package for code blocks.
15429 (Thanks to Josef Svennigsson for the pandoc patch, and Etienne
15430 Millon for the markdown2pdf patch.)
15432 * `markdown2pdf` now supports `--data-dir`.
15434 * URLs in autolinks now have class "url" so they can be styled.
15436 * Improved prettyprinting in most formats. Lines will be wrapped
15437 more evenly and duplicate blank lines avoided.
15439 * New `--columns` command-line option sets the column width for
15440 line wrapping and relative width calculations for tables.
15442 * Made `--smart` work in HTML, RST, and Textile readers, as well
15443 as markdown.
15445 * Added `--html5` option for HTML5 output.
15447 * Added support for listings package in LaTeX reader
15448 (Puneeth Chaganti).
15450 * Added support for simple tables in the LaTeX reader.
15452 * Added support for simple tables in the HTML reader.
15454 * Significant performance improvements in many readers and writers.
15456### API and program changes
15458 * Moved `Text.Pandoc.Definition` from the `pandoc` package to a new
15459 auxiliary package, `pandoc-types`. This will make it possible for other
15460 programs to supply output in Pandoc format, without depending on the whole
15461 pandoc package.
15463 * Added `Attr` field to `Code`.
15465 * Removed `RawHtml`, `HtmlInline`, and `TeX` elements; added generic
15466 `RawBlock` and `RawInline`.
15468 * Moved generic functions to `Text.Pandoc.Generic`. Deprecated
15469 `processWith`, replacing it with two functions, `bottomUp` and `topDown`.
15470 Removed previously deprecated functions `processPandoc` and `queryPandoc`.
15472 * Added `Text.Pandoc.Builder`, for building `Pandoc` structures.
15474 * `Text.Pandoc` now exports association lists `readers` and `writers`.
15476 * Added `Text.Pandoc.Readers.Native`, which exports `readNative`.
15477 `readNative` can now read full pandoc documents, block lists, blocks,
15478 inline lists, or inlines. It will interpret `Str "hi"`
15479 as if it were `Pandoc (Meta [] [] []) [Plain [Str "hi"]]`.
15480 This should make testing easier.
15482 * Removed deprecated `-C/--custom-header` option.
15483 Use `--template` instead.
15485 * `--biblio-file` has been replaced by `--bibliography`.
15486 `--biblio-format` has been removed; pandoc now guesses the format
15487 from the file extension (see README).
15489 * pandoc will treat an argument as a URI only if it has an
15490 `http(s)` scheme. Previously pandoc would treat some
15491 Windows pathnames beginning with `C:/` as URIs.
15493 * The `--sanitize-html` option and the `stateSanitize` field in
15494 `ParserState` have been removed. Sanitization is better done in the
15495 resulting HTML using `xss-sanitize`, which is based on pandoc's
15496 sanitization, but improved.
15498 * pandoc now adds a newline to the end of its output in fragment
15499 mode (= not `--standalone`).
15501 * Added support for `lang` in `html` tag in the HTML template,
15502 so you can do `pandoc -s -V lang=es`, for example.
15504 * `highlightHtml` in `Text.Pandoc.Highlighting` now takes
15505 a boolean argument that selects between "inline" and
15506 "block" HTML.
15508 * `Text.Pandoc.Writers.RTF` now exports `rtfEmbedImage`.
15509 Images are embedded in RTF output when possible (png, jpeg).
15510 Resolves Issue #275.
15512 * Added `Text.Pandoc.Pretty`. This is better suited for pandoc than the
15513 `pretty` package. Changed all writers that used
15514 `Text.PrettyPrint.HughesPJ` to use `Text.Pandoc.Pretty` instead.
15516 * Rewrote `writeNative` using the new prettyprinting module. It is
15517 now much faster. The output has been made more consistent and compressed.
15518 `writeNative` is also now sensitive to writerStandalone`, and will simply
15519 `print a block list if writerStandalone` is False.
15521 * Removed `Text.Pandoc.Blocks`. `Text.Pandoc.Pretty` allows you to define
15522 blocks and concatenate them, so a separate module is no longer needed.
15524 * `Text.Pandoc.Shared`:
15526 + Added `writerColumns`, `writerChapters`, and `writerHtml5` to
15527 `WriterOptions`.
15528 + Added `normalize`.
15529 + Removed unneeded prettyprinting functions:
15530 `wrapped`, `wrapIfNeeded`, `wrappedTeX`, `wrapTeXIfNeeded`, `hang'`,
15531 `BlockWrapper`, `wrappedBlocksToDoc`.
15532 + Made `splitBy` take a test instead of an element.
15533 + Added `findDataFile`, refactored `readDataFile`.
15534 + Added `stringify`. Rewrote `inlineListToIdentifier` using `stringify`.
15535 + Fixed `inlineListToIdentifier` to treat `\160` as ' '.
15537 * `Text.Pandoc.Readers.HTML`:
15539 + Removed `rawHtmlBlock`, `anyHtmlBlockTag`, `anyHtmlInlineTag`,
15540 `anyHtmlTag`, `anyHtmlEndTag`, `htmlEndTag`, `extractTagType`,
15541 `htmlBlockElement`, `htmlComment`
15542 + Added `htmlTag`, `htmlInBalanced`, `isInlineTag`, `isBlockTag`,
15543 `isTextTag`
15545 * Moved `smartPunctuation` from `Text.Pandoc.Readers.Markdown`
15546 to `Text.Pandoc.Readers.Parsing`, and parameterized it with
15547 an inline parser.
15549 * Ellipses are no longer allowed to contain spaces.
15550 Previously we allowed '. . .', ' . . . ', etc. This caused
15551 too many complications, and removed author's flexibility in
15552 combining ellipses with spaces and periods.
15554 * Allow linebreaks in URLs (treat as spaces). Also, a string of
15555 consecutive spaces or tabs is now parsed as a single space. If you have
15556 multiple spaces in your URL, use `%20%20`.
15558 * `Text.Pandoc.Parsing`:
15560 + Removed `refsMatch`.
15561 + Hid `Key` constructor.
15562 + Removed custom `Ord` and `Eq` instances for `Key`.
15563 + Added `toKey` and `fromKey` to convert between `Key` and `[Inline]`.
15564 + Generalized type on `readWith`.
15566 * Small change in calculation of relative widths of table columns.
15567 If the size of the header > the specified column width, use
15568 the header size as 100% for purposes of calculating
15569 relative widths of columns.
15571 * Markdown writer now uses some pandoc-specific features when `--strict`
15572 is not specified: `\` newline is used for a hard linebreak instead of
15573 two spaces then a newline. And delimited code blocks are used when
15574 there are attributes.
15576 * HTML writer: improved gladTeX output by setting ENV appropriately
15577 for display or inline math (Jonathan Daugherty).
15579 * LaTeX writer: Use `\paragraph`, `\subparagraph` for level 4,5 headers.
15581 * LaTeX reader:
15583 + `\label{foo}` and `\ref{foo}` now become `{foo}` instead of `(foo)`.
15584 + `\index{}` commands are skipped.
15586 * Added `fontsize` variable to default LaTeX template.
15587 This makes it easy to set the font size using `markdown2pdf`:
15588 `markdown2pdf -V fontsize=12pt input.txt`.
15590 * Fixed problem with strikeout in LaTeX headers when using
15591 hyperref, by adding a command to the default LaTeX template
15592 that disables `\sout` inside pdf strings. Thanks to Joost Kremers
15593 for the fix.
15595 * The `COLUMNS` environment variable no longer has any effect.
15597### Under-the-hood improvements
15599 * Pandoc now compiles with GHC 7. (This alone leads to a
15600 significant performance improvement, 15-20%.)
15602 * Completely rewrote HTML reader using tagsoup as a lexer. The
15603 new reader is faster and more accurate. Unlike the
15604 old reader, it does not get bogged down on some input
15605 (Issues #277, 255). And it handles namespaces in tags
15606 (Issue #274).
15608 * Replaced `escapeStringAsXML` with a faster version.
15610 * Rewrote `spaceChar` and some other parsers in Text.Pandoc.Parsing
15611 for a significant performance boost.
15613 * Improved performance of all readers by rewriting parsers.
15615 * Simplified Text.Pandoc.CharacterReferences by using
15616 entity lookup functions from TagSoup.
15618 * `Text.Pandoc.UTF8` now uses the unicode-aware IO functions
15619 from `System.IO` if base >= 4.2. This gives support for
15620 windows line endings on windows.
15622 * Remove duplications in documentation by generating the
15623 pandoc man page from README, using `MakeManPage.hs`.
15625 * README now includes a full description of markdown syntax,
15626 including non-pandoc-specific parts. A new `pandoc_markdown`
15627 man page is extracted from this, so you can look up markdown
15628 syntax by doing `man pandoc_markdown`.
15630 * Completely revised test framework (with help from Nathan Gass).
15631 The new test framework is built when the `tests` Cabal flag is set. It
15632 includes the old integration tests, but also some new unit and quickcheck
15633 tests. Test output has been much improved, and you can now specify a glob
15634 pattern after `cabal test` to indicate which tests should be run;
15635 for example `cabal test citations` will run all the citation tests.
15637 * Added a shell script, `stripansi.sh`, for filtering ANSI control
15638 sequences from test output: `cabal test | ./stripansi.sh > test.log`.
15640 * Added `Interact.hs` to make it easier to use ghci while developing.
15641 `Interact.hs` loads `ghci` from the `src` directory, specifying
15642 all the options needed to load pandoc modules (including
15643 specific package dependencies, which it gets by parsing
15644 dist/setup-config).
15646 * Added `Benchmark.hs`, testing all readers + writers using criterion.
15648 * Added `stats.sh`, to make it easier to collect and archive
15649 benchmark and lines-of-code stats.
15651 * Added upper bounds to all cabal dependencies.
15653 * Include man pages in extra-source-files. This allows users to
15654 install pandoc from the tarball without needing to build the man
15655 pages.
15657### Bug fixes
15659 * Filenames are encoded as UTF8. Resolves Issue #252.
15661 * Handle curly quotes better in `--smart` mode. Previously, curly quotes
15662 were just parsed literally, leading to problems in some output formats.
15663 Now they are parsed as `Quoted` inlines, if `--smart` is specified.
15664 Resolves Issue #270.
15666 * Text.Pandoc.Parsing: Fixed bug in grid table parser.
15667 Spaces at end of line were not being stripped properly,
15668 resulting in unintended LineBreaks.
15670 * Markdown reader:
15672 + Allow HTML comments as inline elements in markdown.
15673 So, `aaa <!-- comment --> bbb` can be a single paragraph.
15674 + Fixed superscripts with links: `^[link](/foo)^` gets
15675 recognized as a superscripted link, not an inline note followed by
15676 garbage.
15677 + Fixed regression, making markdown reference keys case-insensitive again.
15678 Resolves Issue #272.
15679 + Properly handle abbreviations (like `Mr.`) at the end of a line.
15680 + Better handling of intraword underscores, avoiding exponential
15681 slowdowns in some cases. Resolves Issue #182.
15682 + Fixed bug in alignments in tables with blank rows in the header.
15684 * RST reader:
15686 + Field lists now allow spaces in field names, and
15687 block content in field values. (Thanks to Lachlan Musicman
15688 for pointing out the bug.)
15689 + Definition list items are now always `Para` instead of
15690 `Plain`, matching behavior of `rst2xml.py`.
15691 + In image blocks, the description is parsed properly and
15692 used for the alt attribute, not also the title.
15693 + Skip blank lines at beginning of file. Resolves
15694 Debian #611328.
15696 * LaTeX reader:
15698 + Improved parsing of preamble.
15699 Previously you'd get unexpected behavior on a document that
15700 contained `\begin{document}` in, say, a verbatim block.
15701 + Allow spaces between `\begin` or `\end` and `{`.
15702 + Support `\L` and `\l`.
15703 + Skip comments inside paragraphs.
15705 * LaTeX writer:
15707 + Escape strings in `\href{..}`.
15708 + In nonsimple tables, put cells in `\parbox`.
15710 * OpenDocument writer: don't print raw TeX.
15712 * Markdown writer:
15714 + Fixed bug in `Image`. URI was getting unescaped twice!
15715 + Avoid printing extra blank lines at the end if there are
15716 no notes or references.
15718 * LaTeX and ConTeXt: Escape `[` and `]` as `{[}` and `{]}`.
15719 This avoids unwanted interpretation as an optional argument.
15721 * ConTeXt writer: Fixed problem with inline code. Previously
15722 `}` would be rendered `\type{}}`. Now we check the string for '}' and '{'.
15723 If it contains neither, use `\type{}`; otherwise use `\mono{}`
15724 with an escaped version of the string.
15726 * `:` now allowed in HTML tags. Resolves Issue #274.
15730## pandoc 1.6 (2010-07-24)
15732+ New EPUB and HTML Slidy writers. (Issue #122)
15734 - [EPUB] is a standard ebook format, used in Apple's iBooks for
15735 the iPad and iPhone, Barnes and Noble's nook reader, the Sony
15736 reader, and many other devices, and by online ebook readers like
15737 [bookworm]. (Amazon's Kindle uses a different format, MobiPocket,
15738 but EPUB books can easily be converted to Kindle format.) Now you
15739 can write your book in markdown and produce an ebook with a single
15740 command! I've put up a short [tutorial here].
15741 - [Slidy], like S5, is a system for producing HTML+javascript slide shows.
15743+ All input is assumed to be UTF-8, no matter what the locale and ghc
15744 version, and all output is UTF-8. This reverts to pre-1.5 behavior.
15745 Also, a BOM, if present, is stripped from the input.
15747+ Markdown now supports grid tables, whose cells can contain
15748 arbitrary block elements. (Issue #43)
15750+ Sequentially numbered example lists in markdown with `@` marker.
15752+ Markdown table captions can begin with a bare colon and no longer need
15753 to include the English word "table." Also, a caption can now occur
15754 either before or after the table. (Issue #227)
15756+ New command-line options:
15758 - `--epub-stylesheet` allows you to specify a CSS file that will
15759 be used to style your ebook.
15760 - `--epub-metadata` allows you to specify metadata for the ebook.
15761 - `--offline` causes the generated HTML slideshow to include all
15762 needed scripts and stylesheets.
15763 - `--webtex` causes TeX math to be converted to images using the
15764 Google Charts API (unless a different URL is specified).
15765 - `--section-divs` causes div tags to be added around each section
15766 in an HTML document. (Issue #230, 239)
15768+ Default behavior of S5 writer in standalone mode has changed:
15769 previously, it would include all needed scripts and stylesheets
15770 in the generated HTML; now, only links are included unless
15771 the `--offline` option is used.
15773+ Default behavior of HTML writer has changed. Between 1.2 and 1.5,
15774 pandoc would enclose sections in div tags with identifiers on the
15775 div tags, so that the sections can be manipulated in javascript.
15776 This caused undesirable interactions with raw HTML div tags. So,
15777 starting with 1.6, the default is to put the identifiers directly
15778 on the header tags, and not to include the divs. The `--section-divs`
15779 option selects the 1.2-1.5 behavior.
15781+ API changes:
15783 - `HTMLMathMethod`: Added `WebTeX`, removed `MimeTeX`.
15784 - `WriterOptions`: Added `writerUserDataDir`, `writerSourceDirectory`,
15785 `writerEPUBMetadata` fields. Removed `writerIncludeBefore`,
15786 `writerIncludeAfter`.
15787 - Added `headerShift` to `Text.Pandoc.Shared`.
15788 - Moved parsing code and `ParserState` from `Text.Pandoc.Shared`
15789 to a new module, `Text.Pandoc.Parsing`.
15790 - Added `stateHasChapters` to `ParserState`.
15791 - Added `HTMLSlideVariant`.
15792 - Made `KeyTable` a map instead of an association list.
15793 - Added accessors for `Meta` fields (`docTitle`, `docAuthors`, `docDate`).
15794 - `Pandoc`, `Meta`, `Inline`, and `Block` have been given `Ord` instances.
15795 - Reference keys now have a type of their own (`Key`), with its
15796 own `Ord` instance for case-insensitive comparison.
15797 - Added `Text.Pandoc.Writers.EPUB`.
15798 - Added `Text.Pandoc.UUID`.
15799 - Removed `Text.Pandoc.ODT`, added `Text.Pandoc.Writers.ODT`.
15800 Removed `saveOpenDocumentAsODT`, added `writeODT`.
15801 - Added `Text.Pandoc.Writers.Native` and `writeNative`.
15802 Removed `prettyPandoc`.
15803 - Added `Text.Pandoc.UTF8` for portable UTF8 string IO.
15804 - Removed `Text.Pandoc.Writers.S5` and the `writeS5` function.
15805 Moved `s5Includes` to a new module, `Text.Pandoc.S5`.
15806 To write S5, you now use `writeHtml` with `writerSlideVariant`
15807 set to `S5Slides` or `SlidySlides`.
15809+ Template changes. If you use custom templates, please update them,
15810 particularly if you use syntax highlighting with pandoc. The old HTML
15811 templates hardcoded highlighting CSS that will no longer work with
15812 the most recent version of highlighting-kate.
15814 - HTML template: avoid empty meta tag if no date.
15815 - HTML template: Use default highlighting CSS from highlighting-kate
15816 instead of hard-coding the CSS into the template.
15817 - HTML template: insert-before text goes before the title, and
15818 immediately after the `<body>` tag, as documented. (Issue #241)
15819 - Added slidy and s5 templates.
15820 - Added amssymb to preamble of latex template. (github Issue 1)
15822+ Removed excess newlines at the end of output. Note: because output
15823 will not contain an extra newline, you may need to make adjustments
15824 if you are inserting pandoc's output into a template.
15826+ In S5 and slidy, horizontal rules now cause a new slide, so you
15827 are no longer limited to one slide per section.
15829+ Improved handling of code in man writer. Inline code is now monospace,
15830 not bold, and code blocks now use .nf (no fill) and .IP (indented para).
15832+ HTML reader parses `<tt>` as Code. (Issue #247)
15834+ html+lhs output now contains bird tracks, even when compiled without
15835 highlighting support. (Issue #242)
15837+ Colons are now no longer allowed in autogenerated XML/HTML identifiers,
15838 since they have a special meaning in XML.
15840+ Code improvements in ODT writer. Remote images are now replaced with
15841 their alt text rather than a broken link.
15843+ LaTeX reader improvements:
15845 - Made latex `\section`, `\chapter` parsers more forgiving of whitespace.
15846 - Parse `\chapter{}` in latex.
15847 - Changed `rawLaTeXInline` to accept `\section`, `\begin`, etc.
15848 - Use new `rawLaTeXInline'` in LaTeX reader, and export `rawLaTeXInline`
15849 for use in markdown reader.
15850 - Fixes bug wherein `\section{foo}` was not recognized as raw TeX
15851 in markdown document.
15853+ LaTeX writer: images are automatically shrunk if they would extend
15854 beyond the page margin.
15856+ Plain, markdown, RST writers now use unicode for smart punctuation.
15858+ Man writer converts math to unicode when possible, as in other writers.
15860+ `markdown2pdf` can now recognize citeproc options.
15862+ Command-line arguments are converted to UTF-8. (Issue #234)
15864+ `Text.Pandoc.TeXMath` has been rewritten to use texmath's parser.
15865 This allows it to handle a wider range of formulas. Also, if a formula
15866 cannot be converted, it is left in raw TeX; formulas are no longer
15867 partially converted.
15869+ Unicode curly quotes are left alone when parsing smart quotes. (Issue #143)
15871+ Cabal file changes:
15873 - Removed parsec < 3 restriction.
15874 - Added 'threaded' flag for architectures where GHC lacks a threaded
15875 runtime.
15876 - Use 'threaded' only for markdown2pdf; it is not needed for pandoc.
15877 - Require highlighting-kate 0.2.7.
15879+ Use explicit imports from `Data.Generics`. Otherwise we have a
15880 conflict with the 'empty' symbol, introduced in syb >= 0.2. (Issue #237)
15882+ New data files: slidy/slidy.min.js, slidy/slidy.min.css, epub.css.
15884[EPUB]: http://en.wikipedia.org/wiki/EPUB
15885[Slidy]: http://www.w3.org/Talks/Tools/Slidy
15886[bookworm]: http://bookworm.oreilly.com/
15887[tutorial here]: http://johnmacfarlane.net/pandoc/epub.html
15889## pandoc 1.5.1.1 (2010-03-29)
15891+ Fixed header identifiers (uniqueIdent in Shared) so they
15892 work as advertized in README and are guaranteed to be
15893 valid XHTML names. Thanks to Xyne for reporting the bug.
15895## pandoc 1.5.1 (2010-03-23)
15897+ Fixed treatment of unicode characters in URIs.
15898+ Revised Setup.hs so it works with debian's build process.
15899+ Fixed bug in OpenDocument writer that led to invalid
15900 XML for some input.
15902## pandoc 1.5.0.1 (2010-03-21)
15904+ HTML writer: Fixed error in math writer (with MathML option)
15905 that caused an infinite loop for unparsable MathML.
15907## pandoc 1.5 (2010-03-20)
15909+ Moved repository to [github](http://github.com/jgm/pandoc).
15910+ New `--mathml` option, for display of TeX math as MathML.
15911+ New `--data-dir` option, allowing users to specify a data
15912 directory other than `~/.pandoc`. Files placed in this directory
15913 will be used instead of system defaults.
15914+ New `--base-header-level` option. For example, `--base-header-level=2`
15915 changes level 1 headers to level 2, level 2 to level 3, etc.
15916+ New 'plain' output format: plain text without pictures, hyperlinks,
15917 inline formatting, or anything else that looks even vaguely
15918 markupish.
15919+ Titles and authors in title blocks can now span multiple lines,
15920 as long as the continuation lines begin with a space character.
15921+ When given an absolute URI as a parameter, pandoc will fetch
15922 the content via HTTP.
15923+ The HTML reader has been made much more forgiving. It no
15924 longer requires well-formed xhtml as input.
15925+ `html2markdown` has been removed; it is no longer necessary, given
15926 the last two changes. `pandoc` can be used by itself to convert
15927 web pages to markdown or other formats.
15928+ `hsmarkdown` has also been removed. Use `pandoc --strict` instead.
15929 Or symlink pandoc's executable to `hsmarkdown`; `pandoc` will then
15930 behave like `hsmarkdown` used to.
15931+ An image in a paragraph by itself is now rendered as a figure
15932 in most writers, with the alt text as the caption.
15933+ Incomplete support for reST tables (simple and grid). Thanks to
15934 Eric Kow. Colspans and rowspans not yet supported.
15935+ In mediawiki, links with relative URLs are now formatted as wikilinks.
15936 Also, headers have been promoted: `= head =` is now level 1 instead of
15937 level 2.
15938+ The markdown reader now handles "inverse bird tracks" when parsing
15939 literate haskell. These are used for haskell example code that
15940 is not part of the literate program.
15941+ The `-B` and `-A` options now imply `-s` and no longer work in
15942 fragment mode.
15943+ Headerless tables are now printed properly in all writers.
15944 In addition, tbody, thead, and cols are used in HTML and Docbook
15945 tables.
15946+ Improved build system; removed obsolete Makefile.
15947+ In LaTeX writer, `\chapter` is now used instead of `\section`.
15948 when the documentclass is book, report, or memoir.
15949+ Many small bug fixes. See [changelog] for details.
15951## pandoc 1.4 (2010-01-02)
15953+ New template system replaces old headers, giving users much
15954 more control over pandoc's output in `--standalone` mode.
15955 Added `--template` and `--variable` options. The `--print-default-header`
15956 option is now `--print-default-template`. See README under
15957 "Templates" for details.
15958+ The old `--custom-header` option should still work, but it has
15959 been deprecated.
15960+ New `--reference-odt` option allows users to customize styles
15961 in ODT output.
15962+ Users may now put custom templates, s5 styles, and a reference
15963 ODT in the `~/.pandoc` directory, where they will override system
15964 defaults. See README for details.
15965+ Unicode is now used whenever possible in HTML and XML output. Entities
15966 are used only where necessary (`&gt;`, `&lt;`, `&quot;`, `&amp;`).
15967+ Authors and dates may now include formatting and notes.
15968+ Added `--xetex` option for `pandoc` and `markdown2pdf`.
15969+ Windows installer now includes highlighting support and
15970 `markdown2pdf` and `hsmarkdown` wrappers.
15971+ Pandoc no longer requires Template Haskell, which should make
15972 it more portable.
15973+ Pandoc can now be built on GHC 6.12, as well as earlier versions.
15974+ See README for other small improvements and bug fixes.
15976## pandoc 1.3 (2009-12-10)
15978+ Added `--id-prefix` option to help prevent duplicate
15979 identifiers when you're generating HTML fragments.
15980+ Added `--indented-code-classes` option, which specifies
15981 default highlighting syntax for indented code blocks.
15982+ `--number-sections` now affects HTML output.
15983+ Improved syntax for markdown definition lists.
15984+ Better looking simple tables.
15985+ Markdown tables without headers are now possible.
15986+ New hard line break syntax: backslash followed by newline.
15987+ Improved performance of markdown reader by ~10% by eliminating the
15988 need for a separate parsing pass for notes.
15989+ Improved syntax highlighting for literate Haskell.
15990+ Support for "..code-block" directive in RST reader.
15991+ Windows binary now includes highlighting support.
15992+ Many bug fixes and small improvements. See [changelog]
15993 for details.
15995## pandoc 1.2.1 (2009-07-18)
15997+ Improved the efficiency of the markdown reader's
15998 abbreviation parsing (should give a big performance
15999 boost with `--smart`).
16000+ HTML writer now wraps sections in divs with unique
16001 identifiers, for easier manipulation.
16002+ Improved LaTeX reader's coverage of math modes.
16003+ Added a portable Haskell version of markdown2pdf (thanks
16004 to Paolo Tanimoto).
16005+ Made `--strict` compatible with `--standalone` and `--toc.`
16006+ Many other small improvements and bug fixes.
16007 See [changelog] for details.
16009## pandoc 1.2 (2009-03-01)
16011+ Added support for literate Haskell. lhs support is triggered by
16012 '+lhs' suffixes in formats. For example, 'latex+lhs' is literate
16013 Haskell LaTeX. '.lhs' files are treated by default as literate
16014 markdown.
16015+ Added `--email-obfuscation` option.
16016+ Brought citeproc support up to date for citeproc-hs-0.2.
16017+ Many bugs fixed. See [changelog] for details.
16019## pandoc 1.1 (2008-11-06)
16021+ New `--jsmath` option supporting use of pandoc with [jsMath].
16022+ Classes on HTML table output for better CSS styling.
16023+ Windows installer no longer requires admin privileges.
16024+ Many bugs fixed. See [changelog] for details.
16026## pandoc 1.0 (2008-09-13)
16028+ New writers for MediaWiki, GNU Texinfo (thanks to Peter Wang),
16029 OpenDocument XML (thanks to Andrea Rossato), and ODT (OpenOffice
16030 document).
16031+ New [delimited code blocks](README.html#delimited-code-blocks),
16032 with optional syntax highlighting.
16033+ Reorganized build system: pandoc can now be built using standard
16034 Cabal tools. It can be compiled on Windows without Cygwin.
16035 The tests can also be run without perl or unix tools.
16036+ LaTeXMathML replaces ASCIIMathML for rendering math in HTML.
16037+ Support for "displayed" math.
16038+ Common abbreviations are now handled more intelligently, with
16039 a non-breaking space (and not a sentence-ending space) after
16040 the period.
16041+ Code is -Wall clean.
16042+ Many bug fixes and small improvements. See [changelog] for
16043 full details.
16045## pandoc 0.46 (2008-01-08)
16047+ Added a `--sanitize-html` option (and a corresponding parameter
16048 in `ParserState` for those using the pandoc libraries in programs).
16049 This option causes pandoc to sanitize HTML (in HTML or Markdown
16050 input) using a whitelist method. Possibly harmful HTML elements
16051 are replaced with HTML comments. This should be useful in the
16052 context of web applications, where pandoc may be used to convert
16053 user input into HTML.
16054+ Made -H, -A, and -B options cumulative: if they are specified
16055 multiple times, multiple files will be included.
16056+ Many bug fixes and small improvements. See [changelog] for full
16057 details.
16059## pandoc 0.45 (2007-12-09)
16061+ Many bug fixes and structural improvements. See [changelog] for
16062 full details.
16063+ Improved treatment of math. Math is now rendered using unicode
16064 by default in HTML, RTF, and DocBook output. For more accurate
16065 display of math in HTML, `--gladtex`, `--mimetex`, and `--asciimathml`
16066 options are provided. See the [User's Guide](README.html#math) for
16067 details.
16068+ Removed support for box-style block quotes in markdown.
16069+ More idiomatic ConTeXt output.
16070+ Text wrapping in ConTeXt and LaTeX output.
16071+ Pandoc now correctly handles all standard line endings
16072 (CR, LF, CRLF).
16073+ New `--no-wrap` option that disables line wrapping and minimizes
16074 whitespace in HTML output.
16075+ Build process is now compatible with both GHC 6.8 and GHC 6.6.
16076 GHC and GHC_PKG environment variables may be used to specify
16077 which version of the compiler to use, when multiple versions are
16078 installed.
16080## pandoc 0.44 (2007-09-03)
16082 [ John MacFarlane ]
16084 * Fixed bug in HTML writer: when --toc was used, anchors were put around
16085 headers, which is invalid XHTML (block content within inline element).
16086 Now the anchors are put inside the header tags. Resolves Issue #23.
16088 * Added xmlns attribute to html element in html writer tests.
16089 This attribute is added by more recent versions of the
16090 xhtml library (>= 3000), and is required for valid XHTML.
16092 [ Recai Oktaş ]
16094 * On configure, compile 'Setup.hs' to 'setup' and use 'setup' as the build
16095 command instead of 'runhaskell', which, on some platforms (such as s390,
16096 alpha, m68k), throws the following error:
16098 runhaskell Setup.hs configure --prefix=/usr
16099 ghc-6.6.1: not built for interactive use
16101 This causes a serious FTBFS bug. Closes: #440668.
16103## pandoc 0.43 (2007-09-02)
16105 [ John MacFarlane ]
16107 * The focus of this release is performance. The markdown parser
16108 is about five times faster than in 0.42, based on benchmarks
16109 with the TextMate manual.
16111 * Main.hs: Replaced CRFilter and tabFilter with single function
16112 tabFilter, which operates on the whole string rather than breaking
16113 it into lines, and handles dos-style line-endings as well as tabs.
16115 * Added separate LaTeX reader and native reader tests; removed
16116 round-trip tests.
16118 * Text.Pandoc.Shared:
16120 + Removed tabsToSpaces and tabsInLine (they were used only in Main.hs.)
16121 + General code cleanup (to elimante warnings when compiling with -Wall.)
16122 + Added 'wrapped' function, which helps wrap text into paragraphs,
16123 using the prettyprinting library.
16124 + Rewrote charsInBalanced and charsInBalanced'.
16125 - Documented restriction: open and close must be distinct characters.
16126 - Rearranged options for greater efficiency.
16127 - Bug fix: Changed inner call to charsInBalanced inside
16128 charsInBalanced' to charsInBalanced'.
16129 + anyLine now requires that the line end with a newline (not eof).
16130 This is a harmless assumption, since we always add newlines to the
16131 end of a block before parsing with anyLine, and it yields a 10% speed
16132 boost.
16133 + Removed unnecessary 'try' in anyLine.
16134 + Removed unneeded 'try' from romanNumeral parser.
16135 + Use notFollowedBy instead of notFollowedBy' in charsInBalanced.
16136 + Removed unneeded 'try' in parseFromString.
16137 + Removed unneeded 'try' from stringAnyCase. (Now it behaves
16138 like 'string'.)
16139 + Changed definition of 'enclosed' in Text.Pandoc.Shared so that
16140 'try' is not automatically applied to the 'end' parser. Added
16141 'try' in calls to 'enclosed' where needed. Slight speed increase.
16143 * Writers:
16145 + Replaced individual wrapping routines in RST, Man, and Markdown
16146 writers with 'wrapped' from Text.Pandoc.Shared.
16147 + Rewrote LaTeX writer to use the prettyprinting library,
16148 so we get word wrapping, etc.
16149 + Modified latex writer tests for new latex writer using prettyprinter.
16150 + Fixed bug in LaTeX writer: autolinks would not cause
16151 `\usepackage{url}` to be put in the document header. Also, changes
16152 to state in enumerated list items would be overwritten.
16153 + In Markdown writer, escape paragraphs that begin with ordered list
16154 markers, so they don't get interpreted as ordered lists.
16156 * Text.Pandoc.Reades.LaTeX:
16158 + Fixed bug in LaTeX reader, which wrongly assumed that the roman
16159 numeral after "enum" in "setcounter" would consist entirely of
16160 "i"s. 'enumiv' is legitimate.
16161 + LaTeX command and environment names can't contain numbers.
16162 + Rearranged order of parsers in inline for slight speed improvement.
16163 + Added '`' to special characters and 'unescapedChar'.
16165 * Text.Pandoc.Readers.RST:
16167 + Removed unneeded try's in RST reader; also minor code cleanup.
16168 + Removed tabchar.
16169 + Rearranged parsers in inline (doubled speed).
16171 * Text.Pandoc.Readers.Markdown:
16173 + Skip notes parsing if running in strict mode. (This yields a nice
16174 speed improvement in strict mode.)
16175 + Simplify autolink parsing code, using Network.URI to test for
16176 URIs. Added dependency on network library to debian/control and
16177 pandoc.cabal.
16178 + More perspicuous definition of nonindentSpaces.
16179 + Removed unneeded 'try' in 'rawLine'.
16180 + Combined linebreak and whitespace into a new whitespace parser, to
16181 avoid unnecessary reparsing of space characters.
16182 + Removed unnecessary 'try' in 'codeBlock', 'ellipses', 'noteMarker',
16183 'multilineRow', 'dashedLine', 'rawHtmlBlocks'.
16184 + Use lookAhead in parsers for setext headers and definition lists
16185 to see if the next line begins appropriately; if not, don't waste
16186 any more time parsing.
16187 + Don't require blank lines after code block. (It's sufficient to
16188 end code block with a nonindented line.)
16189 + Changed definition of 'emph': italics with '_' must not
16190 be followed by an alphanumeric character. This is to help
16191 prevent interpretation of e.g. `[LC_TYPE]: my_type` as
16192 `[LC<em>TYPE]:my</em>type`.
16193 + Improved Markdown.pl-compatibility in referenceLink: the two parts
16194 of a reference-style link may be separated by one space, but not
16195 more... [a] [link], [not] [a link].
16196 + Fixed markdown inline code parsing so it better accords with
16197 Markdown.pl: the marker for the end of the code section is a clump
16198 of the same number of `'s with which the section began, followed
16199 by a non-` character. So, for example,
16200 ` h ``` i ` -> `<code>h ``` i</code>`.
16201 + Split 'title' into 'linkTitle' and 'referenceTitle', since the
16202 rules are slightly different.
16203 + Rewrote 'para' for greater efficiency.
16204 + Rewrote link parsers for greater efficiency.
16205 + Removed redundant 'referenceLink' in definition of inline (it's
16206 already in 'link').
16207 + Refactored escapeChar so it doesn't need 'try'.
16208 + Refactored hrule for performance in Markdown reader.
16209 + More intelligent rearranging of 'inline' so that most frequently
16210 used parsers are tried first.
16211 + Removed tabchar parser, as whitespace handles tabs anyway.
16213 * Text.Pandoc.CharacterReferences:
16215 + Refactored.
16216 + Removed unnecessary 'try's for a speed improvement.
16217 + Removed unnecessary '&' and ';' from the entity table.
16219 * Build process:
16221 + Makefile: Get VERSION from cabal file, not Main.hs.
16222 + Modified MacPorts Portfile:
16223 - Depend on haddock
16224 - Build and install libraries and library documentation in
16225 addition to pandoc executable
16226 - Added template item for md5 sum in Portfile.in.
16227 - Incorporated changes from MacPorts repository (r28278).
16228 + FreeBSD port: Don't try to generate distinfo in Makefile.
16229 It can be made using 'make makesum' in FreeBSD.
16230 + Make both freebsd and macports targets depend on tarball.
16232 * Website and documentation:
16234 + Updated INSTALL instructions.
16235 + Added pandocwiki demo to website.
16236 + Removed local references to Portfile, since pandoc is now in the
16237 MacPorts repository.
16239## pandoc 0.42 (2007-08-26)
16241 [ John MacFarlane ]
16243 * Main.hs: Use utf8 conversion on the extra files loaded with
16244 the -H, -C, -B, and -A options. This fixes problems with unicode
16245 characters in these files.
16247 * Exposed Text.Pandoc.ASCIIMathML, since it is imported in
16248 Text.Pandoc.Readers.HTML and without it we get a linking error when
16249 using the library.
16251 * Markdown reader:
16253 + Added new rule for enhanced markdown ordered lists: if the list
16254 marker is a capital letter followed by a period (including a
16255 single-letter capital roman numeral), then it must be followed by
16256 at least two spaces. The point of this is to avoid accidentally
16257 treating people's initials as list markers: a paragraph might begin,
16258 "B. Russell was an English philosopher," and this shouldn't be
16259 treated as a list. Documented change in README.
16260 + Blocks that start with "p. " and a digit are no longer treated
16261 as ordered lists (it's a page number).
16262 + Added a needed 'try' to listItem.
16263 + Removed check for a following setext header in endline.
16264 A full test is too inefficient (doubles benchmark time), and the
16265 substitute we had before is not 100% accurate.
16266 + Don't use Code elements for autolinks if --strict specified.
16268 * LaTeX writer: When a footnote ends with a Verbatim environment, the
16269 close } of the footnote cannot occur on the same line or an error occurs.
16270 Fixed this by adding a newline before the closing } of every footnote.
16272 * HTML writer:
16273 + Removed incorrect "{}" around style information in HTML tables.
16274 Column widths now work properly in HTML.
16275 + If --strict option is specified (and --toc is not), don't include
16276 identifiers in headers, for better Markdown compatibility.
16278 * Build process:
16280 + Separated $(web_dest) and website targets.
16281 + In website, index.txt is now constructed from template index.txt.in.
16282 + Added freebsd target to Markefile. This creates the freebsd Makefile
16283 from Makefile.in, and creates distinfo. Removed Makefile and distinfo
16284 from the repository.
16285 + Added macport target to Makefile. Portfile is built from template
16286 Portfile.in.
16287 + Removed OSX package targets. (Too many difficulties involving
16288 dependencies on dynamic libraries.)
16289 + More complete INSTALL instructions for all architectures.
16291 * Website:
16292 + Added a programming demo, pandocwiki.
16294 [ Recai Oktaş ]
16296 * Do not forget to close pandoc's ITP. Closes: #391666
16298## pandoc 0.41 (2007-08-19)
16300 [ John MacFarlane ]
16302 * Fixed bugs in HTML reader:
16303 + Skip material at end *only if* `</html>` is present (previously,
16304 only part of the document would be parsed if an error was
16305 found; now a proper error message is given).
16306 + Added new constant eitherBlockOrInline with elements that may
16307 count either as block-level or as inline. Modified isInline and
16308 isBlock to take this into account.
16309 + Modified rawHtmlBlock to accept any tag (even an inline tag):
16310 this is innocuous, because rawHtmlBlock is tried only if a regular
16311 inline element can't be parsed.
16312 + Added a necessary 'try' in definition of 'para'.
16314 * Fixed bug in markdown ordered list parsing. The problem was that
16315 anyOrderedListStart did not check for a space following the
16316 ordered list marker. So in 'A.B. 2007' the parser would be
16317 expecting a list item, but would not find one, causing an error.
16318 Fixed a similar bug in the RST reader. Resolves Issue #22.
16320 * Refactored RST and Markdown readers using parseFromString.
16322 * LaTeX reader will now skip anything after \end{document}.
16324 * Fixed blockquote output in markdown writer: previously, block
16325 quotes in indented contexts would be indented only in the first
16326 line.
16328 * Added note to INSTALL about variations in versions of the xhtml
16329 library that can lead to failed tests (thanks to Leif LeBaron).
16331## pandoc 0.4 (2007-01-16)
16333 [ John MacFarlane ]
16335 * Added two new output formats: groff man pages and ConTeXt. By
16336 default, output files with extensions ".ctx" and ".context" are
16337 assumed to be ConTeXt, and output files with single-digit extensions
16338 are assumed to be man pages.
16340 * Enhanced ordered lists (documented in README, under Lists):
16341 + The OrderedList block element now stores information about
16342 list number style, list number delimiter, and starting number.
16343 + The readers parse this information when possible.
16344 + The writers use this information to style ordered lists.
16345 + The enhancement can be disabled using the --strict option.
16347 * Added support for tables (with a new Table block element). Two kinds
16348 of tables are supported: a simple table with one-line rows, and a
16349 more complex variety with multiline rows. All output formats are
16350 supported, but only markdown tables are parsed at the moment. The
16351 syntax is documented in README.
16353 * Added support for definition lists (with a new DefinitionList block
16354 element). All output and input formats are supported. The syntax is
16355 documented in README.
16357 * Added support for superscripts and subscripts (with new Superscript
16358 and Subscript inline elements). All input and output
16359 formats. The syntax is documented in README.
16361 * Added support for strikeout (with a new Strikeout inline element).
16362 All input and output formats are supported. Thanks to Bradley Kuhn,
16363 who contributed a patch. The syntax is documented in README. Resolves
16364 Issue #18.
16366 * Added a --toc|--table-of-contents option. This causes an automatically
16367 generated table of contents (or an instruction that creates one) to
16368 be inserted at the beginning of the document. Not supported in S5,
16369 DocBook, or man page writers.
16371 * Modified the -m|--asciimathml option:
16373 + If an optional URL argument is provided, a link is inserted
16374 instead of the contents of the ASCIIMathML.js script.
16375 + Nothing is inserted unless the document actually contains
16376 LaTeX math.
16378 * Removed Blank block element as unnecessary.
16380 * Removed Key and Note blocks from the Pandoc data structure. All
16381 links are now stored as explicit links, and note contents are
16382 stored with the (inline) notes.
16384 + All link Targets are now explicit (URL, title) pairs; there
16385 is no longer a 'Ref' target.
16386 + Markdown and RST parsers now need to extract data from key and
16387 note blocks and insert them into the relevant inline elements.
16388 Other parsers have been simplified, since there is no longer any need
16389 to construct separate key and note blocks.
16390 + Markdown, RST, and HTML writers need to construct lists of
16391 notes; Markdown and RST writers need to construct lists of link
16392 references (when the --reference-links option is specified); and
16393 the RST writer needs to construct a list of image substitution
16394 references. All writers have been rewritten to use the State monad
16395 when state is required.
16396 + Several functions (generateReference, keyTable,
16397 replaceReferenceLinks, replaceRefLinksBlockList, and some auxiliaries
16398 used by them) have been removed from Text.Pandoc.Shared, since
16399 they are no longer needed. New functions and data structures
16400 (Reference, isNoteBlock, isKeyBlock, isLineClump) have been
16401 added. The functions inTags, selfClosingTag, inTagsSimple, and
16402 inTagsIndented have been moved to the DocBook writer, since that
16403 is now the only module that uses them. NoteTable is now exported
16404 in Text.Pandoc.Shared.
16405 + Added stateKeys and stateNotes to ParserState; removed stateKeyBlocks,
16406 stateKeysUsed, stateNoteBlocks, stateNoteIdentifiers, stateInlineLinks.
16407 + Added writerNotes and writerReferenceLinks to WriterOptions.
16409 * Added Text.Pandoc module that exports basic readers, writers,
16410 definitions, and utility functions. This should export everything
16411 needed for most uses of Pandoc libraries. The haddock documentation
16412 includes a short example program.
16414 * Text.Pandoc.ASCIIMathML is no longer an exported module.
16416 * Added Text.Pandoc.Blocks module to help in printing markdown
16417 and RST tables. This module provides functions for working with
16418 fixed-width blocks of text--e.g., placing them side by side, as
16419 in a table row.
16421 * Refactored to avoid reliance on Haskell's Text.Regex library, which
16422 (a) is slow, and (b) does not properly handle unicode. This fixed
16423 some strange bugs, e.g. in parsing S-cedilla, and improved performance.
16425 + Replaced 'gsub' with a general list function 'substitute'
16426 that does not rely on Text.Regex.
16427 + Rewrote extractTagType in HTML reader so that it doesn't use
16428 regexs.
16429 + In Markdown reader, replaced email regex test with a custom email
16430 autolink parser (autoLinkEmail). Also replaced selfClosingTag regex
16431 with a custom function isSelfClosingTag.
16432 + Modified Docbook writer so that it doesn't rely on Text.Regex for
16433 detecting 'mailto' links.
16434 + Removed escapePreservingRegex and reamped entity-handling
16435 functions in Text.Pandoc.Shared and Text.Pandoc.CharacterReferences to
16436 avoid reliance on Text.Regex (see below on character reference
16437 handling changes).
16439 * Renamed Text.Pandoc.Entities as Text.Pandoc.CharacterReferences.
16441 * Changed handling of XML entities. Entities are now parsed (and unicode
16442 characters returned) in the Markdown and HTML readers, rather than being
16443 handled in the writers. In HTML and Docbook writers, UTF-8 is now used
16444 instead of entities for characters above 128. This makes the HTML and
16445 DocBook output much more readable and more easily editable.
16447 + Removed sgmlHexEntity, sgmlDecimalEntity, sgmlNamedEntity, and
16448 sgmlCharacterEntity regexes from Text.Pandoc.Shared.
16449 + Renamed escapeSGMLChar to escapeCharForXML. Added escapeStringForXML.
16450 Moved both functions to Text.Pandoc.Writers.Docbook.
16451 + Added characterReference parser to Text.Pandoc.CharacterReferences.
16452 This parses a string and return a unicode character.
16453 + Rewrote decodeCharacterReferences to use the new parser instead of
16454 Text.Regex.
16455 + Added new charRef parser for Markdown and HTML, which replaces the
16456 old 'entity' parser. Added '&' as a special character in Markdown reader.
16457 + Modified HTML and Markdown readers to call decodeEntities on all raw
16458 strings (e.g. authors, dates, link titles), to ensure that no
16459 unprocessed entities are included in the native representation of
16460 the document. (In the HTML reader, most of this work is done by a
16461 change in extractAttributeName.)
16462 + In XML and Markdown output, escape unicode nonbreaking space as '&nbsp;',
16463 since a unicode non-breaking space is impossible to distinguish visually
16464 from a regular space. (Resolves Issue #3.)
16465 + Removed encodeEntitiesNumerical.
16466 + Use Data.Map for entityTable and (new) reverseEntityTable, for a
16467 slight performance boost over the old association list.
16468 + Removed unneeded decodeEntities from 'str' parser in HTML and
16469 Markdown readers.
16471 * Text.Pandoc.UTF8: Renamed encodeUTF8 to toUTF8, decodeUTF8 to
16472 fromUTF8, for clarity.
16474 * Replaced old haskell98 module names replaced by hierarchical module
16475 names, e.g. List by Data.List. Removed haskell98 from dependencies
16476 in pandoc.cabal, and added mtl (needed for state monad). Substituted
16477 xhtml for html.
16479 * Refactored and cleaned up character escaping in writers, using
16480 backslashEscapes and escapeStringUsing functions.
16482 * Instead of adding `\n\n` to the end of an input string in Main.hs,
16483 this is now done in the readers. This makes the libraries behave
16484 the way you'd expect from the pandoc program. Resolves Issue #10.
16486 * URLs and email addresses in autolinks are now typeset as Code.
16488 * In Main.hs, changed putStr to putStrLn -- mainly because MacOS X
16489 doesn't display the whole output unless there's a line ending.
16491 * Major code cleanup in all modules, for greater consistency, concision,
16492 and readability.
16494 * HTML reader:
16496 + Fixed several bugs (extractTagType, attribute parsing).
16497 + Remove Null blocks in lists of blocks when possible.
16498 + Allow HTML comments as raw HTML inline.
16500 * Markdown reader:
16502 + Ordered list items may no longer begin with uppercase letters, or
16503 letters greater than 'n'. (This prevents first initials and page
16504 reference, e.g. 'p. 400', from being parsed as beginning lists.)
16505 Also, numbers beginning list items may no longer end with ')',
16506 which is now allowed only after letters. Note: These changes
16507 may cause documents to be parsed differently. Users should take
16508 care in upgrading.
16509 + Changed autoLink parsing to conform better to Markdown.pl's
16510 behavior. `<google.com>` is not treated as a link, but
16511 `<http://google.com>`, `<ftp://google.com>`, and
16512 `<mailto:google@google.com>` are.
16513 + Cleaned up handling of embedded quotes in link titles. Now these are
16514 stored as a '"' character, not as '&quot;'.
16515 + Use lookAhead parser for the 'first pass' (looking for reference keys),
16516 instead of parsing normally, then using setInput to reset input. This
16517 yields a slight performance boost.
16518 + Fixed several bugs in smart quote recognition.
16519 + Fixed bug in indentSpaces (which didn't properly handle
16520 cases with mixed spaces and tabs).
16521 + Consolidated 'text', 'special', and 'inline' into 'inline'.
16522 + Fixed bug which allowed URL and title to be separated by multiple blank
16523 lines in links and reference keys. They can be on separate lines but
16524 can't have blank lines between them.
16525 + Correctly handle bracketed text inside inline footnotes and links,using
16526 new function inlinesInBalanced. Resolves Issue #14.
16527 + Fixed bug in footnotes: links in footnotes were not being
16528 processed. Solution: three-stage parse. First, get all the
16529 reference keys and add information to state. Next, get all the
16530 notes and add information to state. (Reference keys may be needed
16531 at this stage.) Finally, parse everything else.
16532 + Replaced named constants like 'emphStart' with literals.
16533 + Removed an extra occurrence of escapedChar in definition of inline.
16535 * RST reader:
16537 + Allow the URI in a RST hyperlink target to start on the line
16538 after the reference key.
16539 + Added 'try' in front of 'string', where needed, or used a different
16540 parser. This fixes a bug where ````` would not be correctly parsed as
16541 a verbatim `.
16542 + Fixed slow performance in parsing inline literals in RST reader. The
16543 problem was that ``#`` was seen by 'inline' as a potential link or image.
16544 Fix: inserted 'notFollowedBy (char '`')' in link parsers.
16545 Resolves Issue #8.
16546 + Use lookAhead instead of getInput/setInput in RST reader. Removed
16547 unneeded getState call, since lookAhead automatically saves and
16548 restores the parser state.
16549 + Allow hyperlink target URIs to be split over multiple lines, and
16550 to start on the line after the reference. Resolves Issue #7.
16551 + Fixed handling of autolinks.
16553 * LaTeX reader:
16555 + Replaced `choice [(try (string ...), ...]` idiom with `oneOfStrings`,
16556 for clarity.
16557 + Added clauses for tilde and caret. Tilde is `\ensuremath{\sim}`, and
16558 caret is `\^{}`, not `\^` as before.
16559 + Added parsing for `\url`.
16560 + Parse `\texttt{}` as code, provided there's nothing fancy inside.
16562 * HTML writer:
16564 + Modified HTML writer to use the Text.XHtml library. This results
16565 in cleaner, faster code, and it makes it easier to use Pandoc in
16566 other projects, like wikis, which use Text.XHtml. Two functions are
16567 now provided, writeHtml and writeHtmlString: the former outputs an
16568 Html structure, the latter a rendered string. The S5 writer is also
16569 changed, in parallel ways (writeS5, writeS5String).
16570 + The Html header is now written programmatically, so it has been
16571 removed from the 'headers' directory. The S5 header is still
16572 needed, but the doctype and some of the meta declarations have
16573 been removed, since they are written programmatically. This change
16574 introduces a new dependency on the xhtml package.
16575 + Fixed two bugs in email obfuscation involving improper escaping
16576 of '&' in the `<noscript>` section and in `--strict` mode. Resolves
16577 Issue #9.
16578 + Fixed another bug in email obfuscation: If the text to be obfuscated
16579 contains an entity, this needs to be decoded before obfuscation.
16580 Thanks to thsutton for the patch. Resolves Issue #15.
16581 + Changed the way the backlink is displayed in HTML footnotes.
16582 Instead of appearing on a line by itself, it now generally
16583 appears on the last line of the note. (Exception: when the
16584 note does not end with a Plain or Para block.) This saves space
16585 and looks better.
16586 + Added automatic unique identifiers to headers:
16587 - The identifier is derived from the header via a scheme
16588 documented in README.
16589 - WriterState now includes a list of header identifiers and a table
16590 of contents in addition to notes.
16591 - The function uniqueIdentifiers creates a list of unique identifiers
16592 from a list of inline lists (e.g. headers).
16593 - This list is part of WriterState and gets consumed by blockToHtml
16594 each time a header is encountered.
16595 + Include CSS for .strikethrough class in header only if strikethrough
16596 text appears in the document.
16597 + If the 'strict' option is specified, elements that do not appear in
16598 standard markdown (like definition lists) are passed through as
16599 raw HTML.
16600 + Simplified treatment of autolinks, using pattern matching instead of
16601 conditionals.
16603 * Markdown writer:
16605 + Links in markdown output are now printed as inline links by default,
16606 rather than reference links. A --reference-links option has been added
16607 that forces links to be printed as reference links. Resolves Issue #4.
16608 + Use autolinks when possible. Instead of `[site.com](site.com)`,
16609 use `<site.com>`.
16611 * LaTeX writer:
16613 + Rewrote to use the State monad. The preamble now includes only those
16614 packages that are actually required, given the document's content.
16615 Thus, for example, if strikeout is not used, ulem is not required.
16616 Modified LaTeXHeader accordingly.
16617 + Modified LaTeX writer to insert `\,` between consecutive quotes.
16618 + Removed unused function tableRowColumnWidths.
16619 + Simplified code for escaping special characters.
16620 + Leave extra blank line after `\maketitle`.
16621 + Include empty `\author{}` when no author specified to avoid LaTeX
16622 errors.
16623 + Include fancyvrb code in header only if needed -- that is, only
16624 if there is actually code in a footnote.
16625 + Use `\url{}` for autolinks.
16626 + Include [mathletters] option in ucs package, so that basic unicode
16627 Greek letters will work correctly.
16629 * RST writer: Force blank line before lists, so that sublists will
16630 be handled correctly.
16632 * Docbook writer: Fixed a bug: email links with text, like
16633 [foo](me@bar.baz), were being incorrectly treated as autolinks.
16635 * Removed Text.ParserCombinators.Pandoc and moved all its functions to
16636 Text.Pandoc.Shared.
16638 * Text.Pandoc.Shared:
16640 + Added defaultWriterOptions.
16641 + Added writerTableOfContents to WriterOptions.
16642 + Added writerIgnoreNotes option to WriterOptions. This is needed
16643 for processing header blocks for a table of contents, since notes on
16644 headers should not appear in the TOC.
16645 + Added prettyprinting for native Table format.
16646 + Removed some unneeded imports.
16647 + Moved escape and nullBlock parsers from
16648 Text.ParserCombinators.Pandoc, since the latter is for
16649 general-purpose parsers that don't depend on Text.Pandoc.Definition.
16650 + Moved isHeaderBlock from Text.Pandoc.Writers.HTML.
16651 + Moved Element, headerAtLeast, and hierarchicalize from Docbook
16652 writer, because HTML writer now uses these in constructing a table
16653 of contents.
16654 + Added clauses for new inline elements (Strikeout, Superscript,
16655 Subscript) to refsMatch.
16656 + Removed backslashEscape; added new functions escapeStringUsing and
16657 backslashEscapes.
16658 + Moved failIfStrict from markdown reader, since it is now used also
16659 by the HTML reader.
16660 + Added a 'try' to the definition of indentSpaces.
16661 + In definition of 'reference', added check to make sure it's not a note
16662 reference.
16663 + Added functions: camelCaseToHyphenated, toRomanNumeral,
16664 anyOrderedListMarker, orderedListmarker, orderedListMarkers,
16665 charsInBalanced', withHorizDisplacement, romanNumeral
16666 + Fixed a bug in the anyLine parser. Previously it would parse an empty
16667 string "", but it should fail on an empty string, or we get an error
16668 when it is used inside "many" combinators.
16669 + Removed followedBy' parser, replacing it with the lookAhead parser from
16670 Parsec.
16671 + Added some needed 'try's before multicharacter parsers, especially in
16672 'option' contexts.
16673 + Removed the 'try' from the 'end' parser in 'enclosed', so that
16674 'enclosed' behaves like 'option', 'manyTill', etc.
16675 + Added lineClump parser, which parses a raw line block up to and
16676 including any following blank lines.
16677 + Renamed parseFromStr to parseFromString.
16678 + Added a 'try' to the 'end' parser in 'enclosed'. This makes errors in
16679 the use of 'enclosed' less likely. Removed some now-unnecessary 'try's
16680 in calling code.
16681 + Removed unneeded 'try' in blanklines.
16682 + Removed endsWith function and rewrote calling functions to use
16683 isSuffixOf instead.
16684 + Added >>~ combinator.
16685 + Fixed bug in normalizeSpaces: Space:Str "":Space should compress to
16686 Space.
16688 * Refactored runtests.pl; added separate tests for tables.
16690 * Shell scripts:
16692 + Added -asxhtml flag to tidy in html2markdown. This will
16693 perhaps help the parser, which expects closing tags.
16694 + Modified markdown2pdf to run pdflatex a second time if --toc or
16695 --table-of-contents was specified; otherwise the table of
16696 contents won't appear.
16697 + Modified markdown2pdf to print a helpful message if the 'ulem'
16698 LaTeX package is required and not found.
16700 * Changes to build process:
16702 + Dropped support for compilation with GHC 6.4. GHC 6.6 or higher
16703 is now required.
16704 + Removed cabalize and Pandoc.cabal.in. The repository now contains
16705 pandoc.cabal itself.
16706 + Pandoc.cabal has been changed to pandoc.cabal, because HackageDB
16707 likes the cabal file to have the same name as the tarball.
16708 + Expanded and revised the package description in pandoc.cabal.
16709 Revised the package synopsis.
16710 + The tarball built by 'make tarball' now contains files built from
16711 templates (including man pages and shell scripts), so pandoc can
16712 be built directly using Cabal tools, without preprocessing.
16713 + Executable binaries are now stripped before installing.
16714 + Man pages are now generated from markdown sources, using pandoc's
16715 man page writer.
16716 + Use HTML version of README (instead of RTF) in Mac OS X installer.
16717 + Instead of testing for the existence of a pandoc symlink in build-exec,
16718 use ln -f.
16720 * Documentation:
16722 + Updated README and man pages with information on new features.
16723 + Updated INSTALL instructions with some useful clarifications and
16724 links.
16725 + Updated web content.
16727 * Added FreeBSD port.
16729 [ Recai Oktaş ]
16731 * debian/control:
16733 + Changed pandoc's Build-Depends to include libghc6-mtl-dev and
16734 libghc6-xhtml-dev. Removed libghc6-html-dev.
16735 + Suggest texlive-latex-recommended | tetex-extra instead of
16736 tetex-bin. This brings in fancyvrb and unicode support.
16739## pandoc 0.3 (2007-01-05)
16741 [ John MacFarlane ]
16743 * Changes in pandoc options:
16745 + Allow options to follow or precede arguments.
16746 + Changed '--smartypants' to '--smart' and adjusted symbols accordingly.
16747 + Added '--strict' option.
16748 + Added '-o/--output' option.
16749 + Added '--dump-args' and '--ignore-args' options (for use in wrappers).
16750 + Modified '-v' and '-h' output to go to STDERR, not STDOUT, and return
16751 error conditions. This is helpful for writing wrappers.
16752 + Added copyright message to '-v' output, modeled after FSF messages.
16753 + Reformatted usage message so that it doesn't wrap illegibly.
16754 + Removed extra blanks after '-h' and '-D' output.
16756 * Added docbook writer.
16758 * Added implicit setting of default input and output format based
16759 on input and output filename extensions. These defaults are
16760 overridden if explicit input and output formats are specified using
16761 '-t', '-f', '-r', or '-w' options. Documented in pandoc(1) man page
16762 and README.
16764 * Allow ordered list items to begin with (single) letters, as well
16765 as numbers. The list item marker may now be terminated either by
16766 '.' or by ')'. This extension to standard markdown is documented
16767 in README.
16769 * Revised footnote syntax. (See README for full details.) The
16770 '[^1]' format now standard in markdown extensions is supported,
16771 as are inline footnotes with this syntax: `^[My note.]`.
16772 The earlier footnote syntax `^(1)` is no longer supported.
16774 * Improved HTML representation of footnotes. All footnotes
16775 are now auto-numbered and appear in an ordered list at the
16776 end of the HTML document. Since the default appearance is now
16777 acceptable, the old footnote styles have been removed from the
16778 HTML header.
16780 * Bug fixes:
16782 + Fixed a serious bug in the markdown, LaTeX, and RST readers.
16783 These readers ran 'runParser' on processed chunks of text to handle
16784 embedded block lists in lists and quotation blocks. But then
16785 any changes made to the parser state in these chunks was lost,
16786 as the state is local to the parser. So, for example, footnotes
16787 didn't work in quotes or list items. The fix: instead of calling
16788 runParser on some raw text, use setInput to make it the input, then
16789 parse it, then use setInput to restore the input to what it was
16790 before. This is shorter and more elegant, and it fixes the problem.
16791 + Fixed bug in notFollowedBy' combinator (adding 'try' before
16792 'parser'). Adjusted code that uses this combinator accordingly.
16793 + Fixed bug in RTF writer that caused improper indentation on
16794 footnotes occurring in indented blocks like lists.
16795 + Fixed parsing of metadata in LaTeX reader. Now the title, author,
16796 and date are parsed correctly. Everything else in the preamble
16797 is skipped.
16798 + Modified escapedChar in LaTeX reader to allow a `\` at the end of a
16799 line to count as escaped whitespace.
16800 + Modified LaTeX reader to produce inline links rather than reference
16801 links. Otherwise, links in footnotes aren't handled properly.
16802 + Fixed handling of titles in links in Markdown reader, so that
16803 embedded quotation marks are now handled properly.
16804 + Fixed Markdown reader's handling of embedded brackets in links.
16805 + Fixed Markdown reader so that it only parses bracketed material
16806 as a reference link if there is actually a corresponding key.
16807 + Revised inline code parsing in Markdown reader to conform to
16808 markdown standard. Now any number of `s can begin inline code,
16809 which will end with the same number of `s. For example, to
16810 have two backticks as code, write ``` `` ```. Modified Markdown
16811 writer accordingly.
16812 + Fixed bug in text-wrapping routine in Markdown and RST writers.
16813 Now LineBreaks no longer cause wrapping problems.
16814 + Supported hexadecimal numerical entity references as well as
16815 decimal ones.
16816 + Fixed bug in Markdown reader's handling of underscores and other
16817 inline formatting markers inside reference labels: for example,
16818 in '[A_B]: /url/a_b', the material between underscores was being
16819 parsed as emphasized inlines.
16820 + Changed Markdown reader's handling of backslash escapes so that
16821 only non-alphanumeric characters can be escaped. Strict mode
16822 follows Markdown.pl in only allowing a select group of punctuation
16823 characters to be escaped.
16824 + Modified HTML reader to skip a newline following a `<br>` tag.
16825 Otherwise the newline will be treated as a space at the beginning
16826 of the next line.
16828 * Made handling of code blocks more consistent. Previously, some
16829 readers allowed trailing newlines, while others stripped them.
16830 Now, all readers strip trailing newlines in code blocks. Writers
16831 insert a newline at the end of code blocks as needed.
16833 * Modified readers to make spacing at the end of output more consistent.
16835 * Minor improvements to LaTeX reader:
16837 + `\thanks` now treated like a footnote.
16838 + Simplified parsing of LaTeX command arguments and options.
16839 commandArgs now returns a list of arguments OR options (in
16840 whatever order they appear). The brackets are included, and
16841 a new stripFirstAndLast function is provided to strip them off
16842 when needed. This fixes a problem in dealing with \newcommand
16843 and \newenvironment.
16845 * Revised RTF writer:
16847 + Default font is now Helvetica.
16848 + An `\f0` is added to each `\pard`, so that font resizing works
16849 correctly.
16851 * Moved handling of "smart typography" from the writers to the Markdown
16852 and LaTeX readers. This allows great simplification of the writers
16853 and more accurate smart quotes, dashes, and ellipses. DocBook can
16854 now use `<quote>`. The '--smart' option now toggles an option in
16855 the parser state rather than a writer option. Several new kinds
16856 of inline elements have been added: Quoted, Ellipses, Apostrophe,
16857 EmDash, EnDash.
16859 * Changes in HTML writer:
16861 + Include title block in header even when title is null.
16862 + Made javascript obfuscation of emails even more obfuscatory,
16863 by combining it with entity obfuscation.
16865 * Changed default ASCIIMathML text color to black.
16867 * Test suite:
16869 + Added --strip-trailing-cr option to diff in runtests.pl, for
16870 compatibility with Windows.
16871 + Added regression tests with footnotes in quote blocks and lists.
16873 * Makefile changes:
16875 + osx-pkg target creates a Mac OS X package (directory). New osx
16876 directory contains files needed for construction of the package.
16877 + osx-dmg target creates a compressed disk image containing the package.
16878 + win-pkg target creates Windows binary package.
16879 + tarball target creates distribution source tarball.
16880 + website target generates pandoc's website automatically, including
16881 demos. New 'web' directory contains files needed for construction
16882 of the website (which will be created as the 'pandoc' subdirectory
16883 of 'web').
16884 + Makefile checks to see if we're running Windows/Cygwin; if so,
16885 a '.exe' extension is added to each executable in EXECS.
16887 * Removed all wrappers except markdown2pdf and html2markdown.
16889 * Added new wrapper hsmarkdown, to be used as a drop-in replacement
16890 for Markdown.pl. hsmarkdown calls pandoc with the '--strict'
16891 option and disables other options.
16893 * Added code to html2markdown that tries to determine the character
16894 encoding of an HTML file, by parsing the "Content-type" meta tag.
16896 + If the encoding can't be determined, then if the content is local,
16897 the local encoding is used; if it comes from a URL, UTF-8 is used
16898 by default.
16899 + If input is from STDIN, don't try to determine character encoding.
16900 + Encoding can be specified explicitly using '-e' option.
16902 * Improved warning messages in wrappers:
16904 + Print warning if iconv not available
16905 + More user-friendly error messages in markdown2pdf, when
16906 pdflatex fails.
16908 * Code cleanup:
16910 + Renamed 'Text/Pandoc/HtmlEntities' module to
16911 'Text/Pandoc/Entities'. Also changed function names so as
16912 not to be HTML-specific.
16913 + Refactored SGML string escaping functions from HTML and Docbook
16914 writers into Text/Pandoc/Shared. (escapeSGML, stringToSGML)
16915 + Removed 'BlockQuoteContext' from ParserContext, as it isn't
16916 used anywhere.
16917 + Removed splitBySpace and replaced it with a general, polymorphic
16918 splitBy function.
16919 + Refactored LaTeX reader for clarity (added isArg function).
16920 + Converted some CR's to LF's in src/ui/default/print.css.
16921 + Added license text to top of source files.
16922 + Added module data for haddock to source files.
16923 + Reformatted code for consistency.
16925 * Rewrote documentation and man pages. Split README into INSTALL
16926 and README.
16928 * Split LICENSE into COPYING and COPYRIGHT.
16930 * Removed TODO, since we now maintain ToDo on the wiki.
16932 * Made COPYRIGHT in top level a symlink to debian/copyright, to avoid
16933 duplication.
16935 [ Recai Oktaş ]
16937 * Revamped build process to conform to debian standards and created
16938 a proper debian package. Closes: #391666.
16940 * Modified build process to support GHC 6.6.
16942 + The package can still be compiled using GHC 6.4.2, though because
16943 of dependencies the "make deb" target works only with GHC 6.6+.
16944 + The script 'cabalize' is used to create an appropriate
16945 'Pandoc.cabal' from 'Pandoc.cabal.in', depending on the GHC and
16946 Cabal versions.
16948 * Refactored template processing (fillTemplates.pl).
16950 * Modified wrapper scripts to make them more robust and portable.
16951 To avoid code duplication and ensure consistency, wrappers are
16952 generated via a templating system from templates in src/wrappers.
16954 + Wrappers now accept multiple filenames, when appropriate.
16955 + Spaces and tabs allowed in filenames.
16956 + getopts shell builtin is used for portable option parsing.
16957 + Improved html2markdown's web grabber code, making it more robust,
16958 configurable and verbose. Added '-e', '-g' options.
16961## pandoc 0.2 (2006-08-14)
16963 * Fixed unicode/utf-8 translation
16965## pandoc 0.1 (2006-08-14)
16967 * Initial creation of debian package