Pandoc Changelog

What's new in Pandoc 3.1.13

Apr 9, 2024
  • Org reader:
  • Fix treatment of id property under heading (#9639).
  • DocBook reader:
  • Add empty title to admonition div if not present (#9569). This allows admonition elements (e.g. ) to work with gfm admonitions even if the is not present.
  • DokuWiki reader:
  • Link text cannot contain formatting (e.g., // is not italics) (#9630).
  • An explicitly empty link text ([[url|]]) works the same as an omitted link text (#9632).
  • Typst reader:
  • Support Typst 0.11 table features: col/rowspans, table head and foot (#9588).
  • Parse cell col/rowspans.
  • CSLJson writer:
  • Put $ or $$ around math in csljson output (#9616).
  • ConTeXt writer:
  • Fix options order with externalfigure. The dimensions should come beforeafter the class if both are present.
  • Typst writer:
  • Put label after Span, not before. Labels get applied to preceding markup item.
  • Support Typst 0.11 table features (#9588): colspans, rowspans, cell alignment overrides, relative column widths, header and footer, multiple table bodies with intermediate headers. Row heads are not yet supported.
  • The default typst template has been modified so that tables don’t have lines by default. As is standard with pandoc, we only add a line under a header or over a footer. However, a different default stroke pattern can easily be added in a template.
  • More reliable escaping in inline [..] contexts (#9586). For example, we need to escape [1. April] or it will be treated as an ordered list.
  • Handle unnumbered on headings (#9585).
  • LaTeX writer:
  • Fix math inside strikeout (#9597).
  • Text.Pandoc.Writers.Shared:
  • Export isOrderedListMarker [API change].
  • Other:
  • Change lhs tests so they don’t use --standalone. This will avoid test failures due to minor changes in skylighting versions, e.g. #9589.
  • Use latest texmath, typst.
  • Require pandoc-lua-marshal 0.2.6 (#9613, Albert Krewinkel). Fixes an issue arising when the value of content properties on BlockQuote, Figure, and Div elements was an empty list.
  • Update lua-filters.md (#9611, Carlos Scheidegger).

New in Pandoc 3.1.12.3 (Mar 18, 2024)

  • Markdown reader: Fix bug with footnotes at end of fenced div (#9576).
  • LaTeX template: Fix block headings support for unnumbered paragraphs (#9542, #6018, Oliver Fabel).
  • HTML templates: Replace polyfill provider (#9537, @SukkaW). Replace polyfill.io with cdnjs.cloudflare.com/polyfill. polyfill.io has been acquired by Funnull, and the service has become unstable.
  • Korean translations: delete colon in translation for ‘to’. This was invalid YAML, and not desired anyway, since a colon is added.
  • Use latest commonmark, commonmark-extensions. This fixes a 3.12 regression in parsing of commonmark/gfm autolinks (jgm/commonmark-hs#151).
  • Depend on djot 0.1.1.3, which fixes a serious parsing bug affecting regular paragraphs after lists.
  • Depend on latest skylighting, skylighting-core, typst-hs, texmath.
  • MANUAL.txt: Change broken link to IDML cookbook (#9563).
  • LaTeX reader:
  • Improve tokenization of @ (#9555). Make tokenization sensitive to makeatletter/makeatother. Previously we just always treated @ as a letter. This led to bad results, e.g. with the sequence @. E.g., a@ b would parse as “ab” and a@b as “a”.
  • Make withRaw work inside parseFromToks (#9517). This is needed for raw environments to work inside table cells.
  • Better handling of table colwidths (#9579). Previously the parser just failed if the column width specified in p{} wasn’t a multiple of linewidth. This led to cases where content was skipped.
  • Typst writer:
  • Add ‘kind’ parameter to figures with tables (#9574).
  • Avoid unnecessary box around image in figure (#9236).
  • Omit width/height in images unless explicitly specified (#9236). Previously we computed width/heigth for images that didn’t have size information, because otherwise typst would expand the image to fit page width. This typst behavior has changed in 0.11. This change fixes a bug in which images would sometimes overflow page margins, depending on their intrinsic size.
  • Don’t add hard-coded inset to tables (#9580). Instead, set this globally in the default template, allowing it to be customized.

New in Pandoc 3.1.12.2 (Mar 1, 2024)

  • Docx reader.
  • Ensure that table captions are counted (#9518).
  • Detect caption by style name not id (#9518). The styleId can change depending on the localization.
  • Avoid emitting empty paragraph where caption was.
  • Markdown reader: fix regression in link parsing with wikilinks extensions (#9481). This fixes a regression introduced in 3.1.12.
  • Org reader/writer: support admonitions (#9475).
  • Org writer: omit extra blank line at end of quote block.
  • Typst writer: ensure that -, +, etc. are escaped at beginning of block (#9478). Our recent relaxing of escaping (#9386) caused problems for things like emphasized - characters that were rendered using #strong[-]#. This now gets rendered as #strong[-].
  • LaTeX writer: fix bug when a language is specified in two different ways (#9472). If you used lang: de-DE but then had a span or div with lang=de, the preamble would try to load ngerman twice, leading to an error. This fix ensures that a language is only loaded once.
  • Docx writer: Don’t copy over footnotePr in settings.xml from reference.docx (#9522).
  • EPUB writer: omit EPUB2-specific meta tag on EPUB3 (#9493). This caused a validation failure in epubs with cover images.
  • Lua: avoid crashing when an error message is not valid UTF-8 (Albert Krewinkel).
  • Text.Pandoc.SelfContained.
  • Add role="img" to svgs.
  • Add aria-label to svg elements with alt text if present. Screen readers ignore alt attributes on svg elements but do pay attention to aria-label (#9525).
  • Text.Pandoc.Shared: Fix regression in section numbering in makeSections (#9516). Starting with pandoc 3.1.12, unnumbered sections incremented the section number.
  • Text.Pandoc.Class: fix openUrl TLS negotiation (#9483). With the release of TLS 2.0.0, the TLS library started requiring Extended Main Secret for the TLS handshake. This caused problems connecting to zotero’s server and others that do not support TLS 1.3. This commit relaxes this requirement.
  • Depend on djot 0.1.1.0 (fixes rendering on multiline block attributes).
  • Use new releases of skylighting-format-blaze-html (#9520). Fixes auto-wrapping of long source lines in HTML print media.
  • Use new commonmark-extensions (fixes issue with the rebase_relative_paths extension when used with commonmark/gfm.
  • Makefile: improve epub-validation target (#9493). Use --epub-cover-image to catch issues that only arise with that.

New in Pandoc 3.1.12.1 (Feb 19, 2024)

  • EPUB writer: omit EPUBv3-specific accessibility features on epub2 (#9469). Fixes a regression in 3.1.12.
  • More fixes for SVG ids with --self-contained (#9467). This generalizes the fix to #9420 so it applies to things like style="fill(url(#..." and should fix problems with SVGs including gradients.
  • Powerpoint writer: properly handle math in headings and tables (#9465). This ensures that paragraphs containing math are wrapped in a mc:AlternateContent node as required.
  • Makefile: make validate-epub check v2 output too.

New in Pandoc 3.1.12 (Feb 16, 2024)

  • Add djot as input and output format. Djot is a light markup syntax (https://djot.net).
  • New module Text.Pandoc.Readers.Djot [API change]. The function readDjot is also exported by Text.Pandoc.Readers.
  • New module Text.Pandoc.Writers.Djot [API change]. The function writeDjot is also exported by Text.Pandoc.Writers.
  • --number-sections now uses the first digit for the number of the top-level section, no matter what its level. So if the top-level section is level-2, numbers will be 1, 2, etc. rather than 0.1, 0.2, as in the past (#5071). For some backwards compatibility, we revert to the old behavior when the --number-offset option is used.
  • DocBook reader:
  • Better handling of and (#9341): now gets parsed as an ordered list, and as a sublist.
  • Man reader:
  • Move spaces outside of emph/strong (#9445).
  • MediaWiki reader:
  • Don’t make leading blanks underscores in image links (#9425).
  • Allow lowercase image: (#9424).
  • BibTeX reader:
  • Support pagetotal in converting BibLaTeX.
  • Markdown reader:
  • Fix wikilinks extensions to allow newlines in titles (#9454).
  • EPUB reader:
  • Don’t put # characters in identifiers.
  • LaTeX reader:
  • Improve treatment of cref, Cref (#7463). Use the reference-type ref+label and ref+Label. Also, associate with vref ref instead of ref+page.
  • Limited support for Cref (#7463).
  • Generate relative widths for linewidth, textheight (#9388).
  • Typst reader:
  • Fix handling of overline (#9294). Due to a typo, it was being incorrectly rendered as an underset.
  • Improve handling of inline #quote (#9413).
  • Fix handling of dot(), tilde(), ddot() (jgm/typst-hs#38).
  • Fix character used for norm (jgm/typst-hs#38).
  • Typst writer:
  • Use reference form (e.g. @jones2000[p. 30]) for citations when possible.
  • Use #ref or @ for links with reference-type="ref" (#7463). This attribute is added to LaTeX cref, for example.
  • Improve citation support (#9452). Emit form: "prose" or form: "year" qualifiers if the citation is author-in-text or suppress-author. Strip initial comma from suffix, since typst will add an extra one.
  • Unescape URI escapes in image paths (#9389).
  • Handle labels and citaiton ids with spaces and other special characters (#9387). In these cases, we produce an explicit label() rather than using or @.
  • Avoid producing illegal labels (#9387).
  • Avoid unnecessary escapes (#9386).
  • LaTeX writer:
  • Make writer sensitive to empty_paragraphs extension (#9443).
  • Fix beamer highlighting (mh4ckt3mh4ckt1c4s).
  • Create valid table even when table is empty (#9350).
  • Set font fallback for babel main font (Max Heller).
  • Add some kerns where needed between quotes (#9371).
  • HTML writer:
  • Add suffix to multiple footnote section ids, so they are unique (Sam May). This is necessary when --reference-location is block or section.
  • EPUB writer:
  • Add ARA roles for accessibility (#9378, Iacobus1983). Footnote references are given role “doc-noteref”, footnote text gets “doc-footnote”, and nav gets “doc-toc”.
  • Ensure that an alt attribute is always added (#9354). This seems to be required by iBooks; even an empty alt attribute will satisfy it.
  • Add xml:lang to package element (#9372).
  • Add accessibility metadata to EPUB metadata (#9372, #9400, Iacobus1983 and John MacFarlane). Reasonable default values are used to ensure that pandoc’s EPUBs conform to the EU Accessibilty Act requirements, but values can be overridden using metadata.
  • Docx writer:
  • Restore ability to center-justify table (#9393). The fix to #5947 caused all tables to be left indented. This was necessary to avoid extra indentation in table cells when a table appeared in a list item. This change makes the changes conditional, so that they only affect tables in list items.
  • Man writer:
  • Fix bug with long URLs (#9458). URLs with more than 68 characters didn’t display properly because of wrapping.
  • Support (limited) syntax highlighting in code blocks (#9446). Currently only boldface and italics are supported. The monochrome style might be of use for those generating man pages.
  • Org writer:
  • Escape special lines in code blocks (#9218, Albert Krewinkel).
  • Markdown writer:
  • Use different width fences for nested divs (#9450). Outer divs have longer fences. This aids clarity for the reader, making it easier to see where the div ends. It also makes the output compatible with some other implementations, e.g. micromark, which require different-width fences for nesting.
  • Fix output for pipe tables with a huge number of columns (#9346). Previously we got invalid pipe tables when the number of table columns exceeded the setting of --columns.
  • Powerpoint writer:
  • Fix regression in layout for slides with figures (#9442).
  • Use internal column widths in pptx writer tables (#5706, Tomas Dahlqvist). The table writer used to only divide all available width evenly for all columns. In this update the code uses the incoming widths if they are available. If they are not set the earlier even distribution is used. Some of the golden templates are adjusted slightly because of different rounding when using the new calculation model.
  • Custom writers:
  • Fix handling of common state (#9229, Albert Krewinkel). The CommonState (PANDOC_STATE in Lua) may change between the time that a custom writer script is first loaded and when the writer is run. However, the writer was always using the initial state, which led to problems, e.g. when the mediabag was updated in a filter, as those updates where not visible to the writer. The state is now updated right before the writer function runs.
  • Text.Pandoc.SelfContained:
  • Fix id replacements in SVGs with clipping paths (#9420). This fixes --embed-resources when SVGs have clip-path attributes.
  • Fix size of duplicated SVGs with --embed-resources (#9439).
  • ConTeXt template: support font fallback (#9361, Lawrence Chonavel).
  • Text.Pandoc.Shared:
  • addPandocAttributes: use wrapper attribute, not wrap, for Divs and Spans added as wrappers to hold attributes on elements that do not accept them.
  • makeSections behavior changes:
  • When the optional base level parameter is provided, we no longer ensure that the sequence of heading levels is gapless (#9398). Instead, we set the lowest heading level to the specified base level, and adjust the others accordingly. If an author wants to skip a level, e.g. from level 1 to level 3, they can do that. In general, the heading levels specified in the source document are preserved; makeSections only puts them into a hierarchical structure.
  • Section numbers are now assigned differently, as described above under --number-sections changes (#5071).
  • Improve makeSections code for section number calculation.
  • Text.Pandoc.Chunks:
  • Autogenerate unique ids for sections missing them (#9383). This is needed for TOC generation to work properly. We can’t create TOC links if there are no ids. This fixes some EPUB validation issues we’ve been getting since switching over to Chunks for chunking.
  • Improve fixTOCTreePaths. We weren’t adding ids for section headings that don’t head a chunk, but these headings are needed for a TOC.
  • Lua: catch encoding error in pandoc.read (#9385, Albert Krewinkel). Fixed a bug that could lead to an un-catchable error and program termination when pandoc.read was called with invalid UTF-8 input.
  • LaTeX template: support font fallback (lawcho). This support is LuaLaTeX-specific. See MANUAL.txt for documentation.
  • Text.Pandoc.Readers: Add readMan to exports [API change] (George Stagg).
  • Text.Pandoc.PDF:
  • Reliably detect when TOC has changed (#9295). Sometimes the TOC changes but there are no warnings: this happens when no labels are present. In this case we must rerun LaTeX. So we now take the SHA1 hash of the TOC file and rerun LaTeX if it changes between runs.
  • Increase maximum number of LaTeX runs to 4 (#9299). On some documents, 4 runs are needed (e.g. when a LastPage reference is used).
  • Avoid readFileLazy, which caused improperly cleaned-up temp directories on Windows (#9460).
  • MANUAL.txt:
  • Harmonize spelling of Markdown and MultiMarkdown (#9402, Salim B).
  • Add to list of exceptions for markdown_in_html_blocks extension (#9305).
  • Add clarification to docs for --resource-path (#9417).
  • Makefile: Validate generated EPUB as part of prerelease checks.
  • Add validation for docx golden files to CI (Edwin Török).

New in Pandoc 3.1.11.1 (Jan 8, 2024)

  • Docx reader:
  • Fix HYPERLINK with only switch and no argument (#9246).
  • Org reader:
  • Parse caption and label for grid tables (#9279).
  • MediaWiki reader:
  • Handle multiline math in list items (#9293).
  • OPML writer:
  • Respect --wrap options & --columns in contents of notes (#9297).
  • ODT/OpenDocument writers:
  • Properly handle highlighting styles (#9287). These styles were going into an office:styles element in content.xml, but this is invalid. Instead they must go in styles.xml. The variable highlighting-styles no longer has any effect on the default opendocument template, and highlighting styles are not included in opendocument output.
  • Markdown writer:
  • Add table identifier at end of caption if present (#9279).
  • Text.Pandoc.PDF:
  • Expand list of environment variables to display in verbose output (#9303).
  • Ensure that we find all the LaTeX warnings requiring a rerun (#9284). This should fix a regression from 3.1.9 that led to incorrect alignments in tables (and possibly other issues).
  • Docx writer:
  • Ensure that pandoc’s output validates (Edwin Török, #9273, #9269, John MacFarlane, #9265, #9266, #9264).
  • Don’t emit empty table rows, which seem to cause problems for Word (#9224).
  • LaTeX writer:
  • Omit superfluous page locator label when used with --natbib or --biblatex (#9275). These will treat a bare number as a page locator, and they will be able to localize it. Note that the recognition of the locator label is locale-sensitive; if lang is de, then S. 33 is a page reference, and p. 33 is not!
  • Text.Pandoc.Chunks: Fine tune makeChunks (#9281):
  • Ensure that chunks not based on sections (those with the “preamble” class) get unique identifiers, by appending chunk number.
  • This will also ensure that they get unique path names when the path is generated from the identifier.
  • Default HTML5 template:
  • remove html5shiv (and support for IE < 9).
  • Makefile:
  • Fix make quick-stack: j was expecting a number (Edwin Török).
  • Run built pandoc (instead of pandoc in path).
  • Add validate-epub target, using epubcheck to test the golden files.
  • Add validate-docx-golden-tests target.

New in Pandoc 3.1.11 (Dec 17, 2023)

  • Typst writer:
  • Emit ; after typst code, unless followed by space (#9252). Otherwise there’s the potential that the typst code will swallow up a following character.
  • Text.Pandoc.Logging:
  • Add MakePDFWarning constructor to LogMessage [API change].
  • Add MakePDFInfo constructor to LogMessage [API change].
  • Text.Pandoc.PDF:
  • LaTeX warnings are passed on to the user as warnings.
  • Other:
  • Use report with MakePDFWarning and MakePDFInfo to relay verbose information and warnings, instead of writing directly to stderr.
  • Parse logs to determine whether additional runs needed, instead of running a fixed number of times (#9255). (The number of times that was appropriate given pandoc’s default templates didn’t always work for custom templates, and thus pandoc 3.1.10’s change in the number of runs led to some regressions in PDF production.)
  • Makefile: in make prelease, add checks that pandoc-cli and pandoc have the same version, that pandoc-cli depends on this exact version of pandoc, that there is an entry for this version in the changelog, and that the version numbers in the generated man pages are correct.
  • Regenerate man pages with pandoc 3.1.10. This properly escapes hyphens and fixes version numbers in man pages for pandoc-server and pandoc-lua.
  • Depend on texmath 0.12.8.6. This omits unneeded lrs in typst math output.
  • Depend on typst 0.5. This allows the typst reader to support multiline strings, the version type, and the as keyword with import.

New in Pandoc 3.1.10 (Dec 13, 2023)

  • Link pandoc-cli version to pandoc version. Henceforth pandoc-cli’s version will be synchronized with pandoc’s, and pandoc-cli will depend on an exact pandoc version. This will avoid confusion by ensuring that cabal install pandoc-cli-X.Y.Z installs pandoc version X.Y.Z. It will make things more straightforward for upstream packagers (see #9232). This scheme does not follow the Haskell PVP, but that should cause no harm, because this package does not expose a library.
  • Add alerts markdown extension. This enables GitHub style markdown alerts as a commonmark extension. This extension is now default for gfm. It can’t be used with markdown, only with commonmark and variants.
  • Markdown reader:
  • Preserve newlines in math instead of changing to spaces. Otherwise we can get unwanted results if there’s a % comment (#9193).
  • Make attributes work with reference links (#9171).
  • HTML reader:
  • Improve handling of invalidly nested sublists (#9187, cf. #8150).
  • MediaWiki reader:
  • Allow attribute keys with hyphens (#9178).
  • ODT reader:
  • Support attr text:continue-numbering (#8979, Stephan Meijer).
  • Typst reader:
  • Allow references (e.g. @foo) to become citations if there is no corresponding label in the document.
  • Collapse adjacent cite elements.
  • Handle supplements in cite.
  • Change cite (only one key allowed, a label) (typst 0.9 breaking change).
  • Support quote element (typst 0.9).
  • LaTeX reader:
  • Handle otherlanguage environment and language-name environments like begin{french}...end{french} (#9202).
  • Fix theorem label parsing (#8872, Hikaru Ibayashi).
  • Docx reader:
  • Unwrap content of shaped textboxes (Stephan Meijer, #9214).
  • Improve handling of w:sym (#9220). We now look up symbols in symbol fonts using the table defined at Text.Pandoc.Readers.Docx.Symbols.
  • Add unexported module Text.Pandoc.Readers.Docx.Symbols. This gives us a table to use to resolve characters included in docx via w:sym element.
  • Man reader:
  • Properly handle .sp macro inside lists and block quotes (#9201).
  • LaTeX writer:
  • Fix bug with big footnotes inside emphasis (#8982, Hikaru Ibayashi).
  • Handle identifiers inside heading contents. phantomsection can’t be used in this case, so we need hypertarget (#9209).
  • LaTeX template:
  • Include bookmark package unconditionally. This package produces better PDF bookmarks than hyperref and does it on the first pass.
  • Typst writer:
  • Use quote for block quotes.
  • Support --toc-depth as in other writers (#9242).
  • Put inline image dimensions on enclosing box, not image (#9104).
  • Better handling of tables with captions (#9194). We now put these in a figure with a caption argument.
  • Update typst writer to typst 0.9 citation format (#9188).
  • Typst template:
  • Remove custom definition of blockquote in default template. (We now use built-in quote.)
  • Support table of contents.
  • Support csl (#9186, Ian Max Andolina). Typst now supports CSL for its native citation engine, so pandoc should use a specified csl style in the template, falling back to bibliographystyle if csl is not specified.
  • Docx writer:
  • Use different style for block quotes in notes (#9243). Using “Footnote Block Text” for the style name, so it can be given a different font size if footnotes are.
  • Allow embedded fonts to be used in reference.docx (#6728).
  • HTML5 writer:
  • To conform to validator’s expectations, doc-footnote role is used with aside and doc-endnotes with section.
  • aside is used only for notes at ends of sections or blocks; if all the notes come at the end of the document, section is used so we can have the doc-endnotes role.
  • JATS writer:
  • Handle case where there is material after refs div (#9166). Previously in such cases the references were not being moved to back matter.
  • Ms writer:
  • Don’t do normal escapes in filename arguments for PSPIC etc.
  • T.P.RoffChar: escape - as -. The groff_man (7) man page indicates that - characters will be treated as typographic hyphens and are not appropriate for cases where the output should be copy-pasteable as an ASCII hyphen-minus character. (E.g. in command line options.) However, until a recent update groff man did not actually do this; it treated - and - the same. With the new update (1.23.0) the two are distinguished (see https://lwn.net/Articles/947941/ for background), so now it is important that pandoc escape -.
  • Text.Pandoc.Extension: add Ext_alerts constructor [API change].
  • Text.Pandoc.PDF: We now default to running LaTeX only once in producing a PDF (instead of twice). This is made possible by the shift to the bookmark package, which does not require a second pass for PDF bookmarks. If a table of contents is present, we still have to run three times to get the page numbers, and if beamer is used we still do a minimum of two runs.
  • Text.Pandoc.Shared:
  • renderTags': use minimized tag for rect.
  • Allow svg path element to be minimized.
  • Export combineAttr [API change].
  • Improve isTightList so that it recognizes an item containing only a list which is itself tight as potentially an item in a tight list (#9161).
  • Text.Pandoc.MIME: Ensure we use .svg not .svgz as extension for image/svg+xml mime type. This fixes issues with embedded SVG images in docx output, among other things (#9195).
  • Text.Pandoc.Class: openURL improvements for data uris. Only treat data URI as base64 if ‘;base64’ is specified. Otherwise treat as UTF-8 (not 100% reliable but should cover most other cases). Strip off ;base64 (or ;charset=... or whatever) from mime type (#9195).
  • Text.Pandoc.SelfContained: Improve treatment of embedded SVGs (#9206, #8948).
  • Ensure unique ids for elements by prefixing SVG id.
  • Ensure SVG id attribute except when use element is used.
  • Remove width, height attributes from svg element when use element is used. Instead, add width and height 100% to the use element. This seems to get the sizing right.
  • Text.Pandoc.Citeproc: Don’t link citations if suppress-bibliography specified, for there will be nothing to link to (#9163).
  • epub.css: add styling for sup and sub (#9160).
  • Switch from base64 to base64-bytestring (#9233).
  • Use newest versions of commonmark, commonmark-extensions, commonmark-pandoc, texmath, typst, skylighting, skylighting-core.
  • Benchmark: use standalone documents for reader tests. Otherwise typst reader benchmark fails. Note: this means that we are now parsing longer documents, so bench results on readers won’t be comparable to before.
  • MANUAL.txt: update defaults file docs for bibliography fields (#9173). Recommend using top-level bibliography csl, etc. instead of a nested metadata field. Reason: ${USERDATA} and ${HOME} are only expanded in these contexts, not in metadata.
  • Move man pages to pandoc-cli package (#9245).

New in Pandoc 3.1.9 (Oct 29, 2023)

  • Make reference-section-title work with jats+element_citations (#9021).
  • Add bits as synonym of jats as input format.
  • JATS reader:
  • Modify JATS reader to handle BITS too (#9138, Julia Diaz). Add provision for title-group, book, book-part-wrapper, book-meta, book-part-meta, book-title, book-title-group, index, toc, legend, title, collection-meta
  • Fix handling of alt-text (#9130, Julia Diaz). Previously we were looking for an attribute that doesn’t exist in JATS; alt-text is provided by a child element.
  • CommonMark reader:
  • Handle Ext_tex_math_gfm (#9121). Parse GFM-specific math constructions when tex_math_gfm enabled.
  • DokuWiki reader:
  • Allow autolinks to be avoided using e.g. https:%%//%%... (#9153).
  • Parse and as block-level code (#9154). Previously we treated them as inline code in some contexts, but that is not how DokuWiki works.
  • LaTeX reader:
  • Better handle spacing commands hfill, vfill, hskip, vskip, etc. (#9150).
  • Fix incorrect abbreviation for astronomical unit (#9125, Michael McClurg).
  • Markdown reader:
  • Fix blindspot with superscript in links (#8981). Previously [^super^](#ref) wasn’t parsed as a link, due to code that was meant to prevent footnote markers from being recognized as reference links. This commit tightens up that code to avoid this bad effect. We have also added a new restriction on footnote labels: they cannot contain the characters ^, [, or ]. Though this is technically a breaking change, we suspect that the impact will be minimal, as it’s very unlikely people would be using these characters in their note labels.
  • Don’t apply --default-image-extension to data URIs (#9118).
  • More accurate check that a normalCite is not a link, bracketed span, or reference (#9080).
  • HTML reader:
  • Allow th to close td and vice versa (#9090).
  • Parse task lists using input elements (#9047, Seth Speaks).
  • Creole reader:
  • Handle empty cells correctly (#9141, Sascha Wilde).
  • Org writer:
  • Escape literal *, |, # at beginning of line with ZWS (#9159).
  • ICML writer:
  • Prevent doubled attributes (#9158).
  • Powerpoint writer:
  • Fix a corruption error caused when the document used both a regular png and a png in a data URI (#9113). (Similarly for any other image format.) The problem was that duplicate entries in [Content Types].xml were being created, one for the mime type image/png, one for image/png;base64.
  • LaTeX writer:
  • Fix rowspans in tables so they use the width of the column (= as the width parameter) (#9140).
  • Don’t treat table as “simple” if they have col widths. This should help fix a problem wherein some grid tables with colspans were overly wide (#9140).
  • Fix uneven indents in line block output (#9088).
  • JATS writer: fix 3.1.4 regression in handling block-level metadata (#9092).
  • Ms writer: improvements in image handling (#4475).
  • PDFPIC is now used for PDF images in figures.
  • Inline images that are postscript or PDF are rendered using PSPIC or PDFPIC. This isn’t ideal, because they will still be rendered as if in a separate paragraph, but it’s probably better than just printing the image name.
  • Units are included in height.
  • HTML writer:
  • If raw format is an HTML side deck format, emit it (James J Balamuta).
  • Typst writer:
  • Add #box around image to make it inline. (#9104) An #image by itself in typst is a block-level element. To force images to be inline (as they are in pandoc), we need to add a box with an explicit width. When a width is not given in image attributes, we compute one from the image itself, when possible.
  • Don’t allow long heading to wrap (#9132).
  • Escape ( (#9137). If unescaped ( occurs in certain contexts, it can be parsed as function application.
  • Man writer:
  • Fix some spacing issues around links (#9120). We need to use c before a .UR or .MT, to avoid an extra space, and also after. To ensure that a space at the beginning of the following line doesn’t get swallowed up, we escape it with .
  • Use UR, MT macros for URLs, emails (#9120).
  • Text.Pandoc.Extensions:
  • Add Ext_tex_math_gfm constructor to Extension (#9121). [API change]. This handles two GitHub-specific syntaxes for math. This is now default for gfm, in addition to tex_math_dollars.
  • Remove duplicates for Ext_raw_html and Ext_pipe_tables in some of the lists (Tim Stewart).
  • Text.Pandoc.Metadata: Add helpful message on some metadata YAML errors (#9155).
  • Text.Pandoc.Shared:
  • splitSentences: don’t split after initials. This improves the man and ms writer output, preventing sentence breaks after initials.
  • Add addPandocAttributes function [API change]. This is meant to simplify addition of attributes to Pandoc elements: for elements that don’t have a slot for attributes, an enclosing Div or Span is added to hold the attributes.
  • MANUAL.txt:
  • Clarify that formatting can’t cross line boundaries in line blocks (#9119).
  • Fix legacy option for citation (#8737, 3w36zj6)
  • Update et translations (priiduonu).
  • Updated no translations (Stephan Daus). Renamed no.yaml (macrolanguage Norwegian) to nb.yaml (Norwegian Bokmål). Created soft symbolic link from no.yaml pointing to nb.yaml.
  • Lua subsystem: Use the newest LPeg version (lpeg-1.1.*) (#9107, Albert Krewinkel).
  • Default epub.css: Apply style to h6, format styles, and combine identical styles under shared selectors (samuel-weinhardt).
  • Update nix flake with dependencies (piq9117).
  • LaTeX template: fix CSLBlock vertical space (John Purnell).
  • Allow tasty 1.5 and Diff 0.5.
  • Require commonmark-extensions 0.2.4, commonmark 0.2.4.
  • Require texmath 0.12.8.4. This should improve math in powerpoint, fixing empty boxes around roots in some cases.
  • Require typst 0.3.2.1

New in Pandoc 3.1.8 (Sep 10, 2023)

  • Text.Pandoc.Citeproc: always include an entry-spacing attribute in the Div if the bibliography element contains an entry-spacing attribute (previously we omitted it when it was 0) (#9058).
  • Clean up pandoc’s own man pages by regenerating with pandoc 3.1.7.
  • pandoc-lua-engine: bump lower bound for pandoc (#9046).
  • Depend on texmath 0.12.8.2, fixing binom in typst writer (#9063).
  • JATS reader:
  • Ignore element (#9057, Julia Diaz).
  • Fix conversion of date to ISO 8601 format (#8865).
  • LaTeX template:
  • Add code allow cite to break across lines (#9050).
  • Fix regression with CSL display="block" (#7363). This restores the line break before the block.
  • Rewrite CSLReferences environment to avoid depending on enumitem, which plays badly with beamer. Instead we use a regular list environment. Thanks to @jpcirrus for the concept (#9053).
  • Restore the pre-3.1.7 format of the CSLReferences environment, which again has two parameters. The first determines whether a hanging indent is used (1 = yes, 0 = no), and the second is the entry line spacing (0 = none).
  • Add a strut to avoid inconsistencies in spacing (#9058).
  • Remove a break at the end of CSLRightInline to avoid inconsistencies in spacing. It shouldn’t be necessary because the paragraph should extend to the right margin (#9058).
  • LaTeX writer:
  • Fix regression with figure labels (#9045). In 3.1.7, pandoc added two labels to LaTeX figure environments, one with a phantomsection.
  • Fix default citeproc entry-spacing. According to the CSL manual, the default entry spacing is 1. We were treating it as 0 (#9058).
  • HTML writer:
  • Use the ID prefix in the ID for the footnotes section (#9044, Benjamin Esham).
  • Fix CSL entry-spacing default (#9058).

New in Pandoc 3.1.7 (Sep 1, 2023)

  • Man template: don’t emit .hy, regardless of setting of hyphenate variable (#9020).
  • LaTeX template: special redefinition of st for CJK (#9019). soul’s version raises on error on CJK text.
  • Use latest skylighting-format-blaze-html (#7248). This works around a longstanding iOS Safari bug that caused long lines to be displayed in a different font size in highlighted code.
  • Allow skylighting 0.14 (and require it in pandoc core).
  • Allow text 2.1.
  • Org reader:
  • Don’t parse alphabetical lists unless the fancy_lists extension is enabled (#9042).
  • Allow escaping commas in macro arguments (Amneesh Singh).
  • JATS reader:
  • Support for metadata (#9037, Julia Diaz). metadata objects with multiple fields are created, matching the structure in JATS.
  • Correct name of JATS element attrib.
  • Markdown reader:
  • Support images with wikilink syntax, e.g. ![[foo|bar]], when one of the wikilinks extension is enabled (#8853).
  • Allow a citation or reference link to be parsed after a ! (#8254).
  • Fix dropped ! before nonexistent reference (#9038).
  • LaTeX writer:
  • Fix regression in escaping URLs (#9043).
  • Use cite and bibitem to link up citations, even with citeproc. (#9031). This will give us better accessibility; when tagging is enabled, the citation can be linked to the bibliography entry. This changes some of the details of the layout and the default template. We now make CSLReferences a special enumitem list that will contain bibitems. Internal links inside citations to ids beginning in ref- are creating using cite instead of hyperref.
  • Use phantomsection and label instead of hypertarget (#9022).
  • Use hyperref for LaTeX internal links, hyperlink for beamer (since hyperref doesn’t seem to work) (#9022).
  • Backslash-escape % and # in URLs (#9014).
  • JATS writer:
  • Fix placement of ref-list when no title is specified for the reference section (#9017). (In this case we place it in back with an empty title.)
  • Man writer:
  • Avoid a .PP right after a section heading (#9020). This is at best a no-op (in groff man and mandoc) and at worst (in some formatters) may create extra whitespace.
  • We revert the fanciness introduced in #7506, which employs a custom font name V and a macro that makes this act like boldface in a terminal and monospace in other formats. Unfortunately, this code uses a mechanism that is not portable (and does not work in mandoc) (#9020).
  • Instead of using V for inline code, we simply use CR. Note that f[CR] is emitted instead of plain f[C], because there is no C font in man. (This produces warnings in recent versions of groff, #9020.)
  • For code blocks, we now use the .EX and .EE macros, together with .IP for spacing and indentation. This gives more standard code that can be better interpreted e.g. by mandoc (#9020).

New in Pandoc 3.1.6.2 (Aug 23, 2023)

  • Org reader: allow example lines to end immediately after the colon (Brian Leung).
  • JATS reader: Fix display of block elements (#8889, Julia Diaz). A number of block elements, like disp-quote, list, and disp-formula, were always treated as inlines if appearing inside paragraphs, even if their usage granted a separate block.
  • HTML reader: avoid duplicate id on header and div (#8991).
  • HTML format templates (style.html): Fix typo in clause for svg (Jackson Schuster).
  • Use lastest texmath, typst-symbols, typst. Targets typst 0.7.
  • Docx reader:
  • Omit “Table NN” from caption (#9002).
  • Avoid spurious block quotes in list items (#8836).
  • Typst writer:
  • Use ~ for nonbreaking space, and escape literal ~ (#9010).
  • Put the label in right place for Div, use #block (#8991). Previously we were putting the label at the beginning of the Div’s contents, but according to the documentation such a label gets attached to the preceding element. We now use an explicit #block and add the label at the end.
  • LaTeX writer:
  • Improve escaping of URIs in href, url (#8992).
  • Improve internal links and targets (#8744). We no longer wrap section headings in a hypertarget. This is unnecessary (hyperref creates an anchor based on the label) and it interferes with tagging. In addition, we now use hyperref rather than hyperlink for internal links. Currently hypertarget is still being used for link anchors not on headings. Thanks to @u-fischer.

New in Pandoc 3.1.6.1 (Aug 7, 2023)

  • HTML reader: properly calculate RowHeadColumns (#8984). This fixes a bug in the calculation of the number of header columns in table row. It also changes the algorithm for determining the table body’s RowHeadColumns based on the numbers of head columns in each row. Previously we used the max, and #8634 switched to the min, which led to bad results. Now we only set RowHeadColumns to a non-zero value if all rows have the same number of head columns.
  • Typst writer: escape // so it doesn’t get interpreted as a comment (#8966).
  • ChunkedHTML writer: Fix regression including MathJax script (#8967). The fix for #8620 caused the script to be included when the table of contents but not the body text of a page contains math. But it broke the case where the table of contents doesn’t contain math but the page does. This patch fixes the issue.
  • Use pandoc-types 1.23.1. This fixes a regression with toJSONFilter (#8976), which in 1.23.0.1 no longer worked on pure values of type a -> [a].
  • Use ghc 9.6 for release builds (#8947).
  • Fix some links in FAQs (Diogo Almiro).
  • OpenDocument writer:
  • Implement syntax highlighting for inline and block code (#6710).
  • Support highlighted text in ODT/OpenDocument writers for Span with class mark (#8960). The color can be adjusted by modifying the Highlighted style.
  • Text.Pandoc.SelfContained:
  • Retain attributes in SVG tag when referring to another SVG’s content using (#8969).
  • Allow units in width and height for SVG. Units are optional but allowed.
  • Don’t coerce calculated SVG dimensions to Int.
  • fix calculation of SVG width and height. We were computing width and height from viewBox incorrectly (#8969).
  • Add clause for SVG to default CSS for HTML (#8969).
  • Ensure that width and height attributes don’t get specified twice is both the img tag and the svg include them (#8965).
  • Omit unnecessary attributes xmlns, xmlns:xlink, and version on SVG element (#8965).
  • Use 20 character rather than 40 character hashes for generated IDs (#8965).

New in Pandoc 3.1.6 (Jul 21, 2023)

  • Fix new variant of the vulnerability in CVE-2023-35936. Guilhem Moulin noticed that the fix to CVE-2023-35936 was incomplete. An attacker could get around it by double-encoding the malicious extension to create or override arbitrary files.
  • --embed-resources: Use inline SVG instead of data uris for SVG images in HTML5 (#8948). Note that SelfContained does not have access to the writer name, so we check for HTML5 by determining whether the document starts with . This means that inline SVG won’t be used when generating document fragments.
  • Fix regression on short boolean arguments (#8956). In 3.1.5 boolean arguments were allowed an optional argument (true|false). This created a regression for uses of fused short arguments, e.g. -somyfile.html, which was equivalent to -s -omyfile.html, but now raised an error because pandoc attempted to parse o as a boolean true or false. This change allows the fused short arguments to be used again. Note that -strue will be interpreted as -s with an argument true, not as -s -t -rue. It is best to use long option names with the optional boolean values, to avoid confusion.
  • Make --epub-title-page’s argument optional. It takes a boolean argument, and now that all of our boolean flags take such an argument, we can make this one optional for consistency.
  • Improve errors for illegal output formats. Previously if you did pandoc -s -t bbb, it would give you an error about the missing bbb template instead of saying that bbb is not a supported output format.
  • Improve errors for incorrect command-line option values (#8879). Always give the name of the relevant argument.
  • Fix typo on error message for incorrect --preserve-tabs argument. Thanks @fsoedjede
  • Docx reader: use SVG version of image if present (#7244). Previously the backup PNG was exported even if an SVG was present, but the SVG should be preferred.
  • Typst reader: fix regression in recognition of display math (#8949). The last release caused all math to be parsed as inline math.
  • JATS writer: don’t use for inline code (#8889). It is intended for block-level code.
  • HTML writer: don’t make line blocks sensitive to --wrap (#8952).
  • RST writer: fix figure handling (#8930, #8871). This fixes a number of regressions from pandoc 2.x. Properly handle caption, alt attribute in figures. No longer treat a paragraph with a single image in it as a figure (we have a dedicated Figure element now).
  • Docx writer: Copy “mirror margins” property from reference.docx (#8946).
  • Text.Pandoc.UTF8: Deprecate decodeArg which is now a no-op. This was needed for old base versions which we no longer support.
  • Use released skylighting, typst.
  • Allow latest commonmark-extensions. This allows entities in wikilinks.
  • Switch back to using ghc 9.2 for linux and Windows binary releases (#8947, #8955). With ghc 9.4+, we were getting AVX instructions in the amd64 binary, which aren’t supported on older hardware. For maximum compatibility we switch back to ghc 9.2, which doesn’t cause the problem. (As documented, ghc should not be emiting these instructions, so we aren’t clear on the diagnosis, but the cure has been tested.)
  • Change Windows release build to use cabal instead of stack.

New in Pandoc 3.1.5 (Jul 7, 2023)

  • Allow all boolean flags to take an optional true or false value (#8788, Sam S. Almahri). The default is true if no value is specified, so this is fully backwards-compatible.
  • Support --id-prefix for markdown output (#8878)
  • Markdown reader:
  • Add strictness annotations to fix a memory leak (#8762).
  • Typst reader:
  • Use typst-hs 0.3.0.0, which is more robust, fixes many bugs, and targets typst 0.6.
  • Package loading is now supported, as long as the package has been cached or is local.
  • Rewrite Typst reader in a way that makes it easier to extend.
  • Filter out CR in raw.
  • Handle block content for link element.
  • Handle block-level content in text element.
  • Handle style, align, place in inline contexts too.
  • Improve info message for skipped elements.
  • Add typst reader tests (#8942).
  • MediaWiki reader:
  • Revise treatment of “link trail.” Previously we only included ASCII letters. That is correct for English but not for, e.g., Spanish (see comment in #8525). A safer approach is to include all letters except those in the CJK unified ideograph ranges.
  • AsciiDoc writer:
  • Make modern AsciiDoc the target for asciidoc (#8936). The AsciiDoc community now regards the dialect parsed by asciidoctor as the official AsciiDoc syntax, so it should be the target of our asciidoc format. The asciidoc output format now behaves like asciidoctor used to. asciidoctor is a deprecated synonynm. For the old asciidoc behavior (targeting the Python script), use asciidoc_legacy. The templates have been consolidated. Instead of separate default.asciidoctor and default.asciidoc templates, there is just default.asciidoc.
  • Text.Pandoc.Writers.AsciiDoc API changes:
  • writeAsciiDoc now behaves like writeAsciiDoctor used to.
  • writeAsciiDoctor is now a deprecated synonym for writeAsciiDoc.
  • New exported function writeAsciiDocLegacy behaves like writeAsciDoc used to.
  • Update line-through for asciidoc writer to custom inline style (#8933, Kevin Broch).
  • Typst writer:
  • Support unlisted class in headings (#8941).
  • Consolidate bibliography files into one #bibliography command (#8937).
  • Improve handling of autolinks (#8931).
  • Docx writer:
  • Make relative widths work in tables. This didn’t work before because we were missing an attribute that tells Word to used fixed widths rather than computing optimal ones.
  • DokuWiki writer: fix lists with Div elements (#8920). The DokuWiki writer doesn’t render Divs specially, so their presence in a list (e.g. because of custom-styles) need not prevent a regular DokuWiki list from being used. (Falling back to raw HTML in this case is pointless because no new information is given.)
  • LaTeX writer:
  • Fix babel name for fa (should be persian).
  • Prevent babel language from being imported twice (#8925).
  • Text.Pandoc.Class:
  • Add toTextM [API change]. This is like Text.Pandoc.UTF8.toText, except:
  • it takes a file path as first argument, in addition to bytestring contents
  • it raises an informative error with source position if the contents are not UTF8-encoded
  • This replaces utf8ToText whenever we have the filename and are in a PandocMonad instance. This will lead to more informative error messages for UTF8-encoding, indicating the file path and byte offset where the error occurs (#8884).
  • Remove invalid term “Subject” from Turkish translations (#8921).
  • stack.yaml: add pkg-config to nix packages (#8927, pacien).
  • Allow aeson 2.2.
  • MANUAL: Add clarification on –section-divs. Closes #8882.

New in Pandoc 3.1.4 (Jun 26, 2023)

  • Fix a security vulnerability in MediaBag and T.P.Class.IO.writeMedia. This vulnerability, discovered by Entroy C, allows users to write arbitrary files to any location by feeding pandoc a specially crafted URL in an image element. The vulnerability is serious for anyone using pandoc to process untrusted input. The vulnerability does not affect pandoc when run with the --sandbox flag.
  • Allow epub-title-page to be used in defaults files (#8908).
  • Issue Extracting info message (in --verbose mode) when using --extract-media or extracting media temporarily in PDF production.
  • HTML reader: Update TableBody RowHeadColumns caculation (#8634, Ruqi). This change sets RowHeadColumns to the minimum value of each row, which gives better results in cases where rows have different numbers of leading th tags.
  • Dokuwiki reader: retain image query parameters as attributes (#8887, echo0).
  • Textile reader: Add support for link references (#8706, Stephen Altamirano). Textile supports what it calls “link alias”, which are analogous to Markdown’s reference-style links.
  • LaTeX reader: support alt text on images (#8743, Albert Krewinkel).
  • Commonmark reader: Make implicit_figures work again. Support for this (introduced in #6350) disappeared when we made an architectural change.
  • Mediawiki writer: allow highlighting to work for F# language (Adelar da Silva Queiróz).
  • LaTeX writer: Fix escaping of & in href and url (#8903).
  • ChunkedHTML writer: Make math work in top-level page (#8915).
  • Text.Pandoc.Logging: add new log message type ScriptingWarning [API change] (Albert Krewinkel).
  • Lua: report warnings from Lua scripts (Albert Krewinkel). Lua’s warning system is plugged into pandoc’s reporting architecture. Warnings that are raised with the Lua warn function are now reported together with other messages.
  • Use crypton-connection instead of connection (#8896, Felix Yan). Follows the change introduced in tls 1.7.0.
  • Bump versions for skylighting-core, skylighting.
  • Include lua/module/sample.svg in cabal extra-source-files (Felix Yan).
  • Add Nynorsk (New Norwegian) translations (Per Christian Gaustad).
  • Add tests for fillMediaBag/extractMedia.
  • pandoc-extras.md: add to “Academic publishing workflows” (#8696, Vladimir Alexiev).
  • JATS reader:
  • Add footer and multiple body parsing to table reader (#8765, Noah Malmed).
  • Parse references title from ref-list (#8365).
  • JATS writer:
  • Make --number-sections work.
  • Include title in ref-list (#8364). Previously the reference title ended up in a separate section at the back of the body instead of in the ref-list in the back matter.
  • Docx writer:
  • Fix localization of “Abstract” title (#8702).
  • Allow abstract-title to be specified in docx metadata (#8794).
  • INSTALL.md:
  • Mention alternatives to LaTeX to generate PDF (Norwid Behrnd).
  • Update Linux install links (harabat).

New in Pandoc 3.1.3 (Jun 7, 2023)

  • New output format: typst.
  • New module: Text.Pandoc.Readers.Typst [API change].
  • DocBook reader:
  • Support more emphasis roles (Albert Krewinkel). The role “bf” is taken to indicate “bold face”, i.e., “strongly emphasized” text, while “underline” leads to underlined text.
  • JATS reader:
  • Improve title and label parsing in the JATS reader (#8718, Noah Malmed.)
  • Add rowspan, colspan and alignment to cells in jats table reader (#8408, Noah Malmed)
  • Org reader (Albert Krewinkel):
  • Require abstract environment to use lowercase.
  • Treat #+NAME as synonym for #+LABEL (#8578).
  • ODT reader:
  • Allow lists in table cells (#8892).
  • Allow frames inside spans (#8886).
  • RST reader:
  • Fix sorting on anonymous keys (#8877). This fixes a link resolution bug bug affecting RST documents with anonymous links.
  • HTML reader:
  • Fix iframe with data URI of an image (#8856). In this case we don’t want to try to parse the data at the URL. Instead, create an image inside a div.
  • RTF reader:
  • Fix bug in table parsing (#8767). In certain cases, text before a table was being incorporated into the table itself.
  • Docx reader:
  • Introduce support for Intense Quote (Stephan Meijer).
  • Markdown reader:
  • Disallow escaping of ~ and " in markdown_strict (#8777, Albert Krewinkel). This matches the behavior of the legacy Markdown.pl as well as what is described in the manual.
  • LaTeX reader: ignore args to column type in multicolumn (#8789).
  • HTML writer:
  • Use first paragraph in task item as checkbox label (#8729, Albert Krewinkel).
  • Ms writer:
  • Coerce titles to inlines (#8835). Block-level formatting is not allowed inside .TL.
  • LaTeX writer:
  • Fix width for multicolumn simple table (#8831).
  • Jira writer:
  • Use first code block class as highlighting language (#8814, Albert Krewinkel). The writer no longer searches the list of classes for a known programming language but always uses the first class in that list as the language identifier.
  • OpenDocument writer:
  • Handle row header column cells as header cells (#8764, Michael Stahl).
  • Fix invalid text:p inside text:p from meta (#8256).
  • ODT writer:
  • Don’t add settings.xml (Michael Stahl). This will cause defaults to be used, which is what we want.
  • Don’t add unnecessary Configurations2 directory (Michael Stahl).
  • Don’t add thumbnail (Michael Stahl).
  • Put manifest.version on directory file-entry (Michael Stahl). See ODF 1.3 part 2, 4.16.14.1.
  • Stop validator complaints by producing ODF 1.3 (Michael Stahl).
  • MediaWiki writer:
  • Remove links from inside links in mediawiki writer (#8739, Wout Gevaert).
  • Typst writer:
  • Omit bibliography if citations not enabled (#8763). With this change, the typst writer will omit the #bibliography command when citations is not enabled. (If you want to use pandoc’s own --citeproc, you should combine it with -t typst-citations to disable native typst citations.
  • Use for labels, create internal links.
  • Use #footnote for notes (#8893).
  • Fix alignment issue in lists. It’s an aesthetic issue only; the first line had an extra space indent after the list marker.
  • Commonmark writer:
  • Use shortcut reference links: commonmark supports these.
  • EPUB template: add lang attribute to (Gabriel Lewertoski).
  • Template styles.html: fix task-list styling in reveal.js (#8731, Albert Krewinkel).
  • LaTeX template: Fix babelfont (#8728).
  • Text.Pandoc.Parsing:
  • Remove unnecessary ‘spaces’ in parseFromString.
  • Text.Pandoc.ImageSize: Drop BOM at start of SVG if present. Otherwise our code can fail to determine image size.
  • Lua subsystem:
  • Fix value of PANDOC_SCRIPT_FILE for custom readers & writers (#8781, Albert Krewinkel). The value did not hold the actual file path for scripts in the custom folder of the datadir.
  • Fix YAML in translation files for cs and pl (#8787).
  • Fix pdf output via typst (#8754). One must now use typst compile rather than typst.
  • MANUAL.txt:
  • Added note that the user will need to create the user data dir (#8727).
  • Add wikilinks to non-default extensions (Ilona).
  • Update link to custom djot writer (Albert Krewinkel).
  • Better link to citation syntax.
  • Fix typo (sdhoward).
  • Note that # fancy list markers don’t work with commonmark (#8772, William Lupton).
  • Add commonmark fenced_div note (#8773, William Lupton).
  • Move highlighting documentation, with minor adjustments (William Lupton).
  • Fix inaccurate statement about spaces and tabs in template syntax (Frank Seifferth).
  • Update documentation for org-mode (Christian Christiansen, #8716).
  • doc/lua-filter.md:
  • Fix typos (#8734, perro tuerto).
  • Fix anchor (Toni Dietze).
  • Use full field name in example (#8857, Matt Dodson).
  • Fix copy-paste error (#8798, thron7).
  • CONTRIBUTING.md: update info on ghc versions.
  • INSTALL.md:
  • Fix cabal install instructions (Albert Krewinkel).
  • Use more relevant link to NetBSD/pkgsrc entry (Charlotte Koch).
  • Fix Windows install instructions for winget (#8799).
  • Tests: Rename test/docx/block_quotes_parse_indent.native for consistency (Stephan Meijer).
  • Add tls constraint on cabal.project. This is needed to avoid problems caused by the transition to crypton.
  • Require texmath 0.12.8.

New in Pandoc 3.1.2 (Mar 28, 2023)

  • Add a Lua REPL (Albert Krewinkel). This can be started with pandoc lua -i. It is also possible to instruct a filter to open the REPL at a certain point, for debugging (see pandoc.cli.repl).
  • Support typst as a --pdf-engine.
  • Add typst writer (#8713). New module Text.Pandoc.Writers.Typst, exporting writeTypst [API change].
  • Org reader:
  • Allow zero width space as an escape character (#8716, Christian Christiansen). Allow the character U+200B to be used as an escape character as described in the Org-mode documentation (https://orgmode.org/manual/Escape-Character.html).
  • DocBook reader:
  • Handle “book” for xref references (#8712, Andres Freund) This also adds a test xref to book and part.
  • Handle (#8712).
  • HTML reader:
  • Fix behavior with -native_spans-raw_html (#8711). Previously with this configuration, s were not treated as inline elements at all.
  • HTML writer:
  • Avoid duplicate classes (#8705).
  • Use img element instead of embed for .svg.gz and .png.gz etc. (#8699).
  • HTML writer footnotes changes (#8695): when --reference-location=section or =block, use an aside element for the notes rather than a section. When --reference-location=section, include the aside element inside the section element, rather than outside. (In slide shows, this option causes footnotes on a slide to be displayed at the bottom of the slide.)
  • EPUB writer:
  • Use different structure for epub footnotes (#8676, see #8672, #5583). Many EPUB readers are thrown off by pandoc’s current footnote output. Both the ol and the fact that the footnote backlink is at the end of the note seem to pose problems. With this commit, we now create a list of aside (or div) elements, instead of an ordered list. Each element begins with a note number that is linked back to the note reference. (So, the backlink occurs at the beginning rather than the end.) Thanks to @Porges and @lewer.
  • Docx writer:
  • Include abstract title (#8702). Uses localized term for abstract.
  • Markdown writer:
  • Use implicit figures if there’s a caption but no alt (#8689, Albert Krewinkel).
  • Jira reader (Albert Krewinkel):
  • Add panel title as nested div (#8681).
  • Require jira-wiki-markup 1.5.1 (#8680). This fixes a bug in the parser that caused text between two exclamation marks to be parsed as an image. The first ! of image markup must now be followed by a non-space character; otherwise, the enclosed text is parsed as normal content.
  • Ms writer:
  • Fix handling of Figure (#8660).
  • ICML writer:
  • Fix images with data (#8675). The Contents element should be inside Properties.
  • LaTeX writer:
  • Add Chinese to Babel languages.
  • Fix background image in Beamer when there are figure environments (#8671, Martín Pozo).
  • LaTeX template:
  • Add babelfonts variable to default LaTeX template. This allows specifying certain fonts to be used with certain babel languages. Thanks to Frederik Elwert.
  • Fix highlight/underline with lualatex (#8707). We need the lua-ul package instead of soul, which doesn’t work with lualatex.
  • Lua (Albert Krewinkel):
  • Add pandoc.cli.repl function
  • Fix json.encode for nested AST elements. Ensures that objects with nested AST elements can be encoded as JSON.
  • Auto-generate docs for pandoc modules.
  • Load text module as pandoc.text. This only affects the name in the Lua-internal documentation. It is still possible to load the modules via require 'text', although this is deprecated.
  • Move docs from module text to pandoc.text The latter is easier to use and more consistent with the other modules.
  • Keep the Lua stack clean A metatable used during initialization was not properly removed from the stack. Likewise, accessing the CommonState from Lua previously led to the pollution of the Lua stack with a left-over value.
  • Add function pandoc.format.from_path.
  • Allow to get the JSON encoding of log messages.
  • Text.Pandoc.Format: Add new function formatFromFilePaths [API change] (#8710, Albert Krewinkel).
  • The old Text.Pandoc.App.FormatHeuristics module has been removed.
  • In --version, use Windows %APPDATA% variable to describe user data dir (#8686, Pablo Rodríguez).
  • Text.Pandoc.App.CommandLineOptions: don’t lowercase arg to --from/--read (Albert Krewinkel). This prevented users to use custom writers with uppercase characters in their filenames. Format-normalization, including lower-casing of format identifiers, happens during format parsing.
  • Documentation:
  • Add doc/nix.md.
  • Add doc/extras.md. This was formally in the website repo.
  • doc/lua-filters.md: improve docs for pandoc.zip.
  • Factor out make_macos_release.sh from the release candidate workflow. Use cabal instead of stack to build the macos binary.
  • Modify linux/make_artifacts.sh so it will work on cirrus.
  • Switch to hslua-2.3
  • Depend on latest releases of texmath, doclayout.

New in Pandoc 3.1.1 (Mar 6, 2023)

  • EPUB reader: Give additional information in error if the epub zip container can’t be unpacked.
  • TSV reader: don’t gobble tabs as whitespace (#8661).
  • Org reader: accept empty tables (#8659).
  • LaTeX reader: fix multiplication syntax for tabular (#8658). We recognized *{6}{...} but not *6{...} or *6c.
  • Docx reader: parse image alt texts in LibreOffice generated files. LibreOffice tags images slightly differently than Word; this change lets the parses take that difference into account when looking for an image description (alt text).
  • JATS reader: avoid generating duplicate figure captions (#8669).
  • RST reader: align with spec in syntax for role names (#8653). In particular, we now allow colons in row names.
  • Add note on converting from .doc format to FAQs (#8654).
  • Trap error in getAppUserDataDirectory (#8648). This can raise an error if pandoc is run in a non-user environment.
  • LaTeX writer: do not use longtable foot with Beamer (#8638, Albert Krewinkel). The table foot is made part of the table body, as otherwise it won’t show up in the output. The root cause for this is that longtable cannot detect page breaks in Beamer.
  • LaTeX template: Add CJKsansfont and CJKmonofont for XeLaTeX (#8656, Yudong Jin). CJKsansfont and CJKmonofont will be set for xelatex only if CJKmainfont is also provided.
  • URL style in ConTeXt (#8612, Thomas Hodgson). Previously, a URL like this would be in monospace text: useURL[url1][https://example.com]. Now, it will match the main text unless the linkstyle variable is set, which controls the styling of all links. Closes #8602.
  • Asciidoc writer: Properly escape | in table cells (#8665).
  • asciidoc{,tor} template: fix revision date when author is unset (#8637, arcnmx). Revision line syntax is only valid in combination with an author line, so the date attribute must be set explicitly when the author is missing
  • HTML writer: allow “track” element to be treated as block-level HTML (#8629).
  • Include needed polyfill when MathJaX is used (#8625).
  • JATS writer: include alt-text in , elements (#8631, Albert Krewinkel).
  • Chunked HTML writer: Retain metadata in processing sections for chunked HTML (#8620). Previously we suppressed metadata in all but the top page, in order to prevent the title block from being printed on every page. This prevented use of custom variables set by metadata fields. This commit moves to a better solution: a conditional in the default template restricts the title block to the top page.
  • Use pandoc-lua-marshal 0.2.1 (Albert Krewinkel). All major AST elements now have __tojson metamethods that return the JSON representation of an element. This allows to JSON-encode these elements with libraries that respect the __tojson metamethod, including dkjson.
  • Use latest zip-archive. This allows pandoc to open certain epubs that it could not open before.
  • Use commonmark-extensions 0.2.3.4. This fixes some bugs involving definition lists and inline formatting.
  • Use latest skylighting-format-context
  • docs/custom-readers.md: Update JSON parsing example. The example now uses the built-in pandoc.json library to parse the API output.
  • doc/press.md: Add article on CiTO in J Cheminform by @egonw.
  • doc/lua-filters.md: fix typo in run_json_filter (Morgan Willcock).
  • DocBook reader:
  • Fix references to tables in DocBook files (#8626, Pavol Otto).
  • Parse figure as a Figure element in the AST (#8668).
  • Lua API:
  • Add new function pandoc.system.cputime (Albert Krewinkel). The function returns the CPU time consumed by pandoc and can be used to benchmark Lua computations.
  • Add module pandoc.json to handle JSON encoding (#8605, Albert Krewinkel).
  • MANUAL.txt:
  • Document chunk-template in defaults file.
  • Remove obsolete “raw content in a style” section.
  • Revise documentation for --mathml to reflect support in all major browsers (#8667).

New in Pandoc 3.1 (Feb 10, 2023)

  • Fix regression with --print-highlight-style option (#8586).
  • Add new --chunk-template option (#8581), allowing more control over the filenames in chunked HTML output.
  • Text.Pandoc.App: Add optChunkTemplate constructor to Opt [API change].
  • Text.Pandoc.Options: add writerChunkTemplate constructor to WriterOptions [API change].
  • Text.Pandoc.Chunks: add Data, Typeable, Generic, ToJSON, FromJSON instances for PathTemplate [API change].
  • Text.Pandoc.Citeproc: Fix bug in metaValueToReference (#8611). This bug caused us to get some repeated content when converting MetaBlock to Inlines.
  • ODT reader: fix blockquote indent detection (#3437, Daniel Kessler).
  • LaTeX writer: include short figure/table caption if one is given (Albert Krewinkel). Short captions are used by LaTeX when generating the list of figures or list of tables. Adding a short caption will now overwrite the full caption in these lists.
  • Powerpoint writer: fix handling of simple figures (#8565, Albert Krewinkel). This ensures that simple figures are displayed in the same way as before the introduction of a dedicated Figure constructor in the AST.
  • Improve handling of % in bib(la)tex parsing (#8597, #8595).
  • Use released skylighting 0.13.2.1
  • INSTALL.md: direct people to cabal install pandoc-cli.
  • doc/lua-filters.md: document ‘Figure’ type and constructor (Albert Krewinkel). Fix typos (Martin Joerg).
  • Fix link in manual (#8583, Salim B).
  • Textile reader:
  • Support footnote backlinks (#8585, Stephen Altamirano).
  • Don’t allow brackets in URLs (#8582).

New in Pandoc 3.0.1 (Jan 26, 2023)

  • Fix use of extensions with custom readers (#8571).
  • Text.Pandoc.Writers.Shared: export setupTranslations [API change]. Use this in HTML and OpenDocument writers, to ensure that translations are set up properly even when we don’t go through convertWithOpts.
  • LaTeX reader: fix regression in macro resolution for environments (#8573).
  • Chunked HTML writer: Fix handling of images with absolute URLs (#8567).
  • HTML writer: Don’t omit newlines in task lists.
  • HTML writer: Don’t disable checkboxes in task lists (#8562).
  • Ensure that automatically set variables pandoc-version, outputfile, title-prefix, epub-cover-image, curdir, dzslides-core can be overridden by --variable on the command line. Previously they would create lists in the template Context, which is not desirable.
  • Fix man page copying in linux/make_artifacts.sh (#8566). Previously we were copying the pandoc-server.1 pandoc page to pandoc-lua.1.
  • pandoc.cabal: remove pandoc.cabal, stack.cabal from extra-source-files (#8560). The problem is that if these are in extra-source-files, then they get put in the tarball, and then anyone trying to build the source from an unpacked tarball will run into the problem that cabal.project and stack.yaml refer to pandoc-server, pandoc-lua-engine, and pandoc-cli, which aren’t in the tarball.
  • Require texmath 0.12.6 for better MathML output.
  • Fix typo in Lua filter documentation (Carlos Scheidegger).
  • Fix formatting of link in pandoc-server.md (James Scott-Brown).
  • Minor changelog fixups.

New in Pandoc 3.0 (Jan 19, 2023)

  • Split pandoc-server, pandoc-cli, and pandoc-lua-engine into separate packages (#8309). Note that installing the pandoc package from Hackage will no longer give you the pandoc executable; for that you need to install pandoc-cli.
  • Pandoc now behaves like a Lua interpreter when called as pandoc-lua or when pandoc lua is used (#8311, Albert Krewinkel). The Lua API that is available in filters is automatically available to the interpreter. (See the pandoc-lua man page.)
  • Pandoc behaves like a server when called as pandoc-server or when pandoc server is used. (See the pandoc-server man page.)
  • A new command-line option --list-tables, causes tables to be formatted as list tables in RST (#4564, with Francesco Occhipinti).
  • New command line option: --epub-title-page=true|false allows the EPUB title page to be omitted (#6097).
  • --reference-doc can now accept a URL argument (#8535) and load a remote reference doc.
  • --version output no longer contains version info for dependent packages. Instead, it contains a “Features” line that indicates whether the binary was compiled with support for acting as a server, and for using Lua filters and Custom writers.
  • A new option --split-level replaces --epub-chapter-level and affects both EPUB and chunked HTML output. --epub-chapter-level will still work but is deprecated.
  • Multiple input files with --file-scope: fix case where the links are URL-encoded, e.g. with (#8467).
  • Produce error if --csl is used more than once (#8195, Prat).
  • Remove deprecated --atx-headers option.
  • Remove deprecated option --strip-empty-paragraphs.
  • In --verbose mode add message when running citeproc (as with other filters).
  • Add new mark extension for highlighted text in Markdown, using == delimiters (#7743).
  • Add new extensions wikilinks_title_after_pipe and wikilinks_title_before_pipe for commonmark and markdown. (#2923, Albert Krewinkel). The former enables links of style [[Name of page|Title]] and the latter [[Title|Name of page]]. Titles are optional in both variants, so this works for both: [[https://example.org]], [[Name of page]]. The writer is modified to render links with title wikilink as a wikilink if a respective extension is enabled. Pandoc will use wikilinks_title_after_pipe if both extensions are enabled.
  • Add prefixes to identifiers with --file-scope (#6384). This change only affects the case where --file-scope is used and more than one file is specified on the command line. In this case, identifiers will be prefixed with a string derived from the file path, to disambiguate them. For example, an identifier foo in contents/file1.txt will become contents__file1.txt__foo. Links will be adjusted accordingly: if file2.txt links to file1.txt#foo, then the link will be changed to point to #file1.txt__foo. Similarly, a link to file1.txt will point to #file1.txt. A Div with an identifier derived from the file path will be added around each file’s content, so that links to files will still work.
  • New output format: chunkedhtml. This creates a zip file containing multiple HTML files, one for each section, linked with “next,” “previous,” “up,” and “top” links. (If -o is used with an argument without an extension, it is treated as a directory and the zip file is automatically extracted there, unless it already exists.) The top page will contain a table of contents if --toc is used. A sitemap.json file is also included. The option --split-level determines the level at which sections are to be split.
  • Support complex figures (Albert Krewinkel, Aner Lucero). There is now a dedicate Figure block constructor for figures. The old hack of representing a figure as Para [Image attr [..alt..] (source, "fig:title")] has been dropped. Here is a summary of figure support in different formats:
  • Markdown reader: paragraphs containing just an image are treated as figures if the implicit_figures extension is enabled. The identifier is used as the figure’s identifier and the image description is also used as figure caption; all other attributes are treated as belonging to the image.
  • Markdown writer: figures are output as implicit figures if possible, via HTML if the raw_html extension is enabled, and as Div elements otherwise.
  • HTML reader: elements are parsed as figures, with the caption taken from the respective elements.
  • HTML writer: the alt text is no longer constructed from the caption, as was the case with implicit figures. This reduces duplication, but comes at the risk of images that are missing alt texts. Authors should take care to provide alt texts for all images. Some readers, most notably the Markdown reader with the implicit_figures extension, add a caption that’s identical to the image description. The writer checks for this and adds an aria-hidden attribute to the element in that case.
  • JATS reader: The and elements are parsed into figure elements, even if the contents is more complex.
  • JATS writer: The and elements are used write figures.
  • LaTeX reader: support for figures with non-image contents and for subfigures.
  • LaTeX writer: complex figures, e.g. with non-image contents and subfigures, are supported. The subfigure template variable is set if the document contains subfigures, triggering the conditional loading of the subcaption package. Contants of figures that contain tables are become unwrapped, as longtable environments are not allowed within figures.
  • DokuWiki, Haddock, Jira, Man, MediaWiki, Ms, Muse, PPTX, RTF, TEI, ZimWiki writers: Figures are rendered like Div elements.
  • Asciidoc writer: The figure contents is unwrapped; each image in the the figure becomes a separate figure.
  • Classic custom writers: Figures are passed to the global function Figure(caption, contents, attr), where caption and contents are strings and attr is a table of key-value pairs.
  • ConTeXt writer: Figures are wrapped in a “placefigure” environment with startplacefigure/endplacefigure, adding the features caption and listing title as properties. Subfigures are place in a single row with the startfloatcombination environment.
  • DocBook writer: Uses mediaobject elements, unless the figure contains subfigures or tables, in which case the figure content is unwrapped.
  • Docx writer: figures with multiple content blocks are rendered as tables with style FigureTable; like before, single-image figures are still output as paragraphs with style Figure or Captioned Figure, depending on whether a caption is attached.
  • DokuWiki writer: Caption and “alt-text” are no longer combined. The alt text of a figure will now be lost in the conversion.
  • FB2 writer: The figure caption is added as alt text to the images in the figure; pre-existing alt texts are kept.
  • ICML writer: Only single-image figures are supported. The contents of figures with additional elements gets unwrapped.
  • OpenDocument writer: A separate paragraph is generated for each block element in a figure, each with style FigureWithCaption. Behavior for single-image figures therefore remains unchanged.
  • Org writer: Only the first element in a figure is given a caption; additional block elements in the figure are appended without any caption being added.
  • RST writer: Single-image figures are supported as before; the contents of more complex images become nested in a container of type float.
  • Texinfo writer: Figures are rendered as float with type figure.
  • Textile writer: Figures are rendered with the help of HTML elements.
  • XWiki: Figures are placed in a group.
  • Changes in custom readers/writers:
  • It is now possible to have a custom reader and a custom writer for a format together in the same file. The file may also define a custom template for the writer.
  • Pandoc now checks the folder custom in the user’s data directory for a matching script if it can’t find one in the local directory. Previously, the readers and writers data directories were searched for custom readers and writers, respectively. Scripts in those directories must be moved to the custom folder.
  • Custom readers used to implement a fallback behavior that allowed to consume just a string value as input to the Reader function. This has been removed, the first argument is now always a list of sources. Use tostring on that argument to get a string.
  • New module Text.Pandoc.Writers.ChunkedHTML, exporting writeChunkedHtml [API change].
  • We now set the pandoc-version variable centrally rather than in the writers. One effect is the man writer now emits a comment with the pandoc version.
  • pandoc-server:
  • Add simple CORS support to pandoc-server (#8427).
  • Print message to stderr when starting the server.
  • Docx reader:
  • Mark unnumbered headings with class unnumbered (#8148, Albert Krewinkel). This change ensures good conversion results when converting with --number-sections.
  • Support parsing of highlighted text.
  • Fix handling of oMathPara in w:p with other content (#8483).
  • ODT reader:
  • Fix relative links. ODT adds a ../ to relative links (see #3524); this needs to be removed when converting from ODT.
  • Handle “section” elements (#8409).
  • Rename Text.Pandoc.Readers.Odt -> Text.Pandoc.Readers.ODT, for consistency with Writers.ODT. Rename readOdt -> readODT. [API change]
  • DocBook reader:
  • Support href on link even in a fragment (#8437). (We now just look for an href attribute without worrying about the namespace.)
  • Parse title from imageobject/objectinfo (#8437).
  • JATS reader:
  • Handle uri element in references (#8270).
  • Ipynb reader:
  • Add cell id to attachment filename when storing in MediaBag (#8415). Otherwise attachments with the same name can overwrite each other.
  • LaTeX reader:
  • Skip parenthenized args of toprule, midrule, etc (#8242).
  • Handle ## macro arguments properly (#8243).
  • Remove unused function toksToString in Parsing module.
  • Support more soul commands, including hl.
  • Add unnumbered class for part* (#8447)
  • Fix TEXINPUTS handling (#8392). If TEXINPUTS ends with :, then the system default TEXINPUTS is added. We handle this by just adding the working directory in this case.
  • Parse short table caption (see jgm/pandoc-types#103). This is not too useful yet, because writers don’t do anything with the short caption.
  • MediaWiki reader:
  • Parse table cell with attributess, to support rowspan, colspan (#8231, Ruqi).
  • Refine “blending” rules for MediaWiki links (#8525, Ruqi). The rules for “blending” characters outside a link into the link are described here: https://en.wikipedia.org/wiki/Help:Wikitext#Blend_link These pose a problem for CJK languages, which generally don’t have spaces after links. However, it turns out that the blending behavior, as implemented on Wikipedia, is (contrary to the documentation) only for ASCII letters. This commit implements that restriction, which fixes the problem for CJK.
  • HTML reader:
  • Fix regression for (#8330). It was no longer being parsed as Code (Justin Wood).
  • RST reader:
  • Support mark role for round-trip.
  • Textile reader:
  • Support linked images (#8541).
  • Fix strong emph ending with link (#8540).
  • Adding a Parser to look for ordered list start attribute numbers if any (#2465, vkraven).
  • Handle empty paragraphs (#8487). Also, if attributes are added explicitly to a paragraph, put it in a Div with the attributes.
  • Markdown reader:
  • Allow fenced code block “bare” language to be combined with attributes (#8174, Siphalor), e.g.
  • ```haskell {.class #id}
  • ```
  • Allow table caption labels to start with lowercase t (#8259).
  • Grid tables: allow specifying a table foot by enclosing it with part separator lines, i.e., row separator lines consisting only of + and = characters (#8257, Albert Krewinkel). E.g.:
  • +------+-------+
  • | Item | Price |
  • +======+=======+
  • | Eggs | 5£ |
  • +------+-------+
  • | Spam | 3£ |
  • +======+=======+
  • | Sum | 8£ |
  • +======+=======+
  • Fix implicit_header_references with duplicate headings (#8300). Documentation says that when more than one heading has the same text, an implicit reference [Heading text][] refers to the first one. Previously pandoc linked to the last one instead. This patch makes pandoc conform to the documented behavior.
  • Parse highlighted text inside ==..== if mark extension enabled.
  • Org reader:
  • Allow org-ref v2 citations with & prefix (#8302).
  • Make #+pandoc-emphasis-pre work as expected (#8360, Amir Dekel).
  • BibTeX reader:
  • Fix handling of % in url field (#7678). % does not function as a comment character inside url (where URL-encoding is common).
  • Allow url field in bibtex as well as biblatex (#8287). This field is not officially supported for BibTeX, but many styles can handle it (https://www.bibtex.com/f/url-field/), and others will ignore it.
  • Support software type in biblatex CSL conversions (#8504).
  • Make sure version field comes through in biblatex (#8504).
  • BibTeX writer:
  • Pass through url even for bibtex (#8287).
  • Org writer:
  • Pass through unknown languages in code blocks (#8278), instead of producing begin_example.
  • Use span attributes tag-name in headers as tags (#8513, Albert Krewinkel). This enables round-tripping of tags in Org headings.
  • EndNote reader:
  • Better error when parsing EndNote references fails.
  • DocBook writer:
  • Rename Text.Pandoc.Writers.Docbook -> Text.Pandoc.Writers.DocBook. Rename writeDocbook -> writeDocBook, for consistency with the DocBook reader’s naming. [API change]
  • Fix position of textobject (#8437). It is a child of inlinemediaobject, not imageobject.
  • Add regression tests for #8437.
  • Render image alt text using textobject element (#8437).
  • Don’t indent contents of title element.
  • Store “unnumbered” class in DocBook role attribute (#1402, lifeunleaded).
  • ConTeXt writer (Albert Krewinkel):
  • Support syntax highlighting for code.
  • Always use type for inline code. Inline codes that contained curly braces where previously rendered with mono; this led to unexpected results when the presentation of type was customized, as those changes would not have been applied to code rendered with mono.
  • Add support for unlisted, unnumbered headings (#8486).
  • Support tagging extension (Albert Krewinkel). Paragraphs are enclosed by bpar and epar commands, and highlight commands are used for emphasis. This results in much better tagging in PDF output.
  • LaTeX writer:
  • Do not repeat caption on headless tables (Albert Krewinkel). The caption of headless tables was repeated on each page that contained part of the table. It is now made part of the “first head”, i.e. the table head that is printed only once.
  • Add separator line between table’s body and its foot (Albert Krewinkel).
  • Ignore languages with no babel equivalent, instead of generating an invalid command in the preamble (#8325).
  • Use includesvg for SVGs and include the svg package (#8334).
  • Use soul instead of ulem for strikeout, underline (#8411). This handles things like hyphenation, line breaks, and nonbreaking spaces better.
  • Use toprulenoalign{} instead of toprule() in tables, and similarly for midrule and bottomrule (#8223). This facilitates redefining toprule, midrule, and bottomrule without needing to gobble the ()s. (Those who redefine these macros on the assumption that they will be followed by () may need to change their definitions.)
  • Support highlighted text for Span with class mark.
  • JATS writer:
  • Use for LineBreak in the limited contexts that accept it (#8344).
  • Officially deprecate writeJATS in favor of writeJatsArchiving.
  • RTF writer:
  • Add space after unicode escape commands (#8264). This fixes a bug that caused characters to disappear after unicode escapes.
  • RST writer:
  • Render tables as list tables when the --list-tables option is specified (writerListTables) (#4564, Francesco Occhipinti).
  • Improve inline escaping rules (#8380).
  • Use special mark role for Span with class mark.
  • Commonmark writer:
  • Ensure that we don’t have blank lines in raw HTML (#8307).
  • HTML writer:
  • Only add role attribute in HTML5 (#8241). It is not valid in HTML4.
  • Avoid aria-hidden in code blocks for HTML4 (#8241).
  • Only treat . . . as a slide pause in slides, and not in regular HTML output (#8281).
  • Properly merge classes for headings of level > 6 (#8363).
  • Prevent inside (#7585). If a link text contains a link, we replace it with a span.
  • Replace deprecated aria roles for bibliography entries (#8354). doc-biblioentry -> listitem, doc-bibliography -> list.
  • Remove obsolete stuff about mathml-script. This was a shim we used to include for mathml support. We don’t do anything with this any more, so this is dead code.
  • Include math links if there are raw commands or environments that can be interpreted as math e.g. by MathJax (#8469).
  • Add prooftree to list of math environments (#8462). This will cause raw LaTeX prooftree environments to be rendered appropriately when --mathjax is used.
  • HTML, Markdown writers: filter out empty class attributes (#8251). These should not be generated by any pandoc readers, but they might be produced programatically.
  • Markdown writer:
  • Avoid HTML fallbacks in the generated TOC (Albert Krewinkel, #8131). The generated table of contents usually has IDs for each TOC link, allowing to link back to specific parts of the TOC. However, this leads to unidiomatic markup in formats like gfm, which do not support attributes on links and hence fall back to HTML. The IDs on TOC items are now removed in that case, leading to more aesthetic TOCs.
  • Escape ! before [ (#8254).
  • Support mark extension.
  • AsciiDoc writer:
  • In link text, only replace commas with entities when they’re in Str elements. If a link contains an image, it may have attributes, and the commas there should not be converted (see #8437, #8070).
  • ODT writer:
  • Fix relative links (#3524).
  • Docx writer:
  • Better handling of tables in lists (#5947). Previously the content of each list cell was indented when the table belonged to a list item.
  • Indent tables in list items (#5947).
  • Adjust correct attribute on lang element (#7022). For East Asian languages, we need to adjust w:eastAsia rather than w:val. This allows normal fonts to be used for any Latin-font text. Similarly, for bidi languages, we need to adjust w:bidi rather than w:val. We treat he and ar as bidi languages, zh, ja, ko as East Asian languages.
  • Support relative image widths (Albert Krewinkel). Image widths given in percent are interpreted to be relative to the text width. Previously, percent widths were taken relative to the image’s native size, inconsistently with other writers.
  • Avoid using ‘error’ for unassigned table cells (#8468). Instead, throw a regular pandoc error.
  • Render a Span with class mark as highlighted. Currently yellow is hardcoded.
  • MediaWiki writer:
  • Use the ‘new’ table structure, so that colspan and rowspan are supported (Wout Gevaert).
  • Man writer:
  • Use UTF-8 by default for non-ascii characters (#8507). Only use groff escapes if --ascii has been specified on the command line (writerPreferAscii).
  • ICML writer:
  • Use Contents element for images with raw data instead of a link with a data: uri (#8398).
  • EPUB writer:
  • Refactor to use Text.Pandoc.Chunks.
  • Refactored and simplified code.
  • Make title page optional (#6097).
  • Ms writer:
  • Properly format display equations (#8308).
  • Remove -C option on PSPIC. Some old versions don’t support this option, and since it’s the default it shouldn’t be necessary.
  • XWiki writer:
  • Use template if it is specified (#8296). Previously templates were ignored.
  • LaTeX template:
  • Set fonts after Beamer theme (Jeremie Knuesel). Beamer themes such as metropolis and saintpetersburg change the default fonts. This change gives precedence to the user font settings by moving them after the loading of the Beamer theme.
  • Set babelfont when mainlang and lang are specified and pdflatex is not being used (#8538). This is needed for good results in Arabic.
  • Add variable urlstyle (#8429, Amar Al-Zubaidi). This is set to same by default, so users should not experience any change.
  • HTML template:
  • Remove default font size, line height and font family in default inline css (#8423). mainfont, fontsize, and linestretch can still be used as before; the only difference is that we no longer provide opinionated defaults. This commit also adds a maxwidth variable that sets max-width; if not set, 36em is used as a default.
  • Add code { hyphens: manual; }.
  • Use styles.citations.html partial in styles.html.
  • Fix class name hanging -> hanging-indent in styles.citations.html.
  • Put Consolas before Lucida Console for code font (#8543). This is to prevent Lucida Console from being used on Windows, where it causes spacing issues in some applications, with boldface glyphs wider than regular ones.
  • EPUB CSS changes: Reduce the amount of inline CSS used for EPUBs (#8379). Almost everything is now in the default EPUB CSS (data/epub.css), which can be overridden either by putting epub.css in the user data directory or by using --css on the command line. Inline styles are only used for syntax highlighting (which depends on the style specified, and is only included on pages with highlighted code) and for bibliography formatting (which can depend on the CSL style, and is only used in the page containing the bibliography).
  • Note that, for compatibility with older readers, we don’t use flexbox to style column/columns divs by default, as we do in HTML. Instead, we use an older method which only works when there are two column divs inside a columns
  • If you need more than two columns and aren’t worried about support for older EPUB readers, you can modify the default CSS (there is a comment in the CSS telling you what to do).
  • Reveal.js template: prevent line-wrapping of parallax options (#8503, Albert Krewinkel).
  • reference.pptx: Remove unsupported element (#8342, #6338, Link Swanson). The default template contained text above the header, which can mislead users into thinking there is a way to put text there using pandoc.
  • Text.Pandoc.Readers.Metadata:
  • Fix metadata parsing corner case (#8465).
  • Don’t fail on inline metadata beginning with newline (#8358).
  • Text.Pandoc.App:
  • Move initial input-to-Pandoc code to internal submodule (Albert Krewinkel).
  • Change parseOptionsFromArgs and parseOptions (#8406) They now return Either OptInfo Opt. [API change]
  • Add OptInfo type [API change].
  • Add handleOptInfo function. This performs the IO actions for things like --version that were previously done in parseOptionsFromArgs [API change].
  • convertWithOpts: add argument for a ScriptingEngine [API change].
  • Unify check for standalone output (Albert Krewinkel).
  • New optEpubTitlePage field on Opt [API change] (#6097).
  • Remove optEpubChapterLevel, add optSplitLevel [API change].
  • Export IpynbOutput(..) [API change].
  • Text.Pandoc.App.OutputSettings:
  • Remove unused field outputWriterName in OutputSettings.
  • Text.Pandoc.Citeproc:
  • Check both extension and mime type to determine bibliography type when the bibliography is fetched remotely (#7151).
  • CslJson: allow an object with items property in addition to an array of references. This is what is returned by e.g. https://api.zotero.org/groups/904125/items?v=...&format=csljson
  • Require a digit for an implicit “page” locator inside explicit locator syntax {...} (#8288). Previously a locator specified as {} would be rendered as p. with nothing after it.
  • Update sub verbo to sub-verbo (#8315). This is a change in the term’s canonical name in citeproc. As a result of this change, sub verbo locators have not worked in pandoc since citeproc 0.7.
  • Text.Pandoc.Citeproc.MetaValue: remove unused function metaValueToPath.
  • Add internal module Text.Pandoc.Citeproc.Name (#8345). This exports toName, which previously had been part of T.P.Citeproc.BibTeX, and allows for cleaner module dependencies.
  • Export module Text.Pandoc.Slides [API Change] (Albert Krewinkel).
  • Add new module Text.Pandoc.Format [API change] (Albert Krewinkel). The module provides functions and types for format spec parsing and processing. The function parseFormatSpec was moved from Text.Pandoc.Extensions to the new module and renamed to parseFlavoredFormat. It now operates in a PandocMonad and is based on the updated types.
  • Text.Pandoc.Sources:
  • Add UpdateSourcePos instances for String and strict and lazy ByteString [API change].
  • Text.Pandoc.Extensions:
  • Fix JSON decoding of Extensions (#8352, Albert Krewinkel).
  • Add new exported function readExtension [API change].
  • Remove parseFormatSpec [API change]. This has been moved to Text.Pandoc.Format and renamed as parseFlavoredFormat (Albert Krewinkel).
  • Simpler implementation of Extensions based on Set (benchmarks show no performance penalty).
  • Add CustomExtension constructor to Extension [API change].
  • Remove Bounded, Enum instances for Extension.
  • Add extensionsToList function.
  • Revise readExtension so it can handle CustomExtension, and so that it returns a Text rather than Maybe Text.
  • Add showExtension [API change].
  • Add Ext_mark extension [API change].
  • Add Ext_tagging constructor [API change] (Albert Krewinkel).
  • Add Ext_wikilinks_title_after_pipe, Ext_wikilinks_title_before_pipe [API change] (Albert Krewinkel).
  • Text.Pandoc.PDF:
  • Fix papersize on PDF generation via ms (#8403). We need to set an option in pdfroff in addition to including a macro in the ms file. With this fix, -Vpapersize=a4 should be sufficient to produce A4 PDF via ms.
  • Change default background color of PDFs generated via HTML (#8422, Marcin Serwin).
  • Text.Pandoc.MIME:
  • Base module on package mime-types, which is already a transitive dependency (#8277, Albert Krewinkel).
  • Remove deprecated overrides (#8292).
  • Text.Pandoc.XML:
  • Re-export lookupEntity from commonmark-hs [API change].
  • Text.Pandoc.Parsing:
  • Remove gratuitious renaming of Parsec types. We were exporting Parser, ParserT as synonyms of Parsec, ParsecT. There is no good reason for this and it can cause confusion. Also, when possible, we replace imports of Text.Parsec with Text.Pandoc.Parsing. The idea is to make it easier, at some point, to switch to megaparsec or another parsing engine if we want to. New (re-)exports: Stream(..), updatePosString, SourceName, Parsec, ParsecT. Removed exports: Parser, ParserT [API change].
  • Export errorMessages, messageString [API change].
  • Export fromParsecError, which can be used to turn a parsec ParseError into a regular PandocParseError (#8382) [API change].
  • Remove nested [API change]. It was not being used, and in fact it was a bad idea from the beginning, as it had no hope of solving the problem it was introduced to solve.
  • Change characterReference, charsInBalanced. characterReference so they now return a Text (some named references don’t correspond to a single Char). Use the the lookupEntity function from commonmark-hs instead of the slow one from tagsoup [API change].
  • charsInBalanced now takes a Text parser rather than a Char parser as argument [API change].
  • Text.Pandoc.Shared:
  • Export textToIdentifier [API change].
  • Remove deprecated crFilter. [API change]
  • Remove deprecated deLink. [API change]
  • Deprecate notElemText.
  • Deprecate makeMeta.
  • Remove pandocVersion (now available in Text.Pandoc.Version as pandocVersionText).
  • Remove findM [API change]. This was only used in one place, and can be replaced with simpler code.
  • Remove deprecated makeMeta [API change].
  • Remove ordNub [API change]. This is just nubOrd from Data.Containers.ListUtils.
  • Remove mapLeft [API change]. This is just a synonym for Bifunctor.first.
  • Remove elemText, notElemText [API change].
  • Drop export of pandocVersion and pandocVersionText, which are now exported by Text.Pandoc.Version.
  • Remove escapeURI, isURI. These are now exported by Text.Pandoc.URI, and removing them from Shared helps make the module structure more straightforward.
  • Use LineBreak as default block sep in blocksToInlines. (#8499, Albert Krewinkel). This change also affects the pandoc.utils.blocks_to_inlines Lua function.
  • defaultUserDataDir is no longer exported (it has been moved to T.P.Data) [API change].
  • New function figureDiv, offering offers a standardized way to convert a figure into a Div element (Albert Krewinkel) [API change].
  • Text.Pandoc.Writers.Shared:
  • Export htmlAddStyle, htmlAlignmentToString and htmlAttrs [API change] (Wout Gevaert).
  • Use ‘literal tag’ instead of ‘text (T.unpack tag)’ in tagWithAttrs (Wout Gevaert).
  • toTableOfContents: handle nested Divs better (#8402).
  • Rename Text.Pandoc.Network.HTTP -> Text.Pandoc.URI. This is still an unexported internal module. Export urlEncode, escapeURI, isURI, schemes, uriPathToPath. Drop exports of schemes and uriPathToPath.
  • Text.Pandoc.URI isURI: don’t require non-ASCII characters to be escaped (#8508).
  • Rename Text.Pandoc.Readers.LaTeX.Types -> Text.Pandoc.TeX (internal module).
  • Text.Pandoc.Options:
  • WriterOptions now has a field writerListTables, specifying that list tables be used in RST output [API change].
  • New writerEpubTitlePage field on WriterOptions (#6097) [API change].
  • Remove writerEpubChapterLevel, add writerSplitLevel [API change].
  • Text.Pandoc.Filter:
  • Export applyFilters [API change].
  • Export applyJSONFilter [API Change] (Albert Krewinkel).
  • Parameterize applyFilters over scripting engine [API change] (Albert Krewinkel).
  • New exported module Text.Pandoc.Chunks [API change]. This module provides functions to split Pandoc documents into chunks to be rendered in separate files, e.g. one per section. Internal identifiers are rewritten appropriately to point to the new locations (#6122).
  • Text.Pandoc.Readers:
  • Change argument type of getReader, so it takes a FlavoredFormat instead of a Text [API change] (Albert Krewinkel).
  • Text.Pandoc.Writers:
  • Change argument type of getWriter, so it takes a FlavoredFormat instead of a Text [API change] (Albert Krewinkel).
  • Text.Pandoc.Templates:
  • Do not try to normalize input to getDefaultTemplate (Albert Krewinkel). The function getDefaultTemplate no longer splits off extension modifers from the given format, as that conflicts with using custom writers as formats. Haskell library users should use getDefaultTemplate = 2.0.
  • Use jira-wiki-markup 1.5.0 (#8511, Albert Krewinkel). Fixes issues with icon-like sequences at the beginning of words.
  • Use doctemplates 0.11, avoiding a transitive dependency on HsYAML.
  • Use skylighting 0.13.1.2.
  • Allow mtl 2.3.1 (Alexander Batischev).
  • Use latest skylighting-format-context.
  • Allow building with mtl 2.3.
  • Remove lua53 flag. We now only support Lua 5.4.
  • Add hie.yaml for haskell language server.
  • Add tools/latex-package-dependencies.lua.
  • Update default CSL with latest chicago-author-date.csl.
  • make_artifacts.sh: various small improvements.
  • Remove sample.lua from data files (#8356).
  • Documentation:
  • Deprecate PANDOC_WRITER_OPTIONS in custom writers (Albert Krewinkel).
  • Document pandoc.write_classic (Albert Krewinkel).
  • Document new table features (Albert Krewinkel).
  • Clarify what background-image does in reveal.js (#6450).
  • Documentation improvements for blank_before_blockquote (#8324, Pranesh Prakash).
  • Update grid table documentation (#8346).
  • Add note about MathJax fonts to --embed-resources.
  • Use cabal’s –package-env more (#8317, Artem Pelenitsyn).
  • Modify Zerobrane instructions to use Lua 5.4 (#8353, Ian Max Andolina).
  • Fix documentation for highlight-style in pandoc-server.md.
  • Fix link to fedora package site (#8246, Akos Marton).
  • Rephrase paragraph on format extensions (#8375, Ilona Silverwood).
  • Update README.template (#8496, Sven Wick).
  • Fix a tiny typo in lua-filters.md (TomBen).
  • Clarify that --css should be used with -s.
  • Clarify font selection for pdf -t ms (#8421, nbehrnd).
  • Clarify docs for --metadata-file (#8459).
  • Fix typo in epub.md (Vladimir Alexiev).
  • Add missing backtick in filters.md (R. N. West).
  • doc/lua-filters.md: add documentation for pandoc.format (Albert Krewinkel).
  • Fix epub-embed-font documentation (#8455, Terence Eden).
  • Removed obsolete Templates section in CONTRIBUTING.md.
  • Add manual section on accessible PDFs, archiving standards (#8312, Albert Krewinkel).
  • Tests.Command: remove unused runTest.
  • Add pandoc-lua.1 man page.
  • Improve shell.nix.
  • Add tools/moduledeps.lua for inspecting the internal module dependency tree.
  • Fix macOS zip so pandoc-server is a symlink. This cuts its size by 2x.
  • CI: Improve CI speed by caching more, eliminating macos builds, and splitting benchmarks into a separate action, run by manual dispatch. (We still test that benchmarks build in the regular CI.) The cache can be expired manually by modifying the secret CACHE_VERSION.
  • Remove the unnecessary Setup.hs from pandoc. Cabal does not need this with build-type ‘simple’.
  • Add pandoc-lua and pandoc-server (symlinks) and their man pages to releases.
  • Use hslua-cli package for pandoc-lua interface (Albert Krewinkel).
  • Add server flag to pandoc-cli, allowing it to be compiled without server support.
  • pandoc-cli: Allow building a binary without Lua support (Albert Krewinkel). Disabling the lua cabal flag will result in a binary without Lua.
  • Move --version handling to pandoc-cli. We need it here in order to print information about whether server and Lua support have been compiled in.
  • Move nightly flag from pandoc to pandoc-cli (#8339).
  • Makefile changes:
  • make help will now print all the targets and what they do.
  • Add targets: coverage, weeder, moduledeps, prerelease, ghcid, repl, linecounts, hie.yaml, binpath.
  • Note that you can alias pandoc=`make binpath` for convenient local testing of a build.
  • Rename quick-cabal -> build, quick-test -> test.
  • Exclude tests from SOURCEFILES.
  • Factor out xml-light into an internal library.
  • Add CITATION.cff (#8434).
  • Move trypandoc to a separate repository, jgm/trypandoc.

New in Pandoc 2.19.2 (Aug 24, 2022)

  • Fix regression with data uris in 2.19.1 (#8239). In 2.19.1 we used the base64URL encoding rather than base64.
  • pandoc-server: handle citeproc parameter as documented (#8235).
  • Org reader: treat emacs-jupyter src blocks as code cells (#8236, Albert Krewinkel). This improves support for notebook-like org files that are intended to be used with emacs-jupyter package.
  • HTML writer and templates: revert to using width property for column widths (Albert Krewinkel). The default flex and overflow-x properties of a column are set to auto. In combination, these changes allow to get good results when using columns with or without explicit widths.
  • Fix some typos in the codebase (luz paz).
  • Require hslua-module-path 1.0.3 (#8228, Albert Krewinkel).
  • Org writer (Albert Krewinkel):
  • Add support for jupyter nodebook cells (#6367).
  • Prefix code language of ipynb code blocks with jupyter-. This is the convention used by the emacs-jupyter package.
  • Keep code block attributes as header args. This allows to keep more information in the resulting src blocks, making it easier to roundtrip from or through Org. Org babel ignores unknown header arguments.
  • Add code block identifier as #+name to src blocks.

New in Pandoc 2.19.1 (Aug 24, 2022)

  • Add server capabilities.
  • New exported module Text.Pandoc.Server [API change].
  • The pandoc executable now starts up a web server when renamed or symlinked as pandoc-server, and functions as a CGI program when renamed or symlinked as pandoc-server.cgi. See the man page for pandoc-server for full documentation.
  • Text.Pandoc.App.Opts: Redo FromJSON for Opt so that optional values can be omitted (in which case the values from defaultOptions are used).
  • Org reader: treat “abstract” block as metadata (Albert Krewinkel, #8204). A block of type “abstract” is assumed to define the document’s abstract. It is transferred from the main text to the metadata.
  • Org template: add abstract from metadata as block of type “abstract” (#8204).
  • HTML writer: use flex property for column widths (Albert Krewinkel, #8232).
  • LaTeX writer:
  • Add label to tables that have an identifier (Albert Krewinkel, #8219). Tables with an identifier are marked with a label. A caption is always included in this case, even if the caption is empty.
  • Use textquotesingle for straight quotes in text.
  • Fix widths of multicolumn cells (#8218).
  • LaTeX template: fix behavior of colorlinks variable (Albert Krewinkel, #8226). Fixes a regression in 2.19 that required the boxlinks variable to be set in addition to the usual link coloring variables. Otherwise links were never colored in LaTeX PDF output.
  • Text.Pandoc.Highlighting: Export lookupHighlightingStyle [API change]. Previously this lived in an unexported module Text.Pandoc.App.CommandLineOptions, under the name lookupHighlightStyle.
  • Text.Pandoc.App:
  • Remove unneeded MonadIO constraints in readSources.
  • Factor out convertWithOpts' from convertWithOpts. This runs in any PandocMonad, MonadIO, MonadMask instance. So far it is not exported, but it might find a use later.
  • Support --strip-comments in commonmark/gfm (#8222). This change makes the commonmark reader sensitive to readerStripComments.
  • Lua: add function pandoc.utils.citeproc (Albert Krewinkel). The function runs the citeproc processor on a Pandoc document. Exposing this functionality to Lua allows to make citation processing part of a filter or writer, simplifies the creation of multiple bibliographies, and enables the use of varying citation styles in different parts of a document.
  • Refactor linux/make_artifacts.sh.
  • Update INSTALL.md installation from source instructions.
  • Use base64 package instead of base64-bytestring. It is supposed to be faster and more standards-compliant.
  • trypandoc improvements:
  • Add dropdown with canned examples.
  • Add citeproc support.
  • Support csv, bibliographic and binary formats.
  • Add load from file.
  • Add permalink. Don’t always reload page.
  • Use vanilla JS and CSS + the new pandoc-server.cgi.
  • Allow haddock-library-1.11.0.
  • Convert tool/extract-changes.hs to a Lua filter.

New in Pandoc 2.19 (Aug 4, 2022)

  • Add --embed-resources flag (Elliot Bobrow, #7331). This can be used to embed resources without implying --standalone. Deprecate --self-contained in favor of --embed-resources --standalone.
  • Allow environment variable interpolation in highlight-style and pdf-engine fields in defaults files (#8061; Jaehwang Jung, #8073).
  • Allow placing custom readers and writers in user data directory (Albert Krewinkel, #8112) (readers and writers subdirectories).
  • Add tsv (tab separated values) as an input format (#7974). [API change]: Text.Pandoc.Readers.CSV now exports readTSV. Internal change: In Text.Pandoc.CSV, CSVOptions has changed so that csvQuote takes a Maybe value.
  • Add tex_math_dollars to gfm default extensions (reflecting gfm’s new support for math).
  • RST, Org, Markdown readers: support rowspans and colspans in grid tables (#8202, Albert Krewinkel). Note: the writers does not yet support these more complex grid table features, so these complex grid tables will not round-trip.
  • HTML, LaTeX, and MediaWiki readers: use formatCode (#8162, #8129, Elliot Bobrow). This moves formatting from inside inline code elements to the outside, since pandoc’s Code element only takes string content.
  • Markdown reader:
  • Don’t parse inline notes with blank lines inside (#8028).
  • Allow attributes in special spans (e.g. smallcaps, underline) (Albert krewinkel, #4102). These spans are parsed as SmallCaps or Underline elements, but any attributes are included in a wrapping Span.
  • HTML reader:
  • Allow sublists that are not marked as items (Albert Krewinkel, #8150). This is technically invalid HTML, but it can be found in the wild and browsers handle it.
  • Org reader (Albert Krewinkel):
  • Recognize absolute paths on Windows (Albert Krewinkel, #8201).
  • Recognize {webp,jxl} files as images (YI).
  • Allow attrs for Org tables (Albert Krewinkel, #8049). Tables with attributes are no longer wrapped in Div elements; attributes are added directly to the table element.
  • Support line selection in INCLUDE directives (Brian Leung, #8060).
  • Fix Post / Pre mixup when setting emphasis chars (Amir Dekel, #8134).
  • LaTeX reader:
  • Support includesvg (#8027).
  • Unescape characters in lstinline inside passthrough (#8179).
  • Improve mathEnvWith (#8122). When converting e.g. an align environment to an aligned environment inside a Math element, we need to include a newline before the end{aligned}, since the previous line might end in a comment.
  • Fix treatment of extensions for input in LaTeX reader (#8092). Previously we required a .tex extension, but TeX allows any extension for input (as opposed to include).
  • RTF reader:
  • support nosupersub (#8170).
  • TikiWiki reader:
  • Support underlined text
  • DocBook reader:
  • Improved reading elements (Frerich Raabe, #8065).
  • JATS reader:
  • Strip ref- prefix from ref id in xref (#8007).
  • Support edition in references (#8087).
  • RIS reader:
  • Make parser more forgiving (#8034). Allow blank lines after entries. Allow entries with no space after the -, provided they just have a newline, e.g. DB -n.
  • Get right order of names (#8055).
  • MediaWiki reader:
  • Allow HTML comment after row start (#8110).
  • DokuWiki reader:
  • The tex_math_dollars extension is now supported for dokuwiki (but off by default) (#8178).
  • Content inside ... is parsed as raw LaTeX inline, and inside .. as raw LaTeX block (#8178).
  • The behavior of ... is changed, so that instead of producing a code block, it produces raw HTML with .
  • LaTeX writer:
  • Improve grouping with autocites (#8088).
  • Extend list of book documentclasses (Wentau Han, #8053).
  • Fix width of multicolumn cells (Albert Krewinkel, #8090). Cells spanning multiple columns must be given an explicit width, calculated from the table properties.
  • Beamer: allow containsverbatim as alternative to fragile (#8080).
  • HTML writer:
  • Add ‘footnotes’ identifier to footnotes section (#8043).
  • Fix bug with --number-offset. This formerly caused section divs to be produced, even when --section-divs was not specified (#8097).
  • Use CSS flexboxes for columns (Albert Krewinkel). This allows an arbitrary number of columns, while the previous approach assumed exactly two columns.
  • Allow “spanlike” classes to be combined (see #8194). Previously classes like “underline” and “marked” had to be the first class in a span in order for the span to be interpreted as a “ul” or “mark” element. This commit allows these special classes to be “stacked,” e.g. [test]{.mark .underline}; in addition, the special classes are no longer required to come first in the list of classes.
  • Avoid doubled style attribute when height and width are added to style because of an image, but the image already has a style attribute (#8047).
  • Do not include the deprecated doc-endnote role (#8030). doc-endnote was deprecated in DPUB-ARIA 1.1.
  • Remove extra soft break for tasklist (black-desk, #8142). Browser will display the extra newline character between checkbox and text as a space, which make tasklist items cannot be aligned.
  • EPUB writer:
  • Allow choice of math method for v3 (#8164). Previously we always used MathML for math in EPUB3, because the spec includes MathML. But this is not widely supported by readers, so it seems better to allow users to choose their math method as they can with EPUB2 or HTML. NOTE: Existing workflows that produce EPUBv3 documents including math will be affected by this change. You must add --mathml to your command line if you want to continue producing MathML.
  • RST writer:
  • Fix missing spaces with nested inlines (#8182).
  • Always escape literal backslash (#8178).
  • Ms writer:
  • Add comment in preamble stating generator.
  • Fix roff ms syntax highlighting definitions (#8175, thanks to Branden Robinson).
  • ConTeXt writer:
  • Support complex table structures (Albert Krewinkel, #8116). The following table feature are now supported in ConTeXt:
  • colspans,
  • rowspans,
  • multiple bodies,
  • row headers, and
  • multi-row table head and foot.
  • The wrapping placetable environment is also given a reference option with the table identifier, enabling referencing of the table from within the document.
  • Unify link handling (Albert Krewinkel, #8096). Autolinks, i.e. links with content that’s the same as the linked URL, are now marked with the url command. All other links, both internal and external, are created with the goto command, leading to shorter, slightly more idiomatic code. As before, autolinks can still be styled via setupurl, other links via setupinteraction.
  • Use “sectionlevel” environment for headings (Albert Krewinkel, #5539). The document hierarchy is now conveyed using the startsectionlevel/stopsectionlevel by default. This makes it easy to include pandoc-generated snippets in documents at arbitrary levels. The more semantic environments “chapter”, “section”, “subsection”, etc. are used if the --top-level-division command line parameter is set to a non-default value.
  • Docx writer:
  • Add w:lang to rPr for Span and Div with lang attribute, so that Word can know that “Apfel” is not a spelling error (#8026).
  • Prevent crashing when handling invalid tables (Albert Krewinkel, #8102). Tables with different numbers of cells per row would sometimes crash pandoc. This fix prevents this by cutting off overlong rows.
  • ICML writer:
  • Support custom-style attribute on Table (#8079).
  • AsciiDoc writer:
  • Fix commas in link text (#8070). Commas in link text trigger interpretation of attributes. To block this, we replace them with numeric entities.
  • Fix underline. We were rendering it as +++text+++; this is now changed to [.underline]#text#. See comment at #8070 (comment).
  • FB2 writer:
  • Fix handling of non-section Divs (#8123).
  • Markdown writer:
  • Disable soft wrapping when hard_line_breaks enabled (#8035). We were already doing this for markdown; this commit does the same thing for markua and commonmark and gfm.
  • Avoid excessive indentation on bullet lists for commonmark, markua, gfm. They are now nested by 2 spaces instead of 4 (#8011).
  • Text.Pandoc.Class:
  • Add new function findFileWithDataFallback [API Change] (Albert Krewinkel).
  • fillMediaBag: Keep attributes of original image on Span (Albert Krewinkel, #8099). Images that cannot be fetched are replaced with a Span that contains the image’s description. The span now also retains all original image attributes and inherits all attributes of the image. Furthermore, the classes image and placeholder are added, and path and title are store in attributes original-image-src and original-image-title, respectively.
  • Text.Pandoc.Shared:
  • makeSections: don’t make a section for a div with class “fragments” (#8098).
  • Ensure that Nulls are ignored by makeSection and in segmenting slides (#8155).
  • Add formatCode function to Text.Pandoc.Shared [API change] (Elliot Bobrow, #8129).
  • taskListItemToAscii: handle asciidoctor’s characters (#8011). Asciidoctor uses different unicode characters for task lists; we should recognize them too and be able to convert them to ascii task lists in formats like gfm.
  • Deprecate deLink and mark for later removal.
  • Text.Pandoc.Writers.Shared:
  • toTableOfContents: Don’t replace links with empty spans in TOC (#8020).
  • Text.Pandoc.Readers.Metadata:
  • Ensure that metadata values w/o trailing newlines are parsed as inlines, as the manual states. Previously, they were parsed as inlines if they would otherwise have been a single Plain or Para, but otherwise left unchanged. This led to some quirky results (e.g. #8143). We now use the general function blocksToInlines from T.P.Shared.
  • Text.Pandoc.Parsing:
  • Simplify gridTableWith', gridTableWith [API Change] (Albert Krewinkel). The functions gridTableWith and gridTableWith' no longer takes a boolean argument that toggles whether a table head should be parsed: both, tables with heads and without heads, are always accepted now.
  • Lua subsystem (Albert Krewinkel):
  • Extend pandoc.system module (Albert Krewinkel, #8184). The module now has the additional functions list_directory, make_directory, and remove_directory. This makes it easier to write cross-platform scripts that need to inspect or modify the file system.
  • Require pandoc-lua-marshal 0.1.7. Adds a clone methods to Pandoc objects and allows to pass Blocks in instead of full Caption elements.
  • Add fields pandoc.readers and pandoc.writers (#8177). The set of supported input and output formats is made available to Lua users.
  • Ensure that tables marshaled via JSON arrays behave like Lists. This allows to invoke methods like map and includes on lists like PANDOC_WRITER_OPTIONS.extensions.
  • Require hslua-2.2.1, unless lua53 flag is set, and do not reset foreign encoding before running Lua. This fixes a problem where the encoding used for Lua filenames would sometimes mismatch the encoding used by the OS.
  • Simplify module loading code. Modules are now loaded directly; the special pandoc Lua package searcher is no longer necessary and has been removed.
  • Add function pandoc.mediabag.fill (#8104). The function allows to fill the mediabag with all images in a given document. Images that cannot be fetched are replaced with a Span containing the image description.
  • Populate mediabag after filters have run (Albert Krewinkel, #8099). The mediabag is filled with document resources after the filters have run. This allows, for example, filter authors to modify image paths before pandoc tries to fetch the images. Lua filters that rely on a filled mediabag can use the new pandoc.mediabag.fill function to perform that action in the filter.
  • Ms template: redefine rather than removing .CH macro (#8175).
  • JATS template (Albert Krewinkel, except as noted):
  • Include particles, prefix, suffix in names.
  • Mark authors with cor-id as corresponding authors. Corresponding authors are marked by setting the attribute corresp="yes" in their respective element.
  • Unconditionally include permissions element (#8040). Fixes a bug that caused license information to be omitted when no copyright information was provided.
  • Follow JATS4R recommendation and PudMed Central for license URI (Castedo Ellerman, #8041).
  • LaTeX template:
  • Rename textormath to TextOrMath (Hos Es, #8036).
  • Fix links-as-notes (Albert Krewinkel, #8077).
  • HTML template styles:
  • Remove span.underline rule. This is superfluous now that we render Underline as .
  • Improve CSS for task lists (#8151).
  • LaTeX template: Add boxlinks variable for LaTeX/PDF output (#8198). If boxlinks is set but colorlinks is not, then boxes will be printed around links (hidelinks will not be set in hypersetup).
  • --self-contained: Handle url() in elements (#8193).
  • Text.Pandoc.PDF: use SHA1 hash of filename when converting SVG. The previous code threw away the directory component of the filename in constructing a new one. This led to surprising results if you had e.g. foo/pic.svg and bar/pic.svg; in the final PDF they’d be the same image, because the latter would overwrite the former in the temp directory.
  • Remove Muse reader round-trip tests. These are nondeterministic and have repeatedly failed on strange edge cases.
  • Update fonts MIME following IANA recommendation (Gabriel Lewertowski, #8127).
  • Future compat change for liftA2 export from Prelude (Georgi Lyubenov, #8132).
  • Update default.csl from the latest chicago-author-date.csl.
  • Update manfilter.hs for greater portability (#8045). The tables in our man pages were not rendering correctly with mandoc, now used by default with macOS. mandoc doesn’t allow man formatting inside table cells. For maximum portability, we now render the tables in plain format and include them as code blocks in the man page.
  • CI: update macos container version (#8197, Sukka).
  • Add nightly flag. This causes a -nightly-COMPILEDATE suffix to be added the the output of --version (#8016). This is used in the nightly CI builds.
  • Update dependencies (aeson, skylighting, pandoc-lua-marshall, citeproc, texmath).
  • Documentation improvements (thanks to Jiří Wolker, Castedo Ellerman, Albert Krewinkel, Bastien Dumont, Cezar Drożak, Benjamin Wuethrich, Ivan Panchenko, Sukil Etxenike, Masataka Ogawa).

New in Pandoc 2.18 (Apr 6, 2022)

  • New input formats: endnotexml (EndNote XML bibliography), ris (RIS bibliography).
  • A RIS bibliography file may now be used with --citeproc.
  • Citeproc: Allow a formatted bibliography to be placed in metadata fields via a Div with class refs (#7969, #526). Thus, one can include a metadata field, say refs, whose content is an empty div with id refs, and the formatted bibliography will be put into this metadata field. It may then be interpolated into a template using the variable refs.
  • Ensure that you don’t get PDF output to terminal. -t pdf now behaves like -t docx and gives an error unless the output is redirected.
  • --version now prints hslua version (#7929) and Lua version (#7997, Albert Krewinkel).
  • Change --metadata-file parsing so that, when the input format is not markdown or a markdown variant, pandoc’s markdown is used (#6832, #7926). When the input format is a markdown variant, the same format is used. Reason for the change: it doesn’t make sense to run the markdown parser with a set of extensions designed for a non-markdown format, and this dramatically limits what people can do in metadata files.
  • Trim whitespace from math in --webtex (#7892). This fixes problems with –webtex and markdown output, when display math starts or ends with a newline.
  • New exported module Text.Pandoc.Readers.EndNote, exporting readEndNoteXML, readEndNoteXMLCitation, and readEndNoteXMLReferences. [API change]
  • --self-contained: issue warning rather than failing with an error if a resource can’t be found (#7904).
  • New exported module, Text.Pandoc.Readers.RIS, exporting readRIS (#7894).
  • LaTeX reader:
  • Handle subequations as inline math environment (#7883).
  • Rudimentary support for vbox (#7939).
  • Support today (#7905).
  • Handle label and ref for footnotes (#7930).
  • Allow inline groups starting with bgroup (#7953).
  • Use custom TokStream that keeps track of whether macros are expanded. This allows us to improve performance a bit by avoiding unnecessary runs of the macro expansion code (e.g. from 24 ms to 20 ms on our standard benchmark).
  • Further optimizations for inline parsing.
  • Better handling of usepackage. If the package is local but causes parse errors, parse everything up to the error and skip the rest. Issue a CouldNotParseIncludeFile warning indicating that parsing failed at that point.
  • Text.Pandoc.Readers.LaTeX.Parsing: Monoid and Semigroup instances for TokStream.
  • HTML reader:
  • Give warnings and emit empty note when parsing and the identifier doesn’t correspond to anything in the note table (#7884). Previously we just silently skipped these cases.
  • Fix parsing of epub footnotes (#7884).
  • DocBook reader:
  • Handle complete set of entities as specified at https://www.w3.org/2003/entities/2007doc/byalpha.html (#7938).
  • Handle abstract in info section (#7747).
  • Improve info parsing.
  • Simplify metadata parsing code (#7747). Handle abstract as block-level content. Report skipped info elements with --verbose.
  • Handle address and coyright in metadata (#7747).
  • DokuWiki reader:
  • Add DokuWiki table alignment (#5202, damon-sava-stanley).
  • RST reader:
  • Fix treatment of headerless simple tables (#7902).
  • Wrap math in Span to preserve attributes (#7998, Albert Krewinkel). Math elements with a name, classes, or other fields are wrapped in a Span with these attributes.
  • JATS reader:
  • Improve handling of fn-group elements (#6348, Albert Krewinkel). Footnotes in elements are collected and re-inserted into the document as proper footnotes in the place where they are referenced.
  • Handle pub-date (#8000).
  • Support PMID, DOI, issue in citations (#7995).
  • Improve refs parsing. Handle issn and isbn; use simpler form for issued date.
  • Strip ‘ref-’ from ref id in constructing CSL id. This allows better round-tripping, because the JATS writer adds the ref- prefix to the citation id to get the ref element’s id.
  • Org reader:
  • Allow “:” in property drawer keys (Lucas V. R). Any non-space character is allowed as property drawer key, including “:” itself (so it is not really a delimiter). The real delimiter is a space character, so in a drawer like
  • :PROPERTIES:
  • ::k:ey:: value
  • :END:
  • “:k:ey:” is a key with value “value”.
  • Allow comments above property drawer.
  • More flexible LaTeX environments (Lucas V. R).
  • Handle #+bibliography: as metadata so that it can work with --citeproc.
  • Parse #+print_bibliography: as Div with id refs.
  • Allow multiple #+bibliography:.
  • Markdown reader:
  • Allow one-column pipe tables with pipe on right (#7919).
  • Remove restriction on identifiers, so they no longer need to begin with a letter (#7920).
  • Docx reader:
  • Enable citations extension for docx reader (#7840). When enabled, Zotero, Mendeley, and EndNote citations embedded in a docx are parsed as native pandoc citations. (When disabled, the generated citation text and bibliography are passed through as regular text.) The bibliography generated by the plugin is suppressed. Instead, bibliographic data embedded in citation items is added to the references metadata field so that it can be used with --citeproc.
  • Docbook writer:
  • Interpret links without contents as cross-references (#7360, Jan Tojnar). Links without text contents are converted to elements. DocBook processors will generate appropriate cross-reference text when presented with an xref element.
  • Docx writer:
  • Single numbering ID for examples (#7895, mjfs). This change ensures that example list items all belong to a single number sequence, so that if items are added or deleted in a word processor, the other items will renumber automatically.
  • Add bookmark with table id to table (#7989, Nikolai Korobeinikov, #7285). This allows tables with ids to be linked to.
  • Ipynb writer:
  • Handle metadata better (#7928). Previously we used the markdown writer to render metadata. This had some undesirable consequences (e.g. en dash expanded to -- when smart enabled), so now we use the plain writer.
  • LaTeX writer:
  • Avoid extra space before CSLRightInline (#7932).
  • Add scrreport to chaptersClasses (#6168, ivardb).
  • Support page,trim,clip attributes on images (#7181).
  • Add () after booktabs rules (#8001). These commands take optional arguments with () and [], which can lead to problems if the content of the table cell begins with these characters.
  • RST writer:
  • Support all standard metadata (“bibliographic”) fields.
  • HTML writer: performance improvements.
  • Org writer:
  • Stop indenting property drawers, quote blocks (#3245, Albert Krewinkel). This follows the current default org-mode behavior.
  • Markdown writer:
  • Move table-related code into submodule (Albert Krewinkel).
  • Don’t produce redundant header identifier when the gfm_auto_identifiers extension is set (#7941).
  • Update escaping rules for . We now escape only if raw_tex is enabled or it is followed by a non-alphanumeric.
  • JATS writer:
  • Encode author “others” as (Albert Krewinkel). Citeproc adopted the BibTeX convention to use the author name “others” when there are additional authors that are not named. JATS uses the element for this.
  • Avoid doubled ref-list element (#7990). Previously when generating JATS with the element_citations extension enabled, the references were put in a doubly-nested ref-list element (...).
  • Keep edition info in element citations (#7993, Albert Krewinkel).
  • Fix handling of CSL variable ‘page’ (not ‘pages’ as we had before). It should go to ‘lpage’ and ‘rpage’, not ‘page-range’.
  • EPUB writer: refactor for clarity (#7991, Jonathan Dönszelmann, Ola Wolska, Ivar de Bruin, Jaap de Jong).
  • Custom writer (Albert Krewinkel):
  • Support new-style Writer function (Albert Krewinkel). See the documentation for custom writers for details.
  • Produce stacktrace if Writer function fails
  • Text.Pandoc.Logging: add CouldNotParseIncludeFile constructor for LogMessage [API change].
  • Text.Pandoc.Shared:
  • Put id attributes on TOC entries (#7907, damon-sava-stanley). Naming scheme of id is “toc-” + id of linked to header/section. Effects HTML, Markdown, Powerpoint, and RTF.
  • Define ordNub as alias for nubOrd from containers package (#7963, Albert Krewinkel).
  • Export ensureValidXmlIdentifiers. This function changes identifiers that don’t start with letters, and internal links to these identifiers, making them compatible with XML standards. The change is simple: we add id_ to the front. There is potential for duplication if there are already id_... identifiers defined, but this seems rare enough not to worry too much about.
  • Ensure that valid XML identifiers are used in Docbook, EPUB, FB2, HTML4, S5, Slidy, Slideous, ICML, ODT, TEI writers. Thus, if you convert [anchor]{#1} and [link to](#1), id_1 will be used instead of 1 for the identifier.
  • Lua (Albert Krewinkel).
  • Add module pandoc.layout to format and layout text.
  • Move custom writer code into Lua hierarchy.
  • Use pandoc-lua-marshal 0.1.5.
  • Allow any type of callable object as argument to List functions filter, map, and find_if. These previously required the argument to be of type function, which was too restrictive.
  • Inline: the type of Image captions is now Inlines instead of List.
  • Allow passing Sources to pandoc.read (#8002).
  • Text.Pandoc.PDF:
  • Restore wkhtmltopdf as default pdf engine for HTML (Albert Krewinkel).
  • Allow custom writer as format if engine is explicitly specified (#7898, Albert Krewinkel). Note that it may be necessary to explicitly specify a template on the command line.
  • Text.Pandoc.MediaBag: improve detection of absolute paths (#7881).
  • Text.Pandoc.Extensions:
  • Remove raw_tex extension from list of commonmark extensions, and from the commonmark_x defaults. commonmark doesn’t parse raw TeX, and it doesn’t make sense to write it if we don’t parse it.
  • Remove native_divs from allowed gfm extensions (#7965). This allows to be suppressed using -raw_html. Previously native_divs was enabled but could not be suppressed, because it was not in the list of available extensions for commonmark-based formats.
  • Text.Pandoc.Parsing:
  • Partition module into (internal) submodules (#7962, Albert Krewinkel).
  • Unify grid table parsing (#7971, Albert Krewinkel). Grid table parsing in Markdown and RST are updated use the same functions. Functions are generalized to meet requirements for both formats. This change also lays the ground for further generalizations in table parsers, including support for advanced table features. [API change] in Text.Pandoc.Parsing:
  • Parse results of functions tableWith' and gridTableWith' are now a mf TableComponents instead of a quadruple of alignments, column widths, header rows and body rows.
  • Additional exports from Text.Pandoc.Parsing: tableWith', TableComponents, TableNormalization, toTableComponents, toTableComponents'.
  • Text.Pandoc.XML.Light: add versions of the parsers that allow specifying a custom entity map. Exports new functions: parseXMLElementWithEntities, parseXMLContentsWithEntities [API change].
  • Text.Pandoc.Writers.GridTable: improve module documentation (Albert Krewinkel).
  • Text.Pandoc.Parsing.GridTable: simplify column handling code (Albert Krewinkel).
  • Text.Pandoc.MIME: Add mime type for mkv extension (#7181).
  • Text.Pandoc.Asciify: Fix regression with ascii_identifiers and Turkish undotted i (#8003).
  • Relax upper bound for hslua, allow hslua-2.2. (#7929) Lua 5.4 is used by default after this is merged. Packagers may still include Lua 5.3 instead by building pandoc with --constraint='hslua

New in Pandoc 2.17.1.1 (Feb 1, 2022)

  • Fix regression in 2.17.1 which caused problems finding default files in the default user data directory. (Reverts the item “logic bug in fullDefaultsPath”, which was misguided.)
  • Sample custom writer: use single quotes for strings (#7487, Albert Krewinkel).

New in Pandoc 2.17.1 (Jan 31, 2022)

  • Support pagedjs-cli as pdf engine (#7838, Albert Krewinkel). PagedJS is a polyfill and supports the Paged Media standards by the W3C. https://www.pagedjs.org/
  • CommonMark reader: fix source position after YAML metadata (#7863).
  • LaTeX reader:
  • Remove retokenizing in rawLaTeXParser.
  • Ensure that raggedright doesn’t gobble an argument (#7757).
  • Improve descItem. For some reason we were skipping arbitrary blocks before item. This is now changed to “skip whitespace and comments.”
  • Improve handling of newif.
  • Docx reader: Parse both Zotero citation and bibliography as FieldInfo (#7840).
  • LaTeX writer:
  • Allow arbitrary frameoptions to be passed to a beamer frame, using the frameoptions attribute (#7869).
  • Add s and squeeze to recognized beamer frameoptions (#7869).
  • Markdown writer: handle explicit column widths with pipe tables (#7847). If a table has explicit column width information and the content extends beyond the --columns width, we need to adjust the widths of the pipe separators to encode this width information.
  • Docx writer: Separate tables even with RawBlocks between (#7224, Michael Hoffmann). Adjacent docx tables need to be separated by an empty paragraph. If there’s a RawBlock between tables which renders to nothing, be sure to still insert the empty paragraph so that they will not collapse together.
  • Man writer: use custom font V for inline code (#7506). The V font is defined conditionally, so that it renders like CB in output formats that support that, and like B in those that don’t (e.g. the terminal). Aliases also defined for VI, VB, VBI.
  • Asciidoc writer: Support checklists in asciidoctor writer (#7832, Nikolai Korobeinikov, ricnorr). The checklist syntax (similar to task_list in markdown) seems to be an asciidoctor-only addition.
  • HTML writer:
  • Avoid duplicate “style” attributes on table cells (#7871).
  • Don’t break lines inside code elements. With the new (default) line wrapping of HTML, in conjunction with the default CSS which includes code { whitespace: pre-wrap; }, spurious line breaks could be introduced into inline code (#7858).
  • Custom writer: preserve order of element attributes (#7489, Albert Krewinkel). Attribute key-value pairs are marshaled as AttributeList, i.e., as a userdata type that behaves both like a list and a map. This allows to preserve the order of key-value pairs.
  • Switch to hslua-2.1 (Albert Krewinkel). This allows for some code simplification and improves stability.
  • Don’t read files outside of user data directory (Even Brenden). If a file path does not exist relative to the working directory, and it does exist relative to the user data directory, but outside of of the user data directory, do not read it. This applies to readDataFile and readMetadataFile in PandocMonad and, by extension, any module that uses these by passing them relative paths.
  • Text.Pandoc.Class.makeCanonical: Correctly handle consecutive “..”s at the beginning of a path (Even Brenden). Prior to this commit, ../../file would evaluate to file, when it should be unchanged.
  • Search for metadata files in $DATADIR/metadata (#7851, Even Brenden). If files specified with --metadata-file are not found in the working directory, look in $DATADIR/metadata (#5876).
  • Text.Pandoc.Class: export readMetadataFile [API change] (#5876).
  • Text.Pandoc.Error: export new PandocCouldNotFindMetadataFileError constructor for PandocError [API change] (#5876).
  • Avoid putting a frame around speaker notes in beamer (#7857). If speaker notes (a Div with class ‘notes’) occur right after a section heading, but above slide level, the resulting note{..} caommand should not be wrapped in a frame, as that will cause a spurious blank slide.
  • CSS in HTML template: adjust #TOC and h1 on mobile (#7835, Mauro Bieg).
  • Text.Pandoc.Readers.LaTeX.Parsing: don’t export totoks. Make the first param of tokenize a SourcePos instead of SourceName, and use it instead of totoks.
  • Text.Pandoc.Shared: Modify stringify so it ignores [Citation] inside Cite (#7855). Otherwise we’ll sometimes get two copies of things, one from the citationPrefix or citationSuffix and another from the embedded fallback text. When there is no fallback text, we’ll get no content. However, it really isn’t an alternative to just rely on the result of running query on the embedded Citations; this will result in a jumble of text rather than anything structured.
  • Omit --enable-doc in the cabal haddock invocation in tools/build-and-upload-api-docs.sh.
  • Text.Pandoc.App.Opt: fix logic bug in fullDefaultsPath. Previously we would (also) search the default user data directory for a defaults file, even if a different user data directory was specified using --data-dir. This was a mistake; if --data-dir is used, the default user data directory should not be searched.
  • Text.Pandoc.Shared: defaultUserDataDir behavior change (#7842). If the XDG data directory is not defined (e.g. because it’s not supported in the OS or HOME isn’t defined), we return the empty string instead of raising an exception.
  • Update command tests to distinguish stderr and test exit status.
  • MANUAL: add that speaker notes can be used with beamer (#7856).
  • Update build-and-upload-api-docs.sh.
  • Document --trace option. Document no-check-certificate in defaults files. Document ‘sandbox’ option for defaults files. (#7873).
  • Fix pattern syntax in sample readability custom reader.
  • doc/custom-readers.lua: add example for “readable HTML.”
  • Fix message in man page about where code can be found.
  • manfilter.lua: remove extra indent in table cells with code blocks.
  • Fix lua-filters documentation for table column widths (#7864).
  • epub.doc: Update links to KindleGen (#7846, Benson Muite, Mauro Bieg). KindleGen has been deprecated and we need to link to archived versions.
  • Use tables in defaults files documentation, so each default option is paired with the corresponding command-line option (Carsten Allefeld).
  • Use skylighting 0.12.2.
  • Add pandoc-lua-marshal to Nix shell (#7849, Even Brenden).

New in Pandoc 2.17.0.1 (Jan 17, 2022)

  • Require pandoc-lua-marshal 0.1.3.1 (#7831, Albert Krewinkel). Fixes a problem with List.includes and List.find that caused a Lua stackoverflow and subsequent program crash.
  • HTML template: load header-includes before math (#7833, Kolen Cheung). MathJax expect the config comes before loading the MathJax script. This change of order allows one to config MathJax via header-includes, which loads before the MathJax script. Cf. #2750.
  • When reading defaults file, stop at a line .... This line signals the end of a YAML document. This restores the behavior we got with HsYaml. yaml complains about content past this line. See #4627 (comment)
  • Text.Pandoc.Citeproc: allow notes-after-punctuation to work with numerical styles that use superscripts (e.g. american-medical-association.csl), as well as with note styles. The default setting of notes-after-punctuation is true for note styles and false otherwise. This restores a behavior of pandoc-citeproc that wasn’t properly carried over to Citeproc (#7826, cf. jgm/pandoc-citeproc#384).
  • Use commonmark-pandoc 0.2.1.2 (#7769).
  • Add FAQ on images in ipynb containers (#7749, Kolen Cheung).

New in Pandoc 2.17 (Jan 13, 2022)

  • Support markua as an output format (#1871, Tim Wisotzki and Saumel Lemmenmeier). Markua is a markdown variant used by Leanpub.
  • Add text wrapping for HTML output (#7764). Previously the HTML writer was exceptional in not being sensitive to the --wrap option. With this change --wrap now works for HTML. The default (as with other formats) is automatic wrapping. Note that the contents of script, textarea, and pre tags are always laid out with the flush combinator, so that unwanted spaces won’t be introduced if these occur in an indented context in a template.
  • Don’t read sources until in/out format are verified (#7797).
  • Issue error with --list-extensions for invalid formats (#7797).
  • Make --citeproc recognize .yml as well as .yaml extensions as YAML bibliography files (#7707, Jörn Krenzer).
  • Use latest version of KaTeX with --katex.
  • Fix parsing of footnotes in --metadata-file (#7813). Previously non-inline footnotes were not being parsed.
  • ODT reader:
  • Parse list-header as a list item (Tuong Nguyen Manh).
  • Commonmark reader:
  • Put sourcepos attribute on header, not enclosing div with -f commonmark+sourcepos (#7769).
  • Markdown reader:
  • Don’t allow ^ at beginning of link or image label (#7723). This is reserved for footnotes. Fixes regression from 0a93acf.
  • Fix parsing of “bare locators” after author-in-text citations. Previously @item [p. 12; @item2] was incorrectly parsed as three citations rather than two. This is now fixed by ensuring that prefix doesn’t gobble any semicolons.
  • Revert changes to inlinesInBalancedBrackets (commit fa83246), which caused regressions.
  • Improve detection of pipe table line widths (#7713). Fixed calculation of maximum column widths in pipe tables. It is now based on the length of the markdown line, rather than a “stringified” version of the parsed line. This should be more predictable for users. In addition, we take into account double-wide characters such as emojis.
  • Custom (Lua) readers:
  • First argument is now a list of sources instead of the concatenated text (Albert Krewinkel). The list structure can easily be converted to a string by applying tostring, but it is also possible to access the elements (each with a text and name). A small example is added to the custom reader documentation, showcasing its use in a reader that creates a syntax-highlighted code block for each source code file passed as input. Existing readers will still work through a fallback mechanism, issuing a deprecation notice.
  • Org reader:
  • Parse official org-cite citations (#7329). We also support the older org-ref style as a fallback. We no longer support the “markdown style” or “Berkeley style” citations.
  • Support alphabetical (fancy) lists (Lucas Viana). When the fancy_lists extension is enabled, alphabetical list markers are allowed, mimicking the behaviour of Org Mode when org-list-allow-alphabetical is enabled.
  • Support counter cookies in lists (Lucas Viana). Such cookies are used to override the item counter in ordered lists. In org it is possible to set the counter at any list item, but since Pandoc AST does not support this, we restrict the usage to setting an offset for the entire ordered list, by using the cookie in the first list item.
  • Allow trailing spaces after key/value pairs in directives (Albert Krewinkel). Ensures that spaces at the end of attribute directives like #+ATTR_HTML: :width 100% (note the trailing spaces) are accepted.
  • LaTeX reader:
  • Omit visible content for label{...}. Previously we included the text of the label in square brackets, but this is undesirable in many cases. See discussion in #813 (comment).
  • Improve references (#813). Resolve references to theorem environments. Remove the Span caused by “label” in figure, table, and theorem environments; this had an id that duplicated the environments’ id.
  • Fix semantics of ref. We were including the ams environment type in addition to the number. This is proper behavior for cref but not for ref. To support cref we need to store the environment label separately.
  • Add babel mappings for Guajati (gu) and Oriya (or) (#7815).
  • Fix typo panjabi -> punjabi in babel mappings (#7814).
  • HTML reader:
  • Parse attributes on links and images (#6970).
  • Docx reader:
  • Handle multiple pic elements inside a drawing (#7786).
  • Change elemToParPart to return [ParPart] instead of ParPart. Also remove NullParPartconstructor, as it is no longer needed. This will allow us to handle elements that contain multiple ParParts, e.g. w:drawing elements with multiple pic:pic.
  • DocBook reader:
  • Collapse internal spaces in literal and other similar tags (#7821), as the standard docbook toolchain does.
  • Be sensitive to spacing=“compact” in lists (#7799). When spacing="compact" is set, Para elements are turned into Plain, so we get a “tight” list.
  • Markdown writer:
  • Add new exported function writeMarkua from Text.Pandoc.Writers.Markdown [API change] (#1871, Tim Wisotzki and Saumel Lemmenmeier).
  • Fix indentation issue in footnotes (#7801).
  • Avoid extra space before citation suffix if it already starts with a space.
  • Ensure semicolon between the locator and the next citation when an author-in-text citation has a locator and following citations.
  • Improve escaping for # (#7726).
  • Custom (Lua) writers:
  • Allow variables to be set via second return value of Doc (#6731, Albert Krewinkel). New templates variables can be added by giving variable-value pairs as a second return value of the global function Doc.
  • Provide global PANDOC_WRITER_OPTIONS (#6731, Albert Krewinkel).
  • Assign default Pandoc object to global PANDOC_DOCUMENT (Albert Krewinkel). The default Pandoc object is now non-strict, i.e., only the parts of the document that are accessed will be marshaled to Lua. A special type is no longer necessary. This change also makes it possible to use the global variable with library functions such as pandoc.utils.references, or to inspect the document contents with walk().
  • LaTeX writer:
  • Fix typo panjabi -> punjabi in babel mappings (#7814).
  • MediaWiki writer:
  • Remove redundant display text for wiki links (Jesse Hathaway).
  • Docx writer:
  • Handle bullets correctly in lists by not reusing numIds (#7689, Michael Hoffmann). This fixes a bug in which a Div in a list item would receive bullets on its contained paragraphs.
  • Org writer:
  • Fix list items starting with a code block or other non-paragraph content (#7810).
  • Avoid blank lines after tight sublists (#7810).
  • Fix extra blank line inserted after empty list item (#7810).
  • Don’t add blank line before lists (#7810).
  • Support starting number cookies (Lucas Viana). This is necessary for lists that start at a number other than 1.
  • Support the new org-cite syntax (#7329).
  • Haddock writer:
  • Avoid blank lines after tight sublists (#7810).
  • Ipynb writer:
  • Ensure deterministic order of keys.
  • Handle cell output with raw block of markdown (#7563, Kolen Cheung). Write RawBlock of markdown in code-cell output. This is designed to fit the behavior of #7561, which makes the ipynb reader parse code-cell output with mime “text/markdown” to a RawBlock of markdown. This commit makes the ipynb writer writes this RawBlock of markdown back inside a code-cell output with the same mime, preserving this information in round-trip.
  • In choosing between multiple output options, always favor those marked with the output format over images (Kolen Cheung). Previously, both fmt == f case and Image have a rank of 1.
  • Ipynb reader & writer: properly handle cell “id” (#7728). This is passed through if it exists (in Nb4); otherwise the writer will add a random one so that all cells have an “id”.
  • Ms writer:
  • Properly encode strings for PDF contents (#7731).
  • JATS writer:
  • Keep quotes in element-citations (Albert Krewinkel). Fixed a bug that lead to quote characters being lost in element-citations.
  • RTF writer:
  • Properly handle images in data URIs (#7771).
  • Commonmark writer:
  • Allow ‘)’ delimiters on ordered lists.
  • RST writer:
  • Avoid extra blank line after empty list item (#7810).
  • HTML writer:
  • Make line breaks more consistent. With --wrap=none, we now output line breaks between block-level elements. Previously they were omitted entirely, so the whole document was on one line, unless there were literal line breaks in pre sections. This makes the HTML writer’s behavior more consistent with that of other writers. Also, regardless of wrap settings, put newline after and after block-level elements in the footnotes section. And add a line break between an img tag and the associated figcaption.
  • reveal.js: Make sure images with r-stretch are not in p tags. They must be direct children of the section. There was previously code to make this work with the older class name stretch, but the name has changed in reveal.js.
  • reveal.js: don’t add r-fit-text class to section. It must go on the header only.
  • AsciiDoc writer:
  • Improve detection of intraword emphasis (#7803).
  • OpenDocument writer:
  • Fix vertical alignment bug with display math (#7777). Previously some displayed formulas would be floated above a preceding text line. This is fixed by setting vertical-rel to text rather than paragraph-content.
  • JATS template (Albert Krewinkel):
  • Fix position of contrib affiliations in authoring set. Any element must come before any element.
  • Fix affiliation tagging in articleauthoring output. Affiliations were xlinked even in the articleauthoring tag set, but are not allowed as children of contrib-group elements in that tag set. Each affiliation must be listed directly in the contrib element.
  • Add support for article subtitles.
  • EPUB template:
  • Include abstract in default template.
  • Ensure that the essential styles needed by pandoc (styles.html partial) are included in the templates. This is important for correct formatting of CSL bibliographies. Note that much of the styling in styles.html will be ignored for EPUB, because of the conditional on document-css. Setting the document-css variable will cause it not to be ignored.
  • HTML template: Add abstract (#7588, Jannik Buhr, John MacFarlane). By default, a localized title (the word “Abstract”) will be used, unless the variable abstract-title is set.
  • ConTeXt template: Make title appear in PDF title bar. This is recommended for accessibility reasons. Note: doesn’t work with macOS Preview.app.
  • reference.pptx: change to use 16:9 aspect ratio, Powerpoint’s default.
  • Text.Pandoc.Writers:
  • Do not export writeCustom [API change]. This ensures that all writers exported in T.P.Writers are parameterized and work with any PandocMonad type. This is consistent with T.P.Readers, as readCustom is not exported from that module either.
  • Text.Pandoc.Writers.Shared:
  • endsWithPlain now returns True if the list ends with a list that ends with a Plain, and so on recursively (#7810).
  • Text.Pandoc.Class.IO:
  • writeMedia: unescape percent-encoding in creating file path. This addresses a problem with spaces in image filenames when creating PDFs (#7819); it also affects --extract-media.
  • New internal module Text.Pandoc.Writers.Blaze, exporting layoutMarkup. This converts a blaze Html structure into a doclayout Doc Text.
  • Text.Pandoc.Extensions:
  • parseFormatSpec: cleaner error message for invalid extensions.
  • Text.Pandoc.MediaBag:
  • Fix bug in extractMedia, which caused the test for .. in paths to fail, with the result that images with .. in the path name could be extracted outside of the directory specified by extractMedia. It also led a check for media in resource paths to fail in the docx reader.
  • Text.Pandoc.Citeproc:
  • Avoid adding comma before an author-in-text citation in a note if it begins with a title (no author) (#7761).
  • Text.Pandoc.Citeproc.Locator now exports toLocatorMap, LocatorInfo, and LocatorMap. The type of parseLocator has changed, so it now takes a LocatorMap rather than a Locale as parameter, and returns a LocatorInfo instead of a tuple.
  • Fix citation locator detection for German. toLocatorMap now stores keys case-folded. We want to do a case-insensitive comparison when parsing locators, so that e.g. both Chap. and chap. work. Previously we case-folded terms when doing the lookup, but they weren’t case-folded in the map itself, which led to locator-detection breaking for German (where the terms have uppercase letters).
  • Lua (Albert Krewinkel):
  • Allow single elements as singleton MetaBlocks/MetaInlines. Single elements should always be treated as singleton lists in the Lua subsystem.
  • Add pandoc.template module. The module provides a compile function to use strings as templates.
  • Add pandoc.WriterOptions constructor.
  • Add function pandoc.write.
  • Provide global PANDOC_WRITER_OPTIONS (#5221).
  • The function Text.Pandoc.Filter.applyFilters now takes a filter environment of type Environment, instead of a ReaderOptions value [API change].
  • The Environment type is exported from Text.Pandoc.Filter and allows to combine ReaderOptions and WriterOptions in a single value [API change].
  • Global, exported from Text.Pandoc.Lua, has a new type constructor PANDOC_WRITER_OPTIONS [API change].
  • Add constructors pandoc.Blocks and pandoc.Inlines. The functions convert their argument into a list of Block and Inline values, respectively. When applied to a string, they split the string into Str elements separated by Space or SoftBreak (#7712).
  • Support topdown traversals The traversal order of filters can now be selected by setting the key traverse of the filter to either 'topdown' or 'typewise'; the default remains 'typewise'. Topdown traversals can be cut short by returning false as a second value from the filter function. No child-element of the returned element is processed in that case.
  • Marshal ReaderOptions field extensions, track_changes via JSON. Extensions are now available as a list of strings; the track-changes settings are given as the kebab-case representation used in JSON.
  • Allow binary (byte string) readers to be used with pandoc.read.
  • Use global state when parsing documents in pandoc.read. The function pandoc.read is updated to use the same state that was used while parsing the main input files. This ensures that log messages are preserved and that images embedded in the input are added to the mediabag.
  • Cleanup stack in peekReadOptionsTable. A ReaderOptions element was left on top of the stack when the peekReadOptionsTable function was invoked.
  • walk methods are added to Pandoc, Block, Inline, Blocks, Inlines values; the methods are similar to pandoc.utils.walk_block and pandoc.utils.walk_inline, but apply to filter to the element’s contents.
  • Functions of name Doc are no longer accepted as alternatives for Pandoc filter functions. This functionality was undocumented.
  • Improve handling of empty caption, body by from_simple_table #7776). Create truly empty table caption and body when these are empty in the simple table.
  • Change representation of TableHead, TableFoot, and Row values (#7718). The objects now also follow the principle that element attributes are accessible through the .attr field. Rows in TableHead and TableFoot are available via the .rows field. Row objects have a .cells field, containing the list of table cells.
  • Simplify code of pandoc.utils.stringify. Minor behavior change: plain strings nested in tables are now included in the result string.
  • Simplify and deprecate function pandoc.utils.equals. The function is no longer required for element comparisons; it is now an alias for the == operator.
  • Add function pandoc.utils.references (#7752).
  • Add new library function pandoc.utils.type. The function behaves like the default type function from Lua’s standard library, but is aware of pandoc userdata types. A typical use-case would be to determine the type of a metadata value.
  • Fix return types of blocks_to_inlines, make_sections. Ensures the returned lists have the correct type (Inlines and Blocks, respectively).
  • Use more natural representation for Reference values Omit false boolean values, push integers as numbers.
  • Lua: use package pandoc-lua-marshal (#7719, Albert Krewinkel). The marshaling functions for pandoc’s AST are extracted into a separate package. The package comes with a number of changes:
  • Pandoc’s List module was rewritten in C, and error messages were improved.
  • Lists of Block and Inline elements are marshaled using the new list types Blocks and Inlines, respectively. These types currently behave identical to the generic List type, but give better error messages. This also opens up the possibility of adding element-specific methods to these lists in the future.
  • Elements of type MetaValue are no longer pushed as values which have .t and .tag properties. This was already true for MetaString and MetaBool values, which are still marshaled as Lua strings and booleans, respectively. Affected values:
  • MetaBlocks values are marshaled as a Blocks list;
  • MetaInlines values are marshaled as a Inlines list;
  • MetaList values are marshaled as a generic pandoc Lists.
  • MetaMap values are marshaled as plain tables and no longer given any metatable.
  • Cell values are now marshaled as userdata objects; a constructor function for table cells is provided as pandoc.Cell.
  • The test suite for marshaled objects and their constructors has been extended and improved.
  • A bug in Citation objects, where setting a citation’s suffix modified it’s prefix, has been fixed.
  • Inlines, Blocks, and List objects now have an __eq metamethod, testing equality by comparing two lists element-wise.
  • Powerpoint tests: shorten lines by grouping tests (Albert Krewinkel). This makes the test output more pleasant to read in narrow terminal windows.
  • make check: check for unreleased dependencies.
  • Add tools/build-and-upload-api-docs.sh.
  • Update cabal description.
  • MANUAL.txt: Add section on EPUB styling.
  • MANUAL.txt: clarify “standard Markdown” as “original Markdown” (#7802, Martin Fischer).
  • doc/custom-writers.md: use filter to include source of example.
  • Add an example to doc/custom-readers.md.
  • Fix typo in custom-readers.md (#7722, Mauro Bieg).
  • doc/jats.md: add link to JATS documentation (Martin Fischer).
  • doc/lua-filters.md: many improvements (Albert Krewinkel, John MacFarlane).
  • Use commonmark-extensions 0.2.3. This allows a bare-word class attribute on fenced divs.
  • Use ipynb 0.2.
  • Use citeproc 0.6.0.1.
  • Use texmath 0.12.4.
  • Use doctemplates 0.10.0.1.

New in Pandoc 2.16.2 (Nov 22, 2021)

  • Add interface for custom readers written in Lua (#7669). Users can now do -f myreader.lua and pandoc will treat the script myreader.lua as a custom reader, which parses an input string to a pandoc AST, using the pandoc module defined for Lua filters. A sample custom reader can be found in data/creole.lua. Also see documentation in doc/custom-readers.md.
  • New module Text.Pandoc.Readers.Custom, exporting readCustom [API change].
  • Allow plain to be used in raw attribute syntax.
  • Accept empty --metadata-file (#7675). This was a regression from 2.15 behavior.
  • Markdown reader: Improve inlinesInBalancedBrackets. This is just a small improvement in terms of performance, but it’s simpler and more direct code. Also, we avoid parsing interparagraph spaces in balanced brackets, as the original did.
  • BibTeX reader: Properly handle commented lines in BibTeX/BibLaTeX (#7668).
  • RST reader: handle class attribute for for custom roles (#7699, willj-dev). Previously the class attribute was ignored, and the name of the role used as the class.
  • JATS reader: Capture alt-text in figures (#7703, Aner Lucero).
  • MediaWiki writer: use HTML spans for anchors when header has id (#7697). We need to generate a span when the header’s ID doesn’t match the one MediaWiki would generate automatically. Note that MediaWiki’s generation scheme is different from pandoc’s (it uses uppercase letters, and _ instead of -, for example). This means that in going from markdown to mediawiki, we’ll now get spans before almost every heading, unless explicit identifiers are used that correspond to the ones MediaWiki auto-generates. This is uglier output but it’s necessary for internal links to work properly.
  • Markdown writer: don’t create autolinks when this loses information (#7692). Previously we sometimes lost attributes when rendering links as autolinks.
  • Text.Pandoc.Readers.Metadata: allow multiple YAML documents when parsing YAML for yamlBsToRefs. Some people use --- as the end delimiter in YAML bibliography files, which causes the yaml library to emit an error unless we explicitly allow multiple YAML documents (and just consider the first).
  • HTML writer: Don’t create invalid data- attribute for empty attribute key (#7546).
  • JATS template: fix equal-contrib attribute (Albert Krewinkel). The standard requires the value to be either yes or no, but is was set to true for authors who contributed equally.
  • reveal.js template: Add disableLayout variable (Christophe Dervieux).
  • Text.Pandoc.Error: sort errors in handleError by exit code (Albert Krewinkel).
  • Text.Pandoc.Writers.Shared: Improve toLegacyTable (#7683, Christian Despres).
  • Lua subsystem:
  • Include lpeg module (#7649, Albert Krewinkel). Compiles the lpeg library (Parsing Expression Grammars For Lua) into the program. Package maintainers may choose to rely on package dependencies to make lpeg available, in which case they can compile the with the constraint lpeg +rely-on-shared-lpeg-library. lpeg and re are always made available in global variables, without the need for a require.
  • Set lpeg and re as globals; allow shared lib access via require. The lpeg and re modules are loaded into globals of the respective name, but they are not necessarily registered as loaded packages. This ensures that
  • the built-in library versions are preferred when setting the globals,
  • a shared library is used if pandoc has been compiled without lpeg, and
  • the require mechanism can be used to load the shared library if available, falling back to the internal version if possible and necessary.
  • Fix argument order in constructor pandoc.Cite (Albert Krewinkel). This restores the old behavior; argument order had been switched accidentally in pandoc 2.15.
  • Add Pushable instance for ReaderOptions (Albert Krewinkel).
  • Allow to pass custom reader options to pandoc.read as an optional third argument (#7656, Albert Krewinkel). The object can either be a table or a ReaderOptions value like PANDOC_READER_OPTIONS. Creating new ReaderOptions objects is possible through the new constructor pandoc.ReaderOptions.
  • Display Pandoc values using their native Haskell representation (Albert Krewinkel).
  • Require latest hslua (2.0.1) (#7661, #7657, Albert Krewinkel). This fixes issues with
  • misleading error messages when a required function parameter is omitted;
  • absent properties still being listed in the output of pairs; and
  • alias accessing leading to errors instead of returning nil, e.g. with (pandoc.Str '').identifier.
  • Add missing space in “package not found” message (#7658, Albert Krewinkel).
  • Update build files (#7696, Fabián Heredia Montiel). Drop old windows 32-bit constraints. Update cabal tested-with field to correspond to ci.yml matrix
  • Remove unneeded package dependencies from benchmark target.
  • Require ghc >= 8.6, base >= 4.12. This allows us to get rid of the old custom prelude and some crufty cpp. But the primary reason for this is that conduit has bumped its base lower bound to 4.12, making it impossible for us to support lower base versions.
  • Require Cabal 2.4. Use wildcards to ensure that all pptx tests are included (#7677).
  • Update bash_completion.tpl (S.P.H.).
  • Add data/creole.lua as sample custom reader.
  • Add doc/custom-readers.md and doc/custom-writers.md.
  • doc/lua-filters.md: add section on global modules, including lpeg (Albert Krewinkel).
  • MANUAL.txt: update table of exit codes and corresponding errors (Albert Krewinkel).
  • Use latest texmath.
  • DocBook reader:
  • Add support (Rowan Rodrik van der Molen).
  • Support for (#7607, Rowan Rodrik van der Molen).
  • LaTeX reader:
  • Add rudimentary support for autoref (#7693).
  • Add ‘uri’ class when parsing url, for consistency with treatment of autolinks in other formats (#7672).
  • JATS writer:
  • Ensure figures are wrapped with in list items (Albert Krewinkel). This prevents the generation of invalid output.
  • Add URL to element citation entries (Albert Krewinkel). The URL of a reference, if present, is added in tag to element-citation entries.
  • LaTeX writer:
  • Babel mappings: use ancientgreek for grc.
  • With -t latex-smart, don’t generate ldots from ellipsis (#7674). Instead just use unicode ellipsis.

New in Pandoc 2.16.1 (Nov 3, 2021)

  • Docx reader: don’t let first line indents trigger block quotes (#7655). This fixes a regression introduced in pandoc 2.15.
  • Docx writer: use getTimestamp for modification times in reference.docx (#7654). This ensures that when SOURCE_DATE_EPOCH is set, the modification times of files taken from the reference.docx will be set deterministically, allowing for reproducible builds.
  • Allow tasty-bench 0.3.x.
  • Lua subsystem (Albert Krewinkel):
  • Load module pandoc.path on startup (#7524). Previously the module always had to be loaded via require 'pandoc.path'.
  • Fix typo in SoftBreak constructor.
  • Re-add content property to Strikeout elements. Fixes a regression introduced in 2.15.
  • Be more forgiving when retrieving the Image caption property. Fixes a regression introduced in 2.15.
  • Display Attr values using their native Haskell representation.
  • Allow omitting the 2nd parameter in pandoc.Code constructor. Fixes a regression introduced in 2.15 which required users to always specify an Attr value when constructing a Code element.
  • Allow to compare, show Citation values. Comparisons of Citation values are performed in Haskell; values are equal if they represent the same Haskell value. Converting a Citation value to a string now yields its native Haskell string representation.
  • Restore List behavior of MetaList (#7650). Fixes a regression introduced in 2.16 which had MetaList elements lose the pandoc.List properties.
  • Restore content property on Header elements.
  • Ensure Block elements have all expected properties.
  • Ensure Inline elements have all expected properties.

New in Pandoc 2.16 (Nov 1, 2021)

  • Switch back from HsYAML to yaml for parsing YAML metadata (#6084). HsYAML is around 20 times slower in parsing large YAML bibliographies. In addition, HsYAML is not being actively maintained. This sets us back in our attempts to free ourselves from C dependencies (#4535). But I don’t see a good alternative until a faster pure Haskell parser is available. Notes:
  • We’ve removed the FromYAML instances for all types that had them, since this is a HsYAML-specific typeclass [API change]. (The yaml package just uses From/ToJSON instead of having a dedicated From/ToYAML class.)
  • Unlike HsYAML (in the configuration we were using), yaml parses ‘Y’, ‘N’, ‘Yes’, ‘No’, ‘On’, ‘Off’ as boolean values. Users may need to quote these when they are meant to be interpreted as strings. Similarly, ‘null’ is parsed as a YAML null value (and will be treated as an empty string by pandoc rather than the string ‘null’). Quoting it will force it to be interpreted as a string.
  • Some tests had to be adjusted accordingly.
  • Pandoc now behaves in a more useful way when the YAML metadata contains escaping errors: instead of just failng silently and falling back to some other interpretation of the section, it raises a YAML parsing error.
  • Markdown writer: Ensure that special values are quoted in YAML metadata. These include “Y”, “yes”, “on”, and “off”, which are now (with yaml library) considered boolean values, as well as “null”.
  • Change JSON encodings of some types.
  • For LineEnding use lowercase constructors, e.g. crlf, native.
  • For HTMLSlideVariant use lowercase constructors.
  • For ReaderOptions use e.g. default-image-extension instead of readerDefaultImageExtension for field names.
  • For Extension, use e.g. tex_math_dollars instead of Ext_tex_math_dollars as constructor.
  • For Extensions, use an array of Extensions, instead of an object wrapping the tag Extensions and an integer. (The integer representation is not supposed to be part of the public API.)
  • For Opt, use field names like tab-stop instead of optTabStop.
  • Docx writer:
  • Add IDs to native_numbering test (Tristan Stenner).
  • Move “:” out of the caption bookmark (Tristan Stenner). This is needed so that native references to the figure are included as “As seen in Figure X, it is…” instead of “As seen in [Figure: X, it is…”
  • Lua (Albert Krewinkel, except as noted):
  • Use hslua module abstraction where possible.
  • Fix placement of tests for Block elements in pandoc module tests
  • Increase strictness when getting attribute keys
  • Re-add t and tag property to Attr values. Removal of these properties from Attr values was a regression.
  • Fix pandoc.utils.stringify regression. The pandoc.utils.stringify function returned empty strings when called with a string argument.
  • Fix a copy/paste bug in Lua marshalling code (John MacFarlane, #7639). This caused links to be changed to figures when Lua filters changed link properties.
  • Re-add content property to Link elements (#7647). This was a regression introduced in version 2.15.
  • Generate constants in module pandoc programmatically.
  • Marshal SimpleTable, ListAttributes, Citation, and Block values as userdata objects. Properties of Block values are marshalled lazily, which generally improves performance considerably. Script users may also notice the following differences:
  • Block element properties can no longer be accessed by numerical indexing of the .c field. The .c property now serves as an alias for .content, so some filter that used this undocumented method for property access may continue to work, while others will need to be updated and use proper property names.
  • The marshalled Block elements now have a show method, and a __tostring metamethod. Both return the Haskell string representation of the element.
  • Block values now have the Lua type userdata instead of table.
  • Add a short guide to pandoc’s sources (Albert Krewinkel).
  • Fix epub files in epub reader tests, so that they are valid according to epubcheck (#7586).
  • Allow time 1.13.
  • Require latest skylighting (0.12.1).
  • Fix build on GHC 9.2 (Joseph C. Sible).
  • Fix trypandoc so it builds with aeson > 2.

New in Pandoc 2.15 (Oct 24, 2021)

  • Add --sandbox option (#5045).
  • Add sandbox feature. When this option is used, readers and writers only have access to input files (and other files specified directly on command line). This restriction is enforced in the type system.
  • Filters, PDF production, custom writers are unaffected. This feature only insulates the actual readers and writers, not the pipeline around them in Text.Pandoc.App.
  • Note that when --sandboxed is specified, readers won’t have access to the resource path, nor will anything have access to the user data directory.
  • --self-contained: Fix bug that caused everything to be made a data URI (#7635, #7367). We only need to use data URIs in certain cases, but due to a bug they were being used always.
  • Pandoc will now fall back to latin1 encoding for inputs that can’t be read as UTF-8. This is what it did previously for content fetched from the web and not marked as to content type. It makes sense to do the same for local files. In this case a NotUTF8Encoded warning will be issued, indicating that pandoc is interpreting the input as latin1.
  • Markdown reader:
  • Don’t parse links or bracketed spans as citations (#7632). Previously pandoc would parse [link to (@a)](url) as a citation; similarly [(@a)]{#ident}. This is undesirable. One should be able to use example references in citations, and even if @a is not defined as an example reference, [@a](url) should be a link containing an author-in-text citation rather than a normal citation followed by literal (url).
  • Fix interaction of --strip-comments and list parsing (#7521). Use of --strip-comments was causing tight lists to be rendered as loose (as if the comment were a blank line).
  • Fix parsing bug for math in bracketed spans and links (#7623). This affects math with unbalanced brackets (e.g. $(0,1]$) inside links, images, bracketed spans.
  • Fix code blocks using --preserve-tabs (#7573). Previously they did not behave as the equivalent input with spaces would.
  • DocBook reader:
  • Honor linenumbering attribute (Samuel Tardieu). The attribute DocBook linenumbering="numbered" on code blocks maps to the numberLines class internally.
  • LaTeX reader:
  • Implement siunitx v3 commands (#7614). We support unit, qty, qtyrange, and qtylist as synonynms of si, SI, SIrange, and SIlist.
  • Properly handle ^ followed by group closing (#7615).
  • Recognize that vadjust sometimes takes “pre” (#7531).
  • Ignore (and gobble parameters of) CSLReferences environment (#7531). Otherwise we get the parameters as numbers in the output.
  • Restrict endinput to current file (Simun Schuster).
  • RST reader: handle escaped colons in reference definitions (#7568).
  • HTML reader:
  • Handle empty tbody element in table (#7589).
  • Ipynb reader (Kolen Cheung):
  • Get cell output mime from raw_mimetype in addition to format. (format is what the spec calls for, but raw_mimetype is often used in practice; see jupyter/nbformat#229).
  • Add more formats that can be handled as “raw” cells.
  • Fix mime type for rst.
  • Support text/markdown, which is now a supported mime type for raw output (#7561).
  • RTF reader:
  • Support binN for binary image data.
  • If doc begins with { … } only parse its contents. Some documents seem to have non-RTF (e.g. XML) material after the {rtf1 ... } group.
  • Ignore pgdsc group. Otherwise we get style names treated as test.
  • Better handling of * and bookmarks. We now ensure that groups starting with * never cause text to be added to the document. In addition, bookmarks now create a span between the start and end of the bookmark, rather than an empty span.
  • Docx reader:
  • Avoid blockquote when parent style has more indent (Milan Bracke). When a paragraph has an indentation different from the parent (named) style, it used to be considered a blockquote. But this only makes sense when the paragraph has more indentation. So this commit adds a check for the indentation of the parent style.
  • Fix handling of empty fields (Milan Bracke). Some fields only have an instrText and no content, Pandoc didn’t understand these, causing other fields to be misunderstood because it seemed like a field was still open when it wasn’t.
  • Implement PAGEREF fields (Milan Bracke). These fields, often used in tables of contents, can be a hyperlink.
  • Fix handling of nested fields (Milan Bracke). Fields delimited by fldChar elements can contain other fields. Before, the nested fields would be ignored, except for the end, which would be considered the end of the parent field.
  • Add placeholder for word diagram instead of just omitting it (Ezwal).
  • Org reader:
  • Don’t parse a list as first item in a list item (#7557).
  • Allow an initial :PROPERTIES: drawer to add to metadata (#7520).
  • Docx writer:
  • Make id used in native_numbering predictable (#7551). If the image has the id IMAGEID, then we use the id ref_IMAGEID for the figure number. This allows one to create a filter that adds a figure number with figure name, e.g. Figure X . If an image lack an id, an id of the form ref_fig1 is used.
  • Ensure we have unique ids for wp:docPr and pic:cNvPr elements (#7527, #7503).
  • Handle SVG images (#4058). This change has several parts:
  • In Text.Pandoc.App, if the writer is docx, we fill the media bag and attempt to convert any SVG images to PNG, adding these to the media bag. The PNG backups have the same filenames as the SVG images, but with an added .png extension. If the conversion cannot be done (e.g. because rsvg-convert is not present), a warning is omitted.
  • In Text.Pandoc.Writers.Docx, we now use Word 2016’s syntax for including SVG images. If a PNG fallback is present in the media bag, we include a link to that too.
  • Powerpoint writer (Emily Bourke):
  • Add support for more layouts (#5097). Up til now, four layouts were supported: “Title Slide” (used for the automatically generated metadata slide), “Section Header” (used for headings above slide level), “Two Column” (used when there’s a columns div), “Title and Content” (used for all other slides). We now support three additional layouts: “Comparison”, “Content with Caption”, and “Blank”. The manual describes the logic that determines which layout is used for a slide. Layouts may be customized in the reference doc.
  • Support specifying slide background images using a background-image attribute on the slide’s heading. Only the “stretch” mode is supported, and the background image is centred around the slide in the image’s larger axis, matching the observed default behaviour of PowerPoint.
  • Add support for incremental lists (through same methods as in other slide writers) (#5689).
  • Copy embedded fonts from reference doc.
  • Include all themes in output archive.
  • Fix list level numbering (#4828, #4663). In PowerPoint, the content of a top-level list is at the same level as the content of a top-level paragraph: the only difference is that a list style has been applied. Previously, the writer incremented the paragrap h level on each list, turning what should be top-level lists into second-level lists.
  • Line up list continuation paragraphs. This commit changes the marL and indent values used for plain paragraphs and numbered lists, and changes the spacing defined in the reference doc master for bulleted lists. For paragraphs, there is now a left-indent taken from the otherStyle in the master. For numbered lists, the number is positioned where the text would be if this were a plain paragraph, and the text is indented to the next level. This means that continuation paragraphs line up nicely with numbered lists. Existing reference docs may need to be modified so that otherStyle and bodyStyle indent levels match, for this feature to work with them.
  • Consolidate text runs when possible (jgm). This slims down the output files by avoiding unnecessary text run elements.
  • Support footers in the reference doc. There is one behaviour which may not be immediately obvious: if the reference doc specifies a fixed date (i.e. not automatically updating), and there’s a date specified in the metadata for the document, the footer date is replaced by the metadata date.
  • Fix presentation rel numbering. Before now, the numbering of rIds was inconsistent when making the presentation XML and when making the presentation relationships XML.
  • Don’t add relationships unnecessarily. Before now, for any layouts added to the output from the default reference doc, the relationships were unconditionally added to the output. However, if there was already a layout in slideMaster1 at the same index then that results in duplicate relationships.
  • If slide level is 0, don’t insert a slide break between a heading and a following table, “columns” div, or paragraph starting with an image.
  • Fix capitalisation of notesMasterId.
  • Restructure tests.
  • Asciidoc writer:
  • Translate numberLines attribute to linesnum switch (Samuel Tardieu).
  • Improve escaping for -- in URLs (#7529).
  • LaTeX writer:
  • Make babel use more idiomatic (#7604, hseg). Use babel’s bidi implementation. Import babel languages individually instead of as package options. Move header-includes to after babel setup so it can be modified.
  • Use babel, not polyglossia, with xelatex. Previously polyglossia worked better with xelatex, but that is no longer the case, so we simplify the code so that babel is used with all latex engines. This involves a change to the default LaTeX template.
  • Markdown writer:
  • Avoid bad wraps at the Doc Text level. Previously we tried to do this at the Inline list level, but it makes more sense to intervene on breaking spaces at the Doc Text level.
  • Use underline class rather than ul for underline. This only affects output with bracketed_spans enabled. The markdown reader parses spans with either .ul or .underline as Underline elements, but we’re moving towards preferring the latter.
  • RST writer:
  • Properly handle anchors to ids with spaces or leading underscore (#7593). In this cases we need the quoted form, e.g.
  • .. _`foo bar`:
  • .. _`_foo`:
  • Side note: rST will “normalize” these identifiers anyway, ignoring the underscore.
  • HTML writer:
  • Render ref and eqref as inline math, not display (see #7589).
  • Pass through ref and eqref if MathJax is used (#7587).
  • Pass through inline math environments with KaTeX.
  • Support --reference-location for HTML output (#7461, Francesco Mazzoli).
  • Set “hash” to True by default (for reveal.js) (#7574). See #6968 where the motivation for setting “hash” to True is explained.
  • Native writer: Use pretty-show to format native output (#7580). Previously we used our own homespun formatting. But this produces over-long lines that aren’t ideal for diffs in tests. Performance is slower by about a factor of 10, but this isn’t really a problem because native isn’t suitable as a serialization format. (For serialization you should use json, because the reader is so much faster than native.)
  • Org writer:
  • Don’t indent contents of code blocks. We previously indented them by two spaces, following a common convention. Since the convention is fading, and the indentation is inconvenient for copy/paste, we are discontinuing this practice.
  • Update list of supported source languages in org writer (#5440).
  • Ipynb writer (Kolen Cheung):
  • Improve round trip identity for raw cell output. See jupyter/nbformat#229. The Jupyter ecosystem, including nbconvert, lab and notebook, deviated from their own spec in nbformat, where they used the key raw_mimetype instead of format. Moreover, the mime-type of rst used in Jupyter deviated from that suggested by https://docutils.sourceforge.io/FAQ.html and is defined as text/restructuredtext when chosen from “Raw NBConvert Format” in Jupyter. The new behavior should matche the real world usage better, hence improving the round-trip “identity” in raw-cell.
  • Add more formats that can be handled as “raw” cells.
  • EPUB writer:
  • Add EPUB3 subject metadata (authority/term) (nuew). This adds the ability to specify EPUB 3 authority and term specific refinements to the subject tag. Specifying a plain subject tag in metadata will function as before.
  • Treat epub:type “frontispiece” as front matter (#7600).
  • reveal.js template: Fix line numbers in source code (#7634). We need overflow: visible for these to work, and reveal’s default css disables this. So we re-enable it in the default template.
  • Text.Pandoc.Writers.Shared:
  • Export splitSentences as a Doc Text transform [API change]. Use this in man/ms. We used to attempt automatic sentence splitting in man and ms output, since sentence-ending periods need to be followed by two spaces or a newline in these formats. But it’s difficult to do this reliably at the level of [Inline].
  • Text.Pandoc.Translations: small revisions for compatibility with aeson 2.
  • Don’t prepend file:// to --syntax-definition on Windows (#6374). This was a fix for a problem in skylighting, but this problem doesn’t exist now that we’ve moved from HXT to xml-conduit.
  • Text.Pandoc.Extensions:
  • Add Ext_footnotes to default gfm etxensions. Now gfm supports footnotes.
  • Alphabetize Extension constructors (also affects --list-extensions).
  • Text.Pandoc.Citeproc.Util: Better implementation of splitStrWhen. Previously the citeproc code had two less efficient implementations.
  • Update documentation for definition_list extension (#7594). In 2015, we relaxed indentation requirements for the first line of a definition (see commit d3544dc and issue #2087), but the documnentation wasn’t updated to reflect the change.
  • Text.Pandoc.Citeproc.BibTeX: Fix expansion of special strings in series e.g. newseries or library (#7591). Expansion should not happen when these strings are protected in braces, or when they’re capitalized.
  • Text.Pandoc.Logging: add NotUTF8Encoded constructor to LogMessage [API change].
  • Text.Pandoc.App.FormatHeuristics: remove .tei.xml extension for TEI (#7630). This never worked, because takeExtension only returns .xml. So it won’t be missed if we remove it.
  • Text.Pandoc.Image:
  • Generalize svgToPng to MonadIO.
  • svgToPng, change first parameter from WriterOptions to Int.
  • Text.Pandoc.Class:
  • Add readStdinStrict method to PandocMonad [API change].
  • Generalize type of extractMedia [API change]. It was uselessly restricted to PandocIO, instead of any instance of PandocMonad and MonadIO.
  • Text.Pandoc.Class.PandocIO: derive MonadCatch, MonadThrow, MonadMask. This allows us to use withTempDir [API change].
  • Add module Text.Pandoc.Class.Sandbox, defining sandbox. Exported via Text.Pandoc.Class. [API change]
  • Text.Pandoc.Filter: Generalize type of applyFilters from PandocIO to any instance of MonadIO and PandocMonad [API change].
  • Text.Pandoc.PDF: generalize type of makePDF: instead of PandocIO, it can be used in any instance of PandocMonad, MonadIO, and MonadMask [API change].
  • Lua subsystem and custom writers: generalize types from PandocIO to any instance of PandocMonad and MonadIO [API change]. The type of runLua is now
  • (PandocMonad m, MonadIO m) =>
  • LuaE PandocError a -> m (Either PandocError a)
  • The change from Lua to LuaE PandocError is due to the switch to hslua-2.0; see next item.
  • Lua modules (Albert Krewinkel):
  • Switch to hslua-2.0. The new HsLua version takes a somewhat different approach to marshalling and unmarshalling, relying less on typeclasses and more on specialized types. This allows for better performance and improved error messages. Furthermore, new abstractions allow to document the code and exposed functions.
  • Marshal Version values, Inline elements, Attr elements, and Pandoc elements as userdata.
  • Remove deprecated inline constructors DoubleQuoted, SingleQuoted, DisplayMath, and InlineMath.
  • Attr values are no longer normalized when assigned to an Inline element property.
  • It’s no longer possible to access parts of Inline elements via numerical indexes. E.g., pandoc.Span('test')[2] used to give pandoc.Str 'test', but yields nil now. This was undocumented behavior not intended to be used in user scripts. Use named properties instead.
  • Accessing .c to get a JSON-like tuple of all components no longer works. This was undocumented behavior.
  • Only known properties can be set on an element value. Trying to set a different property will now raise an error.
  • Adds a new pandoc.AttributeList() constructor, which creates the associative attribute list that is used as the third component of Attr values. Values of this type can often be passed to constructors instead of Attr values.
  • Convert IOErrors to PandocErrors in pandoc.pipe function (#7523).
  • Text.Pandoc.PDF: Previously we had to run runIOorExplode inside withTempDir. Now that PandocIO is an instance of MonadMask, this is no longer necessary.
  • Text.Pandoc.App:
  • Reorganize to make it easier to limit IO in main loop. Previously we used liftIO fairly liberally. The code has been restructured to avoid this.
  • Move output-file writing out of PandocMonad action.
  • Text.Pandoc.App.OutputSettings: Generalize some types so we can run this with any instance of PandocMonad and MonadIO, not just PandocIO.
  • Use simpleFigure builder in readers and SimpleFigure pattern synonym in writers (Aner Lucero).
  • Allow time 1.12.
  • Use skylighting-0.12, skylighting-core-0.12. This fixes highlighting issues with typescript, scala, and other syntaxes that include keyword lists from different syntaxes.
  • Use citeproc 0.6, commonmark 0.2.2.1, commonmark-extensions 0.2.2, texmath 0.12.3.2, ipynb 0.1.0.2. (These changes also allow building with aeson >= 2.)
  • Require doclayout >= 0.3.1.1. This fixes recognition of “real widths” of emoji characters, which is important for tabular layout.
  • Cut out over 100K of fat in epub test golden files.
  • Make test/epub/wasteland.epub valid.
  • Add missing % on some command tests. This prevented --accept from working properly.
  • Command tests: raise error if command doesn’t begin with %.
  • OOXML tests: use pretty-printed form to display diffs. Otherwise everything is on one line and the diff is uninformative.
  • Fix compareXML helper in Tests.Writers.OOXML. Given how it is used, we were getting “mine” and “good” flipped in the test results.
  • MANUAL.txt:
  • Clarify attributes extension support (William Lupton).
  • Document formats affected by --reference-location.
  • Document error code 25
  • Add some more info regarding --slide-level=0 (Salim B).
  • Add more to security section of manual.
  • Mention support of title-toc (#7171, Christophe Dervieux).
  • doc/lua-filters.md:
  • Add missing type for Image title (Quinn).
  • Improve order of Image fields (Quinn).
  • Rephrase pandoc.path docs (#7548, Quinn).
  • Do not leak working directory in TikZ filter (Jeroen de Haas).

New in Pandoc 2.14.2 (Aug 23, 2021)

  • Allow --slide-level=0 (#7476). When the slide level is set to 0, headings won’t be used at all in splitting the document into slides. Horizontal rules must be used to separate slides.
  • Add RTF reader (#3982). rtf is now supported as an input format as well as an output format. New module Text.Pandoc.Readers.RTF (exporting readRTF). [API change]
  • HTML reader: treat comments as blank when parsing (#7482).
  • Markdown reader:
  • Fix raw LaTeX injection issue (#7497). Using a code block containing end{verbatim}, one could inject raw TeX into a LaTeX document even when raw_tex is disabled. Thanks to Augustin Laville for noticing the bug.
  • Multimarkdown sub- and superscripts (#5512, OCzarnecki). Added an extension short_subsuperscripts which modifies the behavior of subscript and superscript, allowing subscripts or superscripts containing only alphanumerics to end with a space character (eg. x^2 = 4 or H~2 is combustible). This improves support for multimarkdown.
  • RST reader: Fix :literal: includes (#7513). These should create code blocks, not insert raw RST.
  • LaTeX reader:
  • Proper implicit grouping around environment macros.
  • Support global before def, let, etc. (#7494).
  • Fix scope for LaTeX macros (#7494). They should by default scope over the group in which they are defined (except gdef and xdef, which are global). In addition, environments must be treated as groups.
  • Improve handling of plain TeX macro primitives (#7474). Fixed semantics for let.
  • Implement edef, gdef, and xdef.
  • Docx reader: Improve docx reader’s robustness in extracting images (#7511). The docx reader made some assumptions about how docx containers were laid out that were not always true, with the result that some images in documents did not get extracted.
  • LaTeX writer: Increase table column width precision (#7466, Peter Fabinski). In some cases, the rounding performed by the LaTeX table writer would introduce visible overrun outside the text area. This adds two more decimal places to the width values.
  • Powerpoint writer:
  • Include image title in description (#7352, Emily Bourke). The image title (i.e. ![alt text](link "title")) was previously ignored when writing to pptx. This commit includes it in PowerPoint’s description of the image, along with the link.
  • Select layouts from reference doc by name (Emily Bourke). Until now, users had to make sure that their reference doc contains layouts in a specific order: the first four layouts in the file had to have a specific structure. Now the layout selection uses the layout names rather than order: users must make sure their reference doc contains four layouts with specific names, and if a layout with the right name isn’t found pandoc will emit a warning and use the corresponding layout from the default reference doc as a fallback.
  • Docx writer: be sensitive to the native_numbering extension (#7499). Figure and table numbers are now only included if native_numbering is enabled. (By default it is disabled.) This is a behavior change with respect to 2.14.1, but the default behavior is now that of previous versions. The change was necessary to avoid incompatibilities between pandoc’s native numbering and third-party cross reference filters like pandoc-crossref.
  • RTF writer:
  • Omit bin in pict. According to the spec, this is not needed or wanted when the data is in hexadecimal format, as here.
  • Emit ``` for section headings.
  • RTF template: specify font family for fixed-width font f1. According to the spec, this is mandatory.
  • LaTeX writer: Use ulem for underline (#7351). ulem is conditionally included already when the strikeout variable is set, so we set this when there is underlined text, and use uline instead of underline. This fixes wrapping for underlined text.
  • Text.Pandoc.Citeproc:
  • Revise citeproc code to fit new citeproc 0.5 API (thanks to Benjamin Bray). Linkification of URLs in the bibliography is now done in the citeproc library, depending on the setting of an option. We set that option depending on the value of the metadata field link-bibliography (defaulting to true, for consistency with earlier behavior). If a DOI, PMID, PMCID, or URL field is present but not explicitly rendered, the title (or if no title, the whole entry) is hyperlinked. These changes implement the recommendations from the draft CSL v1.0.2 spec (Appendix VI): https://github.com/citation-style-language/documentation/blob/master/specification.rst#appendix-vi-links
  • Avoid odd handling of quotes. Recent citeproc changes allow us to ignore Quoted elements; citeproc now uses its own method for represented quoted things, and only localizes and flipflops quotes it adds itself. Convert Quoted in bib entries to special Spans before passing them off to citeproc. This ensures that we get proper localization and flipflopping if, e.g., quotes are used in titles (jgm/citeproc#87).
  • Removed quote localization from citeproc processing. This is now done in citeproc itself.
  • Text.Pandoc.Logging: Add PowerpointTemplateWarning log message type [API change] (Emily Bourke).
  • Text.Pandoc.Extension: Add Ext_short_subsuperscripts constructor to Extension [API change] (OCzarnecki).
  • Various sample.lua editorial fixes (#7493, #7487, William Lupton).
  • Bump base-compat version so we get compatibility with base 4.12.
  • Use Prelude from base-compat for ghc 8.4 too.
  • Add haskell-language-server to shell.nix (#7496, Emily Bourke).
  • Tests.Helpers: export testGolden and use it in RTF reader. This gives a diff output on failure.
  • Remove obsolete and incorrect sentence in --slide-level docs.
  • Add internal module Text.Pandoc.Network.HTTP, exporting urlEncode.
  • Text.Pandoc.Parsing: parseFromString: preserve at least the source directory (#7464). Previously we just set the source name to “chunk” when parsing from strings, to avoid misleading source positions. This had the side effect that rebase_relative_paths would break inside sections that were parsed as strings. So, now we use “ORIGINAL_SOURCE_PATH_chunk” instead of just “chunk”.
  • Text.Pandoc.MIME: use image/x-xcf instead of application/x-xcf (#7454).
  • Don’t compare cdLine in OOXML golden tests (Emily Bourke). The cdLine field gives the line of the file some CData was found on, which reflects irrelevant formatting differences.
  • Provide more detailed XML diff in tests (Emily Bourke).
  • OOXML tests: silence warnings. These can make the test output confusing, making people think tests are failing when they’re passing.
  • INSTALL.md: Add GitLab CI/CD example (#7448, Veratyr).
  • Document use of the ‘underline’ class (#7492, #7484, William Lupton).
  • Add a FAQ about the “Cannot allocate memory” error on M1 macs.
  • Use texmath 0.12.3.1.
  • Use released citeproc 0.5.
  • Remove dependency on HTTP package (#7456, mt_caret).
  • MANUAL.txt:
  • Clarifications (William Lupton).
  • Add a note on security risks of include directives.

New in Pandoc 2.14.1 (Jul 19, 2021)

  • Text.Pandoc.ImageSize: Add Tiff constructor for ImageType (#7405) [Minor API change]. This allows pandoc to get size information from tiff images.
  • Markdown reader: don’t try to read contents in self-closing HTML tag. Previously we had problems parsing raw HTML with self-closing tags like . The problem was that pandoc would look for a closing tag to close the markdown contents, but the closing tag had, in effect, already been parsed by htmlTag.
  • LaTeX reader:
  • Avoid trailing hyphen in translating languages (#7447). Previously foreignlanguage{english} turned into . The same issue affected Arabic.
  • Support cline in LaTeX tables (#7442).
  • Improved parsing of raw LaTeX from Text streams (rawLaTeXParser, used to read LaTeX in Markdown files, #7434). We now use source positions from the token stream to tell us how much of the text stream to consume. Getting this to work required a few other changes to make token source positions accurate.
  • DocBook reader:
  • Handle images with imageobjectco elements (#7440).
  • Add support for citerefentry (#7437, Jan Tojnar).
  • RST reader: fix regression with code includes (#7436). With the recent changes to include infrastructure, included code blocks were getting an extra newline.
  • HTML reader:
  • Recognize data-external when reading HTML img tags (#7429, Michael Hoffmann). Preserve all attributes in img tags. If attributes have a data- prefix, it will be stripped. In particular, this preserves a data-external attribute as an external attribute in the pandoc AST.
  • Add col, colgroup to ‘closes’ definitions
  • HTML writer:
  • Remove duplicated alt text in HTML output (Aner Lucero).
  • Remove aria-hidden when explicit alt text is provided (Aner Lucero).
  • Set boolean values for reveal.js variables.
  • Docx writer:
  • Add table numbering for captioned tables. The numbers are added using fields, so that Word can create a list of tables that will update automatically.
  • Support figure numbers. These are set up in such a way that they will work with Word’s automatic table of figures (#7392).
  • Markdown writer: put space between Plain and following fenced Div (#4465).
  • EPUB writer: Don’t incorporate externally linked images in EPUB documents (#7430, Michael Hoffmann). Just as it is possible to avoid incorporating an image in EPUB by passing data-external="1" to a raw HTML snippet, this makes the same possible for native Images, by looking for an associated external attribute.
  • Text.Pandoc.PDF:
  • Fix svgIn path error (#7431). We were duplicating the temp directory; this didn’t cause problems on macOS or linux because there we use absolute paths for the temp directory. But on Windows it caused errors converting SVG files.
  • convertImage: normalize paths (#7431). This will avoid paths on Windows with mixed path separators.
  • Text.Pandoc.Class: Always use / when adding directory to image destination with extractMedia, even on Windows.
  • Text.Pandoc.Citeproc:
  • Allow $ characters in bibtex keys (#7409).
  • Set proper initial source name in parsing BibTeX (for better error messages.)
  • Revamp note citation handling (#7394). Use latest citeproc, which uses a Span with a class rather than a Note for notes. This helps us distinguish between user notes and citation notes. Don’t put citations at the beginning of a note in parentheses. Fix small bug in handling of citations in notes, which led to commas at the end of sentences in some cases.
  • Cleanup and efficiency improvement in deNote.
  • Improve punctuation moving with --citeproc. Previously, using --citeproc could cause punctuation to move in quotes even when there aer no citations. This has been changed; punctuation moving is now limited to citations. In addition, we only move footnotes around punctuation if the style is a note style, even if notes-after-punctuation is true.
  • Use citeproc 0.10. This helps improve note citations (see above) and eliminates double hyperlinks in author-in-text citations. Author-only citations are no longer hyperlinked. See jgm/citeproc#77. It also fixes moving of punctuation inside quotes to conform to the CSL spec: only comma and period are moved, not question mark or exclamation point.
  • Text.Pandoc.Error: fix line calculations in reporting parsec errors. Also remove a spurious initial newline in the error report.
  • Use doctemplates 0.4.1, which gives us better support for boolean variable values. Previously $if(foo)$ would evaluate to true for variables with boolean false values, because it cared only about the string rendering (#7402).
  • Require commonmark-pandoc >= 0.2.2.1. This fixes task lists with multiple paragraphs.
  • Use skylighting 0.11.
  • CSS in HTML template: reset overflow-wrap on code blocks (Mauro Bieg, #7423).
  • LaTeX template: Revert change in PR #7295: “move title, author, date up to top of preamble.” The change caused problem for people who used LaTeX commands defined defined later in the preamble in the title or author fields (#7422).
  • Add doc/faqs.md. This is imported from the website; in the future the website version will be drawn from here. Added a FAQ on the use of AtEndPreamble for cases when the contents of header-includes need to refer to definitions that come later in the preamble. See #7422.
  • Upgrade Debian 10 AMI for build-arm.sh.
  • CircleCI: change to using xcode 11.1.0 (macOS 10.14.4). We previously built on 10.13, but 10.13 no longer gets security updates and CirclCI is deprecating.

New in Pandoc 2.14.0.3 (Jun 23, 2021)

  • Text.Pandoc.MediaBag insertMediaBag: ensure we get a sane mediaPath for URLs (#7391). In earlier 2.14.x versions, we’d get incorrect paths for resources downloaded from URLs when the media are extracted (including in PDF production).
  • Text.Pandoc.Parsing: improve emailAddress (#7398). Previously the parser would accept characters in domains that are illegal in domains, and this sometimes caused it to gobble bits of the following text.
  • txt2tags reader: modify the email address parser so it still includes form parameters, even after the change to emailAddress in Text.Pandoc.Parsing.
  • Text.Pandoc.Readers.Metadata: Fix regression with comment-only YAML metadata blocks (#7400).
  • reveal.js writer and template: better handling of options. Previously it was impossible to specify false values for options that default to true (e.g. center); setting the option to false just caused the portion of the template setting the option to be omitted. Now we prepopulate all the variables with their default values, including them all unconditionally and allowing them to be overridden.
  • Markdown writer: Fix regression in code blocks with attributes (#7397). Code blocks with a single class but nonempty attributes were having attributes drop as a result of #7242.
  • Use lts-18.0 stack resolver.
  • Require skylighting 0.10.5.2 (adding support for Swift).
  • Require commonmark 0.2.1.
  • Rephrase section on unsafe HTML in manual.
  • Create SECURITY.md
  • LaTeX writer:
  • Add strut at end of minipage if it contains line breaks. Without them, the last line is not as tall as it should be in some cases.
  • Always use a minipage for cells with line breaks, when width information is available (#7393). Otherwise the way we treat them can lead to content that overflows a cell.
  • Use strut instead of ~ before \ in empty line.

New in Pandoc 2.14.0.2 (Jun 14, 2021)

  • Fix MediaBag regressions (#7345). iIn the 2.14 release --extract-media stopped working as before; there could be mismatches between the paths in the rendered document and the extracted media. This patch makes several changes that restore the earlier behavior (while keeping the same API). The mediaPath in 2.14 was always constructed from the SHA1 hash of the media contents. Now, we preserve the original path unless it’s an absolute path or contains .. segments (in that case we use a path based on the SHA1 hash of the contents).
  • In Text.Pandoc.MediaBag, mediaDirectory and mediaItems now use the mediaPath, rather than the mediabag key, for the first component of the tuple. This makes more sense, I think, and fits with the documentation of these functions; eventually, though, we should rework the API so that mediaItems returns both the keys and the MediaItems.
  • In Text.Pandoc.Class.IO, rewriting of source paths in extractMedia has been fixed.
  • In Text.Pandoc.Class.PandocMonad, fillMediaBag has been modified so that it doesn’t modify image paths (that was part of the problem in #7345).
  • We now do path normalization (e.g. separators on Windows) in writing the media.
  • Text.Pandoc.PDF:
  • Text.Pandoc.PDF: Fix regression in 2.14 for generation of PDFs with SVGs (#7344).
  • Only print relevant part of environment on --verbose. Since --verbose output might be put in an issue, we want to avoid spilling out secrets in environment variables.
  • Markdown reader: fix pipe table regression in 2.11.4 (#7343). Previously pipe tables with empty headers (that is, a header line with all empty cells) would be rendered as headerless tables. This broke in 2.11.4. The fix here is to produce an AST with an empty table head when a pipe table has all empty header cells.
  • LaTeX reader: don’t allow optional * on symbol control sequences (#7340). Generally we allow optional starred variants of LaTeX commands (since many allow them, and if we don’t accept these explicitly, ignoring the star usually gives acceptable results). But we don’t want to do this for (*) and similar cases.
  • Docx reader: handle absolute URIs in Relationship Target (#7374).
  • Docx writer: fix handling of empty table headers (Albert Krewinkel, #7369). A table header which does not contain any cells is now treated as an empty header.
  • LaTeX writer: Fix regression in table header position (#7347). In recent versions the table headers were no longer bottom-aligned (if more than one line). This patch fixes that by using minipages for table headers in non-simple tables.
  • CommonMark writer:
  • Do not use simple class for fenced-divs (Jan Tojnar, amends #7242.)
  • Do not throw away attributes when Ext_attributes is enabled. Ext_attributes covers at least the following: Ext_fenced_code_attributes, Ext_header_attributes, Ext_inline_code_attributes, Ext_link_attributes.
  • Markdown writer:
  • Allow pipe_tables to be disabled for commonmark formats (commonmark_x, gfm) (#7375).
  • Re-use functions from Text.Pandoc.Markdown.Inline (Jan Tojnar).
  • DocBook writer: Remove non-existent admonitions (Jan Tojnar). attention, error and hint are reStructuredText specific.
  • HTML writer: Don’t omit width attribute on div (#7342).
  • Text.Pandoc.MIME, extensionFromMimeType: add a few special cases. When we do a reverse lookup in the MIME table, we just get the last match, so when the same mime type is associated with several different extensions, we sometimes got weird results, e.g. .vs for text/plain. These special cases help us get the most standard extensions for mime types like text/plain.
  • Lua utils: fix handling of table headers in from_simple_table (Albert Krewinkel, #7369). Passing an empty list of header cells now results in an empty table header.
  • Text.Pandoc.Citeproc:
  • Avoid duplicate classes and attributes on references div.
  • Fix regression in citeproc processing (#7376). If inline references are used (in the metadata references field), we should still only include in the bibliography items that are actually cited (unless nocite is used).
  • Require citeproc 0.4.0.1. This fixes a bug which led to doubled “et al.” in some (rare) circumstances.
  • MANUAL.txt:
  • Mention GladTeX for EPUB export (Sebastian Humenda). This updates the manual and the web site about the GladTeX usage.
  • More details and a useful link for YAML syntax.
  • CONTRIBUTING.md: update modules overview (Albert Krewinkel).
  • using-the-pandoc-api.md: switch from String to Text (Albert Krewinkel).

New in Pandoc 2.11.2 (Nov 23, 2020)

  • Default to using ATX (##-style) headings for Markdown output (#6662, Aner Lucero). Previously we used Setext (underlined) headings by default for levels 1–2.
  • Add option --markdown-headings=atx|setext, and deprecate --atx-headers (#6662, Aner Lucero).
  • Support markdown-headings in defaults files.
  • Fix corner case in YAML metadata parsing (#6823). Previously YAML metadata would sometimes not get recognized if a field ended with a newline followed by spaces.
  • --self-contained: increase coverage (#6854). Previously we only self-contained attributes for certain tag names (img, embed, video, input, audio, source, track, section). Now we self-contain any occurrence of src, data-src, poster, or data-background-image, on any tag; and also href on link tags.
  • DocBook reader: drop period in formalpara title and put it in a div with class formalpara-title, so that people can reformat with filters (#6562).
  • Man reader: improve handling of .IP (#6858). We now better handle .IP when it is used with non-bullet, non-numbered lists, creating a definition list. We also skip blank lines like groff itself.
  • Bibtex reader: fall back on en-US if locale for LANG not found. This reproduces earlier pandoc-citeproc behavior (jgm/citeproc#26).
  • Only use filterIpynbOutput if input format is ipynb (#6841). Before this change content could go missing from divs with class output, even when non-ipynb was being converted.
  • When checking reader/writer name, check base name now that we permit extensions on formats other than markdown.
  • Text.Pandoc.PDF: Fix changePathSeparators for Windows (#6173). Previously a path beginning with a drive, like C:foobar, was translated to C:/foo/bar, which caused problems. With this fix, the backslashes are removed.
  • Text.Pandoc.Logging: Add constructor ATXHeadingInLHS constructor to LogMessage [API change].
  • Fix error that is given when people specify doc output (#6834, gison93).
  • LaTeX template: add a break after parbox in CSLRightInline. This should fix spacing problems between entries with numeric styles. Also fix number of params on CSLReferences.
  • reveal.js template: Put quotes around controlsLayout, controlsBackArrows, and display, since these require strings. Add showSlideNumber, hashOneBasedIndex, pause.
  • Use citeproc 0.2. This fixes a bug with title case around parentheses.
  • pandoc.cabal: remove ‘static’ flag. This isn’t really necessary and can be misleading (e.g. on macOS, where a fully static build isn’t possible). cabal’s new option --enable-executable-static does the same. On stack you can add something like this to the options for your executable in package.yaml: ld-options: -static -pthread
  • Remove obsolete bibutils flag setting in linux/make_artifacts.sh.
  • Markdown reader:
  • Fix detection of locators following in-text citations. Prevously, if we had @foo [p. 33; @bar], the p. 33 would be incorrectly parsed as a prefix of @bar rather than a suffix of @foo.
  • Improve period suppression algorithm for citations in notes in note citation styles (#6835).
  • Don’t increment stateNoteNumber for example list references. This helps with #6836 (a bug in which example list references disturb calculation of citation note number and affect when ibid is triggered).
  • LaTeX reader:
  • Move getNextNumber from Readers.LaTeX to Readers.LaTeX.Parsing.
  • Fix negative numbers in siunitx commands. A change in pandoc 2.11 broke negative numbers, e.g. SI{-33}{celcius} or num{-3}. This fixes the regression.
  • JATS writer:
  • Wrap all tables (Albert Krewinkel). All elements are put inside elements, as the former are not valid as immediate child elements of .
  • Move Table handling to separate module (Albert Krewinkel). Adds two new unexported modules: Text.Pandoc.Writers.JATS.Types, Text.Pandoc.Writers.JATS.Table.
  • Org writer:
  • Replace org #+KEYWORDS with #+keywords (TEC). As of ~2 years ago, lower case keywords became the standard (though they are handled case insensitive, as always).
  • Update org supported languages and identifiers according to the current list contained in https://orgmode.org/worg/org-contrib/babel/languages/index.html (TEC).
  • Manual:
  • Correct link-citation -> link-citations.
  • Add a sentence about pagetitle for HTML (#6843, Alex Toldaiev).

New in Pandoc 2.11.1.1 (Nov 9, 2020)

  • Citeproc: improve punctuation in in-text note citations (#6813). Previously in-text note citations inside a footnote would sometimes have the final period stripped, even if it was needed (e.g. on the end of ‘ibid’).
  • Use citeproc 0.1.1.1. This improves the decision about when to use ibid in cases where citations are used inside a footnote (#6813).
  • Support nocase spans for csljson output.
  • Require latest commonmark, commonmark-extensions. This fixes a bug with autolink_bare_uris and commonmark.
  • LaTeX reader: better handling of \ inside math in table cells (#6811).
  • DokuWiki writer: translate language names for code elements and improve whitespace (#6807).
  • MediaWiki writer: use syntaxhighlight tag instead of deprecated source for highlighted code (#6810). Also support startFrom attribute and numberLines.
  • Lint code in PRs and when committing to master (#6790, Albert Krewinkel).
  • doc/filters.md: describe technical details of filter invocations (#6815, Albert Krewinkel).

New in Pandoc 2.11.1 (Nov 4, 2020)

  • DocBook Reader: fix duplicate bibliography bug (#6773, Nils Carlson).
  • HTML reader: Parse contents of iframes (#6770).
  • Parse inline svg as image unless raw_html is set in the reader (in which case the svg is passed through as raw HTML) (#6770).
  • LaTeX reader: Fix bug parsing macro arguments (#6796). If cL is defined as mathcal{L}, and til as tilde{#1}, then tilcL should expand to tilde{mathcal{L}}, but pandoc was expanding it to tildemathcal{L}. This is fixed by parsing the arguments in “verbatim mode” when the macro expands arguments at the point of use.
  • Properly support optional (cite) argument for blockquote from csquotes (#6802).
  • LaTeX writer: Improved calculation of table column widths. We now have LaTeX do the calculation, using tabcolsep. So we should now have accurate relative column widths no matter what the text width. The default template has been modified to load the calc package if tables are used.
  • HTML writer: Fix duplicate “class” attribute for table rows (Andy Morris).
  • Text.Pandoc.Filter: allow shorter YAML representation of Citeproc (Albert Krewinkel). The map-based YAML representation of filters expects type and path fields. The path field had to be present for all filter types, but is not used for citeproc filters. The field can now be omitted when type is “citeproc”, as described in the MANUAL.
  • Text.Pandoc.Error: Add PandocBibliographyError constructor for PandocError [API change]. This ensures that bibliography parsing errors generate messages that include the bibliography file name – otherwise it can be quite mysterious where it is coming from.
  • Citeproc: properly handle csl field with data: URI (#6783). This is used with the JATS writer, so this fixes a regression in pandoc 2.11 with JATS output and citeproc.
  • Allow citation-abbreviations in defaults file.
  • JATS templates: ensure jats_publishing output is valid (Albert Krewinkel).
  • LaTeX template: Fix CSLRightInline, so that it does not run over the right margin.
  • HTML template: default CSS tweaks (Mauro Bieg and John MacFarlane).
  • Fix margin before codeblock
  • Add monobackgroundcolor variable, making the background color and padding of code optional.
  • Ensure that backgrounds from highlighting styles take precedence over monobackgroundcolor
  • Remove list markers from TOC
  • Add margin-bottom where needed
  • Remove italics from blockquote styling
  • Change borders and spacing in tables to be more consistent with other output formats
  • Style h5, h6
  • Set font-size for print media to 12pt.
  • Reduce interline space.
  • Reduce interparagraph space.
  • Reduce line width.
  • Remove the special line-height: 1 for table cells.
  • Remove the special line-height for pre.
  • Ensure that there is a bit more space before a heading than after.
  • Slightly reduced space after title header.
  • Add CSS example to MANUAL
  • man template: Change comment that triggers tbl from ."t to '" t, as specified in groff_man(7) (#6803).
  • Use latest commonmark, commonmark-extensions. This fixes a bug with nested blocks in footnotes with the footnote extension to commonmark. See jgm/commonmark-hs#63.
  • Citeproc: use comma for in-text citations inside footnotes. When an author-in-text citation like @foo occurs in a footnote, we now render it with: AUTHOR NAME + COMMA + SPACE + REST. Previously we rendered: AUTHOR NAME + SPACE + "(" + REST + ")". This gives better results. Note that normal citations are still rendered in parentheses.
  • Use latest citeproc
  • citeproc no longer capitalizes notes, so we do it in pandoc when appropriate.
  • Closes #6783.
  • Clarify manual on --track-changes (#6801).
  • Add doc/jats.md to document pandoc’s handling of JATS (#6794, Albert Krewinkel).
  • Fix code example in lua-filters.md (#6795).

New in Pandoc 2.11.0.4 (Oct 25, 2020)

  • Use latest citeproc (2.11.0.3, closes #6765). This fixes a problem with author-in-text citations for references including both an author and an editor. Previously, both were included in the text, but only the author should be.
  • With --citeproc, ensure that the final period is removed when citations that occur in notes in note-based styles get put in parentheses. See jgm/citeproc#20.
  • Commonmark writer: fix regression with fenced divs (#6768). Starting with 2.10.1, fenced divs no longer render with HTML div tags in commonmark output. This is a regression due to our transition from cmark-gfm. This commit fixes it.
  • Normalize rewritten image paths with --extract-media (#6761). This change will avoid mixed paths like this one when --extract-media is used with a Word file: ![](C:GitTIJ4Markdown/media/image30.wmf). Instead we’ll get ![](C:GitTIJ4Markdownmediaimage30.wmf).
  • Modify --version output. Use space more efficiently and report the citeproc and ipynb versions, along with skylighting, texmath, and pandoc-types. Drop the word “default” before “user data directory.”
  • DocBook reader: bibliomisc and anchor support (#6754, Nils Carlson). Also ensure that bibliodiv without a title no longer results in an empty Header.
  • ConTeXt template: adds setupinterlinespace to fonts larger than normal (#6763, Denis Maier).
  • LaTeX template: Do not load amssymb if not needed (#6469, Angelo Peronio). See https://tex.stackexchange.com/a/549938.
  • Relax upper bound on hslua, allow hslua-1.3.* (Albert Krewinkel).
  • Use latest sylighting, with support for groovy.
  • MANUAL:
  • Improve explanation of “indent” variable (#6767, Cyrus Yip).
  • Remove org from list of input formats supporting raw_tex (#6753, Nick Fleisher).
  • Document that –html-q-tags requires the smart extension on the reader (#6766).

New in Pandoc 2.11.0.2 (Oct 18, 2020)

  • Fix handling of xdata in bibtex/biblatex bibliographies (#6752).
  • Fix some small typos in the API documentation (#6751, Michael Hoffmann).
  • Require citeproc 0.1.0.2. This fixes a regression from pandoc-citeproc involving spacing between components of a reference in certain styles (e.g. cell.csl).
  • Fix typos in comments, doc strings, error messages, and tests (Albert Krewinkel, #6738).

New in Pandoc 2.11.0.1 (Oct 15, 2020)

  • LaTeX reader: support more acronym commands (#6746): acl, aclp, and capitalized versions of already supported commands.
  • Commonmark reader: add pipe_table extension after defaults (#6739). Otherwise we get bad results for non-table, non-paragraph lines containing pipe characters.
  • Markdown writer: Fix autolinks rendering for gfm (#6740). Previously, autolinks rendered as raw HTML, due to the class="uri" added by pandoc’s markdown reader.
  • default.latex: fix CSLReference macro definition.
  • Fix MANUAL.txt CSL JSON conversion examples.
  • Fix spelling errors in chengelog, MANUAL.txt, doc/org.md (#6738).
  • LaTeX writer:
  • Escape option values in lstlistings environment (#6742).
  • Fix handling of lang pt-BR (#2953). For polyglossia we now use setmainlanguage[variant=brazilian]{portuguese} and for babel usepackage[shorthands=off,main=brazilian]{babel}.
  • Depend on latest citeproc (0.1.0.1):
  • This fixes the citation number issue with ieee.csl and other styles that do not explicitly sort bibliographies (#6741). (Pandoc was numbering them by their order in the bibliography file, rather than the order cited, as required by the CSL spec.)
  • Fixes groupin/collapsing with citation items with prefixes.

New in Pandoc 2.11 (Oct 12, 2020)

  • Add --citeproc (-C) option to trigger built-in citation processing. It is no longer necessary to use the external pandoc-citeproc filter. --citeproc behaves like a filter and can be positioned relative to other filters as they appear on the command line.
  • The new built-in citation processing uses the citeproc library, a reimplementation of CSL citation processing that fixes many of the shortcomings of pandoc-citeproc. In general, citation processing should work much the same as it did with pandoc-citeproc, but with greater fidelity to CSL styles and better performance. (The tests from the pandoc-citeproc package have been carried over to pandoc.) The following differences should be noted:
  • At this point, only some of the writers (HTML, ms, LaTeX) properly interpret CSL display styles. You should get decent output in all formats (at least as good as with pandoc-citeproc), but indentation and block-alignment may not be right.
  • pandoc-citeproc searches the ~/.csl directory for .csl styles. Pandoc instead searches the csl subdirectory of the pandoc user data directory (e.g., ~/.pandoc/csl or ~/.local/share/pandoc/csl). Users who already keep CSL styles in ~/.csl may find it convenient to add a symlink.
  • Some of the bibliography formats supported by pandoc-citeproc (via hs-bibutils) are no longer supported: Copac, EndNote, ISI, MEDLINE, MODS, and RIS. If you use one of these formats, you may use the bibutils utility to convert to BibLaTeX. We now support only BibTeX, BibLaTeX, CSL JSON, and pandoc’s YAML/Markdown analogue of CSL JSON.
  • pandoc-citeproc would always retrieve the independent parent of a dependent style by doing an HTTP request. pandoc will now first seek the independent parent locally (in the resource path or in the csl subdirectory of the pandoc user data directory) before resorting to HTTP. In addition, you may omit the .csl extension, e.g. --csl zoology.
  • Using the --bibliography option (or including bibliography in YAML metadata) no longer triggers citation processing implicitly: one must always use the --citeproc option if citation processing is wanted.
  • Add csljson as and input and output format. This allows pandoc to convert between csljson and other bibliography formats (e.g. -f csljson -t markdown -s or -f bibtex -t csljson), and to generate formatted versions of CSL JSON bibliographies (e.g., pandoc -f csljson --citeproc pl.json -o pl.pdf).
  • Added bibtex, biblatex as input formats. This allows pandoc to convert between BibLaTeX and BibTeX and other bibliography formats, and to generated formatted versions of BibTeX/BibLaTeX bibliographies (e.g., pandoc -f biblatex --citeproc pl.bib -o pl.pdf).
  • Raise informative errors when YAML metadata parsing fails (#6730). Previously the command would succeed, returning empty metadata, with no errors or warnings.
  • Sort languages in --list-highlight-languages output (#6718, Albert Krewinkel). Languages were previously sorted by their long name, which leads to unexpected results).
  • Add CSS to default HTML template (#6601, Mauro Bieg). This greatly improves the default typography in pandoc’s HTML output. The CSS is sensitive to a number of variables (e.g. mainfont, fontsize, linestretch): see the manual for details. To restore the earlier, more spartan output, you can disable this with -M document-css=false.
  • Support --toc-depth option for ODT writer (#6696, niszet).
  • Fix issues with Windows UNC paths with some options (#5127).
  • Remove fenced_code_blocks and backtick_code_blocks from allowed commonmark and gfm extensions. These shouldn’t really be counted as extensions, because they can’t be disabled in commonmark. Adjust markdown writer to check for the commonmark variant in addition to extensions.
  • Add these extensions to gfm and commonmark: fenced_code_blocks, backtick_code_blocks, fenced_code_attributes. These can’t really be disabled in the reader, but they need to be enabled in the writer or we just get indented code.
  • Make sure proper set of extensions is recognized for commonmark_x.
  • Allow gfm_auto_identifiers, ascii_identifiers extensions for docx.
  • Markdown reader:
  • Add Maybe FilePath parameter to yamlToMeta [API change].
  • Export yamlToRefs [API change], a version of yamlToMeta specialized to references.
  • Set citationNoteNum accurately in citations.
  • Revise abbreviation support. Don’t insert a nonbreaking space after a potential abbreviation if it comes right before a note or citation. This causes problems for citeproc’s moving of note citations.
  • LaTeX reader:
  • Support missing siunitx commands (#6658).
  • Support squared, cubed, tothe in siunitx (#6657).
  • Improved uncertainty handling in slunitx.
  • Factored out siunitx stuff into separate unexposed module.
  • Fix improper empty cell filtering (#6689, Christian Despres).
  • Fix parsing of “show name” in newtheorem (#6734). Previously we were just treating it as a string and ignoring accents and formatting.
  • Prevent wrong nesting of multirow and multicolumn table cells (#6603, Laurent P. René de Cotret).
  • Table cell parser not consuming spaces correctly (#6596, Laurent P. René de Cotret).
  • Change SIRange to SIrange (#6617, Emerson Harkin).
  • Allow blank lines inside author (#6324).
  • DocBook reader:
  • Don’t squelch space at end of emphasis and other inline elements; instead, move it outside the element (#6719).
  • Implement table cell alignment (#6698, Nils Carlson).
  • Implement column span support for tables (#6492, Nils Carlson).
  • Update list of block level tags (#6610).
  • JATS reader:
  • Don’t squelch space at end of emphasis and other inline elements; instead, move it outside the element (#6719).
  • RST reader:
  • Apply .. class:: directly to following Header rather than creating a surrounding Div (#6699).
  • Docx reader:
  • Allow empty dates in comments and tracked changes (#6726, Diego Balseiro).
  • Markdown writer:
  • Be less aggressive about using quotes for YAML values, allowing e.g. a quotation mark or bracket as long as it’s not at the beginning of the line.
  • Use double quotes for YAML metadata (#6727).
  • Sort YAML metadata keys in Markdown output case-insensitive.
  • Asciidoc writer:
  • Support asciidoctor’s block figures (#6538, argent0).
  • LaTeX writer:
  • Fix spacing issue with list in definition list. When a list occurs at the beginning of a definition list definition, it can start on the same line as the label, which looks bad. Fix that by starting such lists with an item[].
  • HTML writer:
  • Support intermediate table headers (#5314, Albert Krewinkel).
  • Support attributes on all table elements (Albert Krewinkel).
  • Render table footers if present (#6314, Albert Krewinkel).
  • Fix addition of doc-biblioentry role.
  • Support colspans and rowspans in HTML tables (#6312, Albert Krewinkel).
  • ICML writer:
  • Support internal document links (#5541, Leonard Rosenthol).
  • Changed default link state to invisible (#6676, Leonard Rosenthol).
  • Docx writer:
  • Better handle list items whose contents are lists (#5948, Michael Hoffmann). If the first element of a bulleted or ordered list is another list, then that first item would previously disappear if the target format is docx.
  • Separate adjacent tables (#4315). Word combines adjacent tables, so to prevent this we insert an empty paragraph between two adjacent tables.
  • Org writer:
  • Don’t force blank line after headings (#6554).
  • OpenDocument writer:
  • Implement table cell alignment (#6700 Nils Carson, Mauro Bieg).
  • New table cell support with row and column spans (#6682, Nils Carson).
  • Syntax highlighting for inline code (#6711, niszet).
  • Add Text.Pandoc.Citeproc module, exporting processCitations [API change]. This depends on several other, unexported modules under Text.Pandoc.Citeproc.
  • Add module Text.Pandoc.Writers.CslJson, exporting writeCslJson. [API change]
  • Add module Text.Pandoc.Readers.CslJson, exporting readCslJson. [API change]
  • Add module Text.Pandoc.Readers.BibTeX, exporting readBibTeX and readBibLaTeX. [API change]
  • Text.Pandoc.Filter: Add CiteprocFilter constructor to Filter. [API change] This runs the processCitations transformation. We need to treat it like a filter so it can be placed in the sequence of filter runs (after some, before others). In FromYAML, this is parsed from citeproc or {type: citeproc}, so this special filter may be specified either way in a defaults file (or by citeproc: true, though this gives no control of positioning relative to other filters).
  • Add new exported module Text.Pandoc.Writers.AnnotatedTable [API change] (#6655, Christian Despres). This module (which should generally be imported qualified to avoid name conflicts) provides a Table type that mirrors the structure of a pandoc Table, but with added inferred information so that the writers do not have to lay out tables themselves. The toTable and fromTable functions convert between an annotated Table and a regular pandoc Table. In addition to producing a Table with coherent and well-formed annotations, the toTable function also normalizes its input table like the table builder does. Tests ensure that toTable normalizes tables exactly like the table builder, and that its annotations are coherent.
  • Text.Pandoc.Logging:
  • Remove unused CouldNotParseYamlMetadata constructor for LogMessage [API change].
  • Add CiteprocWarning constructor to LogMessage [API change].
  • Text.Pandoc.Readers.Metadata: export yamlBsToRefs [API change]. These allow specifying an id filter so we parse only references that are used in the document.
  • Text.Pandoc.Parsing:
  • Export ParseError [API change].
  • Add stateInNote and stateNoteNumber to ParserState [API change]. These are used to populate note numbers for citation processing.
  • Fix apparent typos in sample.lua (#6729, William Lupton). Also make the writer less aggressive in escaping quotes.
  • Text.Pandoc.Options:
  • defaultMathJaxURL: use tex-chtml-full instead of tex-mml-chtml (#6599, Kolen Cheung). This drops the MathML support (which we don’t need for HTML math rendering) and includes the full JavaScript, which makes it possible to use --self-contained (though there may still be issues if the required math fonts aren’t available). This change should also reduce latency in pages with lots of formulas.
  • Add /tex-chtml-full.js to defaultMathJaxURL (#6593) Previously we added this in processing command line options, but not in processing defaults files, which was inconsistent.
  • epub.css: Fix cover page selectors and add note explaining their use (#6649, a-vrma).
  • Add data files needed for Text.Pandoc.Citeproc: these include default.csl in the data directory and a citeproc directory that is only used at compile-time for biblatex localizations. Note that we’ve added file-embed as a mandatory rather than a conditional depedency, because of the biblatex localization files.
  • Lua filters:
  • Add SimpleTable for backwards compatibility (#6575, Albert Krewinkel). A new type SimpleTable is made available to Lua filters. It is similar to the Table type in pandoc versions before 2.10; conversion functions from and to the new Table type are provided.
  • Make attr argument optional in Table constructor (Albert Krewinkel). This changes the Lua API. It is highly unlikely for this change to affect existing filters, since the documentation for the new Table constructor (and type) was incomplete and partly wrong before. The Lua API is now more consistent, as all constructors for elements with attributes now take attributes as the last parameter.
  • MANUAL.txt:
  • Add a dedicated Citations section which consolidates the information the manual used to contain about citation processing, and incorporates some information formerly found in the pandoc-citeproc man page.
  • Add note about lualatex using selnolig.
  • Remove duplicate seriespage (#6568, Blake Eryx).
  • Remove lists of support extensions for markdown variants (#6604). Instead, offer the advice to use --list-extensions=FORMAT.
  • Fix position of attributes in header (Albert Krewinkel).
  • Delete obsolete section on compact and loose lists (#6684).
  • doc/lua-filters.md:
  • Add info on how to debug Lua filters (#6732, Ian Max Andolina).
  • Document Underline type and constructor (Albert Krewinkel).
  • Document body field (Albert Krewinkel).
  • Add missing header attribute
  • Add missing Link.title field (Albert Krewinkel).
  • Make the setting-the-date example conditional (the-solipsist). This makes the example a bit more realistic.
  • Remove outdated link table example.
  • doc/org.md:
  • Add section on tables (Albert Krewinkel).
  • Add section on handling of unknown directives (Albert Krewinkel).
  • CONTRIBUTING.md: fix typo (#6584, Dmitry Volodin).
  • Use golden test framework for command tests. This means that --accept can be used to update expected output.
  • Use the smart extension when generating pandoc’s man page (#6613).
  • Release-candidate: don’t build windows i386. So far we haven’t been able to figure out how to get stack to use a 32-bit ghc.
  • Use null instead of deprecated Builder.isNull.
  • Makefile:
  • Fix macospkg target to fetch target from S3 artifacts.
  • Fix pandoc-templates target to include all partials.
  • Remove duplicated dependency in pandoc.cabal (#6591, Felix Yan).
  • Sort build depends in pandoc.cabal alphabetically (#6691, Albert Krewinkel).
  • Add .travis.yml for macos release candidate build (#6622). We need to build the release candidate on Travis rather than GitHub actions, because GH has macos 10.15, and binaries compiled on that OS will not work with 10.13. This build is only triggered on rc/* branches.
  • Remove instructions for building pandoc-citeproc from CI and release binary build instructions. We will no longer distribute pandoc-citeproc.
  • Fix math rendering in trypandoc (this broke after commit d8ad766).
  • Use latest versions of skylighting, commonmark (#6589), comonmark-extensions, commonmark-pandoc, texmath.
  • Relax version bounds for hslua, hslua-module-text, bytestring.
  • Use released pandoc-types 1.22. This changes the JSON encoding slightly for the new table types introduced in 1.21, so they’re more consistent with the rest. Developers of libraries for pandoc filters will want to take note.
  • Fix hlint suggestions, update hlint.yaml (#6680, Christian Despres).
  • Code cleanup (#6678, Joseph C. Sible).
  • Add haddocks to functions in Text.Pandoc.Writers.Shared (Albert Krewinkel).
  • Remove duplicate tshow definition.
  • Linux release candidate build: use ghc-musl container. This simplifies our build process (over using a customized alpine container).

New in Pandoc 2.10.1 (Jul 24, 2020)

  • Add commonmark_x output format. This is commonmark with a number of useful pandoc extensions enabled.
  • Many more extensions now work with commonmark and gfm.
  • Add generic attributes extension. This allows attributes to be added to any block or inline element in a uniform way. Since the Pandoc AST doesn’t include attributes on each element type, the attributes will sometimes be added by creating a surrounding Div or Span container. Currently this extension is only compatible with the commonmark and gfm readers.
  • Support --number-sections for docx output (#1413).
  • LaTeX reader:
  • Support SIRange reader (#6418, Emerson Harkin).
  • Support table col-span and row-span (#6311, Laurent P. René de Cotret). Supports multirow and multicolumn.
  • Support amsthm: newtheorem, theoremstyle, and theorem and proof environments, including labels and references. The only thing that is unsupported is the second optional argument, which causes numbering to be reset after the specified series is incremented.
  • Moved some code to T.P.LaTeX.Parsing. We need to reduce the size of the LaTeX reader to ease compilation on resource-limited systems.
  • RST reader:
  • Fix csv tables with multiline cells (#6549).
  • Fix spurious newlines in some attributes from directives.
  • Avoid extra newline in included code blocks.
  • Commonmark reader:
  • Switch from cmark-gfm to commonmark-hs for commonmark and gfm parsing. This avoids depending on a C library and allows us to support more pandoc extensions for commonmark and gfm.
  • DocBook reader:
  • Parse releaseinfo as metadata (#6542).
  • Docx reader:
  • Only use bCs/iCs on runs with rtl or cs property (#6514, Nikolay Yakimov).
  • Code cleanup/refactoring (Nikolay Yakimov).
  • Org reader (Albert Krewinkel):
  • Respect export setting which disables entities MathML-like entities, e.g., alpha, can be disabled with the #+OPTION: e:nil export setting (Albert Krewinkel).
  • Respect export setting disabling footnotes. Footnotes can be removed from the final document with the #+OPTION: f:nil export setting.
  • Respect tables-excluding export setting. Tables can be removed from the final document with the #+OPTION: |:nil export setting.
  • Markdown writer:
  • Move asciify out of escapeString. Otherwise unsmartify doesn’t catch quotes that have already been turned to entities.
  • Add writeCommonmark (new exported function, API change).
  • Use unicode super/subscript characters when possible if the superscript or subscript extension or raw_html aren’t available.
  • Render caption as following paragraph when table_caption extension is not enabled.
  • Use numerical labels for reference links that are longer than 999 characters or contain square brackets, for conformity with commonmark (#6560).
  • Commonmark writer:
  • Instead of using cmark-gfm, use writeCommonmark from the Markdown writer. This function calls the markdown writer with appropriate extensions and a few small modifications (e.g. not requiring backslashes before spaces inside super/subscripts). With this change comonmark and gfm output can be used with a wider selection of extensions.
  • Jira writer:
  • keep image caption as alt attribute (#6529, Albert Krewinkel).
  • HTML writer:
  • Improve alt-text/caption handling for HTML5 (#6491, Albert Krewinkel). Screen readers read an image’s alt attribute and the figure caption, both of which come from the same source in pandoc. The figure caption is hidden from screen readers with the aria-hidden attribute. This improves accessibility. For HTML4, where aria-hidden is not allowed, pandoc still uses an empty alt attribute to avoid duplicate contents.
  • Ms writer:
  • Fix code highlighting with blank lines. Previously blank lines were simply omitted from highligted code.
  • Escape starting periods in ms writer code blocks (#6505, Michael Hoffmann). If a line of ms code block output starts with a period (.), it should be prepended by & so that it is not interpreted as a roff command.
  • Text.Pandoc.Extensions:
  • Add raw_markdown extension (which only affects ipynb input).
  • Trim down githubMarkdownExtensions. Previously it included all of the following, which make sense for the legacy markdown_github but not for gfm, since they are part of base commonmark and thus can’t be turned off in gfm
  • Ext_all_symbols_escapable
  • Ext_backtick_code_blocks
  • Ext_fenced_code_blocks
  • Ext_space_in_atx_header
  • Ext_intraword_underscores
  • Ext_lists_without_preceding_blankline
  • Ext_shortcut_reference_links
  • These have been removed from githubMarkdownExtensions, though they’re still turned on for legacy markdown_github.
  • Add Ext_attributes constructor for Extension [API change].
  • LaTeX template: use selnolig to selectively suppress ligatures with lualatex (#6534).
  • Benchmark bytestring readers (Nikolay Yakimov).
  • Documentation:
  • Update using-the-pandoc-api.md (favonia).
  • Fix Typos in lua-filters.md (tajmone).
  • Rewrite Raw HTML/TeX section in MANUAL.txt to avoid duplicate headings for the extensions.
  • Fix typo in MANUAL.txt (Benjamin Wuethrich).
  • Remove duplicate ‘titlepage’ in MANUAL.txt (Blake Eryx).
  • CONTRIBUTING.md: Advertise the official nightlies in GitHub actions. Replaces #6500, thanks to @ickc.

New in Pandoc 2.2.2.1 (Jul 20, 2018)

  • Fix regression finding templates in user data directory (#4777). Under version 2.2.1 and prior pandoc found latex templates in the templates directory under the data directory, but this broke in 2.2.2.
  • Fix for bug in parsing input in rawLaTeXBlock and rawLaTeXInline (#4781). (This primarily affects the markdown reader, and other readers that accept raw tex.) Starting in 2.2.2, everything after an input (or include) in a markdown file would be parsed as raw LaTeX.
  • Add missing rollingLinks option to revealjs template (#4778, Igor Khorlo).
  • MANUAL:
  • Clarify gfm vs markdown_github (#4783, Mauro Bieg).
  • Use keywords instead of tags in YAML metadata example (#4779). Unlike tags, keywords is used in some of the writers and default templates.

New in Pandoc 2.1 (Jan 8, 2018)

  • Allow filters and lua filters to be interspersed (#4196). Previously we ran all lua filters before JSON filters. Now we run filters in the order they are presented on the command line, whether lua or JSON. There are two incompatible API changes: The type of applyFilters has changed, and applyLuaFilters has been removed. Filter is also now exported.
  • Use latest skylighting and omit the missingIncludes check, fixing a major performance regression in earlier releases of the 2.x series (#4226). Behavior change: If you use a custom syntax definition that refers to a syntax you haven’t loaded, pandoc will now complain when it is highlighting the text, rather than doing a check at the start. This change dramatically speeds up invocations of pandoc on short inputs.
  • Text.Pandoc.Class: make FileTree opaque (don’t export FileTree constructor). This forces users to interact with it using insertInFileTree and getFileInfo, which normalize file names.
  • LaTeX reader: Simplified a check for raw tex command.
  • Muse writer (Alexander Krotov): don’t escape URIs from AST
  • OpenDocument/ODT writers: improved rendering of formulas (#4170, oltolm).
  • MANUAL.txt simplify and add more structure (Mauro Bieg).
  • Generate README.md from template and MANUAL.txt. make README.md will generate the README.md after changes to MANUAL.txt have been made.
  • Update copyright notices to include 2018 (Albert Krewinkel).
  • Markdown reader:
  • Rewrite inlinesInBalancedBrackets. The rewrite is much more direct, avoiding parseFromString. And it performs significantly better; unfortunately, parsing time still increases exponentially (see #1735).
  • Avoid parsing raw tex unless + letter seen. This seems to help with the performance problem, #4216.
  • Muse reader (Alexander Krotov):
  • Enable round trip test (#4107).
  • Automatically translate #cover into #cover-image. Amusewiki uses #cover directive to specify cover image.
  • Docx reader (Jesse Rosenthal):
  • Allow for insertion/deletion of paragraphs (#3927). If the paragraph has a deleted or inserted paragraph break (depending on the track-changes setting) we hold onto it until the next paragraph. This takes care of accept and reject. For this we introduce a new state which holds the ils from the previous para if necessary. For --track-changes=all, we add an empty span with class paragraph-insertion/paragraph-deletion at the end of the paragraph prior to the break to be inserted or deleted.
  • Remove unused anchors (#3679). Docx produces a lot of anchors with nothing pointing to them—we now remove these to produce cleaner output. Note that this has to occur at the end of the process because it has to follow link/anchor rewriting.
  • Read multiple children of w:sdtContents.
  • Combine adjacent anchors. There isn’t any reason to have numerous anchors in the same place, since we can’t maintain docx’s non-nesting overlapping. So we reduce to a single anchor.
  • Improved tests.
  • Docx writer:
  • Removed redundant subtitle in title (Sebastian Talmon).
  • firstRow table definition compatibility for Word 2016 (Sebastian Talmon). Word 2016 seems to use a default value of “1” for table headers, if there is no firstRow definition (although a default value of 0 is documented), so all tables get the first Row formatted as header. Setting the parameter to 0 if the table has no header row fixes this for Word 2016
  • Fix custom styles with spaces in the name (#3290).
  • Powerpoint writer (Jesse Rosenthal):
  • Ignore Notes div for parity with other slide outputs.
  • Set default slidelevel correctly. We had previously defaulted to slideLevel 2. Now we use the correct behavior of defaulting to the highest level header followed by content. We change an expected test result to match this behavior.
  • Split blocks correctly for linked images.
  • Combine adjacent runs.
  • Make inline code inherit code size. Previously (a) the code size wasn’t set when we force size, and (b) the properties was set from the default, instead of inheriting.
  • Simplify replaceNamedChildren function.
  • Allow linked images. The following markdown: [![Image Title](image.jpg)](http://www.example.com) will now produce a linked image in the resulting PowerPoint file.
  • Fix error with empty table cell. We require an empty tag, even if the cell contains no paragraphs—otherwise PowerPoint complains of corruption.
  • Implement two-column slides. This uses the columns/column div format described in the pandoc manual. At the moment, only two columns (half the screen each) are allowed. Custom widths are not supported.
  • Added more tests.
  • Lua filters (Albert Krewinkel):
  • data/pandoc.lua: drop ‘pandoc-api-version’ from Pandoc objects
  • The current pandoc-types version is made available to Lua programs in the global PANDOC_API_VERSION. It contains the version as a list of numbers.
  • The pandoc version available as a global PANDOC_VERSION (a list of numbers).
  • data/pandoc.lua: make Attr an AstElement.
  • data/pandoc.lua: make all types subtypes of AstElement. Pandoc, Meta, and Citation were just plain functions and did not set a metatable on the returned value, which made it difficult to amend objects of these types with new behavior. They are now subtypes of AstElement, meaning that all their objects can gain new features when a method is added to the behavior object (e.g., pandoc.Pandoc.behavior).
  • data/pandoc.lua: split type and behavior tables. Clearly distinguish between a type and the behavioral properties of an instance of that type. The behavior of a type (and all its subtypes) can now be amended by adding methods to that types behavior object, without exposing the type objects internals. E.g.:
  • pandoc.Inline.behavior.frob = function () print'42' end
  • local str = pandoc.Str'hello'
  • str.frob() -- outputs '42'
  • data/pandoc.lua: fix Element inheritance. Extending all elements of a given type (e.g., all inline elements) was difficult, as the table used to lookup unknown methods would be reset every time a new element of that type was created, preventing recursive property lookup. This is was changed in that all methods and attributes of supertypes are now available to their subtypes.
  • data/pandoc.lua: fix attribute names of Citation (#4222). The fields were named like the Haskell fields, not like the documented, shorter version. The names are changed to match the documentation and Citations are given a shared metatable to enable simple extensibility.
  • data/pandoc.lua: drop function pandoc.global_filter.
  • Bump hslua version to 0.9.5. This version fixes a bug that made it difficult to handle failures while getting lists or a Map from Lua. A bug in pandoc, which made it necessary to always pass a tag when using MetaList or MetaBlock, is fixed as a result. Using the pandoc module’s constructor functions for these values is now optional (if still recommended).
  • Stop exporting pushPandocModule (API change). The introduction of runPandocLua renders direct use of this function obsolete.
  • Update generation of module docs for lua filters.
  • Lua.Module.Utils: make stringify work on MetaValues (John MacFarlane). I’m sure this was intended in the first place, but currently only Meta is supported.
  • Improve benchmarks:
  • Set the default extensions properly.
  • Improve benchmark argument parsing. You can now say make bench BENCHARGS="markdown latex reader" and both the markdown and latex readers will be benchmarked.

New in Pandoc 1.19.2.1 (Feb 9, 2017)

  • Require skylighting >= 0.1.1.4.
  • Adjust test output for skylighting version.
  • Relax upper bounds on blaze-html and blaze-markup.

New in Pandoc 1.19.1 (Jan 25, 2017)

  • Set PANDOC_VERSION environment variable for filters (#2640). This allows filters to check the pandoc version that produced the JSON they are receiving.
  • Docx reader: Ensure one-row tables don't have header (#3285, Jesse Rosenthal). Tables in MS Word are set by default to have special first-row formatting, which pandoc uses to determine whether or not they have a header. This means that one-row tables will, by default, have only a header -- which we imagine is not what people want. This change ensures that a one-row table is not understood to be a header only. Note that this means that it is impossible to produce a header-only table from docx, even though it is legal pandoc. But we believe that in nearly all cases, it will be an accidental (and unwelcome) result
  • HTML reader:
  • Fixed some bad regressions in HTML table parser (#3280). This regression leads to the introduction of empty rows in some circumstances.
  • Understand style=width: as well as width in col (#3286).
  • RST reader:
  • Print warnings when keys, substitition, notes not found. Previously the parsers failed and we got raw text. Now we get a link with an empty URL, or empty inlines in the case of a note or substitution.
  • Fix hyperlink aliases (#3283).
  • Man writer: Ensure that periods are escaped at beginning of line (#3270).
  • LaTeX writer: Fix unnumbered headers when used with --top-level (#3272, Albert Krewinkel). Fix interaction of top-level divisions part or chapter with unnumbered headers when emitting LaTeX. Headers are ensured to be written using stared commands (like subsection*{}).
  • LaTeX template: use comma not semicolon to separate keywords for pdfkeywords. Thanks to Wandmalfarbe.
  • Markdown writer: Fixed incorrect word wrapping (#3277). Previously pandoc would sometimes wrap lines too early due to this bug.
  • Text.Pandoc.Pretty: Added afterBreak [API change]. This makes it possible to insert escape codes for content that needs escaping at the beginning of a line.
  • Removed old MathMLInHTML.js from 2004, which should no longer be needed for MathML with modern browsers.
  • Fixed tests with dynamic linking (#2709).
  • Makefile: Use stack instead of cabal for targets. This is just a convenience for developers.
  • Fixed bash completion of filenames with space (#2749).
  • MANUAL: improved documentation on how to create a custom reference.docx.
  • Fix minor spelling typos in the manual (#3273, Anthony Geoghegan)

New in Pandoc 1.17.02 (Mar 25, 2016)

  • Fixed serious regression in htmlInBalanced, which caused newlines to be omitted in some raw HTML blocks in Markdown (#2804).

New in Pandoc 1.17 (Mar 21, 2016)

  • Added --file-scope option (Jesse Rosenthal). By default pandoc operates on multiple files by first concatenating them (around extra line breaks) and then processing the joined file. So it only parses a multi-file document at the document scope. This has the benefit that footnotes and links can be in different files, but for some purposes it is useful to parse the individual files first and then combine their outputs (e.g. when the files use footnotes or links with the same labels). The --file-scope option causes pandoc to parse the files first, and then combine the parsed output, instead of combining before parsing. --file-scope is selected automatically for binary input files (which cannot be concatenated) and for pandoc json.
  • Add TEI Writer (Chris Forster) and tei output format.
  • Added a general ByteStringReader with warnings, used by the docx reader (API change, Jesse Rosenthal).
  • Add readDocxWithWarnings (API change, Jesse Rosenthal).
  • Changed type of Shared.uniqueIdent's argument from [String] to Set String. This avoids performance problems in documents with many identically named headers (API change, #2671).
  • Removed tex_math_single_backslash from markdown_github options (#2707).
  • Make language extensions as well as full language names trigger syntax highlighting. For example, py will now work as well as python (jgm/highlighting-kate#83).
  • Added institute variable to latex, beamer templates (Fraser Tweedale, Josef Svenningsson).
  • Textile reader: Support >,

New in Pandoc 1.16.0.2 (Jan 15, 2016)

  • Depend on deepseq rather than deepseq-generics (fpco/stackage#1096).
  • Fixed regression in latex smart quote parsing (#2645). In cases where a match was not found for a quote, everything from the open quote to the end of the paragraph was being dropped.

New in Pandoc 1.15.0.6 (Jul 16, 2015)

  • --self-contained: Fixed overaggressive CSS minimization (#2301, 2286). Previously --self-contained wiped out all spaces in CSS, including semantically significant spaces. This was a regression from 1.14.x.
  • Markdown reader: don't allow bare URI links or autolinks in link label (#2300). Added test cases.
  • Text.Pandoc.Parsing, uri: Improved bare autolink detection (#2299). Previously we disallowed - at the end of an autolink, and disallowed the combination =-. This commit liberalizes the rules for allowing punctuation in a bare URI, and adds test cases. One potential drawback is that you can no longer put a bare URI in em dashes like this: this uri---http://example.com---is an example. But in this respect we now match github's treatment of bare URIs.
  • HTML writer: support speaker notes in dzslides. With this change and also will be output if -t dzslides is used. So we can have speaker notes in dzslides too. Thanks to maybegeek.
  • Updated dzslides template.
  • Improved documentation of options to print system default files (#2298). --print-default-data-file and --print-default-template.
  • DokuWiki writer: use $..$ for Math instead of .. (Tiziano Müller). MathJax seems currently to be the only maintained math rendering extension for DokuWiki.
  • Text.Pandoc.Shared: Changed hierarchicalize so it treats references div as top-level header (#2294). This fixes a bug with --section-divs, where the final references section added by pandoc-citeproc, enclosed in its own div, got nested in the div for the section previous to it.
  • Allow vector 0.11.
  • Require cmark > 0.4.

New in Pandoc 1.15 (Jul 7, 2015)

  • OpenDocument writer: Do not add a carriage return after a hard line break (Michael Chladek).
  • Ignore sandbox on ‘make quick’.
  • Man page changes:
  • Removed --man1, --man5 options (breaking change).
  • Removed Text.Pandoc.ManPages module (breaking API change).
  • Makefile target for man/man1/pandoc.1. This uses pandoc to create the man page from README using a custom template and filters.
  • Added man/ directory with template and filters needed to build man page.
  • We no longer have two man pages: pandoc.1 and pandoc_markdown.5. Now there is just pandoc.1, which has all the content from README. This change was needed because of the extensive cross-references between parts of the README.
  • Removed old data/pandoc.1.template and data/pandoc_markdown.5.template.
  • ConTeXt writer:
  • use \goto for internal links.
  • Added a % at end for \reference to avoid spurious space.

New in Pandoc 1.14.0.1 (May 29, 2015)

  • Fixed problem with building of reference.docx and reference.odt when the embed_data_files flag is used. Instead of having a phase of the build where reference.docx and reference.odt are created from their constituent data files, we now construct these archives from their constituents when a docx or odt is built. The constituent files have been moved from extra-source-files to data-files, and reference.docx and reference.odt have been removed. Users can create their own reference.docx or reference.odt by using pandoc to create a simple docx or odt. make-reference-files.hs has been removed, simplifying the build process (#2187)
  • Don't include generated man pages in extra-source-files (#2189).
  • Bumped upper bound for aeson.
  • ConTeXt writer: create internal link anchors for Div elements with identifiers. (This is needed for linked citations to work.)

New in Pandoc 1.14 (May 28, 2015)

  • NEW FEATURES:
  • Added commonmark as input and output format.
  • Added --verbose flag for debugging output in PDF production (#1840, #1653).
  • Allow wildcards in --epub-embed-font arguments (#1939).
  • Added --latex-engine-opt option (#969, #1779, Sumit Sahrawat).
  • Added shortcut_reference_links extension (Konstantin Zudov, #1977). This is enabled by default for those markdown flavors that support reading shortcut reference links, namely: markdown, markdown_strict, markdown_github, markdown_php. If the extension is enabled, the reader parses shortcut reference links like [foo], and the writer creates such links unless doing so would cause problems. Users of markdown flavors that support shortcut reference links should not notice a difference in reading markdown, but the markdown pandoc produces may differ. If shortcut links are not desired, the extension can be disabled in the normal way.
  • BEHAVIOR CHANGES:
  • --toc is now supported for docx output (#458, Nikolay Yakimov). A "dirty" TOC is created at the beginning of document. It can be regenerated after the document has been opened.
  • An implicit --filter pandoc-citeproc is now triggered only when the --bibliography option is used, and not when the bibliography field in metadata is specified (#1849).
  • LaTeX reader:
  • Don't limit includes to .tex extension (#1882). If the extension is not .tex, it must be given explicitly in the \input or \include.
  • Docx reader:
  • Allow numbering in the style file. This allows inherited styles with numbering (lists) (Jesse Rosenthal).
  • Org reader:
  • Support smart punctuation (Craig Bosma).
  • Drop trees with a :noexport: tag (Albert Krewinkel). Trees having a :noexport: tag set are not exported. This mirrors org-mode.
  • Put header tags into empty spans (Albert Krewinkel, #2160). Org mode allows headers to be tagged: * Headline :TAG1:TAG2. Instead of being interpreted as part of the headline, the tags are now put into the attributes of empty spans. Spans without textual content won't be visible by default, but they are detectable by filters. They can also be styled using CSS when written as HTML.
  • Generalize code block result parsing (Albert Krewinkel). Previously, only code blocks were recognized as result blocks; now, any kind of block can be the result.
  • Append newline to the LineBreak in Dokuwiki, HTML, EPUB, LaTeX, MediaWiki, OpenDocument, Texinfo writers (#1924, Tim Lin).
  • HTML writer:
  • Add "inline" or "display" class to math spans (#1914). This allows inline and display math to be styled differently.
  • Include raw latex blocks if --mathjax specified (#1938).
  • Require highlighting-kate >= 0.5.14 (#1903). This ensures that all code blocks will be wrapped in a div with class sourceCode. Also, the default highlighting CSS now adds div.sourceCode { x-overflow: auto; }, which means that code blocks (even with line numbers) will acquire a scroll bar on screens too small to display them (e.g. mobile phones). See also jgm/highlighting-kate#65.
  • LaTeX writer:
  • Use a declaration for tight lists (Jose Luis Duran, Joseph Harriott). Previously, pandoc hard-coded some commands to make tight lists in LaTeX. Now we use a custom command instead, allowing the styling to be changed in a macro in the header. (Note: existing templates may need to be modified to include the definition of this macro. See the current template.)
  • Beamer output: if the header introducing a slide has the class fragile, add the [fragile] option to the slide (#2119).
  • MediaWiki writer:
  • Use File: instead of the deprecated Image: for images and other media files (Greg Rundlett).
  • DocBook writer:
  • Render a Div (id,_,_) [Para _] element as a para element with an id attribute. This makes links to citations work in DocBook with pandoc-citeproc.
  • RST writer:
  • Normalize headings to sequential levels (Nikolay Yakimov). This is pretty much required by docutils.
  • Treat headings in block quotes, etc as rubrics (Nikolay Yakimov).
  • Better handling of raw latex inline (#1961). We use :raw-latex:`...` and add a definition for this role to the template.
  • EPUB writer:
  • Remove linear=no from cover itemref (#1609).
  • Don't use sup element for epub footnotes (#1995). Instead, just use an a element with class footnoteRef. This allows more styling options, and provides better results in some readers (e.g. iBooks, where anything inside the a tag breaks popup footnotes).
  • Take TOC title from toc-title metadata field.
  • Docx writer:
  • Implemented FirstParagraph style (Jesse Rosenthal). Following the ODT writer, we add the FirstParagraph style to the first text paragraph following an image, blockquote, table, heading, or beginning of document. This allows it to be styled differently. The default is for it to be the same as Normal.
  • Added BodyText style (Jesse Rosenthal). We apply a BodyText style to all unstyled paragraphs. This is, essentially, the same as Normal, except that since not everything inherits from BodyText (the metadata won't, for example, or the headers or footnote numbers), we can change the text in the body without having to make exceptions for everything. If we do want to change everything, we can still do it through Normal.
  • Altered Blockquote style slightly (Jesse Rosenthal). Since BlockQuote derives from BodyText, we just want to specify by default that it won't indent, regardless of what BodyText does. Note that this will not produce any visible difference in the default configuration.
  • Take TOC title from toc-title metadata field (Nikolay Yakimov).
  • Added a style to figure images (Nikolay Yakimov). Figures with empty captions use style Figure. Figures with nonempty captions use style Figure with Caption, which is based on Figure, and additionally has keepNext set.
  • ODT writer:
  • Added figure captions (Nikolay Yakimov). The following styles are used for figures: Figure -- for figure with empty caption), FigureWithCaption (based on Figure) -- for figure with caption, FigureCaption (based on Caption) -- for figure captions. Also, TableCaption (based on Caption) is used for table captions.
  • API CHANGES:
  • New Text.Pandoc.Error module with PandocError type (Matthew Pickering).
  • All readers now return Either PandocError Pandoc instead of Pandoc (Matthew Pickering). This allows better handling of errors.
  • Added Text.Pandoc.Writers.CommonMark, exporting writeCommonMark.
  • Added Text.Pandoc.Readers.CommonMark, exporting readCommonMark.
  • Derive Data and Typeable instances for MediaBag, Extension, ReaderOptions, EPUBVersion, CiteMethod, ObfuscationMethod, HTMLSlideVariant, TrackChanges, WriterOptions (Shabbaz Youssefi).
  • New Ext_shortcut_reference_links constructor for Extension (Konstantin Zudov).
  • BUG FIXES
  • Markdown reader:
  • Allow smart ' after inline math (#1909, Nikolay Yakimov).
  • Check for tex macros after indented code (#1973).
  • Rewrote charsInBalancedBrackets for efficiency.
  • Make sure a closing doesn't get included in a definition list item (#2127).
  • Don't parse bracketed text as citation if it might be a link, image, or footnote (Nikolay Yakimov).
  • Require space after key in mmd title block (#2026, Nikolay Yakimov). Require space after key-value delimiter colon in mmd title block.
  • Require nonempty value in mmd title block (Nikolay Yakimov).
  • Disable all metadata block extensions when parsing metadata field values (#2026, Nikolay Yakimov). Otherwise we could get a mmd title block inside YAML metadata, for example.
  • HTML reader:
  • Improve self-closing tag detection in htmlInBalanced (#2146).
  • Handle tables with in body rows (#1859, mb21).
  • Fixed htmlTag (#1820). If the tag parses as a comment, we check to see if the input starts with

New in Pandoc 1.13.2 (Dec 22, 2014)

  • TWiki Reader:
  • add new new twiki reader (API chaneg, Alexander Sulfrian).
  • Markdown reader:
  • Better handling of paragraph in div (#1591). Previously text that ended a div would be parsed as Plain unless there was a blank line before the closing div tag.
  • Don’t treat a citation as a reference link label (#1763).
  • Fix autolinks with following punctuation (#1811). The price of this is that autolinked bare URIs can no longer contain > characters, but this is not a big issue.
  • Fix Ext_lists_without_preceding_blankline bug (#1636, Artyom).
  • Allow startnum to work without fancy_lists. Formerly pandoc -f markdown-fancy_lists+startnum did not work properly.
  • RST reader (all Daniel Bergey):
  • Parse quoted literal blocks (#65). RST quoted literal blocks are the same as indented literal blocks (which pandoc already supports) except that the quote character is preserved in each line.
  • Parse RST class directives. The class directive accepts one or more class names, and creates a Div value with those classes. If the directive has an indented body, the body is parsed as the children of the Div. If not, the first block folowing the directive is made a child of the Div. This differs from the behavior of rst2xml, which does not create a Div element. Instead, the specified classes are applied to each child of the directive. However, most Pandoc Block constructors to not take an Attr argument, so we can’t duplicate this behavior.
  • Warn about skipped directives.
  • Literal role now produces Code. Code role should have “code” class.
  • Improved support for custom roles:
  • Added sourceCode to classes for :code: role, and anything inheriting from it.
  • Add the name of the custom role to classes if the Inline constructor supports Attr.
  • If the custom role directive does not specify a parent role, inherit from the :span: role.
  • This differs somewhat from the rst2xml.py behavior. If a custom role inherits from another custom role, Pandoc will attach both roles’ names as classes. rst2xml.py will only use the class of the directly invoked role (though in the case of inheriting from a :code: role with a :language: defined, it will also provide the inherited language as a class).
  • Warn about ignored fields in role directives.
  • LaTeX reader:
  • Parse label after caption into a span instead of inserting an additional paragraph of bracketed text (#1747).
  • Parse math environments as inline when possible (#1821).
  • Better handling of \noindent and \greektext (#1783).
  • Handle \texorpdfstring more gracefully.
  • Handle \cref and \sep (Wikiwide).
  • Support \smartcite and \Smartcite from biblatex.
  • HTML reader:
  • Retain display type of MathML output (#1719, Matthew Pickering).
  • Recognise tags inside blocks (#1620, Matthew Pickering).
  • Make embed tag either block or inline (#1756).
  • DocBook reader:
  • Handle keycombo, keycap (#1815).
  • Get string content in inner tags for literal elements (#1816).
  • Handle menuchoice elements better, with a > between (#1817).
  • Include id on section headers (#1818).
  • Document/test “type” as implemented (Brian O’Sullivan).
  • Add support for calloutlist and callout (Brian O’Sullivan). We treat a calloutlist as a bulleted list. This works well in practice.
  • Add support for classname (Bryan O’Sullivan).
  • Docx reader:
  • Fix window path for image lookup (Jesse Rosenthal). Don’t use os-sensitive “combine”, since we always want the paths in our zip-archive to use forward-slashes.
  • Single-item headers in ordered lists are headers (Jesse Rosenthal). When users number their headers, Word understands that as a single item enumerated list. We make the assumption that such a list is, in fact, a header.
  • Rewrite rewriteLink to work with new headers (Jesse Rosenthal). There could be new top-level headers after making lists, so we have to rewrite links after that.
  • Use polyglot header list (Jesse Rosenthal). We’re just keeping a list of header formats that different languages use as their default styles. At the moment, we have English, German, Danish, and French. We can continue to add to this. This is simpler than parsing the styles file, and perhaps less error-prone, since there seems to be some variations, even within a language, of how a style file will define headers.
  • Remove header class properly in other langs (Jesse Rosenthal). When we encounter one of the polyglot header styles, we want to remove that from the par styles after we convert to a header. To do that, we have to keep track of the style name, and remove it appropriately.
  • Account for external link URLs with anchors. Previously, if a URL had an anchor, the reader would incorrectly identify it as an internal link and return only the anchor as URL. (Caleb McDaniel)
  • Fix for Issue #1692 (i18n styles) (Nikolay Yakimov).
  • Org reader:
  • Added state changing blanklines (Jesse Rosenthal). This allows us to emphasize at the beginning of a new paragraph (or, in general, after blank lines).
  • Fixed bug with bulleted lists:
  • was being parsed as a list, even though an unindented * should make a heading. See http://orgmode.org/manual/Plain-lists.html#fn-1.
  • Org reader: absolute, relative paths in link (#1741, Albert Krewinkel). The org reader was too restrictive when parsing links; some relative links and links to files given as absolute paths were not recognized correctly.
  • Org reader: allow empty links (jgm/gitit#471, Albert Krewinkel). This is important for use in gitit, which uses empty links for wikilinks.
  • Respect indent when parsing Org bullet lists (#1650, Timothy Humphries). Fixes issue with top-level bullet list parsing.
  • Fix indent issue for definition lists (Timothy Humphries, see #1650, #1698, #1680).
  • Parse multi-inline terms correctly in definition list (#1649, Matthew Pickering).
  • Fix rules for emphasis recognition (Albert Krewinkel). Things like /hello,/ or /hi'/ were falsy recognized as emphasised strings. This is wrong, as , and ' are forbidden border chars and may not occur on the inner border of emphasized text.
  • Drop COMMENT document trees (Albert Krewinkel). Document trees under a header starting with the word COMMENT are comment trees and should not be exported. Those trees are dropped silently (#1678).
  • Properly handle links to file:target (Albert Krewinkel). Org links like [[file:target][title]] were not handled correctly, parsing the link target verbatim. The org reader is changed such that the leading file: is dropped from the link target (see #756, #1812).
  • Parse LaTeX-style MathML entities (#1657, Albert Krewinkel). Org supports special symbols which can be included using LaTeX syntax, but are actually MathML entities. Examples for this are \nbsp (non-breaking space), \Aacute (the letter A with accent acute) or \copy (the copyright sign ©)
  • EPUB reader:
  • URI handling improvements. Now we outsource most of the work to fetchItem'. Also, do not include queries in file extensions (#1671).
  • LaTeX writer:
  • Use \texorpdfstring for section captions when needed (Vaclav Zeman).
  • Handle consecutive linebreaks (#1733).
  • Protect graphics in headers (Jesse Rosenthal). Graphics in \section/\subsection etc titles need to be \protected.
  • Put ~ before header in list item text (Jesse Rosenthal). Because of the built-in line skip, LaTeX can’t handle a section header as the first element in a list item.
  • Avoid using reserved characters as \lstinline delimiters (#1595).
  • Better handling of display math in simple tables (#1754). We convert display math to inline math in simple tables, since LaTeX can’t deal with display math in simple tables.
  • Escape spaces in code (#1694, Bjorn Buckwalter).
  • MediaWiki writer:
  • Fixed links with URL = text. Previously these were rendered as bare words, even if the URL was not an absolute URL (#1825).
  • ICML writer:
  • Don’t force all citations into footnotes.
  • RTF writer:
  • Add blankline at end of output (#1732, Matthew Pickering).
  • RST writer:
  • Ensure blank line after figure.
  • Avoid exces whitespace after last list item (#1777).
  • Wrap line blocks with spaces before continuations (#1656).
  • Fixed double-rendering of footnotes in RST tables (#1769).
  • DokuWiki writer:
  • Better handling of block quotes. This change ensures that multiple paragraph blockquotes are rendered using native > rather than as HTML (#1738).
  • Fix external images (#1739). Preface relative links with “:”, absolute URIs without. (Timothy Humphries)
  • HTML writer:
  • Use protocol-relative URL for mathjax.
  • Put newline btw img and caption paragraph.
  • MathML now outputted with tex annotation (#1635, Matthew Pickering).
  • Add support for KaTeX HTML math (#1626, Matthew Pickering). This adds KaTeX to HTMLMathMethod (API change).
  • Don’t double render when email-obfuscation=none (#1625, Matthew Pickering).
  • Make header attributes work outside top level (#1711). Previously they only appeared on top level header elements. Now they work e.g. in blockquotes.
  • ODT writer:
  • Correctly handle images without extensions (#1729).
  • Strip querystring in ODT write (#1682, Todd Sifleet).
  • FB2 writer:
  • Add newline to output.
  • EPUB writer:
  • Don’t add sourceURL to absolute URIs (#1669).
  • Don’t use unsupported opf:title-type for epub2.
  • Include “landmarks” section in nav document for epub3 (#1757).
  • Removed playOrder from navpoint elements in ncx file (#1760). These aren’t required, and they make manual modification of epubs difficult.
  • Extract title even from structured title.
  • Don’t include nav node in spine unless --toc was requested. Previously we included it in the spine with linear="no", leading to odd results in some readers (#1593).
  • Fixed absolute URI detection (#1672).
  • Correctly resolve relative URIs (#1671).
  • Use regular page template for nav.xhtml, including doctype (#1759).
  • Docx writer:
  • Put docx table captions above tables (#1641, Nikolay Yakimov).
  • Get the page width from the reference docx file, and use it to scale images that are too large to fit (Grégory Bataille).
  • Partial fix for #1607 (Nikolay Yakimov). International heading styles are inferred based on fallback, if there are no en-US “Heading#” styles
  • Look in user data dir for archive reference.docx.
  • Renumber header and footer relationships to avoid collisions (Jesse Rosenthal). We previously took the old relationship names of the headers and footer in secptr. That led to collisions. We now make a map of availabl names in the relationships file, and then rename in secptr.
  • ConTeXt writer:
  • Add function toLabel (Mark Szepieniec). This function can be used to sanitize reference labels so that they do not contain any of the illegal characters #[]“,{}%()|= . Currently only Links have their labels sanitized, because they are the only Elements that use passed labels.
  • Text.Pandoc.Shared:
  • Moved import of toChunks outside of CPP conditional (#1590).
  • Fix inDirectory to reset to the original directory in case an exception occurs (Freiric Barral).
  • Templates:
  • LaTeX template: load polyglossia before bibtex (jgm/pandoc-templates#70). Thanks to bluebirch.
  • LaTeX template: Added \VerbatimFootnotes if there is verbatim in notes (#1616).
  • LaTeX template: Add shorthands=off to babel options (#1648).
  • EPUB, EPUB3 templates: Added id="cover" to body of cover page. This aids styling, making it possible for example to set 0 margins on the title page (#1758).
  • EPUB, EPUB3 templates: Handle structured metadata on titlepage. Previously we just expected ‘title’, ‘subtitle’, ‘author’, ‘date’. Now we still support those, but also support the format recommended for epub metadata in the pandoc README:
  • Text.Pandoc.Templates.getDefaultTemplate: don’t fail when called with “fb2” (#1660).
  • Text.Pandoc.Parsing:
  • Fixed inlineMath so it handles \text{..} containing $. For example: $x = \text{the $n$th root of $y$} (#1677).
  • Change parseFromString to fail if not all input is consumed. (Matthew Pickering)
  • Moved addWarning from Markdown reader to Parsing, so it can be used by more readers (API change, Daniel Bergey).
  • Text.Pandoc.Pretty:
  • Improve performance of realLength (Matthew Pickering).
  • Make CR + BLANKLINE = BLANKLINE. This fixes an extra blank line we were getting at the end of markdown fragments (as well as rst, org, etc.) (#1705).
  • Text.Pandoc.MIME:
  • Add mime type for WebVTT (Jason Ronallo).
  • Changed mime type for otf to application/vnd.ms-opentype (#1761). This is needed for epub3 validation.
  • Text.Pandoc.MediaBag:
  • Fix Windows specific path problems (#1597).
  • Text.Pandoc.Shared:
  • Make collapseFilePath OS-agnostic (Matthew Pickering).
  • Link the test suite using -threaded. This allows the test suite to be run using +RTS -N.
  • Added network dependency under network-uri flag in test section.
  • Give better error messages when someone tries to convert from pdf, doc, odt (#1683).
  • Added track to list of tags treated by --self-contained (#1664).

New in Pandoc 1.13.1 (Sep 8, 2014)

  • Fixed --self-contained with Windows paths (#1558). Previously C:\foo.js was being wrongly interpreted as a URI.
  • HTML reader: improved handling of tags that can be block or inline. Previously a section like this would be enclosed in a paragraph, with RawInline for the video tags (since video is a tag that can be either block or inline):
  • The videos can not be played back on your system.
  • Try viewing on Youtube (requires Internet connection):
  • Relative Velocity on
  • Youtube.
  • This change will cause the video and source tags to be parsed as RawBlock instead, giving better output. The general change is this: when we're parsing a "plain" sequence of inlines, we don't parse anything that COULD be a block-level tag.
  • Docx reader:
  • Be sensitive to user styles. Note that "Hyperlink" is "blacklisted," as we don't want the default underline styling to be inherited by all links by default.
  • Read single paragraph in table cell as Plain . This makes to docx reader's native output fit with the way the markdown reader understands its markdown output.
  • Textile writer: Extended the range of cases where native textile tables will be used (as opposed to raw HTML): we now handle any alignment type, but only for simple tables with no captions.
  • Txt2Tags reader:
  • Header is now parsed only if standalone flag is set .
  • The header is now parsed as meta information. The first line is the title, the second is the author and third line is the date.
  • Corrected formatting of %%mtime macro .
  • Fixed crash when reading from stdin.
  • EPUB writer: Don't use page-progression-direction in EPUB2, which doesn't support it. Also, if page-progression-direction not specified in metadata, don't include the attribute even in EPUB3; not including it is the same as including it with the value "default", as we did before. (#1550)
  • Org writer: Accept example lines with indentation at the beginning .
  • DokuWiki writer:
  • Refactor to use Reader monad.
  • Avoid using raw HTML in table cells; instead, use \\ instead of newlines .
  • Properly handle HTML table cell alignments, and use spacing to make the tables look prettier (#1566).
  • Docx writer:
  • Bibliography entries get Bibliography style (#1559).
  • Implement change tracking .
  • LaTeX writer:
  • Fixed a bug that caused a table caption to repeat across all pages (Jose Luis Duran).
  • Improved vertical spacing in tables and made it customizable using standard lengths set by booktab. See https://groups.google.com/forum/#!msg/pandoc-discuss/qMu6_5lYy0o/ZAU7lzAIKw0J (Jose Luis Duran).
  • Added \strut to fix spacing in multiline tables (Jose Luis Duran).
  • Use \tabularnewline instead of \\ in table cells (Jose Luis Duran).
  • Made horizontal rules more flexible (Jose Luis Duran).
  • Text.Pandoc.MIME:
  • Added MimeType (type synonym for String) and getMimeTypeDef. Code cleanups .
  • Templates:
  • LaTeX template: disable microtype protrusion for typewriter font (#1549, thanks lemzwerg).
  • Improved OSX build procedure.
  • Added network-uri flag, to deal with split of network-uri from network.
  • Fix build dependencies for the trypandoc flag, so that they are ignored if trypandoc flag is set to False.
  • Updated README to remove outdated claim that --self-contained looks in the user data directory for missing files.

New in Pandoc 1.13.0.1 (Aug 18, 2014)

  • Bug fix:
  • Docx writer:
  • Fixed regression which bungled list numbering (#1544), causing all lists to appear as basic ordered lists.
  • Include row width in table rows (Christoffer Ackelman, Viktor Kronvall). Added a property to all table rows where the sum of column widths is specified in pct (fraction of 5000). This helps persuade Word to lay out the table with the widths we specify.
  • Docx reader: miscellaneous under-the-hood improvements (Jesse Rosenthal). Most significantly, the reader now uses Builder, leading to some performance improvements.
  • HTML reader: Parse appropriately styled span as SmallCaps.
  • Markdown writer: don't escape $, ^, ~ when tex_math_dollars, superscript, and subscript extensions, respectively, are deactivated (#1127).
  • Added trypandoc flag to build CGI executable used in the online demo.
  • Makefile: Added 'quick', 'osxpkg' targets.
  • Updated README in templates to indicate templates license. The templates are dual-licensed, BSD3 and GPL2+.

New in Pandoc 1.13 (Aug 16, 2014)

  • New features:
  • Added docx as an input format (Jesse Rosenthal). The docx reader includes conversion of native Word equations to pandoc LaTeX Math elements. Metadata is taken from paragraphs at the beginning of the document with styles Author, Title, Subtitle, Date, and Abstract.
  • Added epub as an input format (Matthew Pickering). The epub reader includes conversion of MathML to pandoc LaTeX Math elements.
  • Added t2t (Txt2Tags) as an input format (Matthew Pickering). Txt2tags is a lightweight markup format described at http://txt2tags.org/.
  • Added dokuwiki as an output format (Clare Macrae).
  • Added haddock as an output format.
  • Added --extract-media option to extract media contained in a zip container (docx or epub) while adjusting image paths to point to the extracted images.
  • Added a new markdown extension, compact_definition_lists, that restores the syntax for definition lists of pandoc 1.12.x, allowing tight definition lists with no blank space between items, and disallowing lazy wrapping. (See below under behavior changes.)
  • Added an extension epub_html_exts for parsing HTML in EPUBs.
  • Added extensions native_spans and native_divs to activate parsing of material in HTML span or div tags as Pandoc Span inlines or Div blocks.
  • --trace now works with the Markdown, HTML, Haddock, EPUB, Textile, and MediaWiki readers. This is an option intended for debugging parsing problems; ordinary users should not need to use it.
  • Behavior changes:
  • Changed behavior of the markdown_attribute extension, to bring it in line with PHP markdown extra and multimarkdown. Setting markdown="1" on an outer tag affects all contained tags, recursively, until it is reversed with markdown="0" (#1378).
  • Revised markdown definition list syntax (#1429). Both the reader and writer are affected. This change brings pandoc’s definition list syntax into alignment with that used in PHP markdown extra and multimarkdown (with the exception that pandoc is more flexible about the definition markers, allowing tildes as well as colons). Lazily wrapped definitions are now allowed. Blank space is required between list items. The space before a definition is used to determine whether it is a paragraph or a “plain” element. WARNING: This change may break existing documents! Either check your documents for definition lists without blank space between items, or use markdown+compact_definition_lists for the old behavior.
  • .numberLines now works in fenced code blocks even if no language is given (#1287, jgm/highlighting-kate#40).
  • Improvements to --filter:
  • Don’t search PATH for a filter with an explicit path. This fixed a bug wherein --filter ./caps.py would run caps.py from the system path, even if there was a caps.py in the working directory.
  • Respect shebang if filter is executable (#1389).
  • Don’t print misleading error message. Previously pandoc would say that a filter was not found, even in a case where the filter had a syntax error.
  • HTML reader:
  • Parse div and span elements even without --parse-raw, provided native_divs and native_spans extensions are set. Motivation: these now generate native pandoc Div and Span elements, not raw HTML.
  • Parse EPUB-specific elements if the epub_html_exts extension is enabled. These include switch, footnote, rearnote, noteref.
  • Org reader:
  • Support for inline LaTeX. Inline LaTeX is now accepted and parsed by the org-mode reader. Both math symbols (like \tau) and LaTeX commands (like \cite{Coffee}), can be used without any further escaping (Albert Krewinkel).
  • Textile reader and writer:
  • The raw_tex extension is no longer set by default. You can enable it with textile+raw_tex.
  • DocBook reader:
  • Support equation, informalequation, inlineequation elements with mml:math content. This is converted into LaTeX and put into a Pandoc Math inline.
  • Revised plain output, largely following the style of Project Gutenberg:
  • Emphasis is rendered with _underscores_, strong emphasis with ALL CAPS.
  • Headings are rendered differently, with space to set them off, not with setext style underlines. Level 1 headers are ALL CAPS.
  • Math is rendered using unicode when possible, but without the distracting emphasis markers around variables.
  • Footnotes use a regular [n] style.
  • Markdown writer:
  • Horizontal rules are now a line across the whole page.
  • Prettier pipe tables. Columns are now aligned (#1323).
  • Respect the raw_html extension. pandoc -t markdown-raw_html no longer emits any raw HTML, including span and div tags generated by Span and Div elements.
  • Use span with style for SmallCaps (#1360).
  • HTML writer:
  • Autolinks now have class uri, and email autolinks have class email, so they can be styled.
  • Docx writer:
  • Document formatting is carried over from reference.docx. This includes margins, page size, page orientation, header, and footer, including images in headers and footers.
  • Include abstract (if present) with Abstract style (#1451).
  • Include subtitle (if present) with Subtitle style, rather than tacking it on to the title (#1451).
  • Org writer:
  • Write empty span elements with an id attribute as org anchors. For example Span ("uid",[],[]) [] becomes .
  • LaTeX writer:
  • Put table captions above tables, to match the conventional standard. (Previously they appeared below tables.)
  • Use \(..\) instead of $..$ for inline math (#1464).
  • Use \nolinkurl in email autolinks. This allows them to be styled using \urlstyle{tt}. Thanks to Ulrike Fischer for the solution.
  • Use \textquotesingle for ' in inline code. Otherwise we get curly quotes in the PDF output (#1364).
  • Use \footnote{..} for notes in beamer, so that footnotes do not appear before the overlays in which their markers appear (#1525).
  • Don’t produce a \label{..} for a Div or Span element. Do produce a \hyperdef{..} (#1519).
  • EPUB writer:
  • If the metadata includes page-progression-direction (which can be ltr or rtl, the page-progression-direction attribute will be set in the EPUB spine (#1455).
  • Custom lua writers:
  • Custom writers now work with --template.
  • Removed HTML header scaffolding from sample.lua.
  • Made citation information available in lua writers.
  • --normalize and Text.Pandoc.Shared.normalize now consolidate adjacent RawBlocks when possible.
  • API changes
  • Added Text.Pandoc.Readers.Docx, exporting readDocx (Jesse Rosenthal).
  • Added Text.Pandoc.Readers.EPUB, exporting readEPUB (Matthew Pickering).
  • Added Text.Pandoc.Readers.Txt2Tags, exporting readTxt2Tags (Matthew Pickering).
  • Added Text.Pandoc.Writers.DokuWiki, exporting writeDokuWiki (Clare Macrae).
  • Added Text.Pandoc.Writers.Haddock, exporting writeHaddock.
  • Added Text.Pandoc.MediaBag, exporting MediaBag, lookupMedia, insertMedia, mediaDirectory, extractMediaBag. The docx and epub readers return a pair of a Pandoc document and a MediaBag with the media resources they contain. This can be extracted using --extract-media. Writers that incorporate media (PDF, Docx, ODT, EPUB, RTF, or HTML formats with --self-contained) will look for resources in the MediaBag generated by the reader, in addition to the file system or web.
  • Text.Pandoc.Readers.TexMath: Removed deprecated readTeXMath. Renamed readTeXMath' to texMathToInlines.
  • Text.Pandoc: Added Reader data type (Matthew Pickering). readers now associates names of readers with Reader structures. This allows inclusion of readers, like the docx reader, that take binary rather than textual input.
  • Text.Pandoc.Shared:
  • Added capitalize (Artyom Kazak), and replaced uses of map toUpper (which give bad results for many languages).
  • Added collapseFilePath, which removes intermediate . and .. from a path (Matthew Pickering).
  • Added fetchItem', which works like fetchItem but searches a MediaBag before looking on the net or file system.
  • Added withTempDir.
  • Added removeFormatting.
  • Added extractSpaces (from HTML reader) and generalized its type so that it can be used by the docx reader (Matthew Pickering).
  • Added ordNub.
  • Added normalizeInlines, normalizeBlocks.
  • normalize is now Pandoc -> Pandoc instead of Data a :: a -> a. Some users may need to change their uses of normalize to the newly exported normalizeInlines or normalizeBlocks.
  • Text.Pandoc.Options:
  • Added writerMediaBag to WriterOptions.
  • Removed deprecated and no longer used readerStrict in ReaderOptions. This is handled by readerExtensions now.
  • Added Ext_compact_definition_lists.
  • Added Ext_epub_html_exts.
  • Added Ext_native_divs and Ext_native_spans. This allows users to turn off the default pandoc behavior of parsing contents of div and span tags in markdown and HTML as native pandoc Div blocks and Span inlines.
  • Text.Pandoc.Parsing:
  • Generalized readWith to readWithM (Matthew Pickering).
  • Export runParserT and Stream (Matthew Pickering).
  • Added HasQuoteContext type class (Matthew Pickering).
  • Generalized types of mathInline, smartPunctuation, quoted, singleQuoted, doubleQuoted, failIfInQuoteContext, applyMacros (Matthew Pickering).
  • Added custom token (Matthew Pickering).
  • Added stateInHtmlBlock to ParserState. This is used to keep track of the ending tag we’re waiting for when we’re parsing inside HTML block tags.
  • Added stateMarkdownAttribute to ParserState. This is used to keep track of whether the markdown attribute has been set in an enclosing tag.
  • Generalized type of registerHeader, using new type classes HasReaderOptions, HasIdentifierList, HasHeaderMap (Matthew Pickering). These allow certain common functions to be reused even in parsers that use custom state (instead of ParserState), such as the MediaWiki reader.
  • Moved inlineMath, displayMath from Markdown reader to Parsing, and generalized their types (Matthew Pickering).
  • Text.Pandoc.Pretty:
  • Added nestle.
  • Added blanklines, which guarantees a certain number of blank lines (and no more).
  • Bug fixes:
  • Markdown reader:
  • Fixed parsing of indented code in list items. Indented code at the beginning of a list item must be indented eight spaces from the margin (or edge of the container), or four spaces from the list marker, whichever is greater.
  • Fixed small bug in HTML parsing with markdown_attribute, which caused incorrect tag nesting for input like *hi*.
  • Fixed regression with intraword underscores (#1121).
  • Improved parsing of inline links containing quote characters (#1534).
  • Slight rewrite of enclosure/emphOrStrong code.
  • Revamped raw HTML block parsing in markdown (#1330). We no longer include trailing spaces and newlines in the raw blocks. We look for closing tags for elements (but without backtracking). Each block-level tag is its own RawBlock; we no longer try to consolidate them (though --normalize will do so).
  • Combine consecutive latex environments. This helps when you have two minipages which can’t have blank lines between them (#690, #1196).
  • Support smallcaps through span. foo will be parsed as a SmallCaps inline, and will work in all output formats that support small caps (#1360).
  • Prevent spurious line breaks after list items (#1137). When the hard_line_breaks option was specified, pandoc would formerly produce a spurious line break after a tight list item.
  • Fixed table parsing bug (#1333).
  • Handle c++ and objective-c as language identifiers in github-style fenced blocks (#1318).
  • Inline math must have nonspace before final $ (#1313).
  • LaTeX reader:
  • Handle comments at the end of tables. This resolves the issue illustrated in http://stackoverflow.com/questions/24009489.
  • Correctly handle table rows with too few cells. LaTeX seems to treat them as if they have empty cells at the end (#241).
  • Handle leading/trailing spaces in \emph better. \emph{ hi } gets parsed as [Space, Emph [Str "hi"], Space] so that we don’t get things like * hi * in markdown output. Also applies to \textbf and some other constructions (#1146).
  • Don’t assume preamble doesn’t contain environments (#1338).
  • Allow (and discard) optional argument for \caption (James Aspnes).
  • HTML reader:
  • Fixed major parsing problem with HTML tables. Table cells were being combined into one cell (#1341).
  • Fixed performance issue with malformed HTML tables. We let a tag close an open or (#1167).
  • Allow space between and .
  • Added audio and source in eitherBlockOrInline.
  • Moved video, svg, progress, script, noscript, svg from blockTags to eitherBlockOrInline.
  • map and object were mistakenly in both lists; they have been removed from blockTags.
  • Ignore DOCTYPE and xml declarations.
  • MediaWiki reader:
  • Don’t parse backslash escapes inside (#1445).
  • Tightened up template parsing. The opening {{ must be followed by an alphanumeric or :. This prevents the exponential slowdown in #1033.
  • Support “Bild” for images.
  • DocBook reader:
  • Better handle elements inside code environments. Pandoc’s document model does not allow structure inside code blocks, but at least this way we preserve the text (#1449).
  • Support (#1236).
  • Textile reader:
  • Fixed list parsing. Lists can now start without an intervening blank line (#1513).
  • HTML block-level tags that do not start a line are parsed as inline HTML and do not interrupt paragraphs (as in RedCloth).
  • Org reader:
  • Make tildes create inline code (#1345). Also relabeled code and verbatim parsers to accord with the org-mode manual.
  • Respect :exports header argument in code blocks (Craig Bosma).
  • Fixed tight lists with sublists (#1437).
  • EPUB writer:
  • Avoid excess whitespace in nav.xhtml. This should improve TOC view in iBooks (#1392).
  • Fixed regression on cover image. In 1.12.4 and 1.12.4.2, the cover image would not appear properly, because the metadata id was not correct. Now we derive the id from the actual cover image filename, which we preserve rather than using “cover-image.”
  • Keep newlines between block elements. This allows easier diff-ability (#1424).
  • Use stringify instead of custom plainify.
  • Use renderTags' for all tag rendering. This properly handles tags that should be self-closing. Previously would appear in EPUB output as (#1420).
  • Better handle HTML media tags.
  • Handle multiple dates with OPF event attributes. Note: in EPUB3 we can have only one dc:date, so only the first one is used.
  • LaTeX writer:
  • Correctly handle figures in notes. Notes can’t contain figures in LaTeX, so we fake it to avoid an error (#1053).
  • Fixed strikeout + highlighted code (#1294). Previously strikeout highlighted code caused an error.
  • ConTeXt writer:
  • Improved detection of autolinks with URLs containing escapes.
  • RTF writer:
  • Improved image embedding: fetchItem' is now used to get the images, and calculated image sizes are indicated in the RTF.
  • Avoid extra paragraph tags in metadata (#1421).
  • HTML writer:
  • Deactivate “incremental” inside slide speaker notes (#1394).
  • Don’t include empty items in the table of contents for slide shows. (These would result from creating a slide using a horizontal rule.)
  • MediaWiki writer:
  • Minor renaming of st prefixed names.
  • AsciiDoc writer:
  • Double up emphasis and strong emphasis markers in intraword contexts, as required by asciidoc (#1441).
  • Markdown writer:
  • Avoid wrapping that might start a list, blockquote, or header (#1013).
  • Use Span instead of (hackish) SmallCaps in plainify.
  • Don’t use braced attributes for fenced code (#1416). If Ext_fenced_code_attributes is not set, the first class attribute will be printed after the opening fence as a bare word.
  • Separate adjacent lists of the same kind with an HTML comment (#1458).
  • PDF writer:
  • Fixed treatment of data uris for images (#1062).
  • Docx writer:
  • Use Compact style for empty table cells (#1353). Otherwise we get overly tall lines when there are empty table cells and the other cells are compact.
  • Create overrides per-image for media/ in reference docx. This should be somewhat more robust and cover more types of images.
  • Improved entryFromArchive to avoid an unneeded parse.
  • Section numbering carries over from reference.docx (#1305).
  • Simplified abstractNumId numbering. Instead of sequential numbering, we assign numbers based on the list marker styles.
  • Text.Pandoc.Options:
  • Removed Ext_fenced_code_attributes from markdown_github extensions.
  • Text.Pandoc.ImageSize:
  • Use default instead of failing if image size not found in exif header (#1358).
  • ignore unknown exif header tag rather than crashing. Some images seem to have tag type of 256, which was causing a runtime error.
  • Text.Pandoc.Shared:
  • fetchItem: unescape URI encoding before reading local file (#1427).
  • fetchItem: strip a fragment like ?#iefix from the extension before doing mime lookup, to improve mime type guessing.
  • Improved logic of fetchItem: absolute URIs are fetched from the net; other things are treated as relative URIs if sourceURL is Just _, otherwise as file paths on the local file system.
  • fetchItem now properly handles links without a protocol (#1477).
  • fetchItem now escapes characters not allowed in URIs before trying to parse the URIs.
  • Fixed runtime error with compactify'DL on certain lists (#1452).
  • pandoc.hs: Don’t strip path off of writerSourceURL: the path is needed to resolve relative URLs when we fetch resources (#750).
  • Text.Pandoc.Parsing:
  • Simplified dash and ellipsis (#1419).
  • Removed (>>~) in favor of the equivalent (= 0.5.8.5 (#1271, #1317, Debian #753299). This change to highlighting-kate means that PHP fragments no longer need to start with

New in Pandoc 1.12.4.2 (May 15, 2014)

  • Require highlighting-kate >= 0.5.8. Fixes a performance regression.
  • Shared: addMetaValue now behaves slightly differently: if both the new and old values are lists, it concatenates their contents to form a new list.
  • LaTeX reader:
  • Set bibliography in metadata from \bibliography or \addbibresource command.
  • Don't error on %foo with no trailing newline.
  • Org reader:
  • Support code block headers (#+BEGIN_SRC ...) (Albert Krewinkel).
  • Fix parsing of blank lines within blocks (Albert Krewinkel).
  • Support pandoc citation extension (Albert Krewinkel). This can be turned off by specifying org-citation as the input format.
  • Markdown reader:
  • citeKey moved to Text.Pandoc.Parsing so it can be used by other readers (Albert Krewinkel).
  • Text.Pandoc.Parsing:
  • Added citeKey (see above).
  • Added HasLastStrPosition type class and updateLastStrPos and notAfterString functions.
  • Updated copyright notices (Albert Krewinkel).
  • Added default.icml to data files so it installs with the package.
  • OSX package:
  • The binary is now built with options to ensure that it can be used with OSX 10.6+.
  • Moved OSX package materials to osx directory.
  • Added OSX package uninstall script, included in the zip container (thanks to Daniel T. Staal).

New in Pandoc 1.12.4 (May 12, 2014)

  • Made it possible to run filters that aren't executable (#1096).
  • Added Emacs org-mode reader (Albert Krewinkel).
  • Added InDesign ICML Writer (mb21).
  • MediaWiki reader:
  • Accept image links in more languages (Jaime Marquínez Ferrándiz).
  • Fixed bug in certain nested lists (#1213). If a level 2 list was followed by a level 1 list, the first item of the level 1 list would be lost.
  • Handle table rows containing just an HTML comment (#1230).
  • LaTeX reader:
  • Give better location information on errors, pointing to line numbers within included files (#1274).
  • LaTeX reader: Better handling of table environment (#1204). Positioning options no longer rendered verbatim.
  • Better handling of figure and table with caption (#1204).
  • Handle @{} and p{length} in tabular. The length is not actually recorded, but at least we get a table (#1180).
  • Properly handle \nocite. It now adds a nocite metadata field. Citations there will appear in the bibliography but not in the text (unless you explicitly put a $nocite$ variable in your template).
  • Markdown reader:
  • Ensure that whole numbers in YAML metadata are rendered without decimal points. (This became necessary with changes to aeson and yaml libraries. aeson >= 0.7 and yaml >= 0.8.8.2 are now required.)
  • Fixed regression on line breaks in strict mode (#1203).
  • Small efficiency improvements.
  • Improved parsing of nested divs. Formerly a closing div tag would be missed if it came right after other block-level tags.
  • Avoid backtracking when closing not found.
  • Fixed bug in reference link parsing in markdown_mmd.
  • Fixed a bug in list parsing (#1154). When reading a raw list item, we now strip off up to 4 spaces.
  • Fixed parsing of empty reference link definitions (#1186).
  • Made one-column pipe tables work (#1218).
  • Textile reader:
  • Better support for attributes. Instead of being ignored, attributes are now parsed and included in Span inlines. The output will be a bit different from stock textile: e.g. for *(foo)hi*, we'll get hi instead of hi. But at least the data is not lost.
  • Improved treatment of HTML spans (%) (#1115).
  • Improved link parsing. In particular we now pick up on attributes. Since pandoc links can't have attributes, we enclose the whole link in a span if there are attributes (#1008).
  • Implemented correct parsing rules for inline markup (#1175, Matthew Pickering).
  • Use Builder (Matthew Pickering).
  • DocBook reader:
  • Better treatment of formalpara. We now emit the title (if present) as a separate paragraph with boldface text (#1215).
  • Set metadata author not authors.
  • Added recognition of authorgroup and releaseinfo elements (#1214, Matthew Pickering).
  • Converted current meta information parsing in DocBook to a more extensible version which is aware of the more recent meta representation (Matthew Pickering).
  • HTML reader:
  • Require tagsoup 0.13.1, to fix a bug with parsing of script tags (#1248).
  • Treat processing instructions & declarations as block. Previously these were treated as inline, and included in paragraph tags in HTML or DocBook output, which is generally not what is wanted (#1233).
  • Updated closes with rules from HTML5 spec.
  • Use Builder (Matthew Pickering, #1162).
  • RST reader:
  • Remove duplicate http in PEP links (Albert Krewinkel).
  • Make rst figures true figures (#1168, CasperVector)
  • Enhanced Pandoc's support for rST roles (Merijn Verstaaten). rST parser now supports: all built-in rST roles, new role definition, role inheritance, though with some limitations.
  • Use author rather than authors in metadata.
  • Better handling of directives. We now correctly handle field lists that are indented more than three spaces. We treat an aafig directive as a code block with attributes, so it can be processed in a filter (#1212).
  • LaTeX writer:
  • Mark span contents with label if span has an ID (Albert Krewinkel).
  • Made --toc-depth work well with books in latex/pdf output (#1210).
  • Handle line breaks in simple table cells (#1217).
  • Workaround for level 4-5 headers in quotes. These previously produced invalid LaTeX: \paragraph or \subparagraph in a quote environment. This adds an mbox{} in these contexts to work around the problem. See http://tex.stackexchange.com/a/169833/22451 (#1221).
  • Use \/ to avoid en-dash ligature instead of -{}- (Vaclav Zeman). This is to fix LuaLaTeX output. The -{}- sequence does not avoid the ligature with LuaLaTeX but \/ does.
  • Fixed string escaping in hyperref and hyperdef (#1130).
  • ConTeXt writer: Improved autolinks (#1270).
  • DocBook writer:
  • Improve handling of hard line breaks in Docbook writer (Neil Mayhew). Use a for the entire paragraph, not just for the newline character.
  • Don't let line breaks inside footnotes influence the enclosing paragraph (Neil Mayhew).
  • Distinguish tight and loose lists in DocBook output, using spacing="compact" (Neil Mayhew, #1250).
  • Docx writer: When needed files are not present in the user's
  • reference.docx, fall back on the versions in the reference.docx
  • in pandoc's data files. This fixes a bug that occurs when a
  • reference.docx saved by LibreOffice is used. (#1185)
  • EPUB writer:
  • Include extension in epub ids. This fixes a problem with duplicate extensions for fonts and images with the same base name but different extensions (#1254).
  • Handle files linked in raw img tags (#1170).
  • Handle media in audio source tags (#1170). Note that we now use a media directory rather than images.
  • Incorporate files linked in video tags (#1170). src and poster will both be incorporated into content.opf and the epub container.
  • HTML writer:
  • Add colgroup around col tags (#877). Also affects EPUB writer.
  • Fixed bug with unnumbered section headings. Unnumbered section headings (with class unnumbered) were getting numbers.
  • Improved detection of image links. Previously image links with queries were not recognized, causing to be used instead of .
  • Man writer: Ensure that terms in definition lists aren't line wrapped
  • (#1195).
  • Markdown writer:
  • Use proper escapes to avoid unwanted lists (#980). Previously we used 0-width spaces, an ugly hack.
  • Use longer backtick fences if needed (#1206). If the content contains a backtick fence and there are attributes, make sure longer fences are used to delimit the code. Note: This works well in pandoc, but github markdown is more limited, and will interpret the first string of three or more backticks as ending the code block.
  • RST writer: Avoid stack overflow with certain tables (#1197).
  • RTF writer: Fixed table cells containing paragraphs.
  • Custom writer:
  • Correctly handle UTF-8 in custom lua scripts (#1189).
  • Fix bugs with lua scripts with mixed-case filenames and paths containing + or - (#1267). Note that getWriter in Text.Pandoc no longer returns a custom writer on input foo.lua.
  • AsciiDoc writer: Handle multiblock and empty table cells
  • (#1245, #1246). Added tests.
  • Text.Pandoc.Options: Added readerTrace to ReaderOptions
  • Text.Pandoc.Shared:
  • Added compactify'DL (formerly in markdown reader) (Albert Krewinkel).
  • Fixed bug in toRomanNumeral: numbers ending with '9' would be rendered as Roman numerals ending with 'IXIV' (#1249). Thanks to Jesse Rosenthal.
  • openURL: set proxy with value of http_proxy env variable (#1211). Note: proxies with non-root paths are not supported, due to limitations in http-conduit.
  • Text.Pandoc.PDF:
  • Ensure that temp directories deleted on Windows (#1192). The PDF is now read as a strict bytestring, ensuring that process ownership will be terminated, so the temp directory can be deleted.
  • Use / as path separators in a few places, even on Windows. This seems to be necessary for texlive (#1151, thanks to Tim Lin).
  • Use ; for TEXINPUTS separator on Windows (#1151).
  • Changes to error reporting, to handle non-UTF8 error output.
  • Text.Pandoc.Templates:
  • Removed unneeded datatype context (Merijn Verstraaten).
  • YAML objects resolve to "true" in conditionals (#1133).
  • Note: If address is a YAML object and you just have $address$
  • in your template, the word true will appear, which may be
  • unexpected. (Previously nothing would appear.)
  • Text.Pandoc.SelfContained: Handle poster attribute in video
  • tags (#1188).
  • Text.Pandoc.Parsing:
  • Made F an instance of Applicative (#1138).
  • Added stateCaption.
  • Added HasMacros, simplified other typeclasses. Removed updateHeaderMap, setHeaderMap, getHeaderMap, updateIdentifierList, setIdentifierList, getIdentifierList.
  • Changed the smart punctuation parser to return Inlines rather than Inline (Matthew Pickering).
  • Changed HasReaderOptions, HasHeaderMap, HasIdentifierList from typeclasses of monads to typeclasses of states. This simplifies the instance definitions and provides more flexibility. Generalized type of getOption and added a default definition. Removed askReaderOption. Added extractReaderOption. Added extractHeaderMap and updateHeaderMap in HasHeaderMap. Gave default definitions for getHeaderMap, putHeaderMap, modifyHeaderMap. Added extractIdentifierList and updateIdentifierList in HasIdentifierList. Gave defaults for getIdentifierList, putIdentifierList, and modifyIdentifierList. The ultimate goal here is to allow different parsers to use their own, tailored parser states (instead of ParserState) while still using shared functions.
  • Template changes:
  • LaTeX template: Use fontenc package only with pdflatex (#1164).
  • LaTeX template: Add linestretch and fontfamily variables.
  • LaTeX template: Conditionalize author and date commands.
  • Beamer template: Consistent styles for figure and table captions (aaronwolen).
  • LaTeX and beamer template: Adjust widths correctly for oversized images. Use \setkeys{Gin}{} to set appropriate defaults for \includegraphics (Yihui Xie, Garrick Aden-Buie). Load upquote only after fontenc (Yihui Xie).
  • Beamer template: Added caption package (#1200).
  • Beamer template: changes for better unicode handling (KarolS).
  • DocBook template: use authorgroup if there are authors.
  • revealjs template: Move include-after to end (certainlyakey).
  • revealjs template: Fixed PDF print function (#1220, kevinkenan).
  • Bumped version bounds of dependencies.
  • Added a --trace command line option, for debugging backtracking
  • bugs. So far this only works with the markdown reader.
  • MathMLinHTML: Fixed deprecation warning (#362, gwern, Albert Krewinkel).
  • Updated travis script to test with multiple GHC versions.
  • Force failure of a Travis build if GHC produces warnings (AlbertKrewinkel).
  • Add .editorconfig (Albert Krewinkel).
  • Give more useful error message if '-t pdf' is specified (#1155).
  • Added Cite, SmallCaps to Arbitrary instance (#1269).
  • Allow html4 as a synonym of html as a reader (it already works as a writer).
  • README:
  • Added an explanation of how to use YAML metadata to force items to appear in the bibliography without citations in the text (like LaTeX \nocite).
  • Added note to --bibtex/--natbib: not for use in making PDF (#1194, thanks to nahoj).
  • Added explanatory notes about --natbib and --biblatex.
  • Added specification of legal syntax for citation keys.
  • Fixed variable defaults documentation (Albert Krewinkel).
  • Removed copyright statements for files that have been removed (Albert Krewinkel).
  • Moved some doc files from data-files to extra-source-files (#1123).
  • They aren't needed at runtime. We keep README and COPYRIGHT in data to ensure that they'll be available on all systems on which pandoc is installed.

New in Pandoc 1.12.3 (Jan 11, 2014)

  • The --bibliography option now sets the biblio-files variable.
  • Don’t run pandoc-citeproc filter if --bibliography is used together with --natbib or --biblatex.
  • Template changes:
  • Updated beamer template to include booktabs.
  • Added abstract variable to LaTeX template.
  • Put header-includes after title in LaTeX template (#908).
  • Allow use of \includegraphics[size] in beamer. This just required porting a macro definition from the default LaTeX template to the default beamer template.
  • reference.docx: Include FootnoteText style.
  • reference.odt: Tidied styles.xml.
  • Relaxed version bounds for dependencies.
  • Added Cite function to sample.lua.
  • Markdown reader:
  • Fixed regression in title blocks (#1089). If author field was empty, date was being ignored.
  • Allow backslash-newline hard line breaks in grid and multiline table cells.
  • Citation keys may now start with underscores, and may contain underscores adjacent to internal punctuation.
  • LaTeX reader:
  • Add support for Verb macro (jrnold) (#1090).
  • Support babel-style quoting: "`..."'.
  • Properly handle script blocks in strict mode.
  • Docbook reader: Avoid failure if tbody contains no tr or row elements.
  • LaTeX writer:
  • Factored out function for table cell creation.
  • Better treatment of footnotes in tables. Notes now appear in the regular sequence, rather than in the table cell.
  • HTML reader: Parse name/content pairs from meta tags as metadata. Closes #1106.
  • Moved fixDisplayMath from Docx writer to Writer.Shared.
  • OpenDocument writer: Fixed RawInline, RawBlock so they don’t escape.
  • ODT writer: Use mathml for proper rendering of formulas. Note: LibreOffice’s support for this seems a bit buggy. But it should be better than what we had before.
  • RST writer: Ensure no blank line after def in definition list (#992).
  • Markdown writer: Don’t use tilde code blocks with braced attributes in markdown_github output.
  • Docx writer: Fixed problem with some modified reference docx files.
  • HTML writer:
  • With --toc, headers no longer link to themselves (#1081).
  • Omit footnotes from TOC entries. Otherwise we get doubled footnotes when headers have notes!
  • EPUB writer:
  • Avoid duplicate notes when headings contain notes. This arose because the headings are copied into the metadata “title” field, and the note gets rendered twice. We strip the note now before putting the heading in “title”.
  • Strip out footnotes from toc entries.
  • Fixed bug with --epub-stylesheet. Now the contents of writerEpubStylesheet (set by --epub-stylesheet) should again work, and take precedence over a stylesheet specified in the metadata.
  • Text.Pandoc.Pretty: Added nestle. API change.
  • Text.Pandoc.MIME: Added wmf, emf.
  • Text.Pandoc.Shared: fetchItem now handles image URLs beginning with //.
  • Text.Pandoc.ImageSize: Parse EXIF format JPEGs.
  • Removed old MarkdownTest_1.0.3 directory (#1104).

New in Pandoc 1.12.2.1 (Dec 10, 2013)

  • Markdown reader: Fixed regression in list parser, involving continuation lines containing raw HTML (or even verbatim raw HTML).

New in Pandoc 1.12.1.1 (Oct 22, 2013)

  • Text.Pandoc.Definition: Changed default JSON serialization format. Instead of {"Str": "foo"}, for example, we now have {"t": "Str", "c": "foo"}. This new format is easier to work with outside of Haskell. Incidentally, “t” stands for “tag”, “c” for “contents”.
  • MediaWiki reader: Trim contents of tags, to avoid problems when converting to markdown (#1027).
  • LaTeX reader:
  • Ensure that preamble doesn’t contribute to the text of the document.
  • Fixed character escaping in . Previously \~ wasn’t handled properly, among others.
  • Parse {groups} as Span. This is needed for accurate conversion of bibtex titles, since we need to know what was protected from titlecase conversions.
  • LaTeX writer:
  • Specially escape non-ascii characters in labels. Otherwise we can get compile errors and other bugs when compiled with pdflatex (#1007). Thanks to begemotv2718 for the fix.
  • Add link anchors for code blocks with identifiers (#1025).
  • Throughout the code, use isURI instead of isAbsoluteURI. It allows fragments identifiers.
  • Slide formats:
  • A Div element with class “notes” is treated as speaker notes. Currently beamer goes to \note{}, revealjs to , and the notes are simply suppressed in other formats (#925).
  • Fixed . . . (pause) on HTML slide formats. Closes #1029. The old version caused a pause to be inserted before the first material on a slide. This has been fixed.
  • Removed data files for s5, slideous, slidy. Users of s5 and slideous will have to download the needed files, as has been documented for some time in the README. By default, slidy code will be sought on the web, as before.
  • HTML writer: Insert command to typeset mathjax only in slideous output (#966, #1012).
  • RST writer: Skip spaces after display math. Otherwise we get indentation problems, and part of the next paragraph may be rendered as part of the math.
  • OpenDocument writer: Fix formatting of strikeout code (#995), thanks to wilx. don’t use font-face-decls variable.
  • Fixed test suite so it works with cabal sandboxes.

New in Pandoc 1.12.0.2 (Oct 1, 2013)

  • Removed an unused dependency (stringable) from pandoc.cabal. This will help packagers, but users should not need to upgrade.

New in Pandoc 1.12.0.1 (Sep 23, 2013)

  • Allow --metadata to be repeated for the same key to form a list. This also has the effect that --bibliography can be repeated, as before.
  • Handle boolean values in --metadata. Note that anything not parseable as a YAML boolean or string is treated as a literal string.
  • LaTeX writer: Don’t print references if --natbib or --biblatex option used.
  • DOCX writer: Add settings.xml to the zip container. Fixes a bug in which docx files could not be read by some versions of Word and LibreOffice (#990).
  • Fixed a regression involving slide shows with bibliographies. The Div container around references messed up the procedure for carving a document into slides. So we now remove the surrounding Div in prepSlides.
  • More informative error message when a filter is not found in path.
  • Depend on pandoc-types 1.12.1. This provide ToJSONFilter instances for Data a => a -> [a] and Data a => a -> IO [a].
  • Don’t use unicode_collation in building OSX package: it adds something like 50MB of dependencies to the package.
  • Declare alex and happy as build-tools (#986).

New in Pandoc 1.12 (Sep 16, 2013)

  • NEW FEATURES:
  • Much more flexible metadata, including arbitrary fields and structured values. Metadata can be specified flexibly in pandoc markdown using YAML metadata blocks.
  • Added opml (OPML) as input and output format. The _note attribute, used in OmniOutliner and supported by multimarkdown, is supported. We treat the contents as markdown blocks under a section header.
  • Added haddock (Haddock markup) as input format (David Lazar).
  • Added revealjs output format, for reveal.js HTML 5 slide shows. (Thanks to Jamie F. Olson for the initial patch.) Nested vertical stacks are used for hierarchical structure. Results for more than one level of nesting may be odd.
  • Custom writers can now be written in lua.
  • New --filter/-F option to make it easier to run “filters” (Pandoc AST transformations that operate on JSON serializations). Filters are always passed the name of the output format, so their behavior can be tailored to it.
  • Added --metadata/-M option. This is like --variable/-V, but actually adds to metadata, not just variables.
  • Added --print-default-data-file option, which allows printing of any of pandoc’s data files. (For example, pandoc --print-default-data-file reference.odt will print reference.odt.)
  • Added syntax for “pauses” in slide shows.
  • New markdown extensions.
  • BEHAVIOR CHANGES:
  • --toc-level no longer implies --toc. Reason: EPUB users who don’t want a visible TOC may still want to set the TOC level for in the book navigation.
  • --help now prints in and out formats in alphabetical order, and says something about PDF output (#720).
  • --self-contained now returns less verbose output (telling you which URLs it is fetching, but not giving the full header). In addition, there are better error messages when fetching a URL fails.
  • Citation support is no longer baked in to core pandoc. Users who need citations will need to install and use a separate filter (--filter pandoc-citeproc). This filter will take bibliography, csl, and citation-abbreviations from the metadata, though it may still be specified on the command line as before.
  • A Cite element is now created in parsing markdown whether or not there is a matching reference.
  • The pandoc-citeproc script will put the bibliography at the end of the document, as before. However, it will be put inside a Div element with class “references”, allowing users some control over the styling of references. A final header, if any, will be included in the Div.
  • The markdown writer will not print a bibliography if the citations extension is enabled. (If the citations are formatted as markdown citations, it is redundant to have a bibliography, since one will be generated automatically.)
  • Previously we used to store the directory of the first input file, even if it was local, and used this as a base directory for finding images in ODT, EPUB, Docx, and PDF. This has been confusing to many users. So we now look for images relative to the current working directory, even if the first file argument is in another directory. Note that this change may break some existing workflows. If you have been assuming that relative links will be interpreted relative to the directory of the first file argument, you’ll need to make that the current directory before running pandoc. (#942)
  • Better error reporting in some readers, due to changes in readWith: the line in which the error occured is printed, with a caret pointing to the column.
  • All slide formats now support incremental slide view for definition lists.
  • Parse \(..\) and \[..\] as math in MediaWiki reader. Parse :... as display math. These notations are used with the MathJax MediaWiki extension.
  • All writers: template variables are set automatically from metadata fields. However, variables specified on the command line with --variable will completely shadow metadata fields.
  • If --variable is used to set many variables with the same name, a list is created.
  • Man writer: The title, section, header, and footer can now all be set individually in metadata. The description variable has been removed. Quotes have been added so that spaces are allowed in the title.
  • Markdown reader:
  • Added support for YAML metadata blocks, which can come anywhere in the document (not just at the beginning). A document can contain multiple YAML metadata blocks.
  • HTML span and div tags are parsed as pandoc Span and Div elements.
  • Markdown writer:
  • Allow simple tables to be printed as grid tables, if other table options are disabled. This means you can do pandoc -t markdown-pipe_tables-simple_tables-multiline_tables and all tables will render as grid tables.
  • Support YAML title block (render fields in alphabetical order to make output predictable).
  • BUG FIXES:
  • In markdown, don’t autolink a bare URI that is followed by (#937).
  • Text.Pandoc.Shared:
  • openURL now follows redirects (#701), properly handles data: URIs, and prints diagnostic output to stderr rather than stdout.
  • readDefaultDataFile: normalize the paths. This fixes bugs in --self-contained on pandoc compiled with embed_data_files (#833).
  • Fixed readDefaultDataFile so it works on Windows.
  • Better error messages for readDefaultDataFile. Instead of listing the last path tried, which can confuse people who are using --self-contained, so now we just list the data file name.
  • URL-escape pipe characters. Even though these are legal, Network.URI doesn’t regard them as legal in URLs. So we escape them first (#535).
  • Mathjax in HTML slide shows: include explicit “Typeset” call. This seems to be needed for some formats (e.g. slideous) and won’t hurt in others (#966).
  • Text.Pandoc.PDF:
  • Put temporary output directory in TEXINPUTS (see #917).
  • makePDF tries to download images that are not found locally, if the first argument is a URL (#917).
  • If compiling with pdflatex yields an encoding error, offer the suggestion to use --latex-engine=xelatex.
  • Produce automatic header identifiers in parsing textile, RST, and LaTeX, unless auto_identifiers extension is disabled (#967).
  • Text.Pandoc.SelfContained: Strip off fragment, query of relative URL before treating as a filename.
  • Text.Pandoc.Parsing: uri parser no longer treats punctuation before percent-encoding, or a + character, as final punctuation.
  • Text.Pandoc.ImageSize: Handle EPS (#903). This change will make EPS images properly sized on conversion to Word.
  • Slidy: Use slidy.js rather than slidy.js.gz. Reason: some browsers have trouble with the gzipped js file, at least on the local file system (#795).
  • Markdown reader:
  • Properly handle blank line at beginning of input (#882).
  • Fixed bug in unmatched reference links. The input [*infile*] [*outfile*] was getting improperly parsed: “infile” was emphasized, but “outfile” was literal (#883).
  • Allow internal + in citation identifiers (#856).
  • Allow . or ) after # in ATX headers if no fancy_lists.
  • Do not generate blank title, author, or date metadata elements. Leave these out entirely if they aren’t present.
  • Allow backtick code blocks not to be preceded by blank line (#975).
  • Textile reader:
  • Correctly handle entities.
  • Improved handling of blocks (#927). Remove internal HTML tags in code blocks, rather than printing them verbatim. Parse attributes on tag for code blocks.
  • HTML reader: Handle non-simple tables (#893). Column widths are read from col tags if present, otherwise divided equally.
  • LaTeX reader
  • Support alltt environment (#892).
  • Support \textasciitilde, \textasciicircum (#810).
  • Treat \textsl as emphasized text reader (#850).
  • Skip positional options after \begin{figure}.
  • Support \v{} for hacek (#926).
  • Don’t add spurious “,” to citation suffixes. This is added when needed in pandoc-citeproc.
  • Allow spaces in alignment spec in tables, e.g. { l r c }.
  • Improved support for accented characters (thanks to Scott Morrison).
  • Parse label after section command and set id (#951).
  • RST reader:
  • Don’t insert paragraphs where docutils doesn’t. rst2html doesn’t add tags to list items (even when they are separated by blank lines) unless there are multiple paragraphs in the list. This commit changes the RST reader to conform more closely to what docutils does (#880).
  • Improved metadata. Treat initial field list as metadata when standalone specified. Previously ALL fields “title”, “author”, “date” in field lists were treated as metadata, even if not at the beginning. Use subtitle metadata field for subtitle.
  • Fixed ‘authors’ metadata parsing in reST. Semicolons separate different authors.
  • MediaWiki reader:
  • Allow space before table rows.
  • Fixed regression for URL. < is no longer allowed in URLs, according to the uri parser in Text.Pandoc.Parsing. Added a test case.
  • Correctly handle indented preformatted text without preceding or following blank line.
  • Fixed | links inside table cells. Improved attribute parsing.
  • Skip attributes on table rows. Previously we just crashed if rows had attributes, now we ignore them.
  • Ignore attributes on headers.
  • Allow Image: for images (#971).
  • Parse an image with caption in a paragraph by itself as a figure.
  • LaTeX writer:
  • Don’t use ligatures in escaping inline code.
  • Fixed footnote numbers in LaTeX/PDF tables. This fixes a bug wherein notes were numbered incorrectly in tables (#827).
  • Always create labels for sections. Previously the labels were only created when there were links to the section in the document (#871).
  • Stop escaping | in LaTeX math. This caused problems with array environments (#891).
  • Change \ to / in paths. / works even on Windows in LaTeX. \ will cause major problems if unescaped.
  • Write id for code block to label attribute in LaTeX when listings is used (thanks to Florian Eitel).
  • Scale LaTeX tables so they don’t exceed columnwidth.
  • Avoid problem with footnotes in unnumbered headers (#940).
  • Beamer writer: when creating beamer slides, add allowframebreaks option to the slide if it is one of the header classes.
  • ConTeXt writer: Properly handle tables without captions. The old output only worked in MkII. This should work in MkIV as well (#837).
  • MediaWiki writer: Use native mediawiki tables instead of HTML (#720).
  • HTML writer:
  • Fixed --no-highlight (Alexander Kondratskiy).
  • Don’t convert to lowercase in email obfuscation (#839).
  • Ensure proper escaping in and fields.
  • AsciiDoc writer:
  • Support --atx-headers (Max Rydahl Andersen).
  • Don’t print empty identifier blocks ([[]]) on headers (Max Rydahl Andersen).
  • ODT writer:
  • Fixing wrong numbered-list indentation in open document format (Alexander Kondratskiy) (#369).
  • reference.odt: Added pandoc as “generator” in meta.xml.
  • Minor changes for ODF 1.2 conformance (#939). We leave the nonconforming contextual-spacing attribute, which is provided by LibreOffice itself and seems well supported.
  • Docx writer:
  • Fixed rendering of display math in lists. In 1.11 and 1.11.1, display math in lists rendered as a new list item. Now it always appears centered, just as outside of lists, and in proper display math style, no matter how far indented the containing list item is (#784).
  • Use w:br with w:type textWrapping for linebreaks. Previously we used w:cr (#873).
  • Use Compact style for Plain block elements, to differentiate between tight and loose lists (#775).
  • Ignore most components of reference.docx. We take the word/styles.xml, docProps/app.xml, word/theme/theme1.xml, and word/fontTable.xml from reference.docx, ignoring everything else. This should help with the corruption problems caused when different versions of Word resave the reference.docx and reorganize things.
  • Made --no-highlight work properly.
  • EPUB writer"
  • Don’t add dc:creator tags if present in EPUB metadata.
  • Add id="toc-title" to h1 in nav.xhtml (#799).
  • Don’t put blank title page in reading sequence. Set linear="no" if no title block. Addresses #797.
  • Download webtex images and include as data URLs. This allows you to use --webtex in creating EPUBs. Math with --webtex is automatically made self-contained.
  • In data/epub.css, removed highlighting styles (which are no longer needed, since styles are added by the HTML writer according to --highlighting-style). Simplified margin fields.
  • If resource not found, skip it, as in Docx writer (#916).
  • RTF writer:
  • Properly handle characters above the 0000-FFFF range. Uses surrogate pairs. Thanks to Hiromi Ishii for the patch.
  • Fixed regression with RTF table of contents.
  • Only autolink absolute URIs. This fixes a regression, #830.
  • Markdown writer:
  • Only autolink absolute URIs. This fixes a regression, #830.
  • Don’t wrap attributes in fenced code blocks.
  • Write full metadata in MMD style title blocks.
  • Put multiple authors on separate lines in pandoc titleblock. Also, don’t wrap long author entries, as new lines get treated as new authors.
  • Text.Pandoc.Templates:
  • Fixed bug retrieving default template for markdown variants.
  • Templates can now contain “record lookups” in variables; for example, author.institution will retrieve the institution field of the author variable.
  • More consistent behavior of $for$. When foo is not a list, $for(foo)$...$endfor$ should behave like if(foo)…endif. So if foo resolves to “”, no output should be produced. See pandoc-templates#39.
  • Citation processing improvements (now part of pandoc-citeproc):
  • Fixed endWithPunct The new version correctly sees a sentence ending in ‘.)’ as ending with punctuation. This fixes a bug which led such sentences to receive an extra period at the end: ‘.).’. Thanks to Steve Petersen for reporting.
  • Don’t interfere with Notes that aren’t citation notes. This fixes a bug in which notes not generated from citations were being altered (e.g. first letter capitalized) (#898).
  • Only capitalize footnote citations when they have a prefix.
  • Changes in suffix parsing. A suffix beginning with a digit gets ‘p’ inserted before it before passing to citeproc-hs, so that bare numbers are treated as page numbers by default. A suffix not beginning with punctuation has a space added at the beginning (rather than a comma and space, as was done before for not-author-in-text citations). The result is that \citep[23]{item1} in LaTeX will be interpreted properly, with ‘23’ treated as a locator of type ‘page’.
  • Many improvements to citation rendering, due to fixes in citeproc-hs (thanks to Andrea Rossato).
  • Warnings are issued for undefined citations, which are rendered as ???.
  • Fixed hanging behavior when locale files cannot be found.

New in Pandoc 1.11.1 (Mar 18, 2013)

  • HTML writer: Fixed numbering mismatch between TOC and sections. --number-offset now affects TOC numbering as well as section numbering, as it should have all along. Closes #789.
  • Markdown writer: Reverted 1.11 change that caused citations to be rendered as markdown citations, even if --bibliography was specified, unless citation extension is disabled. Now, formatted citations are always printed if --bibliography was specified. If you want to reformat markdown keeping pandoc markdown citations intact, don’t use --bibliography. Note that citations parsed from LaTeX documents will be rendered as pandoc markdown citations when --bibliography is not specified.
  • ODT writer: Fixed regression leading to corrupt ODTs. This was due to a change in the Show instance for Text.Pandoc.Pretty.Doc. Closes #780.
  • Fixed spacing bugs involving code block attributes in RST reader and Markdown writer. Closes #763.
  • Bumped QuickCheck version bound.
  • Markdown reader:
  • Fixed regression in which parentheses were lost in link URLs. Added tests. Closes #786.
  • Better handling of unmatched double quotes in --smart mode. These occur frequently in fiction, since it is customary not to close quotes in dialogue if the speaker does not change between paragraphs. The unmatched quotes now get turned into literal left double quotes. (No Quoted inline is generated, however.) Closes #99 (again).

New in Pandoc 1.11b (Mar 11, 2013)

  • Added --number-offset option. (See README for description.)
  • Added --default-image-extension option. (See README for description.)
  • --number-sections behavior change: headers with class unnumbered will not be numbered.
  • --version now reports the default data directory.
  • Text.Pandoc.Parsing is no longer exposed. (API change.)
  • Text.Pandoc.Highlighting is no longer exposed. (API change.)
  • Text.Pandoc.Shared: Changed type of Element. Sec now includes a field for Attr rather than just String. (API change.)
  • Added markdown_github as input format. This was an accidental omission in 1.10.
  • Added readerDefaultImageExtension field to ReaderOptions. (API change.)
  • Added writerNumberOffset field in WriterOptions. (API change.)
  • Beamer template:
  • Fixed captions with longtable. Thanks to Joost Kremers.
  • Provide \Oldincludegraphics as in LaTeX template (Benjamin Bannier).
  • LaTeX template:
  • Load microtype after fonts. Microtype needs to know what fonts are being used. Thanks to dfc for the patch.
  • Set secnumdepth to 5 if --number-sections specified. This yields behavior equivalent to the other writers, numbering level 4 and 5 headers too. Closes #753.
  • HTML reader:
  • Handle tag.
  • Preserve all header attributes.
  • LaTeX reader:
  • Parse \hrule as HorizontalRule. Closes #746.
  • Parse starred variants of \section etc. as headers with attribute unnumbered.
  • Read optional attributes in lstlisting and Verbatim environments. We convert these to pandoc standard names, e.g. numberLines for numbers=left, startFrom=100 from firstnumber=100.
  • Handle language attribute for lstlistings.
  • Better support for Verbatim and minted environments. Closes #763.
  • Markdown reader:
  • - in an attribute context = .unnumbered. The point of this is to provide a way to specify unnumbered headers in non-English documents.
  • Fixed bug parsing key/value attributes. Parsing failed if you had an unquoted attribute immediately before the final ‘}’.
  • Make backslash escape work in attributes.
  • Fix title block parsing. Now if mmd_title_blocks is specified, pandoc will parse a MMD title block if it sees one, even if pandoc_title_blocks is enabled.
  • Refactoring: litChar now includes entities, so we don’t need to use fromEntities e.g. on titles.
  • Allow spaces around borders in pipe tables. Closes #772.
  • Allow all punctuation in angle-bracket autolinks. Previously things like ---- were disallowed, because the uri parser treated them as trailing punctuation. Closes #768.
  • Make implicit_header_references work properly when headers are given explicit identifiers.
  • Check for tables before line blocks. Otherwise some pipe tables get treated as line blocks.
  • Allow & in emails (for entities).
  • Properly handle entities in titles and links. A markdown link should be a link to http://göogle.com. Closes #723.
  • Textile reader:
  • Handle attributes on headers.
  • LaTeX reader:
  • Add fig: as title for images with captions. This is needed for them to be rendered as figures. Closes #766.
  • Never emit an empty paragraph. See #761.
  • Handle \caption for images in figures. Closes #766.
  • Parse \section*, etc. as unnumbered sections.
  • HTML writer:
  • Support header attributes. The attributes go on the enclosing section or div tag if --section-divs is specified.
  • Fixed a regression (only now noticed) in html+lhs output. Previously the bird tracks were being omitted.
  • LaTeX writer:
  • Omit lists with no items to avoid LaTeX errors.
  • Support line numbering with --listings. If numberLines class is present, we add numbers=left; if startFrom is present, we add firstnumber=. (#763)
  • ConTeXt writer:
  • Removed \placecontent. This produced a duplicate toc, in conjunction with \placelist.
  • Use \title, \subject etc. for headers with unnumbered class.
  • Textile writer:
  • Support header attributes.
  • Markdown writer:
  • Use grid tables when needed, and if enabled. Closes #740.
  • Render citations as pandoc-markdown citations. Previously citations were rendered as citeproc-formatted citations by default. Now we render them as pandoc citations, e.g. [@item1], unless the citations extension is disabled. If you still want formatted citations in your markdown output, use pandoc -t markdown-citations.
  • RST writer:
  • Support :number-lines: in code blocks.
  • Docx writer:
  • Better treatment of display math. Display math inside a paragraph is now put in a separate paragraph, so it will render properly (centered and without extra blank lines around it). Partially addresses #742.
  • Content types and document rels xml files are now created from scratch, rather than being taken over from reference.docx. This fixes problems that arise when you edit the reference.docx with Word.
  • We also now encode mime types for each individual image rather than using defaults. This should allow us to handle a wider range of image types (including PDF). Closes #414.
  • Changed style names in reference docx. FootnoteReference -> FootnoteRef, Hyperlink -> Link. The old names got changed by Word when the reference.docx was edited. Closes #414.
  • EPUB writer:
  • Fix section numbering. Previously the numbering restarted from 1 in each chapter (with --number-sections), though the numbers in the table of contents were correct.
  • Headers with “unnumbered” attribute are not numbered. (Nor do they cause an increment in running numbering.) Section numbers now work properly, even when there is material before the first numbered section.
  • Include HTML TOC, even in epub2. The TOC is included in , but linear is set to no unless the --toc option is specified. Include element in OPF. This should allow the TOC to be useable in Kindles when converted with kindlegen. Closes #773.
  • Text.Pandoc.Parsing: Optimized oneOfStringsCI. This dramatically reduces the speed penalty that comes from enabling the autolink_bare_uris extension. The penalty is still substantial (in one test, from 0.33s to 0.44s), but nowhere near what it used to be. The RST reader is also much faster now, as it autodetects URIs.
  • Text.Pandoc.Shared: hierarchicalize will not number section with class “unnumbered”. Unnumbered sections get [] for their section number.
  • Text.Pandoc.Pretty:
  • Fixed chomp so it works inside Prefixed elements.
  • Changed Show instance so it is better for debugging.
  • Text.Pandoc.ImageSize: Added Pdf to ImageType.
  • Text.Pandoc.UTF8: Strip off BOM if present. Closes #743.
  • Windows installer improvements:
  • The installer is now signed with a certificate (thanks to Fyodor Sheremetyev).
  • WiX is used instead of InnoSetup. The installer is now a standard msi file.
  • The version number is now auto-detected, and need not be updated separately.
  • OSX installer improvements:
  • The package and pandoc executable are now signed with a certificate (thanks to Fyodor Sheremetyev).
  • RTF version of license is used.
  • Use full path for sysctl in InstallationCheck script (jonahbull). Closes #580.
  • Converted COPYING to markdown.
  • pandoc.cabal: Require latest versions of highlighting-kate, texmath, citeproc-hs, zip-archive.

New in Pandoc 1.10.1 (Jan 29, 2013)

  • Markdown reader: various optimizations, leading to a significant performance boost.
  • RST reader: Allow anonymous form of inline links: `hello `__ Closes #724.
  • Mediawiki reader: Don’t require newlines after tables. Thanks to jrunningen for the patch. Closes #733.
  • Fixed LaTeX macro parsing. Now LaTeX macro definitions are preserved when output is LaTeX, and applied when it is another format. Partially addresses #730.
  • Markdown and RST readers: Added parser to block that skips blank lines. This fixes a subtle regression involving grid tables with empty cells. Also added test for grid table with empty cells. Closes #732.
  • RST writer: Use .. code:: language for code blocks with language. Closes #721.
  • DocBook writer: Fixed output for hard line breaks, adding a newline between tags.
  • Markdown writer: Use an autolink when link text matches url. Previously we also checked for a null title, but this test fails for links produced by citeproc-hs in bibliographies. So, if the link has a title, it will be lost on conversion to an autolink, but that seems okay.
  • Markdown writer: Set title, author, date variables as before. These are no longer used in the default template, since we use titleblock, but we set them anyway for those who use custom templates.
  • LaTeX writer: Avoid extra space at start/end of table cell. Thanks to Nick Bart for the suggestion of using @{}.
  • Relaxed old-time version bound, allowing 1.0.*.
  • Removed obsolete hsmarkdown script. Those who need hsmarkdown should create a symlink as described in the README.
  • Text.Pandoc.Parsing:
  • More efficient version of anyLine.
  • Type of macro has changed; the parser now returns Blocks instead of Block.

New in Pandoc 1.10.0.5 (Jan 24, 2013)

  • Markdown reader: Try lhsCodeBlock before rawTeXBlock. Otherwise \begin{code}...\end{code} isn’t handled properly in markdown+lhs. Thanks to Daniel Miot for noticing the bug and suggesting the fix.
  • Markdown reader: Fixed bug with headerless grid tables. The 1.10 code assumed that each table header cell contains exactly one block. That failed for headerless tables (0) and also for tables with multiple blocks in a header cell. The code is fixed and tests provided. Thanks to Andrew Lee for pointing out the bug.
  • LaTeX template: Use \urlstyle{same} to avoid monospace URLs.
  • Markdown writer: Use proportional font for email autolinks with obfuscation. Closes #714.
  • Corrected name of blank_before_blockquote in README. Closes #718.
  • Text.Pandoc.Shared: Fixed bug in uri parser. The bug prevented an autolink at the end of a string (e.g. at the end of a line block line) from counting as a link. Closes #711.
  • Use the hsb2hs preprocessor instead of TH for embed_data_files. This should work on Windows, unlike the TH solution with file-embed.
  • Eliminated use of TH in test suite.
  • Added Text.Pandoc.Data (non-exported) to hold the association list of embedded data files, if the embed_data_files flag is selected. This isolates the code that needs special treatment with file-embed or hsb2hs.
  • Fixed EPUB writer so it builds with blaze-html 0.4.x. Thanks to Jens Petersen.
  • Markdown reader: Fixed regressions in fenced code blocks. Closes #722:
  • Tilde code fences can again take a bare language string (~~~ haskell), not just curly-bracketed attributes (~~~ {.haskell}).
  • Backtick code blocks can take the curly-bracketed attributes.
  • Backtick code blocks don’t require a language.
  • Consolidated code for the two kinds of fenced code blocks.
  • Changes to make-windows-installer.bat.:
  • Exit batch file if any of the cabal-dev installs fail.
  • There’s no longer any need to reinstall highlighting-kate.
  • Don’t start with a cabal update; leave that to the user.
  • Force reinstall of pandoc.

New in Pandoc 1.10.0.4 (Jan 21, 2013)

  • Fixed bug with escaped % in LaTeX reader. Closes #710.

New in Pandoc 1.9.4.2 (Jul 2, 2012)

  • Don’t encode/decode file paths if base >= 4.4. Prior to base 4.4, filepaths and command line arguments were treated as unencoded lists of bytes, not unicode strings, so we had to work around that by encoding and decoding them. This commit adds CPP checks for the base version that intelligibly enable encoding/decoding when needed. Fixes a bug with multilingual filenames when pandoc was compiled with ghc 7.4 (#540).
  • Don’t generate an empty H1 after hrule slide breaks. We now use a slide-level header with contents [Str "\0"] to mark an hrule break. This avoids creation of an empty H1 in these contexts. Closes #484.
  • Docbook reader: Added support for “bold” emphasis. Thanks to mb21.
  • In make_osx_package.sh, ensure citeproc-hs is built with the embed_data_files flag.
  • MediaWiki writer: Avoid extra blank lines after sublists (Gavin Beatty).
  • ConTeXt writer: Don’t escape &, ^, , _, simplified escapes for } and { to \{ and \} (Aditya Mahajan).
  • Fixed handling of absolute URLs in CSS imports with --self-contained. Closes #535.
  • Added webm to mime types. Closes #543.
  • Added some missing exports and tests to the cabal file (Alexander V Vershilov).
  • Compile with -rtsopts and -threaded by default.

New in Pandoc 1.9.4.1 (Jun 25, 2012)

  • Markdown reader: Added cf. and cp. to list of likely abbreviations.
  • LaTeX template: Added linkcolor, urlcolor and links-as-notes variables. Make TOC links black.
  • LaTeX template improvements:
  • Don’t print date unless one is given explicitly in the document.
  • Simplified templates.
  • Use fontenc [T1] by default, and lmodern.
  • Use microtype if available.
  • Biblio:
  • Add comma to beginning of bare suffix, e.g. @item1 [50]. Motivation: @item1 [50] should be as close as possible to [@item1, 50].
  • Added workaround for a bug in citeproc-hs 0.3.4 that causes footnotes beginning with a citation to be empty. Closes #531.
  • Fixed documentation on mixed lists. Closes #533.

New in Pandoc 1.9.4 (Jun 5, 2012)

  • Simplified Text.Pandoc.Biblio and fixed bugs with citations inside footnotes and captions. We now handle note citations by inserting footnotes during initial citation processing, and doing a separate pass later to remove notes inside notes.
  • Added ‘zenburn’ highlight style from highlighting-kate.
  • Added Slideous writer. Slideous is an HTML + javascript slide show format, similar to Slidy, but works with IE 7. (Jonas Smedegaard)
  • Beamer writer: When --incremental is used, lists inside a block quote should appear all at once. (This makes Beamer output consistent with the HTML slide show formats.)
  • Org writer: Add space before language name. Closes #523.
  • Docx writer: Simplified bullet characters so they work properly with Word 2007. Closes #520.
  • LaTeX reader: Support \centerline.
  • RST reader: handle figures. Closes #522.
  • Textile reader: fix for and ==. Closes #517. (Paul Rivier)
  • ConTeXt writer:
  • Escape % as \letterpercent{} not \letterpercent, to avoid gobbling spaces after the % sign.
  • Ensure space after \stopformula.
  • Markdown writer:
  • Use : form instead of ~ in definition lists, for better compatibility with other markdown implementations.
  • Don’t wrap the term, because it breaks definition lists.
  • Use a nonzero space to prevent false recognition of list marker in ordered lists. Closes #516.
  • LaTeX writer:
  • Ensure we don’t have extra blank lines at ends of cells. This can cause LaTeX errors, as they are interpreted as new paragraphs.
  • More consistent interblock spacing.
  • Require highlighting-kate >= 0.5.1, for proper highlighted inline code in LaTeX. Closes #527.
  • Ensure that a Verbatim at the end of a footnote is followed by a newline. (Fixes a regression in the previous version.)
  • In default template, use black for internal links and TOC. Added commented-out code to use footnotes for links, as would be suitable in print output.

New in Pandoc 1.9.3 (May 14, 2012)

  • Added docbook reader (with contributions from Mauro Bieg).
  • Fixed bug in fromEntities. The previous version would turn hi & low you know; into hi &.
  • HTML reader:
  • Don’t skip nonbreaking spaces. Previously a paragraph containing just   would be rendered as an empty paragraph. Thanks to Paul Vorbach for pointing out the bug.
  • Support and in tables. Closes #486.
  • Markdown reader:
  • Don’t recognize references inside delimited code blocks.
  • Allow list items to begin with lists.
  • LaTeX reader:
  • Handle \bgroup, \egroup, \begingroup, \endgroup.
  • Control sequences can’t be followed by a letter. This fixes a bug where \begingroup was parsed as \begin followed by group.
  • Parse ‘dimension’ arguments to unknown commands. e.g. \parindent0pt
  • Make \label and \ref sensitive to --parse-raw. If --parse-raw is selected, these will be parsed as raw latex inlines, rather than bracketed text.
  • Don’t crash on unknown block commands (like \vspace{10pt}) inside \author; just skip them. Closes #505.
  • Textile reader:
  • Implemented literal escapes with == and . Closes #473.
  • Added support for LaTeX blocks and inlines (Paul Rivier).
  • Better conformance to RedCloth inline parsing (Paul Rivier).
  • Parse ‘+text+’ as emphasized (should be underlined, but this is better than leaving literal plus characters in the output.
  • Docx writer: Fixed multi-paragraph list items. Previously they each got a list marker. Closes #457.
  • LaTeX writer:
  • Added --no-tex-ligatures option to avoid replacing quotation marks and dashes with TeX ligatures.
  • Use fixltx2e package to provide ‘’.
  • Improve spacing around LaTeX block environments: quote, verbatim, itemize, description, enumerate. Closes #502.
  • Use blue instead of pink for URL links in latex/pdf output.
  • ConTeXt writer: Fixed escaping of %. In text, % needs to be escaped as \letterpercent, not \% Inside URLs, % needs to be escaped as \% Thanks to jmarca and adityam for the fix. Closes #492.
  • Texinfo writer: Escape special characters in node titles. This fixes a problem pointed out by Joost Kremers. Pandoc used to escape an ‘@’ in a chapter title, but not in the corresponding node title, leading to invalid texinfo.
  • Fixed document encoding in texinfo template. Resolves Debian Bug #667816.
  • Markdown writer:
  • Don’t force delimited code blocks to be flush left. Fixes bug with delimited code blocks inside lists etc.
  • Escape < and $.
  • LaTeX writer: Use \hyperref[ident]{text} for internal links. Previously we used \href{\#ident}{text}, which didn’t work on all systems. Thanks to Dirk Laurie.
  • RST writer: Don’t wrap link references. Closes #487.
  • Updated to use latest versions of blaze-html, mtl.

New in Pandoc 1.9.2 (Apr 6, 2012)

  • LaTeX reader:
  • Made lstlisting work as a proper verbatim environment.
  • Fixed bug parsing LaTeX tables with one column.
  • LaTeX writer:
  • Use {} around ctable caption, so that formatting can be used.
  • Don’t require eurosym package unless document has a €.
  • LaTeX template:
  • Added variables for geometry, romanfont, sansfont, mathfont, mainfont so users can more easily customize fonts.
  • PDF writer:
  • Run latex engine at least two times, to ensure that PDFs will have hyperlinked bookmarks.
  • Added PDF metadata (title,author) in LaTeX standalone + PDF output.
  • Texinfo writer:
  • retain directories in image paths. (Peter Wang)
  • RST writer:
  • Better handling of inline formatting, in accord with docutils’ “inline markup recognition rules” (though we don’t implement the unicode rules fully). Now hi*there*hi gets rendered properly as hi\ *there*\ hi, and unnecessary \ are avoided around :math:, :sub:, :sup:.
  • RST reader:
  • Parse \ as null, not escaped space.
  • Allow :math:`...` even when not followed by blank or \. This does not implement the complex rule docutils follows, but it should be good enough for most purposes.
  • Add support for the rST default-role directive. (Greg Maslov)
  • Text.Pandoc.Parsing: Added stateRstDefaultRole field to ParserState. (Greg Maslov)
  • Markdown reader: Properly handle citations nested in other inline elements.
  • Markdown writer: don’t replace empty alt in image with “image”.
  • DZSlides: Updated template.html and styles in default template. Removed bizarre CSS for q in dzslides template.
  • Avoid repeated id attribute in section and header in HTML slides.
  • README improvements: new instructions on internal links, removed misleading note on reST math.
  • Build system:
  • Fixed Windows installer so that dzslides works.
  • Removed stripansi.sh.
  • Added .travis.yml for Travis continuous integration support..
  • Fixed upper bound for zlib (Sergei Trofimovich).
  • Fixed upper bound for test-framework.
  • Updated haddocks for haddock-2.10 (Sergei Trofimovich).

New in Pandoc 1.9.1.2 (Mar 10, 2012)

  • Added beamer+lhs as output format.
  • Don’t escape < in tags with --self-contained. This fixes a bug which prevented highlighting from working when using --self-contained.
  • PDF: run latex engine three times if --toc specified. This fixes page numbers in the table of contents.
  • Docx writer: Added TableNormal style to tables.
  • LaTeX math environment fixes. aligned is now used instead of the nonexistent aligned*. multline instead of the nonexistent multiline.
  • LaTeX writer: Use \textasciitilde for literal ~.
  • HTML writer: Don’t escape contents of EQ tags with –gladtex. This fixes a regression from 1.8.
  • Use tags for Quoted items for HTML5 output. The quote style can be changed by modifying the template or including a css file. A default quote style is included.
  • LaTeX reader: Fixed accents (~{a}, \c{c}). Correctly handle ^{}. Support “minted” as a LaTeX verbatim block.
  • Updated LaTeX template for better language support. Use polyglossia instead of babel with xetex. Set lang as documentclass option. \setmainlanguage will use the last of a comma-separated list of languages. Thanks to François Gannaz.
  • Fixed default LaTeX template so \euro and € work. The eurosym package is needed if you are using pdflatex.
  • Fixed escaping of period in man writer (thanks to Michael Thompson).
  • Fixed list label positions in beamer.
  • Set mainlang variable in context writer. This parallels behavior of latex writer. mainlang is the last of a comma-separated list of languages in lang.
  • EPUB language metadat: convert e.g. en_US from locale to en-US.
  • Changed -V so that you can specify a key without a value. Such keys get the value true.
  • Fixed permissions on installed man pages - thanks Magnus Therning.
  • Windows installer: require XP or higher. The installer is now compiled on a Windows 7 machine, which fixes a problem using citation functions on Windows 7.
  • OSX package: Check for 64-bit Intel CPU before installing.

New in Pandoc 1.9.1.1 (Feb 14, 2012)

  • Better handling of raw latex environments in markdown. Now
  • \begin{equation}
  • a_1
  • \end{equation}
  • turns into a raw latex block as expected.
  • Improvements to LaTeX reader:
  • Skip options after block commands.
  • Correctly handle {\\} in braced.
  • Added a needed ‘try’.
  • Citations: add , to suffix if it doesn’t start with space or punctuation. Otherwise we get no space between the year and the suffix in author-date styles.
  • Added two needed data files for S5. This fixes a problem with pandoc -t s5 --self-contained. Also removed slides.min.js, which was no longer being used.
  • Fixed some minor problems in reference.docx: name on “Date” style, xCs instead of xIs.
  • Fixed a problem creating docx files using a reference docx modified using Word. The problem seems to be that Word modifies _rels/.rels, changing the Type of the Relationship to docProps/core.xml. Pandoc now changes this back to the correct value if it has been altered, fixing the problem.
  • Fixed html5 template so it works properly with highlighting.

New in Pandoc 1.9.0.5 (Feb 9, 2012)

  • Changed cabal file so that build-depends for the test program are not required unless the tests flag is used.
  • LaTeX writer: insert {} between adjacent hyphens so they don’t form ligatures (dashes) in code spans.

New in Pandoc 1.8.2 (Aug 2, 2011)

  • Added script to produce OS X package.
  • Made templates directory a git submodule. This should make it easier for people to revise their custom templates when the default templates change.
  • Changed template naming scheme: FORMAT.template -> default.FORMAT. Note: If you have existing templates in ~/.pandoc/templates, you must rename them to conform to the new scheme!

New in Pandoc 1.8.1.1 (Jul 15, 2011)

  • Removed some debugging lines accidentally included. With those lines, the temp directory is created in the working directory, and it is not deleted. This fix restores the original behavior.

New in Pandoc 1.2.1 (Jul 20, 2009)

  • Fixed regression with --preserveTabs. Brought back optPreserveTabs.
  • The trick of setting tabStop to 0 to mean "preserve tabs" had a bad
  • side effect: strings of 0 spaces were interpreted as indentation.
  • So, with --preserve-tabs, unindented paragraphs were treated as
  • code. Resolves Issue #138.
  • HTML writer: wrap sections in divs. Resolves Issue #70.
  • hierarchicalize has been rationalized; it builds a hierarchical
  • representation of the document from the headers, and simultaneously
  • gives each section a unique identifier based on the heading title.
  • Identifiers are now attached to the divs rather than
  • to the headers themselves.
  • Table of content backlinks go to the beginning of the table, rather
  • than to the section reference that was clicked.
  • Code for constructing identifiers has been moved to Text.Pandoc.Shared
  • from the HTML writer, since it is now consumed only by
  • hierarchical means.
  • In --strict mode, pandoc just prints bare headings, as before
  • (unless --toc has been specified).
  • In s5 output, it does not wrap sections in divs, as that seems to
  • confuse the s5 javascript.
  • Man writer: break lines at end of each sentence. groff expects this
  • and treats '.' and '?' differently when followed by line ending as
  • opposed to ordinary space. Also, don't escape periods. Instead, use
  • zero-width character & to avoid unwanted interpretation of periods
  • at start of line. Resolves Issue #148.
  • Markdown writer: Added '#' and '>' to list of characters to be
  • escaped in markdown output. Removed '

New in Pandoc 1.2 (Mar 2, 2009)

  • Added support for literate Haskell. lhs support is triggered by '+lhs' suffixes in formats. For example, 'latex+lhs' is literate Haskell LaTeX. '.lhs' files are treated by default as literate markdown.
  • Added stateLiterateHaskell to parser state.
  • Added parser for lhsCodeBlock to Markdown, RST, LaTeX readers.
  • Added parser for |inline lhs| to LaTeX reader.
  • Added writerLiterateHaskell to WriterOptions.
  • Added lhs support to Markdown, RST, LaTeX, HTML writers.
  • Added definition of code environment to LaTeX header.
  • Added tests (run only if highlighting support compiled in).
  • Documented lhs features in man page and README.
  • In Text.Pandoc.Definition, added processWith, processWithM, and queryWith, and deprecated processPandoc and queryPandoc for these more general functions.
  • Fixed bug in mediawiki writer: improper closing tags in tables. Thanks to Benct Philip Jonsson for reporting the bug.
  • Added --email-obfuscation option.
  • Added writer option for email obfuscation.
  • Implemented email obfuscation options in HTML writer.
  • Added option to option parser.
  • Documented in README and pandoc man page.
  • LaTeX writer: fixed bug with empty table cells. Resolves Issue #107. Thanks to rodja.trappe for the patch.
  • Fixed bug with header spacing in Markdown and RST writers. A null header (Meta [] [] []) should not cause a blank line at the beginning of output. But a blank line is needed between a non-null header and the main text.
  • Markdown reader: Relax spacing rules for $$ in display math. Now space and newlines are allowed after the opening $$ and before the closing $$. However, the display math cannot contain an entirely blank line. Resolves Issue #105.
  • Markdown reader: Gobble space after Plain blocks containing only raw html inline. Otherwise following header blocks are not parsed correctly, since the parser sees blank space before them. Resolves Issue #124.
  • Markdown reader: Allow " as well as '' to end a latex double-quote.
  • Conditionally depend on syb and base >= 4 if ghc >= 6.10. Resolves Issue #109.
  • Fixed problems in RST and markdown output due to bug in pretty-1.0.1.0
  • Added hang' function to Text.Pandoc.Shared; this will be used instead of hang, which doesn't work properly in pretty-1.0.1.0. When pretty is upgraded, we can go back to hang. See http://article.gmane.org/gmane.comp.lang.haskell.general/16687
  • Use hang' (and some different techniques) in RST and markdown writers. Some output is now a bit different.
  • Brought citeproc support up to date for citeproc-hs-0.2. (Patch by Andrea Rossato.)
  • Moved all haskell source to src subdirectory. Renamed Main.hs to pandoc.hs.
  • Rewrote hsmarkdown in Haskell for portability (src/hsmarkdown.hs). For now, keeping the old shell script too.
  • Added TemplateHaskell to Extensions for executable, removed -threaded for library. Thanks to duncan.coutts for the bug report. Resolves Issue #121.
  • Moved some Extra-Source-Files to Data-Files.
  • Moved tabFilter to Shared.
  • In pandoc.hs, removed optPreserveTabs; instead, tabstop of 0 means preserve tabs.
  • Minor code cleanup based on hlint suggestions.

New in Pandoc 1.1 (Nov 20, 2008)

  • Main.hs:
  • Changed date on copyright message in Main.hs.
  • Have the '-v' option print syntax highlighting languages separated by commas, and wrapped in lines, instead of in five columns as before.
  • Added --jsmath option. Resolves Issue #68.
  • Added --jsmath option to Main.hs
  • Added JsMath to HTMLMathMethod in Text.Pandoc.Shared.
  • Handle math appropriately in HTML writer when JsMath selected.
  • Documented the option in README and man page.
  • Text.Pandoc.Shared:
  • Changed compactify to use a better heuristic for tight and loose lists. Final Para is changed to Plain if all other list items *end* with a Plain block. Addresses Issue #99.
  • HTML reader:
  • Added colons to protocols in unsanitaryURI. Closes Issue #88.
  • HTML reader: Don't interpret contents of blocks as markdown.
  • Added rawVerbatimBlock parser. Resolves Issue #94.
  • Markdown reader:
  • Allow URLs with spaces in them in links and references, but escape them as " ".
  • Allow blank space at the end of horizontal rules.
  • RST reader:
  • Modified 'unknownDirective' parser to handle comment blocks correctly, and added tests for comment blocks. Resolves Issue #86. Closes Debian Bug #500662.
  • HTML writer:
  • Include classes on tr elements in HTML output: "header", "odd", "even". This allows tables to be styled with lines in alternating colors. Resolves Issue #91.
  • Enclose all LaTeXMathML bits in . This prevents parts of the document that are not math from being interpreted as math by LaTeXMathML.js.
  • OpenDocument and ODT writers: Added support for HorizontalRule elements, which were formerly ignored. Resolves Issue #95.
  • Text.Pandoc.Shared:
  • Modified wrappedTeX to eliminate the line break between a footnote and immediately following nonspace characters in LaTeX and ConTeXt output. (This gets interpreted as a space, which is not desired in cases like "text^[note]---".) Resolves Issue #93.
  • Windows installer:
  • Don't require admin privileges to run installer. Modified pandoc-setup.iss, and changed modpath.iss to modify HKCU path if user lacks admin privileges. Also fixed case where oldpath is empty (previously this led to the new path beginning with a semicolon).
  • Updated INSTALL instructions for Arch packages and OS X install using cabal-install.
  • Removed the (now unneeded) debian directory.
  • Removed empty Codec and System directories.
  • Moved odt-styles/ to data/. Removed unneeded variable in Makefile.
  • Modified Setup.hs so that the "test" target returns an error status when tests fail, and "build" returns a success status if the build succeeds. Resolves Issue #100.
  • Added BUGS to files in tarball.