-
Add new command-line option
--variable-json(#10341). This allows non-string values (booleans, lists, maps) to be given to template variables on the command line. -
The
--pdf-engineoption can now takegroffas a value. -
Markdown writer:
- Avoid spaces after/before open/close delimiters (#10696).
E.g. instead of rendering
x<em> space </em>yasx* space *ywe render it asx *space* y. - Handle row/colspans in grid tables, and expand cells when it isn’t possible to lay them out without breaking string of non-whitespace.
- Render a figure with Para caption as implicit figure (#10755).
- When falling back to a Div with class
figurefor a figure that can’t be represented any other way, include a Div with classcaptioncontaining the caption. - Improve use of implicit figures when possible (#10758). When the alt differs from the caption, but only as regards formatting, we still use an implicit figure.
- Omit initial newlines in gfm
mathblocks to avoid an ugly blank line.
- Support the
four_space_ruleextension forplainoutput (#10813, Manolis Stamatogiannakis).
- Avoid spaces after/before open/close delimiters (#10696).
E.g. instead of rendering
-
RST writer:
- Handle row/colspans in grid tables, and expand cells when it isn’t possible to lay them out without breaking string of non-whitespace.
-
Muse writer:
- Handle row/colspans in grid tables, and expand cells when it isn’t possible to lay them out without breaking string of non-whitespace.
-
JATS writer:
- Fix escaping for writing-review-editing role (#10744).
-
HTML writer:
- Remove trailing slash from default revealjs URL (#8749). This avoids a double slash in the URL’s path component.
-
LaTeX writer:
- Make alignment work within
multirowin tables (#10772).
- Make alignment work within
-
Typst writer:
- Support
markclass on spans (#10747). - Add equation label if math contains
\label{..}(#10805).
- Support
-
Roff format writers (man, ms):
- Use the most compatible form for roff escapes (#10716).
For example,
\(xyinstead of\[xy]. This was the original AT&T troff form and is the most widely supported. The bracketed form causes problem for some tools, e.g.makewhatison macOS. And emitefollowed by an escape for a unicode combining accent rather than the form\[e aa], which works for groff but not e.g. on macOS’s man. This change affects Text.Pandoc.RoffChar, Text.Pandoc.Writers.Roff, and the Man and Ms writers.
- Use the most compatible form for roff escapes (#10716).
For example,
-
Docx writer:
- Ensure that figures and tables with custom styles are not dropped (#10705).
- Preserve Relationships for images from reference docx (#10759). This should allow one to include an image in a reference.docx and reference it in an openxml template.
- Don’t renumber rels (#10769). We used to renumber the Relationships so they didn’t conflict with the set of fixed Relationships we imposed. We are now preserving the ids from the reference doc’s document.xml.refs, so we shouldn’t renumber them or references introduced by the user (e.g. in a template) will fail.
-
Ms writer:
- Improve PDF TOC labels. We now use the plain writer to render these, so that Greek characters etc. will show up properly.
- When no
pdf-enginevariable is specified, do not use the.pdfhrefmacros at all (#10738). This gives better results for links in formats other than PDF, since the link text would simply disappear if it exists only in a.pdfhrefmacro. When a PDF engine is specified, escape the argument of.pdfhref Oin a way that is appropriate.
-
OpenDocument writer:
- Fix character styles in footnotes (#10791). Character styles governing the position of the footnote reference should not be imposed on the footnote text.
-
Powerpoint writer:
- Use reference-doc font for captions (#9896, R. N. West).
-
DocBook writer:
- Use literallayout element for LineBlock (#10825).
-
MediaWiki reader/writer:
- Allow definition on same line as term (#10708).
-
LaTeX reader:
- Skip at most one argument to LaTeX tabular newline (#7512, Evan Silberman).
- Disable ligatures inside
\texttt(#10781). - Support more symbol commands (#10782).
-
Commonmark Reader:
- Handle GFM math irregularity with braces (#10631). In GFM, you need
to use
\\{rather than\{for a literal brace.
- Handle GFM math irregularity with braces (#10631). In GFM, you need
to use
-
DocBook reader:
- Improve handling of literallayout (#10825). This is now only made
a CodeBlock when there is a
monospacedclass. Otherwise it is made a LineBlock.
- Improve handling of literallayout (#10825). This is now only made
a CodeBlock when there is a
-
Org reader:
- Add AVIF to Org Reader image extensions (#10736, Christian Christiansen).
- Don’t include newlines in inine code/verbatim (#10730). Convert newlines to spaces as we do in other formats.
- Change handling of inline TeX (#10836). Previously inline
TeX was handled in a way that was different from org’s own export,
and that could lead to information loss. This was particularly noticeable
for inline math environments such as
equation. Previously, anequationenvironment starting at the beginning of a line would create a raw block, splitting up the paragraph containing it (see #10836). On the other hand, anequationenvironment not at the beginning of a line would be turned into regular inline elements representing the math. (This would cause the equation number to go missing and in some cases degrade the math formatting.) Now, we parse all of these as raw “latex” inlines, which will be omitted when converting to formats other than LaTeX (and other formats like pandoc’s Markdown that allow raw LaTex).
-
Beamer template: fix regression in 3.6.4, reverting the omission of
\datewhen the document does not have a date. By default, beamer will display a date when no\dateis present in the title block, so this was an unintended behavior change. The reverted change was motivated by the desire to include a custom\datein the frontmatter via header-includes. This can be achieved more simply by simply setting thedatevariable. In markdown you can even usedatein metadata and put some raw LaTeX there. -
Ms template:
- Use T rather than P as default font family (#10738).
- Put PDF-specific things under a conditional.
Don’t include them if
pdf-engineisn’t set.
-
Upgrade reveal.js URL to v5 (#10740, Kolen Cheung). v4 is no longer available on unpkg.com.
-
Text.Pandoc.PDF: Allow
groffto be used as--pdf-enginewithms(#10738). Whengroffis used as a PDF engine, thegroffextension tomsis automatically enabled. Limitations:groffcurrently produces larger PDFs thanpdfroff.- With
groff, a table of contents produced with--table-of-contents/--tocwill always be placed at the end of the document. - Certain characters (e.g. Greek characters) may be dropped in the PDF outline.
-
Text.Pandoc.Writers.Shared:
- Export
delimited[API change]. - New version of
gridTable(#6344) [API change]. This handles row and colspans. It also ensures that cells won’t wrap text in places where it wouldn’t normally wrap, even if this means making the cells wider than requested by the colspec (#9001, #7641). Because the parameters are different, this is a breaking API change.
- Export
-
Text.Pandoc.App: set
pdf-enginevariable. If--pdf-engineis specified or if a PDF is being produced, we set thepdf-enginevariable. This allows writers and templates to behave differently depending on the PDF engine. -
Text.Pandoc.Class and Text.Pandoc.URI:
- Fix parsing of base64 data URIs to allow URI escapes and whitespace (which will be ignored) (#10704).
- Handle percent encoding in
pBase64URIinstead of unescaping later, for efficiency (#10704).
-
Text.Pandoc.Citeproc.BibTeX:
- Recognize
enas alangidin biblatex bibliographies (#10764).
- Recognize
-
Text.Pandoc.MIME:
- Add mime type and extension for
avif(#10704). - Handle
apng,avif,jxl(#10704).
- Add mime type and extension for
-
Text.Pandoc.Readers.LaTeX.Math: export
inlineEnvironmentNames. Internal module, not a change to the public API. -
reference.docx(Andrew Dunning):- Remove extra spaces around text placeholders.
- Add footnote block text sample.
-
Text.Pandoc.Class.Sandbox:
- Add
sandboxWithFileTreefunction [API change] (Albert Krewinkel).
- Add
-
Lua subsystem (Albert Krewinkel):
- pandoc-lua-engine: add all test files to the cabal file.
- Allow
pandoc.readto be called in “sandbox” mode for added security (#10831). Readers running in a sandbox will not be able to access the network or file system. The sandbox is enabled if the fourth parameter is a list of files or filename/content pairs. The files are read and then made available in the sandbox via en ersatz file system.
-
Makefile:
- Add target
release-checkist. - Install @daisy/ace from npm if not present.
- Use pandoc lua instead of lua.
- Fix typo in
latex-package-dependenciestarget. - Use
jqinstead ofjson_reformatinvalidate-docx-golden-tests2.
- Add target
-
NiX infrastructure: new working
flake.nixand simplershell.nix. Removed olddefault.nix. -
Require random >= 1.3 and use
splitGen.splithas been deprecated. -
Use citeproc-0.9. Bump citeproc bounds for pandoc, pandoc-lua-engine.
-
Use texmath-0.12.10.1.
-
Use released typst 0.8 (partially supporting typst 0.13).
-
Use citeproc 0.9.0.1.
-
MANUAL.txt:
- Fix default URL for revealjs.
- Add note that
alertsextension only works with commonmark (#9716). - Remove “Body Text Char” from list of Word styles that can be customized using a reference.docx (#10646). This doesn’t seem to be present in pandoc-generated docx files, nor is it a Word default.
- For pandoc lua, add note about the environment.
- Improve documentation of
--variableoption.
-
doc/typst-property-output.md: Mention thattypst:no-figureis a class, not an attribute (#10826, Niklas Eicker). -
Change RELEASE-CHECKLIST to RELEASE-CHECKLIST-TEMPLATE.org. Use org-babel to automate many of the steps of the release.
-
INSTALL.md: update MacPorts information (#10719, Mohamed Akram).
-
COPYRIGHT: fix link to source code.
-
CONTRIBUTING.md: Fix link to discussion forum. (#10834, R. N. West).
-
Add
mdocas input format (Evan Silberman). This change introduces a reader for mdoc, a roff-derived semantic markup language for manual pages. This reader has been developed almost exclusively against mandoc’s documentation and implementation of mdoc as a reference, and the real-world manual pages tested against are those from the OpenBSD base system. Of ~3500 manuals in mdoc format shipped with a fresh OpenBSD install, 17 cause the mdoc reader to exit with a parse error. Any further chasing of edge cases is deferred to future work. -
New module: Text.Pandoc.Readers.Mdoc, exporting
readMdoc[API change]. -
Issue warnings for duplicate YAML metadata keys (#10312).
-
Ensure that
--sandboxaffects--embed-resources. Previously it did not (contrary to what was implied by the manual), which means that an image with URL/etc/passwdwould leak an encoded version of that file to HTML output with--self-containedor--embed-resources, even if--sandboxwas used. Thanks to Samuel Mortenson for pointing out the issue. -
Text.Pandoc.App.OutputSettings: add
sandbox'function. This computes the sandboxed files from Opt and avoids code repetition. -
Docx reader:
- Parse index references as empty spans with attributes (#10171).
Attributes included are
entry, and optionallybold,italic,yomi,see. - Don’t create multiple paragraphs for title or subtitle (#10359). If there are multiple paragraphs with Title or Subtitle style, use only the first for metadata.
- Handle case where Zotero
itemDatahas different id from thecitationItemid. In this case we use thecitationItemIdin the bibliography as well, overriding thereferenceIdin the itemData (#10366).
- Parse index references as empty spans with attributes (#10171).
Attributes included are
-
LaTeX reader:
- Put parsed minipage in specially marked Div (#10266).
-
HTML reader:
- Parse footnotes defined by dpub-aria roles (#5294).
-
MediaWiki reader:
- Fix indented tables with caption (#10390).
- Fix parsing of col/rowspan (#6992).
-
Typst reader:
- Avoid generating empty paragraphs.
- Support
underparen,overparen. - Fix
#quoteattribution. If attribution is not present, don’t print the--(#10320). - Fix typo in unicode code point for em dash (see #10320).
-
Commonmark reader:
implicit_figuresshould check for empty caption and not produce an implicit figure in this case (#10429).
-
RST reader:
- Use a new one-pass parsing strategy. Instead of having an initial pass
where we collect reference definitions, we create links with target
##SUBST##somethingor##REF##somethingor##NOTE##something, and resolve these in a pass over the parsed AST. This allows us to handle link references that are not at the top level (#10281). - Ignore newlines in URL in explicit link (#10279).
- Handle block level substitutions.
- Support
:file:on raw directive (#8584). - Implement option lists (#10318).
- Avoid putting metadata in Para (#7766). Create MetaInlines when possible, just as with markdown input. MetaBlocks is still used when there are multiple paragraphs or non-paragraph content. This change also affects field lists.
- Fix linked substitutions (#6588). E.g.
|Python|_. - Support inline anchors (#9196).
- Explicit links define references (#5081). For example,
Go to `g`_ `g <www.example.com>`_.should produce two links to www.example.com.
- Use a new one-pass parsing strategy. Instead of having an initial pass
where we collect reference definitions, we create links with target
-
EPUB writer:
- Use standardized filename for cover image instead of the original name (#10404). This avoids problems with e.g. filenames containing spaces.
-
Markdown writer:
- Issue INFO warning when not rendering table, e.g., when
raw_htmlis disabled and the table can’t be fit into a supported markdown table format (#10407). - Respect empty LineBlock lines in
plainoutput (Evan Silberman). The plain writer behaved as a markdown variant withExt_line_blocksturned off, and so empty lines in a line block would get eliminated.
- Issue INFO warning when not rendering table, e.g., when
-
LaTeX writer:
Ensure that beamer footnotes go on frame, not column (#5769).
-
HTML writer:
- Unwrap empty incremental divs (#10328, Albert Krewinkel). Divs are unwrapped if the only purpose of the div seems to be to control whether lists are presented incrementally on slides.
-
Typst writer:
- Make template sensitive to a
page-numberingvariable (#10370). This can be set to an empty string (or, in metadata, to false) for no page numbers. - Make
smartextension work (#10271). Ifsmartis not enabled, a command in the default template will disable smartquote substitutions. Whensmartis enabled, render curly apostrophes as straight and escape straight apostrophes. Whensmartis disabled, render curly apostrophes as curly and don’t escape straight apostrophes. Similarly for quotes, em and en dashes. This should give more idiomatic typst output, with fewer unnecessary escapes.
- Make template sensitive to a
-
ANSI writer:
- Respect empty LineBlock lines (Evan Silberman).
-
JATS writer:
- Correct spelling of suppress attribute (#10350, Andreas Deininger).
-
Typst template:
- Remove
definitions.typstpartial. - Remove unnecessary definition of
endnote. - Incorporate the one remaining definition into
default.typst. - Use typst 0.12 code for two column layout (#10294, Luis Rivera).
- Note: the new templates presuppose typst 0.12; if you try to use an earlier version of typst, an error will be raised.
- Remove
-
LaTeX/Beamer template:
- Split
fonts.latexpartial into two parts:fonts.latexandfont-settings.latex. - In beamer template, load beamer theme between
fonts.latexandfont-settings.latex. This allows a theme (such as metropolis) to set its own default font, while still allowing the user to override it. This fixes a regression in pandoc 3.5 (#10297). - Note: Users who have custom templates based on pandoc 3.5 templates will
need to add
font-settings.latex()afterfonts.latex()in the latex template. In a beamer template, the beamer theme-setting code needs to be moved between these two partials.
- Split
-
ConTeXt template: Ensure that font names don’t wrap (#10305).
-
epub.css: remove background-color (#10264, Suraj Patil). With this greyish background color, epubs look bad on a Kindle (#10263). -
Text.Pandoc.ImageSize: add WebP support (Evan Silberman, #10397). Add
Webpconstructor on ImageType [API change]. -
Text.Pandoc.Readers.Roff and a new unexported module Text.Pandoc.Readers.Roff.Escape: parameterize Roff escaping (Evan Silberman) [API change]. This allows code to be reused between the mdoc and man readers, despite the differing Token types.
-
Text.Pandoc.PDF:
- PDF via LaTeX: always do max runs if
tocis present (#10308). The old method (checking to see if toc hash had changed) is not completely reliable. - Use
.sourceextension, not.html, intoPdfViaTempFile(#10314).
- PDF via LaTeX: always do max runs if
-
Text.Pandoc.Logging: add
YamlWarningconstructor toLogMessage[API change] (#10312). -
Text.Pandoc.Format: remove duplicate typst entry (#10388, Caleb Mclennan).
-
Fix a typo in the
ua.yamllocalization for ‘See’ (Jens). -
Lua subsystem (Albert Krewinkel):
- Remove prefixes from Lua type names (#8574). Lua type names were inconsistent with regard to the use of prefixes; all prefixes are removed now, and Lua types now have the same name as the Haskell types. The use of app-specific prefixes is suggested by the Lua manual to avoid collisions. However, this shouldn’t be a problem with pandoc, as it cannot be used as a Lua package.
-
doc/libraries.md: Add newly developed Haskell packages. Sort list alphabetically (Albert Krewinkel).
-
doc/lua-filters.md: document
pandoc.List:itermethod (Albert Krewinkel). List objects have a new functioniterthat returns an iterator function that returns the next list item on each call. -
MANUAL.txt:
- Clarify what the example of YAML EPUB metadata shows (#10405).
- Fix typo in template syntax (#10265, Pascal Wagler).
- Update manual with information on openxml template (#10273).
- Clarify that
--variablecan only assign string values (#10298).
-
Fix comments in TEI writer referring to DocBook (#10430, Evan Silberman).
-
Fix several typos in documentation (#10349, Andreas Deininger).
-
Allow Diff 1.0.
-
Add font-settings.latex partial to pandoc.cabal (#10379).
-
Bump upper bound for data-default.
-
Use latest typst, texmath, pandoc-lua-marshal, commonmark-pandoc, commonmark-extensions, skylighting, skylighting-format-blaze-html.
-
New output format:
ansi(for formatted console output) (Evan Silberman). Most Pandoc elements are supported and printed in a reasonable way, if not always ideally. This version does no detection of terminal capabilities, nor does it fall back to different output styles for less-capable terminals. -
Add command line options
--table-caption-positionand--figure-caption-position. These allow the user to specify whether to put captions above or below tables and figures, respectively. The following output formats are supported: HTML (and related such as EPUB), LaTeX (and Beamer), Docx, ODT/OpenDocument, Typst. -
Change default
--pdf-enginevia HTML to WeasyPrint (#10142).wkhtmltopdfis deprecated.weasyprintis the easiest-to-install, maintained alternative. For better results, one might preferpagedjs-cli. -
Org reader:
- Fix parsing of src blocks with an
-iflag (#10071, Albert Krewinkel). Tabs are now preserved in the contents of src blocks if the the block has the-iflag.
- Fix parsing of src blocks with an
-
RTF reader:
- Handle images inside
shpcontexts (#10145).
- Handle images inside
-
RST reader:
- Improve simple table support (#10093). Multiline rows occur only when the first cell is empty; we were previously treating lines with any empty cell as row continuations. In addition, we no longer wrap multiline cells in Para if they can be represented as Plain. This is consistent with docutils behavior.
-
LaTeX reader:
- Math environments don’t have bracketed options (#10160).
- Parse nested tabular environments (#4746).
-
Typst reader:
- Change how “block” elements are handled. Previously they were always parsed as divs. But actually they can occur in some “inline” contexts. Now we first try to parse them as inlines, and only as blocks if that fails. A surrounding Div or Span element is added only if there is an identifier.
-
HTML reader:
- Only parse main element’s contents (if present) (#10140). If main has an id or class, we include a div with that id or class; otherwise just the contents.
- Read TeX annotation in MathML content if present (#9971).
- Better handle KaTeX-generated math (#9971). KaTeX emits the mathml
followed by a span with an HTML fallback. Previously pandoc was
converting both. We now ignore the HTML fallback span, marked
with class
katex-html.
-
Docx reader:
- Add “SuppressAuthor” and “AuthorOnly” to citationMode
when
+citationsis used (thomjur).
- Add “SuppressAuthor” and “AuthorOnly” to citationMode
when
-
New module: Text.Pandoc.Writers.ANSI [API change] (Evan Silberman).
-
Docx writer:
- Support
custom-styleattribute for docx table (Sebbones). - Support
--number-offsets. - Make table/figure rendering sensitive to caption position settings.
- Support
-
OpenDocument writer:
- Make table/figure rendering sensitive to caption position settings.
-
Typst writer/template:
- Implement figure caption positions by triggering a show rule in the default template, which determines caption positions for figures and tables globally.
- Don’t include trailing semicolon after
@style citations with suffixes (#10148). - Template: move header-includes before show doc (#9996, Gordon Woodhull).
-
LaTeX writer:
- Make table/figure rendering sensitive to caption position settings (#5116).
- Preserve locator labels with
--natbib(#10057).
-
HTML writer/template:
- Make
<figcaption>placement sensitive to caption position settings. For tables,<caption>must be the first element, and positioning is determined by CSS, for here we set a variable which the default template is sensitive to. - Use
makeSectionsWithOffsetsforwriterNumberOffsets, instead of the old, inefficient code. - Don’t add doc-biblioref role to every link in a citation; only to links to the bibliography (#10156).
- Add
data-when renderinglabelattribute (#10048).
- Make
-
Markdown writer:
-
Avoid emitting markdown caption if table has fallen back to raw HTML, which will then contain a
<caption>tag (#10094). -
Make math sensitive to
tex_math_gfmextension (#9121). This means that in GFM output, the “new style” math will be used by default, e.g.$`x=y`$ ```math x = y ```To defeat this and get the older behavior, namely
$x=y$ $$x=y$$one could use
-t gfm-tex_math_gfm.
-
-
AsciiDoc writer:
- Add
link:prefix when needed (#10105). AsciiDoc requires it except forhttp,https,irc,mailto,ftpschemes (#10105). - Preserve original base level (#10062). We used to normalize so that the base level is always 1, but asciidoc no longer seems to care about that, and the behavior creates difficulties when we are converting fragments.
- Don’t emit empty figure caption (#10047).
- Add
-
ODT writer:
- Add TableCaption to styles.xml (#10058, Ian Max Andolina).
-
LaTeX template:
- Fix wrong beamer color in (sub)section page (Jonathan).
-
Text.Pandoc.Options:
- Add
CaptionPositionand newWriterOptionsfieldswriterFigureCaptionPositionandwriterTableCaptionPosition[API change].
- Add
-
Text.Pandoc.Opt:
- Change default for optNumberOffset to
[]. This behaves the same as[0,0,0,0,0]. - Add
OptfieldsoptFigureCaptionPositionandoptTableCaptionPosition[API change].
- Change default for optNumberOffset to
-
Text.Pandoc.Format: change
formatFromFilePathsso that it is smarter about URLs. URLs are parsed, and we take the format from the path component, if present (#10141). This means thathttps://emacs.org/will be treated as HTML, whilehttps://emacs.org/sample.orgwill be treated as Org. -
Text.Pandoc.URI:
- Add unofficial
gemini:to list of URI schemes (Pau RE).
- Add unofficial
-
Text.Pandoc.Shared:
- Add
makeSectionsWithOffsets[API change]. - Remove `stripEmptyParagraphs [API change] (Albert Krewinkel). This function is no longer used.
- Add
-
Text.Pandoc.Highlighting: Expose
formatANSI[API change] (Evan Silberman). -
Text.Pandoc.Writers.Shared: export
to{Sub,Super}scriptInline[API change] (Evan Silberman). -
Remove use of partial functions (e.g.
head) in code. -
Use latest skylighting-core, skylighting, doclayout, texmath, typst.
-
pandoc-lua-engine: Add accessors for several writer options, including some that were added in previous releases.
-
pandoc-server: Initialize some missing fields in WriterOptions:
writerEpubTitlePage,writerChunkTemplate,writerListTables,writerFigureCaptionPosition,writerTableCaptionPosition. -
CONTRIBUTING.md: Summarize steps for adding a new cli option.
-
MANUAL.txt:
- Clarify that the
--number-offsetoption should only directly affect numbering of the first section heading in a document; subsequent headings will increment normally. - Fix asciidoc link (#10039).
- Fix CSL Docs broken link (#10100, Tristano Ajmone).
- Document the use of
luatexjawhen CJKmainfont is used with lualatex (#3873, Kolen Cheung). - Add a
citations(typst) section to the manual (#9127). - Clarify that
citationsaffects both input and output fororg. - Add note on
--citeprocthat you may need to disablecitationsextension on the output format (e.g.,-t markdown-citations) to see the rendered citation (#9127, #10012).
- Clarify that the
-
INSTALL.md — reorganise info on static binaries and add conda-forge install options (#10098, #10069, Ian Max Andolina).
-
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.Zinstalls 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
alertsmarkdown extension. This enables GitHub style markdown alerts as a commonmark extension. This extension is now default forgfm. It can’t be used withmarkdown, only withcommonmarkand 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).
- Preserve newlines in math instead of changing to spaces.
Otherwise we can get unwanted results if there’s
a
-
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).
- Support attr
-
Typst reader:
- Allow references (e.g.
@foo) to become citations if there is no corresponding label in the document. - Collapse adjacent
citeelements. - Handle supplements in
cite. - Change
cite(only one key allowed, a label) (typst 0.9 breaking change). - Support
quoteelement (typst 0.9).
- Allow references (e.g.
-
LaTeX reader:
- Handle otherlanguage environment and language-name environments like
\begin{french}...\end{french}(#9202). - Fix theorem label parsing (#8872, Hikaru Ibayashi).
- Handle otherlanguage environment and language-name environments like
-
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:symelement.
-
Man reader:
- Properly handle
.spmacro inside lists and block quotes (#9201).
- Properly handle
-
LaTeX writer:
- Fix bug with big footnotes inside emphasis (#8982, Hikaru Ibayashi).
- Handle identifiers inside heading contents.
\phantomsectioncan’t be used in this case, so we need\hypertarget(#9209).
-
LaTeX template:
- Include
bookmarkpackage unconditionally. This package produces better PDF bookmarks thanhyperrefand does it on the first pass.
- Include
-
Typst writer:
- Use
quotefor block quotes. - Support
--toc-depthas 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).
- Use
-
Typst template:
- Remove custom definition of
blockquotein default template. (We now use built-inquote.) - 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
cslstyle in the template, falling back tobibliographystyleifcslis not specified.
- Remove custom definition of
-
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-footnoterole is used withasideanddoc-endnoteswithsection. asideis used only for notes at ends of sections or blocks; if all the notes come at the end of the document,sectionis used so we can have thedoc-endnotesrole.
- To conform to validator’s expectations,
-
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\-. Thegroff_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_alertsconstructor [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
bookmarkpackage, 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 forrect.- Allow svg
pathelement to be minimized. - Export
combineAttr[API change]. - Improve
isTightListso 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
.svgnot.svgzas extension forimage/svg+xmlmime type. This fixes issues with embedded SVG images in docx output, among other things (#9195). -
Text.Pandoc.Class:
openURLimprovements for data uris. Only treat data URI asbase64if ‘;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
idattribute except whenuseelement is used. - Remove
width,heightattributes from svg element whenuseelement is used. Instead, addwidthandheight100% to theuseelement. This seems to get the sizing right.
-
Text.Pandoc.Citeproc: Don’t link citations if
suppress-bibliographyspecified, for there will be nothing to link to (#9163). -
epub.css: add styling for sup and sub (#9160).
-
Switch from
base64tobase64-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
bibliographycsl, etc. instead of a nestedmetadatafield. Reason:${USERDATA}and${HOME}are only expanded in these contexts, not inmetadata. -
Move man pages to pandoc-cli package (#9245).
-
Fix CVE-2023-38745, a 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<DOCTYPE! html>. 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 parseoas a booleantrueorfalse. This change allows the fused short arguments to be used again. Note that-struewill be interpreted as-swith an argumenttrue, 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 missingbbbtemplate instead of saying thatbbbis 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-tabsargument. 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
<code>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
decodeArgwhich 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 emitting 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.
-
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
--sandboxflag. [CVE-2023-35936] -
Allow
epub-title-pageto be used in defaults files (#8908). -
Issue
Extractinginfo message (in--verbosemode) when using--extract-mediaor 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_figureswork again. Support for this (introduced in #6350) disappeared when we made an architectural change. -
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-sectionswork. - 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.
- Make
-
Mediawiki writer: allow highlighting to work for F# language (Adelar da Silva Queiróz).
-
LaTeX writer: Fix escaping of
&in\hrefand\url(#8903). -
Docx writer:
- Fix localization of “Abstract” title (#8702).
- Allow
abstract-titleto be specified in docx metadata (#8794).
-
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
warnfunction 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. -
INSTALL.md:
- Mention alternatives to LaTeX to generate PDF (Norwid Behrnd).
- Update Linux install links (harabat).
-
pandoc-extras.md: add to “Academic publishing workflows” (#8696, Vladimir Alexiev).
-
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).
-
DocBook reader:
- Fix
<xref>references to tables in DocBook files (#8626, Pavol Otto). - Parse
figureas a Figure element in the AST (#8668).
- Fix
-
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).
CJKsansfontandCJKmonofontwill be set for xelatex only ifCJKmainfontis 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 thelinkstylevariable 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
<graphic>,<inline-graphic>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.
-
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.jsonto handle JSON encoding (#8605, Albert Krewinkel).
- Add new function
-
Use pandoc-lua-marshal 0.2.1 (Albert Krewinkel). All major AST elements now have
__tojsonmetamethods that return the JSON representation of an element. This allows to JSON-encode these elements with libraries that respect the__tojsonmetamethod, 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
-
MANUAL.txt:
- Document chunk-template in defaults file.
- Remove obsolete “raw content in a style” section.
- Revise documentation for
--mathmlto reflect support in all major browsers (#8667).
-
docs/custom-readers.md: Update JSON parsing example. The example now uses the built-in
pandoc.jsonlibrary 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).
-
Split pandoc-server, pandoc-cli, and pandoc-lua-engine into separate packages (#8309). Note that installing the
pandocpackage from Hackage will no longer give you thepandocexecutable; for that you need to installpandoc-cli. -
Pandoc now behaves like a Lua interpreter when called as
pandoc-luaor whenpandoc luais used (#8311, Albert Krewinkel). The Lua API that is available in filters is automatically available to the interpreter. (See thepandoc-luaman page.) -
Pandoc behaves like a server when called as
pandoc-serveror whenpandoc serveris used. (See thepandoc-serverman 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|falseallows the EPUB title page to be omitted (#6097). -
--reference-doccan now accept a URL argument (#8535) and load a remote reference doc. -
--versionoutput 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-levelreplaces--epub-chapter-leveland affects both EPUB and chunked HTML output.--epub-chapter-levelwill still work but is deprecated. -
Multiple input files with
--file-scope: fix case where the links are URL-encoded, e.g. with%20(#8467). -
Produce error if
--cslis used more than once (#8195, Prat). -
Remove deprecated
--atx-headersoption. -
Remove deprecated option
--strip-empty-paragraphs. -
In
--verbosemode add message when running citeproc (as with other filters). -
Add new
markextension for highlighted text in Markdown, using==delimiters (#7743). -
Add new extensions
wikilinks_title_after_pipeandwikilinks_title_before_pipeforcommonmarkandmarkdown. (#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 titlewikilinkas a wikilink if a respective extension is enabled. Pandoc will usewikilinks_title_after_pipeif both extensions are enabled. -
Add prefixes to identifiers with
--file-scope(#6384). This change only affects the case where--file-scopeis 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 identifierfooincontents/file1.txtwill becomecontents__file1.txt__foo. Links will be adjusted accordingly: iffile2.txtlinks tofile1.txt#foo, then the link will be changed to point to#file1.txt__foo. Similarly, a link tofile1.txtwill 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-ois 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--tocis used. Asitemap.jsonfile is also included. The option--split-leveldetermines 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_figuresextension 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_htmlextension is enabled, and as Div elements otherwise. - HTML reader:
<figure>elements are parsed as figures, with the caption taken from the respective<figcaption>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_figuresextension, add a caption that’s identical to the image description. The writer checks for this and adds anaria-hiddenattribute to the<figcaption>element in that case. - JATS reader: The
<fig>and<caption>elements are parsed into figure elements, even if the contents is more complex. - JATS writer: The
<fig>and<caption>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
subfiguretemplate 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), wherecaptionandcontentsare strings andattris 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\startfloatcombinationenvironment. - DocBook writer: Uses
mediaobjectelements, 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 styleFigureorCaptioned 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.
- Markdown reader: paragraphs containing just an image are treated as
figures if the
-
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
customin the user’s data directory for a matching script if it can’t find one in the local directory. Previously, thereadersandwritersdata directories were searched for custom readers and writers, respectively. Scripts in those directories must be moved to thecustomfolder. - Custom readers used to implement a fallback behavior that allowed to
consume just a string value as input to the
Readerfunction. This has been removed, the first argument is now always a list of sources. Usetostringon that argument to get a string.
-
New module Text.Pandoc.Writers.ChunkedHTML, exporting
writeChunkedHtml[API change]. -
We now set the
pandoc-versionvariable 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
oMathParainw:pwith other content (#8483).
- Mark unnumbered headings with class
-
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]
- Fix relative links. ODT adds a
-
DocBook reader:
- Support href on link even in a fragment (#8437).
(We now just look for an
hrefattribute without worrying about the namespace.) - Parse title from imageobject/objectinfo (#8437).
- Support href on link even in a fragment (#8437).
(We now just look for an
-
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
toksToStringin Parsing module. - Support more
soulcommands, including\hl. - Add
unnumberedclass for\part*(#8447) - Fix
TEXINPUTShandling (#8392). IfTEXINPUTSends with:, then the system defaultTEXINPUTSis 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
<tt>(#8330). It was no longer being parsed as Code (Justin Wood).
- Fix regression for
-
RST reader:
- Support
markrole for round-trip.
- Support
-
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:
-
Org reader:
- Allow org-ref v2 citations with
&prefix (#8302). - Make
#+pandoc-emphasis-prework as expected (#8360, Amir Dekel).
- Allow org-ref v2 citations with
-
BibTeX reader:
- Fix handling of
%inurlfield (#7678).%does not function as a comment character insideurl(where URL-encoding is common). - Allow
urlfield inbibtexas well asbiblatex(#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
softwaretype in biblatex <-> CSL conversions (#8504). - Make sure
versionfield comes through in biblatex (#8504).
- Fix handling of
-
BibTeX writer:
- Pass through
urleven forbibtex(#8287).
- Pass through
-
Org writer:
- Pass through unknown languages in code blocks (#8278), instead
of producing
begin_example. - Use span attributes
tag-namein headers as tags (#8513, Albert Krewinkel). This enables round-tripping of tags in Org headings.
- Pass through unknown languages in code blocks (#8278), instead
of producing
-
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, notimageobject. - 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).
- Rename Text.Pandoc.Writers.Docbook -> Text.Pandoc.Writers.DocBook.
Rename
-
ConTeXt writer (Albert Krewinkel):
- Support syntax highlighting for code.
- Always use
\typefor inline code. Inline codes that contained curly braces where previously rendered with\mono; this led to unexpected results when the presentation of\typewas customized, as those changes would not have been applied to code rendered with\mono. - Add support for unlisted, unnumbered headings (#8486).
- Support
taggingextension (Albert Krewinkel). Paragraphs are enclosed by\bparand\eparcommands, andhighlightcommands 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
\includesvgfor SVGs and include thesvgpackage (#8334). - Use
soulinstead ofulemfor strikeout, underline (#8411). This handles things like hyphenation, line breaks, and nonbreaking spaces better. - Use
\toprule\noalign{}instead of\toprule()in tables, and similarly for\midruleand\bottomrule(#8223). This facilitates redefining\toprule,\midrule, and\bottomrulewithout 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
<break/>for LineBreak in the limited contexts that accept it (#8344). - Officially deprecate
writeJATSin favor ofwriteJatsArchiving.
- Use
-
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-tablesoption is specified (writerListTables) (#4564, Francesco Occhipinti). - Improve inline escaping rules (#8380).
- Use special
markrole for Span with classmark.
- Render tables as list tables when the
-
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
<a>inside<a>(#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
--mathjaxis used.
-
HTML, Markdown writers: filter out empty class attributes (#8251). These should not be generated by any pandoc readers, but they might be produced programmatically.
-
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
markextension.
-
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
langelement (#7022). For East Asian languages, we need to adjustw:eastAsiarather thanw:val. This allows normal fonts to be used for any Latin-font text. Similarly, for bidi languages, we need to adjustw:bidirather thanw:val. We treatheandaras bidi languages,zh,ja,koas 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
markas 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
--asciihas been specified on the command line (writerPreferAscii).
- Use UTF-8 by default for non-ascii characters (#8507).
Only use groff escapes if
-
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
\babelfontwhenmainlangandlangare specified andpdflatexis not being used (#8538). This is needed for good results in Arabic. - Add variable
urlstyle(#8429, Amar Al-Zubaidi). This is set tosameby 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, andlinestretchcan still be used as before; the only difference is that we no longer provide opinionated defaults. This commit also adds amaxwidthvariable that setsmax-width; if not set, 36em is used as a default. - Add
code { hyphens: manual; }. - Use
styles.citations.htmlpartial instyles.html. - Fix class name
hanging->hanging-indentinstyles.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.
- Remove default font size, line height and font family in
default inline css (#8423).
-
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 puttingepub.cssin the user data directory or by using--csson 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/columnsdivs by default, as we do in HTML. Instead, we use an older method which only works when there are twocolumndivs inside acolumnsdiv. 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
parseOptionsFromArgsandparseOptions(#8406) They now returnEither OptInfo Opt. [API change] - Add
OptInfotype [API change]. - Add
handleOptInfofunction. This performs the IO actions for things like--versionthat were previously done inparseOptionsFromArgs[API change]. convertWithOpts: add argument for aScriptingEngine[API change].- Unify check for standalone output (Albert Krewinkel).
- New
optEpubTitlePagefield onOpt[API change] (#6097). - Remove
optEpubChapterLevel, addoptSplitLevel[API change]. - Export
IpynbOutput(..)[API change].
-
Text.Pandoc.App.OutputSettings:
- Remove unused field
outputWriterNameinOutputSettings.
- Remove unused field
-
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
itemsproperty 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 asp.with nothing after it. - Update
sub verbotosub-verbo(#8315). This is a change in the term’s canonical name in citeproc. As a result of this change,sub verbolocators 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
parseFormatSpecwas moved from Text.Pandoc.Extensions to the new module and renamed toparseFlavoredFormat. 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 asparseFlavoredFormat(Albert Krewinkel). - Simpler implementation of Extensions based on Set (benchmarks show no performance penalty).
- Add
CustomExtensionconstructor toExtension[API change]. - Remove
Bounded,Enuminstances forExtension. - Add
extensionsToListfunction. - Revise
readExtensionso it can handleCustomExtension, and so that it returns a Text rather thanMaybe Text. - Add
showExtension[API change]. - Add
Ext_markextension [API change]. - Add
Ext_taggingconstructor [API change] (Albert Krewinkel). - Add
Ext_wikilinks_title_after_pipe,Ext_wikilinks_title_before_pipe[API change] (Albert Krewinkel).
-
Text.Pandoc.PDF:
- Fix
papersizeon 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=a4should be sufficient to produce A4 PDF via ms. - Change default background color of PDFs generated via HTML (#8422, Marcin Serwin).
- Fix
-
Text.Pandoc.MIME:
- Base module on package
mime-types, which is already a transitive dependency (#8277, Albert Krewinkel). - Remove deprecated overrides (#8292).
- Base module on package
-
Text.Pandoc.XML:
- Re-export
lookupEntityfrom commonmark-hs [API change].
- Re-export
-
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.characterReferenceso they now return a Text (some named references don’t correspond to a single Char). Use the thelookupEntityfunction from commonmark-hs instead of the slow one from tagsoup [API change]. charsInBalancednow takes a Text parser rather than a Char parser as argument [API change].
- 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:
-
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 aspandocVersionText). - 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 justnubOrdfrom Data.Containers.ListUtils. - Remove
mapLeft[API change]. This is just a synonym for Bifunctor.first. - Remove
elemText,notElemText[API change]. - Drop export of
pandocVersionandpandocVersionText, 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 thepandoc.utils.blocks_to_inlinesLua function. defaultUserDataDiris 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].
- Export
-
Text.Pandoc.Writers.Shared:
- Export
htmlAddStyle,htmlAlignmentToStringandhtmlAttrs[API change] (Wout Gevaert). - Use ‘literal tag’ instead of ‘text (T.unpack tag)’ in
tagWithAttrs(Wout Gevaert). toTableOfContents: handle nested Divs better (#8402).
- Export
-
Rename Text.Pandoc.Network.HTTP -> Text.Pandoc.URI. This is still an unexported internal module. Export
urlEncode,escapeURI,isURI,schemes,uriPathToPath. Drop exports ofschemesanduriPathToPath. -
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
writerEpubTitlePagefield onWriterOptions(#6097) [API change]. - Remove
writerEpubChapterLevel, addwriterSplitLevel[API change].
- WriterOptions now has a field
-
Text.Pandoc.Filter:
- Export
applyFilters[API change]. - Export
applyJSONFilter[API Change] (Albert Krewinkel). - Parameterize
applyFiltersover scripting engine [API change] (Albert Krewinkel).
- Export
-
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 aFlavoredFormatinstead of aText[API change] (Albert Krewinkel).
- Change argument type of
-
Text.Pandoc.Writers:
- Change argument type of
getWriter, so it takes aFlavoredFormatinstead of aText[API change] (Albert Krewinkel).
- Change argument type of
-
Text.Pandoc.Templates:
- Do not try to normalize input to
getDefaultTemplate(Albert Krewinkel). The functiongetDefaultTemplateno longer splits off extension modifers from the given format, as that conflicts with using custom writers as formats. Haskell library users should usegetDefaultTemplate <=< (fmap formatName . parseFlavoredFormat)if the input format can still contain extensions. The same is true forcompileDefaultTemplate, which callsgetDefaultTemplateinternally - Add Wrapper type documentation (#8490, William Rusnack).
- Do not try to normalize input to
-
New exported module Text.Pandoc.Scripting (Albert Krewinkel). The module contains the central data structure for scripting engines (e.g., Lua) [API change].
-
Text.Pandoc.Error:
- Add new PandocError constructor
PandocNoScriptingEngine[API change] (Albert Krewinkel). - Add new PandocError constructor
PandocFormatError[API change] (Albert Krewinkel). The new error is used to report problems with input or output format specifications. - Add new PandocError constructor
PandocNoTemplateError(Albert Krewinkel). - Remove
PandocParsecErrorconstructor fromPandocError(#8385). Henceforth we just usePandocParseError.
- Add new PandocError constructor
-
New module Text.Pandoc.Version, exporting
pandocVersionTextandpandocVersion[API change].pandocVersionreturns aVersioninstead of aText, which is consistent withpandocTypesVersion. -
Text.Pandoc.Class:
- Make
getPOSIXTime,getZonedTimesensitive toSOURCE_DATE_EPOCHenvironment variable if set (#7093). (getTimestampwas already sensitive.) This ensures that EPUB builds are reproducible. - Text.Pandoc.Class no longer exports
readDataFile,readDefaultDataFile,setTranslations, andtranslateTerm[API change]. - Text.Pandoc.Class now exports
checkUserDataDir[API change].
- Make
-
T.P.Class.IO: export function
writeMedia[API change] (Albert Krewinkel). This is useful for thepandoc.mediabagmodule. -
Separate out Text.Pandoc.Data and Text.Pandoc.Translations from Text.Pandoc.Class (#8348). This makes Text.Pandoc.Class more self-contained.
- Text.Pandoc.Data is now an exported module, providing
readDataFileandreadDefaultDataFile(both formerly provided by Text.Pandoc.Class), and alsogetDataFileNames(formerly unexported in Text.Pandoc.App.CommandLineOptions) anddefaultUSerDataDir(formerly provided by Text.Pandoc.Shared). [API change] - Text.Pandoc.Translations is now an exported module (along with
Text.Pandoc.Translations.Types), providing
readTranslations,getTranslations,setTranslations,translateTerm,lookupTerm,readTranslations,Term(..), andTranslations[API change].
- Text.Pandoc.Data is now an exported module, providing
-
Text.Pandoc now exports Text.Pandoc.Data and
setTranslationsandtranslateTerm{API change]. -
Export module Text.Pandoc.Class.IO [API change]. The module is useful when defining instances of class PandocMonad for types that are also instances of MonadIO.
-
Remove modules Text.Pandoc.Writers.Custom and Text.Pandoc.Readers.Custom [API Change] (Albert Krewinkel). The functions
writeCustomandreadCustomare available from module Text.Pandoc.Lua. -
Text.Pandoc.Server:
- Split this module into a separate package,
pandoc-server, allowing thepandoclibrary to be compiled without server support. - Return object if JSON is accepted. Previously we just returned
a JSON-encoded string. Now we return something like:
This is a change in the pandoc-server JSON API.{ "output": "<p>hello</p>" "base64": false, "messages": [ { "message": "Not rendering RawInline (Format \"tex\") \"\\\\noe\"", "verbosity": "INFO" } ], } - Set translations in the writer based on
langmetadata. - Return error in JSON object if response is JSON.
- Remove
parseServerOpts. [API change]
- Split this module into a separate package,
-
Text.Pandoc.Lua:
-
Lua subsystem (Albert Krewinkel):
- The whole Lua subsystem has been moved to a separate package,
pandoc-lua-engine.pandocdoes not depend on it.convertWithOptshas a new parameter that can be used to pass in the scripting engine defined inpandoc-lua-engine(or a different one, in theory). - Fix the behavior of Lua “Version” objects under equality comparisons (#8267).
- Support running Lua with a GC-collected Lua state.
- Ensure that extensions marshaling is consistent.
- Produce more informative error messages for pandoc errors. Errors are reported in Lua in the same words in which they would be reported in the terminal.
- Add new module
pandoc.format. The module provides functions to query the set of extensions supported by formats and the set of extension enabled per default. - Add function
pandoc.template.apply. - Add function
pandoc.template.meta_to_context. The functions converts Meta values to template contexts; the intended use is in combination withpandoc.template.apply. - Allow Doc values in
WriterOptions.variables. The specialized peeker and pusher function forContext Textvalues does not go via JSON, and thus keeps Doc values unchanged during round-tripping. - Fix rendering of Lua errors in Lua, so that the
Error running Luamessage is not prepended multiple times. - Add new module
pandoc.zip. - Allow strings in place of compiled templates (#8321).
This allows to use a string as parameter to
pandoc.template.applyand in the WriterOptionstemplatefield. - Rename
reader_extensions/writer_extensionsglobals asExtensions(#8390). - Add
pandoc.scaffolding.Writer(#8377). This can be used to reduce boilerplate in custom writers. - Fix peeker for PandocError (Albert Krewinkel). String error messages were incorrectly popped of the stack when retrieving a PandocError.
- Add functions
pandoc.text.toencoding,pandoc.text.fromencoding(#8512, Albert Krewinkel). - Add
pandoc.climodule. Allow processing of CLI options in Lua. - Support
-DCLI option for custom writers. A new errorPandocNoTemplateError(code 87) is thrown if a template is required but cannot be found. - Allow table structure as format spec. This allows to pass structured
values as format specifiers to
pandoc.writeandpandoc.read. - Add function
pandoc.mediabag.write(Albert Krewinkel). - Add module
pandoc.structure(Albert Krewinkel). The functionmake_sectionshas been given a friendlier interface and moved to the new module; the oldpandoc.utils.make_sectionshas been deprecated.
- The whole Lua subsystem has been moved to a separate package,
-
Custom writers:
- The global variables
PANDOC_DOCUMENTandPANDOC_WRITER_OPTIONSare no longer set when the writer script is loaded. Both variables are still set in classic writers before the conversion is started, so they can be used when they are wrapped in functions. - Deprecate classic custom writers.
- Add function
pandoc.write_classic. The function can be used to convert a classic writer into a new-style writer by setting it as the value ofWriter:
or to fully restore the old behavior:Writer = pandoc.write_classicfunction Writer (doc, opts) PANDOC_DOCUMENT = doc PANDOC_WRITER_OPTIONS = opts load(PANDOC_SCRIPT_FILE)() return pandoc.write_classic(doc, opts) end - Support extensions in custom writers. Custom writers can define the
extensions that they support via the global
writer_extensions. The variable’s value must be a table with all supported extensions as keys, and their default status as values. For example, the below specifies that the writer supports the extensionssmartandsourcepos, but only thesmartextension is enabled by default:writer_extensions = { smart = true, sourcepos = false, } - Custom writers can define a default template via a global
Templatefunction; the data directory is no longer searched for a default template. Writer authors can restore the old lookup behavior withTemplate = function () local template return template.compile(template.default(PANDOC_SCRIPT_FILE)) end
- The global variables
-
Custom readers:
-
Use latest versions of
commonmark-extensions,texmath,citeproc,gridtables, andskylighting. -
Use pandoc-types 1.23. This adds the
FigureBlock constructor and removes theNullBlock constructor. -
Require aeson >= 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
lua53flag. 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_OPTIONSin 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
--cssshould 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 forpandoc.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).
- Deprecate
-
Tests.Command: remove unused
runTest. -
Add pandoc-lua.1 man page.
-
Improve
shell.nix. -
Add
tools/moduledeps.luafor 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
serverflag to pandoc-cli, allowing it to be compiled without server support. -
pandoc-cli: Allow building a binary without Lua support (Albert Krewinkel). Disabling the
luacabal flag will result in a binary without Lua. -
Move
--versionhandling to pandoc-cli. We need it here in order to print information about whether server and Lua support have been compiled in. -
Move
nightlyflag from pandoc to pandoc-cli (#8339). -
Makefile changes:
make helpwill 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.
-
Add
--embed-resourcesflag (Elliot Bobrow, #7331). This can be used to embed resources without implying--standalone. Deprecate--self-containedin favor of--embed-resources --standalone. -
Allow environment variable interpolation in
highlight-styleandpdf-enginefields in defaults files (#8061; Jaehwang Jung, #8073). -
Allow placing custom readers and writers in user data directory (Albert Krewinkel, #8112) (
readersandwriterssubdirectories). -
Add
tsv(tab separated values) as an input format (#7974). [API change]: Text.Pandoc.Readers.CSV now exportsreadTSV. Internal change: In Text.Pandoc.CSV,CSVOptionshas changed so thatcsvQuotetakes a Maybe value. -
Add
tex_math_dollarstogfmdefault 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
\lstinlineinside\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
\inputin LaTeX reader (#8092). Previously we required a.texextension, but TeX allows any extension for\input(as opposed to\include).
- Support
-
RTF reader:
- support
\nosupersub(#8170).
- support
-
TikiWiki reader:
-
DocBook reader:
- Improved reading
<xref>elements (Frerich Raabe, #8065).
- Improved reading
-
JATS reader:
- Strip
ref-prefix from ref id in xref (#8007). - Support edition in references (#8087).
- Strip
-
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).
- Make parser more forgiving (#8034). Allow blank lines after entries.
Allow entries with no space after the
-
MediaWiki reader:
- Allow HTML comment after row start (#8110).
-
DokuWiki reader:
- The
tex_math_dollarsextension is now supported fordokuwiki(but off by default) (#8178). - Content inside
<latex>...</latex>is parsed as raw LaTeX inline, and inside<LATEX>..</LATEX>as raw LaTeX block (#8178). - The behavior of
<php>...</php>is changed, so that instead of producing a code block, it produces raw HTML with<?php ... ?>.
- The
-
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-divswas 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
--mathmlto your command line if you want to continue producing MathML.
- 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
-
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
placetableenvironment is also given areferenceoption 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
\urlcommand. All other links, both internal and external, are created with the\gotocommand, 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/\stopsectionlevelby 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-divisioncommand line parameter is set to a non-default value.
-
-
Docx writer:
- Add
w:langtorPrfor 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.
- Add
-
ICML writer:
- Support custom-style attribute on Table (#8079).
-
AsciiDoc writer:
-
FB2 writer:
- Fix handling of non-section Divs (#8123).
-
Markdown writer:
- Disable soft wrapping when
hard_line_breaksenabled (#8035). We were already doing this formarkdown; this commit does the same thing formarkuaandcommonmarkandgfm. - Avoid excessive indentation on bullet lists for
commonmark,markua,gfm. They are now nested by 2 spaces instead of 4 (#8011).
- Disable soft wrapping when
-
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 classesimageandplaceholderare added, and path and title are store in attributesoriginal-image-srcandoriginal-image-title, respectively.
- Add new function
-
Text.Pandoc.Shared:
makeSections: don’t make a section for a div with class “fragments” (#8098).- Ensure that Nulls are ignored by
makeSectionand in segmenting slides (#8155). - Add
formatCodefunction 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
deLinkand 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
blocksToInlinesfrom T.P.Shared.
- 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
-
Text.Pandoc.Parsing:
- Simplify
gridTableWith',gridTableWith[API Change] (Albert Krewinkel). The functionsgridTableWithandgridTableWith'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.
- Simplify
-
Lua subsystem (Albert Krewinkel):
- Extend
pandoc.systemmodule (Albert Krewinkel, #8184). The module now has the additional functionslist_directory,make_directory, andremove_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
clonemethods to Pandoc objects and allows to pass Blocks in instead of full Caption elements. - Add fields
pandoc.readersandpandoc.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
mapandincludeson lists likePANDOC_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.
- Extend
-
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.fillfunction 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<contrib>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
\textormathto\TextOrMath(Hos Es, #8036). - Fix links-as-notes (Albert Krewinkel, #8077).
- Rename
-
HTML template styles:
- Remove
span.underlinerule. This is superfluous now that we render Underline as<u>. - Improve CSS for task lists (#8151).
- Remove
-
LaTeX template: Add
boxlinksvariable for LaTeX/PDF output (#8198). Ifboxlinksis set butcolorlinksis not, then boxes will be printed around links (hidelinkswill not be set inhypersetup). -
--self-contained: Handleurl()in<style>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.svgandbar/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
liftA2export from Prelude (Georgi Lyubenov, #8132). -
Update
default.cslfrom 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
nightlyflag. This causes a-nightly-COMPILEDATEsuffix 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 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, sayrefs, whose content is an empty div with idrefs, and the formatted bibliography will be put into this metadata field. It may then be interpolated into a template using the variablerefs. -
Ensure that you don’t get PDF output to terminal.
-t pdfnow behaves like-t docxand gives an error unless the output is redirected. -
--versionnow prints hslua version (#7929) and Lua version (#7997, Albert Krewinkel). -
Change
--metadata-fileparsing 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. -
--self-contained: issue warning rather than failing with an error if a resource can’t be found (#7904). -
New exported module Text.Pandoc.Readers.EndNote, exporting
readEndNoteXMLandreadEndNoteXMLCitation[API change]. -
New exported module, Text.Pandoc.Readers.RIS, exporting
readRIS(#7894) [API change]. -
LaTeX reader:
- Handle subequations as inline math environment (#7883).
- Rudimentary support for
vbox(#7939). - Support
\today(#7905). - Handle
\labeland\reffor 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 aCouldNotParseIncludeFilewarning 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
<a epub:type="noteref">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).
- Give warnings and emit empty note when parsing
-
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
Spanwith these attributes.
-
JATS reader:
- Improve handling of fn-group elements (#6348, Albert Krewinkel).
Footnotes in
<fn-group>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
issnandisbn; 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.
- Improve handling of fn-group elements (#6348, Albert Krewinkel).
Footnotes in
-
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 idrefs. -
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
citationsextension 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 thereferencesmetadata field so that it can be used with--citeproc.
- Enable
-
Docbook writer:
- Interpret links without contents as cross-references (#7360, Jan Tojnar).
Links without text contents are converted to
<xref>elements. DocBook processors will generate appropriate cross-reference text when presented with an xref element.
- Interpret links without contents as cross-references (#7360, Jan Tojnar).
Links without text contents are converted to
-
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
--whensmartenabled), so now we use the plain 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
-
LaTeX writer:
- Avoid extra space before
\CSLRightInline(#7932). - Add
scrreporttochaptersClasses(#6168, ivardb). - Support
page,trim,clipattributes 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.
- Avoid extra space before
-
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_identifiersextension is set (#7941). - Update escaping rules for
\. We now escape\only ifraw_texis enabled or it is followed by a non-alphanumeric.
-
JATS writer:
- Encode author “others” as
<etal/>(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<etal>element for this. - Avoid doubled ref-list element (#7990). Previously when generating JATS
with the
element_citationsextension enabled, the references were put in a doubly-nested ref-list element (<ref-list><ref-list>...). - 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’.
- Encode author “others” as
-
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
CouldNotParseIncludeFileconstructor forLogMessage[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
ordNubas alias fornubOrdfrom 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 addid_to the front. There is potential for duplication if there are alreadyid_...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_1will be used instead of1for the identifier. -
Lua (Albert Krewinkel).
- Add module
pandoc.layoutto 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, andfind_if. These previously required the argument to be of typefunction, which was too restrictive. - Inline: the type of Image captions is now
Inlinesinstead ofList. - Allow passing
Sourcestopandoc.read(#8002).
- Add module
-
Text.Pandoc.PDF:
- Restore
wkhtmltopdfas 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.
- Restore
-
Text.Pandoc.MediaBag: improve detection of absolute paths (#7881).
-
Text.Pandoc.Extensions:
- Remove
raw_texextension from list of commonmark extensions, and from thecommonmark_xdefaults. commonmark doesn’t parse raw TeX, and it doesn’t make sense to write it if we don’t parse it. - Remove
native_divsfrom allowed gfm extensions (#7965). This allows<div>to be suppressed using-raw_html. Previouslynative_divswas enabled but could not be suppressed, because it was not in the list of available extensions for commonmark-based formats.
- Remove
-
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'andgridTableWith'are now amf TableComponentsinstead of a quadruple of alignments, column widths, header rows and body rows. - Additional exports from Text.Pandoc.Parsing:
tableWith',TableComponents,TableNormalization,toTableComponents,toTableComponents'.
- Parse results of functions
-
-
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_identifiersand 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 <2.2'. Differences between 5.3 and 5.4 should not generally affect pandoc Lua filters. See list of incompatible changes here: https://www.lua.org/manual/5.4/manual.html#8.1 -
JATS template: allow multiple licenses (Albert Krewinkel).
-
LaTeX template:
- Skip
\babelprovideifbabel-langis empty (#7945) to avoid an error. - Move hyperref near end of preamble (#5811). It now comes after
header-includes and right before title, author, date, abstract.
Note: Users who presuppose hyperref in their header-includes
will now have to add
\usepackage{hyperref}to their header-includes to make it available there. (The redundant\usepackagewill do no harm in this case.) - Remove special redefinition of
\sout. This used to be necessary to avoid problems with hyperref, when headings contain strikeout text, but it does not seem to be necessary any more (tested).
- Skip
-
Tests: improve location reporting of failing tests (Albert Krewinkel).
-
Add tests for idempotency of
makeSections(#7950). -
Add armhf support in linux build script (#7944, Tony).
-
Use latest pandoc-types, so that toJSONFilter will work with Meta and MetaValue.
-
Use latest doclayout, texmath, commonmark, citeproc.
-
INSTALL.md: add reference to install via winget (#7951, Guriy Samarin).
-
MANUAL.txt:
- Document way to get list in block quote in slide shows (#7916).
- Minor changes to security section.
- Note that
smartworks for html input. - Fix typos (#7934, Dimitris Apostolou).
- Fix documentation for citations and org mode.
- Remove claim that
--self-containeddoes not work with--mathjax(#682).
-
doc/org.md: remove obsolete citations section. This mostly described citation formats we no longer support.
-
doc/lua-filters.md: Fix typo (#7981, Mario Lang).
-
Makefile: Use cabal for default build
-
Add
lua53cabal flag. It is false by default. If set to true, compile with hslua 2.1 and Lua 5.3, otherwise hslua 2.2 and Lua 5.4.
-
Support
pagedjs-clias 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:
-
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
--columnswidth, we need to adjust the widths of the pipe separators to encode this width information. -
Docx writer: Separate tables even with RawBlocks between (#7724, 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_listin 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
readDataFileandreadMetadataFilein 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,../../filewould evaluate tofile, when it should be unchanged. -
Search for metadata files in
$DATADIR/metadata(#7851, Even Brenden). If files specified with--metadata-fileare not found in the working directory, look in$DATADIR/metadata(#5876). -
Text.Pandoc.Class: export
readMetadataFile[API change] (#5876). -
Text.Pandoc.Error: export new
PandocCouldNotFindMetadataFileErrorconstructor forPandocError[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 oftokenizea SourcePos instead of SourceName, and use it instead oftotoks. -
Text.Pandoc.Shared: Modify
stringifyso it ignores[Citation]insideCite(#7855). Otherwise we’ll sometimes get two copies of things, one from thecitationPrefixorcitationSuffixand 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 runningqueryon the embeddedCitations; this will result in a jumble of text rather than anything structured. -
Omit
--enable-docin the cabal haddock invocation intools/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-diris used, the default user data directory should not be searched. -
Text.Pandoc.Shared:
defaultUserDataDirbehavior 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
--traceoption. Documentno-check-certificatein 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).
-
Support
markuaas 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
--wrapoption. With this change--wrapnow works for HTML. The default (as with other formats) is automatic wrapping. Note that the contents ofscript,textarea, andpretags are always laid out with theflushcombinator, 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-extensionsfor invalid formats (#7797). -
Make
--citeprocrecognize.ymlas well as.yamlextensions 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).
- Put sourcepos attribute on header, not enclosing div
with
-
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 thatprefixdoesn’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.
- Don’t allow
-
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 atextandname). 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.
- 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
-
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_listsextension is enabled, alphabetical list markers are allowed, mimicking the behaviour of Org Mode whenorg-list-allow-alphabeticalis 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 https://github.com/jgm/pandoc/issues/813#issuecomment-978232426. - 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\crefbut not for\ref. To support\crefwe need to store the environment label separately. - Add babel mappings for Guajati (gu) and Oriya (or) (#7815).
- Fix typo
panjabi->punjabiin babel mappings (#7814).
- Omit visible content for
-
HTML reader:
- Parse attributes on links and images (#6970).
-
Docx reader:
- Handle multiple pic elements inside a drawing (#7786).
- Change
elemToParPartto return[ParPart]instead ofParPart. Also removeNullParPartconstructor, as it is no longer needed. This will allow us to handle elements that contain multiple ParParts, e.g.w:drawingelements with multiplepic: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
writeMarkuafrom 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).
- Add new exported function
-
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 functionDoc. Example:function Doc (body, meta, vars) vars.date = vars.date or os.date '%B %e, %Y' return body, vars end - 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 aspandoc.utils.references, or to inspect the document contents withwalk().
- Allow variables to be set via second return value of
-
LaTeX writer:
- Fix typo
panjabi->punjabiin babel mappings (#7814).
- Fix typo
-
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 == fcase 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<dd>and after block-level elements in the footnotes section. And add a line break between animgtag and the associatedfigcaption. - reveal.js: Make sure images with
r-stretchare not in p tags. They must be direct children of the section. There was previously code to make this work with the older class namestretch, but the name has changed in reveal.js. - reveal.js: don’t add
r-fit-textclass to section. It must go on the header only.
- Make line breaks more consistent. With
-
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-reltotextrather thanparagraph-content.
- 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
-
JATS template (Albert Krewinkel):
- Fix position of contrib affiliations in authoring set. Any
<aff>element must come before any<email>element. - Fix affiliation tagging in
articleauthoringoutput. Affiliations werexlinked even in the articleauthoring tag set, but<aff>are not allowed as children ofcontrib-groupelements in that tag set. Each affiliation must be listed directly in the contrib element. - Add support for article subtitles.
- Fix position of contrib affiliations in authoring set. Any
-
EPUB template:
- Include abstract in default template.
- Ensure that the essential styles needed by pandoc (
styles.htmlpartial) are included in the templates. This is important for correct formatting of CSL bibliographies. Note that much of the styling instyles.htmlwill be ignored for EPUB, because of the conditional ondocument-css. Setting thedocument-cssvariable 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-titleis 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 anyPandocMonadtype. This is consistent with T.P.Readers, asreadCustomis not exported from that module either.
- Do not export
-
Text.Pandoc.Writers.Shared:
endsWithPlainnow 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 byextractMedia. It also led a check formediain resource paths to fail in the docx reader.
- Fix bug in
-
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, andLocatorMap. The type ofparseLocatorhas changed, so it now takes aLocatorMaprather than aLocaleas parameter, and returns aLocatorInfoinstead of a tuple. - Fix citation locator detection for German.
toLocatorMapnow stores keys case-folded. We want to do a case-insensitive comparison when parsing locators, so that e.g. bothChap.andchap.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.templatemodule. The module provides acompilefunction to use strings as templates. - Add
pandoc.WriterOptionsconstructor. - 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
Environmenttype 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.Blocksandpandoc.Inlines. The functions convert their argument into a list of Block and Inline values, respectively. When applied to a string, they split the string intoStrelements separated bySpaceorSoftBreak(#7712). - Support topdown traversals The traversal order of filters can now
be selected by setting the key
traverseof the filter to either'topdown'or'typewise'; the default remains'typewise'. Topdown traversals can be cut short by returningfalseas a second value from the filter function. No child-element of the returned element is processed in that case. - Marshal ReaderOptions field
extensions,track_changesvia 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 functionpandoc.readis 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 thepeekReadOptionsTablefunction was invoked. walkmethods are added toPandoc,Block,Inline,Blocks,Inlinesvalues; the methods are similar topandoc.utils.walk_blockandpandoc.utils.walk_inline, but apply to filter to the element’s contents.- Functions of name
Docare no longer accepted as alternatives forPandocfilter 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, andRowvalues (#7718). The objects now also follow the principle that element attributes are accessible through the.attrfield. Rows inTableHeadandTableFootare available via the.rowsfield. Row objects have a.cellsfield, 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 defaulttypefunction 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 (InlinesandBlocks, respectively). - Use more natural representation for Reference values
Omit
falseboolean 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
BlockandInlineelements are marshaled using the new list typesBlocksandInlines, 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
MetaValueare no longer pushed as values which have.tand.tagproperties. This was already true forMetaStringandMetaBoolvalues, which are still marshaled as Lua strings and booleans, respectively. Affected values:MetaBlocksvalues are marshaled as aBlockslist;MetaInlinesvalues are marshaled as aInlineslist;MetaListvalues are marshaled as a generic pandocLists.MetaMapvalues are marshaled as plain tables and no longer given any metatable.
Cellvalues are now marshaled as userdata objects; a constructor function for table cells is provided aspandoc.Cell.- The test suite for marshaled objects and their constructors has been extended and improved.
- A bug in
Citationobjects, where setting a citation’s suffix modified it’s prefix, has been fixed. - Inlines, Blocks, and List objects now have an
__eqmetamethod, 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.
-
Add interface for custom readers written in Lua (#7669). Users can now do
-f myreader.luaand pandoc will treat the scriptmyreader.luaas 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 indata/creole.lua. Also see documentation indoc/custom-readers.md. -
New module Text.Pandoc.Readers.Custom, exporting
readCustom[API change]. -
Allow
plainto 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.
-
DocBook reader:
- Add
<titleabbr>support (Rowan Rodrik van der Molen). - Support for
<indexterm>(#7607, Rowan Rodrik van der Molen).
- Add
-
LaTeX reader:
- Add rudimentary support for
\autoref(#7693). - Add ‘uri’ class when parsing
\url, for consistency with treatment of autolinks in other formats (#7672).
- Add rudimentary support for
-
JATS reader: Capture
alt-textin 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 theyamllibrary to emit an error unless we explicitly allow multiple YAML documents (and just consider the first). -
JATS writer:
- Ensure figures are wrapped with
<p>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
<uri>to element-citation entries.
- Ensure figures are wrapped with
-
HTML writer: Don’t create invalid
data-attribute for empty attribute key (#7546). -
LaTeX writer:
- Babel mappings: use
ancientgreekforgrc. - With
-t latex-smart, don’t generate\ldotsfrom ellipsis (#7674). Instead just use unicode ellipsis.
- Babel mappings: use
-
JATS template: fix
equal-contribattribute (Albert Krewinkel). The standard requires the value to be eitheryesorno, but is was set totruefor authors who contributed equally. -
reveal.js template: Add
disableLayoutvariable (Christophe Dervieux). -
Text.Pandoc.Error: sort errors in
handleErrorby exit code (Albert Krewinkel). -
Text.Pandoc.Writers.Shared: Improve toLegacyTable (#7683, Christian Despres).
-
Lua subsystem:
-
Include lpeg module (#7649, Albert Krewinkel). Compiles the
lpeglibrary (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 constraintlpeg +rely-on-shared-lpeg-library.lpegandreare always made available in global variables, without the need for arequire. -
Set
lpegandreas globals; allow shared lib access viarequire. Thelpegandremodules 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
requiremechanism 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.readas an optional third argument (#7656, Albert Krewinkel). The object can either be a table or a ReaderOptions value likePANDOC_READER_OPTIONS. Creating new ReaderOptions objects is possible through the new constructorpandoc.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-withfield to correspond toci.ymlmatrix -
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.luaas sample custom reader. -
Add
doc/custom-readers.mdanddoc/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.
-
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-imageattribute 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
marLandindentvalues 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 theotherStylein 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 thatotherStyleandbodyStyleindent 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
linesnumswitch (Samuel Tardieu). - Improve escaping for
--in URLs (#7529).
- Translate numberLines attribute to
-
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-includesto afterbabelsetup 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.
- Make babel use more idiomatic (#7604, hseg). Use babel’s
bidi implementation. Import babel languages individually instead
of as package options. Move
-
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
underlineclass rather thanulfor underline. This only affects output withbracketed_spansenabled. The markdown reader parses spans with either.ulor.underlineas Underline elements, but we’re moving towards preferring the latter.
-
RST writer:
-
HTML writer:
- Render
\refand\eqrefas inline math, not display (see #7589). - Pass through
\refand\eqrefif MathJax is used (#7587). - Pass through inline math environments with KaTeX.
- Support
--reference-locationfor 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.
- Render
-
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_mimetypeinstead offormat. Moreover, the mime-type of rst used in Jupyter deviated from that suggested by https://docutils.sourceforge.io/FAQ.html and is defined astext/restructuredtextwhen 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.
- 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
-
EPUB writer:
- Add EPUB3 subject metadata (authority/term) (nuew).
This adds the ability to specify EPUB 3
authorityandtermspecific refinements to thesubjecttag. Specifying a plainsubjecttag in metadata will function as before. - Treat epub:type “frontispiece” as front matter (#7600).
- Add EPUB3 subject metadata (authority/term) (nuew).
This adds the ability to specify EPUB 3
-
reveal.js template: Fix line numbers in source code (#7634). We need
overflow: visiblefor these to work, and reveal’s default css disables this. So we re-enable it in the default template. -
Text.Pandoc.Writers.Shared:
- Export
splitSentencesas 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].
- Export
-
Text.Pandoc.Translations: small revisions for compatibility with aeson 2.
-
Don’t prepend
file://to--syntax-definitionon 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_footnotesto defaultgfmetxensions. Nowgfmsupports footnotes. - Alphabetize Extension constructors (also affects
--list-extensions).
- Add
-
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.
newseriesorlibrary(#7591). Expansion should not happen when these strings are protected in braces, or when they’re capitalized. -
Text.Pandoc.Logging: add
NotUTF8Encodedconstructor toLogMessage[API change]. -
Text.Pandoc.App.FormatHeuristics: remove
.tei.xmlextension for TEI (#7630). This never worked, becausetakeExtensiononly returns.xml. So it won’t be missed if we remove it. -
Text.Pandoc.Image:
- Generalize
svgToPngto MonadIO. svgToPng, change first parameter from WriterOptions to Int.
- Generalize
-
Text.Pandoc.Class:
- Add
readStdinStrictmethod to PandocMonad [API change]. - Generalize type of
extractMedia[API change]. It was uselessly restricted to PandocIO, instead of any instance of PandocMonad and MonadIO.
- Add
-
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
applyFiltersfrom 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
runLuais now(PandocMonad m, MonadIO m) => LuaE PandocError a -> m (Either PandocError a)The change from
LuatoLuaE PandocErroris 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, andInlineMath. - 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 givepandoc.Str 'test', but yieldsnilnow. This was undocumented behavior not intended to be used in user scripts. Use named properties instead. - Accessing
.cto 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 ofAttrvalues. Values of this type can often be passed to constructors instead ofAttrvalues. - Convert IOErrors to PandocErrors in
pandoc.pipefunction (#7523).
-
Text.Pandoc.PDF: Previously we had to run
runIOorExplodeinsidewithTempDir. 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
simpleFigurebuilder in readers andSimpleFigurepattern 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.epubvalid. -
Add missing
%on some command tests. This prevented--acceptfrom 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
attributesextension 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).
- Clarify
-
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).
-
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).
rtfis now supported as an input format as well as an output format. New module Text.Pandoc.Readers.RTF (exportingreadRTF). [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 whenraw_texis disabled. Thanks to Augustin Laville for noticing the bug. - Multimarkdown sub- and superscripts (#5512, OCzarnecki).
Added an extension
short_subsuperscriptswhich modifies the behavior ofsubscriptandsuperscript, allowing subscripts or superscripts containing only alphanumerics to end with a space character (eg.x^2 = 4orH~2 is combustible). This improves support for multimarkdown.
- Fix raw LaTeX injection issue (#7497). Using a code block
containing
-
RST reader: Fix
:literal:includes (#7513). These should create code blocks, not insert raw RST. -
LaTeX reader:
- Proper implicit grouping around environment macros.
- Support
\globalbefore\def,\let, etc. (#7494). - Fix scope for LaTeX macros (#7494). They should by default
scope over the group in which they are defined (except
\gdefand\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.
) 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.
- Include image title in description (#7352, Emily Bourke). The
image title (i.e.
-
Docx writer: be sensitive to the
native_numberingextension (#7499). Figure and table numbers are now only included ifnative_numberingis 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
\binin\pict. According to the spec, this is not needed or wanted when the data is in hexadecimal format, as here. - Emit `\outlinelevel`` for section headings.
- Omit
-
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
strikeoutvariable is set, so we set this when there is underlined text, and use\ulineinstead 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.
- 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
-
Text.Pandoc.Logging: Add PowerpointTemplateWarning log message type [API change] (Emily Bourke).
-
Text.Pandoc.Extension: Add
Ext_short_subsuperscriptsconstructor toExtension[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-leveldocs. -
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 thatrebase_relative_pathswould 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
cdLinein OOXML golden tests (Emily Bourke). ThecdLinefield 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).
-
MANUAL.txt
- Clarifications (William Lupton).
- Add a note on security risks of include directives.
-
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).
-
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
<col/>. 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 byhtmlTag. -
LaTeX reader:
- Avoid trailing hyphen in translating languages (#7447).
Previously
\foreignlanguage{english}turned into<span lang="en-">. The same issue affected Arabic. - Support
\clinein 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.
- Avoid trailing hyphen in translating languages (#7447).
Previously
-
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 adata-externalattribute as anexternalattribute in the pandoc AST. - Add col, colgroup to ‘closes’ definitions
- Recognize data-external when reading HTML img tags (#7429,
Michael Hoffmann). Preserve all attributes in img tags. If attributes
have a
-
HTML writer:
- Remove duplicated alt text in HTML output (Aner Lucero).
- Remove
aria-hiddenwhen 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 associatedexternalattribute. -
Text.Pandoc.PDF:
- Fix
svgInpath 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.
- Fix
-
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--citeproccould 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 ifnotes-after-punctuationistrue.
- Allow
-
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 booleanfalsevalues, 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\AtEndPreamblefor cases when the contents ofheader-includesneed 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.
-
Fix MediaBag regressions (#7345). iIn the 2.14 release
--extract-mediastopped 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). ThemediaPathin 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,
mediaDirectoryandmediaItemsnow use themediaPath, 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 thatmediaItemsreturns both the keys and the MediaItems.In Text.Pandoc.Class.IO, rewriting of source paths in
extractMediahas been fixed.In Text.Pandoc.Class.PandocMonad,
fillMediaBaghas 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--verboseoutput 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_attributesis enabled.Ext_attributescovers at least the following:Ext_fenced_code_attributes,Ext_header_attributes,Ext_inline_code_attributes,Ext_link_attributes.
-
Markdown writer:
- Allow
pipe_tablesto be disabled for commonmark formats (commonmark_x,gfm) (#7375). - Re-use functions from Text.Pandoc.Markdown.Inline (Jan Tojnar).
- Allow
-
DocBook writer: Remove non-existent admonitions (Jan Tojnar).
attention,errorandhintare 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..vsfortext/plain. These special cases help us get the most standard extensions for mime types liketext/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
referencesfield), we should still only include in the bibliography items that are actually cited (unlessnociteis 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).
-
Change reader types, allowing better tracking of source positions [API change]. Previously, when multiple file arguments were provided, pandoc simply concatenated them and passed the contents to the readers, which took a Text argument. As a result, the readers had no way of knowing which file was the source of any particular bit of text. This meant that we couldn’t report accurate source positions on errors or include accurate source positions as attributes in the AST. More seriously, it meant that we couldn’t resolve resource paths relative to the files containing them (see e.g. #5501, #6632, #6384, #3752).
-
Add
rebase_relative_pathsextension (#3752). When enabled, this extension rewrites relative image and link paths by prepending the (relative) directory of the containing file. This behavior is useful when your input sources are split into multiple files, across several directories, with files referring to images stored in the same directory. The extension can be enabled for all markdown and commonmark-based formats. -
Add Text.Pandoc.Sources (exported module), with a
Sourcestype and aToSourcesclass. ASourceswraps a list of(SourcePos, Text)pairs [API change]. A parsecStreaminstance is provided forSources. The module also exports versions of parsec’ssatisfyand other Char parsers that track source positions accurately from aSourcesstream (or any instance of the newUpdateSourcePosclass). -
Text.Pandoc.Parsing
- Export the modified Char parsers defined in Text.Pandoc.Sources
instead of the ones parsec provides. Modified parsers to use a
Sourcesas stream [API change]. - Improve include file functions [API change]. Remove old
insertIncludedFileF. GiveinsertIncludedFilea more general type, allowing it to be used whereinsertIncludedFileFwas. - Add parameter to the
citeKeyparser from Text.Pandoc.Parsing, which controls whether the@{..}syntax is allowed [API change].
- Export the modified Char parsers defined in Text.Pandoc.Sources
instead of the ones parsec provides. Modified parsers to use a
-
Text.Pandoc.Error: Modified the constructor
PandocParsecErrorto take aSourcesrather than aTextas first argument, so parse error locations can be accurately reported. -
Fix source position reporting for YAML bibliographies (#7273).
-
Issue error message when reader or writer format is malformed (#7231). Previously we exited with an error status but (due to a bug) no message.
-
Smarter smart quotes (#7216, #2103). Treat a leading
"with no closing"as a left curly quote. This supports the practice, in fiction, of continuing paragraphs quoting the same speaker without an end quote. It also helps with quotes that break over lines in line blocks. -
Markdown reader:
- Use MetaInlines not MetaBlocks for multimarkdown metadata fields. This gives better results in converting to e.g. pandoc markdown.
- Implement curly-brace syntax for Markdown citation keys (#6026).
The change provides a way to use citation keys that contain
special characters not usable with the standard citation key syntax.
Example:
@{foo_bar{x}'}for the keyfoo_bar{x}. It also allows separating citation keys from immediately following text, e.g.@{foo}A.
-
RST reader:
- Seek include files in the directory of the file containing the include directive, as RST requires (#6632).
- Use
insertIncludedFilefrom Text.Pandoc.Parsing instead of reproducing much of its code.
-
Org reader: Resolve org includes relative to the directory containing the file containing the INCLUDE directive (#5501).
-
ODT reader: Treat tabs as spaces (#7185, niszet).
-
Docx reader:
- Add handling of vml image objects (#7257, mbrackeantidot).
- Support new table features (Emily Bourke, #6316): column spans, row spans, multiple header rows, table description (parsed as a simple caption), captions, column widths.
-
LaTeX reader:
- Improved siunitx support (#6658, #6620).
- Better support for
\xspace(#7299). - Improve parsing of
\defmacros. We previously set “verbatim mode” even for parsing the initial\def; this caused problems for\defnested inside another\def. - Implement
\newif.
-
ConTeXt writer: improve ordered lists (#5016, Denis Maier). Change ordered list from itemize to enumerate. Add new itemgroup for ordered lists. Remove manual insertion of width attributes. Use tabular figures in ordered list enumerators.
-
HTML reader:
- Don’t fail on unmatched closing “script” tag (Albert Krenkel, #7282).
- Keep h1 tags as normal headers (#2293, Albert Krewinkel).
The tags
<title>and<h1 class="title">often contain the same information, so the latter was dropped from the document. However, as this can lead to loss of information, the heading is now always retained. Use--shift-heading-level-by=-1to turn the<h1>into the document title, or a filter to restore the previous behavior. - Handle relative lengths (e.g.
2*) in HTML column widths (#4063). See https://www.w3.org/TR/html4/types.html#h-6.6.
-
DocBook/JATS readers:
- Fix mathml regression caused by the switch in XML libraries (#7173).
- Fix “phrase” in DocBook: take classes from “role” not “class” (#7195).
-
DocBook reader: ensure that first and last names are separated (#6541).
-
Jira reader (Albert Krewinkel, #7218):
- Support “smart” links:
[alias|https://example.com|smart-card]syntax. - Allow spaces and most unicode characters in attachment links.
- No longer require a newline character after
{noformat}. - Only allow URI path segment characters in bare links.
- The
file:schema is no longer allowed in bare links; these rarely make sense.
- Support “smart” links:
-
Plain writer: handle superscript unicode minus (#7276).
-
LaTeX writer:
- Better handling of line breaks in simple tables (#7272). Now we also handle the case where they’re embedded in other elements, e.g. spans.
- For beamer output, support
exampleblockandalertblock(#7278). A block will be rendered as anexampleblockif the heading has classexampleand analertblockif it has classalert. - Separate successive quote chars with thin space (#6958, Albert Krewinkel). Successive quote characters are separated with a thin space to improve readability and to prevent unwanted ligatures. Detection of these quotes sometimes had failed if the second quote was nested in a span element.
- Separate successive quote chars with thin space (#6958, Albert Krewinkel).
-
EPUB Writer: Fix belongs-to-collection XML id choice (#7267, nuew). The epub writer previously used the same XML id for both the book identifier and the epub collection. This causes an error on epubcheck.
-
BibTeX/BibLaTeX writer: Handle
annotefield (#7266). -
ZimWiki writer: allow links and emphasis in headers (#6605, Albert Krewinkel).
-
ConTeXt writer:
- Support blank lines in line blocks (#6564, Albert Krewinkel, thanks to @denismaier).
- Use span identifiers as reference anchors (#7246, Albert Krewinkel).
-
HTML writer:
- Keep attributes from code nested below
pretag (#7221, Albert Krewinkel). If a code block is defined with<pre><code class="language-x">…</code></pre>, where the<pre>element has no attributes, then the attributes from the<code>element are used instead. Any leadinglanguage-prefix is dropped in the code’sclassattribute are dropped to improve syntax highlighting. - Ensure headings only have valid attribs in HTML4 (#5944, Albert Krewinkel).
- Parse
<header>as a Div (Albert Krewinkel).
- Keep attributes from code nested below
-
Org writer:
- Inline latex envs need newlines (#7252, tecosaur). As specified in https://orgmode.org/manual/LaTeX-fragments.html, an inline \begin{}…\end{} LaTeX block must start on a new line.
- Use LaTeX style maths deliminators (#7196, tecosaur).
-
JATS writer (Albert Krewinkel):
- Use either styled-content or named-content for spans (#7211).
If the element has a content-type attribute, or at least one class,
then that value is used as
content-typeand the span is put inside a<named-content>element. Otherwise a<styled-content>element is used instead. - Reduce unnecessary use of
<p>elements for wrapping (#7227). The<p>element is used for wrapping in cases were the contents would otherwise not be allowed in a certain context. Unnecessary wrapping is avoided, especially around quotes (<disp-quote>elements). - Convert spans to
<named-content>elements (#7211). Spans with attributes are converted to<named-content>elements instead of being wrapped with<milestone-start/>and<milestone-end>elements. Milestone elements are not allowed in documents using the articleauthoring tag set, so this change ensures the creation of valid documents. - Add footnote number as label in backmatter (#7210). Footnotes in the backmatter are given the footnote’s number as a label. The articleauthoring output is unaffected from this change, as footnotes are placed inline there.
- Escape disallows chars in identifiers. XML identifiers must start
with an underscore or letter, and can contain only a limited set
of punctuation characters. Any IDs not adhering to these rules are
rewritten by writing the offending characters as
Uxxxx, wherexxxxis the character’s hex code.
- Use either styled-content or named-content for spans (#7211).
If the element has a content-type attribute, or at least one class,
then that value is used as
-
Jira writer: use
{color}when span has a color attribute (Albert Krewinkel, tarleb/jira-wiki-markup#10). -
Docx writer:
- Autoset table width if no column has an explicit width (Albert Krewinkel).
- Extract Table handling into separate module (Albert Krewinkel).
- Support colspans and rowspans in tables (Albert Krewinkel, #6315).
- Support multirow table headers (Albert Krewinkel).
- Improve integration of settings from reference.docx (#1209).
This change allows users to create a reference.docx that
sets
w:proofStatefor spelling or grammar todirty, so that spell/grammar checking will be triggered on the generated docx. - Copy over more settings from reference.docx (#7240). From settings.xml
in the reference-doc, we now include:
zoom,embedSystemFonts,doNotTrackMoves,defaultTabStop,drawingGridHorizontalSpacing,drawingGridVerticalSpacing,displayHorizontalDrawingGridEvery,displayVerticalDrawingGridEvery,characterSpacingControl,savePreviewPicture,mathPr,themeFontLang,decimalSymbol,listSeparator,autoHyphenation,compat. - Set zoom to 100% by default in settings.xml.
- Align math options more with current Word defaults (e.g. Cambria Math font).
- Remove
rsids from default settings.xml. Word will add these when revisions are made.
-
Ms writer: Handle tables with multiple paragraphs (#7288). Previously they overflowed the table cell width. We now set line lengths per-cell and restore them after the table has been written.
-
Markdown writer:
- Use cleaner braceless syntax for code blocks with a single class (#7242, Jan Tojnar).
- Add quotes properly in markdown YAML metadata fields (#7245). This fixes a bug, which caused the writer to look at the last rather than the first character in determining whether quotes were needed. So we got spurious quotes in some cases and didn’t get necessary quotes in others.
- Use
@{..}syntax for citations when needed. - Use fewer unneeded escapes for
#(see #6259). - Improve escaping of
@. We need to escape literal@before{because of the new citation syntax.
-
Commonmark writer: Use backslash escapes for
<and|… instead of entities (#7208). -
Powerpoint writer: allow
monofontto be specified in metadata (#7187). -
LaTeX template:
- Use non-starred names for xcolor color names (#6109). This should make svgnames and x11names work properly.
- Fix bad vertical spacing after bibliography (#7234, badumont).
- List of figures before list of tables (#7235, Julien Dutant).
- Move CSL macro definitions before header-includes so they can be overridden (#7286).
- Improve treatment of CSL
entry-spacing(#7296). Previously with the default template settings (indentvariable not set), we would get interparagraph spaces separating bib entries even withentry-spacing="0". On the other hand, settingentry-spacing="2"gave ridiculously large spacing. This change makes the spacing caused byentry-spacinga multiple of\parskipby default, which gives aesthetically reasonable output. Those who want a larger or smaller unit (e.g. because they useindentwhich sets\parskipto 0) may\setlength{\cslentryspacingunit}{10pt}in header-includes to override the defaults. - Move title, author, date up to top of preamble (#7295). This allows header-includes to use them, and puts them in a position where you can see them immediately.
- Define commands for zero width non-joiner character (#6639, Albert Krewinkel). The zero-width non-joiner character is used to avoid ligatures (e.g. in German).
-
ConTeXt template:
- Define
enumerateitemgroup (#5016, Denis Maier). - List of figures before list of tables (#7235, Julien Dutant).
- Define
-
reveal.js template:
- Support
toc-title(#7171, Florian Kohrt). - Use
hash: trueby default rather thanhistory: true(#6968).
- Support
-
HTML-based slide shows: add support for
institute(#7289, Thomas Hodgson). -
Text.Pandoc.Extensions: Add constructor
Ext_rebase_relative_pathstoExtensions[API change]. -
Text.Pandoc.XML.Light: add Eq, Ord instances for Content, Element, Attr, CDataKind [API change].
-
Text.Pandoc.MediaBag:
- Change type to use a
Textkey instead of[FilePath]. We normalize the path and use/separators for consistency. - Export
MediaItemtype [API change]. - Change
MediaBagtype to a map from Text to MediaItem [API change]. lookupMedianow returns aMediaItem[API change].- Change
insertMediaso it sets themediaPathto a filename based on the SHA1 hash of the contents. This will be used when contents are extracted.
- Change type to use a
-
Text.Pandoc.Class.PandocMonad:
- Remove
fetchMediaResource[API change]. UsefetchItemto get resources infillMediaBag. - Add informational message in
downloadOrReadindicating what path local resources have been loaded from.
- Remove
-
Text.Pandoc.Logging:
- Remove single quotes around paths in messages.
- Add LoadedResource constructor to LogMessage [API change]. This is for INFO-level messages telling where image data has been loaded from. (This can vary because of the resource path.)
-
Text.Pandoc.Asciify: simplify code and export
toAsciiText[API change]. Instead of encoding a giant (and incomplete) map, we now just use unicode-transforms to normalize the text to a canonical decomposition, and manipulate the result. -
App: allow tabs expansion even if file-scope is used (Albert Krewinkel, #6709). Tabs in plain-text inputs are now handled correctly, even if the
--file-scopeflag is used. -
Add new internal module Text.Pandoc.Writers.GridTable (Albert Krewinkel).
-
Text.Pandoc.Highlighting: Change type of
languagesByExtension, adding a parameter for aSyntaxMap[API change] (Jan Tojnar, #7241). Languages defined using--syntax-definitionwere not recognized bylanguagesByExtension. This patch corrects that, allowing the writers to see all custom definitions. The LaTeX writer still uses the default syntax map, but that’s okay in that context, since--syntax-definitionwon’t create new listings styles. -
Text.Pandoc.Citeproc:
- Ensure that CSL-related attributes are passed on to a Div with id
‘refs’. Otherwise things like
entry-spacingwon’t work when such Divs are used. - Use metadata’s
langfor the lang parameter of citeproc, overridinglocaleLanguage. - Recognize locators spelled with a capital letter (#7323).
- Add a comma and a space in front of the suffix if it doesn’t start with space or punctuation (#7324).
- Don’t detect math elements as locators (#7321).
- Ensure that CSL-related attributes are passed on to a Div with id
‘refs’. Otherwise things like
-
Remove Text.Pandoc.BCP47 module [API change]. Use types and functions from UnicodeCollation.Lang instead. This is a richer implementation of BCP 47.
-
Text.Pandoc.Shared:
- Fix regression in grid tables for wide characters (#7214).
In the translation from String to Text, a char-width-sensitive
splitAt'was dropped. This commit reinstates it and uses it to makesplitTextByInstanceschar-width sensitive. - Add
getLang(formerly in the now-removed BCP47) [API change].
- Fix regression in grid tables for wide characters (#7214).
In the translation from String to Text, a char-width-sensitive
-
Text.Pandoc.SelfContained: use
application/octet-streamfor unknown mime types instead of halting with an error (#7202). -
Lua filters: respect Inlines/Blocks filter functions in
pandoc.walk_*(Albert Krewinkel). -
Add text as build-depend for trypandoc (#7193, Roman Beránek).
-
Bump upper-bounds for network-uri, time, attoparsec.
-
Use citeproc 0.4.
-
Use texmath 0.12.3.
-
Use jira-wiki-markup 1.3.5 (Albert Krewinkel).
-
Require latest skylighting (fixes a bug in XML syntax highlighting).
-
Use latest xml-conduit.
-
Use latest commonmark, commonmark-extensions, commonmark-pandoc.
-
Use haddock-library-1.10.0 (Albert Krewinkel).
-
Allow compilation with base 4.15 (Albert Krewinkel).
-
MANUAL:
- Add information about
langand bibliography sorting. - Add info about YAML escape sequences, link to spec (#7152, Albert Krewinkel).
- Note that
institutevariable works for HTML-based slides. - Update documentation on citation syntax.
- Add citation example for locators and suffixes (Tristan Stenner)
- Add information about
-
Updated and fixed typos in documentation (Charanjit Singh, Anti-Distinctlyminty, Tatiana Porras, obcat).
-
Add instructions for installing pandoc-types before compiling filter.
-
INSTALL: add note that parallel installations should be avoided (#6865).
-
Remove
biblatex-nussbaum.mdtest. It is basically the same asbiblaetx-quotes.md. -
Command tests: fail if a file contains no tests—and fix a test that failed in that way!
-
Use smaller images in tests, reducing the size of the source tarball by 8 MB.
-
Support
yaml_metadata_blockextension forcommonmark,gfm(#6537). This supported is a bit more limited than with pandoc’smarkdown. The YAML block must be the first thing in the input, and the leaf notes are parsed in isolation from the rest of the document. So, for example, you can’t use reference links if the references are defined later in the document. -
Fix fallback to default partials when custom templates are used. If the directory containing a template does not contain the partial, it should be sought in the default templates, but this was not working properly (#7164).
-
Handle
nocitebetter with--biblatexand--natbib(#4585). Previously the nocite metadata field was ignored with these formats. Now it populates anocite-idstemplate variable and causes a\nocitecommand to be issued. -
Text.Pandoc.Citeproc: apply
fixLinkscorrectly (#7130). This is code that incorporates a prefix likehttps://doi.org/into a following link when appropriate. -
Text.Pandoc.Shared:
- Remove
backslashEscapes,escapeStringUsing[API change]. Replace these inefficient association list lookups with more efficient escaping functions in the writers that used them (for a 10-25% performance boost in org, haddock, rtf, texinfo writers). - Remove
ToString,ToTexttypeclasses [API change]. These were needed for the transition from String to Text, but they are no longer used and may clash with other things. - Simplify
compactDL.
- Remove
-
Text.Pandoc.Parsing:
- Change type of
readWithMso that it is no longer polymorphic [API change]. TheToTextclass has been removed, and now that we’ve completed the transition to Text we no longer need this to operate on Strings. - Remove
Ftype synonym [API change]. Muse and Org were defining their ownFanyway.
- Change type of
-
Text.Pandoc.Readers.Metadata:
- Export
yamlMetaBlock[API change]. - Make
yamlBsToMeta,yamlBsToRefspolymorphic on the parser state [API change].
- Export
-
Markdown reader: Fix regression with
tex_math_backslash(#7155). -
MediaWiki reader: Allow block-level content in notes (ref) (#7145).
-
Jira reader (Albert Krewinkel):
- Fixed parsing of autolinks (i.e., of bare URLs in the text). Previously an autolink would take up the rest of a line, as spaces were allowed characters in these items.
- Emoji character sequences no longer cause parsing failures. This was due to missing backtracking when emoji parsing fails.
- Mark divs created from panels with class “panel”.
-
RST reader: fix logic for ending comments (#7134). Previously comments sometimes got extended too far.
-
DocBook writer: include Header attributes as XML attributes on section (Erik Rask). Attributes with key names that are not allowed as XML attributes are dropped, as are attributes with invalid values and
xml:id(DocBook 5) andid(DocBook 4). -
Docx writer:
- Make
nsidinabstractNumdeterministic. Previously we assigned a random number, but we don’t need random values, so now we just assign a value based on the list marker. - Use integral values for
w:tblW(#7141).
- Make
-
Jira writer (Albert Krewinkel):
- Block quotes are only rendered as
bq.if they do not contain a linebreak. - Jira writer: improve div/panel handling. Include div attributes in
panels, always render divs with class
panelas panels, and avoid nesting of panels.
- Block quotes are only rendered as
-
HTML writer: Add warnings on duplicate attribute values. This prevents emitting invalid HTML. Ultimately it would be good to prevent this in the types themselves, but this is better for now.
-
Org writer: Prevent unintended creation of ordered list items (#7132, Albert Krewinkel). Adjust line wrapping if default wrapping would cause a line to be read as an ordered list item.
-
JATS templates: support ‘equal-contrib’ attrib for authors (Albert Krewinkel). Authors who contributed equally to a paper may be marked with
equal-contrib. -
reveal.js template: replace JS comment with HTML (#7154, Florian Kohrt).
-
Text.Pandoc.Logging: Add
DuplicateAttributeconstructor toLogMessage. [API change] -
Use
-j4for linux release build. This speeds up the build dramatically on arm. -
cabal.project: remove ghcoptions. Move flags to top level, so they can be set differently on the command line.
-
Require latest texmath, skylighting, citeproc, jira-wiki-markup. (The latest skylighting fixes a bad bug with Haskell syntax highlighting.) Narrow version bounds for texmath, skylighting, and citeproc, since the test output depend on them.
-
Use doclayout 0.3.0.2. This significantly reduces the time and memory needed to compile pandoc.
-
Use
foldl'instead offoldleverywhere. -
Update bounds for random (#7156, Alexey Kuleshevich).
-
Remove uses of some partial functions.
-
Don’t bake in a larger stack size for the executable.
-
Test improvements:
- Use
getExecutablePathfrom base, avoiding the dependency onexecutable-path. - Factor out
setupEnvironmentin Helpers, to avoid code duplication. - Fix finding of data files by setting teh
pandoc_datadirenvironment variable when we shell out to pandoc. This avoids the need to use--data-dirfor the tests, which caused problems findingpandoc.luawhen compiling without theembed_data_filesflag (#7163).
- Use
-
Benchmark improvements:
- Build
+RTS -A8m -RTSinto default ghc-options for benchmark. This is necessary to get accurate benchmark results; otherwise we are largely measuring garbage collecting, some not related to the current benchmark. - Allow specifying BASELINE file in ‘make bench’ for comparison (otherwise the latest benchmark is chosen by default).
- Force
readFilein benchmarks early (Bodigrim).
- Build
-
CONTRIBUTING: suggest using a
cabal.project.localfile (#7153, Albert Krewinkel). -
Add ghcid-test to Makefile. This loads the test suite in ghcid.
-
--resource-pathnow accumulates if specified multiple times (#6152). Resource paths specified later on the command line are prepended to those specified earlier. Thus,--resource-path foo --resource-path bar:bazis equivalent to--resource-path bar:bas:foo. (The previous behavior was for the last--resource-pathto replace all the rest.)resource-pathin defaults files behaves the same way: it will be prepended to the resource path set by earlier command line options or defaults files. This change facilitates the use of multiple defaults files: each can specify a directory containing resources it refers to without clobbering the resource paths set by the others. -
Allow defaults files to refer to the home directory, the user data directory, and the directory containing the defaults file itself (#5871, #5982, #5977). In fields that expect file paths (and only in these fields),
${VARIABLE}will expand to the value of the environment variableVARIABLE(and in particular${HOME}will expand to the path of the home directory). A warning will be raised for undefined variables.${USERDATA}will expand to the path of the user data directory in force when the defaults file is being processed.${.}will expand to the directory containing the defaults file. (This allows default files to be placed in a directory containing resources they make use of.)
-
When downloading content from URL arguments, be sensitive to the character encoding (#5600). We can properly handle UTF-8 and latin1 (ISO-8859-1); for others we raise an error. Fall back to latin1 if no charset is given in the mime type and UTF-8 decoding fails.
-
Allow abbreviations that don’t end in a period to be specified using
--abbreviations(#7124). -
Add new unexported module Text.Pandoc.XML.Light, as well as Text.Pandoc.XML.Light.Types, Text.Pantoc.XML.Light.Proc, Text.Pandoc.XML.Light.Output. (Closes #6001, #6565, #7091).
This module exports definitions of
ElementandContentthat are isomorphic to xml-light’s, but with Text instead of String. This allows us to keep most of the code in existing readers that use xml-light, but avoid lots of unnecessary allocation.We also add versions of the functions from xml-light’s Text.XML.Light.Output and Text.XML.Light.Proc that operate on our modified XML types, and functions that convert xml-light types to our types (since some of our dependencies, like texmath, use xml-light).
We export functions that use xml-conduit’s parser to produce an
Elementor[Content]. This allows existing pandoc code to use a better parser without much modification.The new parser is used in all places where xml-light’s parser was previously used. Benchmarks show a significant performance improvement in parsing XML-based formats (with docbook, opml, jats, and docx almost twice as fast, odt and fb2 more than twice as fast).
In addition, the new parser gives us better error reporting than xml-light. We report XML errors, when possible, using the new
PandocXMLErrorconstructor inPandocError.These changes revealed the need for some changes in the tests. The docbook-reader.docbook test lacked definitions for the entities it used; these have been added. And the docx golden tests have been updated, because the new parser does not preserve the order of attributes.
-
DocBook reader:
- Avoid expensive tree normalization step, as it is not necessary with the new XML parser.
- Support
informalfigure(#7079) (Nils Carlson).
-
Docx reader:
- Use Map instead of list for Namespaces. This gives a speedup of about 5-10%. With this and the XML parsing changes, the docx reader is now about twice as fast as in the previous release.
-
HTML reader:
- Small performance tweaks.
- Also, remove exported class
NamedTag(..)[API change]. This was just intended to smooth over the transition from String to Text and is no longer needed. - As a result, the functions
isInlineTagandisBlockTagare no longer polymorphic; they apply to aTag Text[API change]. - Do a lookahead to find the right parser to use. This takes benchmarks from 34ms to 23ms, with less allocation.
- Fix bad handling of empty
srcattribute iniframe(#7099). Ifsrcis empty, we simply skip theiframe. Ifsrcis invalid or cannot be fetched, we issue a warning nd skip instead of failing with an error.
-
JATS reader:
- Avoid tree normalization, which is no longer necessary given the new XML parser.
-
LaTeX reader:
- Don’t export
tokenize,untokenize[API change]. These are internal implementation details, which were only exported for testing. They don’t belong in the public API. - Improved efficiency of the parser. With these changes the reader is almost twice as fast as in the last release in our benchmarks.
- Code cleanup, removing some unnecessary things.
- Rewrite
withRawso it doesn’t rely on fragile assumptions about token positions (which break when macros are expanded) (#7092). This requires the addition ofsEnableWithRawandsRawTokensinLaTeXState, and a new combinatordisablingWithRawto disable collecting of raw tokens in certain contexts. AddparseFromToksto Text.Pandoc.Readers.LaTeX.Parsing. Fix parsing of single character tokens so it doesn’t mess up the new raw token collecting. These changes slightly increase allocations and have a small performance impact. - Handle some bibtex/biblatex-specific commands that used to be dealt with in pandoc-citeproc (#7049).
- Optimize
satisfyTok, avoiding unnecessary macro expansion steps. Benchmarks after this change show 2/3 of the run time and 2/3 of the allocation of the Feb. 10 benchmarks. - Removed
sExpandedin state. This isn’t actually needed and checking it doesn’t change anything. - Improve
braced'. Remove the parameter, have it parse the opening brace, and make it more efficient. - Factor out pieces of the LaTeX reader to make the module smaller. This reduces memory demands when compiling. Created Text.Pandoc.Readers.{LaTeX,Math,Citation,Table,Macro,Inline}. Changed Text.Pandoc.Readers.LaTeX.SIunitx to export a command map instead of individual commands.
- Handle table cells containing
&in\verb(#7129).
- Don’t export
-
Make Text.Pandoc.Readers.LaTeX.Types an unexported module [API change].
-
Markdown reader:
- Improved handling of mmd link attributes in references (#7080). Previously they only worked for links that had titles.
- Improved efficiency of the parser (benchmarks show a 15% speedup).
-
OPML reader:
- Avoid tree normalization, which is no longer necessary with the new XML parser.
-
ODT reader:
- Finer-grained errors on parse failure (#7091).
- Give more information if the zip container can’t be unpacked.
-
Org reader:
- Support
task_listsextension (Albert Krewinkel, #6336). - Fix bug in org-ref citation parsing (Albert Krewinkel, #7101). The org-ref syntax allows to list multiple citations separated by comma. Previously commas were accepted as part of the citation id, so all citation lists were parsed as one single citation.
- Support
-
RST reader:
- Use
getTimestampinstead ofgetCurrentTimeto fetch timestamp. SettingSOURCE_DATE_EPOCHwill allow reproducible builds. - RST reader: fix handling of header in CSV tables (#7064). The interpretation of this line is not affected by the delim option.
- Use
-
Jira reader:
- Modified the Doc parser to skip leading blank lines. This fixes parsing of documents which start with multiple blank lines (Albert Krewinkel, #7095).
- Prevent URLs within link aliases to be treated as autolinks (Albert Krewinkel, #6944).
-
Text.Pandoc.Shared
- Remove formerly exported functions that are no longer used in the
code base:
splitByIndices,splitStringByIndicies,substitute, andunderlineSpan(which had been deprecated in April 2020) [API change]. - Export
handleTaskListItem(Albert Krewinkel) [API change]. - Change
defaultUserDataDirstodefaultUserDataDir[API change]. We determine what is the default user data directory by seeing whether the XDG directory and/or legacy directory exist.
- Remove formerly exported functions that are no longer used in the
code base:
-
BibTeX writer:
- BibTeX writer: use doclayout and doctemplate. This change allows
bibtex/biblatex output to wrap as other formats do,
depending on the settings of
--wrapand--columns(#7068).
- BibTeX writer: use doclayout and doctemplate. This change allows
bibtex/biblatex output to wrap as other formats do,
depending on the settings of
-
CSL JSON writer:
- Output
[]if no references in input, instead of raising a PandocAppError as before.
- Output
-
Docx writer:
- Use
getTimestampinstead ofgetCurrentTimefor timestamp. SettingSOURCE_DATE_EPOCHwill allow reproducible builds.
- Use
-
EPUB writer:
- Use
getTimestampinstead ofgetCurrentTimefor timestamp. SettingSOURCE_DATE_EPOCHwill allow reproducible builds (#7093). This does not suffice to fully enable reproducible in EPUB, since a unique id is still being generated for each build. - Support
belongs-to-collectionmetadata (#7063) (Nick Berendsen).
- Use
-
JATS writer:
- Escape special chars in reference elements (Albert Krewinkel). Prevents the generation of invalid markup if a citation element contains an ampersand or another character with a special meaning in XML.
-
Jira writer:
- Use Span identifiers as anchors (Albert Krewinkel).
- Use
{noformat}instead of{code}for unknown languages (Albert Krewinkel). Code blocks which are not marked as a language supported by Jira are rendered as preformatted text via{noformat}blocks.
-
LaTeX writer:
- Adjust hypertargets to beginnings of paragraphs (#7078).
Use
\vadjust preso that the hypertarget takes you to the beginning of the paragraph rather than one line down. This makes a particular difference for links to citations using--citeprocandlink-citations: true. - Change BCP47 lang tag from
jptoja(Mauro Bieg, #7047). - Use function instead of map for accent lookup (should be more efficient).
- Split the module to make it easier to compile on low-memory systems: added Text.Pandoc.Writers.LaTeX.{Util,Citation,Lang}.
- Adjust hypertargets to beginnings of paragraphs (#7078).
Use
-
Markdown writer:
- Handle math right before digit. We insert an HTML comment to
avoid a
$right before a digit, which pandoc will not recognize as a math delimiter. - Split the module to make it easier to compile on low-memory systems: added Text.Pandoc.Writers.Markdown.{Types,Inline}.
- Handle math right before digit. We insert an HTML comment to
avoid a
-
ODT writer:
- Use
getTimestampinstead ofgetCurrentTimefor timestamp. SettingSOURCE_DATE_EPOCHwill allow reproducible builds. - Update default ODT style (Lorenzo). Previously, the “First paragraph”
style inherited from “Standard” but not from “Text body.” Now
it is adjusted to inherit from “Text body”, to avoid some ugly
spacing issues. It may be necessary to update a custom
reference.odtin light of this change.
- Use
-
Org writer:
- Support
task_listsextension (Albert Krewinkel, #6336).
- Support
-
Pptx writer:
- Use
getTimestampinstead ofgetCurrentTimefor timestamp. SettingSOURCE_DATE_EPOCHwill allow reproducible builds.
- Use
-
JATS templates: tag
author.nameasstring-name(Albert Krewinkel). The partitioning the components of a name into surname, given names, etc. is not always possible or not available. Usingauthor.nameallows to give the full name as a fallback to be used whenauthor.surnameis not available. -
Add default templates for bibtex and biblatex, so that the variables
header-include,include-before,include-after(or alternatively the command line options--include-in-header,--include-before-body,--include-after-body) may be used. -
LaTeX template:
- Update to iftex package (#7073) (Andrew Dunning)
- Wrap url colours in braces (#7121) (Loïc Grobol).
-
revealjs template: Add ‘center’ option for vertical slide centering. (maurerle, #7104).
-
Text.Pandoc.XML: Improve efficiency of
fromEntities. -
Text.Pandoc.MIME
- Add exported function
getCharset[API change].
- Add exported function
-
Text.Pandoc.UTF8: change IO functions to return Text, not String [API change]. This affects
readFile,getContents,writeFileWith,writeFile,putStrWith,putStr,putStrLnWith,putStrLn.hPutStrWith,hPutStr,hPutStrLnWith,hPutStrLn,hGetContents. This avoids the need to uselessly create a linked list of characters when emiting output. -
Text.Pandoc.App
- Add
parseOptionsFromArgs[API change, new exported function]. - Add fields for CSL options to
Opt[API change]:optCSL,optbibliography,optCitationAbbreviations.
- Add
-
Text.Pandoc.Citeproc.BibTeX
Text.Pandoc.Citeproc.writeBibTeXStringnow returnsDoc Textinstead ofText(#7068).- Correctly handle
pages(=pagein CSL) (#7067). - Correctly handle BibLaTeX
langid(=languagein CSL, #7067). - In BibTeX output, protect foreign titles since there’s no language field (#7067).
- Clean up BibTeX parsing (#7049). Previously there was a messy code
path that gave strange results in some cases, not passing through raw
tex but trying to extract a string content. This was an artefact of
trying to handle some special bibtex-specific commands in the BibTeX
reader. Now we just handle these in the LaTeX reader and simplify
parsing in the BibTeX reader. This does mean that more raw tex will
be passed through (and currently this is not sensitive to the
raw_texextension; this should be fixed).
-
Text.Pandoc.Citeproc.MetaValue
- Correctly parse “raw” date value in markdown references metadata. (See jgm/citeproc#53.)
-
Text.Pandoc.Citeproc
- Use https URLs for links (Salim B, #7122).
-
Text.Pandoc.Class
- Add
getTimestamp[API change]. This attempts to read theSOURCE_DATE_EPOCHenvironment variable and parse a UTC time from it (treating it as a unix date stamp, see https://reproducible-builds.org/specs/source-date-epoch/). If the variable is not set or can’t be parsed as a unix date stamp, then the function returns the current date.
- Add
-
Text.Pandoc.Error
- Add
PandocUnsupportedCharsetErrorconstructor forPandocError[API change]. - Export
renderError[API change]. - Refactor
handleErrorto userenderError. This allows us render error messages without exiting.
- Add
-
Text.Pandoc.Extensions
Ext_task_listsis now supported by org (and turned on by default) (Albert Krewinkel, #6336).- Remove
Ext_fenced_code_attributesfrom allowed commonmark attributes (#7097). This attribute was listed as allowed, but it didn’t actually do anything. Useattributesfor code attributes and more.
-
Lua subsystem:
- Always load built-in Lua scripts from default data-dir (Albert
Krewinkel). The Lua modules
pandocandpandoc.Listare now always loaded from the system’s default data directory. Loading from a different directory by overriding the default path, e.g. via--data-dir, is no longer supported to avoid unexpected behavior and to address security concerns. - Add module “pandoc.path” (Albert Krewinkel, #6001, #6565). The module allows to work with file paths in a convenient and platform-independent manner.
- Use strict evaluation when retrieving AST value from the stack (Albert Krewinkel, #6674).
- Always load built-in Lua scripts from default data-dir (Albert
Krewinkel). The Lua modules
-
Text.Pandoc.PDF
- Disable
smartextension when building PDF via LaTeX. This is to prevent accidental creation of ligatures like?`and!`(especially in languages with quotations like German), and similar ligature issues. (See jgm/citeproc#54.)
- Disable
-
Text.Pandoc.CSV:
- Fix parsing of unquoted values (#7112). Previously we didn’t allow unescaped quotes in unquoted values, but they are allowed in CSV.
-
Test suite:
- Use a more robust method for testing the executable. Many
of our tests require running the pandoc executable. This
is problematic for a few different reasons. First,
cabal-install will sometimes run the test suite after
building the library but before building the executable,
which means the executable isn’t in place for the tests.
One can work around that by first building, then building
and running the tests, but that’s fragile. Second, we
have to find the executable. So far, we’ve done that using
a function
findPandocthat attempts to locate it relative to the test executable (which can be located using findExecutablePath). But the logic here is delicate and work with every combination of options. To solve both problems, we add an--emulateoption to thetest-pandocexecutable. When--emulateoccurs as the first argument passed totest-pandoc, the program simply emulates the regular pandoc executable, using the rest of the arguments (after--emulate). Thus,test-pandoc --emulate -f markdown -t latexis just likepandoc -f markdown -t latex. Since all the work is done by library functions, implementing this emulation just takes a couple lines of code and should be entirely reliable. With this change, we can test the pandoc executable by running the test program itself (locatable usingfindExecutablePath) with the--emulateoption. This removes the need for the fragilefindPandocstep, and it means we can run our integration tests even when we’re just building the library, not the executable. [Note: part of this change involved simplifying some complex handling to set environment variables for dynamic library paths. I have tested a build with--enable-dynamic-executable, and it works, but further testing may be needed.] - Print accurate location if a test fails (Albert
Krewinkel). Ensures that tasty-hunit reports the location
of the failing test instead of the location of the helper
testfunction.
- Use a more robust method for testing the executable. Many
of our tests require running the pandoc executable. This
is problematic for a few different reasons. First,
cabal-install will sometimes run the test suite after
building the library but before building the executable,
which means the executable isn’t in place for the tests.
One can work around that by first building, then building
and running the tests, but that’s fragile. Second, we
have to find the executable. So far, we’ve done that using
a function
-
Documentation: Update URLs and use
httpswhere possible (#7122, Salim B). -
Add
doc/libraries.md, a description of libraries that support pandoc. -
MANUAL.txt
- MANUAL: block-level formatting is not allowed in line blocks (#7107).
- Clarify
tex_math_dollarsextension. Note that no blank lines are allowed between the delimiters in display math. - Add MANUAL section on reproducible builds.
- Document no template fallback for absolute path (#7077, Nixon Enraght-Moony.)
- Improve docs for cite-method.
- Update README and man page.
-
Makefile: in
make bench, create CSV files for comparison and compare against previous benchmark run. Add timestamp to CSV filenames. -
cabal.project: don’t explicitly set -trypandoc. If we do, this can’t be overridden on the cabal command line.
-
doc/lua-filters.md: improve documentation for
pandoc.mediabag.insert,pandoc.mediabag.fetch,directory,normalize(Albert Krewinkel). -
Allow base64-bytestring-1.2.* (Dmitrii Kovanikov)
-
Require jira-wiki-markup 1.3.3 (Albert Krewinkel)
-
Require citeproc 0.3.0.8, which correctly titlecases when titles contain non-ASCII characters.
-
Use skylighting 0.10.4. This version of skylighting uses xml-conduit rather than hxt. This speeds up parsing of XML syntax definitions fourfold, and removes four packages from pandoc’s dependency graph: hxt-charproperties, hxt-unicode, hxt-regex-xmlschema, hxt.
-
Add script
tools/parseTimings.plto help pin down which modules take the most time and memory to compile. -
Avoid unnecessary use of NoImplicitPrelude pragma (#7089) (Albert Krewinkel)
-
Benchmarks
- Use the lighter-weight tasty-bench instead of criterion.
- Run writer benchmarks for binary formats too.
- Alphabetize benchmarks.
- Don’t run benchmarks for bibliography formats (yet; we need a special input for them).
- Show allocation data
- Clean up benchmark code.
- Allow specifying patterns using `-p blah’.
-
trypandoc: add 2 second timeout.
-
Use
-split-sectionsin creating linux release binary. This reduces executable size significantly (by about 30%). -
Remove
weigh-pandoc. It’s not really useful any more, now that our regular benchmarks include data on allocation. -
Improve linux package build process and add script to automate building an arm64 binary package.
-
With
--bibliography(orbibliographyin metadata), a URL may now be provided, and pandoc will fetch the resource. In addition, if a file path is provided and it is not found relative to the working directory, the resource path will be searched (#6940). -
Add
sourceposextension forcommonmark,gfm,commonmark_x(#4565). With thesourceposextension set set,data-posattributes are added to the AST by the commonmark reader. No other readers are affected. Thedata-posattributes are put on elements that accept attributes; for other elements, an enlosing Div or Span is added to hold the attributes. -
Change extensions for
commonmark_x: replaceauto_identifierswithgfm_auto_identifiers(#6863).commonmark_xnever actually supportedauto_identifiers(it didn’t do anything), because the underlying library implements gfm-style identifiers only. Attempts to add theauto_identifiersextension tocommonmarkwill now fail with an error. -
HTML reader:
- Split module into several submodules (Albert Krewinkel). Reducing module size should reduce memory use during compilation.
- Support advanced table features (Albert Krewinkel): block level content in captions, row and colspans, body headers, row head columns, footers, attributes.
- Disable round-trip testing for tables. Information for cell alignment in a column is not preserved during round-trips (Albert Krewinkel).
- Allow finer grained options for tag omission (Albert Krewinkel).
- Simplify list attribute handling (Albert Krewinkel).
- Pay attention to
langattributes on body element (#6938). These (as well aslangattributes on the html element) should update lang in metadata. - Retain attribute prefixes and avoid duplicates (#6938).
Previously we stripped attribute prefixes, reading
xml:langaslangfor example. This resulted in two duplicatelangattributes whenxml:langandlangwere both used. This commit causes the prefixes to be retained, and also avoids invald duplicate attributes.
-
Commonmark reader:
- Refactor
specFor. - Set input name to
""to avoid clutter in sourcepos output.
- Refactor
-
Org reader:
- Parse
#+LANGUAGEintolangmetadata field (#6845, Albert Krewinkel). - Preserve targets of spurious links (#6916, Albert
Krewinkel). Links with (internal) targets that the reader doesn’t
know about are converted into emphasized text. Information on the
link target is now preserved by wrapping the text in a Span of class
spurious-link, with an attributetargetset to the link’s original target. This allows to recover and fix broken or unknown links with filters.
- Parse
-
DocBook reader:
- Table text width support (#6791, Nils Carlson).
Table width in relation to text width is not natively supported
by docbook but is by the docbook
fostylesheets through an XML processing instruction,<?dbfo table-width="50%"?>.
- Table text width support (#6791, Nils Carlson).
Table width in relation to text width is not natively supported
by docbook but is by the docbook
-
LaTeX reader:
- Improve parsing of command options (#6869, #6873).
In cases where we run into trouble parsing inlines til the
closing
], e.g. quotes, we return a plain string with the option contents. Previously we mistakenly included the brackets in this string. - Preserve center environment (#6852, Igor Pashev).
The contents of the
centerenvironment are put in aDivwith classcenter. - Don’t parse
\rulewith width 0 as horizontal rule. These are sometimes used as spacers in LaTeX. - Don’t apply theorem default styling to a figure inside (#6925). If we put an image in italics, then when rendering to Markdown we no longer get an implicit figure.
- Improve parsing of command options (#6869, #6873).
In cases where we run into trouble parsing inlines til the
closing
-
Dokuwiki reader:
- Handle unknown interwiki links better (#6932).
DokuWiki lets the user define his own Interwiki links. Previously
pandoc reacted to these by emitting a google search link, which is
not helpful. Instead, we now just emit the full URL including the
wikilink prefix, e.g.
faquk>FAQ-mathml. This at least gives users the ability to modify the links using filters.
- Handle unknown interwiki links better (#6932).
DokuWiki lets the user define his own Interwiki links. Previously
pandoc reacted to these by emitting a google search link, which is
not helpful. Instead, we now just emit the full URL including the
wikilink prefix, e.g.
-
Markdown writer:
- Properly handle boolean values in writing YAML metadata (#6388).
- Ensure that a new csl-block begins on a new line (#6921). This just looks better and doesn’t affect the semantics.
-
RST writer:
- Better image handling (#6948). An image alone in its paragraph
(but not a figure) is now rendered as an independent image, with an
altattribute if a description is supplied. An inline image that is not alone in its paragraph will be rendered, as before, using a substitution. Such an image cannot have a “center”, “left”, or “right” alignment, so the classesalign-center,align-left, oralign-rightare ignored. However,align-top,align-middle,align-bottomwill generate a correspondingalignattribute.
- Better image handling (#6948). An image alone in its paragraph
(but not a figure) is now rendered as an independent image, with an
-
Docx writer:
- Keep raw openxml strings verbatim (#6933, Albert Krewinkel).
- Use Content instead of Element. This allows us to inject raw OpenXML into the document without reparsing it into an Element, which is necessary if you want to inject an open tag or close tag.
- Fix bullets/lists indentation, so that the first level is slightly indented to the right instead of right on the margin (cholonam).
- Support bold and italic in “complex script” (#6911). Previously bold and italics didn’t work properly in LTR text. This commit causes the w:bCs and w:iCs attributes to be used, in addition to w:b and w:i, for bold and italics respectively.
-
ICML writer:
- Fix image bounding box for custom widths/heighta (Mauro Bieg, #6936).
-
LaTeX writer:
- Improve table spacing (#6842, #6860).
Remove the
\strutthat was added at the end of minipage environments in cells. Replace\tabularnewlinewith\\ \addlinespace. - Improve calculation of column spacing (#6883).
- Extract table handling into separate module (Albert Krewinkel).
- Fix bug with nested
csl-display Spans (#6921). - Improve longtable output (#6883). Don’t create minipages for regular paragraphs. Put width and alignment information in the longtable column descriptors.
- Improve table spacing (#6842, #6860).
Remove the
-
OpenDocument writer:
- Support for table width as a percentage of text width (#6792, Nils Carson).
- Implement Div and Span ident support (#6755, Nils Carson). Spans and Divs containing an ident in the Attr will become bookmarks or sections with idents in OpenDocument format.
- Add two extensions,
xrefs_nameandxrefs_number(#6774, Nils Carlson). Links to headings, figures and tables inside the document are substituted with cross-references that will use the name or caption of the referenced item forxrefs_nameor the number forxrefs_number. For thexrefs_numberto be useful heading numbers must be enabled in the generated document and table and figure captions must be enabled using for example thenative_numberingextension. In order for numbers and reference text to be updated the generated document must be refreshed.
-
JATS writer:
- Support advanced table features (Albert Krewinkel).
- Support author affiliations (#6687, Albert Krewinkel).
-
Docbook writer:
- Use correct id attribute consistently (Jan Tojnar).
DocBook5 should always use
xml:idinstead ofid. - Handle admonition titles better (Jan Tojnar).
Docbook reader produces a
Divwithtitleclass for<title>element within an “admonition” element. Markdown writer then turns this into a fenced div withtitleclass attribute. Since fenced divs are block elements, their content is recognized as a paragraph by the Markdown reader. This is an issue for Docbook writer because it would produce an invalid DocBook document from such AST – the<title>element can only contain “inline” elements. Handle this special case separately by unwrapping the paragraph before creating the<title>element. - Add XML namespaces to top-level elements (#6923, Jan Tojnar).
Previously, we only added
xmlnsattributes to chapter elements, even when running with--top-level-division=section. These namespaces are now added to part and section elements too, when they are the selected top-level divisions. We do not need to add namespaces to documents produced with--standaloneflag, since those will already have xmlns attribute on the root element in the template.
- Use correct id attribute consistently (Jan Tojnar).
DocBook5 should always use
-
HTML writer:
- Fix handling of nested
csl-display spans (#6921). Previously inner Spans used to represent CSL display attributes were not rendered as div tags as intended.
- Fix handling of nested
-
EPUB writer:
- Include title page in landmarks (#6919).
Note that the toc is also included if
--tocis specified. - Add frontmatter type on body element for nav.xhtml (#6918).
- Include title page in landmarks (#6919).
Note that the toc is also included if
-
EPUB templates: use preserveAspectRatio=“xMidYMid” for cover image (#6895, Shin Sang-jae). This change affects both the epub2 and the epub3 templates. It avoids distortion of the cover image by requiring that the aspect ratio be preserved.
-
LaTeX template:
- Include
csquotespackage ifcsquotesvariable set. - Put back
amssymb. We need it for checkboxes in todo lists, and maybe for other things. In this location it seems compatible with the cases that prompted #6469 and PR #6762. - Disable language-specific shorthands in babel (#6817, #6887).
Babel defines “shorthands” for some languages, and these can
produce unexpected results. For example, in Spanish,
1.22gets rendered as122, andet~al.asetal. One would think that babel’sshorthands=offoption (which we were using) would disable these, but it doesn’t. So we removeshorthands=offand add some code that redefines the shorthands macro. Eventually this will be fixed in babel, I hope, and we can revert to something simpler.
- Include
-
JATS template: allow array of persistent institute ids in
pid(Albert Krewinkel). -
Text.Pandoc.Parsing: minor code and efficiency improvements.
-
Text.Pandoc.Extension:
- Add
Ext_sourceposconstructor forExtension[API change]. - Add
Ext_xrefs_nameandExt_xrefs_numberconstructors forExtension(Nils Carson) [API change].
- Add
-
Text.Pandoc.Citeproc:
- Fix truncation of
[Citation]list inCiteinside footnotes (#6890). This affected author-in-text citations in footnotes. It didn’t cause problems for the printed output, but for filters that expected the citation id and other information. - Allow the use of both inline and external references (#6951), as with pandoc-citeproc. References defined in the document’s metadata take priority over references with the same id defined in an external bibliography.
- Use
fetchItemto get external bibliography (#6940). - Ensure that BCP47 lang codes can be used. We ignore the variants and just use the base lang code and country code when passing off to citeproc.
- Citeproc BibTeX parser: revert change in
getRawFieldwhich was made (for reasons forgotten) when transferring this code from pandoc-citeproc. The change led to--in URLs being interpreted as en-dashes, which is unwanted (#6874).
- Fix truncation of
-
Text.Pandoc.ImageSize:
- Default to DPI 72 if the format specifies DPI of 0 (#6880). This shouldn’t happen, in general, but it can happen with JPEGs that don’t conform to the spec. Having a DPI of 0 will blow up size calculations (division by 0).
- ImageSize: use JuicyPixels to determine size for png, jpeg, and gif, instead of doing our own binary parsing (#6936). This gives more reliable results.
-
Text.Pandoc.CSS:
- Remove
foldOrElse(internal module) (Albert Krewinkel).
- Remove
-
Use skylighting 0.10.2 (#6625).
-
Use citeproc 0.3. This fixes issues with references with duplicate ids (jgm/citeproc#36).
-
Use doctemplates 0.9. This fixes issues with boolean metadata values in the Markdown writer (#6388) and in
meta-json(#6650). It also fixes issues with nested for loops in templates. -
Add translations zh-Hans.yaml and zh-Hant.yaml (#6904, #6909, Kolen Cheung, taotieren).
-
Add tests: True to cabal.project. This fixes some CI failures for cabal.
-
Normalize test/tables/*.native (#6888, Kolen Cheung).
-
Move executable to
appdirectory to avoid problems with cabal repl. -
CONTRIBUTING: add section “How can I help?” (#6892, Albert Krewinkel). Also adds a paragraph aimed at highlighting the importance of feature maintenance.
-
MANUAL: Document that –number-sections works in
ms(#6935).
-
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-headingsin 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 ofsrc,data-src,poster, ordata-background-image, on any tag; and alsohrefonlinktags. -
Markdown reader:
- Fix detection of locators following in-text citations.
Prevously, if we had
@foo [p. 33; @bar], thep. 33would be incorrectly parsed as a prefix of@barrather than a suffix of@foo. - Improve period suppression algorithm for citations in notes in note citation styles (#6835).
- Don’t increment
stateNoteNumberfor example list references. This helps with #6836 (a bug in which example list references disturb calculation of citation note number and affect whenibidis triggered).
- Fix detection of locators following in-text citations.
Prevously, if we had
-
LaTeX reader:
- Move
getNextNumberfrom 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.
- Move
-
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.IPwhen 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-USif locale for LANG not found. This reproduces earlier pandoc-citeproc behavior (jgm/citeproc#26). -
JATS writer:
- Wrap all tables (Albert Krewinkel).
All
<table>elements are put inside<table-wrap>elements, as the former are not valid as immediate child elements of<body>. - Move Table handling to separate module (Albert Krewinkel). Adds two new unexported modules: Text.Pandoc.Writers.JATS.Types, Text.Pandoc.Writers.JATS.Table.
- Wrap all tables (Albert Krewinkel).
All
-
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).
-
Only use
filterIpynbOutputif input format is ipynb (#6841). Before this change content could go missing from divs with classoutput, 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
changePathSeparatorsfor Windows (#6173). Previously a path beginning with a drive, likeC:\foo\bar, was translated toC:\/foo/bar, which caused problems. With this fix, the backslashes are removed. -
Text.Pandoc.Logging:
- Add constructor
ATXHeadingInLHStoLogMessage[API change]. - Add constructor
EnvironmentVariableUndefinedtoLogMessage[API change].
- Add constructor
-
Fix error that is given when people specify
docoutput (#6834, gison93). -
LaTeX template: add a
\breakafter parbox inCSLRightInline. This should fix spacing problems between entries with numeric styles. Also fix number of params onCSLReferences. -
reveal.js template: Put quotes around
controlsLayout,controlsBackArrows, anddisplay, since these require strings. AddshowSlideNumber,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-staticdoes 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. -
Manual:
- Correct
link-citation->link-citations. - Add a sentence about
pagetitlefor HTML (#6843, Alex Toldaiev).
- Correct
-
INSTALL.md: Remove references to
pandoc-citeproc(#6857). -
CONTRIBUTING: describe hlint and how it’s used (#6840, Albert Krewinkel).
-
DocBook Reader: fix duplicate bibliography bug (#6773, Nils Carlson).
-
HTML reader:
- Parse contents of iframes (#6770).
- Parse inline svg as image unless
raw_htmlis 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
\cLis defined as\mathcal{L}, and\tilas\tilde{#1}, then\til\cLshould expand to\tilde{\mathcal{L}}, but pandoc was expanding it to\tilde\mathcal{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
\blockquotefromcsquotes(#6802).
- Fix bug parsing macro arguments (#6796). If
-
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
typeandpathfields. 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
PandocBibliographyErrorconstructor forPandocError[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
cslfield withdata: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-abbreviationsin defaults file. -
JATS templates: ensure
jats_publishingoutput 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
monobackgroundcolorvariable, 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: 1for 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
tblfrom.\"tto'\" t, as specified in groff_man(7) (#6803). -
Use latest commonmark, commonmark-extensions. This fixes a bug with nested blocks in footnotes with the
footnoteextension tocommonmark. See jgm/commonmark-hs#63. -
Citeproc: use comma for in-text citations inside footnotes. When an author-in-text citation like
@foooccurs 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.mdto document pandoc’s handling of JATS (#6794, Albert Krewinkel). -
Fix code example in lua-filters.md (#6795).
-
Add
--citeproc(-C) option to trigger built-in citation processing. It is no longer necessary to use the externalpandoc-citeprocfilter.--citeprocbehaves 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
~/.csldirectory for.cslstyles. Pandoc instead searches thecslsubdirectory of the pandoc user data directory (e.g.,~/.pandoc/cslor~/.local/share/pandoc/csl). Users who already keep CSL styles in~/.cslmay 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
bibutilsutility 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
cslsubdirectory of the pandoc user data directory) before resorting to HTTP. In addition, you may omit the.cslextension, e.g.--csl zoology. -
Using the
--bibliographyoption (or includingbibliographyin YAML metadata) no longer triggers citation processing implicitly: one must always use the--citeprocoption if citation processing is wanted.
-
-
Add
csljsonas and input and output format. This allows pandoc to convert betweencsljsonand other bibliography formats (e.g.-f csljson -t markdown -sor-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,biblatexas 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-languagesoutput (#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-depthoption for ODT writer (#6696, niszet). -
Fix issues with Windows UNC paths with some options (#5127).
-
Remove
fenced_code_blocksandbacktick_code_blocksfrom allowedcommonmarkandgfmextensions. 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
gfmandcommonmark: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_identifiersextensions fordocx. -
Markdown reader:
- Add
Maybe FilePathparameter toyamlToMeta[API change]. - Export
yamlToRefs[API change], a version ofyamlToMetaspecialized to references. - Set
citationNoteNumaccurately 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.
- Add
-
LaTeX reader:
- Support missing siunitx commands (#6658).
- Support
squared,cubed,tothein 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
\multirowand\multicolumntable cells (#6603, Laurent P. René de Cotret). - Table cell parser not consuming spaces correctly (#6596, Laurent P. René de Cotret).
- Change
SIRangetoSIrange(#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).
- Apply
-
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[].
- 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
-
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-biblioentryrole. - 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
readBibTeXandreadBibLaTeX. [API change] -
Text.Pandoc.Filter: Add
CiteprocFilterconstructor 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 fromciteprocor{type: citeproc}, so this special filter may be specified either way in a defaults file (or byciteproc: 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
Tabletype that mirrors the structure of a pandocTable, but with added inferred information so that the writers do not have to lay out tables themselves. ThetoTableandfromTablefunctions convert between an annotatedTableand a regular pandocTable. In addition to producing aTablewith coherent and well-formed annotations, thetoTablefunction also normalizes its input table like the table builder does. Tests ensure thattoTablenormalizes tables exactly like the table builder, and that its annotations are coherent. -
Text.Pandoc.Logging:
- Remove unused
CouldNotParseYamlMetadataconstructor forLogMessage[API change]. - Add
CiteprocWarningconstructor toLogMessage[API change].
- Remove unused
-
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
stateInNoteandstateNoteNumbertoParserState[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: usetex-chtml-fullinstead oftex-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.jstodefaultMathJaxURL(#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.cslin the data directory and aciteprocdirectory that is only used at compile-time for biblatex localizations. Note that we’ve addedfile-embedas a mandatory rather than a conditional dependency, because of the biblatex localization files. -
Lua filters:
-
Add SimpleTable for backwards compatibility (#6575, Albert Krewinkel). A new type
SimpleTableis made available to Lua filters. It is similar to theTabletype in pandoc versions before 2.10; conversion functions from and to the new Table type are provided. Old filters using tables now require minimal changes and can use, e.g.,if PANDOC_VERSION > {2,10,1} then pandoc.Table = pandoc.SimpleTable endand
function Table (tbl) tbl = pandoc.utils.to_simple_table(tbl) … return pandoc.utils.from_simple_table(tbl) endto work with the current pandoc version.
-
Make
attrargument optional inTableconstructor (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
bodyfield (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
--acceptcan be used to update expected output. -
Use the
smartextension 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
nullinstead of deprecatedBuilder.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 d8ad766d17603784b86fc5c2e1b22864125d04d1).
-
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
tshowdefinition. -
Linux release candidate build: use ghc-musl container. This simplifies our build process (over using a customized alpine container).
-
Use pandoc-types 1.21. This adds two things:
- A native Underline constructor for Inline (#6277, Vaibhav Sagar).
- More expressive types for tables (#1024, Christian Despres). Tables can now take attributes; and rowspans and colspans, column headers, multiple row headers, table head and foot can all be represented. (Note, however, that reader and writer support for these features is still lacking, so most users won’t see any differences in table conversion yet. These changes just lay the foundation for further improvements.)
-
Support new Underline element in readers and writers (#6277, Vaibhav Sagar).
-
Support new Table type (Christian Despres). The Builder.simpleTable now only adds a row to the TableHead when the given header row is not null. This uncovered an inconsistency in the readers: some would unconditionally emit a header filled with empty cells, even if the header was not present. Now every reader has the conditional behaviour. Only the XWiki writer depended on the header row being always present; it now pads its head as necessary.
-
Add an option to disable certificate validation (#6156, Cédric Couralet, Cécile Chemin, Juliette Fourcot). This commit adds the option
--no-check-certificate, which disables certificate checking when resources are fetched by HTTP. -
Unify defaults and markdown metadata parsers (#6328, Nikolay Yakimov). Clean up code in Text.Pandoc.Readers.Metadata and properly handle errors in
yamlToMeta. This fixes parsing of Boolean fields in metadata withinin defaults files and reduces code duplication. -
Docbook reader:
- Implement
<procedure>(#6442, Mathieu Boespflug). - Implement
<phrase>(#6438, Mathieu Boespflug). - Treat envar and systemitem like code (#6435, Mathieu Boespflug).
- Implement
<replaceable>(#6437, Mathieu Boespflug) - Map
<simplesect>to unnumbered section (#6436, Mathieu Boespflug).
- Implement
-
JATS reader:
- Handle “label” element in section title (#6288).
- Parse abstract element into metadata field of same name (#6480, Albert Krewinkel).
-
Jira reader (Albert Krewinkel):
- Resolve multiple parsing problems, including issues with empty table cells, faulty recognition of closing emphasis characters, and parsing of image attributes (#6212, #6219, #6220).
- Two consecutive markup chars are now parsed verbatim (#6343); styled text must not be empty.
- Newlines are no longer allowed within styled text (#6325).
- Links to anchors are now parsed as links (#6407).
- Retain image attributes (#6234). Jira images attributes as in
!image.jpg|align=right!are retained as key-value pairs. Thumbnail images, such as!example.gif|thumbnail!, are marked by athumbnailclass in their attributes. - Use Underline for inserted text (#6237). Previously, the span was
marked with the non-standard class
inserted. - Improve icon conversion for
(/),(x),(!),(?)(+),(-),(off),(*). (#6236, #6264). - Support citations, attachment links, and user links (#6231, #6238, #6239).
- Resolve parsing issues of blockquote, color (#6233, #6235).
-
HTML reader:
- Parse attributes into table attributes.
- Support
<bdo>(#5794, Tristan de Cacqueray). - Add
summaryto list of block-level HTML tags (#6385). This improves support for summary/details inside Markdown. NOTE: you need to include a blank line before the closing</details>, if you want the last part of the content to be parsed as a paragraph. - Fix parsing unclosed th elements in a table (#6247).
-
Commonmark reader: Implement
implicit_figuresextension (#6350). -
Markdown Reader:
- Fix inline code in lists (#6284, Nikolay Yakimov). Previously inline code containing list markers was sometimes parsed incorrectly.
- Don’t require blank line after grid table (#6481). This allows grid tables to be enclosed in fenced divs with no intervening blank lines.
-
LaTeX reader:
- Don’t parse beyond
\end{document}(#6380). This required some internal changes to\subfilehandling. - Better handling of
\lettrine. SmallCaps instead of Span for the part after the initial capital. Ensure that both arguments are parsed, so that in Markdown both are treated as raw LateX. (Closes #6258.)
- Don’t parse beyond
-
Org reader (Albert Krewinkel):
- Recognize images with uppercase extensions (#6472).
- Keep unknown keyword lines as raw org. The lines of unknown
keywords, like
#+SOMEWORD: valueare no longer read as metadata, but kept as raworgblocks. This ensures that more information is retained when round-tripping org-mode files; additionally, this change makes it possible to support non-standard org extensions via filters. - Unify keyword handling. Handling of export settings and other
keywords (like
#+LINK) has been combined and unified. - Support
LATEX_HEADER_EXTRAandHTML_HEAD_EXTRAsettings. These export settings are treated like their non-extra counterparts, i.e., the values are added to theheader-includesmetadata list. - Allow multiple
#+SUBTITLEexport settings. The values of all lines are read as inlines and collected in thesubtitlemetadata field. - Read
#+INSTITUTEvalues as text with markup. The value is stored in theinstitutemetadata field and used in the default beamer presentation template. - The behavior of the
#+AUTHORand#+KEYWORDexport settings has changed: Org now allows multiple such lines and adds a space between the contents of each line. Pandoc now always parses these settings as meta inlines; setting values are no longer treated as comma-separated lists. Note that a Lua filter can be used to restore the previous behavior. - Read description lines as inlines (#6485).
#+DESCRIPTIONlines are now treated as text with markup. If multiple such lines are given, then all lines are read and separated by soft linebreaks. - Honor tex export option (#4070). The
texexport option can be set with#+OPTION: tex:niland allows three settings:t(the default) causes LaTeX fragments to be parsed as TeX or added as raw TeX.nilremoves all LaTeX fragments from the document.verbatimtreats LaTeX as text.
-
RST reader:
- Pass arbitrary attributes through in code blocks (#6465). Exceptions: name (which becomes the id), class (which becomes the classes), and number-lines (which is treated specially to fit with pandoc highlighting).
- Handle
date::directive (#6276).
-
Textile reader: support
pre.for code blocks (#6454). -
Ipynb reader:
- Implement
raw_markdownextension (#5408). Specifying-f ipynb+raw_markdownwill cause Markdown cells to be represented as raw Markdown blocks, instead of being parsed. This is not what you want when going fromipynbto other formats, but it may be useful when going fromipynbto Markdown or toipynb, to avoid semantically insignificant changes in the contents of the Markdown cells that might otherwise be introduced. - Handle application/pdf output as image (#6430).
- Properly handle image/svg+xml as an image (#6430).
- Implement
-
Docx reader:
- Distinguish between docx parsing and docx container unpacking errors.
-
MediaWiki reader:
- Fix
gfm_auto_identifiersso that-is not replaced by_(#6335).
- Fix
-
Vimwiki reader:
-
Jira writer (Albert Krewinkel):
- Always escape braces (#6478). Braces are now always escaped, even within words or when surrounded by whitespace. Jira and Confluence treat braces specially.
- Convert Underline to inserted text (
+inserted+). - Add image attributes (#6234). Image attributes are added to the output as image parameters. If the image has a class “thumbnail”, then a thumbnail image is generated; all other attributes are discarded in this case.
-
LaTeX writer:
- Ensure that
-M csquotesworks even in fragment mode (#6265). - Escape
^specially for listings (#6460). - Create hypertarget for links with identifier (#6360).
- Distinguish between single and double quotes when using enquote package (#6457, dbecher-ito).
- Add support for customizable alignment of columns in beamer (#6331, andrebauer).
- Add support for customizable alignment of columns in beamer (#4805, #4150, andrebauer).
- Ensure that
-
HTML writer:
- Use CSS in favor of
<br>for display math (#6372) Some CSS to ensure that display math is displayed centered and on a new line is now included in the default HTML-based templates; this may be overridden if the user wants a different behavior.
- Use CSS in favor of
-
Org writer:
- Clean-up Div handling (Albert Krewinkel).
-
Docx writer:
- Enable column and row bands for tables (#6371). This change will not have any effect with the default style. However, it enables users to use a style (via a reference.docx) that turns on row and/or column bands.
-
OpenDocument (and ODT) writer:
- Add custom-style “Abstract” in metadata abstract. This ensures that the abstract is rendered with style Abstract.
- Enable custom-style attribute on a Div. This allows you to apply a custom style to contained paragraphs.
-
DocBook writer:
- Add id of figure to enclosed image.
- Add personname element to docbook author (#6244).
-
FB2 writer:
- Properly handle cover-image containing spaces (#6391).
-
Markdown writer:
- Ensure consistent padding for pipe tables (#6240).
- Avoid unnecessary escapes before intraword
_whenintraword_underscoresextension is enabled (#6296).
-
RST writer:
- Properly handle images with same alt text (#6194). Previously we created duplicate references for these in rendering RST.
-
AsciiDoc writer:
- Add blank line after Div (#6308).
-
Haddock Writer:
-
PowerPoint writer (Jesse Rosenthal):
- Write math input verbatim in speaker notes (#6301). OMML in speaker notes would lead to corrupt PowerPoint output. We now output the OMML verbatim as LaTeX in the speaker notes.
-
LaTeX template: Make polyglossia package options list-aware (#6444, Frederik Elwert).
-
Reveal.js template:
- Update template for reveal.js 4.0.0 (#6390, Salim B).
- Update template with newly available options (#6347, Jake Zimmerman).
- Use CDN version of revealjs v4 by default (#6408).
-
opendocument template: Add abstract and subtitle to opendocument template (#6369).
-
reference.odt: clean up styles. Add Abstract. Change Author, Date to centered paragraphs with no character styling.
-
epub.css: wrap overlong lines in highlighted code blocks (#6242). This fixes a problem in iBooks v2.4 with our earlier horizontally scrolling code blocks. The problem seems to be a bug in iBooks, not pandoc, but since iBooks is a major target we’re changing pandoc’s default behavior so that pandoc-produced epubs work on that platform.
-
Text.Pandoc.PDF:
- Use
--enable-local-file-accessin invokingwkhtmltopdf(#6474).wkhtmltopdfchanged in recent versions to require this for access to local files. This fixes PDF via HTML5 with--css. - Send verbose output to stderr, not stdout (#6483).
- Use
-
Text.Pandoc.MIME: Fix MIME type for TrueType fonts in EPUBs (#6464, Michael Reed).
-
Text.Pandoc.Shared:
makeSections: omit number attribute when unnumbered class is present (#6339). Previously the attribute was included but given an empty value, and this caused the table of contents creation functions in Text.Pandoc.Writers.Shared to think these items had numbers, which meant that they were included in the TOC even if theunlistedclass was used.- Deprecate
underlineSpanin Shared in favor ofText.Pandoc.Builder.underline(Vaibhav Sagar). renderTags': use self-closing tag for col element (#6295).
-
Text.Pandoc.UUID: Fix
getRandomUUID, which previously would return the same value twice in a row. MakegetRandomUUIDpolymorphic in PandocMonad. RemovegetUUID(#6228, Joseph C. Sible). -
Text.Pandoc.Class: Generalize
PandocIOfunctions toMonadIO. -
Fixed Katex standalone script (#6399, Lucas Escot). Global macros are now persistent when using the HTML Writer with the
--katexoption. -
Lua subsystem (Albert Krewinkel):
- Use new type PandocLua for all pandoc Lua operations (API change).
The new type
PandocLuais an instance of thePandocMonadtypeclass and can thus be used in a way similar toPandocIO. - Use PandocError for exceptions in Lua subsystem (API change).
The PandocError type is used throughout the Lua subsystem. All Lua
functions throw an exception of this type if an error occurs. The
LuaExceptiontype is removed and no longer exported fromText.Pandoc.Lua. In its place, a new constructorPandocLuaErroris added to PandocError.
- Use new type PandocLua for all pandoc Lua operations (API change).
The new type
-
Lua filters: improve error messages for failing filters (#6332, Albert Krewinkel). Print the Lua error properly instead of displaying their
showstring. -
Use latest skylighting. This fixes a bug with lua multiline comments (and may improve handling of other syntaxes as well). IT also adds
aria-hidden="true"to the empty a elements, which helps people who use screen readers. -
Use latest texmath.
-
Require latest doctemplates 0.8.2. This adds support for template pipes
first,rest,last,allbutlast. -
Revert 0e48a02 and dependency on base-noprelude, which hasn’t been updated for ghc 8.10 (see #6187).
-
Dependency adjustments:
- Allow haddock-library 1.9.x.
- Allow hslua 1.1 (#6243, Felix Yan).
- Allow base64-bytestring 1.1.
- Use latest jira-wiki-markup.
- Allow http-client 0.7.
- Allow tasty 1.3.x.
- Allow aeson 1.5 (#6400, Felix Yan).
- Remove unused dependency
vector(#6462, Laurent P. René de Cotret). - Bump QuickCheck upper bound.
-
Significant code cleanup and simplification (Joseph C. Sible, #6223, #6209, #6225, #6229, #6226, #6340).
-
Remove unnecessary hlint ignores (#6341, Joseph C. Sible).
-
Remove obsolete RelaxedPolyRec extension (#6487, Nikolay Yakimov).
-
trypandoc improvements (Mike Tzou):
- Add standalone option to the command text (#6210).
- Update third party libraries.
-
MANUAL.txt:
- Clarify template partial naming (#6476, Mauro Bieg).
- Describe
jiraas “Jira/Confluence wiki markup” (#6351, Albert Krewinkel). In the past, Jira’s wiki markup was also used by – and could be imported into – Atlassian Confluence. - Add link to print-css.rocks (#6272, Mauro Bieg).
- Clarify pipe table column width adjustment (#6254).
- Fix ATX header syntax.
- Fix misleading note about image size conversions (#6353).
- Update links to reveal.js documentation (#6386, Salim B).
- Separate adjacent verbatim code blocks (#6307, tom-audm).
-
org.md:
- Document behavior of
smartextension (#4387, Albert Krewinkel). - Describe all supported export options in detail.
- Document behavior of
-
lua-filters.md:
- Fix description of BulletList Lua type (Levi Gruspe).
- Use pandoc.system module in TikZ example (Albert
Krewinkel). Showcase temporary directory handling with
with_temporary_directoryandwith_working_directory.
-
INSTALL.md: fix FreeBSD port link (#6422, Mo). The FreeBSD port was renamed from pandoc to hs-pandoc in 2010. The old pandoc port is still at version 1.5.1.1
-
Propagate
(DY)LD_LIBRARY_PATHin tests (#6376, Lila). -
Bump
cabal-versionto 2.2 (#6377). -
Make it possible to compile using Stack on NixOS (#6439, Mathieu Boespflug).
-
CI action to check for commit message length (Nikolay Yakimov, #6398).
-
Markdown reader: Fix table alignment when heading begins with t (#6153). Due to a typo (
tinstead of\t) we were center aligning column headings that begin with a lowercaset! -
Text.Pandoc.Readers.Roff:
- Fix parsing of
\.in man/ms readers (#6175). Previously due to a typo it was being parsed as`. - Fix parsing of
\'in man/ms readers (#6175). It was being parsed as a backtick.
- Fix parsing of
-
Jira reader (Albert Krewinkel):
- Fix parsing of tables without preceding blankline (#6198).
A bug was fixed which caused faulty parsing if a table was not
preceded by a newline and the first table cell had no space
after the initial
|characters. - Fix parsing of strikeout, emphasis (#6196). A bug was fixed which caused non-emphasized text containing digits and/or non-special symbols (like dots) to sometimes be parsed incorrectly.
- Support colored inline text, indented lists (#6183, #6184).
- Fix parsing of tables without preceding blankline (#6198).
A bug was fixed which caused faulty parsing if a table was not
preceded by a newline and the first table cell had no space
after the initial
-
Ms writer:
- Fix definition lists so indent even when paragraph indent is set to 0 (as is the default). Also ensure indent for display math that falls back to TeX.
- Use
.QS/.QEinstead of.RS/.REfor block quotes.
-
EPUB writer: fix regression on detection of front/back/bodymatter (#6170). This bug caused sections with epub:type
dedicationto be misplaced in bodymatter instead of frontmatter as specified in the manual. The same problem would affect other epub:types. The pattern matching needed to be changed with the use ofmakeSection. -
AsciiDoc writer: remove redundant
otherwiseguard ininlineToAsciiDoc(#6146, Ryan Scott). -
Text.Pandoc.Class:
- Fix missing import when data files are not embedded (Albert Krewinkel).
- Subdivide Text.Pandoc.Class into small unexported modules and ensure that all functions have Haddock documentation (#6106, Albert Krewinkel).
- Finer grained imports of Text.Pandoc.Class submodules (#6203, Albert Krewinkel).
-
Text.Pandoc.XML: Add to list of HTML5 attributes:
allow,autocapitalize,decoding,enterkeyhint,imagesizes,imagesrcset,loading. -
Use implicit Prelude (#6187, Albert Krewinkel). The previous behavior was introduced as a fix for #4464. It seems that this change alone did not fix the issue, and
stack ghciandcabal replonly work with GHC 8.4.1 or newer, as no custom Prelude is loaded for these versions. Given this, it seems cleaner to revert to the implicit Prelude. -
Always use custom prelude (#6187, Albert Krewinkel). Previously, the custom prelude was used only with older GHC versions, as a workaround for problems with ghci. The ghci problems are resolved by replacing package
basewithbase-noprelude, allowing for consistent use of the custom prelude across all GHC versions. -
Remove outdated checks for no longer supported base versions (Albert Krewinkel).
-
PDF via wkhtmltopdf: put user-specified options last (#6171). Certain options (e.g.
cover) need to come after flags on the command line. -
Text.Pandoc.App: set resource path at the beginning so it can affect things like include-in-header (#5982).
-
Change macOS release candidate CI process so that notarized packages can be produced (#6169).
-
Make MANUAL more explicit about nonbreaking space handling by
all_symbols_escapable(#6154, Fabien Schurter). -
trypandoc (Mike Tzou):
- Add checkbox for standalone option (#6189).
- Use strict mode for JavaScript code (#6188).
- Fetch resources over https (#6188).
- Remove unnecessary attributes on style, script elements (#6188).
-
Use details tag to make GitHub releases changelog collapsible.
-
Update filter code in doc/filters.md so it works with latest pandoc (#6185).
-
linux/Dockerfile: upgrade to alpine 3.11 (#6180, Albert Krewinkel). This is used to build the static linux binaries.
-
Add
csvas an input format (#6100). The CSV table is converted into a pandoc simple table. A new module Text.Pandoc.Readers.CSV exportsreadCSV[API change]. -
Introduce new format variants for JATS writer (#6014, Albert Krewinkel):
jats_archivingfor the “Archiving and Interchange Tag Set”,jats_publishingfor the “Journal Publishing Tag Set”, andjats_articleauthoringfor the “Article Authoring Tag Set.”
The
jatsoutput format is now an alias forjats_archiving. The module Text.Pandoc.Writers.JATS now exportswriteJatsArchiving,writeJatsPublishing, andwriteJatsArticleAuthoring, as well as the legacywriteJATS[API change]. -
--defaults: Supportbibliographyandcslfields. MoveaddMetafrom Text.Pandoc.App.CommandLineOptions to Text.Pandoc.App.Opt (internal change). -
Add timing info for filters in
--verbosemode (#6112). When verbose mode is specified (verbosity == INFO), print a notice when running a filter and when a filter completes (including timing). -
LaTeX reader:
- Allow
&in LaTeX citation keys (#6110). - Improve caption and label parsing.
- Don’t emit empty Span elements for labels.
- Put tables with labels in a surrounding Div.
- Resolve
\refto table numbers (#6137). - Skip comments in more places where this is needed (#6114).
- Allow beamer overlays for all commands in all raw tex (#6043). This affects parsing of raw tex in LaTeX and in Markdown and other formats.
- Improve parsing of raw environments (#6034). If parsing fails
in a raw environment (e.g. due to special characters like unescaped
_), try again as a verbatim environment, which is less sensitive to special characters. This allows us to capture special environments that change catcodes as raw tex when-f latex+raw_texis used.
- Allow
-
RST reader:
- Add highlight directive (#6140, Lucas Escot).
-
MediaWiki writer:
- Prevent triple
[[[which confuses MediaWiki (#6119).
- Prevent triple
-
HTML reader:
- Don’t parse
data-idasidattribute. And similarly don’t parse anydata-XasXwhenXis a valid HTML attribute.
- Don’t parse
-
Org reader:
- Simplify parsing of sub- and superscripts (#6127, Albert Krewinkel). Speeds up parsing of single-word, markup-less sub- and superscripts.
-
LaTeX writer:
- Group biblatex citations even with prefix and suffix (#5849, Ethan Riley). Previously biblatex citations were only grouped if there was no prefix. This patch allows them to be grouped in subgroups split by prefixes and suffixes, which allows better citation sorting.
- Fix regression in handling of columns in beamer slides (#6033). Columns in title slides were causing problems with slide division.
- Fix duplicate frame classes in LaTeX/Beamer output (#6107).
-
HTML writer:
- Fix duplicate attributes on headings (#6062), regression from 2.7.x.
- Fix
--number-offsetwith HTML TOC. Eventually it would be worth adding a parameter tomakeSectionsso this could be done at that level; then it would also affect other writers that construct TOC manually. - reveal.js: restore old behavior for 2D nesting (#6032). The fix to #6030 actually changed behavior, so that the 2D nesting occurred at slide level N-1 and N, instead of at the top-level section. This commit restores the v2.7.3 behavior. If there are more than 2 levels, the top level is horizontal and the rest are collapsed to vertical.
- reveal.js: ensure that pauses work even in title slides (#5819).
-
Markdown writer:
- Fix regression: spurious dots in markdown_mmd metadata output (#6133).
-
Docx writer:
- Fix regression with Compact style on tight lists (#6072). Starting in 2.8, the docx writer no longer distinguishes between tight and loose lists, since the Compact style is omitted. This is a side-effect of the fix to #5670, as explained in the changelog. This patch fixes the problem by extending the exception currently offered to Plain blocks inside tables to Plain blocks inside list items.
-
Jira writer:
- Fix output of table headers (Albert Krewinkel, #6035).
-
Add Text.Pandoc.Image with unexported svgToPng.
-
Text.Pandoc.XML: Export
html5Attributes,html4Attributes,rdfaAttributes(formerly unexported in Text.Pandoc.Writers.HTML). [API change] -
Text.Pandoc.Shared: Export a new function
findM(#6125, Joseph C. Sible). -
Text.Pandoc.Logging: Add
RunningFilter,FilterCompletedconstructors to LogMessage [API change]. -
Text.Pandoc.CSV: fix bug in CSV parser; previously an extra blank record would sometimes be inserted at the end.
-
LaTeX template: add space option to xeCJK with PassOptionsToPackage (#6002). Otherwise we can get a clash with documentclasses that already load the package.
-
Lua filters:
-
Allow filtering of element lists (#6038, Albert Krewinkel). Lists of Inline and Block elements can now be filtered via
InlinesandBlocksfunctions, respectively. This is helpful if a filter conversion depends on the order of elements rather than a single element. For example, the following filter can be used to remove all spaces before a citation:function isSpaceBeforeCite (spc, cite) return spc and spc.t == 'Space' and cite and cite.t == 'Cite' end function Inlines (inlines) for i = #inlines-1,1,-1 do if isSpaceBeforeCite(inlines[i], inlines[i+1]) then inlines:remove(i) end end return inlines end -
Add methods
insert,remove, andsortto pandoc.List (Albert Krewinkel). Example of use:local numbers = pandoc.List {2, 3, 1} numbers:sort() -- numbers is now {1, 2, 3} -
Make
pandoc.Lista callable constructor (Albert Krewinkel). It is now possible to construct a new List viapandoc.List()instead ofpandoc.List:new(). -
Add tests for pandoc.List module (Albert Krewinkel).
-
-
Text.Pandoc.App.CommandLineOptions: Change
setVariableto useTextinstead ofString. This avoids some unnecessary unpacking. -
Use versioned directory for windows release zipfile. Also remove old
make-windows-installer.bat, superseded by GitHub actions workflow, and modifypandoc.wxsfor new paths. -
Extensive code cleanup (#6141, #6128, #6129, #6130, #6123, #6105, 6102, #6117, #6124, #6115, #6116, #6111, Joseph C. Sible).
-
Fix hlint warnings (Albert Krewinkel).
-
Use latest doclayout, doctemplates (#6031). The new version of doclayout fixes a memory leak that affected
--include-in-headerwith large files (and possibly other cases involving extremely long lines). -
Use latest texmath.
-
Use latest skylighting and fix test suite (#6086).
-
sample.lua: Fix typo in descriptive comments (#6136, Caleb Maclennan). Fix typo in error message (#6135).
-
Add Docker and GH Actions instructions/links to INSTALL.md.
-
Update filter documentation (#6065). Improve cabal v2 instructions. Remove example using pandoc API directly (we have other docs for that and it was outdated).
-
Lua filter docs:
- Cross-link constructors and types (Albert Krewinkel). Thanks to @bpj for the idea.
- Sort pandoc.List methods alphabetically (Albert Krewinkel).
- Unify, fix anchors and internal links (#6061, Albert Krewinkel). Links and anchors now follow consistent conventions, like lowercase-only anchor names. This breaks some links to specific sections in the document, but will make it much easier to link documentation in the future.
- Clarify filter function execution order (#6059, Albert Krewinkel).
-
In docs, update URLs and use
https:wherever possible (#6090, Salim B).
-
Improvements in templates system (from doctemplates):
- Pandoc templates now support a number of new features that
have been added in doctemplates: notably,
elseif,it, partials, filters, and syntax to control nesting and reflowing of text. These changes make pandoc more suitable out of the box for generating plain-text documents from data in YAML metadata. It can create enumerated lists and even tabular structures. - We now used templates parameterized on doclayout Doc types. The main impact of this change is better reflowing of content interpolated into templates. Previously, interpolated variables were rendered independently and interpolated as strings, which could lead to overly long lines. Now the templates interpolated as Doc values which may include breaking spaces, and reflowing occurs after template interpolation rather than before.
- Remove code from the LaTeX, Docbook, and JATS writers that looked in the template for strings to determine whether it is a book or an article, or whether csquotes is used. This was always kludgy and unreliable.
- Change template code to use new API for doctemplates.
- Pandoc templates now support a number of new features that
have been added in doctemplates: notably,
-
Add
--defaults/-doption. This adds the ability to specify a collection of default values for options in a YAML file. For example, one might define a set of defaults for letters, and then dopandoc -d letter myletter.md -o myletter.pdf. See the documentation of this feature in MANUAL.txt. -
Raise error on unsupported extensions (#4338).
-
The
--list-extensions[=FORMAT]option now lists only extensions that affect the given FORMAT. -
Add
-Loption as shortcut for--lua-filter. -
Add
--shift-heading-level-byoption and deprecate--base-heading-level(#5615). The new option does everything the old one does, but also allows negative shifts. It also promotes the document metadata (if not null) to a level-1 heading with a +1 shift, and demotes an initial level-1 heading to document metadata with a -1 shift. This supports converting documents that use an initial level-1 heading for the document title. -
Allow
--metadata-fileto be used repeatedly to include multiple metadata files (Owen McGrath, #5702). Values in files specified first will be overridden by those in later files. -
--asciinow uses numerical hex character references (#5718). -
Allow PDF output to stdout (#5751). PDF output now behaves like other binary formats: it will not be output to the terminal, but can be sent to stdout using either
-o -or a pipe. The intermediate format will be determined based on the setting of--pdf-engine. -
Make some writers sensitive to ‘unlisted’ class on headings (#1762). If this is present on a heading with the ‘unnumbered’ class, the heading won’t appear in the TOC. This class has no effect if ‘unnumbered’ is not also specified. This affects HTML-based writers (including slide shows and EPUB), LateX (including beamer), RTF, and PowerPoint. Other writers do not yet support
unlisted. -
Fix
gfm_auto_identifiersbehavior with emojis (#5813). Note that we also now use emoji names for emojis whenascii_identifiersis enabled. -
When
--ipynb-outputis used with the default “best” format, strip ANSI escape codes for non-ipynb output (#5633). These cause problems in many formats, including LaTeX. -
Don’t look for template files remotely for remote input (#5579). Previously pandoc would look for the template at a remote URL when a URL was used for the input file, instead of taking it from the data directory.
-
Allow combining
-Vheader-includesand--include-in-header(#5904). Previouslyheader-includesset as a variable would be clobbered by material included using--include-in-header. -
Change merge behavior for metadata. Previously, if a document contained two YAML metadata blocks that set the same field, the conflict would be resolved in favor of the first. Now it is resolved in favor of the second (due to a change in pandoc-types). This makes the behavior more uniform with other things in pandoc (such as reference links and
--metadata-file). -
Don’t add a newline to fragment output if there’s already one.
-
Change exit codes and document in MANUAL.txt:
PandocAppErrorwas 1, is now 4PandocOptionErrorwas 2, is now 6PandocMakePDFErrorwas 65, is now 66
-
Switch to new pandoc-types and use Text instead of String [API change]. (Christian Despres, #5884).
-
HTML reader:
- Better handling of
<q>with cite attribute (#5798, Ole Martin Ruud). If a<q>tag has aciteattribute, we interpret it as a Quoted element with an inner Span. - Add support for HTML
<samp>element (#5792, Amogh Rathore). The<samp>element is parsed as Code with classsample. - Add support for HTML
<var>element (#5799, Amogh Rathore). The<var>element is parsed as Code with classvariable. - Add support for
<mark>elements (Florian B, #5797). Parse<mark>elements from HTML as Spans with classmark. - Add support for
<kbd>elements, parsing them as Span with classkbd(Daniele D’Orazio, #5796). - Add support for
<dfn>, parsing this as a Span with classdfn(#5882, Florian Beeres).
- Better handling of
-
Markdown reader:
- Headers: don’t parse content over newline boundary (#5714).
- Handle inline code more eagerly within lists (Brian Leung, #5627).
- Removed some needless lookaheads.
- Don’t parse footnote body unless extension enabled.
- Fix small super/subscript issue (#5878). Superscripts and subscripts cannot contain spaces, but newlines were previously allowed (unintentionally). This led to bad interactions in some cases with footnotes. With this change newlines are also not allowed inside super/subscripts.
- Use
take1WhilePforstr, table row. This yields a small but measurable performance improvement.
-
LaTeX reader:
- Fix parsing of optional arguments that contain braced text (#5740).
- Don’t try to parse includes if
raw_texis set (#5673). When theraw_texextension is set, we just carry through\usepackage,\input, etc. verbatim as raw LaTeX. - Properly handle optional arguments for macros (#5682).
- Fix
\\in\parboxinside a table cell (#5711). - Improve
withRawso it can handle cases where the token string is modified by a parser (e.g. accent when it only takes part of a Word token) (#5686). This fixes a bug that caused the ends of certain documents to be dropped. - Handle
\passthroughmacro used by latex writer (#5659). - Support tex
\ttcommand (#5654). - Search for image with list of extensions like latex does, if an extension is not provided (#4933).
- Handle
\loosenesscommand values better (#4439). - Add
mboxandhboxhandling (Vasily Alferov, #5586). When+raw_texis enabled, these are passed through literally. Otherwise, they are handled in a way that emulates LaTeX’s behavior. - Properly handle
\providecommandand\provideenvironment(#5635). They are now ignored if the corresponding command or environment is already defined. - Support epigraph command in LaTeX Reader (oquechy, #3523).
- Ensure that expanded macros in raw LaTeX end with a space if the original did (#4442).
- Treat
lyenvironment from lilypond as verbatim (Urs Liska, #5671). - Add
tikzcdto list of special environments (Eigil Rischel). This allows it to be processed by filters, in the same way that one can do fortikzpicture.
-
Roff reader:
- Better support for
while. - More improvements in parsing conditionals.
- Fix problem parsing comments before macro.
- Improve handling of groups.
- Better parsing of groups (#5410). We now allow groups
where the closing
\\}isn’t at the beginning of a line.
- Better support for
-
RST reader:
- Keep
nameproperty inimgAttr(Brian Leung, #5619). - Fixed parsing of indented blocks (#5753). We were requiring consistent indentation, but this isn’t required by RST.
- Use title, not admonition-title, for admonition title. This puts RST reader into alignment with docbook reader.
- Don’t strip final underscore from absolute URI (#5763).
- Avoid spurious warning when resolving links to internal anchors
ending with
_(#5763).
- Keep
-
Org reader:
- Accept
ATTR_LATEXin block attributes (Albert Krewinkel, #5648). Attributes for LaTeX output are accepted as valid block attributes; however, their values are ignored. - Modify handling of example blocks (Brian Leung, #5717).
- Allow the
-iswitch to ignore leading spaces (Brian Leung). - Handle awkwardly-aligned code blocks within lists (Brian Leung).
Code blocks in Org lists must have their
#+BEGIN_aligned in a reasonable way, but their other components can be positioned otherwise. - Fix parsing of empty comment lines (#5856, Albert Krewinkel). Comment lines in Org-mode can be completely empty.
- Accept
-
Muse reader (Alexander Krotov):
- Add RTL support (#5551).
- Do not allow closing asterisks to be followed by
*. - Do not split series of asterisks into symbols and emphasis (#5821).
- Do not terminate emphasis on
*not followed by space.
-
DokuWiki reader:
- Parse markup inside monospace (’’) (#5916, Alexander Krotov).
-
Docx reader:
- Move style-parsing-specific code to a new unexported module, Text.Pandoc.Readers.Docx.Parse.Styles (Nikolay Yakimov).
- Move StyleMap to docx writer (Nikolay Yakimov).
- Only use LTR when it is overriding BiDi setting (#5723, Jesse
Rosenthal). The left-to-right direction setting in docx is used
in the spec only for overriding an explicit right-to-left setting.
We only process it when it happens in a paragraph set with BiDi.
This is especially important for docs exported from Google Docs,
which explicitly (and unnecessarily) set
rtl=0for every paragraph. - Fix list number resumption for sublists (#4324). The first list item of a sublist should not resume numbering from the number of the last sublist item of the same level, if that sublist was a sublist of a different list item.
-
Docbook reader:
- Richer parse for admonitions (Michael Peyton Jones, #1234). Instead of parsing admonitions as blockquotes, we now parse them as Divs with an appropriate class. We also handle titles for admonitions as a nested Div with the “title” class.
- Fix nesting of chapters and sections (#5864, Florian Klink, Félix Baylac-Jacqué).
- Fix bug with entities in mathphrase element (#5885).
-
MediaWiki reader:
- Skip optional
{{table}}template (#5757).
- Skip optional
-
LaTeX reader:
- Fix dollar-math parsing to ensure that space is left between a control sequence and a following letter (#5836).
- In
untokenize, ensure space between control sequence and following letter (#5836). - Don’t omit macro definitions defined in the preamble.
These were formerly omitted (though they still affected macro
resolution if
latex_macroswas set). Now they are included in the document body. - Parse macro definitions as raw LaTeX when
latex_macrosis disabled. (Whenlatex_macrosis enabled, we omit them, since pandoc is applying the macros itself.) - Fix a hang/memory leak in certain circumstances (#5845).
- Text.Pandoc.Readers.LaTeX.Parsing: add
[Tok]parameter torawLaTeXParser. This allows us to repeat retokenizing unnecessarily in e.g.rawLaTeXBlock. - Add KOMA-Script metadata commands (#5910, Andrew Dunning).
Add all titling commands to existing definition for
\dedication. - Parse
\microsiunitx unit command (#5921, Jose Luis Duran).
-
Markdown writer:
- Ensure proper nesting when we have long ordered list markers (#5705).
- Make
plainoutput plainer (#5741). Previously we used the following Project Gutenberg conventions for plain output: extra space before and after level 1 and 2 headings, all-caps for strong emphasis, underscores surrounding regular emphasis. Now these conventions are used only when thegutenbergextension is enabled. By default, Strong and Emph are rendered without special formatting, and headings are rendered without special formatting, and with only one blank line following. To restore the former behavior, use-t plain+gutenberg. - Prefer using raw_attribute when enabled (#4311).
The
raw_attributewill be used to mark raw bits, even HTML and LaTeX, and even whenraw_htmlandraw_texare enabled, as they are by default. To get the old behavior, disableraw_attributein the writer. - Prefer
pipe_tablesto raw HTML even when we must lose width information (#2608, #4497). - Improve escaping in list items (#5918).
-
AsciiDoc writer:
- Don’t include
+in code blocks for regular asciidoc. This is asciidoctor-specific. - Handle admonitions (#5690).
- Don’t include
-
LaTeX writer:
- Add thin space when needed in LaTeX quote ligatures (#5684).
- Use
\hspace{0pt}for 0-width space U+200B (#5756). - Use
cslreferencesenvironment for csl bibliographies. This allows bibliographies to receive special formatting. The template now contains definition of this environment (enabled only when CSL is used). It also defines a\cslhangindentlength. This is set to 2em by default when the bibliography style specifies a hanging indent. To override the length, you can use e.g.\setlength{\cslhangindent}{7em}in header-includes. See jgm/pandoc-citeproc#410. - Strip off
{}around locator for biblatex/natbib output (#5722). - Fix line breaks at start of paragraph (#3324).
Previously we just omitted these. Now we render them
using
\hfill\breakinstead of\\. This is a revision of a PR by @sabine (#5591) who should be credited with the idea. - We no longer look in the template or header-includes to see if a
book or article documentclass is used, or to see whether the
csquotespackage is used. To usecsquotesfor LaTeX, setcsquotesin your variables or metadata. To specify a book style, use thedocumentclassvariable or--top-level-division. - Fix horizontal rule (#5801). We change to use 0.5pt rather than
\linethickness, which apparently only ever worked “by accident” and no longer works with recent updates to texlive.
-
ConTeXt writer:
- Add option to include source files in ConTeXt PDFs (Tristan
Stenner, #5578). The metadata field or variable
(
includesource) can be set to attach the source documents to the resulting PDF. - Customizable type of PDF/A for the ConTeXt writer (Karl
Pettersson, #5608). The
pdfavariable may now be set in metadata. Also updated color profile settings in accordance with ConTeXt wiki, and made ICC profile and output intent for PDF/A customizable usingpdfaiccprofileandpdfaintent. - Unit tests: adjust code property to avoid an irrelevant failure involving inline code with two consecutive newlines.
- Set
csl-hanging-indentvariable if needed. - Use special environment for CSL references.
- Use braces, not start/stop, for inline language tags. This prevents unwanted gobbling of spaces.
- Add option to include source files in ConTeXt PDFs (Tristan
Stenner, #5578). The metadata field or variable
(
-
HTML writer:
- Use numeric character references with
--ascii(#5718). Previously we used named character references with html5 output. But these aren’t valid XML, and we aim to produce html5 that is also valid XHTML (polyglot markup). (This is also needed for epub3.) - Ensure that line numbers in code blocks get id-prefix (#5650).
- Ensure TeX formulas are rendered correctly (Philip Pesca,
#5658). The web service passed in to
--webtexmay render formulas using inline or display style by default. Prefixing formulas with the appropriate command ensures they are rendered correctly. - Render inline formulas correctly with
--webtex(Philip Pesca, #5655). We add\textstyleto the beginning of the formula to ensure it will be rendered in inline style. - Pass through
aria-attributes to HTML5 (#5642). - Render a Quoted element with an inner Span with
citeattribute using a<q>tag (#5798, Ole Martin Ruud). - Render a Span with class
markusing the<mark>element (Florian Beeres, #5797). - Render Span with class
dfnusing<dfn>element (Florian Beeres, #5882). - Render Span with class
kbdusing<kbd>element (Daniele D’Orazio, #5796). - Render Code with class
variableusing<var>element (Amogh Rathore, #5799). - Render Code with class
sampleusing<samp>element (Amogh Rathore, #5799).
- Use numeric character references with
-
EPUB writer:
- Improve splitting into chapters (#5761), using
makeSection. - Avoid issuing warning multiple times when title not set (see #5760).
- Use svg tag wrapper for cover image (#5638). In addition, the code generating the image has been moved to the template, to make it more customizable. NOTE: Those who use custom EPUB templates will need to adjust their templates, adding the code to generate the cover image. (Previously this was just inserted into ‘body’.)
- Improve toChapters, making it work better if there are Divs around sections.
- Add support for EPUB2 covers (blmage, #3992).
- Do not override existing “fileN” medias when writing to EPUB format (blmage, #4206).
- Ensure that
langvariable is set on all chapters (so that it will add anxml:langattribute on thehtmlelement).
- Improve splitting into chapters (#5761), using
-
RST writer:
- Removed remnants of
admonition-title. - Fix handling of
:align:on figures and images (#4420). When the image has thealign-right(etc.) class, we now use an:align:attribute. - Improve spacing for tables with no width information (#5899). If a simple table would be too wide, we use a grid table.
- Fix backslash escaping after strings (Albert Krewinkel, #5906). The check whether a complex inline element following a string must be escaped, now depends on the last character of the string instead of the first.
- Ensure there’s a blank line before tables (#5898).
- Removed remnants of
-
Dokuwiki writer:
- Handle mixed lists without HTML fallback (#5107).
-
XWiki writer:
- Fix multiline table (Zihang Chen, #5683).
-
Muse writer:
- Add RTL support (Alexander Krotov, #5551).
-
Man writer:
- Suppress non-absolute link URLs (#5770). Absolute URLs are still printed in parentheses following the link text, but relative URLs are suppressed (just as internal links starting with ‘#’ always have been).
- Improved definition list term output. Now we boldface code but not other things. This matches the most common style in man pages (particularly option lists).
-
Ms writer:
- Use
.LPinstead of.PPfor line block (#5588). - Use boldface for definition terms in DefinitionLists.
- Use
-
JATS writer:
- Do not emit empty
<fn-group>(Mauro Bieg, #5595). - Update template to v1.1dtd (#5632, Arfon Smith).
- Update
data/jats.cslto avoid commas between editor name-part elements. (#5629) - Add
abstractto template (Mauro Bieg).
- Do not emit empty
-
TEI writer:
- Don’t strip hash from internal links (#5922).
-
Jira writer:
- Remove escapeStringForJira for code blocks (Jan-Otto Kröpke).
- Remove extraneous newline after single-line block quotes (#5858, Albert Krewinkel).
- Improve escaping of special characters, using backslash escapes instead of HTML entities (#5858, Albert Krewinkel).
-
OpenDocument writer:
- Avoid duplicate attributes (#4634). We use the innermost attribute in nested cases.
- If
native_numberingextension is set, use native OpenDocument enumeration for figures and tables (Nils Carlson). - Place caption before table (#5681, Dmitry Pogodin).
-
ODT writer:
- Add a test for MathML formulas in ODT documents (blmage).
- Improve the parsing of frames in ODT documents (blmage).
-
Docx writer:
- Make handling of styles more robust in localized versions
of Word (Nikolay Yakimov, #5523, #5052, #5074). We now use
style names, not ids, for assigning semantic meaning, since
the ids can change depending on the locale. Style name
comparisons are case-insensitive, since those are
case-insensitive in Word. Since docx style names can have
spaces in them, and pandoc-markdown classes can’t, anywhere
when style name is used as a class name, spaces are
replaced with ASCII dashes
-. Code styles, i.e. “Source Code” and “Verbatim Char” now honor style inheritance. Docx Reader now honours “Compact” style (used in Pandoc-generated docx). The side-effect is that “Compact” style no longer shows up in docx+styles output. Styles inherited from “Compact” will still show up. - Re-use Readers.Docx.Parse for StyleMap (#5766, Nikolay Yakimov).
- Internal improvements and code simplification (Nikolay Yakimov).
- Preserve built-in styles in DOCX with custom style (Ben Steinberg, #5670). This change prevents custom styles on divs and spans from overriding styles on certain elements inside them, like headings, blockquotes, and links. On those elements, the “native” style is required for the element to display correctly. This change also allows nesting of custom styles; in order to do so, it removes the default “Compact” style applied to Plain blocks, except when inside a table.
- Add
proofStateto list of elements carried over from settings.xml in the reference.docx (Krystof Beuermann, #5703). - Change order of
ilvlandnumIdindocument.xml(Agustín Martín Barbero, #5645). Also, make list para properties go first. This reordering of properties shouldn’t be necessary but it seems Word Online does not understand the docx correctly otherwise.
- Make handling of styles more robust in localized versions
of Word (Nikolay Yakimov, #5523, #5052, #5074). We now use
style names, not ids, for assigning semantic meaning, since
the ids can change depending on the locale. Style name
comparisons are case-insensitive, since those are
case-insensitive in Word. Since docx style names can have
spaces in them, and pandoc-markdown classes can’t, anywhere
when style name is used as a class name, spaces are
replaced with ASCII dashes
-
PowerPoint writer:
- Code formatting is now context dependent (Jeroen de Haas, #5573).
This commit alters the way in which the Powerpoint writer treats
inline code and code blocks. Inline code is now formatted at
the same size as the surrounding text. Code blocks are now given
a margin and font size according to their level.
Furthermore this commit allows changing the font with which code is
formatted via the
monofontoption. - Start numbering at appropriate numbers (Jesse Rosenthal, #5709). Starting numbers for ordered lists were previously ignored. Now we specify the number if it is something other than 1.
- Code formatting is now context dependent (Jeroen de Haas, #5573).
This commit alters the way in which the Powerpoint writer treats
inline code and code blocks. Inline code is now formatted at
the same size as the surrounding text. Code blocks are now given
a margin and font size according to their level.
Furthermore this commit allows changing the font with which code is
formatted via the
-
Text.Pandoc.Parsing:
- Add
manyChar,many1Char,manyTillChar,many1TillChar,many1Till,manyUntil,mantyUntilChar: these are like their unsuffixed counterparts but pack some or all of their output (Christian Despres, #5884). - Add
stateAllowLineBreakstoParserState[API change]. - Fix inline parsing in grid table cells (#5708).
- Change type of
setLastStrPosso it takes aMaybe SourcePosrather than aSourcePos[API change]. - Make
parseFromString'andgridTableWithandgridTableWith'polymorphic in the parser state, constraining it withHasLastStrPosition[API change]. parseFromString': resetstateLastStrPostoNothingbefore parse.- Rename takeWhileP -> take1WhileP and clean it up. (It doesn’t match the empty sequence.)
- Add
-
Text.Pandoc.PDF:
- For PDFs via HTML, ensure temp file is deleted even if the pdf program is not found (#5720).
- Better detection of a Cygwin environment (#5451).
- Don’t assume tex log file is UTF8-encoded (#5872). Fall back to latin1 if it can’t be read as UTF-8.
-
Text.Pandoc.Extensions:
- Export new function
getAllExtensions, which returns the extensions that affect a given format (whether enabled by default or not) [API change]. - Change type of
parseFormatSpecfromEither ParseError (String, Extensions -> Extensions)toEither ParseError (String, [Extension], [Extension])[API change]. - Add
Ext_gutenbergconstructor toExtension[API change]. - Add
Ext_native_numberingconstructor toExtension[API change] (Nils Carlson).
- Export new function
-
Text.Pandoc.Readers, Text.Pandoc.Writers:
- Change type of
getReaderandgetWriterso they return a value in the PandocMonad instance rather than an Either [API change]. Exceptions for unknown formats and unsupported extensions are now raised by these functions.
- Change type of
-
Text.Pandoc.App
- Change
optMetadataFiletype fromMaybe FilePathto[FilePath](Owen McGrath, #5702) [API change].
- Change
-
Text.Pandoc.Logging:
- Add
CouldNotDeduceFormatconstructor toLogMessage[API change]. Issue this warning when we’re falling back to markdown or html because we don’t recognize the extension of the input or output files. - Clarify warning for missing title (#5760).
- Add
UnusualConversionconstructor toLogMessage[API change] (Mauro Bieg, #5736). Emit warning on-f latex -o out.pdf.
- Add
-
Lua filters:
- Improve function documentation (Albert Krewkinkel).
- Traverse nested blocks and inlines in correct order (Albert Krewinkel, #5667). Traversal methods are updated to use the new Walk module so that sequences with nested Inline (or Block) elements are traversed in the order in which they appear in the linearized document.
- New unexported module
Text.Pandoc.Lua.Walk(Albert Krewinkel). Lua filters must be able to traverse sequences of AST elements and to replace elements by splicing sequences back in their place. SpecialWalkableinstances can be used for this; those are provided in a new moduleText.Pandoc.Lua.Walk. Attrvalues can now be given as normal Lua tables (Albert Krewinkel, #5744). This can be used as a convenient alternative to constructingAttrvalues withpandoc.Attr. Identifiers are taken from theidfield, classes must be given as space separated words in theclassfield. All remaining fields are included as attributes. With this change, the following lines now create equal elements:
This also works when using the attr setter:pandoc.Span('test', {id = 'test', class = 'a b', check = 1}) pandoc.Span('test', pandoc.Attr('test', {'a','b'}, {check = 1}))
Furthermore, the attributes field of AST elements can now be a plain key-value table even when using thelocal span = pandoc.Span 'text' span.attr = {id = 'test', class = 'a b', check = 1}attributesaccessor:local span = pandoc.Span 'test' span.attributes = {check = 1} -- works as expected now- Export
make_sections, removehierarchicalize. Lua filters that usehierarchicalizewill need to be rewritten to usemake_sections. - Add a
clone()method to all AST elements (Albert Krewinkel, #5568). - Fix Lua function names in pandoc.system (niszet). Change
get_current_directorytoget_working_directoryandwith_temp_directorytowith_temporary_directory, to conform to the manual.
-
Text.Pandoc.Error:
- Add constructors
PandocUnknownReaderError,PandocUnknownWriterError,PandocUnsupportedExtensionError. [API change]. - Better message for
PandocShouldNeverHappenError. - Better message for
PandocTemplateError.
- Add constructors
-
Text.Pandoc.Emoji:
- Update emoji list (#5666). Done using new
tools/emojis.hs, which uses the list from the gem GitHub uses. Future updates can be done with this tool.
- Update emoji list (#5666). Done using new
-
Text.Pandoc.PDF:
- Pass value of
--dpitorsvg-convertwhen converting SVG to PDF in the process of creating a PDF (#5721).
- Pass value of
-
Text.Pandoc.Shared:
- Replace
ElementandmakeHierarchicalwithmakeSections. Now that we have Divs, we can use them to represent the structure of sections, and we don’t need a special Element type.makeSectionsreorganizes a block list, adding Divs with classsectionaround sections, and adding numbering if needed. This change also fixes some longstanding issues recognizing section structure when the document contains Divs (#3057, see also #997). - Remove
Elementtype [API change] - Remove
makeHierarchicalize[API change] - Add
makeSections[API change] - Export
deLink[API change] - Make
filterIpynbOutputstrip ANSI escapes from code in output for non-ipynb formats, when the default “best” option is used with--ipynb-output(#5633). - Fix
camelCaseToHyphenatedso it handlesABCDefbetter. - Improve
isTight(#5857). If a list has an empty item, this should not count against its being a tight list. - Export
htmlSpanLikeElements[API change] (Daniele D’Orazio, #5796). This is a mapping of HTML span-like elements that are internally represented as a Span with a single class. - Change the implementation of
htmlSpanLikeElementsto retain classes and attributes (#5882, Florian Beeres).
- Replace
-
Text.Pandoc.Slides: recognize content in Divs when determining slide level.
-
Text.Pandoc.SelfContained:
- Omit content-type on type attribute for
<style>(#5725). It doesn’t seem to be valid for HTML5, and as a result Chrome ignores the style element.
- Omit content-type on type attribute for
-
Text.Pandoc.Pretty has been removed [API change]. We now use the new external doclayout module instead.
-
Text.Pandoc.Writers.Shared:
- Remove
metaToJSON,metaToJSON'[API change]. - Modify
addVariablesToContext,defField,setField,getField,resetFieldto work with Context rather than JSON values. [API change] - Export new function
endsWithPlain[API change]. - Change
gridTablesso it does better at keeping the widths of columns (#4320) and does better at figuring out column widths when no widths are given (#5899).
- Remove
-
Text.Pandoc.Options
- Change type of
writerTemplatetoMaybe Templateinstead ofMaybe String. - Change To/FromJSON instances for
HTMLMathMethod,CiteMethod,ObfuscationMethod,TrackChanges,WrapOption,TopLevelDivision,ReferenceLocation,HTMLSlideVariant(#5790). In each case we use lowercase (or hyphenated lowercase) for constructors to line up more closely with command-line option values. This is a breaking change for those who manually decode or encode JSON for these data types (e.g. forReaderOptionsorWriterOptions).
- Change type of
-
Text.Pandoc.Filters:
- Add
FromYAMLinstance forFilter. applyFilters: Add and apply filters in order (not reversed) This changesapplyFiltersfrom Text.Pandoc.Filter so that it does a left fold rather than a right fold, applying the filters in the order listed.
- Add
-
Text.Pandoc.XML:
- Change
toEntitiesto emit numerical hex character references (#5718).
- Change
-
Text.Pandoc.Highlighting:
- Add additional listings languages (Wandmalfarbe).
-
Text.Pandoc.MediaBag:
- Some of the types using Strings were switched to use FilePath instead (Christian Despres, #5884).
-
Text.Pandoc.Templates:
- Don’t import/export
varListToJSON[API change]. It is removed in doctemplates >= 0.3. - Change type of
renderTemplate'[API change]. Return value is now Text rather than being polymorphic. This makes room for upcoming removal of theTemplateTargetclass from doctemplates.
- Don’t import/export
-
Text.Pandoc.App.Opt [API changes]:
- More convenient To/FromJSON instances. Make the field names
like
strip-empty-paragraphsrather thanoptStripEmptyParagraphs. Anyone who is using JSON serialization of Opt will need to adjust things accordingly. - Change
optHighlightStyleto aMaybe Stringinstead ofMaybe Style. Do the parsing/loading of themes later, after option parsing. - Remove
optBaseHeaderLevelfromOpt. We now just useoptShiftHeadingLevelBy, to avoid redundancy. - Change
optShiftHeadingLeveltooptShiftHeadingLevelByto match the option. - Custom FromJSON instance for
LineEnding, so eitherCRLForcrlfwill work. - Change
optVariablesfrom[(String, String)]toContext Text. - Change
optMetadatatoMeta, to allow structured values. The current behavior of the--metadataoption stays the same. - Rename
optReader,optWriterasoptFrom,optTo. - Add
FromYAMLinstances toOptand to all subsidiary types. - Rename
optMetadataFiletooptMetadataFiles. - Rename
optPDFEngineArgstooptPDFEngineOpts. - Rename
optWrapTexttooptWrap. - Add
IpynbOutputenumerated type: use this instead of a string foroptIpynbOutput. - Change optInputFiles to a
Maybe [FilePath](#5888) [API change].Nothingmeans: nothing specified.Just []means: an empty list specified (e.g. in defaults). - List fields in Opt so they aren’t reversed (#5881) [API change].
Previously
optIncludeInHeader, etc. were in reverse order. - The
sourcefilevariable is now always a list. It used to be sometimes a string, sometimes a list (when there was more than one).
- More convenient To/FromJSON instances. Make the field names
like
-
Template changes:
- default.latex: added code for
cslreferencesenvironment, to be used for pandoc-citeproc references. Acsl-hanging-indentvariable (set automatically if there is ahanging-identclass on the references Div) controls whether contents of this environment receive a hanging indent. - default.latex: Add
spaceas default option for xeCJK, so that spaces between words are preserved (#5855, jeongminkim-islab). This is necessary for Korean. - default.latex: Remove include of
grffile(#5848). This package used to be needed for proper handling of image filenames containing periods (in addition to the period before the extension). It no longer works with the latest LaTeX kernel and graphicx, so we have removed it. Future versions of graphicx will handle these filenames without the need forgrffile. - default.context: add a saner default for page numbers.
Previously they appeared centered at the top of the page;
now we put them centered at the bottom, unless the
pagenumberingvariable is set. - default.context: define a start-stop-pair
cslreferencesto allow for hanging indents in the bibliography (#5875, Denis Maier). - default.ms: update defaults. Use Palatino font, use slightly wider interparagraph space, don’t indent paragraphs, and put page numbers on the bottom. This brings ms output closer to default LaTeX output.
- default.revealjs: add navigationMode (Mauro Bieg, #5657).
- default.muse: handle multiple authors better.
- docbook4, docbook5 templates: add indentation to body.
- HTML-based templates: use
styles.htmlpartial to avoid code duplication. - HTML-based templates: change indentation of styles in template.
- default.latex: added code for
-
reference.docx (#5820):
- Change Block Text (block quote) style so that the same font is used as in the body text, and the block text is indented left and right.
- All headings now have a uniform color.
- Level-1 headings no longer set
w:themeShade="B5". - Level-2 headings are now 14 point rather than 16 point.
- Level-3 headings are now 12 point rather than 14 point.
- Level-4 headings are italic rather than bold.
-
epub.css: Add CSS for hanging-indent div to support pandoc-citeproc’s new hanging indents.
-
pandoc.cabal:
- Repeat ghc-options in all stanzas.
- Remove conditionals for ghc < 8 (Albert Krewinkel, #5693).
- Compile with
-Wcpp-undefand-fhide-source-pathswhen possible (Albert Krewinkel). - Add cabal.project to extra-source-files (Albert Krewinkel).
- Add dependency on skylighting-core (#5729). Even though it shouldn’t be needed, some tools require it.
- Require latest pandoc-types, texmath, skylighting, haddock-library.
- Ensure TemplateHaskell is added to other-extensions when it is used (Vanessa McHale, #5728).
- Remove
derive_json_via_thflag; always use TH. This cuts down on code duplication and reduces the chance for errors. See #4083.
-
Makefile:
- Add ghci target.
- Add ghcid target.
- Remove references to obsolete flag (#5694).
-
Benchmarks: fix failure on ipynb.
-
Use MathJax 3 (zorkow).
-
KaTeX math: respect
classoption=fleqnvariable, bump KaTeX version to 0.11.1 (#5815, Mauro Bieg). -
Fix redundant constraint compiler warnings (Pete Ryland, #5625).
-
Use throwError instead of fail when appropriate.
-
Use Prelude.fail to avoid ambiguity with fail from GHC.Base.
-
Add
diff-zip.shto tools (John MacFarlane, Agustín Martín Barbero). This is intended to make it easier to test differences in zip containers, like epub, docx, or odt. -
Add
.gitattributes(#5747). This ensures that the golden files intest/fb2/reader/don’t have newlines converted. This should fix a test failure on GitHub CI with Windows. -
Reorder options in
--help. -
Revise code for HsYAML-0.2.0.0 (@vijayphoenix, #5704).
-
Remove blank line in code example in Haddocks (Leif Metcalf, #5679).
-
Fix trypandoc with
getReader/getWriterchanges. -
Allow building pandoc with GHC 8.8.
-
linux tarball: add architecture
-amd64to filename. Now it will be:pandoc-VERSION-linux-ARCH.tar.gz. -
MANUAL.txt:
- Add section for exit codes.
- Document some pptx limitations in slide show section:
No incremental display (#5689). No pause with
. . .(#5701). - reveal.js flags (Mauro Bieg, #5653).
- Document addition of
data-prefix to unknown attributes in HTML5. - Link to YAML spec (Mauro Bieg, #5687).
- Fix capitalization of “Linux” (#5859, Marcus Stollsteimer).
- Use a table for exit codes.
- Put all template variable docs into one section.
- Use ATX headers consistently.
- Add fuller documentation of templates (#5779), including new template syntax, partials, etc.
- Add documentation for the variable
hyperrefoptions(Wandmalfarbe). - Clarify when macro definitions are passed as raw latex.
In Markdown input, they are always passed through. In LaTeX, only if
latex_macrosis disabled. - Clarify that
--dpiprovides a default and doesn’t override dpi values specified in the images themselves (#5721). - Document how to use custom writers with
--standalone(#5866). - Clarify
--preserve-tabsdefault.
-
INSTALL.md:
- Fix instructions for libicu.
- Add Void Linux instructions (Volodymyr Kozachnyskyi).
-
CONTRIBUTING.md:
- Add information on tests (Agustín Martín Barbero, #5652).
- Add information about command test naming to CONTRIBUTING (Florian B).
-
Fix typos in changelog and comments (#5896, Brian Wignall).
-
doc/lua-filters.md:
- Fix mistakes in mediabag module docs (#5851, Albert Krewinkel).
- Improve metadata replacement example in lua-filters doc (#5851).
- Mention which Lua version is shipped with pandoc (Albert Krewinkel, #5892).
-
Add
jira(Atlassian’s Jira wiki markup) as output format (#2497, Albert Krewinkel). -
Add
tex_math_dollarstomultimarkdownExtensions(#5512). This form is now supported in multimarkdown, in addition totex_math_double_backslash. -
Fix
--self-containedso it works when output format has extensions. Previously if you used--self-containedwithhtml-smartorhtml+smart, it wouldn’t work. -
Add template variable
curdirwith working directory from which pandoc is run (#5464). -
Markdown reader: don’t create implicit reference for empty header (#5549).
-
Muse reader: allow images inside link descriptions (Alexander Krotov).
-
HTML reader: epub related fixes.
- With epub extensions, check for
epub:typein addition totype. - Fix problem with noteref parsing which caused block-level content to be eaten with the noteref.
- Rename
pAnyTagtopAny. - Refactor note resolution.
- Trim definition list terms (Alexander Krotov).
- With epub extensions, check for
-
LaTeX reader:
- Add braces when resolving
\DeclareMathOperator(#5441). These seem to be needed for xelatex but not pdflatex. - Allow newlines in
\mintinline. - Pass through unknown listings language as class (#5540). Previously if the language was not in the list of languages supported by listings, it would not be added as a class, so highlighting would not be triggered.
rawLaTeXInline: Include trailing{}s in raw latex commands (#5439). This change affects the markdown reader and other readers that allow raw LaTeX. Previously, trailing{}would be included for unknown commands, but not for known commands. However, they are sometimes used to avoid a trailing space after the command. The chances that a{}after a LaTeX command is not part of the command are very small.
- Add braces when resolving
-
MediaWiki reader: handle multiple attributes in table row (#5471, chinapedia).
-
Docx reader: Add support for
w:rtl(#5545). Elements with this property are put into Span inlines withdir="rtl". -
DocBook reader: Issue
IgnoredElementwarnings. -
Org reader (Albert Krewinkel):
- Fix planning elements in headers level 3 and higher (#5494). Planning info is now always placed before the subtree contents. Previously, the planning info was placed after the content if the header’s subtree was converted to a list, which happens with headers of level 3 and higher per default.
- Omit, but warn about unknown export options. Unknown export options are properly ignored and omitted from the output.
- Prefer plain symbols over math symbols (#5483).
Symbols like
\alphaare output plain and unemphasized, not as math. - Recognize emphasis after TODO/DONE keyword (#5484).
-
FB2 reader:
- Skip unknown elements rather than throwing errors (#5560).
Sometimes custom elements are used (e.g.
idelement insideauthor); previously the reader would halt with an error. Now it skips the element and issues anIgnoredElementwarning. - Parse notes (#5493, Alexander Krotov).
- Internal improvements (Alexander Krotov).
- Skip unknown elements rather than throwing errors (#5560).
Sometimes custom elements are used (e.g.
-
OpenDocument writer: Roll back automatic figure/table numbering (#5474). This was added in pandoc 2.7.2, but it makes it impossible to use pandoc-crossref. So this has been rolled back for now, until we find a good solution to make this behavior optional (or a creative way to let pandoc-crossref and this feature to coexist).
-
New module Text.Pandoc.Writers.Jira, exporting
writeJira[API change] (Albert Krewinkel). -
EPUB writer:
- Don’t include ‘landmarks’ if there aren’t any. Previously we could get an empty ol element, which caused validation errors with epubcheck.
- Ensure unique ids for styleesheets in content.opf (#5463).
- Make stylesheet link compatible with kindlegen (#5466,
Eric Schrijver). Pandoc omitted
type="text/css"from both<style>and<rel="stylesheet">elements in all templates, which is valid according to the spec. However, Amazon’s kindlegen software relies on this attribute on<link>elements when detecting stylesheets to include.
-
HTML writer:
- Output video and audio elements depending on file extension of the image path (Mauro Bieg).
- Emit empty alt tag in figures (#5518, Mauro Bieg). The same text is already in the and screen-readers would read it twice, see #4737.
- Don’t add variation selector if it’s already there. This fixes round-trip failures.
- Prevent gratuitous emojification on iOS (#5469).
iOS chooses to render a number of Unicode entities, including ‘↩’, as
big colorful emoji. This can be defeated by appending Unicode
VARIATION SELECTOR-15’/‘VARIATION SELECTOR-16’. So we now append this
character when escaping strings, for both ‘↩’ and ‘↔’. If other
characters prove problematic, they can simply be added to
needsVariationSelector. + Addclass="heading"to level 7+ Headers rendered as<p>elements (#5457).
-
RST writer: treat Span with no attributes as transparent (#5446). Previously an Emph inside a Span was being treated as nested markup and ignored. With this patch, the Span is just ignored.
-
LaTeX writer:
- Include inline code attributes with
--listings(#5420). - Don’t produce columns environment unless beamer (#5485).
- Fix footnote in image caption. Regression: the fix for #4683 broke this case.
- Don’t highlight code in headings (#5574). This causes compilation errors.
- Use
\mboxto get proper behavior inside\sout(#5529).
- Include inline code attributes with
-
EPUB writer: Fix document section assignments (#5546). For example, introduction should go in bodymatter, not frontmatter, and epigraph, conclusion, and afterward should go in bodymatter, not backmatter. For the full list of assignments, see the manual.
-
Markdown writer:
- Add backslashes to avoid unwanted interpretation of definition list terms as other kinds of block (#554).
- Ensure the code fence is long enough (#5519). Previously too few backticks were used when the code block contained an indented line of backticks. (Ditto tildes.)
- Handle labels with integer names (Jesse Rosenthal, #5495).
Previously if labels had integer names, it could produce a conflict
with auto-labeled reference links. Now we test for a conflict and
find the next available integer. This involves adding a new state
variable
stPrevRefsto keep track of refs used in other document parts when using--reference-location=block|section
-
Textile writer: fix closing tag for math output (Albert Krewinkel). Opening and closing tag for math output match now.
-
Org writer: always indent src blocks content by 2 spaces (#5440, Albert Krewinkel). Emacs always uses two spaces when indenting the content of src blocks, e.g., when exiting a
C-c 'edit-buffer. Pandoc used to indent contents by the space-equivalent of one tab, but now always uses two spaces, too. -
Asciidoc writer:
- Use
`+...+`form for inline code. The old`a__b__c`yields emphasis inside code in asciidoc. To get a pure literal code span, use`+a__b__c+`. - Use proper smart quotes with asciidoctor (#5487). Asciidoctor has a different format for smart quotes.
- Use doubled ## when necessary for spans (#5566).
- Ensure correct nesting of strong/emph (#5565): strong must be the outer element.
- Use
-
JATS writer:
- Wrap elements with p when needed (#5570). The JATS spec restricts
what elements can go inside
fnandlist-item. So we wrap other elements inside<p specific-use="wrapper">when needed. - Properly handle footnotes (#5511) according to “best practice.”
(Group them at the end in
<fn-group>and use<xref>elements to link them.) - Fix citations with PMID so they validate (#5481). This includes an update to data/jats.csl.
- Ensure validity of
<pub-date>by parsing the date and extracting year, month, and day, as expected. Also add an iso-8601-date attribute automatically. - Don’t use
<break>element for LineBreak. It is only allowed in a few special contexts, and not in<p>elements. - Don’t make
<string-name>a child of<string>, which is illegal.
- Wrap elements with p when needed (#5570). The JATS spec restricts
what elements can go inside
-
FB2 writer:
- Do not wrap note references into
<sup>and brackets (Alexander Krotov). Existing FB2 readers, such as FBReader, already display links with type=“note” as a superscript. - Use genre metadata field (#5478).
- Do not wrap note references into
-
Muse writer: do not escape empty line after
<br>(Alexander Krotov). -
Add unicode code point in “Missing character” warning (#5538). If the character isn’t in the console font, the message is pretty useless, so we show the code point for anything non-ASCII.
-
Lua: add Version type to simplify comparisons (Albert Krewinkel). Version specifiers like
PANDOC_VERSIONandPANDOC_API_VERSIONare turned intoVersionobjects. The objects simplify version-appropriate comparisons while maintaining backward-compatibility. A functionpandoc.types.Versionis added as part of the newly introduced modulepandoc.types, allowing users to create version objects in scripts. -
pandoc lua module (Albert Krewinkel):
- Fix deletion of nonexistent attributes (#5569).
- Better tests for Attr and AttributeList.
-
pandoc.mediabag lua module (Albert Krewinkel):
- Add function
deletefor deleting a single item. - Add function
emptyfor removing all entries. - Add function
itemsfor iterating over mediabag.
- Add function
-
Text.Pandoc.Class: Fix handling of
file:URL scheme indownloadOrRead(#5517, Mauro Bieg). Previouslyfile:/URLs were handled wrongly and pandoc attempted to make HTTP requests, which failed. -
Text.Pandoc.MIME: add
mediaCategory[API change] (Mauro Bieg). -
Text.Pandoc.Shared:
- Add
onlySimpleTableCells[API change] (Mauro Bieg) and use this to consolidate simple-table detection (#5524). This fixes an inconsistency in the HTML reader, which did not treat tables with<p>inside cells as simple. metaToJSON: treat digits starting with 0 as a string, not a number (#5479). This fixes a regression in YAML metadata in pandoc 2.7.2.
- Add
-
Text.Pandoc.Logging: Add
IgnoredElementconstructor forLogMessage.SkippedConetntdoesn’t work for some XML-based readers which don’t have access to parsec source positions. -
Text.Pandoc.Asciify: Add Turkish undotted-i (#5433, Mauro Bieg).
-
Improve output of Lua tests (#5499, Albert Krewinkel). This makes use of tasty-lua, a package to write tests in Lua and integrate the results into Tasty output. Test output becomes more informative: individual tests and test groups become visible in test output. Failures are reported with helpful error messages.
-
Lua: add
pandoc.systemmodule (#5468, Albert Krewinkel). ThesystemLua module provides utility functions to interact with the operating- and file system. E.g.print(pandoc.system.get_current_directory())orpandoc.system.with_temporary_directory('tikz', function (dir) -- write and compile a TikZ file with pdflatex end) -
LaTeX template: Add pdflang to hypersetup if lang is set (#5443).
-
beamer template: Fix using Beamer with geometry (#5505, Daniel Maslowski). Beamer already loads geometry, so we need to use the
\geometrycommand to set geometry options. -
EPUB2/3 templates: Move inline styles to default epub.css (#5466). NOTE: Those who use a custom CSS stylesheet with EPUB should add these lines:
code{ white-space: pre-wrap; } span.smallcaps{ font-variant: small-caps; } span.underline{ text-decoration: underline; } q { quotes: "“" "”" "‘" "’"; } div.column{ display: inline-block; vertical-align: top; width: 50%; } -
reveal.js template:
- Updates for revealjs 3.8.0 (#5435, ebiim).
- Remove reference to head.min.js (#5448, Winnie Hellmann). NOTE: users will need to update reveal.js to at least 3.8.0 for their presentations generated with this version of pandoc to work correctly.
-
Text.Pandoc.PDF:
- Replace
</>with literal/(#5451). We use forward-slash for a directory separator in tmpDir, even on Windows (because that’s what tex likes). So we should not put a backslash between the tmpDir and the filename on Windows. This is harmless enough in normal Windows setups, but it breaks on Cygwin. Thanks to @cc2x for noticing and diagnosing the problem. - Allow use of
-output-directoryin--pdf-engine-opt(#5462). This is currently possible withmklatexand-outdir, but was not yet possible with xelatex and-output-directory. - For PDF via ms/pdfroff, make TOC appear at beginning and in
PDF bookmarks (#5553). Previously the TOC appeared at the end
of the document, and was not bookmarked. To keep it at the end,
add
--pdf-engine-opt=--no-toc-relocationto your command line.
- Replace
-
Fix broken links in documents (#5473, Shim Myeongseob). Also, use absolute links to pandoc.org when possible, so that the links can be followed by people viewing these documents on GitHub.
-
Improved sample lua tikz filter in lua-filters docs (#5445, Matthew Doty). There are three changes:
- It only processes elements which begin with
\begin{tikzpicture} - It uses pdf2svg instead of imagemagick to preserve fidelity
- The images produced have transparent backgrounds
- It only processes elements which begin with
-
MANUAL.txt:
- Add note about
title-meta,author-meta,date-meta(#5486). - Fix typo (#5489, Christian Krause).
- Add note about
-
add test/tables.xwiki to git and pandoc.cabal (#5498, Mauro Bieg).
-
Disable missing-home-modules warning in
stack.yaml. Otherwisestack ghcifails.
-
Add XWiki writer (#1800, Derek Chen-Becker). Add
Text.Pandoc.Writers.XWiki, exportingwriteXWiki[API change]. -
Dokuwiki Reader: parse single curly brace (#5416, Mauro Bieg).
-
Vimwiki reader: improve handling of internal links (#5414). We no longer append
.htmlto link targets, and we add a titlewikilink. This mirrors behavior of other wiki readers. Generally the.htmlextension is not wanted. It may be important for output to HTML in certain circumstances, but it can always be added using a filter that matches on links with titlewikilink.If your workflow requires the current behavior, here is a lua filter that will add the
.htmlextension:function Link(el) if el.title == 'wikilink' then el.target = el.target .. ".html" end return el end -
ipynb reader:
- Use format
ipynbfor raw cell where no format given. - Avoid introducing spurious
.0on integers in metadata.
- Use format
-
Markdown reader: fenced div takes priority over setext header.
-
HTML reader: read
data-fooattribute intofoo(#5392). The HTML writer adds thedata-prefix for HTML5 for nonstandard attributes. But the attributes are represented in the AST without thedata-prefix, so we should strip this when reading HTML. -
LaTeX reader: Improve autolink detection (#5340).
-
PowerPoint writer (Jesse Rosenthal):
- Expand builtin reference doc to model all layouts. The previous built-in reference doc had only title and content layouts. Add in a section-header slide and a two-content slide, so users can more easily modify it to build their own templates.
- Always open up in slide view. When editing a template/reference-doc, the user might be in Master view, but when producing a slide show, it is assumed that slide view will be desired.
- Remove
handoutsMasterListfrom template presentation.xml - Fix numerous errors in templating (#5402). Previously, some templates
produced by Office 365 (MacOS) would not render with
--reference-doccorrectly. We now apply correct shapes for content, and build shape trees correctly. - Make default placeholder type for template lookup.
- Apply speaker notes to metadata slide if applicable.
- Test for speaker notes after breaking header.
- Correctly handle notes after section-title header. Previously, if notes came after a section-title header (ie, a level-1 header in a slide-level=2 presentation), they would go on the next slide. This keeps them on the slide with the header.
- Internal improvements.
-
ipynb writer:
- Use format
ipynbfor raw cell where no format given. According to nbformat docs, this is supposed to render in every format. We don’t do that, but we at least preserve it as a raw block in markdown, so you can round-trip. - Consolidate adjacent raw blocks. Sometimes pandoc creates two HTML blocks, e.g. one for the open tag and one for a close tag. If these aren’t consolidated, only one will show up in output cell.
- Fixed carry-over of nbformat from metadata.
- Preserve
nbformat_minorif it’s given. This helps with round-tripping.
- Use format
-
LaTeX writer:
- Avoid inadvertently creating ?
or !ligatures (#5407). These are upside down ? and !, resp. - Fix footnotes in table caption and cells (#5367). This fixes a
bug wherein footnotes appeared in the wrong order, and with
duplicate numbers, when in table captions and cells.
We now use regular
\footnotecommands, even in the table caption and the minipages containing cells. Apparently longtable knows how to handle this.
- Avoid inadvertently creating ?
-
HTML writer: Don’t add data- prefix to RDFa attributes (#5403).
-
JATS writer: Ensure that plain strings go inside
<pub-id>tag (#5397). -
Markdown writer:
- Better rendering of numbers (#5398). If the number is integral, we render it as an integral not a float.
- Proper rendering of empty map in YAML metadata (#5398). Should
be
{}, not empty string. - Properly escape attributes in Markdown writer (#5369).
- Be sure implicit figures work in list contexts (#5368). Previously they would sometimes not work: e.g., when they occurred in final paragraphs in lists that were originally parsed as Plain and converted later using PlainToPara.
-
Docx writer: Use
w:brwithout attributes for line breaks (#5377). We previously added the attributetype="textWrapping", but this causes problems on Word Online. -
LaTeX template (Andrew Dunning):
- Ensure correct heading/table order (#5365). Improve workaround
(#1658) for tables following headings. The new solution works whether
or not the
indentvariable is enabled. - Remove
subparagraphvariable. The default is now to use run-in style for level 4 and 5 headings (\paragraphand\subparagraph). To get the previous default behavior (where these were formatted as blocks, like\subsubsection), set theblock-headingsvariable. - Add pandoc to PDF metadata (#5388).
- Group graphics-related code (#5389).
- Move
\setstretchafter front matter (#5179). Ensures that\maketitle,\tableofcontents, and so forth are not affected by changes to line spacing.
- Ensure correct heading/table order (#5365). Improve workaround
(#1658) for tables following headings. The new solution works whether
or not the
-
Update data/jats.csl to avoid commas between name-part elements (#5397).
-
Add support for golang (
go) with--listings(#5427). -
Text.Pandoc.Shared - improve
metaToJSONbehavior with numbers. We now do a better job marshalling numbers from MetaString or MetaInlines into JSON Number. -
Text.Pandoc.Writers.Shared:
metaValueToJSON: use Number Values for integers. Pandoc’s MetaValue doesn’t have a distinguished number type, so numbers are put in MetaStrings. If the MetaString consists entirely of digits, we convert it to a Number. We should probably consider adding a MetaNumber constructor to MetaValue, for better round-tripping with JSON etc. This change aids round-tripping in ipynb metadata fields, liketoc_depth. -
Text.Pandoc.Class:
fetchItem: don’t treat UNC paths as protocol-relative URLs (#5127). These are paths beginning//?/UNC/.... -
Text.Pandoc.ImageSize: Improve
pdfSizeso it handles a wider range of PDFs (#4322, with help from Richard Davis). -
Text.Pandoc.Pretty: avoid stack overflow by using strict sum (#5401).
-
Fix harmless error in file-scope code (#5422).
-
MANUAL.txt:
- Improve ‘header’ and ‘heading’ usage (#5423, Andrew Dunning). The term ‘header’ was being used where ‘heading’ is more appropriate.
- Add paragraph on options affecting markdown in ipynb.
-
stack.yaml - remove -Wmissing-home-modules This seems to cause problems with stack ghci. Remove RTS options.
-
Add ghc-options to cabal.project.
-
appveyor.yml - use ghc 8.6.4. Fixes segfault issues on Windows (#5037).
-
linux build process: Remove clone of pandoc-citeproc (#5366). It wasn’t being used; cabal.project specifies the version to use.
-
Use XDG data directory for user data directory (#3582). Instead of
$HOME/.pandoc, the default user data directory is now$XDG_DATA_HOME/pandoc, whereXDG_DATA_HOMEdefaults to$HOME/.local/sharebut can be overridden by setting the environment variable. If this directory is missing, then$HOME/.pandocis searched instead, for backwards compatibility. However, we recommend moving local pandoc data files from$HOME/.pandocto$HOME/.local/share/pandoc. On Windows the default user data directory remains the same. -
Slide show formats behavior change: content under headers less than slide level is no longer ignored, but included in the title slide (for HTML slide shows) or in a slide after the title slide (for beamer). This change makes possible 2D reveal.js slideshows with content in the top slide on each stack (#4317, #5237).
-
Add command line option
--ipynb-output=all|none|best(#5339). Output cells in ipynb notebooks often contain several different versions of an output, with different MIME types, e.g. an HTML table and a plain-text fallback. Specifying--ipynb-output=best(the default) ensures that the best version for the output format is used.allincludes all versions, andnonesuppresses them all, leaving output cells empty. -
asciidoctoris now an output format separate fromasciidoc, to accommodate some minor implementation-specific differences (currently just in the treatment of display math). -
Add
latexmkas an option for--pdf-engine(#3195). Note that you can use--pdf-engine-opt=-outdir=barto specify a persistent temp directory. -
Markdown reader:
- Improve tight/loose list handling (#5285). Previously the algorithm allowed list items with a mix of Para and Plain, which is never wanted.
- Add newline when parsing blocks in YAML (#5271). Otherwise last block gets parsed as a Plain rather than a Para. This is a regression in pandoc 2.x. This patch restores pandoc 1.19 behavior.
- Make
yamlToMetarespect extensions (#5272, Mauro Bieg). This adds aReaderOptionsparameter toyamlToMeta[API change]. - Fix bug parsing fenced code blocks (#5304). Previously parsing would break if the code block contained a string of backticks of sufficient length followed by something other than end of line.
-
LaTeX reader: don’t let
\egroupmatch{.bracednow actually requires nested braces. Otherwise some legitimate command and environment definitions can break. -
Docx reader (Jesse Rosenthal):
- Rename
getDocumentPathasgetDocumentXmlPath. - Use field notation for setting
ReaderEnv. - Figure out
document.xmlpath once at the beginning of parsing, and add it to the environment, so we can avoid repeated lookups. - Dynamically determine main document xml path (#5277).
The desktop Word program places the main document file in
word/document.xml, but the online word places it inword/document2.xml. This file path is actually stated in the root_rels/.relsfile, in theRelationshipelement with anhttp://../officedocumenttype. - Fix paths in archive to prevent Windows failure (#5277). Some paths in archives are absolute (have an opening slash) which, for reasons unknown, produces a failure in the test suite on MS Windows. This fixes that by removing the leading slash if it exists.
- Add comments to aid code readability.
- Trim space inside the last inline (#5273).
- Unwrap sdt elements in footnotes and comments (#5302).
- Rename
-
Muse reader (Alexander Krotov):
- Test that block level markup does not break
<verbatim>. - Add secondary note support.
- Test that block level markup does not break
-
ipynb reader: handle images referring to attachments. Previously we didn’t strip off the attachment: prefix, so even though the attachment was available in the mediabag, pandoc couldn’t find it.
-
JATS reader:
- Fix parsing of figures (#5321). This ensures that a figure
containing a single image is parsed as a pandoc “implicit
figure” (i.e., a Para with a single Image whose title attribute
begins with
fig:). More complex figures will still be parsed as divs. - Support
fig-groupblock element (#5317). - Handle citations with multiple references (#5310). The
ridattribute can have a space-separated list of ids.
- Fix parsing of figures (#5321). This ensures that a figure
containing a single image is parsed as a pandoc “implicit
figure” (i.e., a Para with a single Image whose title attribute
begins with
-
AsciiDoc Writer: Add
writeAsciiDoctor[API change, Tarik Graba]. Handle display math appropriately for Asciidoctor. -
JATS writer: wrap figure caption in
<p>to fix validation (#5290, Mauro Bieg). -
HTML writer:
- Implement WAI-ARIA roles for (end)notes, citations, and bibliography (#4213). Note that doc-biblioref is only used when link-citations produces links, since it belongs on links.
- Include content (including speaker notes) in title slides (#4317, #5237).
-
ipynb writer:
- Ensure final newline.
- Only include metadata under
jupyterfield. - Don’t create attachments for images with absolute URIs, including data: URIs (#5303).
- Keep plain text fallbacks in output even if a richer format is
included (#5293). We don’t know what output format will be needed.
See the
--ipynb-outputcommand line option for a way to control what formats are included in the output.
-
Markdown writer: use
markdown="1"when appropriate for Divs: whennative_divsandmarkdown_in_html_blocksare disabled butraw_htmlandmarkdown_attributeare enabled. -
LaTeX writer:
- Use right fold for
escapeString. This is more elegant than the explicit recursive code we were using. - Avoid
{}after control sequences when escaping.\ldots{}.doesn’t behave as well as\ldots.with the latex ellipsis package. This patch causes pandoc to avoid emitting the{}when it is not necessary. Now\ldotsand other control sequences used in escaping will be followed by either a{}, a space, or nothing, depending on context. - For beamer, include contents under headers superordinate to slidelevel (#4317). Currently we keep the fancy title slide, and add a new slide with the same title and whatever content was under the header.
- Use right fold for
-
Powerpoint writer (Jesse Rosenthal): support underlines. Use span with single class “underline” as in docx writer.
-
Muse writer: escape secondary notes (Alexander Krotov).
-
FB2 writer: add section identifiers support (#5229, John KetzerX).
-
Make
--fail-if-warningswork for PDF output (#5343). -
Lua filters (Albert Krewinkel):
- Load module
pandocbefore callinginit.lua(#5287). The fileinit.luain pandoc’s data directory is run as part of pandoc’s Lua initialization process. Previously, thepandocmodule was loaded ininit.lua, and the structure for marshaling was set up after. This allowed simple patching of element marshaling, but made usinginit.luamore difficult. Now, all required modules are now loaded before callinginit.lua. The file can be used entirely for user customization. Patching marshaling functions, while discouraged, is still possible via thedebugmodule. - All Lua modules bundled with pandoc, i.e.,
pandoc.List,pandoc.mediabag,pandoc.utils, andtextare re-exported from thepandocmodule. They are assigned to the fieldsList,mediabag,utils, andtext, respectively.
- Load module
-
Text.Pandoc.Lua (Albert Krewinkel):
- Split
StackInstancesinto smaller Marshaling modules. - Get
CommonStatefrom Lua global. This allows more control over the common state from within Lua scripts.
- Split
-
LaTeX template:
- Support the
subjectmetadata variable (#5289, Pascal Wagler). - Add
\frontmatter,\mainmatter,\backmatterfor book classes (#5306).
- Support the
-
epub3 template: Add titlepage class to section (#5269).
-
HTML5 template: Add ARIA role
doc-tocfor table of contents (#4213). -
Make
--metadata-fileuse selected extensions (#5279, #5272, Mauro Bieg). -
Text.Pandoc.Shared:
- Remove
withTempDir[API change]. - Add new exported function
defaultUserDataDirs[API change]. - Add
filterIpynbOutput[API change]. compactify: Avoid lists with a mix of Plain and Para elements (#5285).
- Remove
-
Text.Pandoc.Translations: reorder alphabetically and remove
Author(#5334, Mauro Bieg). -
Text.Pandoc.Extensions:
- More carefully groom ipynb default extensions.
- Add
all_symbols_escapabletogithubMarkdownExtensions.
-
Text.Pandoc.PDF:
- Use system temp directory when possible (#1192). Previously we
created temp dirs in the working directory, partly (a) because
there were problems using the system temp directory on Windows,
when their pathnames included tildes, and partly (b) because
programs like
epstopdf.plwould not be allowed to write to directories outside the working directory in restricted mode. We now (a) use the system temp dir except when the path includes tildes, and (b) setTEXMFOUTPUTwhen creating the PDF, so that subsidiary programs can use the system temp directory. This addresses problems that occurred when pandoc was used in a synced directory (such as Dropbox). - Change types of subsidiary functions to PandocIO, to allow warnings to be threaded through (#5343).
- Use system temp directory when possible (#1192). Previously we
created temp dirs in the working directory, partly (a) because
there were problems using the system temp directory on Windows,
when their pathnames included tildes, and partly (b) because
programs like
-
Text.Pandoc.MIME: add WebP (#5267, Mauro Bieg).
-
Tests: avoid calling
findPandocmultiple times. -
Old tests: remove need for temp files by using
pipeProcess. -
Added simple ipynb reader/writer tests (#5274).
-
Rearrange
--helpoutput in a more rational way, with common options at the beginning and options grouped by function (#5336). -
trypandoc: Add JATS and other missing formats (Arfon Smith, #5291).
-
Add missing copyright notices and remove license boilerplate (#4592, Albert Krewinkel).
-
Use latest basement/foundation on 32bit windows.
-
Use latest skylighting (#5328). Custom syntax definitions no longer try to load
language.dtd. -
Require texmath 0.11.2.1
-
Use latest pandoc-citeproc (0.16.1.1).
-
MANUAL.txt:
- Clarify variable substitution indentation in templates (#5338, Agustín Martín Barbero).
- Reorder custom-styles section (#5324, Mauro Bieg).
-
Support ipynb (Jupyter notebook) as input and output format.
- Add
ipynbas input and output format (extension.ipynb). - Added Text.Pandoc.Readers.Ipynb [API change].
- Added Text.Pandoc.Writers.Ipynb [API change].
- Add
PandocIpynbDecodingErrorconstructor to Text.Pandoc.Error.Error [API change]. - Depend on ipynb library.
- Note: there is no template for ipynb.
- Add
-
Add DokuWiki reader (#1792, Alexander Krotov). This adds Text.Pandoc.Readers.DokuWiki [API change], and adds
dokuwikias an input format. -
Implement task lists (#3051, Mauro Bieg). Added
task_listsextension. Task lists are supported from markdown and gfm input. They should work, to some degree, in all output formats, though in most formats you’ll get a bullet list with a unicode character for the box. In HTML, you get checkboxes and in LaTeX/PDF output, a box is used as the list marker. API changes:- Added constructor
Ext_task_liststoExtension. - Added
taskListItemFromAsciiandtaskListItemToAsciito Text.Pandoc.Shared.
- Added constructor
-
Allow some command line options to take URL in addition to FILE.
--include-in-header,--include-before-body,--include-after-body. -
HTML reader:
- Handle empty
startattribute (see #5162). - Treat
textareaas a verbatim environment (#5241) and preserve spacing.
- Handle empty
-
RST reader:
- Change treatment of
number-linesdirective (Brian Leung, #5207). Directives of this type without numeric inputs should not have astartFromattribute; with a blank value, the writers can produce extra whitespace. - Removed superfluous
sourceCodeclass on code blocks (#5047). - Handle
sourcecodedirective as synonym forcode(#5204).
- Change treatment of
-
Markdown reader:
- Remove
sourceCodeclass for literate Haskell code blocks (#5047). Reverse order ofliterateandhaskellclasses on code blocks when parsing literate Haskell, sohaskellis first. - Treat
<textarea>as a verbatim environment (#5241).
- Remove
-
Org reader:
- Handle
minleveloption differently (#5190, Brian Leung). Whenminlevelexceeds the original minimum level observed in the file to be included, every heading should be shifted rightward. - Allow for case of
:minlevel == 0(#5190). - Fix treatment of links to images (#5191, Albert Krewinkel). Links with descriptions which are pointing to images are no longer parsed as inline images, but as links.
- Add support for #+SELECT_TAGS (Brian Leung).
- Separate filtering logic from conversion function (Brian Leung).
- Handle
-
TWiki reader: Fix performance issue with underscores (#3921).
-
MediaWiki reader: use
_instead of-in auto-identifiers (#4731). We may not still be exactly matching mediawiki’s algorithm. -
LaTeX reader:
- Remove
sourceCodeclass for literate Haskell code blocks (#5047). Reverse order ofliterateandhaskellclasses on code blocks when parsing literate Haskell, sohaskellis first. - Support
\DeclareMathOperator(#5149). - Support
\inputminted(#5103). - Support
\endinput(#5233). - Allow includes with dots like
cc_by_4.0. Previously the.0was interpreted as a file extension, leading pandoc not to add.tex(and thus not to find the file). The new behavior matches tex more closely.
- Remove
-
Man reader:
- Use
mapLeftfrom Shared instead of defining own.
- Use
-
Docx reader (Jesse Rosenthal):
- Handle level overrides (#5134).
-
Docx writer:
- Support custom properties (#3024, #5252, Agustín Martín Barbero).
Also supports additional core properties:
subject,lang,category,description. - Make Level into a real type, instead of an alias for a tuple (Jesse Rosenthal).
- Support custom properties (#3024, #5252, Agustín Martín Barbero).
Also supports additional core properties:
-
ICML writer (Mauro Bieg):
- Support custom-styles (#5137, see #2106).
- Support unnumbered headers (#5140).
-
Texinfo writer: Use header identifier for anchor if present (#4731). Previously we were overwriting an existing identifier with a new one.
-
Org writer: Preserve line-numbering for example and code blocks (Brian Leung).
-
Man/Ms writers: Don’t escape
-as\-. The\-gets rendered in HTML and PDF as a unicode minus sign. -
Ms writer: Ensure we have a newline after .EN in display math (#5251).
-
RST writer: Don’t wrap simple table header lines (#5128).
-
Asciidoc writer: Shorter delimiters for tables, blockquotes (#4364). This matches asciidoctor reference docs.
-
Dokuwiki writer: Remove automatic
:prefix before internal image links (#5183, Damien Clochard). This prevented users from making relative image links. -
Zimwiki writer: remove automatic colon prefix before internal images (#5183, Damien Clochard).
-
MediaWiki writer: fix caption, use ‘thumb’ instead of ‘frame’ (#5105). Captions used to have the word ‘caption’ prepended; this has been removed. Also, ‘thumb’ is used instead of ‘frame’ to allow images to be resized.
-
reveal.js writer:
- Ensure that we don’t get > 2 levels of section nesting, even with slide level > 2 (#5168).
- If slide level == N but there is no N-level header, make sure the next header with level > N gets treated as a slide and put in a section, rather than remaining loose (#5168).
-
Markdown writer:
- Make
plainRawBlocks pass through inplainoutput. - Include needed whitespace after HTML figure (#5121). We use HTML for a figure in markdown dialects that can’t represent it natively.
- Make
-
Commonmark writer:
- Fix handling of SoftBreak with
hard_line_breaks(#5195). - Implement
--toc(writerTableOfContents) in commonmark/gfm writers (#5172).
- Fix handling of SoftBreak with
-
EPUB writer:
- Ensure that picture transforms are done on metadata too.
- Small fixes to
nav.xhtml: Add ‘landmarks’ id attribute to the landmarks nav. Replace old default CSS removing numbers from ol.toc li with new rules that matchnav#toc ol, nav#landmarks ol. We keep thetocclass onolfor backwards compatibility.
-
LaTeX writer:
- Make raw content marked
beamerpass through inbeameroutput (pandoc/lua-filters#40). - Beamer: avoid duplicated
fragileproperty in some cases (#5208). - Add
#special characters for listings (#4939). This character needs special handling in\lstinline.
- Make raw content marked
-
RTF writer: use
toTableOfContentsfrom Shared to replace old duplicated code. -
Pptx writer:
- Support custom properties. Also supports additional core
properties:
subject,category,description(#5252, Agustín Martín Barbero). - Use
toTableOfContentsfrom Shared to replace old duplicated code.
- Support custom properties. Also supports additional core
properties:
-
ODT writer (Augustín Martín Barbero):
- Fix typo in custom properties (#2839).
- Improve standard properties, including the following core
properties:
generator(Pandoc/VERSION),description,subject,keywords,initial-creator(from authors),creation-date(actual creation date) (#5252).
-
Custom writers:
- Allow ‘-’ in filenames for custom lua writers (#5187).
- sample.lua: add
SingleQuoted,DoubleQuoted(#5104). - sample.lua: Add a missing
>(MichaWiedenmann).
-
reveal.js template: Add
zoomKeyconfig (#4249). -
HTML5 template: Remove unnecessary type=“text/css” on style and link for HTML5 (#5146).
-
LaTeX template (Andrew Dunning, except where noted):
- Prevent fontspec from scaling
mainfontto match the default font, Latin Modern. A main font set to 12pt could previously appear between 11pt to 13pt depending on its design. To return to the earlier rendering, use-V mainfontoptions="Scale=MatchLowercase"(#5212, #5218). - Display monospaced fonts without TeX ligatures when using
--pdf-engine=lualatex. It now matches the behaviour of other engines (#5212, #5218). - Remove the deprecated
romanfontvariable. The functionality ofmainfontis identical (#5218). - Render
\subtitlewith the standard document classes. Previously,subtitleonly appeared when using the KOMA-Script classes or Beamer (#5213, #5244). - Use Babel instead of Polyglossia for LuaLaTeX. This avoids several language selection problems, notably with retaining French spacing conventions when switching to a verbatim environment or another language; and in printing Greek text without hyphenation (#5193).
- Use the
xurlpackage if available, improving the appearance of URLs by allowing them to break at additional points (#5193). - Use
bookmarkif available to correct heading levels in PDF bookmarks: see the KOMA-Script 3.26 release notes (#5193). - Require the
xcolorpackage to avoid a possible error when using additional packages alongside footnotes in tables (#5193, closes #4861). - Remove obsolete
fixltx2epackage, which has no functionality with TeX Live 2015 or later (#5193). - Allow multiple
fontfamilies.options(#5193, closes #5194). - Restrict
institutevariable to Beamer (#5219). - Use
footnotehyperpackage if available to make footnotes in tables compatible withhyperref(#5234). - Number parts and chapters in book classes only if the
numbersectionsvariable is set, for consistency with other output formats. To return to the previous behaviour, use-V numbersections -V secnumdepth=0(#5235). - Reindent file (#5193).
- Use built-in parskip handling with KOMA-Script classes (#5143, Enno).
- Set default listings language for lua, assembler (#5227, John
MacFarlane). Otherwise we get an error when trying to compile code
with lua or assembler code. To change the default dialect
(currently 5.3 for lua and x86masm for assembler), you can use
--include-in-headerto inject something like\lstset{defaultdialect=[5.2]Lua}.
- Prevent fontspec from scaling
-
Text.Pandoc.Readers: Changed types of
readJSON; it now runs in an instance of PandocMonad, like the other readers and writers. [API change] -
Text.Pandoc.Writers: Changed types of
writeJSON; it now runs in an instance of PandocMonad, like the other readers and writers. [API change] -
Text.Pandoc.Error: Added
PandocUTF8DecodingErrorconstructor forPandocError. [API change] -
Text.Pandoc.Writers.Shared - add
toTableOfContents. [API change] This is refactored out from the Markdown writer. It can be used in other writers to create a table of contents. -
Improve error messages for UTF-8 decoding errors. Now we give the filename and byte offset (#4765).
-
Text.Pandoc.XML: Strip out illegal XML characters in
escapeXMLString(#5119). -
Text.Pandoc.Process: update
pipeProcess(Albert Krewinkel). The implementation ofpipeProcesswas rewritten to fix sporadic failures caused by prematurely closed pipes. -
Use
safeReadinstead ofreadeverywhere in the code (John MacFarlane, Mauro Bieg, #5162, #5180). -
Text.Pandoc.SelfContained: Decompress
.svgzwhen converting todata:URI (#5163, Alexander Krotov). -
Text.Pandoc.Parsing: Remove unused
HasHeaderMap(#5175, Alexander Krotov). [API change] -
Normalize Windows paths to account for change in ghc 8.6 (#5127). When pandoc is compiled with ghc 8.6, Windows paths are treated differently, and paths beginning
\\serverno longer work. This commit rewrites such patsh to\\?\UNC\serverwhich works. The change operates at the level of argument parsing, so it only affects the command line program. -
Simplify/fix reading of
--metadatavalues on command line to avoid problems relating to hvr/HsYAML#7 (#5177). -
data/pandoc.lua: auto-fix nested constructor arguments (Albert Krewinkel). Incorrect types to pandoc element constructors are automatically converted to the correct types when possible. This was already done for most constructors, but conversions are now also done for nested types (like lists of lists).
-
Removed custom Setup.hs, use build-type: simple. The only thing we gained from the custom build was automatic installation of the man page when using ‘cabal install’. But custom builds cause problems, e.g., with cross-compilation. Installation of the man page is better handled by packagers. Note to packagers (e.g. Debian): it may be necessary to add a step installing the man page with the next release.
-
Allow latest http-client, tasty, zip-archive, Glob.
-
Require skylighting >= 0.7.5, adding support for sml, J, typescript.
-
Tests: Cleaned up
findPandocinTests.Helpers, so it works well with cabal v2. -
INSTALL.md:
- Use button for installer links (John MacFarlane, Mauro Bieg, #5167).
- Fix links and bump required stack version (max).
- Improve installation notes on associated software (Andrew
Dunning). Includes explanation of how to install related tools
with package managers (since the method of installing
rsvg-convertis not obvious).
-
doc/org.md: improve documentation of org features (Albert Krewinkel).
-
doc/lua-filters.md: use 3rd level headers for module fields.
-
MANUAL:
- Clarify automatic identifiers (#5201). We remove non-alphanumerics. This includes, e.g., emojis.
- Fix example for Div with id (Geoffrey Ely).
- Update list of LaTeX packages used.
- Make it clear that
hard_line_breaksworks ingfm(see #5195). - Mention
raw_attributein documentation forraw_htmlandraw_tex(#5240, thanks to @eiro). - Clarify that
$sep$must come right before$endfor$in templates (#5243, Lev Givon). - Document metadata support for docx, odt, pptx writers (Agustín Martín Barbero).
- Reorganize template variables (#5249, Andrew Dunning). Add additional headings to categorize variables, and alphabetize when there is large number; add more examples.
- Document
date-metatemplate variable (#5260, Tristan Stenner).
-
trypandoc: Fix CSS and viewport.
-
Text.Pandoc.App: split into several unexported submodules (Albert Krewinkel): Text.Pandoc.App.FormatHeuristics, Text.Pandoc.App.Opt, Text.Pandoc.App.CommandLineOptions, Text.Pandoc.App.OutputSettings. This is motivated partly by the desire to reduce recompilations when something is modified, since App previously depended on virtually every other module.
-
Text.Pandoc.Extensions
- Semantically,
gfm_auto_identifiersis now a modifier ofauto_identifiers; for identifiers to be set,auto_identifiersmust be turned on, and then the type of identifier produced depends ongfm_auto_identifiersandascii_identifiersare set. Accordingly,auto_identifiersis now added togithubMarkdownExtensions(#5057). - Remove
ascii_identifiersfromgithubMarkdownExtensions. GitHub doesn’t seem to strip non-ascii characters any more.
- Semantically,
-
Text.Pandoc.Lua.Module.Utils (Albert Krewinkel)
- Test AST object equality via Haskell (#5092). Equality of Lua
objects representing pandoc AST elements is tested by unmarshalling
the objects and comparing the result in Haskell.
A new function
equalswhich performs this test has been added to thepandoc.utilsmodule. - Improve stringify. Meta value strings (MetaString) and booleans (MetaBool) are now converted to the literal string and the lowercase boolean name, respectively. Previously, all values of these types were converted to the empty string.
- Test AST object equality via Haskell (#5092). Equality of Lua
objects representing pandoc AST elements is tested by unmarshalling
the objects and comparing the result in Haskell.
A new function
-
Text.Pandoc.Parsing: Remove Functor and Applicative constraints where Monad already exists (Alexander Krotov).
-
Text.Pandoc.Pretty: Don’t render BreakingSpace at end of line or beginning of line (#5050).
-
Text.Pandoc.Readers.Markdown
- Fix parsing of citations, quotes, and underline emphasis after symbols. Starting with pandoc 2.4, citations, quoted inlines, and underline emphasis were no longer recognized after certain symbols, like parentheses (#5099, #5053).
- In pandoc 2.4, a soft break after an abbreviation would be relocated before it to allow for insertion of a nonbreaking space after the abbreviation. This behavior is here reverted. A soft break after an abbreviation will remain, and no nonbreaking space will be added. Those who care about this issue should take care not to end lines with an abbreviation, or to insert nonbreaking spaces manually.
-
Text.Pandoc.Readers.FB2: Do not throw error for unknown elements in
<body>(Alexander Krotov). Some libraries include custom elements in their FB2 files. -
Text.Pandoc.Readers.HTML
- Allow
tfootbefore body rows (#5079). - Parse
<small>as a Span with class “small” (#5080). - Allow thead containing a row with
tdrather thanth(#5014).
- Allow
-
Text.Pandoc.Readers.LaTeX
- Cleaned up handling of dimension arguments. Allow decimal points, preceding space.
- Don’t allow arguments for verbatim, etc.
- Allow space before bracketed options.
- Allow optional arguments after
\\in tables. - Improve parsing of
\tiny,\scriptsize, etc. Parse as raw, but know that these font changing commands take no arguments.
-
Text.Pandoc.Readers.Muse
- Trim whitespace before parsing grid table cells (Alexander Krotov).
- Add grid tables support (Alexander Krotov).
-
Text.Pandoc.Shared
- For bibliography match Div with id
refs, not classreferences. This was a mismatch between pandoc’s docx, epub, latex, and markdown writers and the behavior of pandoc-citeproc, which actually looks for a div with idrefsrather than one with classreferences. - Exactly match GitHub’s identifier generating algorithm (#5057).
- Add parameter for
ExtensionstouniqueIdentandinlineListToIdentifier(#5057). [API change] This allows these functions to be sensitive to the settings ofExt_gfm_auto_identifiersandExt_ascii_identifiers, and allows us to useuniqueIdentin the CommonMark reader, replacing custom code. It also means thatgfm_auto_identifierscan now be used in all formats.
- For bibliography match Div with id
-
Text.Pandoc.Writers.AsciiDoc
- Use
.+ as list markers to support nested ordered lists (#5087). - Support list number styles (#5089).
- Render Spans using
[#id .class]#contents#(#5080).
- Use
-
Text.Pandoc.Writers.CommonMark
- Respect
--ascii(#5043, quasicomputational). - Make sure
--asciiaffects quotes, super/subscript.
- Respect
-
Text.Pandoc.Writers.Docx
- Fix bookmarks to headers with long titles (#5091). Word has a 40 character limit for bookmark names. In addition, bookmarks must begin with a letter. Since pandoc’s auto-generated identifiers may not respect these constraints, some internal links did not work. With this change, pandoc uses a bookmark name based on the SHA1 hash of the identifier when the identifier isn’t a legal bookmark name.
- Add bookmarks to code blocks (Nikolay Yakimov).
- Add bookmarks to images (Nikolay Yakimov).
- Refactor common bookmark creation code into a function (Nikolay Yakimov).
-
Text.Pandoc.Writers.EPUB: Handle calibre metadata (#5098). Nodes of the form
<meta name="calibre:series" content="Classics on War and Politics"/>are now included from an epub XML metadata file. You can also include this information in your YAML metadata, like so:
calibre: series: Classics on War and PoliciticsIn addition, ibooks-specific metadata can now be included via an XML file. (Previously, it could only be included via YAML metadata, see #2693.)
-
Text.Pandoc.Writers.HTML: Use plain
"instead of"outside of attributes. -
Text.Pandoc.Writers.ICML: Consolidate adjacent strings, inc. spaces. This avoids splitting up the output unnecessarily into separate elements.
-
Text.Pandoc.Writers.LaTeX: Don’t emit
[<+->]unless beamer output, even ifwriterIncrementalis True (#5072). -
Text.Pandoc.Writers.Muse (Alexander Krotov).
- Output tables as grid tables if they have multi-line cells.
- Indent simple tables only on the top level.
- Output tables with one column as grid tables.
- Add support for
--reference-location. - Internal improvements.
-
Text.Pandoc.Writers.OpenDocument: Fix list indentation (Nils Carlson, #5095). This was a regression in pandoc 2.4.
-
Text.Pandoc.Writers.RTF: Fix warnings for skipped raw inlines.
-
Text.Pandoc.Writers.Texinfo: Add blank line before
@menusection (#5055). -
Text.Pandoc.XML: in
toHtml5Entities, prefer shorter entities when there are several choices for a particular character. -
data/abbreviations
- Add additional abbreviations (Andrew Dunning) Many of these borrowed from the Chicago Manual of Style 10.42, ‘Scholarly abbreviations’.
-
Templates
- Asciidoc template: add :lang: to title header is lang is set in metadata (#5088).
-
pandoc.cabal: Add cabal flag
derive_json_via_th(Albert Krewinkel) Disabling the flag will cause derivation of ToJSON and FromJSON instances via GHC Generics instead of Template Haskell. The flag is enabled by default, as deriving via Generics can be slow (see #4083). -
trypandoc:
- Tweaked drop-down lists.
- Put link to site in footer.
- Preselect output format.
- Update on change of in or out format.
- Add man input format.
-
MANUAL.txt:
- Fix outdated description of latex_macros extension.
- Clarified placement of bibliography.
- Added “A note on security.”
- Fix note on curly brace syntx for locators.
- Document new explicit syntax for citeproc locators.
- Remove confusing cross-links for some extensions.
- Don’t put pandoc in code ticks in heading.
- Document that
--asciiworks for gfm and commonmark too. - Add
manto--fromoptions.
-
doc/customizing-pandoc.md: various improvements (Mauro Bieg).
-
--asciiis now implemented in the writers, not in Text.Pandoc.App, via the newwriterPreferAsciifield inWriterOptions. Now thewrite*functions for Docbook, HTML, ICML, JATS, LaTeX, Ms, Markdown, and OPML are sensitive towriterPreferAscii. Previously the to-ascii translation was done in Text.Pandoc.App, and thus not available to those using the writer functions directly. -
--asciinow works with Markdown output. HTML5 character reference entities are used. -
--asciinow works with LaTeX output. 100% ASCII output can’t be guaranteed, but the writer will use commands like\"{a}and\lwhenever possible, to avoid emitting a non-ASCII character. -
For HTML5 output,
--asciinow uses HTML5 character reference entities rather than numerical entities. -
Improved detection of format based on extension (in Text.Pandoc.App). We now ensure that if someone tries to convert a file for a format that has a pandoc writer but not a reader, it won’t just default to markdown.
-
Add viz. to abbreviations file (#5007, Nick Fleisher).
-
AsciiDoc writer: always use single-line section headers, instead of the old underline style (#5038). Previously the single-line style would be used if
--atx-headerswas specified, but now it is always used. -
RST writer: Use simple tables when possible (#4750).
-
CommonMark (and gfm) writer: Add plain text fallbacks. (#4528, quasicomputational). Previously, the writer would unconditionally emit HTML output for subscripts, superscripts, strikeouts (if the strikeout extension is disabled) and small caps, even with
raw_htmldisabled. Now there are plain-text (and, where possible, fancy Unicode) fallbacks for all of these corresponding (mostly) to the Markdown fallbacks, and the HTML output is only used whenraw_htmlis enabled. -
Powerpoint writer: support raw openxml (Jesse Rosenthal, #4976). This allows raw openxml blocks and inlines to be used in the pptx writer. Caveats: (1) It’s up to the user to write well-formed openxml. The chances for corruption, especially with such a brittle format as pptx, is high. (2) Because of the tricky way that blocks map onto shapes, if you are using a raw block, it should be the only block on a slide (otherwise other text might end up overlapping it). (3) The pptx ooxml namespace abbreviations are different from the docx ooxml namespaces. Again, it’s up to the user to get it right. Unzipped document and ooxml specification should be consulted.
-
With
--katexin HTML formats, do not use the autorenderer (#4946). We no longer surround formulas with\(..\)or\[..\]. Instead, we tell katex to convert the contents of span elements with class “math”. Since math has already been identified, this avoids wasted time parsing for LaTeX delimiters. Note, however, that this may yield unexpected results if you have span elements with class “math” that don’t contain LaTeX math. Also, use latest version of KaTeX by default (0.9.0). -
The man writer now produces ASCII-only output, using groff escapes, for portability.
-
ODT writer:
- Add title, author and date to metadata; any remaining
metadata fields are added as
meta:user-definedtags. - Implement table caption numbering (#4949, Nils Carlson).
Captioned tables are numbered and labeled with format “Table 1:
caption”, where “Table” is replaced by a translation, depending
on the value of
langin metadata. Uncaptioned tables are not enumerated. - OpenDocument writer: Implement figure numbering in captions (#4944,
Nils Carlson). Figure captions are now numbered 1, 2, 3, …
The format in the caption is “Figure 1: caption” and so on
(where “Figure” is replaced by a translation, depending on the
value of
langin the metadata). Captioned figures are numbered consecutively and uncaptioned figures are not enumerated. This is necessary in order for LibreOffice to generate an Illustration Index (Table of Figures) for included figures.
- Add title, author and date to metadata; any remaining
metadata fields are added as
-
RST reader: Pass through fields in unknown directives as div attributes (#4715). Support
classandnameattributes for all directives. -
Org reader: Add partial support for
#+EXCLUDE_TAGSoption. (#4284, Brian Leung). Headers with the corresponding tags should not appear in the output. -
Log warnings about missing title attributes now include a suggestion about how to fix the problem (#4909).
-
Lua filter changes (Albert Krewinkel):
-
Report traceback when an error occurs. A proper Lua traceback is added if either loading of a file or execution of a filter function fails. This should be of help to authors of Lua filters who need to debug their code.
-
Allow access to pandoc state (#5015). Lua filters and custom writers now have read-only access to most fields of pandoc’s internal state via the global variable
PANDOC_STATE. -
Push ListAttributes via constructor (Albert Krewinkel). This ensures that ListAttributes, as present in OrderedList elements, have additional accessors (viz.
start,style, anddelimiter). -
Rename ReaderOptions fields, use snake_case. Snake case is used in most variable names, using camelCase for these fields was an oversight. A metatable is added to ensure that the old field names remain functional.
-
Iterate over AST element fields when using
pairs. This makes it possible to iterate over all ield names of an AST element by using a genericforloop with pairs`:for field_name, field_content in pairs(element) do ... endRaw table fields of AST elements should be considered an implementation detail and might change in the future. Accessing element properties should always happen through the fields listed in the Lua filter docs.
Note that the iterator currently excludes the
t/tagfield. -
Ensure that MetaList elements behave like Lists. Methods usable on Lists can also be used on MetaList objects.
-
Fix MetaList constructor (Albert Krewinkel). Passing a MetaList object to the constructor
pandoc.MetaListnow returns the passed list as a MetaList. This is consistent with the constructor behavior when passed an (untagged) list.
-
-
Custom writers: Custom writers have access to the global variable
PANDOC_DOCUMENT(Albert Krewinkel, #4957). The variable contains a userdata wrapper around the full pandoc AST and exposes two fields,metaandblocks. The field content is only marshaled on-demand, performance of scripts not accessing the fields remains unaffected.
-
Text.Pandoc.Parsing
- Make
uriaccept any stream with Char tokens (Alexander Krotov). - Rewrite
uriwithoutwithRaw(Alexander Krotov). - Generalize
parseFromStringandparseFromString'to any streams with Char token (Alexander Krotov) - Rewrite
nonspaceCharusingnoneOf(Alexander Krotov)
- Make
-
Text.Pandoc.Shared: Reimplement
mapLeftusingBifunctor.first(Alexander Krotov). -
Text.Pandoc.Pretty: Simplify
Text.Pandoc.Pretty.offset(Alexander Krotov). -
Text.Pandoc.App
- Work around HXT limitation for –syntax-definition with windows drive (#4836).
- Always preserve tabs for man format. We need it for tables.
- Split command line parsing code into a separate unexported module, Text.Pandoc.App.CommandLineOptions (Albert Krewinkel).
-
Text.Pandoc.Readers.Roff: new unexported module for tokenizing roff documents.
-
New unexported module Text.Pandoc.RoffChar, provided character escape tables for roff formats.
-
Text.Pandoc.Readers.HTML: Fix
htmlTagandisInlineTagto accept processing instructions (#3123, regression since 2.0). -
Text.Pandoc.Readers.JATS: Use
foldl'instead ofmaximumto account for empty lists (Alexander Krotov). -
Text.Pandoc.Readers.RST: Don’t allow single-dash separator in headerless table (#4382).
-
Text.Pandoc.Readers.Org: Parse empty argument array in inline src blocks (Brian Leung).
-
Text.Pandoc.Readers.Vimwiki:
- Get rid of
F,runFandstateMeta'in favor ofstateMeta(Alexander Krotov). - Parse
Textwithout converting to[Char](Alexander Krotov).
- Get rid of
-
Text.Pandoc.Readers.Creole: Parse
Textwithout converting to[Char](Alexander Krotov). -
Text.Pandoc.Readers.LaTeX
-
Text.Pandoc.Readers.Markdown
- Fix awkward soft break movements before abbreviations (#4635).
- Add updateStrPos in a couple places where needed.
-
Text.Pandoc.Readers.Docx: Trigger bold/italic with bCs, iCs (#4947). These are variants for “complex scripts” like Arabic and are now treated just like b, i (bold, italic).
-
Text.Pandoc.Readers.Muse (Alexander Krotov)
- Try to parse lists before trying to parse table. This ensures that tables inside lists are parsed correctly.
- Forbid whitespace after opening and before closing markup elements.
- Parse page breaks.
- Simplify
museToPandocTableto get rid of partial functions. - Allow footnotes to start with empty line.
- Make sure that the whole text is parsed.
- Allow empty headers. Previously empty headers caused parser to terminate without parsing the rest of the document.
- Allow examples to be indented with tabs.
- Remove indentation from examples indicated by
{{{and}}}. - Fix parsing of empty cells.
- Various changes to internals.
- Rewrite some parsers in applicative style.
- Avoid tagsoup dependency.
- Allow table caption to contain
+.
-
Text.Pandoc.Writers.LaTeX
- Add newline if math ends in a comment (#4880). This prevents the closing delimiter from being swalled up in the comment.
- With
--listings, don’t pass through org-babel attributes (#4889). - With
--biblatex, use\autocitewhen possible (#4960).\autocites{a1}{a2}{a3}will not collapse the entries. So, if we don’t have prefixes and suffixes, we use instead\autocite{a1,a2,a3}. - Fix description lists contining highlighted code (#4662).
-
Text.Pandoc.Writers.Man
- Don’t wrap
.SHand.SSlines (#5019). - Avoid unnecessary
.RS/.REpair in definition lists with one paragraph definitions. - Moved common groff functions to Text.Pandoc.Writers.Groff.
- Fix strong/code combination on man (should be
\f[CB]not\f[BC], see #4973).
- Man writer: use
\f[R]instead of\f[]to reset font (Alexander Krotov, #4973). - Move
splitSentencesto Text.Pandoc.Shared.
- Don’t wrap
-
Text.Pandoc.Writers.Docx
-
Add framework for custom properties (#3034). So far, we don’t actually write any custom properties, but we have the infrastructure to add this.
-
Handle tables in table cells (#4953). Although this is not documented in the spec, some versions of Word require a
w:pelement inside every table cell. Thus, we add one when the contents of a cell do not already include one (e.g. when a table cell contains a table).
-
-
Text.Pandoc.Writers.AsciiDoc: Prevent illegal nestings. Adjust header levels so that n+1 level headers are only found under n level headers, and the top level is 1.
-
Text.Pandoc.Writers.OpenDocument: Improve bullet/numbering alignment (#4385). This change eliminates the large gap we used to have between bullet and text, and also ensures that numbers in numbered lists will be right-aligned.
-
Text.Pandoc.Writers.ZimWiki
- Number ordered list items sequentially, rather than always with 1 (#4962).
- Remove extra indentation on lists (#4963).
-
Text.Pandoc.Writers.EPUB: Use metadata field
cssinstead ofstylesheet(Mauro Bieg, #4990). -
Text.Pandoc.Writers.Markdown: Ensure blank between raw block and normal content (#4629). Otherwise a raw block can prevent a paragraph from being recognized as such.
-
Text.Pandoc.Writers.Ms
- Removed old
escapeBar. We don’t need this now that we use@for math delim. - Moved common code to Text.Pandoc.Writers.Roff and to Text.Pandoc.RoffChar.
- Move
splitSentencesto Text.Pandoc.Shared (to avoid duplication with the man writer).
- Removed old
-
Text.Pandoc.Writers.Muse (Alexander Krotov).
-
Add
--metadata-fileoption (Mauro Bieg, #1960), which allows users to specify metadata in a YAML file, regardless of the input format (#1960). -
Text.Pandoc.Writers.Shared: export
isDisplayMath(API change). -
Text.Pandoc.Readers.Markdown: export
yamlToMeta(API change, Mauro Bieg). -
Text.Pandoc.Readers.LaTeX.Types:
- New type
ArgSpec(API change). - Second parameter of
Macroconstructor is now[ArgSpec]instead ofInt(API change).
- New type
-
Markdown reader:
- Use
texinstead oflatexfor raw tex-ish content. We can’t always tell if it’s LaTeX, ConTeXt, or plain TeX. Better just to usetexalways. Note that ifcontextorlatexspecifically is desired, you can still force that in a markdown document by using the raw attribute. Note that this change may affect some filters, if they assume that raw tex parsed by the Markdown reader will be RawBlock (Formatlatex). In most cases it should be trivial to modify the filters to accepttexas well. - Refactor and reorganize YAML code (Mauro Bieg).
- Make
example_listswork for interrupted lists withoutstartnum(#4908).
- Use
-
HTML reader:
- Parse
<script type="math/textags as math (#4877). These are used by MathJax in some configurations. - Extract spaces inside links instead of trimming them (Alexander Krotov, #4845).
- Added round-trip tests (Alexander Krotov).
- Make parsing sensitive to the
raw_texextension (#1126). This now allows raw LaTeX environments,\ref, and\eqrefto be parsed (which is helpful for translation HTML documents using MathJaX).
- Parse
-
Org reader (Albert Krewinkel):
- Respect export option
pfor planning info. Inclusion of planning info (*DEADLINE*,*SCHEDULED*, and*CLOSED*) can be controlled via thepexport option: setting the option totwill add all planning information in a Plain block below the respective headline. - Org reader internals: don’t rely on RecordWildCards and ViewPatterns ghc extensions.
- Strip planning info from output. Planning info is parsed, but not included in the output (as is the default with Emacs Org-mode, #4867).
- Respect export option
-
LaTeX reader:
- Handle parameter patterns for
\def(#4768, #4771). For example:\def\foo#1[#2]{#1 and #2}. - Allow
%characters in URLs. This affects\hrefand\url(#4832). - Fixed parsing of
\texorpdfstring. We were returning the wrong argument as the content. - Support
blockcquote,foreignblockquote,foreigncblockquote,hyphenblockquote,hyphencblockquote,enquote*,foreignquote,hyphenquotefromcsquotes(#4848). Note thatforeignquotewill be parsed as a regular Quoted inline (not using the quotes appropriate to the foreign language). - Support more text-mode accents (#4652). Add support for
\|,\b,\G,\h,\d,\f,\r,\t,\U,\i,\j,\newtie,\textcircled. Also fall back to combining characters when composed characters are not available. - Resolve
\reffor figure numbers. - Support
mintinline(#4365, Marc Schreiber). - Fix siunitx unit commands so they are only recognized in
siunitx contexts (#4842). For example,
\loutside of an siunitx context should be l-slash, not l (for liter). - Fix double
unnumberedclass (#4838). Theunnumberedclass was being included twice for starred sections.
- Handle parameter patterns for
-
RST reader: Don’t skip link definitions after comments (#4860).
-
Muse reader (Alexander Krotov):
- Close the
</quote>in indented tag test. There is already a separate test for unclosed</quote>. - Autonumber sections in the correct order. Parsing now stops at each section header to ensure the header is registered before parsing of the next section starts.
- Move duplicate code into
headingStartfunction. - Allow newline after opening
*or**. - Don’t allow digits after closing marker in lightweight markup This change makes reader more compatible with Emacs Muse.
- Parse
<verse>tag in one pass instead of usingparseFromString. This change makes it possible to have verbatim</verse>tag inside verse.
- Close the
-
ODT reader: deal gracefully with missing
<office:font-face-decls/>(#4336). This allows pandoc to parse ODT document produced by KDE’s Calligra. -
Muse writer (Alexander Krotov):
- Output headers without asterisks if not on the top level.
- Never wrap definition list terms.
- Set
envInsideBlock = Truewhen rendering notes. - Use
""instead of[]for empty String. - Check for whitespace in the beginning and end of Str’s.
- Escape
-,;and>in the beginning of strings. - Escape list markers in the beginning of notes.
- Normalize inline list before testing if tags should be used.
- Use tags instead of lightweight markup for empty strings.
- Use lightweight markup when possible.
- Escape empty strings. This guarantees that
conditionalEscapeStringnever returns empty string. - Wrap conditionalEscapeString result into
Musetype. This removes the need to passenvInsideLinkDescriptionto it. - Separate
shouldEscapeStringfunction. - Simplify inline list rendering.
- Replace newlines in strings with spaces.
-
Docx writer:
- Add MetaString case for abstract, subtitle (#4900, Mauro Bieg).
- Properly handle display math in spans (#4826). This isn’t a complete solution, since other nestings of display math may still cause problems, but it should work for what is by far the most common case.
-
HTML writer:
- Always output
<dt>element, even if it is empty (#4883, Alexander Krotov). - Don’t prefix
epub:attributes withdata-.
- Always output
-
Org writer: Don’t escape literal
_,^(#4882). Org doesn’t recognize these escapes. -
ODT writer: Fix percentage image scaling (#4881, Nils Carlson). Image scaling was broken when a width was set to a percentage.
-
EPUB writer: set
epub:typeon body element in each chapter, depending on theepub:typeof the first section (#4823). This only affects epub3. See http://www.idpf.org/epub/profiles/edu/structure/#h.l0bzsloklt10 -
FB2 writer: put
coverpageelement between title and date rather than indocument-infoelement (#4854). -
Markdown writer: Escape
~if strikeout extension enabled (#4840). -
Haddock writer: Use proper format for latex math in haddock (#4571, Joe Hermaszewski). Inline math in
\(..\), display math in\[..\], tex is now used. Previously we’d “fake it with unicode” and fall back to tex when that didn’t work. But newer haddock versions support latex math. -
TEI writer:
- Ensure that title element is always present, even if empty (#4839).
- Put author tags in the template, rather than adding them in the writer (#4839).
-
LaTeX writer/template: be sensitive to
filecolorvariable (#4822).linkcoloronly affects internal links, andurlcoloronly affects linked URLs. For external links, the option to use isfilecolor. -
ConTeXt writer: output raw
texblocks as well ascontext(#969). -
RST writer:
- Use
.. raw:: latexfortexcontent. - Use
.. containerfor generic Divs, instead of raw HTML. - Render Divs with admonition classes as admonitions (#4833).
Also omit Div with class
admonition-title. These are generated by the RST reader and should be omitted on round-trip.
- Use
-
Text.Pandoc.PDF: fix message printed when rsvg-convert is not available (#4855, Antonio Terceiro).
-
HTML5 template: add the
title-block-headeridentifier to theheaderelement, to make it easier to style precisely (#4767, J. B. Rainsberger). -
OpenDocument template: Remove unnecessary indenting of TOC title (#4798, José de Mattos Neto).
-
latex template: Add support for $toc-title$ to LaTeX (and PDF) (#4853, Wandmalfarbe).
-
TEI template: improve
publicationStmt. Add support forpublisher,address,pubPlace, anddatevariables. -
beamer template: Support “toc-title” (#4835, Cyril Roelandt).
-
Text.Pandoc.Extensions: Fix haddock on
Ext_footnotes(Chris Martin). -
Lua: cleanup Lua utils, remove unused functions (Albert Krewinkel).
-
MANUAL.txt:
- Clarify that
--biblatex/--natbibdon’t work directly for PDF (#4904). - Document
epub:typeattribute (Mauro Bieg, #4901) - Clarify when
--resource-pathhas an effect. - More detail on customization in syntax highlighting section.
- Document encoding issue with
--listings(#4871, Damien Clochard). - Remove docs on removed
--katex-stylesheet(Mauro Bieg, #4862). - Use https for context wiki links (#4910).
- Clarify that
-
CONTRIBUTING.md:
- Link to lua-filters repository (#4874).
- Fix mistake in REPL instructions for stack. (#4849, Brian Leung).
-
lua-filters.md: add links to filters, and to lua-filters repository (#4874).
-
INSTALL.md:
- Indicate that cabal >= 2.0 is needed.
- Added chocolatey installation method (#4844, Miodrag Milić).
-
Travis: exclude round-trip tests, except for nightly test which can fail.
-
Use latest texmath, pandoc-citeproc.
-
Use a patched version of foundation until https://github.com/haskell-foundation/foundation/pull/503 is fixed.
-
Clean up appveyor build and Windows package creation. We now use 64-bit stack and ghc 8.4.3, lts-12 for the 64-bit build. The WiX-based msi is now 64-bit for 64-bit builds (fixing #4795).
-
Remove obsolete RELEASE-CHECKLIST.md.
-
Added additional compiler warnings in Makefile and CI builds.
-
Use HsYAML instead of yaml for translations and YAML metadata (#4747). yaml wraps a C library; HsYAML is pure Haskell. Advances #4535.
Note: HsYAML implements YAML 1.2, in which the valid true values are
true,True,TRUE. This means a change in the semantics of YAML metadata that could affect users:y,yes, andonno longer count as true values. -
Fix regression: make
--pdf-enginework with full paths (#4681, Mauro Bieg). -
CommonMark reader: Handle
ascii_identifiersextension (#4742, Anders Waldenborg). Non-ascii characters were not stripped from identifiers even if theascii_identifiersextension was enabled (which is is by default for gfm). -
TikiWiki reader: Improve list parsing (#4722, Mauro Bieg). Remove trailing Space from list items. Parse lists that have no space after marker.
-
LaTeX reader:
- Treat
lilypondas a verbatim environment (#4725). - Parse figure label into Image id (#4700, Mauro Bieg).
- Beamer: Allow “noframenumbering” option (#4696, Raymond Ehlers).
- Allow spaces around
\graphicspatharguments (#4698). - Handle includes without surrounding blanklines (#4553).
In addition,
\inputcan now be used in an inline context, e.g. to provide part of a paragraph, as it can in LaTeX. - In
rawLaTeXBlock, handle macros that resolve to a\beginor\end(#4667). - In
rawLaTeXBlock, don’t expand macros in macro definitions (#4653). Note that this only affected LaTeX in markdown. - Tighten up reading of beamer overlay specifications (#4669).
Ideally we’d turn these on only when reading beamer, but currently
beamer is not distinguished from latex as an input format.
This commit also activates parsing of overlay specifications
after commands in general (e.g.
\item), since they can occur in many contexts in beamer. - Parse more siunitx unit commands (#4296, #4773).
- Be more forgiving in key/value option parsing (#4761).
- Treat
-
Markdown reader:
- Allow empty code spans, e.g.
` `. - Emojis are now wrapped in Spans with class
emojiand attributedata-emoji(Anders Waldenborg, #4743). This allows the writer to handle them in a special way (e.g. using a special font, or just rendering the emoji name).
- Allow empty code spans, e.g.
-
Muse reader (Alexander Krotov, except where indicated):
- Get rid of non-exhaustive pattern match warning (Mauro Bieg).
- Add support for floating images.
- Add support for images with specified width.
- Parse image URLs without “guard” and “takeExtension”.
- Split link and image parsing into separate functions.
- Parse links starting with “URL:” explicitly instead of trying to strip “URL:” prefix after parsing.
-
Texinfo writer: Use
@supand@subinstead of custom macros (#4728, Alexander Krotov). -
Markdown writer: Preserve
implicit_figureswith attributes, even ifimplicit_attributesis not set, by rendering in raw HTML (#4677). -
Markdown and commonmark/github writers now respect the
emojiextension. So,-f markdown+emoji -t markdown+emojinow leaves:smile:as:smile:rather than converting it to a smile character. -
Docx writer: Be sensitive to
tocin YAML metadata (#4645). -
ODT/OpenDocument writer: Make internal links work (#4358). This adds proper bookmarks to the headers with non-null IDs.
-
EPUB writer: Properly escape pagetitle. Previously we weren’t escaping
&and other XML characters in the pagetitle, so a title containing a&would be invalid. -
AsciiDoc Writer: Eescape square brackets at start of line (#4545, Mauro Bieg).
-
RST writer:
- Don’t treat ‘example’ as a syntax name (#4748). This fixes conversions from org with example blocks.
- Support
--number-sectionsvia thesection-numberingdirective in standalone output.
-
reveal.js writer and template: reuse mathjax URL provided by the argument to
--mathjaxor the normal pandoc default, rather than a hard-coded one in the template (#4701). -
LaTeX writer:
- Properly handle footnotes in table captions (#4683). Refactored code from figure captions to use in both places.
- In beamer output, fix single digit column percentage (#4690, Mauro Bieg).
-
FB2 writer (Alexander Krotov):
- Convert Plain to Para in annotation (#2424).
- Fix order of items in title-info (#2424).
-
Custom writer: fix error message on script failure (Albert Krewinkel). Error messages produced by Lua were not displayed by Pandoc.
-
Text.Pandoc.Emoji now exports
emojiToInline, which returns a Span inline containing the emoji character and some attributes with metadata (classemoji, attributedata-emojiwith emoji name). (API change, Anders Waldenborg, #4743). -
Text.Pandoc.PDF:
- Revert fix for #4484 (only compress images on last run, #4755). This will mean some increase in the time it takes to produce an image-heavy PDF with xelatex, but it will make tables of contents correct, which is more important.
- Fix logic error in
runTeXProgram. We were running the tex program one more time than requested. This should speed up PDF production.
-
Allow
--templateto take a URL as argument. -
Text.Pandoc.Highlighting: Add missing re-export of
breezeDarkhighlighting style (#4687, Adrian Sieber, API change). -
Clarify macOS install in INSTALL.md (#4661). Make the binary package installer the recommended method, and note that on some older versions of macOS, homebrew installs from source and takes a lot of disk space (#4664, Ian).
-
MANUAL:
- Clarify EPUB linked media (#4756, Mauro Bieg)
- Update manual for “true” YAML values. Now that we’re using HsYAML and
YAML 1.2, the valid true values are
true,True,TRUE. NOTE!y,yes,onno longer count as true values. - Document
-Fas alias for--filter(thanks to Gandalf Saxe). - Update manual on how math is rendered in LaTeX.
- Add proxy description (#4131, Mauro Bieg).
- Clarify that
--tocrequires--standalone(#4703). - Update citation styles link (#4699, wiefling).
-
In API docs, clarify how
Ext_east_asian_line_breaksextension works (kaizshang91). Note that it will not take effect when readers/writers are called as libraries (#4674). -
Improved translations/fr (#4766, lux-lth).
-
Removed inadvertently added
.origfiles from repository (#4648). -
Remove
network-uriflag and use ‘Network.Socket’. This removes a compiler warning. There is no need for the oldnetwork-uriflag, since network 2.6 was released in 2014. -
Add stack.lts10.yaml, stack.lts11.yaml. use lts-12 in stack.yaml.
-
Bump upper bounds for dependent packages.
-
Exclude foundation 0.0.21 for ghc 7.10. Otherwise cabal gets confused because of the way ghc 7.10 is excluded in foundation’s cabal file. This can be removed when haskell-foundation/foundation#500 is fixed.
-
Require cabal-version >= 2.0. This is needed for haddock-library.
-
Restored and undeprecated gladtex for HTML math (#4607).
- Added
GladTeXconstructor toText.Pandoc.Options.HTMLMathMethod[API change, reverts removal in v2.2] - Restored and undeprecated
--gladtexoption, removed in v2.2.
- Added
-
LaTeX reader: Handle
$in/text{..}inside math (#4576). -
Org reader: Fix image filename recognition (Albert Krewinkel). Use a function from the filepath library to check whether a string is a valid file name. The custom validity checker that was used before gave wrong results (e.g. for absolute file paths on Windows, kawabata/ox-pandoc#52).
-
FB2 reader: Replace some errors with warnings (Alexander Krotov).
-
HTML writer:
- Strip links from headers when creating TOC (#4340). Otherwise the TOC entries will not link to the sections.
- Fix regression with tex math environments in HTML + MathJax (#4639).
-
Muse writer (Alexander Krotov): Add support for left-align and right-align classes (#4542).
-
Docx writer: Support underline (#4633).
-
Text.Pandoc.Parsing: Lookahead for non-whitespace after
singleQuoteStartanddoubleQuoteStart(#4637). -
test-pandoc-utils.lua: more robust testing on both windows and *nix. Previously the pipe tests were only run if\bin/falseand/bin/sedwere present, which they aren’t in default MacOS and Windows systems. Fixed by usingtrandfalse, which should always be in the path on a *nix system, andfindandechofor Windows. -
Text.Pandoc.Shared: add
uriPathToPath. This adjusts the path from a file: URI in a way that is sensitive to Windows/Linux differences. Thus, on Windows,/c:/foogets interpreted asc:/foo, but on Linux,/c:/foogets interpreted as/c:/foo. See #4613. -
Use
uriPathToPathwith file: URIs (#4613). -
Revert piping HTML to pdf-engine (Mauro Bieg, #4413). Use a temp file as before.
-
Text.Pandoc.Class: Catch IO errors when writing media files and issue a warning, rather than an error (Francesco Occhipinti, #4559).
-
Don’t lowercase custom writer filename (Alexander Krotov, #4610).
-
MANUAL (Mauro Bieg):
- Clarify truthiness in template variables (#2281).
- Clarify pipe table width calculation (#4520).
-
ConTeXt template: New Greek fallback typeface (Pablo Rodríguez, #4405). CMU Serif gives better typographic results than the previous Greek fallback DejaVu Serif.
-
Make HTML template polyglot (#4606, OvidiusCicero), by making
<link rel="stylesheet" href="$css$">self-closing. -
Use texmath 0.11, allowing better translation of non-ASCII characters in math (#4642).
-
New input format:
fb2(FictionBook2) (Alexander Krotov). -
Make
--asciiwork for all XML formats (ICML, OPML, JATS,…), and formsandman. -
Remove deprecated
--latexmathml,--gladtex,--mimetex,--jsmath,-m,--asciimathmloptions. -
New module Text.Pandoc.Readers.FB2, exporting readFB2 (Alexander Krotov, API change).
-
Markdown reader:
- Allow empty key-value attributes, like
title=""(#2944). - Handle table w/o following blank line in fenced div (#4560).
- Remove “fallback” for
doubleQuoteparser. Previously the parser tried to be efficient – if no end double quote was found, it would just return the contents. But this could backfire in a case**this should "be bold**, since the fallback would return the content"be bold**and the closing boldface delimiter would never be encountered. - Improve computation of the relative width of the last column in a multiline table, so we can round-trip tables without constantly shrinking the last column.
- Allow empty key-value attributes, like
-
EPUB reader:
- Fix images with space in file path (#4344).
-
LaTeX reader:
- Properly resolve section numbers with
\refand chapters (#4529). - Parse sloppypar environment (#4517, Marc Schreiber).
- Improve handling of raw LaTeX (for markdown etc.) (#4589, #4594). Previously there were some bugs in how macros were handled.
- Support
\MakeUppercase,\MakeLowercase,\uppercase,\lowercase, and also\MakeTextUppercaseand\MakeTextLowercasefrom textcase (#4959).
- Properly resolve section numbers with
-
Textile reader:
- Fixed tables with no body rows (#4513). Previously these raised an exception.
-
Mediawiki reader:
- Improve table parsing (#4508). This fixes detection of table
attributes and also handles
!characters in cells.
- Improve table parsing (#4508). This fixes detection of table
attributes and also handles
-
DocBook reader:
- Properly handle title in
sectionelement (#4526). Previously we just gotsection_titleforsection(thoughsect1,sect2, etc. were handled properly). - Read tex math as output by asciidoctor (#4569, Joe Hermaszewski).
- Properly handle title in
-
Docx reader:
- Combine adjacent CodeBlocks with the same attributes into a single CodeBlock. This prevents a multiline codeblock in Word from being read as different paragraphs.
-
RST reader:
- Allow < 3 spaces indent under directives (#4579).
- Fix anonymous redirects with backticks (#4598).
-
Muse reader (Alexander Krotov):
- Add support for Text::Amuse multiline headings.
- Add
<math>tag support. - Add support for
<biblio>and<play>tags. - Allow links to have empty descriptions.
- Require block
<literal>tags to be on separate lines. - Allow
-in anchors. - Allow verse to be indented.
- Allow nested footnotes.
- Internal improvements.
-
Muse writer (Alexander Krotov):
- Escape
>only at the beginning of a line. - Escape
]in image title. - Escape
]brackets in URLs as%5D. - Only escape brackets when necessary.
- Escape ordered list markers.
- Do not escape list markers unless preceded by space.
- Escape strings starting with space.
- Escape semicolons and markers after line break.
- Escape
;to avoid accidental comments. - Don’t break headers, line blocks and tables with line breaks.
- Correctly output empty headings.
- Escape horizontal rule only if at the beginning of the line.
- Escape definition list terms starting with list markers.
- Place header IDs before header.
- Improve span writing.
- Do not join Spans in normalization.
- Don’t align ordered list items.
- Remove key-value pairs from attributes before normalization.
- Enable
--wrap=preservefor all tests by default. - Reduced
<verbatim>tags in output. - Internal changes.
- Escape
-
RST writer:
- Use more consistent indentation (#4563). Previously we used an odd mix of 3- and 4-space indentation. Now we use 3-space indentation, except for ordered lists, where indentation must depend on the width of the list marker.
- Flatten nested inlines (#4368, Francesco Occhipinti). Nested inlines are not valid RST syntax, so we flatten them following some readability criteria discussed in #4368.
-
EPUB writer:
- Ensure that
pagetitleis always set, even when structured titles are used. This prevents spurious warnings about empty title elements (#4486).
- Ensure that
-
FB2 writer (Alexander Krotov):
- Output links inline instead of producing notes. Previously all links were turned into footnotes with unclickable URLs inside.
- Allow emphasis and notes in titles.
- Don’t intersperse paragraph with empty lines.
- Convert metadata value
abstractto book annotation. - Use
<empty-line />forHorizontalRulerather thanLineBreak. FB2 does not have a way to represent line breaks inside paragraphs; previously we used<empty-line />elements, but these are not allowed inside paragraphs.
-
Powerpoint writer (Jesse Rosenthal):
- Handle Quoted Inlines (#4532).
- Simplify code with
ParseXml. - Allow fallback options when looking for placeholder type.
- Check reference-doc for all layouts.
- Simplify speaker notes logic.
- Change notes state to a simpler per-slide value.
- Remove
MaybefromSpeakerNotesinSlide.memptymeans no speaker notes. - Add tests for improved speaker notes.
- Handle speaker notes earlier in the conversion process.
- Keep notes with related blocks (#4477). Some blocks automatically
split slides (imgs, tables,
columndivs). We assume that any speaker notes immediately following these are connected to these elements, and keep them with the related blocks, splitting after them. - Remove
docProps/thumbnail.jpegin data dir (Jesse Rosenthal, #4588). It contained a nonfree ICC color calibration profile and is not needed for production of a powerpoint document.
-
Markdown writer:
- Include a blank line at the end of the row in a single-row multiline table, to prevent it from being interpreted as a simple table (#4578).
-
CommonMark writer:
- Correctly ignore LaTeX raw blocks when
raw_texis not enabled (#4527, quasicomputational).
- Correctly ignore LaTeX raw blocks when
-
EPUB writer:
- Add
epub:type="footnotes"to notes section in EPUB3 (#4489).
- Add
-
LaTeX writer:
- In beamer, don’t use format specifier for default ordered lists (#4556). This gives better results for styles that put ordered list markers in boxes or circles.
- Update
\lstinlinedelimiters (#4369, Tim Parenti).
-
Ms writer:
- Use
\f[R]rather than\f[]to reset font (#4552). - Use
\f[BI]and\f[CB]in headers, instead of\f[I]and\f[C], since the header font is automatically bold (#4552). - Use
\f[CB]rather than\f[BC]for monospace bold (#4552). - Create pdf anchor for a Div with an identifier (#4515).
- Escape
/character in anchor ids (#4515). - Improve escaping for anchor ids: we now use uNNN instead of uNNN to avoid ambiguity.
- Use
-
Man writer:
- Don’t escape U+2019 as
'(#4550).
- Don’t escape U+2019 as
-
Text.Pandoc.Options:
- Removed
JsMath,LaTeXMathML, andGladTeXconstructors fromText.Pandoc.Options.HTMLMathMethod[API change].
- Removed
-
Text.Pandoc.Class:
writeMedia: unescape URI-escaping in file path. This avoids writing things likefile%20one.pngto the file system.
-
Text.Pandoc.Parsing:
- Fix
romanNumeralparser (#4480). We previously accepted ‘DDC’ as 1100. uri: don’t treat*characters at end as part of URI (#4561).
- Fix
-
Text.Pandoc.MIME:
- Use the alias
application/epsfor EPS (#2067). This will ensure that we retain the eps extension after reading the image into a mediabag and writing it again.
- Use the alias
-
Text.Pandoc.PDF:
- Use
withTempDirinhtml2pdf. - With
xelatex, don’t compress images til the last run (#4484). This saves time for image-heavy documents. - Don’t try to convert EPS files (#2067).
pdflatexconverts them itself, and JuicyPixels can’t do it. - For
pdflatex, use a temp directory in the working directory. Otherwise we can have problems with the EPS conversion pdflatex tries to do, which can’t operate on a file above the working directory without--shell-escape.
- Use
-
Changes to tests to accommodate changes in pandoc-types. In https://github.com/jgm/pandoc-types/pull/36 we changed the table builder to pad cells. This commit changes tests (and two readers) to accord with this behavior.
-
Set default extensions for
beamersame aslatex. -
LaTeX template:
- Add
beameroptionvariable (#4359, Étienne Bersac). - Use
pgfpagespackage; this is needed for notes on second screen in beamer (Étienne Bersac). - Add
background-imagevariable (#4601, John Muccigrosso).
- Add
-
reveal.js template: Add
background-imagevariable (#4600, John Muccigrosso). -
ms template: Fix date. Previously
.NDwas used, but this only works if you have a title page, which we don’t. Thanks to @teoric. -
Removed pragmas for unused extensions (#4506, Anabra).
-
Fix bash completion for
--print-default-data-file(#4549). Previously this looked in the filesystem, even if pandoc was compiled withembed_data_files(and sometimes it looked in a nonexistent build directory). Now the bash completion script just includes a hard-coded list of data file names. -
MANUAL:
- Clarify template vs metadata variables (#4501, Mauro Bieg).
- Fix raw content example (#4479, Mauro Bieg).
- Specify that you use html for raw output in epub.
- Add examples for raw docx blocks (#4472, Tristan Stenner).
The documentation states that the target format name should match
the output format, which isn’t the case for
docx/openxmland some others. - Don’t say that
empty_paragraphsaffects markdown output (#4540). - Consolidate input/output format documentation (#4577, Mauro Bieg).
-
New README template. Take in/out formats from manual.
-
Fix example in lua-filters docs (#4459, HeirOfNorton).
-
Use the
-threadedGHC flag when building benchmarks (#4587, Francesco Occhipinti). -
Bump temporary upper bound to 1.4.
-
Use pandoc-citeproc 0.14.3.1.
-
Use texmath-0.10.1.2 (fixes escapes in math in ms, #4597).
-
Removed old lib directory. This was used for something long ago, but plays no role now.
-
Removed unneeded data file
LaTeXMathML.js. -
Create 64- and 32-bit versions of Windows binary packages.
-
Docx reader (Jesse Rosenthal):
- Add tests for nested smart tags.
- Parse nested smart tags.
- Make unwrapSDT into a general
unwrapfunction that can unwrap both nested SDT tags and smartTags. This makes the SmartTags constructor in the Docx type unnecessary, so we remove it (#4446). - Remove unused
docxWarnings(Alexander Krotov).
-
RST reader: Allow unicode bullet characters (#4454).
-
Haddock reader: Better table handling, using haddock-library’s new table support, if compiled against a version that includes it. Note that tables with col/rowspans will not translate well into Pandoc.
-
Muse reader (Alexander Krotov):
- Various internal improvements.
- Require closing tag to have the same indentation as opening.
- Do not reparse blocks inside unclosed block tag (#4425).
- Parse
<class>tag (supported by Emacs Muse). - Do not produce empty Str element for unindented verse lines.
-
LaTeX reader:
- Add support to parse unit string of
\SIcommand (closes #4296, Marc Schreiber).
- Add support to parse unit string of
-
Haddock writer: In the writer, we now render tables always as grid tables, since Haddock supports these.
-
DokuWiki writer: rewrite backSlashLineBreaks (#4445, Mauro Bieg).
-
Docx writer: Fixed formatting of
DefaultStyleordered lists in docx writer. We want decimal for the top level, not lower roman. -
RST writer:
- Strip whitespace at beginning and ending of inline containers (#4327, Francesco Occhipinti).
- Filter out empty inline containers (#4434). There is nothing in
RST that corresponds to e.g.
Emph [], so we just ignore elements like this (Francesco Occhipinti).
-
Muse writer (Alexander Krotov):
- Support spans with anchors.
- Replace smallcaps with emphasis before normalization.
- Output smallcaps as emphasis.
- Expand Cite before list normalization.
- Write empty inline lists as
<verbatim></verbatim>. - Remove empty Str from the beginning of inline lists during normalization.
- Escape “-” to avoid creating bullet lists.
- Fix math expansion for more than one expression per paragraph.
- Expand math before inline list normalization.
-
Dokuwiki writer: fix LineBreaks in Tables (#4313, Mauro Bieg).
-
Ms writer:
- Asciify pdf anchors, since unicode anchors don’t work (#4436). Internal links should be converted automatically, so this shouldn’t affect users directly.
- Don’t escape hyphens as
\-; that’s for a minus sign (#4467).
-
Beamer writer: put hyperlink after
\begin{frame}and not in the title (#4307). If it’s in the title, then we get a titlebar on slides with theplainattribute, when the id is non-null. This fixes a regression in 2.0. -
EPUB writer: Remove notes from TOC in nav.xhtml (#4453, Mauro Bieg).
-
JATS writer: Remove extraneous, significant whitespace (#4335, Nokome Bentley).
-
html2pdf: inject base tag with current working directory (#4413, Mauro Bieg). This helps ensure that linked resources are included.
-
Add Semigroup instances for everything for which we defined a Monoid instance previously (API change):
- Text.Pandoc.Class.FileTree.
- Text.Pandoc.Translations.Translations.
- Text.Pandoc.Extensions.Extensions.
- Text.Pandoc.Readers.Odt.StyleReader.Styles.
- Text.Pandoc.Pretty.Doc.
- Text.Pandoc.MediaBag.MediaBag.
-
Add custom Prelude to give clean code for Monoid and Semigroup that works with ghc 7.10-8.4. The custom Prelude (
prelude/Prelude) is used for ghc versions < 8.4.NoImplicitPreludeis used in all source files, and Prelude is explicitly imported (this is necessary for ghci to work properly with the custom prelude). -
Text.Pandoc.Writers.Shared (Francesco Occhipinti):
- Export
stripLeadingTrailingSpace. - Don’t wrap lines in grid tables when
--wrap=none(#4320). gridTable: Don’t wrap lines in tables when--wrap=none. Instead, expand cells, even if it results in cells that don’t respect relative widths or surpass page column width. This change affects RST, Markdown, and Haddock writers.
- Export
-
Raise error if someone tries to print docx, odt, etc. template (#4441).
-
LaTeX template: Provide
bidipackage’s option using\PassOptionsToPackage(#4357, Václav Haisman). This avoid a clash whenpolyglossialoads it first and then it is loaded again for XeLaTeX. -
ConTeXt template: Added
pdfavariable to generate PDF/A (#4294, Henri Menke). Instructions on how to install the ICC profiles on ConTeXt standalone can be found in the wiki: http://wiki.contextgarden.net/PDFX#ICC_profiles. If the ICC profiles are not available the log will contain error messages. -
Use latest pandoc-types, skylighting
-
Use latest pandoc-citeproc in binary package.
-
Bump upper bound for time, criterion, haddock-library, exceptions, http-types, aeson, haddock-library.
-
Bump upper bound tasty-quickcheck 0.10 (#4429, Felix Yan).
-
pandoc.cabal: fix up other-extensions and language fields. Language is now consistently
Haskell2010, and other-extensions is consistentlyNoImplicitPrelude. Everything else to be specified in the module header as needed. -
Removed
old-localeflag and Text.Pandoc.Compat.Time. This is no longer necessary since we no longer support ghc 7.8. -
Make
weigh-pandocinto a benchmark program. Removeweigh-pandocflag.weigh-pandocis now built (and run) automatically when you build (and run) benchmarks. -
MANUAL: add instructions for background images reveal.js (#4325, John Muccigrosso).
-
appveyor: use VS 2013 environment instead of VS 2015 for Windows builds.
-
Markdown reader:
- Fix parsing bug with nested fenced divs (#4281). Previously we allowed
“nonindent spaces” before the opening and closing
:::, but this interfered with list parsing, so now we require the fences to be flush with the margin of the containing block.
- Fix parsing bug with nested fenced divs (#4281). Previously we allowed
“nonindent spaces” before the opening and closing
-
Commonmark reader:
raw_htmlis now on by default. It can be disabled explicitly using-f commonmark-raw_html.
-
Org reader (Albert Krewinkel):
-
Move citation tests to separate module.
-
Allow changing emphasis syntax (#4378). The characters allowed before and after emphasis can be configured via
#+pandoc-emphasis-preand#+pandoc-emphasis-post, respectively. This allows to change which strings are recognized as emphasized text on a per-document or even per-paragraph basis. Example:#+pandoc-emphasis-pre: "-\t ('\"{" #+pandoc-emphasis-post: "-\t\n .,:!?;'\")}["
-
-
LaTeX reader:
- Fixed comments inside citations (#4374).
- Fix regression in package options including underscore (#4424).
- Make
--tracework. - Fixed parsing of
tabular*environment (#4279).
-
RST reader:
- Fix regression in parsing of headers with trailing space (#4280).
-
Muse reader (Alexander Krotov):
- Enable
<literal>tags even if amuse extension is enabled. Amusewiki disables tags for security reasons. If user wants similar behavior in pandoc, RawBlocks and RawInlines can be removed or replaced with filters. - Remove space prefix from
<literal>tag contents. - Do not consume whitespace while looking for closing end tag.
- Convert alphabetical list markers to decimal in round-trip test. Alphabetical lists are an addition of Text::Amuse. They are not present in Emacs Muse and can be ambiguous when list starts with “i.”, “c.” etc.
- Allow
<quote>and other tags to be indented. - Allow single colon in definition list term.
- Fix parsing of verse in lists.
- Improved parsing efficiency. Avoid
parseFromString. Lists are parsed in linear instead of exponential time now. - Replace ParserState with MuseState.
- Prioritize lists with roman numerals over alphabetical lists. This is to make sure “i.” starts a roman numbered list, instead of a list with letter “i” (followed by “j”, “k”, …”).
- Fix directive parsing.
- Parse definition lists with multiple descriptions.
- Parse next list item before parsing more item contents.
- Fixed a bug: headers did not terminate lists.
- Move indentation parsing from
definitionListItemtodefinitionList. - Paragraph indentation does not indicate nested quote. Muse allows indentation to indicate quotation or alignment, but only on the top level, not within a or list.
- Require that block tags are on separate lines. Text::Amuse already explicitly requires it anyway.
- Fix matching of closing inline tags.
- Various internal changes.
- Fix parsing of nested definition lists.
- Require only one space for nested definition list indentation.
- Do not remove trailing whitespace from
<code>. - Fix parsing of trailing whitespace. Newline after whitespace now results in softbreak instead of space.
- Enable
-
Docx reader (Jesse Rosenthal, except where noted):
- Handle nested sdt tags (#4415).
- Don’t look up dependant run styles if
+stylesis enabled. - Move pandoc inline styling inside custom-style span.
- Read custom styles (#1843). This will read all paragraph and
character classes as divs and spans, respectively. Dependent styles
will still be resolved, but will be wrapped with appropriate style
tags. It is controlled by the
+stylesextension (-f docx+styles). This can be used in conjunction with thecustom-stylefeature in the docx writer for a pandoc-docx editing workflow. Users can convert from an input docx, reading the custom-styles, and then use that same input docx file as a reference-doc for producing an output docx file. Styles will be maintained across the conversion, even if pandoc doesn’t understand them. - Small change to Fields hyperlink parser. Previously, unquoted string required a space at the end of the line (and consumed it). Now we either take a space (and don’t consume it), or end of input.
- Pick table width from the longest row or header (Francesco Occhipinti, #4360).
-
Muse writer (Alexander Krotov):
- Change verse markup:
>instead of<verse>tag. - Remove empty strings during inline normalization.
- Don’t indent nested definition lists.
- Use unicode quotes for quoted text.
- Write image width specified in percent in Text::Amuse mode.
- Don’t wrap displayMath into
<verse>. - Escape nonbreaking space (
~~). - Join code with different attributes during normalization.
- Indent lists inside Div.
- Support definitions with multiple descriptions.
- Change verse markup:
-
Powerpoint writer (Jesse Rosenthal):
- Use table styles This will use the default table style in the reference-doc file. As a result they will be easier when using in a template, and match the color scheme.
- Remove empty slides. Because of the way that slides were split, these could be accidentally produced by comments after images. When animations are added, there will be a way to add an empty slide with either incremental lists or pauses.
- Implement syntax highlighting. Note that background colors can’t be implemented in PowerPoint, so highlighting styles that require these will be incomplete.
- New test framework for pptx. We now compare the output of the Powerpoint writer with files that we know to (a) not be corrupt, and (b) to show the desired output behavior (details below).
- Add
notesMastertopresentation.xmlif necessary. - Ignore links and (end)notes in speaker notes.
- Output speaker notes.
- Read speaker note templates conditionally. If there are speaker notes in the presentation, we read in the notesMasters templates from the reference pptx file.
- Fix deletion track changes (#4303, Jesse Rosenthal).
-
Markdown writer: properly escape @ to avoid capture as citation (#4366).
-
LaTeX writer:
- Put hypertarget inside figure environment (#4388). This works around a problem with the endfloat package and makes pandoc’s output compatible with it.
- Fix image height with percentage (#4389). This previously caused the image to be resized to a percentage of textwidth, rather than textheight.
-
ConTeXt writer (Henri Menke):
- New section syntax and support
--section-divs(#2609).\section[my-header]{My Header}->\section[title={My Header},reference={my-header}]. The ConTeXt writer now supports the--section-divsoption to write sections in the fenced style, with\startsectionand\stopsection. - xtables: correct wrong usage of caption (Henri Menke).
- New section syntax and support
-
Docx writer:
- Fix image resizing with multiple images (#3930, Andrew Pritchard).
- Use new golden framework (Jesse Rosenthal).
- Make more deterministic to facilitate testing (Jesse Rosenthal).
getUniqueIdnow calls to the state to get an incremented digit, instead of calling to P.uniqueHash.- we always start the PRNG in mkNumbering/mkAbstractNum with the same seed (1848), so our randoms should be the same each time.
- Fix ids in comment writing (Jesse Rosenthal). Comments from
--track-changes=allwere producing corrupt docx, because the writer was trying to get id from the(ID,_,_)field of the attributes, and ignoring the “id” entry in the key-value pairs. We now check both.
-
Ms writer: Added papersize variable.
-
TEI writer:
- Use
heightinstead ofdepthfor images (#4331). - Ensure that id prefix is always used.
- Don’t emit
roleattribute; that was a leftover from the Docbook writer. - Use ‘xml:id’, not ‘id’ attribute (#4371).
- Use
-
AsciiDoc writer:
- Do not output implicit heading IDs (#4363, Alexander
Krotov). Convert to
asciidoc-auto_identifiersfor old behaviour.
- Do not output implicit heading IDs (#4363, Alexander
Krotov). Convert to
-
RST writer:
- Remove
blockToRST'moving its logic intofixBlocks(Francesco Occhipinti). - Insert comment between lists and quotes (#4248, Francesco Occchipinti).
- Remove
-
RST template: remove definition of ‘math’ role as raw. This used to be needed prior to v 0.8 of docutils, but now math support is built-in.
-
Slides: Use divs to set incremental/non-incremental (#4381, Jesse Rosenthal). The old method (list inside blockquote) still works, but we are encouraging the use of divs with class
incrementalornonincremental. -
Text.Pandoc.ImageSize:
- Make image size detection for PDFs more robust (#4322).
- Determine image size for PDFs (#4322).
- EMF Image size support (#4375, Andrew Pritchard).
-
Text.Pandoc.Extensions:
- Add
Ext_styles(Jesse Rosenthal, API change). This will be used in the docx reader (defaulting to off) to read pargraph and character styles not understood by pandoc (as divs and spans, respectively). - Made
Ext_raw_htmldefault forcommonmarkformat.
- Add
-
Text.Pandoc.Parsing:
- Export
manyUntil(Alexander Krotov, API change). - Export improved
sepBy1(Alexander Krotov). - Export list marker parsers:
upperRoman,lowerRoman,decimal,lowerAlpha,upperAlpha(Alexander Krotov, API change).
- Export
-
Tests/Lua: fix tests on windows (Albert Krewinkel).
-
Lua: register script name in global variable (#4393). The name of the Lua script which is executed is made available in the global Lua variable
PANDOC_SCRIPT_FILE, both for Lua filters and custom writers. -
Tests: Abstract powerpoint tests out to OOXML tests (Jesse Rosenthal). There is very little pptx-specific in these tests, so we abstract out the basic testing function so it can be used for docx as well. This should allow us to catch some errors in the docx writer that slipped by the roundtrip testing.
-
Lua filters: store constructors in registry (Albert Krewinkel). Lua functions used to construct AST element values are stored in the Lua registry for quicker access. Getting a value from the registry is much faster than getting a global value (partly to idiosyncrasies of hslua); this change results in a considerable performance boost.
-
Documentation:
doc/org.mdAdd draft of Org-mode documentation (Albert Krewinkel).doc/lua-filters.md: document global vars set for filters (Albert Krewinkel).- INSTALL.md: mention Stack version. (#4343, Adam Brandizzi).
- MANUAL: add documentation on custom styles (Jesse Rosenthal).
- MANUAL.txt: Document incremental and nonincremental divs (Jesse Rosenthal). Blockquoted lists are still described, but fenced divs are presented in preference.
- MANUAL.txt: document header and footer variables (newmana).
- MANUAL.txt: self-contained implies standalone (#4304, Daniel Lublin).
- CONTRIBUTING.md: label was renamed. (#4310, Alexander Brandizzi).
-
Require tagsoup 0.14.3 (#4282), fixing HTML tokenization bug.
-
Use latest texmath.
-
Use latest pandoc-citeproc.
-
Allow exceptions 0.9.
-
Require aeson-pretty 0.8.5 (#4394).
-
Bump blaze-markup, blaze-html lower bounds to 0.8, 0.9 (#4334).
-
Update tagsoup to 0.14.6 (Alexander Krotov, #4282).
-
Removed ghc-prof-options. As of cabal 1.24, sensible defaults are used.
-
Update default.nix to current nixpkgs-unstable for hslua-0.9.5 (#4348, jarlg).
-
Added
jatsas an input format.- Add Text.Pandoc.Readers.JATS, exporting
readJATS(API change) (Hamish Mackenzie). - Improved citation handling in JATS reader. JATS citations
are now converted to pandoc citations, and JATS ref-lists
are converted into a
referencesfield in metadata, suitable for use with pandoc-citeproc. Thus a JATS article with embedded bibliographic information can be processed with pandoc and pandoc-citeproc to produce a formatted bibliography.
- Add Text.Pandoc.Readers.JATS, exporting
-
Allow
--list-extensionsto take an optional FORMAT argument. This lists the extensions set by default for the selected FORMAT. The extensions are now alphabetized, and the+or-indicating the default setting comes before, rather than after, the extension. -
Markdown reader:
- Preserve original whitespace between blocks.
- Recognize
\placeformulaas context. - Be pickier about table captions. A caption starts with a
:which can’t be followed by punctuation. Otherwise we can falsely interpret the start of a fenced div, or even a table header line like:--:|:--:, as a caption. - Always use four space rule for example lists. It would be awkward to indent example list contents to the first non-space character after the label, since example list labels are often long. Thanks to Bernhard Fisseni for the suggestion.
- Improve raw tex parsing. Note that the Markdown reader is also
affected by the
latex_macrosextension changes described below under the LaTeX reader.
-
LaTeX reader:
latex_macrosextension changes (#4179). Don’t pass through macro definitions themselves whenlatex_macrosis set. The macros have already been applied. Iflatex_macrosis enabled, thenrawLaTeXBlockin Text.Pandoc.Readers.LaTeX will succeed in parsing a macro definition, and will update pandoc’s internal macro map accordingly, but the empty string will be returned.- Export
tokenize,untokenize(API change). - Use
applyMacrosinrawLaTeXBlock,rawLaTeXInline. - Refactored
inlineCommand. - Fix bug in tokenizer. Material following
^^was dropped if it wasn’t a character escape. This only affected invalid LaTeX, so we didn’t see it in the wild, but it appeared in a QuickCheck test failure. - Fix regression in LateX tokenization (#4159). This mainly affects the Markdown reader when parsing raw LaTeX with escaped spaces.
- Add tests of LaTeX tokenizer.
- Support
\foreignlanguagefrom babel. - Be more tolerant of
&character (#4208). This allows us to parse unknown tabular environments as raw LaTeX.
-
Muse reader (Alexander Krotov):
- Parse anchors immediately after headings as IDs.
- Require that note references does not start with 0.
- Parse empty comments correctly.
-
Org reader (Albert Krewinkel):
- Fix asterisks-related parsing error (#4180).
- Support minlevel option for includes (#4154). The level of headers
in included files can be shifted to a higher level by specifying a
minimum header level via the
:minlevelparameter. E.g.#+include: "tour.org" :minlevel 1will shift the headers in tour.org such that the topmost headers become level 1 headers. - Break-up org reader test file into multiple modules.
-
OPML reader:
- Enable raw HTML and other extensions by default for notes
(#4164). This fixes a regression in 2.0. Note that extensions can
now be individually disabled, e.g.
-f opml-smart-raw_html.
- Enable raw HTML and other extensions by default for notes
(#4164). This fixes a regression in 2.0. Note that extensions can
now be individually disabled, e.g.
-
RST reader:
- Allow empty list items (#4193).
- More accurate parsing of references (#4156). Previously we erroneously
included the enclosing backticks in a reference ID (#4156). This
change also disables interpretation of syntax inside references, as
in docutils. So, there is no emphasis in
`my *link*`_.
-
Docx reader:
- Continue lists after interruption (#4025, Jesse Rosenthal). Docx expects that lists will continue where they left off after an interruption and introduces a new id if a list is starting again. So we keep track of the state of lists and use them to define a “start” attribute, if necessary.
- Add tests for structured document tags unwrapping (Jesse Rosenthal).
- Preprocess Document body to unwrap
w:sdtelements (Jesse Rosenthal, #4190).
-
Plain writer:
- Don’t linkify table of contents.
-
RST writer:
- Fix anchors for headers (#4188). We were missing an
_.
- Fix anchors for headers (#4188). We were missing an
-
PowerPoint writer (Jesse Rosenthal):
- Treat lists inside BlockQuotes as lists. We don’t yet produce incremental lists in PowerPoint, but we should at least treat lists inside BlockQuotes as lists, for compatibility with other slide formats.
- Add ability to force size. This replaces the more specific
blockQuote runProp, which only affected the size of blockquotes. We can use this for notes, etc. - Implement notes. This currently prints all notes on a final slide. Note that at the moment, there is a danger of text overflowing the note slide, since there is no logic for adding further slides.
- Implement basic definition list functionality to PowerPoint writer.
- Don’t look for default template file for Powerpoint (#4181).
- Add pptx to isTextFormat list. This is used to check standalone and not writing to the terminal.
- Obey slide level option (Jesse Rosenthal).
- Introduce tests.
-
Docx writer:
- Ensure that
distArchiveis the one that comes with pandoc (#4182). Previously areference.docxin~/.pandoc(or the user data dir) would be used instead, and this could cause problems because a user-modified docx sometimes lacks vital sections that we count on thedistArchiveto supply.
- Ensure that
-
Org writer:
- Do not wrap “-” to avoid accidental bullet lists (Alexander Krotov).
- Don’t allow fn refs to wrap to beginning of line (#4171, with help from Alexander Krotov). Otherwise they can be interpreted as footnote definitions.
-
Muse writer (Alexander Krotov):
- Don’t wrap note references to the next line (#4172).
-
HTML writer:
- Use br elements in line blocks instead of relying on CSS
(#4162). HTML-based templates have had the custom CSS for
div.line-blockremoved. Those maintaining custom templates will want to remove this too. We still enclose line blocks in a div with classline-block.
- Use br elements in line blocks instead of relying on CSS
(#4162). HTML-based templates have had the custom CSS for
-
LaTeX writer:
- Use
\renewcommandfor\textlatinwith babel (#4161). This avoids a clash with a deprecated\textlatincommand defined in Babel. - Allow fragile=singleslide attribute in beamer slides (#4169).
- Use
\endheadafter\toprulein headerless tables (#4207).
- Use
-
FB2 writer:
- Add cover image specified by
cover-imagemeta (Alexander Krotov, #4195).
- Add cover image specified by
-
JATS writer (Hamish Mackenzie):
- Support writing
<fig>and<table-wrap>elements with<title>and<caption>inside them by using Divs with class set to one offig,table-wraporcaption(Hamish Mackenzie). The title is included as a Heading so the constraint on where Heading can occur is also relaxed. - Leave out empty alt attributes on links.
- Deduplicate image mime type code.
- Make
<p>optional in<td>and<th>(#4178). - Self closing tags for empty xref (#4187).
- Improve support for code language.
- Support writing
-
Custom writer:
- Use init file to setup Lua interpreter (Albert Krewinkel).
The same init file (
data/init) that is used to setup the Lua interpreter for Lua filters is also used to setup the interpreter of custom writers.lua. - Define instances for newtype wrapper (Albert Krewinkel). The custom
writer used its own
ToLuaStackinstance definitions, which made it difficult to share code with Lua filters, as this could result in conflicting instances. AStringifywrapper is introduced to avoid this problem. - Added tests for custom writer.
- Fixed definition lists and tables in
data/sample.lua.
- Use init file to setup Lua interpreter (Albert Krewinkel).
The same init file (
-
Fixed regression: when target is PDF, writer extensions were being ignored. So, for example,
pandoc -t latex-smart -o file.pdfdid not work properly. -
Lua modules (Albert Krewinkel):
- Add
pandoc.utilsmodule, to hold utility functions. - Create a Haskell module Text.Pandoc.Lua.Module.Pandoc to
define the
pandoclua module. - Make a Haskell module for each Lua module. Move definitions for the
pandoc.mediabagmodules to a separate Haskell module. - Move
sha1from the mainpandocmodule topandoc.utils. - Add function
pandoc.utils.hierarchicalize(convert list of Pandoc blocks into (hierarchical) list of Elements). - Add function
pandoc.utils.normalize_date(parses a date and converts it (if possible) to “YYYY-MM-DD” format). - Add function
pandoc.utils.to_roman_numeral(allows conversion of numbers below 4000 into roman numerals). - Add function
pandoc.utils.stringify(converts any AST element to a string with formatting removed). data/init.lua: loadpandoc.utilsby default- Turn pipe, read into full Haskell functions. The
pipeandreadutility functions are converted from hybrid lua/haskell functions into full Haskell functions. This avoids the need for intermediate_pipe/_readhelper functions, which have dropped. - pandoc.lua: re-add missing MetaMap function. This was a bug introduced in version 2.0.4.
- Add
-
Text.Pandoc.Class: Add
insertInFileTree[API change]. This gives a pure way to insert an ersatz file into aFileTree. In addition, we normalize paths both on insertion and on lookup. -
Text.Pandoc.Shared: export
blocksToInlines'(API change, Maura Bieg). -
Text.Pandoc.MIME: Add opus to MIME type table as audio/ogg (#4198).
-
Text.Pandoc.Extensions: Alphabetical order constructors for
Extension. This makes them appear in order in--list-extensions. -
Allow lenient decoding of latex error logs, which are not always properly UTF8-encoded (#4200).
-
Update latex template to work with recent versions of beamer. The old template produced numbered sections with some recent versions of beamer. Thanks to Thomas Hodgson.
-
Updated reference.docx (#4175). Instead of just “Hello, world”, the document now contains exemplars of most of the styles that have an effect on pandoc documents. This makes it easier to see the effect of style changes.
-
Removed
default.themedata file (#4096). It is no longer needed now that we have--print-highlight-style. -
Added
stack.lts9.yamlfor building with lts 9 and ghc 8.0.2. We still need this for the alpine static linux build, since we don’t have ghc 8.2.2 for that yet. -
Removed
stack.pkg.yaml. We only really needstack.yaml; we can put flag settings for pandoc-citeproc there. -
Makefile: Add ‘trypandoc’ and ‘pandoc-templates’ targets to make releases easier.
-
MANUAL.txt:
- Add note on what formats have
+smartby default. - Use native syntax for custom-style (#4174, Mauro Bieg).
- Introduce dedicated Extensions section, since some extensions affect formats other than markdown (Mauro Bieg, #4204).
- Clarify default html output for
--section-divs(Richard Edwards).
- Add note on what formats have
-
filters.md: say that Text.Pandoc.JSON comes form pandoc-types. Closes jgm/pandoc-website#16.
-
epub.md: Delete removed
-Soption from command (#4151, Georger Araújo).
-
Add
--print-highlight-styleoption. This generates a JSON version of a highlighting style, which can be saved as a.themefile, modified, and used with--highlight-style(#4106, #4096). -
Add
--strip-empty-paragraphsoption. This works for any input format. It is primarily intended for use with docx and odt documents where empty paragraphs have been used for inter-paragraph spaces. -
Support
--webtexforgfmoutput. -
Recognize
.musefile extension. -
Support beamer
\alertin LaTeX reader. Closes #4091. -
Docx reader: don’t strip out empty paragraphs (#2252). Users who have a conversion pipeline from docx may want to consider adding
--strip-empty-paragraphsto the command line. -
Org reader (Albert Krewinkel): Allow empty list items (#4090).
-
Muse reader (Alexander Krotov):
- Parse markup in definition list terms.
- Allow definition to end with EOF.
- Make code blocks round trip.
- Drop common space prefix from list items.
- Add partial round trip test.
- Don’t interpret XML entities.
- Remove
nested. - Parse
~~as non-breaking space in Emacs mode. - Correctly remove indentation from notes. Exactly one space is required and considered to be part of the marker.
- Allow list items to be empty.
- Add ordered list test.
- Add more multiline definition tests.
- Don’t allow blockquotes within lists.
- Fix reading of multiline definitions.
- Add inline
<literal>support. - Concatenate inlines of the same type
-
Docx writer: allow empty paragraphs (#2252).
-
CommonMark/gfm writer:
- Use raw html for native divs/spans (#4113). This allows a pandoc markdown native div or span to be rendered in gfm using raw html tags.
- Implement
raw_htmlandraw_texextensions. Note thatraw_htmlis enabled by default forgfm, whileraw_texis disabled by default.
-
Muse writer (Alexander Krotov):
- Test that inline math conversion result is normalized.
Without normalization this test produced
<em>a</em><em>b</em><em>c</em>. - Improve inline list normalization and move to writer.
- Escape hash symbol.
- Escape
----to avoid accidental horizontal rules. - Escape only
</code>inside code tag. - Additional
<verbatim>is not needed as<code>is verbatim already.
- Test that inline math conversion result is normalized.
Without normalization this test produced
-
LaTeX writer:
- Allow specifying just width or height for image size.
Previously both needed to be specified (unless the image was
being resized to be smaller than its original size).
If height but not width is specified, we now set width to
textwidth. If width but not height is specified, we now set
height to textheight. Since we have
keepaspectratio, this yields the desired result. - Escape
~and_in code with--listings(#4111).
- Allow specifying just width or height for image size.
Previously both needed to be specified (unless the image was
being resized to be smaller than its original size).
If height but not width is specified, we now set width to
textwidth. If width but not height is specified, we now set
height to textheight. Since we have
-
HTML writer: export
tagWithAttributes. This is a helper allowing other writers to create single HTML tags. -
Let papersizes
a0,a1,a2, … be case-insensitive by converting the case as needed in LaTeX and ConTeXt writers. -
Change
fixDisplayMathfromText.Pandoc.Writers.Sharedso that it no longer produces emptyPara’s as an artifact. -
Text.Pandoc.Shared.blocksToInlines: rewrote using builder. This gives us automatic normalization, so we don’t get for example two consecutive Spaces. -
Include default CSS for ‘underline’ class in HTML-based templates.
-
revealjs template: add
tex2jaxconfiguration for the math plugin. With the next release of reveal.js, this will fix the problem of$s outside of math contexts being interpreted as math delimiters (#4027). -
pandoc.luamodule for use in lua filters (Albert Krewinkel):-
Add basic lua List module (#4099, #4081). The List module is automatically loaded, but not assigned to a global variable. It can be included in filters by calling
List = require 'List'. Lists of blocks, lists of inlines, and lists of classes are now givenListas a metatable, making working with them more convenient. E.g., it is now possible to concatenate lists of inlines using Lua’s concatenation operator..(requires at least one of the operants to haveListas a metatable):function Emph (emph) local s = {pandoc.Space(), pandoc.Str 'emphasized'} return pandoc.Span(emph.content .. s) endThe
Listmetatable is assigned to the tables which get passed to the constructorsMetaBlocks,MetaInline, andMetaList. This enables the use of the resulting objects as lists. -
Lua/StackInstances: push Pandoc and Meta via constructor. Pandoc and Meta elements are now pushed by calling the respective constructor functions of the pandoc Lua module. This makes serialization consistent with the way blocks and inlines are pushed to lua and allows to use List methods with theblocksvalue. -
Add documentation for pandoc.List in
lua-filters.md.
-
-
Use latest tagsoup. This fixes a bug in parsing HTML tags with
&(but not a valid entity) following them (#4094, #4088). -
Use skylighting 0.4.4.1, fixing the color of unmarked code text when
numberLinesis used (#4103). -
Make
normalizeDatemore forgiving (Mauro Bieg, #4101), not requiring a leading 0 on single-digit days. -
Fix
--helpoutput for--highlight-styleto includeFILE(Mauro Bieg, #4095). -
Clearer deprecation warning for
--latexmathml, --asciimathml, -m. Previously we only mentioned--latexmathml, even if-mwas used. -
Changelog: fix description of lua filters in 2.0 release (Albert Krewinkel). Lua filters were initially run after conventional (JSON) filters. However, this was changed later to make it easier to deal with files in the mediabag. The changelog is updated to describe that feature of the 2.0 release correctly.
-
Change Generic JSON instances to TemplateHaskell (Jasper Van der Jeugt, #4085). This reduces compile time and memory usage significantly.
-
lua-filters.md: Added tikz filter example. -
Create alternative zip file for macOS binaries.
-
Create alternative zip file for Windows binaries.
-
Update INSTALL.md since we now provide zips for binaries.
-
Relax
http-typesdependency (Justus Sagemüller, #4084). -
Add
epub.md,getting-started.mdto docs. These used to live in the website repo. -
Add
packagestarget to Makefile. -
Bump bounds for binary, http-types, tasty-hunit
-
New output format
ms(groff ms). Complete support, including tables, math, syntax highlighting, and PDF bookmarks. The writer uses texmath’s new eqn writer to convert math to eqn format, so a ms file produced with this writer should be processed withgroff -ms -eif it contains math. -
New output format
jats(Journal Article Tag Suite). This is an XML format used in archiving and publishing articles. Note that a URI-encoded CSL stylesheet (data/jats.csl) is added automatically unless a stylesheet is specified using--css. -
New output format
gfm(GitHub-flavored CommonMark) (#3841). This uses bindings to GitHub’s fork of cmark, so it should parse gfm exactly as GitHub does (excepting certain postprocessing steps, involving notifications, emojis, etc.).markdown_githubhas been deprecated in favor ofgfm. -
New output format
muse(Emacs Muse) (Alexander Krotov, #3489). -
New input format
gfm(GitHub-flavored CommonMark) (#3841). This uses bindings to GitHub’s fork of cmark.markdown_githubhas been deprecated in favor ofgfm. -
New input format
muse(Emacs Muse) reader (Alexander Krotov, #3620). -
New input format
tikiwiki(TikiWiki markup) (rlpowell, #3800). -
New input format
vimwiki(Vimwiki markup) (Yuchen Pei, #3705). Note that there is a new data file,data/vimwiki.css, which can be used to display the HTML produced by this reader and pandoc’s HTML writer in the style of vimwiki’s own HTML export. -
New input format
creole(Creole 1.0) (#3994, Sascha Wilde). -
New syntax for Divs, with
fenced_divsextension enabled by default (#168). This gives an attractive, plain-text way to create containers for block-level content. -
Added new syntax for including raw content in any output format, enabled by the
raw_attributeextension (which is on by default formarkdownandmultimarkdown). The syntax is the same as for fenced code blocks or code inlines, only with{=FORMAT}for attributes, whereFORMATis the name of the output format (e.g.,ms,html). -
Implement multicolumn support for slide formats (#1710). The structure expected is:
:::::::::::::: {.columns} ::: {.column width="40%"} contents... ::: ::: {.column width="60%"} contents... ::: ::::::::::::::Support has been added for beamer and all HTML slide formats.
-
Allows line comments in templates, beginning with
$--(#3806). (Requires doctemplates 0.2.1.) -
Add
--eol=crlf|lf|nativeflag and writer option to control line endings (Stefan Dresselhaus, #3663, #2097). -
Add
--logoption to save log messages in JSON format to a file (#3392). -
Add
--request-headeroption, to set request headers when pandoc makes HTTP requests to fetch external resources. For example:--request-header User-Agent:blah. -
Added lua filters (Albert Krewinkel, #3514). The new
--lua-filteroption works like--filterbut takes pathnames of special lua filters and uses the lua interpreter baked into pandoc, so that no external interpreter is needed. Note that lua filters are all applied after regular filters, regardless of their position on the command line. For documentation of lua filters, seedoc/lua-filters.md. -
Set
PANDOC_READER_OPTIONSin environment where filters are run. This contains a JSON representation ofReaderOptions, so filters can access it. -
Support creation of pdf via groff
msand pdfroff.pandoc -t ms -o output.pdf input.txt. -
Support for PDF generation via HTML and
weasyprintorprince(Mauro Bieg, #3909).pandoc -t html5 -o output.pdf --pdf-engine=prince. -
Added
--epub-subdirectoryoption (#3720). This specifies the subdirectory in the OCF container that holds the EPUB specific content. We now put all EPUB related content in anEPUB/subdirectory by default (later this will be configurable).mimetype META-INF/ com.apple.ibooks.display-options.xml container.xml EPUB/ <<--configurable-->> fonts/ <<--static-->> font.otf media/ <<--static-->> cover.jpg fig1.jpg styles/ <<--static-->> stylesheet.css content.opf toc.ncx text/ <<--static-->> ch001.xhtml -
Added
--resource-path=SEARCHPATHcommand line option (#852). SEARCHPATH is separated by the usual character, depending on OS (: on unix, ; on windows). Default resource path is just working directory. However, the working directory must be explicitly specified if the--resource-pathoption is used. -
Added –abbreviations=FILE option for custom abbreviations file (#256). Dfault abbreviations file (
data/abbreviations) contains a list of strings that will be recognized by pandoc’s Markdown parser as abbreviations. (A nonbreaking space will be inserted after the period, preventing a sentence space in formats like LaTeX.) Users can override the default by putting a file abbreviations in their user data directory (~/.pandocon *nix). -
Allow a theme file as argument to
--highlight-style. Also include a sample,default.theme, indata/. -
Allow
--syntax-definitionoption for dynamic loading of syntax highlighting definitions (#3334). -
Lists in
markdownby default now use the CommonMark variable nesting rules (#3511). The indentation required for a block-level item to be included in a list item is no longer fixed, but is determined by the first line of the list item. To be included in the list item, a block must be indented to the level of the first non-space content after the list marker. Exception: if are 5 or more spaces after the list marker, then the content is interpreted as an indented code block, and continuation paragraphs must be indented two spaces beyond the end of the list marker. See the CommonMark spec for more details and examples.Documents that adhere to the four-space rule should, in most cases, be parsed the same way by the new rules. Here are some examples of texts that will be parsed differently:
- a - bwill be parsed as a list item with a sublist; under the four-space rule, it would be a list with two items.
- a codeHere we have an indented code block under the list item, even though it is only indented six spaces from the margin, because it is four spaces past the point where a continuation paragraph could begin. With the four-space rule, this would be a regular paragraph rather than a code block.
- a codeHere the code block will start with two spaces, whereas under the four-space rule, it would start with
code. With the four-space rule, indented code under a list item always must be indented eight spaces from the margin, while the new rules require only that it be indented four spaces from the beginning of the first non-space text after the list marker (here,a).This change was motivated by a slew of bug reports from people who expected lists to work differently (#3125, #2367, #2575, #2210, #1990, #1137, #744, #172, #137, #128) and by the growing prevalance of CommonMark (now used by GitHub, for example). Those who prefer the old behavior can use
-f markdown+four_space_rule. -
Added
four_space_ruleextension. This triggers the old pandoc parsing rule for content nested under list items (the “four space rule”). -
Added
spaced_reference_linksextension (#2602). It allows whitespace between the two parts of a reference link: e.g.[a] [b] [b]: urlThis was previously enabled by default; now it is forbidden by default.
-
Add
space_in_atx_headerextension (#3512). This is enabled by default in pandoc and GitHub markdown but not the other flavors. This requirse a space between the opening #’s and the header text in ATX headers (as CommonMark does but many other implementations do not). This is desirable to avoid falsely capturing things ilke#hashtagor
#5 -
Add
sourcefileandoutputfiletemplate variables (Roland Hieber, #3431). -
Allow ibooks-specific metadata in epubs (#2693). You can now have the following fields in your YAML metadata, and it will be treated appropriately in the generated EPUB:
ibooks: version: 1.3.4 specified-fonts: false ipad-orientation-lock: portrait-only iphone-orientation-lock: landscape-only binding: true scroll-axis: vertical
-
Reader functions no longer presuppose that CRs have been stripped from the input. (They strip CRs themselves, before parsing, to simplify the parsers.)
-
Added support for translations (localization) (#3559). Currently this only affects the LaTeX reader, for things like
\figurename. Translation data files for 46 languages can be found indata/translations. -
Make
--asciiwork with DocBook output too. -
Rename
--latex-engineto--pdf-engine, and--latex-engine-optto--pdf-engine-opt. -
Removed
--parse-rawandreaderParseRaw. These were confusing. Now we rely on the+raw_texor+raw_htmlextension with latex or html input. Thus, instead of--parse-raw -f latexwe use-f latex+raw_tex, and instead of--parse-raw -f htmlwe use-f html+raw_html. -
With
--filterR filters are now recognized, even if they are not executable (#3940, #3941, Andrie de Vries). -
Support SVG in PDF output, converting with
rsvg2pdf(#1793). -
Make epub an alias for epub3, not epub2.
-
Removed
--epub-stylesheet; use--cssinstead (#3472, #847). Multiple stylesheets may be used. Stylesheets will be taken both from--cssand from thestylesheetmetadata field (which can contain either a file path or a list of them). -
--mathmland MathML in HTMLMathMethod no longer take an argument. The argument was for a bridge JavaScript that used to be necessary in 2004. We have removed the script already. -
--kateximprovements. The latest version is used, and the autoload script is loaded by default. -
Change MathJax CDN default since old one is shutting down (#3544). Note: The new URL requires a version number, which we’ll have to update manually in subsequent pandoc releases in order to take advantage of mathjax improvements.
-
--self-contained: don’t incorporate elements withdata-external="1"(#2656). You can leave an external link as it is by adding the attribute data-external=“1” to the element. Pandoc will then not try to incorporate its content when--self-containedis used. This is similar to a feature already supported by the EPUB writer. -
Allow
--extract-mediato work with non-binary input formats (#1583, #2289). If--extract-mediais supplied with a non-binary input format, pandoc will attempt to extract the contents of all linked images, whether in local files, data: uris, or external uris. They will be named based on the sha1 hash of the contents. -
Make
papersize: a4work regardless of the case ofa4. It is converted toa4in LaTeX andA4in ConTeXt. -
Make
east_asian_line_breaksaffect all readers/writers (#3703). -
Underlined elements are now treated consistently by readers (#2270, hftf); they are always put in a Span with class
underline. This allows the user to treat them differently from other emphasis, using a filter. Docx, Org, Textile, Txt2Tags, and HTML readers have been changed. -
Improved behavior of
auto_identifierswhen there are explicit ids (#1745). Previously only autogenerated ids were added to the list of header identifiers in state, so explicit ids weren’t taken into account when generating unique identifiers. Duplicated identifiers could result. This simple fix ensures that explicitly given identifiers are also taken into account. -
Use
table-of-contentsfor contents of toc, maketoca boolean (#2872). Changed markdown, rtf, and HTML-based templates accordingly. This allows you to settoc: truein the metadata; this previously produced strange results in some output formats. For backwards compatibility,tocis still set to the toc contents. But it is recommended that you update templates to usetable-of-contentsfor the toc contents andtocfor a boolean flag. -
Change behavior with binary format output to stdout. Previously, for binary formats, output to stdout was disabled unless we could detect that the output was being piped (and not sent to the terminal). Unfortunately, such detection is not possible on Windows, leaving windows users no way to pipe binary output. So we have changed the behavior in the following way:
- Output to stdout is allowed when it can be determined that the output is being piped (on non-Windows platforms).
- If the
-ooption is not used, binary output is never sent to stdout by default; instead, an error is raised. - If
-o -is used, binary output is sent to stdout, regardless of whether it is being piped. This works on Windows too.
-
Better error behavior: uses of
errorhave been replaced by raising ofPandocError, which can be trapped and handled by the calling program. -
Removed
hard_line_breaksextension frommarkdown_github(#3594). GitHub has two Markdown modes, one for long-form documents like READMEs and one for short things like issue comments. In issue comments, a line break is treated as a hard line break. In README, wikis, etc., it is treated as a space as in regular Markdown. Since pandoc is more likely to be used to convert long-form documents from GitHub Markdown,-hard_line_breaksis a better default. -
Include
backtick_code_blocksextension inmardkown_mmd(#3637). -
Escape
MetaStringvalues (as added with-M/--metadataflag) (#3792). Previously they would be transmitted to the template without any escaping. Note that--M title='*foo*'yields a different result from--- title: *foo* ---In the latter case, we have emphasis; in the former case, just a string with literal asterisks (which will be escaped in formats, like Markdown, that require it).
-
Allow
em,cm,infor image height/width in HTML, LaTeX (#3450). -
HTML writer: Insert
data-in front of unsupported attributes. Thus, a span with attributefoogets written to HTML5 withdata-foo, so it is valid HTML5. HTML4 is not affected. This will allow us to use custom attributes in pandoc without producing invalid HTML. (With help from Wandmalfarbe, #3817.) -
Plain writer: improved super/subscript rendering. We now handle more non-digit characters for which there are sub/superscripted unicode characters. When unicode sub/superscripted characters are not available, we use
_(..)or^(..)(#3518). -
Docbook, JATS, TEI writers: print INFO message when omitting interior header (#3750). This only applies to section headers inside list items, e.g., which were otherwise silently omitted.
-
Change to
--reference-linksin Markdown writer (#3701). With--reference-locationofsectionorblock, pandoc will now repeat references that have been used in earlier sections. The Markdown reader has also been modified, so that exactly repeated references do not generate a warning, only references with the same label but different targets. The idea is that, with references after every block, one might want to repeat references sometimes. -
ODT/OpenDocument writer:
- Support
langattribute (#1667). - Added support for
--toc(#2836). Thanks to @anayrat.
- Support
-
Docx writer:
-
langmeta, see #1667 (Mauro Bieg, #3515). -
Change
FigureWithCaptiontoCaptionedFigure(iandol, #3658). -
Use
Tablerather thanTable Normalfor table style (#3275).Table Normalis the default table style and can’t be modified. -
Pass through comments (#2994). We assume that comments are defined as parsed by the docx reader:
I want I left a comment.some text to have a comment on it.
We assume also that the id attributes are unique and properly matched between comment-start and comment-end.
-
Bookmark improvements. Bookmark start/end now surrounds content rather than preceding it. Bookmarks generated for Div with id (jgm/pandoc-citeproc#205).
-
Add
keywordsmetadata to docx document properties (Ian).
-
-
RST writer: support unknown interpreted text roles by parsing them as
Spanwithroleattributes (#3407). This way they can be manipulated in the AST. -
HTML writer:
- Line block: Use class instead of style attribute (#1623). We now
issue
<div class="line-block">and include a default definition forline-blockin the default templates, instead of hard-coding astyleon the div. - Add class
footnoteBackto footnote back references (Timm Albers). This allows for easier CSS styling. - Render SmallCaps as span with smallcaps class (#1592), rather than using a style attribute directly. This gives the user more flexibility in styling small caps in CSS.
- With reveal.js we use
data-srcinstead ofsrcfor images for lazy loading. - Special-case
.stretchclass for images in reveal.js (#1291). Now in reveal.js, an image with classstretchin a paragraph by itself will stretch to fill the whole screen, with no caption or figure environment.
- Line block: Use class instead of style attribute (#1623). We now
issue
-
Added warnings for non-rendered blocks to writers.
-
Writers now raise an error on template failure.
-
When creating a PDF via LaTeX, warn if the font is missing some characters (#3742).
-
Remove initial check for PDF-creating program (#3819). Instead, just try running it and raise the exception if it isn’t found at that point. This improves things for users of Cygwin on Windows, where the executable won’t be found by
findExecutableunless.exeis added. The same exception is raised as before, but at a later point. -
Readers issue warning for duplicate header identifiers (#1745). Autogenerated header identifiers are given suffixes so as not to clash with previously used header identifiers. But they may still coincide with an explicit identifier that is given for a header later in the document, or with an identifier on a div, span, link, or image. We now issue a warning in this case, so users can supply an explicit identifier.
-
CommonMark reader now supports
emoji,hard_line_breaks,smart, andraw_htmlextensions. -
Markdown reader:
-
Don’t allow backslash + newline to affect block structure (#3730). Note that as a result of this change, the following, which formerly produced a header with two lines separated by a line break, will now produce a header followed by a paragraph:
Hi\
there
This may affect some existing documents that relied on this undocumented and unintended behavior. This change makes pandoc more consistent with other Markdown implementations, and with itself (since the two-space version of a line break doesn’t work inside ATX headers, and neither version works inside Setext headers).
-
-
Org reader (Albert Krewinkel, unless noted):
- Support
table.eltables (#3314). - Support macros (#3401).
- Support the
#+INCLUDE:file inclusion mechanism (#3510). Recognized include types areexample,export,src, and normal org file inclusion. Advanced features like line numbers and level selection are not implemented yet. - Interpret more meta value as inlines. The values of the following
meta variables are now interpreted using org-markup instead of
treating them as pure strings:
keywords(comma-separated list of inlines),subtitle(inline values),nocite(inline values, can be repeated). - Support
\nexport option (#3940). This turns all newlines in the text into hard linebreaks.
- Support
-
RST reader:
-
Improved admonition support (#223). We no longer add an
admonitionclass, we just use the class for the type of admonition,notefor example. We put the word corresponding to the label in a paragraph inside aDivat the beginning of the admonition with classadmonition-title. This is about as close as we can get to RST’s own output. -
Initial support of
.. tabledirective. This allows adding captions to tables. -
Support
.. line-blockdirective. This is deprecated but may still be in older documents. -
Support scale and align attributes of images (#2662).
-
Implemented implicit internal header links (#3475).
-
Support RST-style citations (#853). The citations appear at the end of the document as a definition list in a special div with id
citations. Citations link to the definitions. -
Recurse into bodies of unknown directives (#3432). In most cases it’s better to preserve the content than to emit it. This isn’t guaranteed to have good results; it will fail spectacularly for unknown raw or verbatim directives.
-
Handle chained link definitions (#262). For example,
.. _hello: .. _goodbye: example.comHere both
helloandgoodbyeshould link toexample.com. -
Support anchors (#262). E.g.
`hello` .. _hello: paragraphThis is supported by putting “paragraph” in a
Divwith idhello. -
Support
:widths:attribute for table directive. -
Implement csv-table directive (#3533). Most attributes are supported, including
:file:and:url:. -
Support unknown interpreted text roles by parsing them as Span with “role” attributes (#3407). This way they can be manipulated in the AST.
-
-
HTML reader: parse a span with class
smallcapsasSmallCaps. -
LaTeX reader:
- Implemented
\graphicspath(#736). - Properly handle column prefixes/suffixes. For example, in
\begin{tabular}{>{$}l<{$}>{$}l<{$} >{$}l<{$}}each cell will be interpreted as if it has a$before its content and a$after (math mode). - Handle komascript
\dedication(#1845). It now adds adedicationfield to metadata. It is up to the user to supply a template that uses this variable. - Support all
\textXXcommands, where XX =rm,tt,up,md,sf,bf(#3488). Spans with a class are used when there is nothing better. - Expand
\newenvironmentmacros (#987). - Add support for LaTeX subfiles package (Marc Schreiber, #3530).
- Better support for subfigure package (#3577). A figure with two subfigures turns into two pandoc figures; the subcaptions are used and the main caption ignored, unless there are no subcaptions.
- Add support for
\vdots(Marc Schreiber, #3607). - Add basic support for hyphenat package (Marc Schreiber, #3603).
- Add basic
\textcolorsupport (Marc Schreiber). - Add support for
tabularxenvironment (Marc Schreiber, #3632). - Better handling of comments inside math environments (#3113).
This solves a problem with commented out
\end{eqnarray}inside an eqnarray (among other things). - Parse tikzpicture as raw verbatim environment if
raw_texextension is selected (#3692). Otherwise skip with a warning. This is better than trying to parse it as text! - Add
\colorboxsupport (Marc Schreiber). - Set identifiers on Spans used for
\label. - Have
\setmainlanguagesetlangin metadata. - Support etoolbox’s
\ifstrequal. - Support
plainbreak,fancybreaket al from the memoir class (bucklereed, #3833). - Support
\let. Also, fix regular macros so they’re expanded at the point of use, and NOT also the point of definition.\letmacros, by contrast, are expanded at the point of definition. Added anExpansionPointfield toMacroto track this difference. - Support simple
\defmacros. Note that we still don’t support macros with fancy parameter delimiters, like\def\foo#1..#2{...}. - Support
\chaptername,\partname,\abstractname, etc. (#3559, obsoletes #3560). - Put content of
\ref,\label,\eqrefcommands intoSpanwith attributes, so they can be handled in filters (Marc Schreiber, #3639) - Add Support for
glossariesandacronympackage (Marc Schreiber, #3589). Acronyms are not resolved by the reader, but acronym and glossary information is put into attributes on Spans so that they can be processed in filters. - Use
Linkinstead ofSpanfor\ref. This makes more sense semantically and avoids unnecessarySpan [Link]nestings when references are resolved. - Rudimentary support for
\hyperlink. - Support
\textquoteleft|right,\textquotedblleft|right(#3849). - Support
\lq,\rq. - Implement
\newtoggle,\iftoggle,\toggletrue|falsefrom etoolbox (#3853). - Support
\RNand\Rn, from biblatex (bucklereed, #3854). - Improved support for
\hyperlink,\hypertarget(#2549). - Support
\kogonek accent. - Improve handling of accents. Handle ogonek, and fall back correctly
with forms like
\"{}. - Better support for ogonek accents.
- Support for
\faCheckand\faClose(Marc Schreiber, #3727). - Support for
xspace(Marc Schreiber, #3797). - Support
\setmainlanguageor\setdefaultlanguage(polyglossia) and\figurename. - Better handling of
\partin LaTeX (#1905). Now we parse chapters as level 0 headers, and parts as level -1 headers. After parsing, we check for the lowest header level, and if it’s less than 1 we bump everything up so that 1 is the lowest header level. So\partwill always produce a header; no command-line options are needed. - Add block version of
\textcolor(Marc Schreiber). \textcolorworks as inline and block command (Marc Schreiber).\textcolorwill be parse as span at the beginning of a paragraph (Marc Schreiber).- Read polyglossia/babel
\text(LANG){...}(bucklereed) - Improved handling of include files in LaTeX reader (#3971).
Previously
\includewouldn’t work if the included file contained, e.g., a begin without a matching end. - Support
\expandafter(#3983). - Handle
\DeclareRobustCommand(#3983). Currently it’s just treated as a synonym for\newcommand. - Handle
\lettrine(Mauro Bieg).
- Implemented
-
Math improvements due to updates in texmath:
- Improved handling of accents and upper/lower delimiters.
- Support for output in GNU eqn format (used with *roff).
- Allow
\boldsymbol+ a token without braces, and similarly with other styling commands. - Improve parsing of
\mathopto allow multi-character operator names. - Add thin space after math operators when “faking it with unicode.”
-
walkis now used instead ofbottomUpin theToJSONFilterinstance fora -> [a](pandoc-types). Note that behavior will be slightly different, sincebottomUp’s treatment of a function[a] -> [a]is to apply it to each sublist of a list, while walk applies it only to maximal sublists. Usually the latter behavior is what is wanted, and the former can be simulated when needed. But there may be existing filters that need to be rewritten in light of the new behavior. Performance should be improved. -
There are some changes to syntax highlighting due to revisions in the
skylightinglibrary:- Support for
powershellhas been added, and many syntax definitions have been updated. - Background colors have been added to the
katestyle. - The way highlighted code blocks are formatted in HTML has been changed (David Baynard), in ways that may require changes in hard-coded CSS affecting highlighting. (If you haven’t included hard-coded highlighting CSS in your template, you needn’t change anything.)
- Support for
-
New module
Text.Pandoc.Class(Jesse Rosenthal, John MacFarlane). This contains definitions of thePandocMonadtypeclass, thePandocIOandPandocPuremonads, and associated functions. -
Changed types of all writers and readers.
- We now use
Textinstead ofStringin the interface (#3731). (We have not yet changed the internals of most readers to work withText, but making this change in the API now opens up a path to doing that.) - The result is now of form
m awith constraintPandocMonad m. Readers and writers can be combined to form monadic values which can be run using eitherrunIOorrunPure. IfrunIOis used, then both readers and writers will be able to do IO when needed (for include files, for example); ifrunPureis used, then the functions are pure and will not touch IO. - Where previously you used
writeRST def (readMarkdown def "[foo](url)"), now you would userunPure $ readMarkdown def (pack "[foo](url)") >>= writeRST def.
- We now use
-
New module
Text.Pandoc.Readers(Albert Krewinkel). This contains reader helper functions formerly defined in the top-levelText.Pandocmodule.- Changed
StringReader->TextReader. getReadernow returns a pair of a reader andExtensions, instead of building the extensions into the reader (#3659). The calling code must explicitly setreaderExtensionsusing theExtensionsreturned. The point of the change is to make it possible for the calling code to determine what extensions are being used.
- Changed
-
New module
Text.Pandoc.Writers(Albert Krewinkel). This contains writer helper functions formerly defined in the top-levelText.Pandocmodule.- Changed
StringWriter->TextWriter. getWriternow returns a pair of a reader andExtensions, instead of building the extensions into the reader (#3659). The calling code must explicitly setreaderExtensionsusing theExtensionsreturned. The point of the change is to make it possible for the calling code to determine what extensions are being used.
- Changed
-
New module
Text.Pandoc.Lua, exportingrunLuaFilter(Albert Krewinkel, #3514). -
New module
Text.Pandoc.App. This abstracts out the functionality of the command line program (convertWithOpts), so it can be reproduced e.g. in a desktop or web application. Instead of exiting, we throw errors (#3548), which are caught (leading to exit) in pandoc.hs, but allow other users ofText.Pandoc.Appto recover.pandoc.hsis now a 2-liner. The module also exports some utility functions for parsing options and running filters. -
New module
Text.Pandoc.Logging(exported module) (#3392). This now contains theVerbositydefinition previously inText.Pandoc.Options, as well as a newLogMessagedatatype that will eventually be used instead of raw strings for warnings. This will enable us, among other things, to provide machine-readable warnings if desired. Include ToJSON instance and showLogMessage. This gives us the possibility of both machine-readable and human-readable output for log messages. -
New module
Text.Pandoc.BCP47, withgetLang,Lang(..),parseBCP47. -
New module
Text.Pandoc.Translations, exportingTerm,Translations,readTranslations. -
New module
Text.Pandoc.Readers.LaTeX.Types', exportingMacro,Tok,TokType,Line,Column`. -
Text.Pandoc.Error: added many new constructors forPandocError. -
Expose some previously private modules (#3260). These are often helpful to people writing their own reader or writer modules:
Text.Pandoc.Writers.SharedText.Pandoc.ParsingText.Pandoc.AsciifyText.Pandoc.EmojiText.Pandoc.ImageSizeText.Pandoc.Highlighting`
-
New module
Text.Pandoc.Extensions(Albert Krewinkel): Extension parsing and processing functions were defined in the top-levelText.Pandocmodule. These functions are moved to the Extensions submodule as to enable reuse in other submodules. -
Add
Ext_raw_attributeconstructor forExtension. -
Add
Ext_fenced_divsconstructor for `Extension’. -
Add
Ext_four_space_ruleconstructor inExtension. -
Add
Ext_gfm_auto_identifiersconstructor forExtension. -
Add
Monoidinstance forExtensions. -
Add
Text.Pandoc.Writers.Ms, exportingwriteMs. -
Add
Text.Pandoc.Writers.JATS, exportingwriteJATS. -
Add
Text.Pandoc.Writers.Muse, exportingwriteMuse. -
Add
Text.Pandoc.Readers.Muse, exportingreadMuse. -
Add
Text.Pandoc.Readers.TikiWiki, exportingreadTikiWiki. -
Add
Text.Pandoc.Readers.Vimwiki, exportingreadVimwiki. -
Add
Text.Pandoc.Readers.Creole, exportingreadCreole. -
Export
setVerbosityfromText.Pandoc. -
Text.Pandoc.Pretty: AddEqinstance forDoc. -
Text.Pandoc.XML:toEntities: changed type toText -> Text. -
Text.Pandoc.UTF8:- Export
fromText,fromTextLazy,toText,toTextLazy. DefinetoString,toStringLazyin terms of them. - Add new functions parameterized on
Newline:writeFileWith,putStrWith,putStrLnWith,hPutStrWith,hPutStrLnWith.
- Export
-
Text.Pandoc.MediaBag: removedextractMediaBag. -
Text.Pandoc.Highlighting:highlightingnow returns an Either rather than Maybe. This allows us to display error information returned by the skylighting library. Display a warning if the highlighting library throws an error.- Add parameter for
SyntaxMaptohighlight.
-
Text.Pandoc.Writers.Math:- Export
defaultMathJaxURL,defaultKaTeXURL. This will ensure that we only need to update these in one place.
- Export
-
Text.Pandoc.SelfContained:- Removed
WriterOptionsparameter frommakeSelfContained. - Put
makeSelfContainedin PandocMonad instead of IO. This removes the need to pass MediaBag around and improves exceptions. It also opens up the possibility of using makeSelfContained purely. - Export
makeDataURI.
- Removed
-
Text.Pandoc.ImageSize:- Export
lengthToDim, new functionscaleDimension. - Export
inEmfrom ImageSize (#3450). - Change
showFlandshowinstance forDimensionso extra decimal places are omitted. - Added
Emas a constructor ofDimension. - Add
WriterOptionsparameter toimageSizesignature (Mauro Bieg).
- Export
-
Text.Pandoc.Templates:- Change type of
renderTemplate'. Now it runs inPandocMonadand raises a properPandocTemplateErrorif there are problems, rather than failing with uncatchableerror. - Change signature of
getDefaultTemplate. Now it runs in any instance ofPandocMonad, and returns aStringrather than anEithervalue. And it no longer takes adatadirparameter, since this can be retrieved fromCommonState.
- Change type of
-
Text.Pandoc.Options:- Added
writerEpubSubdirectorytoWriterOptions(#3720). The EPUB writer now takes its EPUB subdirectory from this option. - In
WriterOptions, renamewriterLaTeXEnginetowriterPdfEngineandwriterLaTeXArgstowriterPdfArgs(Mauro Bieg, #3909). - Add
writerSyntaxMaptoWriterOptions. - Removed
writerEpubStylesheetfromWriterOptions. - Remove
writerUserDataDirfromWriterOptions. It is now carried inCommonStateinPandocMonadinstances. (And thus it can be used by readers too.) - Changed
writerEpubMetadatato aMaybe String. - Removed
readerApplyMacrosfromReaderOptions. Now we just check thelatex_macrosreader extension. - FromJSON/ToJSON instances for
ReaderOptions. - In
HTMLMathMethod, theKaTeXcontsructor now takes only one string (for the KaTeX base URL), rather than two. - Removed
writerSourceURLfromWriterOptions. We now usestSourceURLinCommonState, which is set bysetInputFiles.
- Added
-
Text.Pandoc.Shared:tabFilternow takes aText, notString.openURL: Changed type from an Either. Now it will just raise an exception to be trapped later.- Remove
normalizeSpaces(#1530). - Remove
warn. (UsereportfromText.Pandoc.Classinstead.) - Export a new function
crFilter. - Add
eastAsianLineBreakFilter(previously in Markdown reader). - Provide custom
isURIthat rejects unknown schemes. (Albert Krewinkel, #2713). We also export the set of knownschemes. The new function replaces the function of the same name fromNetwork.URI, as the latter did not check whether a scheme is well-known. All official IANA schemes (as of 2017-05-22) are included in the set of known schemes. The four non-official schemesdoi,isbn,javascript, andpmidare kept. - Remove
err. - Remove
readDataFile,readDefaultDataFile,getReferenceDocx,getReferenceODT. These now live inText.Pandoc.Class, where they are defined in terms ofPandocMonadprimitives and have different signatures. - Remove
openURL. UseopenURLfromText.Pandoc.Classinstead. - Add
underlineSpan.
-
Text.Pandoc.Readers.HTML: export newNamedTagclass. -
Text.Pandoc.Readers.Markdown: removereadDocxWithWarnings. With the new API one can simply usegetLogafter running the reader. -
Text.Pandoc.Readers.LaTeX: Changed types forrawLaTeXInlineandrawLaTeXBlock. (Both now return aString, and they are polymorphic in state.)
-
Removed
data/templatessubmodule. Templates are now a subtree indata/templates. This removes the need to dogit submodule update. -
Renamed
tests->test. -
Remove
httpsflag. Always build with HTTPS support. -
Use
file-embedinstead ofhsb2hsto embed data files whenembed_data_filesflag is set.file-embedgives us better dependency tracking: if a data file changes, ghc/stack/cabal know to recompile the Data module. This also removeshsb2hsas a build dependency. -
Add
custom-setupstanza to pandoc, lowercase field names. -
Add
staticCabal flag. -
Name change OSX -> MacOS. Add a -MacOS suffix to mac package rather than -OSX. Changed local names from osx to macos.
-
make_macos_package.sh - Use strip to reduce executable size.
-
Revised binary linux package. Now a completely static executable is created, using Docker and alpine. We create both a deb and a tarball. The old
debdirectory has been replaced with alinuxdirectory. Runningmakein thelinuxdirectory should perform the build, putting the binary packages inartifacts/. -
linux/control.in: addReplaces:, so existing pandoc-citeproc and pandoc-data packages will be uninstalled; this package provides both (#3822). Add latex packages as ‘suggested’, update description. -
Remove cpphs build requirement – it is no longer needed.
-
Replaced
{deb,macos,windows}/stack.yamlwithstack.pkg.yaml. -
Name change OSX -> macOS (ickc, #3869).
-
Fix casing of Linux, UNIX, and Windows (ickc).
-
.travis.yml: create a source dist and do cabal build and test there. That way we catch errors due to files missing from the data section of pandoc.cabal. -
Makefile:
- Split
make haddockfrommake full. - Add BRANCH variable for winpkg.
- Add
linttarget. - Improve
make full. Disable optimizations. Build everything, inc. trypandoc and benchmarks. Use parallel build. - Allow
make testto takeTESTARGS.
- Split
-
Added new command tests (
Tests.Command), using small text files intest/command/. Any files added in this directory will be treated as shell tests (see smart.md for an example). This makes it very easy to add regression tests etc. -
Test fixes so we can find data files. In old tests & command tests, we now set the environment variable
pandoc_datadir. In lua tests, we set the datadir explicitly. -
Refactored
compareOutputin docx writer test. -
Consolidated some common functions in
Tests.Helper. -
Small change to unbalanced bracket test to speed up test suite.
-
Speed up Native writer quickcheck tests.
-
Use tasty for tests rather than test-framework.
-
Add simple Emacs mode to help with Pandoc templates editing. (Václav Haisman, #3889).
tools/pandoc-template-mode.el
-
Use skylighting library instead of highlighting-kate for syntax highlighting. Skylighting is faster and more accurate (#3363). Later we’ll be able to add features like warning messages, dynamic loading of xml syntax definitions, and dynamic loading of themes.
-
Added a new highlight style,
breezeDark. -
Text.Pandoc.Highlighting: Update list of
listingslanguages (#3374). This allows more languages to be used when using the--listingsoption. -
OpenDocument writer:
- Small refactoring. Removed separate ‘parent’ parameter in paraStyle.
- Don’t profilerate text styles unnecessarily (#3371). This change makes the writer create only as many temporary text styles as are absolutely necessary. It also consolidates adjacent nodes with the same style.
-
Org reader (Albert Krewinkel):
- Allow short hand for single-line raw blocks (Albert Krewinkel,
#3366). Single-line raw blocks can be given via
#+FORMAT: raw line, whereFORMATmust be one oflatex,beamer,html, ortexinfo. - Accept org-ref citations followed by commas (Albert Krewinkel). Bugfix for an issue which, whenever the citation was immediately followed by a comma, prevented correct parsing of org-ref citations.
- Ensure emphasis markup can be nested. Nested emphasis markup (e.g.
/*strong and emphasized*/) was interpreted incorrectly in that the inner markup was not recognized. - Remove pipe char irking the haddock coverage tool (Albert Krewinkel).
- Allow short hand for single-line raw blocks (Albert Krewinkel,
#3366). Single-line raw blocks can be given via
-
Docx reader: Empty header should be list of lists (Jesse Rosenthal). In the past, the docx reader wrote an empty header as an empty list. It should have the same width as a row (and be filled with empty cells).
-
MediaWiki reader:
- Improved handling of display math (#3362). Sometimes display math is indented with more than one colon. Previously we handled these cases badly, generating definition lists and missing the math.
- Fix quotation mark parsing (#3336, tgkokk). Change MediaWiki reader’s behavior when the smart option is parsed to match other readers’ behavior.
-
Markdown reader:
- Fixed
-f markdown_github-hard_line_breaks+escaped_line_breaks(#3341). Previously this did not properly enable escaped line breaks. - Disallow space between inline code and attributes (#3326, #3323, Mauro Bieg).
- Fixed
-
DocBook5 writer: make id attribute xml:id, fixes #3329 (#3330, Mauro Bieg).
-
Added some test cases for ODT reader (#3306, #3308, Hubert Plociniczak).
-
LaTeX writer: allow tables with empty cells to count as “plain.” This addresses a problem of too-wide tables when empty cells are used. Thanks to Joost Kremers for reporting the issue.
-
Org writer: prefix footnote numbers with
fn:(Albert Krewinkel). Unprefixed numbers where used by older org-mode versions, but are no longer supported. -
HTML writer: don’t process pars with empty RawInline, (#1040, #3327, Mauro Bieg).
-
Markdown writer: Fix display math with
--webtex(#3298). -
Fix sample.lua so it properly handles raw blocks/inlines (#3358, bumper314).
-
Templates:
- default.latex: Moved geometry after hyperref (Václav Haisman). Otherwise PDF sizes can be wrong in some circumstances.
- Copied a few changes from default.latex to default.beamer (Wandmalfarbe).
- default.latex, default.beamer: Changed position of
\VerbatimNotesandfancyvrb. This fixes hyperlinks on footnotes in documents that contain verbatim in notes (#3361). (Note: the beamer template was updated to match the LaTeX template, but at this point verbatim in notes seems not to work in beamer.) - default.latex: Allow passing
microtypeoptionsto microtype (Václav Haisman). - default.latex: Add hyphen option to url package.
- default.docbook5: Fix namespace declarations (Mauro Bieg).
-
Moved
make_osx_package.shtoosx/directory. -
Travis continuous integration:
- Fix false positives with dist build.
- Speed improvements (Kolen Cheung, #3304, #3357).
-
MANUAL.txt:
- Clarify that blank space is needed around footnotes (#3352).
- Fixed typo (#3351, Alexey Rogechev).
- Note that
--wrap=autodoes not work in HTML output. - Default
--columnswidth is 72, not 80. - Fixed broken links (#3316, Kolen Cheung).
- Document usage of
@*in nocite section (#3333, John Muccigrosso).
-
INSTALL.md:
- Indent code so it’s properly formatted (#3335, Bheesham Persaud).
- Added instructions for extracting binary from OSX, Windows packages.
-
CONTRIBUTING.md: Describe labels currently used in issue tracker (Albert Krewinkel). The labels have changed over time, the list of labels is updated to reflect the current set of labels used in the issue tracker.
-
Rearrange and extend badges in README (Albert Krewinkel, #3354)
-
Bumped version bounds for dependencies.
-
Changed resolution of filter paths.
- We now first treat the argument of
--filteras a full (absolute or relative) path, looking for a program there. If it’s found, we run it. - If not, and if it is a simple program name or a relative path, we
try resolving it relative to
$DATADIR/filters. - If this fails, then we treat it as a program name and look in the user’s PATH.
- Removed a hardcoded ‘/’ that may have caused problems with Windows paths.
Previously if you did
--filter fooand you hadfooin your path and also an executablefooin your working directory, the one in the path would be used. Now the one in the working directory is used.In addition, when you do
--filter foo/bar.hs, pandoc will now find a filter$DATADIR/filters/foo/bar.hs– assuming there isn’t afoo/bar.hsrelative to the working directory. - We now first treat the argument of
-
Allow
file://URIs as arguments (#3196). Also improved default reader format detection. Previously with a URI ending in .md or .markdown, pandoc would assume HTML input. Now it treats these as markdown. -
Allow to overwrite top-level division type heuristics (#3258, Albert Krewinkel). Pandoc uses heuristics to determine the most reasonable top-level division type when emitting LaTeX or Docbook markup. It is now possible to overwrite this implicitly set top-level division via the
top-level-divisioncommand line parameter. -
Text.Pandoc.Options [API changes]:
- Removed
writerStandalonefield inWriterOptions, madewriterTemplateaMaybevalue. Previously settingwriterStandalone = Truedid nothing unless a template was provided in writerTemplate. Now a fragment will be generated ifwriterTemplateisNothing; otherwise, the specified template will be used and standalone output generated. Divisionhas been renamedTopLevelDivision(#3197). TheSection,Chapter, andPartconstructors were renamed toTopLevelSection,TopLevelChapter, andTopLevelPart, respectively. An additionalTopLevelDefaultconstructor was added, which is now also the new default value of thewriterTopLevelDivisionfield inWriterOptions.
- Removed
-
Improved error if they give wrong arg to
--top-level-division. -
Use new module from texmath to lookup MS font codepoints in Docx reader. Removed unexported module Text.Pandoc.Readers.Docx.Fonts. Its code now lives in texmath (0.9).
-
DocBook reader: Fixed xref lookup (#3243). It previously only worked when the qnames lacked the docbook namespace URI.
-
HTML reader:
- Improved table parsing (#3027). We now check explicitly for non-1 rowspan or colspan attributes, and fail when we encounter them. Previously we checked that each row had the same number of cells, but that could be true even with rowspans/colspans. And there are cases where it isn’t true in tables that we can handle fine – e.g. when a tr element is empty. So now we just pad rows with empty cells when needed.
- Treat
<math>as MathML by default unless something else is explicitly specified in xmlns. Provided it parses as MathML, of course. Also fixed default which should be to inline math if no display attribute is used. - Only treat “a” element as link if it has href (#3226). Otherwise treat as span.
-
Docx reader (Jesse Rosenthal):
- Add a placeholder value for CHART. We wrap
[CHART]in a<span class="chart">. Note that it maps to inlines because, in docx, anything in a drawing tag can be part of a larger paragraph. - Be more specific in parsing images We not only want
w:drawing, because that could also include charts. Now we specifyw:drawing/pic:pic. This shouldn’t change behavior at all, but it’s a first step toward allowing other sorts of drawing data as well. - Abstract out function to avoid code repetition.
- Update tests for img title and alt (#3204).
- Handle Alt text and titles in images. We use the “description” field as alt text and the “title” field as title. These can be accessed through the “Format Picture” dialog in Word.
- Docx reader utils: handle empty namespace in
elemName. Previously, if given an empty namespace(elemName ns "" "foo")elemNamewould output a QName with aJust ""namespace. This is never what we want. Now we output aNothing. If someone does want aJust ""in the namespace, they can enter the QName value explicitly.
- Add a placeholder value for CHART. We wrap
-
ODT reader/writer:
-
Inline code when text has a special style (Hubert Plociniczak). When a piece of text has a text
Source_Textthen we assume that this is a piece of the document that represents a code that needs to be inlined. Adapted the writer to also reflect that change. Previously it was just writing a ‘preformatted’ text using a non-distinguishable font style. Code blocks are still not recognized by the ODT reader. That’s a separate issue. -
Infer table’s caption from the paragraph (#3224, Hubert Plociniczak). ODT’s reader always put empty captions for the parsed tables. This commit
- checks paragraphs that follow the table definition
- treats specially a paragraph with a style named ‘Table’
- does some postprocessing of the paragraphs that combines tables followed immediately by captions
The ODT writer used the
TableCaptionstyle for the caption paragraph. This commit follows the OpenOffice approach which allows for appending captions to table but uses a built-in style namedTableinstead ofTableCaption. Users of a customreference.odtshould change the style’s name fromTableCaptiontoTable.
-
-
ODT reader: Infer tables’ header props from rows (#3199, Hubert Plociniczak). ODT reader simply provided an empty header list which meant that the contents of the whole table, even if not empty, was simply ignored. While we still do not infer headers we at least have to provide default properties of columns.
-
Markdown reader:
-
Allow reference link labels starting with
@...ifcitationsextension disabled (#3209). Example: in\[link text\]\[@a\]link textisn’t hyperlinked because[@a]is parsed as a citation. Previously this happened whether or not thecitationsextension was enabled. Now it happens only if thecitationsextension is enabled. -
Allow alignments to be specified in Markdown grid tables. For example,
+-------+---------------+--------------------+ | Right | Left | Centered | +=========:+:=================+:=============:+ | Bananas | $1.34 | built-in wrapper | +-------+---------------+--------------------+ -
Allow Small Caps elements to be created using bracketed spans (as they already can be using HTML-syntax spans) (#3191, Kolen Cheung).
-
-
LaTeX reader:
- Don’t treat
\vspaceand\hspaceas block commands (#3256). Fixed an error which came up, for example, with\vspaceinside a caption. (Captions expect inlines.) - Improved table handling. We can now parse all of the tables emitted by pandoc in our tests. The only thing we don’t get yet are alignments and column widths in more complex tables. See #2669.
- Limited support for minipage.
- Allow for
[]s inside LaTeX optional args. Fixes cases like: - Handle BVerbatim from fancyvrb (#3203).
- Handle hungarumlaut (#3201).
- Allow beamer-style
<...>options in raw LaTeX (also in Markdown) (#3184). This allows use of things like\only<2,3>{my content}in Markdown that is going to be converted to beamer.
- Don’t treat
-
Use pre-wrap for code in dzslides template (Nicolas Porcel). Otherwise overly long code will appear on every slide.
-
Org reader (Albert Krewinkel):
-
Respect column width settings (#3246). Table column properties can optionally specify a column’s width with which it is displayed in the buffer. Some exporters, notably the ODT exporter in org-mode v9.0, use these values to calculate relative column widths. The org reader now implements the same behavior. Note that the org-mode LaTeX and HTML exporters in Emacs don’t support this feature yet, which should be kept in mind by users who use the column widths parameters.
-
Allow HTML attribs on non-figure images (#3222). Images which are the only element in a paragraph can still be given HTML attributes, even if the image does not have a caption and is hence not a figure. The following will add set the
widthattribute of the image to50%:+ATTR\_HTML: :width 50% ======================= \[\[file:image.jpg\]\] -
Support
ATTR_HTMLfor special blocks (#3182). Special blocks (i.e. blocks with unrecognized names) can be prefixed with anATTR_HTMLblock attribute. The attributes defined in that meta-directive are added to theDivwhich is used to represent the special block. -
Support the
todoexport option. Thetodoexport option allows to toggle the inclusion of TODO keywords in the output. Setting this tonilcauses TODO keywords to be dropped from headlines. The default is to include the keywords. -
Add support for todo-markers. Headlines can have optional todo-markers which can be controlled via the
#+TODO,#+SEQ_TODO, or#+TYP_TODOmeta directive. Multiple such directives can be given, each adding a new set of recognized todo-markers. If no custom todo-markers are defined, the defaultTODOandDONEmarkers are used. Todo-markers are conceptually separate from headline text and are hence excluded when autogenerating headline IDs. The markers are rendered as spans and labelled with two classes: One class is the markers name, the other signals the todo-state of the marker (eithertodoordone).
-
-
LaTeX writer:
- Use
\autocites*when “suppress-author” citation used. - Ensure that simple tables have simple cells (#2666). If cells contain more than a single Plain or Para, then we need to set nonzero widths and put contents into minipages.
- Remove invalid inlines in sections (#3218, Hubert Plociniczak).
- Use
-
Markdown writer:
- Fix calculation of column widths for aligned multiline tables
(#1911, Björn Peemöller). This also fixes excessive CPU and memory
usage for tables when
--columnsis set in such a way that cells must be very tiny. Now cells are guaranteed to be big enough so that single words don’t need to line break, even if this pushes the line length above the column width. - Use bracketed form for native spans when
bracketed_spansenabled (#3229). - Fixed inconsistent spacing issue (#3232). Previously a tight bullet sublist got rendered with a blank line after, while a tight ordered sublist did not. Now we don’t get the blank line in either case.
- Fix escaping of spaces in super/subscript (#3225). Previously two backslashes were inserted, which gave a literal backslash.
- Adjust widths in Markdown grid tables so that they match on round-trip.
- Fix calculation of column widths for aligned multiline tables
(#1911, Björn Peemöller). This also fixes excessive CPU and memory
usage for tables when
-
Docx writer:
- Give full detail when there are errors converting tex math.
- Handle title text in images (Jesse Rosenthal). We already handled alt text. This just puts the image “title” into the docx “title” attr.
- Fixed XML markup for empty cells (#3238). Previously the Compact style wasn’t being applied properly to empty cells.
-
HTML writer:
- Updated
renderHtmlimport from blaze-html.
- Updated
-
Text.Pandoc.Pretty:
- Fixed some bugs that caused blank lines in tables (#3251). The bugs
caused spurious blank lines in grid tables when we had things like
blankline $$ blankline. - Add exported function
minOffet[API change] (Björn Peemöller). - Added error message for illegal call to
block(Björn Peemöller).
- Fixed some bugs that caused blank lines in tables (#3251). The bugs
caused spurious blank lines in grid tables when we had things like
-
Text.Pandoc.Shared:
- Put
warnin MonadIO. fetchItem: Better handling of protocol-relative URL (#2635). If URL starts with//and there is no “base URL” (as there would be if a URL were used on the command line), then default to http:.
- Put
-
Export Text.Pandoc.getDefaultExtensions [API change] (#3178).
-
In –version, trap error in
getAppUserDataDirectory(#3241). This fixes a crash withpandoc --versionon unusual systems with no real user (e.g. SQL Server 2016). -
Added weigh-pandoc for memory usage diagnostics (#3169).
-
Use correct mime types for woff and woff2 (#3228).
-
Remove make_travis_yml.hs (#3235, Kolen Cheung).
-
changelog: Moved an item that was misplaced in the 1.17.2 section to the 1.18 section where it belongs.
-
CONTRIBUTING.md: minor change in wording and punctuation (#3252, Kolen Cheung).
-
Further revisions to manual for
--versionchanges (#3244).
-
Added
--list-input-formats,--list-output-formats,--list-extensions,--list-highlight-languages, and--list-highlight-styles(#3173). Removed list of highlighting languages from--versionoutput. Removed list of input and output formats from default--helpoutput. -
Added
--reference-location=block|section|documentoption (Jesse Rosenthal). This determines whether Markdown link references and footnotes are placed at the end of the document, the end of the section, or the end of the top-level block. -
Added
--top-level-division=section|chapter|part(Albert Krewinkel). This determines what a level-1 header corresponds to in LaTeX, ConTeXt, DocBook, and TEI output. The default issection. The--chaptersoption has been deprecated in favor of--top-level-division=chapter. -
Added
LineBlockconstructor forBlock(Albert Krewinkel). This is now used in parsing RST and Markdown line blocks, DocBooklinegroup/linecombinations, and Org-modeVERSEblocks. PreviouslyParablocks with hard linebreaks were used.LineBlocks are handled specially in the following output formats: AsciiDoc (as[verse]blocks), ConTeXt (\startlines/\endlines), HTML (divwith a style), Markdown (line blocks ifline_blocksis enabled), Org-mode (VERSEblocks), RST (line blocks). In other output formats, a paragraph with hard linebreaks is emitted. -
Allow binary formats to be written to stdout (but not to tty) (#2677). Only works on posix, since we use the unix library to check whether output is to tty. On Windows, pandoc works as before and always requires an output file parameter for binary formats.
-
Changed JSON output format (Jesse Rosenthal). Previously we used generically generated JSON, but this was subject to change depending on the version of aeson pandoc was compiled with. To ensure stability, we switched to using manually written ToJSON and FromJSON instances, and encoding the API version. Note: pandoc filter libraries will need to be revised to handle the format change. Here is a summary of the essential changes:
- The toplevel JSON format is now
{"pandoc-api-version" : [MAJ, MIN, REV], "meta" : META, "blocks": BLOCKS}instead of[{"unMeta": META}, [BLOCKS]]. Decoding fails if the major and minor version numbers don’t match. - Leaf nodes no longer have an empty array for their “c” value.
Thus, for example, a
Spaceis encoded as{"t":"Space"}rather than{"t":"Space","c":[]}as before.
- The toplevel JSON format is now
-
Removed
tests/Tests/Arbitrary.hsand added aText.Pandoc.Arbitrarymodule to pandoc-types (Jesse Rosenthal). This makes it easier to use QuickCheck with pandoc types outside of pandoc itself. -
Add
bracketed_spansMarkdown extension, enabled by default in pandocmarkdown. This allows you to create a native span using this syntax:[Here is my span]{#id .class key="val"}. -
Added
angle_brackets_escapableMarkdown extension (#2846). This is needed because github flavored Markdown has a slightly different set of escapable symbols than original Markdown; it includes angle brackets. -
Export
Text.Pandoc.ErrorinText.Pandoc[API change]. -
Print highlighting-kate version in
--version. -
Text.Pandoc.Options:Extensionhas new constructorsExt_brackted_spansandExt_angle_brackets_escapable[API change].- Added
ReferenceLocationtype [API change] (Jesse Rosenthal). - Added
writerReferenceLocationfield toWriterOptions(Jesse Rosenthal).
-
--filter: we now check$DATADIR/filtersfor filters before looking in the path (#3127, Jesse Rosenthal, thanks to Jakob Voß for the idea). Filters placed in this directory need not be executable; if the extension is.hs,.php,.pl,.js, or.rb, pandoc will run the right interpreter. -
For
--webtex, replace deprecated Google Chart API by CodeCogs as default (Kolen Cheung). -
Removed
raw_texextension frommarkdown_mmddefaults (Kolen Cheung). -
Execute .js filters with node (Jakob Voß).
-
Textile reader:
- Support
bc..extended code blocks (#3037). Also, remove trailing newline in code blocks (consistently with Markdown reader). - Improve table parsing. We now handle cell and row attributes, mostly by skipping them. However, alignments are now handled properly. Since in pandoc alignment is per-column, not per-cell, we try to devine column alignments from cell alignments. Table captions are also now parsed, and textile indicators for thead and tfoot no longer cause parse failure. (However, a row designated as tfoot will just be a regular row in pandoc.)
- Improve definition list parsing. We now allow multiple terms (which we concatenate with linebreaks). An exponential parsing bug (#3020) is also fixed.
- Disallow empty URL in explicit link (#3036).
- Support
-
RST reader:
- Use Div instead of BlockQuote for admonitions (#3031).
The Div has class
admonitionand (if relevant) one of the following:attention,caution,danger,error,hint,important,note,tip,warning. Note: This will change the rendering of some RST documents! The word (“Warning”, “Attention”, etc.) is no longer added; that must be done with CSS or a filter. - A Div is now used for
sidebaras well. - Skip whitespace before note (Jesse Rosenthal, #3163). RST requires a space before a footnote marker. We discard those spaces so that footnotes will be adjacent to the text that comes before it. This is in line with what rst2latex does.
- Allow empty lines when parsing line blocks (Albert Krewinkel).
- Use Div instead of BlockQuote for admonitions (#3031).
The Div has class
-
Markdown reader:
- Allow empty lines when parsing line blocks (Albert Krewinkel).
- Allow attributes on autolinks (#3183, Daniele D’Orazio).
-
LaTeX reader:
- More robust parsing of unknown environments (#3026).
We no longer fail on things like
^inside options for tikz. - Be more forgiving of non-standard characters, e.g.
^outside of math. Some custom environments give these a meaning, so we should try not to fall over when we encounter them. - Drop duplicate
*in bibtexKeyChars (Albert Krewinkel)
- More robust parsing of unknown environments (#3026).
We no longer fail on things like
-
MediaWiki reader:
- Fix for unquoted attribute values in mediawiki tables (#3053). Previously an unquoted attribute value in a table row could cause parsing problems.
- Improved treatment of verbatim constructions (#3055). Previously these yielded strings of alternating Code and Space elements; we now incorporate the spaces into the Code. Emphasis etc. is still possible inside these.
- Properly interpret XML tags in pre environments (#3042). They are meant to be interpreted as literal text.
-
EPUB reader: don’t add root path to data: URIs (#3150). Thanks to @lep for the bug report and patch.
-
Org reader (Albert Krewinkel):
- Preserve indentation of verse lines (#3064). Leading spaces in verse lines are converted to non-breaking spaces, so indentation is preserved.
- Ensure image sources are proper links. Image sources as those in plain
images, image links, or figures, must be proper URIs or relative file
paths to be recognized as images. This restriction is now enforced
for all image sources. This also fixes the reader’s usage of uncleaned
image sources, leading to
file:prefixes not being deleted from figure images. Thanks to @bsag for noticing this bug. - Trim verse lines properly (Albert Krewinkel).
- Extract meta parsing code to module. Parsing of meta-data is well separable from other block parsing tasks. Moving into new module to get small files and clearly arranged code.
- Read markup only for special meta keys. Most meta-keys should be read as normal string values, only a few are interpreted as marked-up text.
- Allow multiple, comma-separated authors. Multiple authors can be
specified in the
#+AUTHORmeta line if they are given as a comma-separated list. - Give precedence to later meta lines. The last meta-line of any given type is the significant line. Previously the value of the first line was kept, even if more lines of the same type were encountered.
- Read LaTeX_header as header-includes. LaTeX-specific header commands
can be defined in
#+LaTeX_headerlines. They are parsed as format-specific inlines to ensure that they will only show up in LaTeX output. - Set documentclass meta from LaTeX_class.
- Set classoption meta from LaTeX_class_options.
- Read HTML_head as header-includes. HTML-specific head content can be
defined in
#+HTML_headlines. They are parsed as format-specific inlines to ensure that they will only show up in HTML output. - Respect
authorexport option. Theauthoroption controls whether the author should be included in the final markup. Setting#+OPTIONS: author:nilwill drop the author from the final meta-data output. - Respect
emailexport option. Theemailoption controls whether the email meta-field should be included in the final markup. Setting#+OPTIONS: email:nilwill drop the email field from the final meta-data output. - Respect
creatorexport option. Thecreatoroption controls whether the creator meta-field should be included in the final markup. Setting#+OPTIONS: creator:nilwill drop the creator field from the final meta-data output. Org-mode recognizes the special valuecommentfor this field, causing the creator to be included in a comment. This is difficult to translate to Pandoc internals and is hence interpreted the same as other truish values (i.e. the meta field is kept if it’s present). - Respect unnumbered header property (#3095). Sections the
unnumberedproperty should, as the name implies, be excluded from the automatic numbering of section provided by some output formats. The Pandoc convention for this is to add an “unnumbered” class to the header. The reader treats properties as key-value pairs per default, so a special case is added to translate the above property to a class instead. - Allow figure with empty caption (Albert Krewinkel, #3161).
A
#+CAPTIONattribute before an image is enough to turn an image into a figure. This wasn’t the case because theparseFromStringfunction, which processes the caption value, would fail on empty values. Adding a newline character to the caption value fixes this.
-
Docx reader:
- Use XML convenience functions (Jesse Rosenthal).
The functions
isElemandelemName(defined in Docx/Util.hs) make the code a lot cleaner than the original XML.Light functions, but they had been used inconsistently. This puts them in wherever applicable. - Handle anchor spans with content in headers. Previously, we would only be able to figure out internal links to a header in a docx if the anchor span was empty. We change that to read the inlines out of the first anchor span in a header.
- Let headers use existing id. Previously we always generated an id for headers (since they wouldn’t bring one from Docx). Now we let it use an existing one if possible. This should allow us to recurs through anchor spans.
- Use all anchor spans for header ids. Previously we only used the first anchor span to affect header ids. This allows us to use all the anchor spans in a header, whether they’re nested or not (#3088).
- Test for nested anchor spans in header. This ensures that anchor spans in header with content (or with other anchor spans inside) will resolve to links to a header id properly.
- Use XML convenience functions (Jesse Rosenthal).
The functions
-
ODT reader (Hubert Plociniczak)
- Include list’s starting value. Previously the starting value of the lists’ items has been hardcoded to 1. In reality ODT’s list style definition can provide a new starting value in one of its attributes.
- Infer caption from the text following the image. Frame can contain other frames with the text boxes.
- Add
fig:to title for Image with a caption (as expected by pandoc’s writers). - Basic support for images in ODT documents.
- Don’t duplicate text for anchors (#3143). When creating an anchor element we were adding its representation as well as the original content, leading to text duplication.
-
DocBook writer:
- Include an anchor element when a div or span has an id (#3102). Note that DocBook does not have a class attribute, but at least this provides an anchor for internal links.
-
LaTeX writer:
- Don’t use * for unnumbered paragraph, subparagraph. The starred
variants don’t exist. This helps with part of #3058…it gets rid of
the spurious
*s. But we still have numbers on the 4th and 5th level headers. - Properly escape backticks in verbatim (#3121, Jesse Rosenthal).
Otherwise they can cause unintended ligatures like
?`. - Handle NARRAOW NO-BREAK SPACE into LaTeX (Vaclav Zeman) as
\,. - Don’t include
[htbp]placement for figures (#3103, Václav Haisman). This allows figure placement defaults to be changed by the user in the template.
- Don’t use * for unnumbered paragraph, subparagraph. The starred
variants don’t exist. This helps with part of #3058…it gets rid of
the spurious
-
TEI writer: remove heuristic to detect book template (Albert Krewinkel). TEI doesn’t have
<book>elements but only generic<divN>division elements. Checking the template for a trailing</book>is nonsensical. -
MediaWiki writer: transform filename with underscores in images (#3052).
foo bar.jpgbecomesfoo_bar.jpg. This was already done for internal links, but it also needs to happen for images. -
ICML writer: replace partial function (!!) in table handling (#3175, Mauro Bieg).
-
Man writer: allow section numbers that are not a single digit (#3089).
-
AsciiDoc writer: avoid unnecessary use of “unconstrained” emphasis (#3068). In AsciiDoc, you must use a special form of emphasis (double
__) for intraword emphasis. Pandoc was previously using this more than necessary. -
EPUB writer: use stringify instead of plain writer for metadata (#3066). This means that underscores won’t be used for emphasis, or CAPS for bold. The metadata fields will just have unadorned text.
-
Docx Writer:
- Implement user-defined styles (Jesse Rosenthal). Divs and Spans
with a
custom-stylekey in the attributes will apply the corresponding key to the contained blocks or inlines. - Add ReaderT env to the docx writer (Jesse Rosenthal).
- Clean up and streamline RTL behavior (Jesse Rosenthal, #3140).
You can set
dir: rtlin YAML metadata, or use-M dir=rtlon the command line. For finer-grained control, you can set thedirattribute in Div or Span elements.
- Implement user-defined styles (Jesse Rosenthal). Divs and Spans
with a
-
Org writer (Albert Krewinkel):
- Remove blank line after figure caption. Org-mode only treats an image as a figure if it is directly preceded by a caption.
- Ensure blank line after figure. An Org-mode figure should be surrounded by blank lines. The figure would be recognized regardless, but images in the following line would unintentionally be treated as figures as well.
- Ensure link targets are paths or URLs. Org-mode treats links as document internal searches unless the link target looks like a URL or file path, either relative or absolute. This change ensures that this is always the case.
- Translate language identifiers. Pandoc and Org-mode use different programming language identifiers. An additional translation between those identifiers is added to avoid unexpected behavior. This fixes a problem where language specific source code would sometimes be output as example code.
- Drop space before footnote markers (Albert Krewinkel, #3162). The writer no longer adds an extra space before footnote markers.
-
Markdown writer:
- Don’t emit HTML for tables unless
raw_htmlextension is set (#3154). Emit[TABLE]if no suitable table formats are enabled and raw HTML is disabled. - Check for the
raw_htmlextension before emitting a raw HTML block. - Abstract out note/ref function (Jesse Rosenthal).
- Add ReaderT monad for environment variables (Jesse Rosenthal).
- Don’t emit HTML for tables unless
-
HTML, EPUB, slidy, revealjs templates: Use
<p>instead of<h1>for subtitle, author, date (#3119). Note that, as a result of this change, authors may need to update CSS. -
revealjs template: Added
notes-serveroption (jgm/pandoc-templates#212, Yoan Blanc). -
Beamer template:
- Restore whitespace between paragraphs. This was a regression in the last release (jgm/pandoc-templates#207).
- Added
themeoptionsvariable (Carsten Gips). - Added
beamerarticlevariable. This causes thebeamerarticlepackage to be loaded in beamer, to produce an article from beamer slides. (Carsten Gips) - Added support for
fontfamiliesstructured variable (Artem Klevtsov). - Added hypersetup options (Jake Zimmerman).
-
LaTeX template:
- Added dummy definition for
\institute. This isn’t a standard command, and we want to avoid a crash wheninstituteis used with the default template. - Define default figure placement (Václav Haisman), since pandoc
no longer includes
[htbp]for figures. Users with custom templates will want to add this. See #3103. - Use footnote package to fix notes in tables (jgm/pandoc-templates#208, Václav Haisman).
- Added dummy definition for
-
Moved template compiling/rendering code to a separate library.
doctemplates. This allows the pandoc templating system to be used independently. -
Text.Pandoc.Error: Fix out of index error in
handleError(Matthew Pickering). The fix is to not try to show the exact line when it would cause an out-of-bounds error as a result of included files. -
Text.Pandoc.Shared: Add
linesToBlockfunction (Albert Krewinkel). -
Text.Pandoc.Parsing.emailAddress: tighten up parsing of email addresses. Technically
**@useris a valid email address, but if we allow things like this, we get bad results in markdown flavors that autolink raw email addresses (see #2940). So we exclude a few valid email addresses in order to avoid these more common bad cases. -
Text.Pandoc.PDF: Don’t crash with nonexistent image (#3100). Instead, emit the alt text, emphasized. This accords with what the ODT writer currently does. The user will still get a warning about a nonexistent image.
-
Fix example in API documentation (#3176, Thomas Weißschuh).
-
Tell where to get tarball in INSTALL (#3062).
-
Rename README to MANUAL.txt and add GitHub-friendly README.md (Albert Krewinkel, Kolen Cheung).
-
Replace COPYING with Markdown version COPYING.md from GNU (Kolen Cheung).
-
MANUAL.txt:
- Put note on structured vars in separate paragraph (#2148, Albert Krewinkel). Make it clearer that structured author variables require a custom template
- Note that
--katexworks best withhtml5(#3077). - Fix the LaTeX and EPUB links in manual (Morton Fox).
- Document
biblio-titlevariable.
-
Improve spacing of footnotes in
--helpoutput (Waldir Pimenta). -
Update KaTeX to v0.6.0 (Kolen Cheung).
-
Allow latest dependencies.
-
Use texmath 0.8.6.6 (#3040).
-
Allow http-client 0.4.30, which is the version in stackage lts. Previously we required 0.5. Remove CPP conditionals for earlier versions.
-
Remove support for GHC < 7.8 (Jesse Rosenthal).
- Remove Compat.Monoid.
- Remove an inline monad compatibility macro.
- Remove Text.Pandoc.Compat.Except.
- Remove directory compat.
- Change constraint on mtl.
- Remove unnecessary CPP condition in UTF8.
- Bump base lower bound to 4.7.
- Remove 7.6 build from .travis.yaml.
- Bump supported ghc version in CONTRIBUTING.md.
- Add note about GHC version support to INSTALL.
- Remove GHC 7.6 from list of tested versions (Albert Krewinkel).
- Remove TagSoup compat.
- Add EOL note to time compat module. Because time 1.4 is a boot library for GHC 7.8, we will support the compatibility module as long as we support 7.8. But we should be clear about when we will no longer need it.
- Remove blaze-html CPP conditional.
- Remove unnecessary CPP in custom Prelude.
-
Added Zim Wiki writer, template and tests.
zimwikiis now a valid output format. (Alex Ivkin) -
Changed email-obfuscation default to no obfuscation (#2988).
writerEmailObfuscationindefaultWriterOptionsis nowNoObfuscation.- the default for the command-line
--email-obfuscationoption is nownone.
-
Docbook writer: Declare xlink namespace in Docbook5 output (Ivo Clarysse).
-
Org writer:
- Support arbitrary raw inlines (Albert Krewinkel).
Org mode allows arbitrary raw inlines (“export snippets” in Emacs
parlance) to be included as
@@format:raw foreign format text@@. - Improve Div handling (Albert Krewinkel). Div blocks handling is
changed to make the output look more like idiomatic org mode:
- Div-wrapped content is output as-is if the div’s attribute is the null attribute.
- Div containers with an id but neither classes nor key-value pairs are unwrapped and the id is added as an anchor.
- Divs with classes associated with greater block elements are
wrapped in a
#+BEGIN…#+ENDblock. - The old behavior for Divs with more complex attributes is kept.
- Support arbitrary raw inlines (Albert Krewinkel).
Org mode allows arbitrary raw inlines (“export snippets” in Emacs
parlance) to be included as
-
HTML writer: Better support for raw LaTeX environments (#2758). Previously we just passed all raw TeX through when MathJax was used for HTML math. This passed through too much. With this patch, only raw LaTeX environments that MathJax can handle get passed through. This patch also causes raw LaTeX environments to be treated as math, when possible, with MathML and WebTeX output.
-
Markdown writer: use raw HTML for simple, pipe tables with linebreaks (#2993). Markdown line breaks involve a newline, and simple and pipe tables can’t contain one.
-
Make –webtex work with the Markdown writer (#1177). This is a convenient option for people using websites whose Markdown flavors don’t provide for math.
-
Docx writer:
- Set paragraph to FirstPara after display math (Jesse Rosenthal). We treat display math like block quotes, and apply FirstParagraph style to paragraphs that follow them. These can be styled as the user wishes. (But, when the user is using indentation, this allows for paragraphs to continue after display math without indentation.)
- Use actual creation time as doc prop (Jesse Rosenthal). Previously, we had used the user-supplied date, if available, for Word’s document creation metadata. This could lead to weird results, as in cases where the user post-dates a document (so the modification might be prior to the creation). Here we use the actual computer time to set the document creation.
-
LaTeX writer:
- Don’t URI-escape image source (#2825). Usually this is a local file,
and replacing spaces with
%20ruins things. - Allow ‘standout’ as a beamer frame option (#3007).
## Slide title {.standout}.
- Don’t URI-escape image source (#2825). Usually this is a local file,
and replacing spaces with
-
RST reader: Fixed links with no explicit link text. The link
`<foo>`_should havefooas both its link text and its URL. See RST spec at http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#embedded-uris-and-aliases Closes Debian #828167 – reported by Christian Heller. -
Textile reader:
- Fixed attributes (#2984). Attributes can’t be followed by
a space. So,
_(class)emph_but_(noclass) emph_. - Fixed exponential parsing bug (#3020).
- Fix overly aggressive interpretation as images (#2998). Spaces are not allowed in the image URL in textile.
- Fixed attributes (#2984). Attributes can’t be followed by
a space. So,
-
LaTeX reader:
- Fix
\citeso it is a NormalCitation not AuthorInText. - Strip off double quotes around image source if present (#2825). Avoids interpreting these as part of the literal filename.
- Fix
-
Org reader:
- Add semicolon to list of special chars (Albert Krewinkel)
Semicolons are used as special characters in citations syntax. This
ensures the correct parsing of Pandoc-style citations:
[prefix; @key; suffix]. Previously, parsing would have failed unless there was a space or other special character as the last character. - Add support for “Berkeley-style” cites (Albert Krewinkel, #1978). A specification for an official Org-mode citation syntax was drafted by Richard Lawrence and enhanced with the help of others on the orgmode mailing list. Basic support for this citation style is added to the reader.
- Support arbitrary raw inlines (Albert Krewinkel).
Org mode allows arbitrary raw inlines (“export snippets” in Emacs
parlance) to be included as
@@format:raw foreign format text@@. - Remove partial functions (Albert Krewinkel, #2991).
Partial functions like
headlead to avoidable errors and should be avoided. They are replaced with total functions. - Support figure labels (Albert Krewinkel, #2496, #2999).
Figure labels given as
#+LABEL: thelabelare used as the ID of the respective image. This allows e.g. the LaTeX to add proper\labelmarkup. - Improve tag and properties type safety (Albert Krewinkel). Specific newtype definitions are used to replace stringly typing of tags and properties. Type safety is increased while readability is improved.
- Parse as headlines, convert to blocks (Albert Krewinkel). Emacs org-mode is based on outline-mode, which treats documents as trees with headlines are nodes. The reader is refactored to parse into a similar tree structure. This simplifies transformations acting on document (sub-)trees.
- Refactor comment tree handling (Albert Krewinkel). Comment trees were handled after parsing, as pattern matching on lists is easier than matching on sequences. The new method of reading documents as trees allows for more elegant subtree removal.
- Support archived trees export options (Albert Krewinkel).
Handling of archived trees can be modified using the
archoption. Archived trees are either dropped, exported completely, or collapsed to include just the header when thearchoption is nil, non-nil, orheadline, respectively. - Put export setting parser into module (Albert Krewinkel). Export option parsing is distinct enough from general block parsing to justify putting it into a separate module.
- Support headline levels export setting (Albert Krewinkel).
The depths of headlines can be modified using the
Hoption. Deeper headlines will be converted to lists. - Replace ugly code with view pattern (Albert Krewinkel). Some less-than-smart code required a pragma switching of overlapping pattern warnings in order to compile seamlessly. Using view patterns makes the code easier to read and also doesn’t require overlapping pattern checks to be disabled.
- Fix parsing of verbatim inlines (Albert Krewinkel, #3016).
Org rules for allowed characters before or after markup chars were not
checked for verbatim text. This resultet in wrong parsing outcomes of
if the verbatim text contained e.g. space enclosed markup characters as
part of the text (
=is_substr = True=). Forcing the parser to update the positions of allowed/forbidden markup border characters fixes this.
- Add semicolon to list of special chars (Albert Krewinkel)
Semicolons are used as special characters in citations syntax. This
ensures the correct parsing of Pandoc-style citations:
-
LaTeX template: fix for obscure hyperref/xelatex issue. Here’s a minimal case:
\documentclass[]{article} \usepackage{hyperref} \begin{document} \section{\%á} \end{document}Without this change, this fails on the second invocation of xelatex. This affects inputs this like
# %áwith pdf output via xelatex. -
trypandoc: call results ‘html’ instead of ‘result’. This is for better compatibility with babelmark2.
-
Document MultiMarkdown as input/output format (Albert Krewinkel, #2973). MultiMarkdown was only mentioned as a supported Markdown dialect but not as a possible input or output format. A brief mention is added everywhere the other supported markdown dialects are mentioned.
-
Document Org mode as a format containing raw HTML (Albert Krewinkel) Raw HTML is kept when the output format is Emacs Org mode.
-
Implement
RawInlineandRawBlockin sample lua custom writer (#2985). -
Text.Pandoc.Shared:
- Introduce blocksToInlines function (Jesse Rosenthal).
This is a lossy function for converting
[Block] -> [Inline]. Its main use, at the moment, is for docx comments, which can contain arbitrary blocks (except for footnotes), but which will be converted to spans. This is, at the moment, pretty useless for everything but the basicParaandPlaincomments. It can be improved, but the docx reader should probably emit a warning if the comment contains more than this. - Add BlockQuote to blocksToInlines (Jesse Rosenthal).
- Add further formats for
normalizeDate(Jesse Rosenthal). We want to avoid illegal dates – in particular years with greater than four digits. We attempt to parse series of digits first as%Y%m%d, then%Y%m, and finally%Y. normalizeDateshould reject illegal years (Jesse Rosenthal). We only allow years between 1601 and 9999, inclusive. The ISO 8601 actually says that years are supposed to start with 1583, but MS Word only allows 1601-9999. This should stop corrupted word files if the date is out of that range, or is parsed incorrectly.- Improve year sanity check in normalizeDate (Jesse Rosenthal).
Previously we parsed a list of dates, took the first one, and then
tested its year range. That meant that if the first one failed, we
returned nothing, regardless of what the others did. Now we test for
sanity before running
msumover the list of Maybe values. Anything failing the test will be Nothing, so will not be a candidate.
- Introduce blocksToInlines function (Jesse Rosenthal).
This is a lossy function for converting
-
Docx reader:
- Add simple comment functionality. (Jesse Rosenthal).
This adds simple track-changes comment parsing to the docx reader. It is
turned on with
--track-changes=all. All comments are converted to inlines, which can list some information. In the future a warning will be added for comments with formatting that seems like it will be excessively denatured. Note that comments can extend across blocks. For that reason there are two spans:comment-startandcomment-end.comment-startwill contain the comment.comment-endwill always be empty. The two will be associated by a numeric id. - Enable warnings in top-level reader (Jesse Rosenthal).
Previously we had only allowed for warnings in the parser. Now we allow
for them in the
Docx.hsas well. The warnings are simply concatenated. - Add warning for advanced comment formatting. (Jesse Rosenthal). We can’t guarantee we’ll convert every comment correctly, though we’ll do the best we can. This warns if the comment includes something other than Para or Plain.
- Add tests for warnings. (Jesse Rosenthal).
- Add tests for comments (Jesse Rosenthal).
We test for comments, using all track-changes options. Note that we
should only output comments if
--track-changes=all. We also test for emitting warnings if there is complicated formatting.
- Add simple comment functionality. (Jesse Rosenthal).
This adds simple track-changes comment parsing to the docx reader. It is
turned on with
-
README: update to include track-changes comments. (Jesse Rosenthal)
-
Improved Windows installer - don’t ignore properties set on command-line. See #2708. Needs testing to see if this resolves the issue. Thanks to @nkalvi.
-
Process markdown extensions on command line in L->R order (#2995). Previously they were processed, very unintuitively, in R->L order, so that
markdown-tex_math_dollars+tex_math_dollarshadtex_math_dollarsdisabled. -
Added
secnumdepthvariable to LaTeX template (#2920). -
Include table of contents in README.html in Windows package.
-
Writers: treat SoftBreak as space for stripping (Jesse Rosenthal) In Writers.Shared, we strip leading and trailing spaces for display math. Since SoftBreak’s are treated as spaces, we should strip those too.
-
beamer, latex templates: pass biblatexoptions directly in package load. This allows runtime optinos to be used. Fixes jgm/pandoc-citeproc#201
-
CPP workaround for deprecation of
parseUrlin http-client. -
Removed some redundant class constraints.
-
make_oxs_package.sh - use OSX env variable.
-
Added
winpkgtarget to Makefile. This downloads the windows package from appveyor and signs it using the key. -
Document Org mode as a format containing raw TeX (Albert Krewinkel). Raw TeX is kept verbatim when the output format is Emacs Org mode.
-
Support math with haddock-library >= 1.4.
-
Removed
-rtsoptsfrom library stanza. It has no effect, and Hackage wouldn’t accept the package. -
Update library dependency versions.
-
New output format:
docbook5(Ivo Clarysse). -
Text.Pandoc.Options: AddwriterDocBook5toWriterOptions(API change). -
Org writer:
- Add :PROPERTIES: drawer support (Albert Krewinkel, #1962).
This allows header attributes to be added to org documents in the form
of
:PROPERTIES:drawers. All available attributes are stored as key/value pairs. This reflects the way the org reader handles:PROPERTIES:blocks. - Add drawer capability (Carlos Sosa). For the implementation of the
Drawer element in the Org Writer, we make use of a generic Block
container with attributes. The presence of a
drawerclass defines that theDivconstructor is a drawer. The first class defines the drawer name to use. The key-value list in the attributes defines the keys to add inside the Drawer. Lastly, the list of Block elements contains miscellaneous blocks elements to add inside of the Drawer. - Use
CUSTOM_IDin properties (Albert Krewinkel). TheIDproperty is reserved for internal use by Org-mode and should not be used. TheCUSTOM_IDproperty is to be used instead, it is converted to theIDproperty for certain export format.
- Add :PROPERTIES: drawer support (Albert Krewinkel, #1962).
This allows header attributes to be added to org documents in the form
of
-
LaTeX writer:
- Ignore
--incrementalunless output format is beamer (#2843). - Fix polyglossia to babel env mapping (Mauro Bieg, #2728). Allow for optional argument in square brackets.
- Recognize
la-x-classicas Classical Latin (Andrew Dunning). This allows one to access the hyphenation patterns in CTAN’s hyph-utf8. - Add missing languages from hyph-utf8 (Andrew Dunning).
- Improve use of
\strutwith\minipageinside tables (Jose Luis Duran). This improves spacing in multiline tables. - Use
{}around options containing special chars (#2892). - Avoid lazy
foldl. - Don’t escape underscore in labels (#2921). Previously they were
escaped as
ux5f. - brazilian -> brazil for polyglossia (#2953).
- Ignore
-
HTML writer: Ensure mathjax link is added when math appears in footnote (#2881). Previously if a document only had math in a footnote, the MathJax link would not be added.
-
EPUB writer: set
navpagevariable on nav page. This allows templates to treat it differently. -
DocBook writer:
- Use docbook5 if
writerDocbook5is set (Ivo Clarysse). - Properly handle
ulink/link(Ivo Clarysse).
- Use docbook5 if
-
EPUB reader:
- Unescape URIs in spine (#2924).
- EPUB reader: normalise link id (Mauro Bieg).
-
Docx Reader:
- Parse
moveToandmoveFrom(Jesse Rosenthal).moveToandmoveFromare track-changes tags that are used when a block of text is moved in the document. We now recognize these tags and treat them the same asinsertanddelete, respectively. So,--track-changes=acceptwill show the moved version, while--track-changes=rejectwill show the original version. - Tests for track-changes moving (Jesse Rosenthal).
- Parse
-
ODT, EPUB, Docx readers: throw
PandocErroron unzip failure (Jesse Rosenthal) Previously,readDocx,readEPUB, andreadOdtwould error out if zip-archive failed. We change the archive extraction step fromtoArchivetotoArchiveOrFail, which returns an Either value. -
Markdown, HTML readers: be more forgiving about unescaped
&in HTML (#2410). We are now more forgiving about parsing invalid HTML with unescaped&as raw HTML. (Previously any unescaped&would cause pandoc not to recognize the string as raw HTML.) -
Markdown reader:
- Fix pandoc title blocks with lines ending in 2 spaces (#2799).
- Added
-sto markdown-reader-more test.
-
HTML reader: fixed bug in
pClose. This caused exponential parsing behavior in documnets with unclosed tags indl,dd,dt. -
MediaWiki reader: Allow spaces before
!in MediaWiki table header (roblabla). -
RST reader: Support
:class:option for code block in RST reader (Sidharth Kapur). -
Org reader (all Albert Krewinkel, except where noted otherwise):
- Stop padding short table rows. Emacs Org-mode doesn’t add any padding to table rows. The first row (header or first body row) is used to determine the column count, no other magic is performed.
- Refactor rows-to-table conversion. This refactors the codes conversing a list table lines to an org table ADT. The old code was simplified and is now slightly less ugly.
- Fix handling of empty table cells, rows (Albert Krewinkel, #2616).
This fixes Org mode parsing of some corner cases regarding empty cells
and rows. Empty cells weren’t parsed correctly, e.g.
|||should be two empty cells, but would be parsed as a single cell containing a pipe character. Empty rows where parsed as alignment rows and dropped from the output. - Fix spacing after LaTeX-style symbols.
The org-reader was dropping space after unescaped LaTeX-style symbol
commands:
\ForAll \Aumlresulted in∀Äbut should give∀ Äinstead. This seems to be because the LaTeX-reader treats the command-terminating space as part of the command. Dropping the trailing space from the symbol-command fixes this issue. - Print empty table rows. Empty table rows should not be dropped from the output, so row-height is always set to be at least 1.
- Move parser state into separate module. The org reader code has become large and confusing. Extracting smaller parts into submodules should help to clean things up.
- Add support for sub/superscript export options.
Org-mode allows to specify export settings via
#+OPTIONSlines. Disabling simple sub- and superscripts is one of these export options, this options is now supported. - Support special strings export option Parsing of special strings
(like
...as ellipsis or--as en dash) can be toggled using the-option. - Support emphasized text export option. Parsing of emphasized text can
be toggled using the
*option. This influences parsing of text marked as emphasized, strong, strikeout, and underline. Parsing of inline math, code, and verbatim text is not affected by this option. - Support smart quotes export option. Reading of smart quotes can be
toggled using the
'option. - Parse but ignore export options. All known export options are parsed but ignored.
- Refactor block attribute handling. A parser state attribute was used to keep track of block attributes defined in meta-lines. Global state is undesirable, so block attributes are no longer saved as part of the parser state. Old functions and the respective part of the parser state are removed.
- Use custom
anyLine. Additional state changes need to be made after a newline is parsed, otherwise markup may not be recognized correctly. This fixes a bug where markup after certain block-types would not be recognized. - Add support for
ATTR_HTMLattributes (#1906). Arbitrary key-value pairs can be added to some block types using a#+ATTR_HTMLline before the block. Emacs Org-mode only includes these when exporting to HTML, but since we cannot make this distinction here, the attributes are always added. The functionality is now supported for figures. - Add
:PROPERTIES:drawer support (#1877). Headers can have optional:PROPERTIES:drawers associated with them. These drawers contain key/value pairs like the header’sid. The reader adds all listed pairs to the header’s attributes;idandclassattributes are handled specially to match the wayAttrare defined. This also changes behavior of how drawers of unknown type are handled. Instead of including all unknown drawers, those are not read/exported, thereby matching current Emacs behavior. - Use
CUSTOM_IDin properties. See above on Org writer changes. - Respect drawer export setting. The
dexport option can be used to control which drawers are exported and which are discarded. Basic support for this option is added here. - Ignore leading space in org code blocks (Emanuel Evans, #2862). Also fix up tab handling for leading whitespace in code blocks.
- Support new syntax for export blocks. Org-mode version 9
uses a new syntax for export blocks. Instead of
#+BEGIN_<FORMAT>, where<FORMAT>is the format of the block’s content, the new format uses#+BEGIN_export <FORMAT>instead. Both types are supported. - Refactor
BEGIN...ENDblock parsing. - Fix handling of whitespace in blocks, allowing content to be indented less then the block header.
- Support org-ref style citations. The org-ref package is an
org-mode extension commonly used to manage citations in org
documents. Basic support for the
cite:citeKeyand[[cite:citeKey][prefix text::suffix text]]syntax is added. - Split code into separate modules, making for cleaner code and better decoupling.
-
Added
docbook5template. -
--mathjaximprovements:- Use new CommonHTML output for MathJax (updated default MathJax URL, #2858).
- Change default mathjax setup to use
TeX-AMS_CHTMLconfiguration. This is designed for cases where the input is always TeX and maximal conformity with TeX is desired. It seems to be smaller and load faster than what we used before. See #2858. - Load the full MathJax config to maximize loading speed (KolenCheung).
-
Bumped upper version bounds to allow use of latest packages and compilation with ghc 8.
-
Require texmath 0.8.6.2. Closes several texmath-related bugs (#2775, #2310, #2310, #2824). This fixes behavior of roots, e.g.
\sqrt[3]{x}, and issues with sub/superscript positioning and matrix column alignment in docx. -
README:
- Clarified documentation of
implicit_header_references(#2904). - Improved documentation of
--columnsoption.
- Clarified documentation of
-
Added appveyor setup, with artefacts (Jan Schulz).
-
stack.yaml versions: Use proper flags used for texmath, pandoc-citeproc.
-
LaTeX template: support for custom font families (vladipus). Needed for correct polyglossia operation with Cyrillic fonts and perhaps can find some other usages. Example usage in YAML metadata:
fontfamilies: - name: \cyrillicfont font: Liberation Serif - name: \cyrillicfonttt options: Scale=MatchLowercase font: Liberation -
Create unsigned msi as build artifact in appveyor build.
-
On travis, test with ghc 8.0.1; drop testing for ghc 7.4.1.
-
Added
--file-scopeoption (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-scopeoption causes pandoc to parse the files first, and then combine the parsed output, instead of combining before parsing.--file-scopeis selected automatically for binary input files (which cannot be concatenated) and for pandoc json. -
Add TEI Writer (Chris Forster) and
teioutput format. -
Added a general
ByteStringReaderwith warnings, used by the docx reader (API change, Jesse Rosenthal). -
Add
readDocxWithWarnings(API change, Jesse Rosenthal). -
Changed type of
Shared.uniqueIdentargument from[String]toSet String. This avoids performance problems in documents with many identically named headers (API change, #2671). -
Removed
tex_math_single_backslashfrommarkdown_githuboptions (#2707). -
Make language extensions as well as full language names trigger syntax highlighting. For example,
pywill now work as well aspython(jgm/highlighting-kate#83). -
Added
institutevariable to latex, beamer templates (Fraser Tweedale, Josef Svenningsson). -
Docx reader (Jesse Rosenthal):
- Handle alternate content. Some word functions (especially graphics) give various choices for content so there can be backwards compatibility.
- Don’t turn numbered headers into lists.
- Docx Reader: Add state to the parser, for warnings
- Update feature checklist in source code.
- Get rid of
Modifiabletypeclass. - Add tests for adjacent hyperlinks.
- Add a “Link” modifier to
Reducible. We want to make sure that links have their spaces removed, and are appropriately smushed together (#2689).
-
HTML reader:
- Fixed behavior of base tag (#2777).
If the base path does not end with slash, the last component
will be replaced. E.g. base =
http://example.com/foocombines withbar.htmlto givehttp://example.com/bar.html. If the href begins with a slash, the whole path of the base is replaced. E.g. base =http://example.com/foo/combines with/bar.htmlto givehttp://example.com/bar.html. - Rewrote
htmlInBalanced. This version avoids an exponential performance problem with<script>tags, and it should be faster in general (#2730). - Properly handle an empty cell in a simple table (#2718).
- Handle multiple
<meta>tags with same name. Put them in a list in the metadata so they are all preserved, rather than (as before) throwing out all but one..
- Fixed behavior of base tag (#2777).
If the base path does not end with slash, the last component
will be replaced. E.g. base =
-
Markdown reader:
- Improved pipe table parsing (#2765).
- Allow
+separators in pipe table cells. We already allowed them in the header, but not in the body rows, for some reason. This gives compatibility with org-mode tables. - Don’t cross line boundary parsing pipe table row. Previously an Emph element could be parsed across the newline at the end of the pipe table row.
- Use
htmlInBalancedforrawVerbatimBlock, for better performance (#2730). - Fixed bug with smart quotes around tex math.
-
LaTeX reader:
- Handle interior
$characters in math (#2743). For example,$$\hbox{$i$}$$. inlineCommandnow gobbles an empty{}after any command (#2687). This gives better results when people write e.g.\TeX{}in Markdown.- Properly handle LaTeX “math” environment as inline math (#2171).
- Handle interior
-
Textile reader: Support
>,<,=,<>text alignment attributes. Closes #2674. -
Org reader (Albert Krewinkel):
- Prefix even empty figure names with “fig:” (#2643). The
convention used by pandoc for figures is to mark them by prefixing
the name with
fig:. The org reader failed to do this if a figure had no name. - Refactor link-target processing (#2684).
- Prefix even empty figure names with “fig:” (#2643). The
convention used by pandoc for figures is to mark them by prefixing
the name with
-
ConTeXt writer: Fix whitespace at line beginning in line blocks (#2744). Thanks to @c-foster.
-
HTML writer: Don’t include alignment attribute for default table columns. Previously these were given “left” alignment. Better to leave off alignment attributes altogether (#2694).
-
Markdown writer: Use hyphens for YAML metadata block bottom line, for better compatibility with other Markdown flavors (Henrik Tramberend).
-
LaTeX writer:
- Use image identifier to create a label and hypertarget for figures (Mauro Bieg).
- Avoid double toprule in headerless table with caption (#2742).
- Clean up options parser (Jesse Rosenthal).
- Treat
memoirtemplate witharticleoption as article, instead of treating allmemoirtemplates as books. - Allow more flexible table alignment (Henrik Tramberend, #2665).
New default is not to include
[c]option (which is the default anyway if no positioning is specified). Now LaTeX emplates can control the overall table alignment in a document by setting the longtable length variablesLTleftandLTright. For example,\setlength\LTleft\parindent\setlength\LTright\fillwill create left-aligned tables that respect paragraph indentation.
-
Docx writer: Handle image alt text (#2754, Mauro Bieg).
-
Org writer - pass through RawInline with format “org”.
-
DokuWiki writer: use
$$for display math. -
Custom writer: Pass attributes parameter to CaptionedImage (#2697).
-
Make protocol-relative URIs work again (#2737).
-
make_osx_package.sh: Use env variable for developer id certs.
-
Raise
tagsouplower bound to 0.13.7 to fix entity-related problems (#2734). -
Allow
zip-archive0.3. -
Allow
aeson0.11.
-
Added
Attrfield toLinkandImage(Mauro Bieg, #261, API change).- Added syntax for link and image attributes to pandoc’s Markdown.
- Updated readers and writers to use link and image attributes when appropriate.
- Support image attributes in Docx, Textile, RST readers.
-
Renamed link attribute extensions. The old
link_attributesis nowmmd_link_attributes, andlink_attributesnow enables the new pandoc-style link and image attributes (API change). Note: this change could break some existing workflows. -
Implemented
SoftBreakand new--wrapoption (#1701, API change). Added threefold wrapping option.- Command line option: deprecated
--no-wrap, added--wrap=[auto|none|preserve] - Added
WrapOption, exported fromText.Pandoc.Options - Changed type of
writerWrapTextinWriterOptionsfromBooltoWrapOption. - Modified
Text.Pandoc.Sharedfunctions to allowSoftBreak. - Supported
SoftBreakin readers and writers.
- Command line option: deprecated
-
Text.Pandoc.Options: Added
writerDpitoWriterOptions(API change, Mauro Bieg). -
Added
--dpicommand-line option (Mauro Bieg). -
Rationalized behavior of
--no-tex-ligaturesand--smart(#2541). This change makes--no-tex-ligaturesaffect the LaTeX reader as well as the LaTeX and ConTeXt writers. If it is used, the LaTeX reader will parse characters`,', and-literally, rather than parsing ligatures for quotation marks and dashes. And the LaTeX writer will print unicode quotation mark and dash characters literally, rather than converting them to the standard ASCII ligatures. Note that--smarthas no effect on the LaTeX reader.--smartis still the default for all input formats when LaTeX or ConTeXt is the output format, unless--no-tex-ligaturesis used.Some examples to illustrate the logic:
% echo "'hi'" | pandoc -t latex `hi' % echo "'hi'" | pandoc -t latex --no-tex-ligatures 'hi' % echo "'hi'" | pandoc -t latex --no-tex-ligatures --smart ‘hi’ % echo "'hi'" | pandoc -f latex --no-tex-ligatures <p>'hi'</p> % echo "'hi'" | pandoc -f latex <p>’hi’</p> -
Removed deprecated options
--offlineand--html5. -
Fixed language code for Czech (
csnotcz) (#2597). -
Implemented
east_asian_line_breaksextension (#2586). InText.Pandoc.Options, addedExt_east_asian_line_breaksconstructor toExtension(API change). This extension is likeignore_line_breaks, but smarter – it only ignores line breaks between two East Asian wide characters. This makes it better suited for writing with a mix of East Asian and non-East Asian scripts. -
Added support for PDF creation via
wkhtmltopdf. To use this:pandoc -t html5 -o result.pdf(and add--mathjaxif you have math.) Margins can be set using the variablesmargin-top,margin-bottom,margin-left,margin-right. Other styling can be done through CSS. -
Fixed cite key parsing regression (jgm/pandoc-citeproc#201). We were capturing final colons as in
[@foo: bar]; the citation id was being parsed as@foo:. -
ICML writer:
- Fixed image syntax for local files (#2589).
- Changed type of
writeICML(Mauro Bieg). API change: It is nowWriterOptions -> Pandoc -> IO String. Also handle new image attributes. - Intersperse line breaks instead of appending them to
every
ParagraphStyleRange(Mauro Bieg, #2501). - Add
Citestyle to citations (Mauro Bieg). - Added figure handling (#2590, Mauro Bieg).
- Better handling of math. Instead of just printing the raw tex, we now try to fake it with unicode characters.
-
HTML writer: Include
exampleclass for example lists (#2524). -
ODT/OpenDocument writer: improved image attributes (Mauro Bieg).
- Support for percentage widths/heights
- Use
Attrinstead of title to get dimensions from ODT walker towriteOpenDocument.
-
AsciiDoc writer:
- Support anchors in spans and divs with id elements (jgm/pandoc-citeproc#143).
- Fixed code blocks (#1861).
-
Haddock writer: omit formatting inside links, which isn’t supported by Haddock (#2515).
-
MediaWiki writer: Fixed spacing issues in table cells.
- Start cell on new line unless it’s a single Para or Plain (#2606).
- For single Para or Plain, insert a space after the
|to avoid problems when the text begins with a character like-(#2604).
-
Beamer writer: mark frame as fragile when it contains verbatim (#1613).
-
LaTeX writer:
- Add support for GAP highlighting using listings (Raniere Silva).
- Consider
header-includescontent as well as templates when determining whether to use csquotes (Andreas Lööw). - Create defaults for geometry using
margin-leftetc. Ifgeometryhas no value, butmargin-left,margin-right,margin-top, and/or-margin-bottomare given, a default value forgeometryis created from these. Note that these variables already affect PDF production via HTML5 withwkhtmltopdf.
-
ConTeXt writer: set default layout based on
margin-left, etc. This sets up\setuplayoutbased on the variablesmargin-left,margin-right,margin-bottom, andmargin-top, if no layout is given. -
Docx writer: better handling of PDF images. Previously we tried to get the image size from the image even if an explicit size was specified. Since we still can’t get image size for PDFs, this made it impossible to use PDF images in docx. Now we don’t try to get the image size when a size is already explicitly specified.
-
Markdown writer: use raw HTML for link/image attributes when the
link_attributesextension is unset andraw_htmlis set (#2554). -
MediaWiki reader: interpret markup inside
<tt>,<code>(#2607). -
LaTeX reader:
- Improved smart quote parsing (#2555). This fixes redering of unmatched quotes.
- Use curly quotes for unmatched ` (#2555).
- Allow blank space between braced arguments of commands (#2592).
-
Markdown reader:
- Improved pipe table relative widths. Previously pipe table columns got relative widths (based on the header underscore lines) when the source of one of the rows was greater in width than the column width. This gave bad results in some cases where much of the width of the row was due to nonprinting material (e.g. link URLs). Now pandoc only looks at printable width (the width of a plain string version of the source), which should give better results. Thanks to John Muccigrosso for bringing up the issue.
- Fixed parsing bug with macros. Previously macro definitions in indented code blocks were being parsed as macro definitions, not code.
-
Textile reader: skip over attribute in image source (#2515). We don’t have a place yet for styles or sizes on images, but we can skip the attributes rather than incorrectly taking them to be part of the filename.
-
Docx reader: Handle dummy list items (Jesse Rosenthal). These come up when people create a list item and then delete the bullet. It doesn’t refer to any real list item, and we used to ignore it.
-
CommonMark reader/writer rewritten to use latest
cmark. -
Fixed Emoji character definitions (#2523). There were many bugs in the definitions.
-
Text.Pandoc.CSS:- Added
pickStylesToKVsfunction to extract multiple properties at once (API change, Mauro Bieg). - Parse CSS that doesn’t contain the optional semicolon (Mauro Bieg).
- Added
-
trypandoc: sort drop-down lists. -
Beamer template:
- Made
\euroconditional on presence of character. for xelatex and lualatex, as it is for pdflatex (Andrew Dunning). - Moved
header-includesbefore setting of title (Thomas Hodgson), to match the LaTeX template (jgm/pandoc-templates#168). - Added
section-titlesvariable (defaults to true) to enable/suppress section title pages in beamer slide shows (Thomas Hodgson). - Moved beamer themes after fonts, so that themes can change fonts. (Previously the fonts set were being clobbered by lmodern.sty.) (Thomas Hodgson).
- Made
-
Beamer/LaTeX template changes (Thomas Hodgson):
- Added
thanksvariable - Use
parskip.stywhenindentisn’t set (fall back to usingsetlengthas before ifparskip.styisn’t available). - Use
biblio-stylewith biblatex. - Added
biblatexoptionsvariable.
- Added
-
LaTeX template changes:
- Added
paperafter$papersize$variable in latex template. Thus you can saypapersize: a4and the latex will containa4paper. This change may break some existing workflows; if you currently specifya4paper, you’ll geta4paperpaperwhich is meaningless. However, the change seems worth it, as it will make thepapersizevariable work uniformly across ConTeXt, LaTeX, and html->pdf via wkhtmltopdf. - Only pass options to color package if
colorlinksis set (Andrew Dunning). - Make definition of
\euroconditional in xelatex/lualatex, as it is already for pdflatex (Andrew Dunning). - Removed setting of
subjectin PDF metadata. This used to be set to the subtitle, but really the subtitle need not give the subject. Also,subtitlecan contain formatting, so we’d need, at least, a plain text version for this. - Moved
header-includesbefore setting of\title,\author, etc. This allows these macros to be redefined. - Use
\subtitlecommand forsubtitle, instead of tacking it on to the title as before. We give a no-op fallback definition if it is not defined. This change should produce much better results in classes that support\subtitle. With the default article class, which does not define\subtitle, subtitles will no longer be printed unless the user defines\subtitleand redefines\maketitle. - Moved redefinitions of
\paragraphand\subparagraphto before header-includes.
- Added
-
Context template:
- Use
simplefontsfor font loading (Paolo Rodríguez). This is needed for things to work on ConTeXt stable from TeXLive 2015. - Revert use of
\setupheadin title block (Andrew Dunning, Rik Kabel).
- Use
-
Update LaTeX/ConTeXt link colour usage (Andrew Dunning).
-
Fixed man template so disabling hyphenation actually works. The command needs to come after .TH.
-
Added ‘navigation’ variable to beamer template (#2543). Valid values are
empty(the default),horizontal,vertical, andframe. Note that this changes the default behavior fromhorizontaltoempty. Closes #2543. -
Added
tocto HTML slide format templates (Andrew Dunning), so that--toccreates a contents slide. -
Added
stack.full.yamlto buildpandoc-citeprocas well. -
Allow pipe tables with no body rows (#2556). Previously this raised a runtime error.
-
Shared: Improved
fetchItemso thatC:/Blah/Blah.jpgisn’t treated as URL. The Haskell URI parsing routines will accept “C:” as a scheme, so we rule that out manually. This helps with--self-containedand absolute Windows paths. -
Define a
meta-jsonvariable for all writers (#2019). This contains a JSON version of all the metadata, in the format selected for the writer. So, for example, to get just the YAML metadata, you can run pandoc with the following custom template:$meta-json$. The intent is to make it easier for static site generators and other tools to get at the metadata. -
Document limitations of –self-contained (#2553).
-
Improved Citations section of README (#2551). Added information about
link-citationsand a link to the pandoc-citeproc man page. -
ImageSize: usesafeReadinstead ofreadMaybe, which isn’t in base < 4.6. -
Allow .adoc file extension for AsciiDoc (Andrew Dunning).
-
Improved implicit pandoc-citeproc inclusion. The filter pandoc-citeproc is automatically used when
--bibliographyis specified on the command line, unless--natbibor--biblatexis used. However, previously this only worked if--bibliographywas spelled out in full, and not if--bibliowas used. -
reveal.js: Interpret pauses correctly for all headers (#2530). Previously, when using headers below the slide level, pauses are left uninterpreted into pauses. In my opinion, unexpected behavior but intentional looking at the code.
-
Remove redundant
centervariable for reveal.js (Andrew Dunning). -
Parsing: Add
extractIdClass, modified type ofKeyTable(Mauro Bieg, API change). -
ImageSize: Added functions for converting between image dimensions (Mauro Bieg).
-
Use lts-3.18 in stack.yaml. This avoids Windows build issues with the HTTP library.
-
Bump version bounds for dependencies.
-
pandoc my.md -t context -o my.pdfwill now create a PDF using ConTeXt rather than LaTeX (#2463). -
Fixed omitted
url(...)in CSS data-uri with--self-contained(#2489). -
Added
emojiMarkdown extension, enabled by default inmarkdown_github(#2523). AddedExt_emojitoExtensioninText.Pandoc.Options(API change). -
Text.Pandoc.Readers.HTML.parseTags: Fixed over-eager raw HTML inline parsing (#2469). Tightened up the inline HTML parser so it disallows TagWarnings. -
Derive
Genericinstances for the types inText.Pandoc.Options. -
Org reader:
- Fix paragraph/list interaction (Albert Krewinkel, #2464). Paragraphs can be followed by lists, even if there is no blank line between the two blocks. However, this should only be true if the paragraph is not within a list, were the preceding block should be parsed as a plain instead of paragraph (to allow for compact lists). Thanks to @rgaiacs for bringing this up.
- Allow toggling header args (Albert Krewinkel, #2269). Org-mode allows to skip the argument of a code block header argument if it’s toggling a value. Argument-less headers are now recognized, avoiding weird parsing errors.
- Fix markup parsing in headers (Albert Krewinkel, #2504). Markup as the very first item in a header wasn’t recognized. This was caused by an incorrect parser state: positions at which inline markup can start need to be marked explicitly by changing the parser state. This wasn’t done for headers. The proper function to update the state is now called at the beginning of the header parser, fixing this issue.
- Fix emphasis rules for smart parsing (Albert Krewinkel, #2513). Smart quotes, ellipses, and dashes should behave like normal quotes, single dashes, and dots with respect to text markup parsing.
- Require whitespace around definition list markers (#2518). This rule was not checked before, resulting in bugs with footnotes and some link types.
-
Markdown reader:
- Pipe tables with long lines now get relative cell widths (#2471).
If a pipe table contains a line longer than the column width (as set by
--columnsor 80 by default), relative widths are computed based on the widths of the separator lines relative to the column width. This should solve persistent problems with long pipe tables in LaTeX/PDF output, and give more flexibility for determining relative column widths in other formats, too. For narrower pipe tables, column widths of 0 are used, telling pandoc not to specify widths explicitly in output formats that permit this. - Improved parser for
mmd_title_block. We now allow blank metadata fields. These were explicitly disallowed before. - Citation keys can now contain
://, so URLs and DOIs can be used as citation keys (jgm/pandoc-citeproc#166).
- Pipe tables with long lines now get relative cell widths (#2471).
If a pipe table contains a line longer than the column width (as set by
-
Beamer template: fix incompatibility of section slides with natbib. Natbib (and presumably biblatex) bibliography commands create their own section. Since these are in frame environments, we have an incompatibility with the
\AtBeginSectionmacro which creates a special frame when a new section occurs. (We can’t have a frame inside another frame.) This change disables\AtBeginSectioninside bibliography slides. Thinks to Yihui Xie for bringing the problem to my attention. This supersedes #145. See discussion there. -
Textile reader: don’t do smart punctuation unless explicitly asked (#2480). Note that although smart punctuation is part of the textile spec, it’s not always wanted when converting from textile to, say, Markdown. So it seems better to make this an option.
-
LaTeX reader: Handle
commentenvironment (Arata Mizuki). Thecommentenvironment is handled in a similar way to theverbatimenvironment, except that its content is discarded. -
Docx reader: Follow relationships correctly in foot/endnotes (#2258, Jesse Rosenthal). This fixes a problem with links in notes.
-
LaTeX and ConTeXt writers: support
langattribute on divs and spans (mb21). For LaTeX, also collectlanganddirattributes on spans and divs to set thelang,otherlangsanddirvariables if they aren’t set already. See #895. -
LaTeX writer:
- Use proper command for
\textarabic(mb21). - Added
de-CH-1901, fixedel-polytonintoPloyglossia(Nick Bart). - Use
\hypertargetand\hyperlinkfor links. This works correctly to link to Div or Span elements. We now don’t bother defining\labelfor Div or Span elements. Closes jgm/pandoc-citeproc#174. - Avoid footnotes in list of figures (#1506).
- Properly handle footnotes in captions (#1506).
- Add
\protectto\hyperlink(#2490). Thanks to Hadrien Mary. - Set
colorlinksiflinkcolor,urlcolor,citecolor, ortoccoloris set (#2508).
- Use proper command for
-
Textile writer: support start number in ordered lists (#2465).
-
OpenDocument writer: Allow customization of opendocument automatic styles. Automatic styles can now be inserted in the template, which now provides the enclosing
<office:automatic-styles>tags (#2520). -
Docx writer: insert space between footnote reference and note (#2527). This matches Word’s default behavior.
-
EPUB writer: don’t download linked media when
data-externalattribute set (#2473). By default pandoc downloads all linked media and includes it in the EPUB container. This can be disabled by settingdata-externalon the tags linking to media that should not be downloaded. Example:<audio controls="1"> <source src="http://www.sixbarsjail.it/tmp/bach_toccata.mp3" type="audio/mpeg"></source> </audio> -
HTML writer: use width on whole table if col widths sum to < 100%. Otherwise some browsers display the table with the columns separated far apart.
-
AsciiDoc template: Fix
authoranddate; addkeywords,abstract(Andrew Dunning). -
HTML-based templates (Andrew Dunning):
- Use en dash instead of hyphen between title prefix and title.
- Add
keywordsto metadata. - Add
lang,dir,quoteswhere missing. - Always make author and date display conditional.
- Updated dzslides template from source.
-
Man template: make “generated by” comment conditional.
-
LaTeX, Beamer templates:
- Add
babel-otherlangsfor language divs/spans;babel-newcommands, filled by commands that make babel understand the polyglossia-style language directives (mb21, #137). - Improved formatting of conditionals;
$for$is always provided to allow multiple options (Andrew Dunning, #141). - Use
Ligatures=TeXrather thanMapping=tex-textwithfontspecto improve support for LuaTeX (Andrew Dunning, #135). - Revise
hyperrefusage (Andrew Dunning, #139, #141):- use same options for all LaTeX engines;
- add
subtitleandkeywordsto PDF metadata; - do not override
hyperreflink coloring without user input, effectively making thehidelinksoption the default (removed as a separate variable); - link colors can be enabled (using a slightly darker version of the old
defaults) using a new
colorlinksvariable, automatically used by the LaTeX writer when custom colors are specified; pdfborder={0 0 0}is automatically set byhyperrefwithcolorlinks, and is only applied ifcolorlinksis disabled.
- Add
-
ConTeXt template (Andrew Dunning):
- New variables for controlling styles:
linkstyle,linkcolor,linkcontrastcolor,layout,pagenumbering,whitespace,indenting,interlinespace,headertext,footertext,mainfont,sansfont,monofont,mathfont,fontsize. - Default template no longer supports MkII.
- Improve writing of title block (suppressing numbering of first page).
- Add
titlesubtitle,author,date,keywordsto PDF metadata. - Support
subtitle,abstract. - Support list of figures (
lof), list of tables (lot). - Disable link styling by default.
- Define styles for all section types.
- Enable microtype.
- Improved formatting of conditionals.
- New variables for controlling styles:
-
Beamer template: added code to prevent slide breaks inside paragraphs (#2422, thanks to Nick Bart). This will matter, in practice, only when
allowframebreaksis used. It is especially helpful for bibliography slides. -
OpenDocument template: Add
<office:automatic-styles>tag around automatic styles. The writer now longer provides this (see #2520). -
Restored Text.Pandoc.Compat.Monoid.
-
Do not export (<>) from custom Prelude. The Prelude now matches base 4.8 Prelude’s API.
-
Don’t use custom prelude with ghc 7.10. Use the custom prelude only for earlier versions. This change makes
stack ghciandcabal replwork (#2503), at least with ghc 7.10. -
Changed § to % in operators from Odt.Arrows.Utils (#2457). This prevents problems building haddocks with “C” locale.
-
Change default for old-locale flag to False.
-
Use stack in deb, osx, and Windows package generators.
-
Added Vagrantfile for building deb in vm. This should help in automating binary package creation. ‘make package’ will make the package. ‘make package COMMIT=blah’ will make the package from commit blah.
-
README:
- Consistent capitalization for pandoc and Markdown.
- Fixed
auto_identifiersexamples (Benoit Schweblin). - Improved documentation of template variables (Andrew Dunning).
-
pandocVersionis now defined inText.Pandoc.Sharedand reexported fromText.Pandoc(Alex Vong). This allows writers to access it. (Alex Vong) (API change) -
For
markdown_mmd, add:implicit_figures,superscripts,subscripts(#2401). -
Added
odtas input format (MarLinn). Added new moduleText.Pandoc.Reader.ODT(API change). Fully implemented features: Paragraphs, Headers, Basic styling, Unordered lists, Ordered lists, External Links, Internal Links, Footnotes, Endnotes, Blockquotes. Partly implemented features: Citations, Tables. -
Markdown Reader:
- Add basic tests for each header style (Ophir Lifshitz).
- Add implicit header ref tests for headers with spaces (Ophir Lifshitz).
- Skip spaces in headers (Ophir Lifshitz).
- Handle ‘id’ and ‘class’ in parsing key/value attributes (#2396).
# Header {id="myid" class="foo bar"}is now equivalent to# Header {#myid .foo .bar}. - Use ‘=’ instead of ‘#’ for atx-style headers in markdown+lhs. (Kristof Bastiaensen)
- Pipe tables: allow indented columns. Previously the left-hand column could not start with 4 or more spaces indent. This was inconvenient for right-aligned left columns. Note that the first (header column) must still have 3 or fewer spaces indentation, or the table will be treated as an indented code block.
- Fix regression: allow HTML comments containing
--. Technically this isn’t allowed in an HTML comment, but we’ve always allowed it, and so do most other implementations. It is handy if e.g. you want to put command line arguments in HTML comments.
-
LaTeX reader:
- Don’t eat excess whitespace after macros with only optional arguments (#2446).
- Support longtable (#2411).
- Implement
\Cite(#2335). - Support abstract environment. The abstract populates an
abstractmetadata field. - Properly handle booktabs lines. Lines aren’t part of the pandoc table model, so we just ignore them (#2307).
-
HTML reader:
- Handle type attribute on ol, e.g.
<ol type="i">(#2313). - Updated for new automatic header attributes.
- Add auto identifiers if not present on headers. This makes TOC linking work properly.
- Detect
font-variantwithpickStyleAttrProps(Ophir Lifshitz). - Test
<ol>type, class, and inline list-style(-type) CSS (Ophir Lifshitz). - Better handling of “section” elements (#2438). Previously
<section>tags were just parsed as raw HTML blocks. With this change, section elements are parsed as Div elements with the class “section”.
- Handle type attribute on ol, e.g.
-
MediaWiki reader: handle unquoted table attributes (#2355).
-
DocBook reader:
- Added proper support for DocBook
xrefelements (Frerich Raabe). AddeddbContentfield to reader state, so we can lookup cross refs. - Handle
informalexample(#2319).
- Added proper support for DocBook
-
Docx Reader:
- Create special punctuation test (Ophir Lifshitz).
- Parse soft, no-break hyphen elements (Ophir Lifshitz).
- Updated headers test (Ophir Lifshitz). Replaced
styles.xmlinheaders.docxwith pandoc’s currentstyles.xml, which contains styles for Heading 1 through 6. Added Heading 4 through 7 to the test document. Note that Heading 7 is not parsed as a Heading because there is no Heading 7 style.
-
RST reader: better handling of indirect roles. Previously the parser failed on this kind of case
.. role:: indirect(code) .. role:: py(indirect) :language: python :py:`hi`Now it correctly recognizes
:py:as a code role. -
Org reader:
- Add auto identifiers if not present on headers (#2354, Juliusz Gonera).
- Allow verse blocks to contain empty lines (#2402, Albert Krewinkel).
-
EPUB reader: stop mangling external URLs (#2284).
-
RST writer:
- Don’t insert
\when complex expression in matched pairs. E.g.[:sup:`3`]is okay; you don’t need[:sup:`3`\ ]. - Ensure that
\is inserted when needed before Cite and Span elements that begin with a “complex” element (jgm/pandoc-citeproc#157). - Normalize headers only in “standalone” mode (#2394).
- Don’t insert
-
Haddock writer: escape
*and^(G. Bataille). -
Markdown writer:
- In TOC, add links to headers (#829).
- Use unicode super/subscripts for digits in plain output
(when the
superscriptsandsubscriptsextensions are not enabled).
-
Docx writer:
- Moved invalid character stripping to
formattedString. This avoids an inefficient generic traversal (#2356). - Use user data directory for
reference.docxarchive. This allows the test suite to work without installing pandoc first. It also brings the docx writer in line with the odt writer. - Tests: docx writer tests now use
../datafor data directory. This allows tests to be run without installing first. - Tests: Use real jpg (not empty) for docx tests to avoid warning.
- Moved invalid character stripping to
-
LaTeX writer:
- Fixed detection of ‘chapters’ from template.
If a documentclass isn’t specified in metadata, but the
template has a hardwired bookish documentclass, act as if
--chapterswas used. This was the default in earlier versions, but it has been broken for a little while. - Correctly recognize book documentclass in metadata (#2395).
- Set language-related variables automatically, depending
on the value of the
langfield, which is now always assumed to be in BCP47 format (mb21, #1614, #2437). - Add
\protectto\hyperdefin inline context. This way we don’t get an error when this is used as a moveable argument (#2136). - Support all frame attributes in Beamer.
- Percent-encode more special characters in URLs (#1640, #2377). The special characters are ‘<’,’>’,’|’,’”’,’{’,’}’,’[’,’]’,’^’, ‘`’.
- Fixed detection of ‘chapters’ from template.
If a documentclass isn’t specified in metadata, but the
template has a hardwired bookish documentclass, act as if
-
HTML writer:
- Update KaTeX JS and CSS versions (Emily Eisenberg).
- For dzslides, add
role="note"for speaker notes (#1693). - Percent-encode more special characters in URLs (#1640, #2377). The special characters are ‘<’,’>’,’|’,’”’,’{’,’}’,’[’,’]’,’^’, ‘`’.
- Render Div with class
sectionas<section>in HTML5.
-
EPUB writer:
- In TOC, replace literal
<br/>with space (#2105). - With
--webtex, include image file rather thandata:URI (#2363).
- In TOC, replace literal
-
Native writer: format Div properly, with blocks separated.
-
Support bidirectional text output with XeLaTeX, ConTeXt and HTML (#2191, mb21).
-
Reference Docx:
- Add missing Header 6 style (steel blue) (Ophir Lifshitz).
- Correct
outlineLvlfor Header styles (Ophir Lifshitz).
-
Templates
- Beamer: Add
innertheme,outerthemevariables (Guilhem Bonnefille, #121). Add space after colon in figure caption. Integrate recent font and language updates from LaTeX template; allow use ofmainfontvariable for changing the slide text in XeTeX and LuaTeX (Andrew Dunning, #131). - LaTeX: Add
mainfontoptions,sansfontoptions,monofontoptions,mathfontoptions,fontfamilyoptions(Andrew Dunning, #122). Support handling of bidirectional text (mb21, #120). Improve reliability of superscripts/subscripts under XeTeX and prevent letters and numbers from appearing on a different baseline by removing use of therealscriptspackage (viaxltxtra). To restore use of OpenType characters for these features under XeTeX or LuaTeX, add\usepackage{realscripts}toheader-includes(Andrew Dunning, #130). Remove redundant reference toxunicode(Andrew Dunning, #130). Addfontenc,indent,subparagraphvariables (Andrew Dunning). Allow use ofhidelinksvariable forhyperrefpackage (Hugo Roy, #113). Prevent package clash withtufte-latexand other classes that includehyperreforcolor(Xavier Olive, #115). - ConTeXt: Support handling of bidirectional text (mb21, #120).
- LaTeX and ConTeXt: Use more specific language variables.
Instead of directly using
lang, we now usebabel-langandpolyglossia-langandcontext-lang. These variables are set by the writers to the necessary values, based on thelangvariable (which now always takes a value in BCP47 format). (mb21, #114, #129). - HTML: Support handling of bidirectional text (mb21, #120). Move HTML5 shiv after CSS and fix URL (Andrew Dunning). Add dir attribute in html5 (Andrew Dunning).
- reveal.js: Add
controls,progressvariables (Grégoire Pineau, #127). Addwidth,heightvariables (Anrew Dunning). Update template from 3.1 source (Andrew Dunning). All configuration options are now available as variables, but are only be included if set (reveal.js uses defaults otherwise). - man: Added comment stating that the page is autogenerated by pandoc,
giving version. Added
adjustingandhyphenatevariables (Alex Vong, #123).
- Beamer: Add
-
epub.css: added selectors for nested emphasis (Pablo Rodriguez).
-
MediaBag: ensure that
/is always used as path separator. -
sample.lua: defineCaptionedImage, add newline at end (#2393). -
Added
--bash-completionoption. This generates a bash completion script. To use:eval "$(pandoc --bash-completion)". -
Text.Pandoc.Error: Define Typeable and Exception instances for PandocError (#2386).
-
Text.Pandoc.Parsing:
toKey: strip off outer brackets. This makes keys with extra space at the beginning and end work: e.g.[foo]: bar [ foo ]will now be a link to bar (it wasn’t before).
-
Text.Pandoc: disable
auto_identifiersfor epub. The epub writer inserts its own auto identifiers; this is more complex due to splitting into “chapter” files. -
Renamed Text.Pandoc.Compat.Locale -> Text.Pandoc.Compat.Time. It now reexports Data.Time.
-
Use custom Prelude to avoid compiler warnings.
- The (non-exported) prelude is in prelude/Prelude.hs.
- It exports Monoid and Applicative, like base 4.8 prelude, but works with older base versions.
- It exports (<>) for mappend.
- It hides ‘catch’ on older base versions.
-
Added a
stack.ymaland stack install instructions to INSTALL. -
Clarified what is “out of scope” in README and CONTRIBUTING.md.
-
Added note to CONTRIBUTING.md about ghc versions and travis.
-
Clarify docs on block quotes. The space after
>is optional (#2346). -
Removed obsolete reference to default.csl (#2372).
-
List all styles in manual for
--reference-docx(Chris Black) -
Don’t capitalize header links in man page.
-
Added section on repl to CONTRIBUTING.md.
-
README: Added space after backslash in image example (#2329).
-
Document details of citation locator terms (Nick Bart).
-
Fixed some internal links in README (#2309).
-
Improve CSL documentation, variables documentations, links, and cross-references in README. (Andrew Dunning)
-
Fix build failure with
--flags=-https(Sergei Trofimovich). -
Use
newManagerinstead ofwithManagerin recenthttp-client. This avoids a deprecation warning. -
Allow building with latest versions of http-types, HUnit, criterion, syb, aeson.
-
Updated benchmark program for new criterion API.
-
Setup.hs: rewrite so as not to use process, directory, filepath. Using anything outside base is dangerous, since older versions of ghc may link against two different versions.
-
Added appveyor (Windows continuous integration) builds.
-
New
.travis.yml. Autgenerated usingmake_travis_yml.hs. This script has been modified in a few ways, e.g. to addGHCOPTS.make .travis.ymlregenerates it based on the tested-with field of the cabal file.
-
Added
--man1and--man5options to pandoc, allowing pandoc to generate its own man pages. Man pages are no longer automatically generated in the build process (the process for this was too complex and prone to failure, #2190). Themake-pandoc-man-pagesexecutable has been removed. Theman/directory has been removed, and man page templates have been moved todata/. NOTE TO PACKAGERS: You will no longer find pandoc’s man pages inman/, but you can generate them usingpandoc --man1 > pandoc.1andpandoc --man5 > pandoc_markdown.5. -
Added new unexported module:
Text.Pandoc.ManPages. -
READMEnow acts like a data file (even though it isn’t indata/). So, for example,pandoc --print-default-data-file READMEwill produce the README.) This change was required for the--man1and--man5options, since the man pages are produced from the README, but it may be useful for other purposes as well. -
Allow
reference.docxandreference.odtto be used with--print-default-data-fileand to shadow defaults if placed in the user data directory. Note that as of 1.14, we no longer include these files as data files; instead, we include their components. This change causes pandoc to behave as if it has these data files; they are constructed on demand when needed usinggetDefaultReferenceDocxandgetDefaultReferenceODT. -
Fixed regression in CSS parsing with
--self-contained(#2224). Pandoc 1.14.0.x used css-text to parse the CSS, but its parser silently drops big sections of CSS. This commit replaces the use of css-text with a small but principled CSS preprocessor, which removes whitespace and comments and replacesurl()with base 64 data when possible. -
Use
https://instead of//for MathJax and KaTeX CDN URLs (#1920). This will allow math to work when pages are being viewed locally. -
Text.Pandoc.Options: ExportplainExtensions. These are the extensions used inplainoutput. -
LaTeX reader: Don’t parse
_and^as sub/superscript outside of math mode; treat them as regular inline text. Normally these will cause an error in LaTeX, but there are contexts (e.g.allttenvironments) where they are allowed. -
HTML reader: allow
<body>to close<head>. -
DocBook reader: support
mediaobjects andfigures(#2184, mb21). -
RST reader: Fix reference names with special characters (Lars-Dominik Braun).
-
Textile writer: escape
+and-as entities (#2225). -
DokuWiki writer: Use proper
<code>tags for code blocks (#2213). -
Plain writer: don’t use symbols for super/subscript (#2237). Simplified code by using
plainExtensions. -
InDesign writer: Properly escape URLs containing more than one colon character (gohai).
-
Docx writer: Make sure we use dist version of
reference.docx(and not the user’s version) for certain settings. Taking some settings values from a user-supplied reference.docx can lead to corruption. This fixes a regression from the last release (#2249). -
Text.Pandoc.Shared: exportsgetDefaultReferenceDocxandgetDefaultReferenceODT(API change). These functions have been removed from the Docx and ODT writers. -
LaTeX template (Xavier Olive):
- Added
CJKmainfontandCJKoptionsvariables. - Allow dvipsnames (e.g.
MidnightBlue) for colors (Xavier Olive).
- Added
-
Epub templates: use
author.role, notauthor.type. -
Bump cmark version to >= 0.3.4.
-
Improved Windows installer (#2205, thanks to nkalvi). Users can now select a per-user or systemwide install, and can set the installation path. At the end of installation, the install location is given. The install location is also now given in the list of installed programs in Control Panel. Cleaner WiX syntax is used for setting the path.
-
Added
download_statstarget to Makefile.
-
Made it possible to run filters that aren’t executable (#1096). Pandoc first tries to find the executable (searching the path if path isn’t given). If it fails, but the file exists and has a
.py,.pl,.rb,.hs, or.phpextension, pandoc runs the filter using the appropriate interpreter. This should make it easier to use filters on Windows, and make it more convenient for everyone. -
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
tableenvironment (#1204). Positioning options no longer rendered verbatim. - Better handling of figure and table with caption (#1204).
- Handle
@{}andp{length}in tabular. The length is not actually recorded, but at least we get a table (#1180). - Properly handle
\nocite. It now adds anocitemetadata 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 closingdivtag would be missed if it came right after other block-level tags. - Avoid backtracking when closing
</div>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<em><span class="foo">hi</span></em>instead of<em class="foo">hi</em>. 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).
- 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
-
DocBook reader:
- Better treatment of
formalpara. We now emit the title (if present) as a separate paragraph with boldface text (#1215). - Set metadata
authornotauthors. - Added recognition of
authorgroupandreleaseinfoelements (#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).
- Better treatment of
-
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
closeswith rules from HTML5 spec. - Use Builder (Matthew Pickering, #1162).
-
RST reader:
- Remove duplicate
httpin 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
authorrather thanauthorsin metadata. - Better handling of directives. We now correctly handle field
lists that are indented more than three spaces. We treat an
aafigdirective as a code block with attributes, so it can be processed in a filter (#1212).
- Remove duplicate
-
LaTeX writer:
- Mark span contents with label if span has an ID (Albert Krewinkel).
- Made
--toc-depthwork 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:
\paragraphor\subparagraphin aquoteenvironment. This adds anmbox{}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
hyperrefandhyperdef(#1130).
-
ConTeXt writer: Improved autolinks (#1270).
-
DocBook writer:
- Improve handling of hard line breaks in Docbook writer
(Neil Mayhew). Use a
<literallayout>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).
- Improve handling of hard line breaks in Docbook writer
(Neil Mayhew). Use a
-
Docx writer: When needed files are not present in the user’s
reference.docx, fall back on the versions in thereference.docxin pandoc’s data files. This fixes a bug that occurs when areference.docxsaved 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
imgtags (#1170). - Handle media in
audiosource tags (#1170). Note that we now use amediadirectory rather thanimages. - Incorporate files linked in
videotags (#1170).srcandposterwill both be incorporated intocontent.opfand 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
<embed>to be used instead of<img>.
-
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 thatgetWriterinText.Pandocno longer returns a custom writer on inputfoo.lua.
-
AsciiDoc writer: Handle multiblock and empty table cells (#1245, #1246). Added tests.
-
Text.Pandoc.Options: AddedreaderTracetoReaderOptions -
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 inhttp-conduit.
- Added
-
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
;forTEXINPUTSseparator 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
addressis a YAML object and you just have$address$in your template, the wordtruewill appear, which may be unexpected. (Previously nothing would appear.)
-
-
Text.Pandoc.SelfContained: Handleposterattribute invideotags (#1188). -
Text.Pandoc.Parsing:- Made
Fan instance of Applicative (#1138). - Added
stateCaption. - Added
HasMacros, simplified other typeclasses. RemovedupdateHeaderMap,setHeaderMap,getHeaderMap,updateIdentifierList,setIdentifierList,getIdentifierList. - Changed the smart punctuation parser to return
Inlinesrather thanInline(Matthew Pickering). - Changed
HasReaderOptions,HasHeaderMap,HasIdentifierListfrom typeclasses of monads to typeclasses of states. This simplifies the instance definitions and provides more flexibility. Generalized type ofgetOptionand added a default definition. RemovedaskReaderOption. AddedextractReaderOption. AddedextractHeaderMapandupdateHeaderMapinHasHeaderMap. Gave default definitions forgetHeaderMap,putHeaderMap,modifyHeaderMap. AddedextractIdentifierListandupdateIdentifierListinHasIdentifierList. Gave defaults forgetIdentifierList,putIdentifierList, andmodifyIdentifierList. The ultimate goal here is to allow different parsers to use their own, tailored parser states (instead ofParserState) while still using shared functions.
- Made
-
Template changes:
- LaTeX template: Use
fontencpackage only withpdflatex(#1164). - LaTeX template: Add
linestretchandfontfamilyvariables. - 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). Loadupquoteonly afterfontenc(Yihui Xie). - Beamer template: Added caption package (#1200).
- Beamer template: changes for better unicode handling (KarolS).
- DocBook template: use
authorgroupif there are authors. - revealjs template: Move
include-afterto end (certainlyakey). - revealjs template: Fixed PDF print function (#1220, kevinkenan).
- LaTeX template: Use
-
Bumped version bounds of dependencies.
-
Added a
--tracecommand 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 (Albert Krewinkel).
-
Add
.editorconfig(Albert Krewinkel). See http://editorconfig.org/ for details. -
Give more useful error message if ‘-t pdf’ is specified (#1155).
-
Added
Cite,SmallCapstoArbitraryinstance (#1269). -
Allow
html4as a synonym ofhtmlas 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
--natbiband--biblatex. - Added specification of legal syntax for citation keys.
- Fixed variable defaults documentation (Albert Krewinkel).
- Added an explanation of how to use YAML metadata to
force items to appear in the bibliography without citations in
the text (like LaTeX
-
Removed copyright statements for files that have been removed (Albert Krewinkel).
-
Moved some doc files from
data-filestoextra-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. -
Use cabal sandboxes in Windows build script.
-
The
--bibliographyoption now sets thebiblio-filesvariable. So, if you’re using--natbibor--biblatex, you can just use--bibliography=foo.bibinstead of-V bibliofiles=foo. -
Don’t run pandoc-citeproc filter if
--bibliographyis used together with--natbibor--biblatex(Florian Eitel). -
Template changes:
- Updated beamer template to include booktabs.
- Added
abstractvariable to LaTeX template. - Put
header-includesaftertitlein 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: IncludeFootnoteTextstyle. Otherwise Word ignores the style, even when specified in thepPr. (#901) -
reference.odt: Tidiedstyles.xml. -
Relaxed version bounds for dependencies.
-
Added
withSocketsDoaround http conduit code inopenURL, so it works on Windows (#1080). -
Added
Citefunction tosample.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
Verbmacro (jrnold) (#1090). - Support babel-style quoting:
"`..."'.
- Add support for
-
Properly handle script blocks in strict mode. (That is,
markdown-markdown_in_html_blocks.) Previously a spurious<p>tag was being added (#1093). -
Docbook reader: Avoid failure if
tbodycontains notrorrowelements. -
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. (This was a regression in 1.10.)
-
HTML reader: Parse name/content pairs from meta tags as metadata. Closes #1106.
-
Moved
fixDisplayMathfrom Docx writer toWriter.Shared. -
OpenDocument writer: Fixed
RawInline,RawBlockso 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_githuboutput. A consequence of this change is that the backtick form will be preferred in general if both are enabled. That is good, as it is much more widespread than the tilde form. (#1084) -
Docx writer: Fixed problem with some modified reference docx files. Include
word/_rels/settings.xml.relsif it exists, as well as otherrelsfiles besides the ones pandoc generates explicitly. -
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!
- With
-
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 ofwriterEpubStylesheet(set by--epub-stylesheet) should again work, and take precedence over a stylesheet specified in the metadata.
-
Text.Pandoc.Pretty: Addednestle. API change. -
Text.Pandoc.MIME: Addedwmf,emf. -
Text.Pandoc.Shared:fetchItemnow handles image URLs beginning with//. -
Text.Pandoc.ImageSize: Parse EXIF format JPEGs. Previously we could only get size information for JFIF format, which led to squished images in Word documents. Closes #976. -
Removed old
MarkdownTest_1.0.3directory (#1104).
-
Metadata may now be included in YAML blocks in a markdown document. For example,
--- title: - type: main text: My Book - type: subtitle text: An investigation of metadata creator: - role: author text: John Smith - role: editor text: Sarah Jones identifier: - scheme: DOI text: doi:10.234234.234/33 publisher: My Press rights: (c) 2007 John Smith, CC BY-NC cover-image: img/mypic.jpg stylesheet: style.css ...Metadata may still be provided using
--epub-metadata; it will be merged with the metadata in YAML blocks. -
EPUB writer:
metatags are now used instead ofopfattributes for EPUB3.- Insert “svg” property as needed in opf (EPUB 3).
- Simplify
imageTypeOfusinggetMimeType. - Add properties attribute to
cover-imageitem for EPUB 3. - Don’t include node for
cover.xhtmlif no cover! - Ensure that same identifier is used throughout (#1044). If an identifier is given in metadata, we use that; otherwise we generate a random uuid.
- Add cover reference to guide element (EPUB 2) (Shaun Attfield).
Fixes an issue with Calibre putting the cover at the end of the book
if the spine has
linear="no". Apparently this is best practice for other converters as well: http://www.idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.6. - Allow
stylesheetin metadata. The value is a path to the stylesheet. - Allow partial dates:
YYYY,YYYY-MM.
-
Markdown writer: Fix rendering of tight sublists (#1050). Previously a spurious blank line was included after a tight sublist.
-
ODT writer: Add
draw:nameattribute todraw:frameelements (#1069). This is reported to be necessary to avoid an error from recent versions of Libre Office when files contain more than one image Thanks to wmanley for reporting and diagnosing the problem. -
ConTeXt writer: Don’t hardcode figure/table placement and numbering. Instead, let this be set in the template, using
\setupfloat. Thanks to on4aa and Aditya Mahajan for the suggestion (#1067). -
Implemented CSL flipflopping spans in DOCX, LaTeX, and HTML writers.
-
Fixed bug with markdown intraword emphasis. Closes #1066.
-
Docbook writer: Hierarchicalize block content in metadata. Previously headers just disappeared from block-level metadata when it was used in templates. Now we apply the ‘hierarchicalize’ transformation. Note that a block headed by a level-2 header will turn into a
<sect1>element. -
OpenDocument writer: Skip raw HTML (#1035). Previously it was erroneously included as verbatim text.
-
HTML/EPUB writer, footnotes: Put
<sup>tag inside<a>tags. This allows better control of formatting, since the<a>tags have a distinguishing class (#1049). -
Docx writer:
- Use mime type info returned by fetchItem.
- Fixed core metadata (#1046).
Don’t create empty date nodes if no date given.
Don’t create multiple
dc:creatornodes; instead separate by semicolons. - Fix URL for core-properties in
_rels/.rels(#1046).
-
Plain writer: don’t print
<span>tags. -
LaTeX writer:
- Fix definition lists with internal links in terms (#1032). This fix puts braces around a term that contains an internal link, to avoid problems with square brackets.
- Properly escape pdftitle, pdfauthor (#1059).
- Use booktabs package for tables (thanks to Jose Luis Duran).
-
Updated beamer template. Now references should work properly (in a slide) when
--biblatexor--natbibis used. -
LaTeX reader:
- Parse contents of curly quotes or matched
"as quotes. - Support
\textnormalas span with classnodecor. This is needed for pandoc-citeproc. - Improved citation parsing. This fixes a run-time error that occurred
with
\citet{}(empty list of keys). It also ensures that empty keys don’t get produced.
- Parse contents of curly quotes or matched
-
MediaWiki reader: Add automatic header identifiers.
-
HTML reader:
- Use pandoc
DivandSpanfor raw<div>,<span>when--parse-raw. - Recognize
svgtags as block level content (thanks to MinRK). - Parse LaTeX math if appropriate options are set.
- Use pandoc
-
Markdown reader:
- Yaml block must start immediately after
---. If there’s a blank line after---, we interpreted it as a horizontal rule. - Correctly handle empty bullet list items.
- Stop parsing “list lines” when we hit a block tag.
This fixes exponential slowdown in certain input, e.g.
a series of lists followed by
</div>.
- Yaml block must start immediately after
-
Slides: Preserve
<div class="references">in references slide. -
Text.Pandoc.Writer.Shared:- Fixed bug in
tagWithAttrs. A space was omitted before key-value attributes, leading to invalid HTML. normalizeDate: Allow dates with year only (thanks to Shaun Attfield).- Fixed bug in
openURLwithdata:URIs. Previously the base-64 encoded bytestring was returned. We now decode it so it’s a proper image!
- Fixed bug in
-
DocBook reader: Handle numerical attributes starting with decimal. Also use
safeReadinstead ofread. -
Text.Pandoc.Parsing:- Generalized type of
registerHeader, using new type classesHasReadeOptions,HasIdentifierList,HasHeaderMap. These allow certain common functions to be reused even in parsers that use custom state (instead ofParserState), such as the MediaWiki reader. - Moved inlineMath, displayMath from Markdown reader to Parsing. Generalize their types and export them from Parsing. (API change.)
- Generalized type of
-
Text.Pandoc.Readers.TexMath: ExportreadTeXMath', which attends to display/inline. DeprecatereadTeXMath, and usereadTeXMath'in all the writers. Requiretexmath >= 0.6.5.2. -
Text.Pandoc.MIME:- Add entry for
jfif. - In looking up extensions, drop the encoding info. E.g. for ‘image/jpg;base64’ we should lookup ‘image/jpg’.
- Add entry for
-
Templates: Changed how array variables are resolved. Previously if
foois an array (which might be because multiple values were set on the command line),$foo$would resolve to the concatenation of the elements of foo. This is rarely useful behavior. It has been changed so that the first value is rendered. Of course, you can still iterate over the values using$for(foo)$. This has the result that you can override earlier settings using-Vby putting new values later on the command line, which is useful for many purposes. -
Text.Pandoc: Don’t default topandocExtensionsfor all writers. -
Allow “epub2” as synonym for “epub”, “html4” for “html”.
-
Don’t look for slidy files in data files with
--self-contained. -
Allow
https:command line arguments to be downloaded. -
Fixed
make_osx_package.shso data files embedded inpandoc-citeproc.
-
--toc-levelno 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. -
--helpnow prints in and out formats in alphabetical order, and says something about PDF output (#720). -
--self-containednow 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 takebibliography,csl, andcitation-abbreviationsfrom the metadata, though it may still be specified on the command line as before. -
A
Citeelement is now created in parsing markdown whether or not there is a matching reference. -
The
pandoc-citeprocscript will put the bibliography at the end of the document, as before. However, it will be put inside aDivelement with class “references”, allowing users some control over the styling of references. A final header, if any, will be included in theDiv. -
The markdown writer will not print a bibliography if the
citationsextension 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 occurred 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:<math>...</math>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
--variablewill completely shadow metadata fields. -
If
--variableis used to set many variables with the same name, a list is created. -
Man writer: The
title,section,header, andfootercan now all be set individually in metadata. Thedescriptionvariable has been removed. Quotes have been added so that spaces are allowed in the title. If you have a title that beginsCOMMAND(1) footer here | header herepandoc will still parse it into a title, section, header, and footer. But you can also specify these elements explicitly (#885).
-
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_tablesand all tables will render as grid tables. - Support YAML title block (render fields in alphabetical order to make output predictable).
- Allow simple tables to be printed as grid tables,
if other table options are disabled. This means you can do
-
MetainText.Pandoc.Definitionhas been changed to allow structured metadata. (Note: existing code that pattern-matches onMetawill have to be revised.) Metadata can now contain indefinitely many fields, with content that can be a string, a Boolean, a list ofInlineelements, a list ofBlockelements, or a map or list of these. -
A new generic block container (
Div) has been added toBlock, and a generic inline container (Span) has been added toInline. These can take attributes. They will render in HTML, Textile, MediaWiki, Org, RST and Markdown (withmarkdown_in_htmlextension) as HTML<div>and<span>elements; in other formats they will simply pass through their contents. But they can be targeted by scripts. -
Formatis now a newtype, not an alias for String. Equality comparisons are case-insensitive. -
Added
Text.Pandoc.Walk, which exports hand-written tree-walking functions that are much faster than the SYB functions fromText.Pandoc.Generic. These functions are now used where possible in pandoc’s code. (Tests.Walkverifies thatwalkandquerymatch the generic traversalsbottomUpandqueryWith.) -
Added
Text.Pandoc.JSON, which providesToJSONandFromJSONinstances for the basic pandoc types. They use GHC generics and should be faster than the old JSON serialization usingData.Aeson.Generic. -
Added
Text.Pandoc.Process, exportingpipeProcess. This is a souped-up version ofreadProcessWithErrorcodethat uses lazy bytestrings instead of strings and allows setting environment variables. (Used inText.Pandoc.PDF.) -
New module
Text.Pandoc.Readers.OPML. -
New module
Text.Pandoc.Writers.OPML. -
New module
Text.Pandoc.Readers.Haddock(David Lazar). This is based on Haddock’s own lexer/parser. -
New module
Text.Pandoc.Writers.Custom. -
In
Text.Pandoc.Shared,openURLandfetchItemnow return an Either, for better error handling. -
Made
stringifypolymorphic inText.Pandoc.Shared. -
Removed
stripTagsfromText.Pandoc.XML. -
Text.Pandoc.Templates:- Simplified
Templatetype to a newtype. - Removed
Empty. - Changed type of
renderTemplate: it now takes a JSON context and a compiled template. - Export
compileTemplate. - Export
renderTemplate'that takes a string instead of a compiled template. - Export
varListToJSON.
- Simplified
-
Text.Pandoc.PDFexportsmakePDFinstead oftex2pdf. -
Text.Pandoc:- Made
toJsonFilteran alias fortoJSONFilterfromText.Pandoc.JSON. - Removed
ToJsonFiltertypeclass.ToJSONFilterfromText.Pandoc.JSONshould be used instead. (Compiling against pandoc-types instead of pandoc will also produce smaller executables.)
- Removed the deprecated
jsonFilterfunction.
- Added
readJSON,writeJSONto the API (#817).
- Made
-
Text.Pandoc.Options:- Added
Ext_lists_without_preceding_blankline,Ext_ascii_identifiers,Ext_ignore_line_breaks,Ext_yaml_metadataBlocktoExtension. - Changed
writerSourceDirectorytowriterSourceURLand changed the type to aMaybe.writerSourceURLis set to ‘Just url’ when the first command-line argument is an absolute URL. (So, relative links will be resolved in relation to the first page.) Otherwise, ‘Nothing’. - All bibliography-related fields have been removed from
ReaderOptionsandWriterOptions:writerBiblioFiles,readerReferences,readerCitationStyle.
- Added
-
The
Text.Pandoc.Bibliomodule has been removed. Users of the pandoc library who want citation support will need to useText.CSL.Pandocfrompandoc-citeproc.
-
Markdown reader:Improved strong/emph parsing, using the strategy of https://github.com/jgm/Markdown. The new parsing algorithm requires no backtracking, and no keeping track of nesting levels. It will give different results in some edge cases, but these should not affect normal uses.
-
Added
Text.Pandoc.Compat.Monoid. This allows pandoc to compile withbase< 4.5, whereData.Monoiddoesn’t export<>. Thanks to Dirk Ullirch for the patch. -
Added
Text.Pandoc.Compat.TagSoupEntity. This allows pandoc to compile withtagsoup0.13.x. Thanks to Dirk Ullrich for the patch. -
Most of
Text.Pandoc.Readers.TeXMathhas been moved to thetexmathmodule (0.6.4). (This allowspandoc-citeprocto handle simple math in bibliography fields.) -
Added
Text.Pandoc.Writers.Sharedfor shared functions used only in writers.metaToJSONis used in writers to create a JSON object for use in the templates from the pandoc metadata and variables.getField,setField, anddefFieldare for working with JSON template contexts. -
Added
Text.Pandoc.Asciifyutility module. This exports functions to create ASCII-only versions of identifiers. -
Text.Pandoc.Parsing- Generalized state type on
readWith(API change). - Specialize readWith to
Stringinput. (API change). - In
ParserState, replacestateTitle,stateAuthors,stateDatewithstateMetaandstateMeta'.
- Generalized state type on
-
Text.Pandoc.UTF8: use strict bytestrings in reading. The use of lazy bytestrings seemed to cause problems using pandoc on 64-bit Windows 7/8 (#874). -
Factored out
registerHeaderfrom markdown reader, added toText.Pandoc.Parsing. -
Removed
blaze_html_0_5flag, requireblaze-html>= 0.5. Reason: < 0.5 does not provide a monoid instance for Attribute, which is now needed by the HTML writer (#803). -
Added
http-conduitflag, which allows fetching https resources. It also brings in a large number of dependencies (http-conduitand its dependencies), which is why for now it is an optional flag (#820). -
Added CONTRIBUTING.md.
-
Improved INSTALL instructions.
-
make-windows-installer.bat: Removed explicit paths for executables. -
aesonis now used instead ofjsonfor JSON. -
Set default stack size to 16M. This is needed for some large conversions, esp. if pandoc is compiled with 64-bit ghc.
-
Various small documentation improvements. Thanks to achalddave and drothlis for patches.
-
Removed comment that chokes recent versions of CPP (#933).
-
Removed support for GHC version < 7.2, since pandoc-types now requires at least GHC 7.2 for GHC generics.
-
Text.Pandoc.Definition: AddedAttrfield toHeader. Previously header identifiers were autogenerated by the writers. Now they are added in the readers (either automatically or explicitly). -
Text.Pandoc.Builder:InlinesandBlocksare now synonyms forMany InlineandMany Block.Manyis a newtype wrapper aroundSeq, with custom Monoid instances forMany InlineandMany Block. This allowsManyto be made an instance ofFoldableandTraversable`.- The old
Listableclass has been removed. - The module now exports
isNull,toList,fromList. - The old
ReadandShowinstances have been removed; derived instances are now used. - Added
headerWith.
-
The readers now take a
ReaderOptionsrather than aParserStateas a parameter. Indeed, not all parsers use theParserStatetype; some have a custom state. The motivation for this change was to separate user-specifiable options from the accounting functions of parser state. -
New module
Text.Pandoc.Options. This includes theWriterOptionsformerly inText.Pandoc.Shared, and its associated data types. It also includes a new typeReaderOptions, which contains many options formerly inParserState, and its associated data types:ParserState.stateParseRaw->ReaderOptions.readerParseRaw.ParserState.stateColumns->ReaderOptions.readerColumns.ParserState.stateTabStop->ReaderOptions.readerTabStop.ParserState.stateOldDashes->ReaderOptions.readerOldDashes.ParserState.stateLiterateHaskell->ReaderOptions.readerLiterateHaskell.ParserState.stateCitations->ReaderOptions.readerReferences.ParserState.stateApplyMacros->ReaderOptions.readerApplyMacros.ParserState.stateIndentedCodeClasses->ReaderOptions.readerIndentedCodeClasses.- Added
ReaderOptions.readerCitationStyle.
-
WriterOptionsnow includeswriterEpubVersion,writerEpubChapterLevel,writerEpubStylesheet,writerEpubFonts,writerReferenceODT,writerReferenceDocx, andwriterTOCDepth.writerEPUBMetadatahas been renamedwriterEpubMetadatafor consistency. -
Changed signatures of
writeODT,writeDocx,writeEPUB, since they no longer stylesheet, fonts, reference files as separate parameters. -
Removed
writerLiterateHaskellfromWriterOptions, andreaderLiterateHaskellfromReaderOptions. LHS is now handled by an extension (Ext_literate_haskell). -
Removed deprecated
writerXeTeX. -
Removed
writerStrictfromWriterOptions. AddedwriterExtensions. Strict is now handled through extensions. -
Text.Pandoc.OptionsexportspandocExtensions,strictExtensions,phpMarkdownExtraExtensions,githubMarkdownExtensions, andmultimarkdownExtensions, as well as theExtensionstype. -
New
Text.Pandoc.Readers.MediaWikimodule, exportingreadMediaWiki. -
New
Text.Pandoc.Writers.FB2module, exportingwriteFB2(thanks to Sergey Astanin). -
Text.Pandoc:- Added
getReader,getWritertoText.Pandoc. writersis now an association list(String, Writer). AWritercan be aPureStringWriter, anIOStringWriter, or anIOByteStringWriter. ALL writers are now in the ‘writers’ list, including the binary writers and FB2 writer. This allows code inpandoc.hsto be simplified.- Changed type of
readers, so all readers are in IO. Users who want pure readers can still get them form the reader modules; this just affects the functiongetReaderthat looks up a reader based on the format name. The point of this change is to make it possible to print warnings from the parser.
- Added
-
Text.Pandoc.Parsing:Text.Parsecnow exports all Parsec functions used in pandoc code. No other module directly imports Parsec. This will make it easier to change the parsing backend in the future, if we want to.Text.Parsecis used instead ofText.ParserCombinators.Parsec.- Export the type synonym
Parser. - Export
widthsFromIndices,NoteTable',KeyTable',Key',toKey',withQuoteContext,singleQuoteStart,singleQuoteEnd,doubleQuoteStart,doubleQuoteEnd,ellipses,apostrophe,dash,nested,F(..),askF,asksF,runF,lineBlockLines. ParserStateis no longer an instance ofShow.- Added
stateSubstitutionsandstateWarningstoParserState. - Generalized type of
withQuoteContext. - Added
guardEnabled,guardDisabled,getOption. - Removed
failIfStrict. lookupKeySrcandfromKeyare no longer exported.
-
Data.Defaultinstances are now provided forReaderOptions,WriterOptions, andParserState.Text.Pandocre-exportsdef. Now you can usedef(which is re-exported byText.Pandoc) instead ofdefaultWriterOptions(which is still defined). Closes #546. -
Text.Pandoc.Shared:- Added
safeRead. - Renamed
removedLeadingTrailingSpacetotrim,removeLeadingSpacetotriml, andremoveTrailingSpacetotrimr. - Count
\ras space intrimfunctions. - Moved
renderTags'from HTML reader andText.Pandoc.SelfContainedtoShared. - Removed
failUnlessLHS. - Export
compactify', formerly in Markdown reader. - Export
isTightList. - Do not export
findDataFile. readDataFilenow returns a strict ByteString.- Export
readDataFileUTF8which returns a String, like the oldreadDataFile. - Export
fetchItemandopenURL.
- Added
-
Text.Pandoc.ImageSize: Use strict, not lazy bytestrings. RemovedreadImageSize. -
Text.Pandoc.UTF8: ExportencodePath,decodePath,decodeArg,toString,fromString,toStringLazy,fromStringLazy. -
Text.Pandoc.UTF8is now an exposed module. -
Text.Pandoc.Biblio:- csl parameter now a
Stringrather than aFilePath. - Changed type of
processBiblio. It is no longer in the IO monad. It now takes aMaybe Styleargument rather than parameters for CSL and abbrev filenames. (pandoc.hsnow calls the functions to parse the style file and add abbreviations.)
- csl parameter now a
-
Markdown reader now exports
readMarkdownWithWarnings. -
Text.Pandoc.RTFnow exportswriteRTFWithEmbeddedImagesinstead ofrtfEmbedImage.
-
We no longer depend on
utf8-string. Instead we use functions defined inText.Pandoc.UTF8that useData.Text’s conversions. -
Use
safeReadinstead of usingreadsdirectly (various modules). -
“Implicit figures” (images alone in a paragraph) are now handled differently. The markdown reader gives their titles the prefix
fig:; the writers look for this before treating the image as a figure. Though this is a bit of a hack, it has two advantages: (i) implicit figures can be limited to the markdown reader, and (ii) they can be deactivated by turning off theimplicit_figuresextension. -
catchfromControl.Exceptionis now used instead of the old Prefacecatch. -
Text.Pandoc.Shared: Improved algorithm fornormalizeSpacesandoneOfStrings(which is now non-backtracking). -
Text.Pandoc.Biblio: Remove workaround fortoCapital. Now citeproc-hs is fixed upstream, so this is no longer needed. Closes #531. -
Textile reader: Improved speed of
hyphenedWords. This speeds up the textile reader by about a factor of 4. -
Use
Text.Pandoc.Builderin RST reader, for more flexibility, better performance, and automatic normalization. -
Major rewrite of markdown reader:
- Use
Text.Pandoc.Builderinstead of lists. This also means that everything is normalized automatically. - Move to a one-pass parsing strategy, returning values in the reader monad, which are then run (at the end of parsing) against the final parser state.
- Use
-
In HTML writer, we now use
toHtmlinstead of pre-escaping. We work around the problem that blaze-html unnecessarily escapes'by pre-escaping just the'characters, instead of the whole string. If blaze-html later stops escaping'characters, we can simplifystrToHtmltotoHtml. Closes #629. -
Moved code for embedding images in RTFs from
pandoc.hsto the RTF writer (which now exportswriteRTFWithEmbeddedImages). -
Moved citation processing from
pandoc.hsinto the readers. This makes things more convenient for library users. -
The man pages are now built by an executable
make-pandoc-man-pages, which has its own stanza in the cabal file so that dependencies can be handled by Cabal. Special treatment inSetup.hsensures that this executable never gets installed; it is only used to create the man pages. -
The cabal file has been modified so that the pandoc library is used in building the pandoc executable. (This required moving
pandoc.hsfromsrcto..) This cuts compile time in half. -
The
executableandlibraryflags have been removed. -
-threadedhas been removed from ghc-options. -
Version bounds of dependencies have been raised, and the
blaze_html_0_5flag now defaults to True. Pandoc now compiles on GHC 7.6. -
We now require base >= 4.2.
-
Integrated the benchmark program into cabal. One can now do:
cabal configure --enable-benchmarks && cabal build cabal bench --benchmark-option='markdown' --benchmark-option='-s 20'The benchmark now uses README + testsuite, so benchmark results from older versions aren’t comparable.
-
Integrated test suite with cabal. To run tests, configure with
--enable-tests, thencabal test. You can specify particular tests using--test-options='-t markdown'. No output is shown unless tests fail. The Haskell test modules have been moved fromsrc/totests/. -
Moved all data files and templates to the
data/subdirectory. -
Added an
embed_data_filescabal flag. This causes all data files to be embedded in the binary, so that the binary is self-sufficient and can be relocated anywhere, copied on a USB key, etc. The Windows installer now uses this. (Since we no longer have the option to build the executable without the library, this is the only way to get a relocatable binary on Windows.) -
Removed pcre3.dll from windows package. It isn’t needed unless highlighting-kate is compiled with the
pcre-lightflag. By default, regex-prce-builtin is used.
-
Fixed parsing of consecutive lists in markdown. Pandoc previously behaved like Markdown.pl for consecutive lists of different styles. Thus, the following would be parsed as a single ordered list, rather than an ordered list followed by an unordered list:
1. one 2. two - one - twoThis change makes pandoc behave more sensibly, parsing this as two lists. Any change in list type (ordered/unordered) or in list number style will trigger a new list. Thus, the following will also be parsed as two lists:
1. one 2. two a. one b. twoSince we regard this as a bug in Markdown.pl, and not something anyone would ever rely on, we do not preserve the old behavior even when
--strictis selected. -
Dashes work differently with
--smart:---is always em-dash, and--is always en-dash. Pandoc no longer tries to guess when-should be en-dash. Note: This may change how existing documents look when processed with pandoc. A new option,--old-dashes, is provided for legacy documents. -
The markdown writer now uses setext headers for levels 1-2. The old behavior (ATX headers for all levels) can be restored using the new
--atx-headersoption. -
Links are now allowed in markdown image captions. They are also allowed in links, but will appear there as regular text. So,
[link with [link](/url)](/url)will turn into
<p><a href="/url">link with link</a></p> -
Improved handling of citations using
citeproc-hs-0.3.4. Added--citation-abbreviationsoption. -
Citation keys can no longer end with a punctuation character. This means that
@item1.will be parsed as a citation with key ‘item1’, followed by a period, instead of a citation with key ‘item1.’, as was the case previously. -
In HTML output, citations are now put in a span with class
citation. -
The markdown reader now recognizes DocBook block and inline tags. It was always possible to include raw DocBook tags in a markdown document, but now pandoc will be able to distinguish block from inline tags and behave accordingly. Thus, for example,
<sidebar> hello </sidebar>will not be wrapped in
<para>tags. -
The LaTeX parser has been completely rewritten; it is now much more accurate, robust, and extensible. However, there are two important changes in how it treats unknown LaTeX. (1) Previously, unknown environments became BlockQuote elements; now, they are treated as “transparent”, so
\begin{unknown}xyz\end{unknown}is the same asxyz. (2) Previously, arguments of unknown commands were passed through with their braces; now the braces are stripped off. -
--smartis no longer selected automatically withmanoutput. -
The deprecated
--xetexoption has been removed. -
The
--html5/-5option has been deprecated. Use-t html5instead.html5andhtml5+lhsare now separate output formats. -
Single quotes are no longer escaped in HTML output. They do not need to be escaped outside of attributes.
-
Pandoc will no longer transform leading newlines in code blocks to
<br/>tags. -
The ODT writer now sizes images appropriately, using the image size and DPI information embedded in the image.
-
--standaloneis once again implicitly for a non-text output format (ODT, EPUB). You can again dopandoc test.txt -o test.odtand get a standalone ODT file. -
The Docbook writer now uses
<sect1>,<sect2>, etc. instead of<section>. -
The HTML writer now uses
<del>for strikeout. -
In HTML output with
--section-divs, the classessectionandlevel[1,2,..6]are put on thedivtags so they can be styled. In HTML 5 output with--section-divs, the classeslevel[1,2,...6]are put onsectiontags. -
EPUB writer changes:
- The
langvariable now sets the language in the metadata (if it is not set, we default to the locale). - EPUB: UTF-8 is used rather than decimal entities.
- The
-
Added
titleslideclass to title slide in S5 template. -
In HTML, EPUB, and docx metadata, the date is normalized into YYYY-MM-DD format if possible. (This is required for validation.)
-
Attributes in highlighted code blocks are now preserved in HTML. The container element will have the classes, id, and key-value attributes you specified in the delimited code block. Previously these were stripped off.
-
The reference backlink in the HTML writer no longer has a special
footnoteBacklinkclass. -
The HTML template has been split into
htmlandhtml5templates. -
Author and date are treated more consistently in HTML templates. Authors are now
<h2>, date<h3>. -
URLs are hyphenated in the ConTeXt writer (B. Scott Michel).
-
In
Text.Pandoc.Builder,+++has been replaced by<>.
-
Removed
Apostrophe,EmDash,EnDash, andEllipsesfrom the nativeInlinetype in pandoc-types. Now we useStrelements with unicode. -
Improvements to
Text.Pandoc.Builder:InlinesandBlocksare now newtypes (not synonyms for sequences).- Instances are defined for
IsString,Show,Read,Monoid, and a newListableclass, which allows these to be manipulated to some extent like lists. Monoid append includes automatic normalization. +++has been replaced by<>(mappend).
-
Use blaze-html instead of xhtml for HTML generation. This changes the type of
writeHtml. -
Text.Pandoc.Shared:- Added
warnanderr. - Removed
unescapeURI, modifiedescapeURI. (See under [behavior changes], above.)
- Added
-
Changes in URI escaping: Previously the readers escaped URIs by converting unicode characters to octets and then percent encoding. Now unicode characters are left as they are, and
escapeURIonly percent-encodes space characters. This gives more readable URIs, and works well with modern user agents. URIs are no longer unescaped at all on conversion tomarkdown,asciidoc,rst,org. -
New module
Text.Pandoc.SelfContained. -
New module
Text.Pandoc.Docx. -
New module
Text.Pandoc.PDF. -
Added
writerBeamertoWriterOptions. -
Added
normalizeDatetoText.Pandoc.Shared. -
Added
splitStringWithIndicesinText.Pandoc.Shared. This is likesplitWithIndices, but it is sensitive to distinctions between wide, combining, and regular characters. -
Text.Pandoc.Pretty:- Added
chompcombinator. - Added
beforeNonBreakcombinator. This allows you to include something conditionally on it being before a nonblank. Used for RST inline math. - Added
charWidthfunction. All characters marked W or F in the unicode spec EastAsianWidth.txt get width 2. - Added
realLength, based oncharWidth.realLengthis now used in calculating offsets.
- Added
-
New module
Text.Pandoc.Slides, for common functions for breaking a document into slides. -
Removed
Text.Pandoc.S5, which is no longer needed. -
Removed
Text.Pandoc.CharacterReferences. MovedcharacterReferencetoText.Pandoc.Parsing.decodeCharacterReferencesis replaced byfromEntitiesinText.Pandoc.XML. -
Added
Text.Pandoc.ImageSize. This is intened for use indocxandodtwriters, so the size and dpi of images can be calculated. -
Removed
writerAsciiinWriterOptions. -
Added
writerHighlighttoWriterOptions. -
Added
DZSlidestoHTMLSlideVariant. -
writeEPUBhas a new argument for font files to embed. -
Added
stateLastStrPostoParserState. This lets us keep track of whether we’re parsing the position immediately after a regular (non-space, non-symbol) string, which is useful for distinguishing apostrophes from single quote starts. -
Text.Pandoc.Parsing:escapednow returns aChar.- Removed
charsInBalanced', added a character parser as a parameter ofcharsInBalanced. This is needed for proper handling of escapes, etc. - Added
withRaw.
-
Added
toEntitiestoText.Pandoc.XML. -
Text.Pandoc.Readers.LaTeX:- Export
handleIncludes. - Export
rawLaTeXBlockinstead ofrawLaTeXEnvironment'.
- Export
-
Added
ToJsonFilterclass andtoJsonFilterfunction toText.Pandoc, deprecating the oldjsonFilterfunction. -
Text.Pandoc.Highlighting:- Removed
highlightHtml,defaultHighlightingCss. - Export
formatLaTeXInline,formatLaTeXBlock, andhighlight, plus key functions from highlighting-kate. - Changed types of highlighting function.
highlightreturns aMaybe, not anEither.
- Removed
-
Added
--epub-cover-imageoption. -
Documented
--biblatexand--natbiboptions. -
Allow
--section-divswith slidy output. Resolves Issue #296. -
Disallow notes within notes in reST and markdown. These previously caused infinite looping and stack overflows. For example:
[^1] [^1]: See [^1]Note references are allowed in reST notes, so this isn’t a full implementation of reST. That can come later. For now we need to prevent the stack overflows. Partially resolves Issue #297.
-
EPUB writer: Allow non-plain math methods.
-
Forbid ()s in citation item keys. Resolves Issue #304: problems with
(@item1; @item2)because the final paren was being parsed as part of the item key. -
Changed URI parser so it doesn’t include trailing punctuation. So, in RST,
http://google.com.should be parsed as a link followed by a period. The parser is smart enough to recognize balanced parentheses, as often occur in wikipedia links:http://foo.bar/baz_(bam). -
Markdown+lhs reader: Require space after inverse bird tracks, so that HTML tags can be used freely at the left margin of a markdown+lhs document. Thanks to Conal Elliot for the suggestion.
-
Markdown reader: Fixed bug in footnote order (reported by CircleCode).
-
RST reader:
- Fixed bug in in field lists with multi-line items at the end of the list.
- Added parentheses to RST
specialChars, so(http://google.com)will be parsed as a link in parens. Resolves Issue #291. - Allow
|followed by newline in RST line block.
-
LaTeX reader:
- Support
\dots. - Gobble option & space after linebreak
\\[10pt].
- Support
-
Textile reader:
- Make it possible to have colons after links. (qerub)
- Make it possible to have colons after links. (Christoffer Sawicki)
-
HTML reader:
- Skip spaces after
<b>,<emph>, etc. - Handle tbody, thead in simple tables. Closes #274.
- Implicit
Paras instead ofPlainsin some contexts.
- Skip spaces after
-
OpenDocument writer: Use special
First paragraphstyle for first paragraph after most non-paragraph blocks. This allows users to specify e.g. that only paragraphs after the first paragraph of a block are to be indented. Thanks to Andrea Rossato for the patch. Closes #20. -
LaTeX writer: use
deVerbon table and picture captions. Otherwise LaTeX complains about\verbinside command argument. Thanks to bbanier for reporting the bug. -
Markdown writer: Insert HTML comment btw list and indented code block. This prevents the code block from being interpreted as part of the list.
-
EPUB writer: Add a meta element specify the cover. Some EPUB e-readers, such as the Nook, require a meta element inside the OPF metadata block to ensure the cover image is properly displayed. (Kelsey Hightower)
-
HTML writer: Use embed tag for images with non-image extensions. (e.g. PDFs). Closes #264.
-
LaTeX writer: Improved tables.
- More space between lines, top-align cells.
- Use ctable package, which allows footnotes and provides additional options.
- Made cell alignments work in multiline tables.
- Closes #271, #272.
-
Un-URI-escape image filenames in LaTeX, ConTeXt, RTF, Texinfo. Also do this when copying image files into EPUBs and ODTs. Closes #263.
-
Changed to github issue tracker.
-
Added failing emph/strong markdown test case due to Perry Wagle.
-
Slidy improvements:
- Updated to use Slidy2.
- Fixed bug, unclosed div tag.
- Added
durationvariable in template. Setting this activates the timer. - Use ‘titlepage’ instead of ‘cover’ for title div.
-
Support for citations using Andrea Rossato’s
citeproc-hs0.3. You can now write, for example,Water is wet [see @doe99, pp. 33-35; also @smith04, ch. 1].and, when you process your document using
pandoc, specifying a citation style using--csland a bibliography using--bibliography, the citation will be replaced by an appropriately formatted citation, and a list of works cited will be added to the end of the document.This means that you can switch effortlessly between different citation and bibliography styles, including footnote, numerical, and author-date formats. The bibliography can be in any of the following formats: MODS, BibTeX, BibLaTeX, RIS, EndNote, EndNote XML, ISI, MEDLINE, Copac, or JSON. See the README for further details.
Citations are supported in the markdown reader, using a special syntax, and in the LaTeX reader, using natbib or biblatex syntax. (Thanks to Nathan Gass for the natbib and biblatex support.)
-
New
textilereader and writer. Thanks to Paul Rivier for contributing thetextilereader, an almost complete implementation of the textile syntax used by the ruby RedCloth library. Resolves Issue #51. -
New
orgwriter, for Emacs Org-mode, contributed by Puneeth Chaganti. -
New
jsonreader and writer, for reading and writing a JSON representation of the native Pandoc AST. These are much faster than thenativereader and writer, and should be used for serializing Pandoc to text. To convert between the JSON representation and native Pandoc, useencodeJSONanddecodeJSONfromText.JSON.Generic. -
A new
jsonFilterfunction inText.Pandocmakes it easy to write scripts that transform a JSON-encoded pandoc document. For example:-- removelinks.hs - removes links from document import Text.Pandoc main = interact $ jsonFilter $ bottomUp removeLink where removeLink (Link xs _) = Emph xs removeLink x = xTo use this to remove links while translating markdown to LaTeX:
pandoc -t json | runghc removelinks.hs | pandoc -f json -t latex -
Attributes are now allowed in inline
Codeelements, for example:In this code, `ulist ! [theclass "special"] << elts`{.haskell} is...The attribute syntax is the same as for delimited code blocks.
Codeinline has an extra argument place for attributes, just likeCodeBlock. Inline code will be highlighted in HTML output, if pandoc is compiled with highlighting support. Resolves Issue #119. -
New
RawBlockandRawInlineelements (replacingRawHtml,HtmlInline, andTeX) provide lots of flexibility in writing scripts to transform Pandoc documents. Scripts can now change how each element is rendered in each output format. -
You can now define LaTeX macros in markdown documents, and pandoc will apply them to TeX math. For example,
\newcommand{\plus}[2]{#1 + #2} $\plus{3}{4}$yields
3+4. Since the macros are applied in the reader, they will work in every output format, not just LaTeX. -
LaTeX macros can also be used in LaTeX documents (both in math and in non-math contexts).
-
A new
--mathjaxoption has been added for displaying math in HTML using MathJax. Resolves issue #259. -
Footnotes are now supported in the RST reader. (Note, however, that unlike docutils, pandoc ignores the numeral or symbol used in the note; footnotes are put in an auto-numbered ordered list.) Resolves Issue #258.
-
A new
--normalizeoption causes pandoc to normalize the AST before writing the document. This means that, for example,*hi**there*will be rendered as<em>hithere</em>instead of<em>hi</em><em>there</em>. This is not the default, because there is a significant performance penalty. -
A new
--chapterscommand-line option causes headers in DocBook, LaTeX, and ConTeXt to start with “chapter” (level one). Resolves Issue #265. -
In DocBook output,
<chapter>is now used for top-level headers if the template contains<book>. Resolves Issue #265. -
A new
--listingsoption inpandocandmarkdown2pdfcauses the LaTeX writer to use the listings package for code blocks. (Thanks to Josef Svennigsson for the pandoc patch, and Etienne Millon for the markdown2pdf patch.) -
markdown2pdfnow supports--data-dir. -
URLs in autolinks now have class “url” so they can be styled.
-
Improved prettyprinting in most formats. Lines will be wrapped more evenly and duplicate blank lines avoided.
-
New
--columnscommand-line option sets the column width for line wrapping and relative width calculations for tables. -
Made
--smartwork in HTML, RST, and Textile readers, as well as markdown. -
Added
--html5option for HTML5 output. -
Added support for listings package in LaTeX reader (Puneeth Chaganti).
-
Added support for simple tables in the LaTeX reader.
-
Added support for simple tables in the HTML reader.
-
Significant performance improvements in many readers and writers.
-
Moved
Text.Pandoc.Definitionfrom thepandocpackage to a new auxiliary package,pandoc-types. This will make it possible for other programs to supply output in Pandoc format, without depending on the whole pandoc package. -
Added
Attrfield toCode. -
Removed
RawHtml,HtmlInline, andTeXelements; added genericRawBlockandRawInline. -
Moved generic functions to
Text.Pandoc.Generic. DeprecatedprocessWith, replacing it with two functions,bottomUpandtopDown. Removed previously deprecated functionsprocessPandocandqueryPandoc. -
Added
Text.Pandoc.Builder, for buildingPandocstructures. -
Text.Pandocnow exports association listsreadersandwriters. -
Added
Text.Pandoc.Readers.Native, which exportsreadNative.readNativecan now read full pandoc documents, block lists, blocks, inline lists, or inlines. It will interpretStr "hi"as if it werePandoc (Meta [] [] []) [Plain [Str "hi"]]. This should make testing easier. -
Removed deprecated
-C/--custom-headeroption. Use--templateinstead. -
--biblio-filehas been replaced by--bibliography.--biblio-formathas been removed; pandoc now guesses the format from the file extension (see README). -
pandoc will treat an argument as a URI only if it has an
http(s)scheme. Previously pandoc would treat some Windows pathnames beginning withC:/as URIs. -
The
--sanitize-htmloption and thestateSanitizefield inParserStatehave been removed. Sanitization is better done in the resulting HTML usingxss-sanitize, which is based on pandoc’s sanitization, but improved. -
pandoc now adds a newline to the end of its output in fragment mode (= not
--standalone). -
Added support for
langinhtmltag in the HTML template, so you can dopandoc -s -V lang=es, for example. -
highlightHtmlinText.Pandoc.Highlightingnow takes a boolean argument that selects between “inline” and “block” HTML. -
Text.Pandoc.Writers.RTFnow exportsrtfEmbedImage. Images are embedded in RTF output when possible (png, jpeg). Resolves Issue #275. -
Added
Text.Pandoc.Pretty. This is better suited for pandoc than theprettypackage. Changed all writers that usedText.PrettyPrint.HughesPJto useText.Pandoc.Prettyinstead. -
Rewrote
writeNativeusing the new prettyprinting module. It is now much faster. The output has been made more consistent and compressed.writeNativeis also now sensitive to writerStandalone, and will simplyprint a block list if writerStandalone` is False. -
Removed
Text.Pandoc.Blocks.Text.Pandoc.Prettyallows you to define blocks and concatenate them, so a separate module is no longer needed. -
Text.Pandoc.Shared:- Added
writerColumns,writerChapters, andwriterHtml5toWriterOptions. - Added
normalize. - Removed unneeded prettyprinting functions:
wrapped,wrapIfNeeded,wrappedTeX,wrapTeXIfNeeded,hang',BlockWrapper,wrappedBlocksToDoc. - Made
splitBytake a test instead of an element. - Added
findDataFile, refactoredreadDataFile. - Added
stringify. RewroteinlineListToIdentifierusingstringify. - Fixed
inlineListToIdentifierto treat\160as ’ ’.
- Added
-
Text.Pandoc.Readers.HTML:- Removed
rawHtmlBlock,anyHtmlBlockTag,anyHtmlInlineTag,anyHtmlTag,anyHtmlEndTag,htmlEndTag,extractTagType,htmlBlockElement,htmlComment - Added
htmlTag,htmlInBalanced,isInlineTag,isBlockTag,isTextTag
- Removed
-
Moved
smartPunctuationfromText.Pandoc.Readers.MarkdowntoText.Pandoc.Readers.Parsing, and parameterized it with an inline parser. -
Ellipses are no longer allowed to contain spaces. Previously we allowed ‘. . .’, ’ . . . ‘, etc. This caused too many complications, and removed author’s flexibility in combining ellipses with spaces and periods.
-
Allow linebreaks in URLs (treat as spaces). Also, a string of consecutive spaces or tabs is now parsed as a single space. If you have multiple spaces in your URL, use
%20%20. -
Text.Pandoc.Parsing:- Removed
refsMatch. - Hid
Keyconstructor. - Removed custom
OrdandEqinstances forKey. - Added
toKeyandfromKeyto convert betweenKeyand[Inline]. - Generalized type on
readWith.
- Removed
-
Small change in calculation of relative widths of table columns. If the size of the header > the specified column width, use the header size as 100% for purposes of calculating relative widths of columns.
-
Markdown writer now uses some pandoc-specific features when
--strictis not specified:\newline is used for a hard linebreak instead of two spaces then a newline. And delimited code blocks are used when there are attributes. -
HTML writer: improved gladTeX output by setting ENV appropriately for display or inline math (Jonathan Daugherty).
-
LaTeX writer: Use
\paragraph,\subparagraphfor level 4,5 headers. -
LaTeX reader:
\label{foo}and\ref{foo}now become{foo}instead of(foo).\index{}commands are skipped.
-
Added
fontsizevariable to default LaTeX template. This makes it easy to set the font size usingmarkdown2pdf:markdown2pdf -V fontsize=12pt input.txt. -
Fixed problem with strikeout in LaTeX headers when using hyperref, by adding a command to the default LaTeX template that disables
\soutinside pdf strings. Thanks to Joost Kremers for the fix. -
The
COLUMNSenvironment variable no longer has any effect.
-
Pandoc now compiles with GHC 7. (This alone leads to a significant performance improvement, 15-20%.)
-
Completely rewrote HTML reader using tagsoup as a lexer. The new reader is faster and more accurate. Unlike the old reader, it does not get bogged down on some input (Issues #277, 255). And it handles namespaces in tags (Issue #274).
-
Replaced
escapeStringAsXMLwith a faster version. -
Rewrote
spaceCharand some other parsers in Text.Pandoc.Parsing for a significant performance boost. -
Improved performance of all readers by rewriting parsers.
-
Simplified Text.Pandoc.CharacterReferences by using entity lookup functions from TagSoup.
-
Text.Pandoc.UTF8now uses the unicode-aware IO functions fromSystem.IOif base >= 4.2. This gives support for windows line endings on windows. -
Remove duplications in documentation by generating the pandoc man page from README, using
MakeManPage.hs. -
README now includes a full description of markdown syntax, including non-pandoc-specific parts. A new
pandoc_markdownman page is extracted from this, so you can look up markdown syntax by doingman pandoc_markdown. -
Completely revised test framework (with help from Nathan Gass). The new test framework is built when the
testsCabal flag is set. It includes the old integration tests, but also some new unit and quickcheck tests. Test output has been much improved, and you can now specify a glob pattern aftercabal testto indicate which tests should be run; for examplecabal test citationswill run all the citation tests. -
Added a shell script,
stripansi.sh, for filtering ANSI control sequences from test output:cabal test | ./stripansi.sh > test.log. -
Added
Interact.hsto make it easier to use ghci while developing.Interact.hsloadsghcifrom thesrcdirectory, specifying all the options needed to load pandoc modules (including specific package dependencies, which it gets by parsing dist/setup-config). -
Added
Benchmark.hs, testing all readers + writers using criterion. -
Added
stats.sh, to make it easier to collect and archive benchmark and lines-of-code stats. -
Added upper bounds to all cabal dependencies.
-
Include man pages in extra-source-files. This allows users to install pandoc from the tarball without needing to build the man pages.
-
New EPUB and HTML Slidy writers. (Issue #122)
- EPUB is a standard ebook format, used in Apple’s iBooks for the iPad and iPhone, Barnes and Noble’s nook reader, the Sony reader, and many other devices, and by online ebook readers like bookworm. (Amazon’s Kindle uses a different format, MobiPocket, but EPUB books can easily be converted to Kindle format.) Now you can write your book in markdown and produce an ebook with a single command! I’ve put up a short tutorial here.
- Slidy, like S5, is a system for producing HTML+javascript slide shows.
-
All input is assumed to be UTF-8, no matter what the locale and ghc version, and all output is UTF-8. This reverts to pre-1.5 behavior. Also, a BOM, if present, is stripped from the input.
-
Markdown now supports grid tables, whose cells can contain arbitrary block elements. (Issue #43)
-
Sequentially numbered example lists in markdown with
@marker. -
Markdown table captions can begin with a bare colon and no longer need to include the English word “table.” Also, a caption can now occur either before or after the table. (Issue #227)
-
New command-line options:
--epub-stylesheetallows you to specify a CSS file that will be used to style your ebook.--epub-metadataallows you to specify metadata for the ebook.--offlinecauses the generated HTML slideshow to include all needed scripts and stylesheets.--webtexcauses TeX math to be converted to images using the Google Charts API (unless a different URL is specified).--section-divscauses div tags to be added around each section in an HTML document. (Issue #230, 239)
-
Default behavior of S5 writer in standalone mode has changed: previously, it would include all needed scripts and stylesheets in the generated HTML; now, only links are included unless the
--offlineoption is used. -
Default behavior of HTML writer has changed. Between 1.2 and 1.5, pandoc would enclose sections in div tags with identifiers on the div tags, so that the sections can be manipulated in javascript. This caused undesirable interactions with raw HTML div tags. So, starting with 1.6, the default is to put the identifiers directly on the header tags, and not to include the divs. The
--section-divsoption selects the 1.2-1.5 behavior. -
API changes:
HTMLMathMethod: AddedWebTeX, removedMimeTeX.WriterOptions: AddedwriterUserDataDir,writerSourceDirectory,writerEPUBMetadatafields. RemovedwriterIncludeBefore,writerIncludeAfter.- Added
headerShifttoText.Pandoc.Shared. - Moved parsing code and
ParserStatefromText.Pandoc.Sharedto a new module,Text.Pandoc.Parsing. - Added
stateHasChapterstoParserState. - Added
HTMLSlideVariant. - Made
KeyTablea map instead of an association list. - Added accessors for
Metafields (docTitle,docAuthors,docDate). Pandoc,Meta,Inline, andBlockhave been givenOrdinstances.- Reference keys now have a type of their own (
Key), with its ownOrdinstance for case-insensitive comparison. - Added
Text.Pandoc.Writers.EPUB. - Added
Text.Pandoc.UUID. - Removed
Text.Pandoc.ODT, addedText.Pandoc.Writers.ODT. RemovedsaveOpenDocumentAsODT, addedwriteODT. - Added
Text.Pandoc.Writers.NativeandwriteNative. RemovedprettyPandoc. - Added
Text.Pandoc.UTF8for portable UTF8 string IO. - Removed
Text.Pandoc.Writers.S5and thewriteS5function. Moveds5Includesto a new module,Text.Pandoc.S5. To write S5, you now usewriteHtmlwithwriterSlideVariantset toS5SlidesorSlidySlides.
-
Template changes. If you use custom templates, please update them, particularly if you use syntax highlighting with pandoc. The old HTML templates hardcoded highlighting CSS that will no longer work with the most recent version of highlighting-kate.
- HTML template: avoid empty meta tag if no date.
- HTML template: Use default highlighting CSS from highlighting-kate instead of hard-coding the CSS into the template.
- HTML template: insert-before text goes before the title, and
immediately after the
<body>tag, as documented. (Issue #241) - Added slidy and s5 templates.
- Added amssymb to preamble of latex template. (github Issue 1)
-
Removed excess newlines at the end of output. Note: because output will not contain an extra newline, you may need to make adjustments if you are inserting pandoc’s output into a template.
-
In S5 and slidy, horizontal rules now cause a new slide, so you are no longer limited to one slide per section.
-
Improved handling of code in man writer. Inline code is now monospace, not bold, and code blocks now use .nf (no fill) and .IP (indented para).
-
HTML reader parses
<tt>as Code. (Issue #247) -
html+lhs output now contains bird tracks, even when compiled without highlighting support. (Issue #242)
-
Colons are now no longer allowed in autogenerated XML/HTML identifiers, since they have a special meaning in XML.
-
Code improvements in ODT writer. Remote images are now replaced with their alt text rather than a broken link.
-
LaTeX reader improvements:
- Made latex
\section,\chapterparsers more forgiving of whitespace. - Parse
\chapter{}in latex. - Changed
rawLaTeXInlineto accept\section,\begin, etc. - Use new
rawLaTeXInline'in LaTeX reader, and exportrawLaTeXInlinefor use in markdown reader. - Fixes bug wherein
\section{foo}was not recognized as raw TeX in markdown document.
- Made latex
-
LaTeX writer: images are automatically shrunk if they would extend beyond the page margin.
-
Plain, markdown, RST writers now use unicode for smart punctuation.
-
Man writer converts math to unicode when possible, as in other writers.
-
markdown2pdfcan now recognize citeproc options. -
Command-line arguments are converted to UTF-8. (Issue #234)
-
Text.Pandoc.TeXMathhas been rewritten to use texmath’s parser. This allows it to handle a wider range of formulas. Also, if a formula cannot be converted, it is left in raw TeX; formulas are no longer partially converted. -
Unicode curly quotes are left alone when parsing smart quotes. (Issue #143)
-
Cabal file changes:
- Removed parsec < 3 restriction.
- Added ‘threaded’ flag for architectures where GHC lacks a threaded runtime.
- Use ‘threaded’ only for markdown2pdf; it is not needed for pandoc.
- Require highlighting-kate 0.2.7.
-
Use explicit imports from
Data.Generics. Otherwise we have a conflict with the ‘empty’ symbol, introduced in syb >= 0.2. (Issue #237) -
New data files: slidy/slidy.min.js, slidy/slidy.min.css, epub.css.
-
Added two new output formats: groff man pages and ConTeXt. By default, output files with extensions “.ctx” and “.context” are assumed to be ConTeXt, and output files with single-digit extensions are assumed to be man pages.
-
Enhanced ordered lists (documented in README, under Lists):
- The OrderedList block element now stores information about list number style, list number delimiter, and starting number.
- The readers parse this information when possible.
- The writers use this information to style ordered lists.
- The enhancement can be disabled using the –strict option.
-
Added support for tables (with a new Table block element). Two kinds of tables are supported: a simple table with one-line rows, and a more complex variety with multiline rows. All output formats are supported, but only markdown tables are parsed at the moment. The syntax is documented in README.
-
Added support for definition lists (with a new DefinitionList block element). All output and input formats are supported. The syntax is documented in README.
-
Added support for superscripts and subscripts (with new Superscript and Subscript inline elements). All input and output formats. The syntax is documented in README.
-
Added support for strikeout (with a new Strikeout inline element). All input and output formats are supported. Thanks to Bradley Kuhn, who contributed a patch. The syntax is documented in README. Resolves Issue #18.
-
Added a –toc|–table-of-contents option. This causes an automatically generated table of contents (or an instruction that creates one) to be inserted at the beginning of the document. Not supported in S5, DocBook, or man page writers.
-
Modified the -m|–asciimathml option:
- If an optional URL argument is provided, a link is inserted instead of the contents of the ASCIIMathML.js script.
- Nothing is inserted unless the document actually contains LaTeX math.
-
Removed Blank block element as unnecessary.
-
Removed Key and Note blocks from the Pandoc data structure. All links are now stored as explicit links, and note contents are stored with the (inline) notes.
- All link Targets are now explicit (URL, title) pairs; there is no longer a ‘Ref’ target.
- Markdown and RST parsers now need to extract data from key and note blocks and insert them into the relevant inline elements. Other parsers have been simplified, since there is no longer any need to construct separate key and note blocks.
- Markdown, RST, and HTML writers need to construct lists of notes; Markdown and RST writers need to construct lists of link references (when the –reference-links option is specified); and the RST writer needs to construct a list of image substitution references. All writers have been rewritten to use the State monad when state is required.
- Several functions (generateReference, keyTable, replaceReferenceLinks, replaceRefLinksBlockList, and some auxiliaries used by them) have been removed from Text.Pandoc.Shared, since they are no longer needed. New functions and data structures (Reference, isNoteBlock, isKeyBlock, isLineClump) have been added. The functions inTags, selfClosingTag, inTagsSimple, and inTagsIndented have been moved to the DocBook writer, since that is now the only module that uses them. NoteTable is now exported in Text.Pandoc.Shared.
- Added stateKeys and stateNotes to ParserState; removed stateKeyBlocks, stateKeysUsed, stateNoteBlocks, stateNoteIdentifiers, stateInlineLinks.
- Added writerNotes and writerReferenceLinks to WriterOptions.
-
Added Text.Pandoc module that exports basic readers, writers, definitions, and utility functions. This should export everything needed for most uses of Pandoc libraries. The haddock documentation includes a short example program.
-
Text.Pandoc.ASCIIMathML is no longer an exported module.
-
Added Text.Pandoc.Blocks module to help in printing markdown and RST tables. This module provides functions for working with fixed-width blocks of text–e.g., placing them side by side, as in a table row.
-
Refactored to avoid reliance on Haskell’s Text.Regex library, which (a) is slow, and (b) does not properly handle unicode. This fixed some strange bugs, e.g. in parsing S-cedilla, and improved performance.
- Replaced ‘gsub’ with a general list function ‘substitute’ that does not rely on Text.Regex.
- Rewrote extractTagType in HTML reader so that it doesn’t use regexs.
- In Markdown reader, replaced email regex test with a custom email autolink parser (autoLinkEmail). Also replaced selfClosingTag regex with a custom function isSelfClosingTag.
- Modified Docbook writer so that it doesn’t rely on Text.Regex for detecting ‘mailto’ links.
- Removed escapePreservingRegex and reamped entity-handling functions in Text.Pandoc.Shared and Text.Pandoc.CharacterReferences to avoid reliance on Text.Regex (see below on character reference handling changes).
-
Renamed Text.Pandoc.Entities as Text.Pandoc.CharacterReferences.
-
Changed handling of XML entities. Entities are now parsed (and unicode characters returned) in the Markdown and HTML readers, rather than being handled in the writers. In HTML and Docbook writers, UTF-8 is now used instead of entities for characters above 128. This makes the HTML and DocBook output much more readable and more easily editable.
- Removed sgmlHexEntity, sgmlDecimalEntity, sgmlNamedEntity, and sgmlCharacterEntity regexes from Text.Pandoc.Shared.
- Renamed escapeSGMLChar to escapeCharForXML. Added escapeStringForXML. Moved both functions to Text.Pandoc.Writers.Docbook.
- Added characterReference parser to Text.Pandoc.CharacterReferences. This parses a string and return a unicode character.
- Rewrote decodeCharacterReferences to use the new parser instead of Text.Regex.
- Added new charRef parser for Markdown and HTML, which replaces the old ‘entity’ parser. Added ‘&’ as a special character in Markdown reader.
- Modified HTML and Markdown readers to call decodeEntities on all raw strings (e.g. authors, dates, link titles), to ensure that no unprocessed entities are included in the native representation of the document. (In the HTML reader, most of this work is done by a change in extractAttributeName.)
- In XML and Markdown output, escape unicode nonbreaking space as ‘ ’, since a unicode non-breaking space is impossible to distinguish visually from a regular space. (Resolves Issue #3.)
- Removed encodeEntitiesNumerical.
- Use Data.Map for entityTable and (new) reverseEntityTable, for a slight performance boost over the old association list.
- Removed unneeded decodeEntities from ‘str’ parser in HTML and Markdown readers.
-
Text.Pandoc.UTF8: Renamed encodeUTF8 to toUTF8, decodeUTF8 to fromUTF8, for clarity.
-
Replaced old haskell98 module names replaced by hierarchical module names, e.g. List by Data.List. Removed haskell98 from dependencies in pandoc.cabal, and added mtl (needed for state monad). Substituted xhtml for html.
-
Refactored and cleaned up character escaping in writers, using backslashEscapes and escapeStringUsing functions.
-
Instead of adding
\n\nto the end of an input string in Main.hs, this is now done in the readers. This makes the libraries behave the way you’d expect from the pandoc program. Resolves Issue #10. -
URLs and email addresses in autolinks are now typeset as Code.
-
In Main.hs, changed putStr to putStrLn – mainly because MacOS X doesn’t display the whole output unless there’s a line ending.
-
Major code cleanup in all modules, for greater consistency, concision, and readability.
-
HTML reader:
- Fixed several bugs (extractTagType, attribute parsing).
- Remove Null blocks in lists of blocks when possible.
- Allow HTML comments as raw HTML inline.
-
Markdown reader:
- Ordered list items may no longer begin with uppercase letters, or letters greater than ‘n’. (This prevents first initials and page reference, e.g. ‘p. 400’, from being parsed as beginning lists.) Also, numbers beginning list items may no longer end with ‘)’, which is now allowed only after letters. Note: These changes may cause documents to be parsed differently. Users should take care in upgrading.
- Changed autoLink parsing to conform better to Markdown.pl’s
behavior.
<google.com>is not treated as a link, but<http://google.com>,<ftp://google.com>, and<mailto:[email protected]>are. - Cleaned up handling of embedded quotes in link titles. Now these are stored as a ‘”’ character, not as ‘"’.
- Use lookAhead parser for the ‘first pass’ (looking for reference keys), instead of parsing normally, then using setInput to reset input. This yields a slight performance boost.
- Fixed several bugs in smart quote recognition.
- Fixed bug in indentSpaces (which didn’t properly handle cases with mixed spaces and tabs).
- Consolidated ‘text’, ‘special’, and ‘inline’ into ‘inline’.
- Fixed bug which allowed URL and title to be separated by multiple blank lines in links and reference keys. They can be on separate lines but can’t have blank lines between them.
- Correctly handle bracketed text inside inline footnotes and links,using new function inlinesInBalanced. Resolves Issue #14.
- Fixed bug in footnotes: links in footnotes were not being processed. Solution: three-stage parse. First, get all the reference keys and add information to state. Next, get all the notes and add information to state. (Reference keys may be needed at this stage.) Finally, parse everything else.
- Replaced named constants like ‘emphStart’ with literals.
- Removed an extra occurrence of escapedChar in definition of inline.
-
RST reader:
- Allow the URI in a RST hyperlink target to start on the line after the reference key.
- Added ‘try’ in front of ‘string’, where needed, or used a different parser. This fixes a bug where ````` would not be correctly parsed as a verbatim `.
- Fixed slow performance in parsing inline literals in RST reader. The
problem was that
#was seen by ‘inline’ as a potential link or image. Fix: inserted ‘notFollowedBy (char ‘`’)’ in link parsers. Resolves Issue #8. - Use lookAhead instead of getInput/setInput in RST reader. Removed unneeded getState call, since lookAhead automatically saves and restores the parser state.
- Allow hyperlink target URIs to be split over multiple lines, and to start on the line after the reference. Resolves Issue #7.
- Fixed handling of autolinks.
-
LaTeX reader:
- Replaced
choice [(try (string ...), ...]idiom withoneOfStrings, for clarity. - Added clauses for tilde and caret. Tilde is
\ensuremath{\sim}, and caret is\^{}, not\^as before. - Added parsing for
\url. - Parse
\texttt{}as code, provided there’s nothing fancy inside.
- Replaced
-
HTML writer:
- Modified HTML writer to use the Text.XHtml library. This results in cleaner, faster code, and it makes it easier to use Pandoc in other projects, like wikis, which use Text.XHtml. Two functions are now provided, writeHtml and writeHtmlString: the former outputs an Html structure, the latter a rendered string. The S5 writer is also changed, in parallel ways (writeS5, writeS5String).
- The Html header is now written programmatically, so it has been removed from the ‘headers’ directory. The S5 header is still needed, but the doctype and some of the meta declarations have been removed, since they are written programmatically. This change introduces a new dependency on the xhtml package.
- Fixed two bugs in email obfuscation involving improper escaping
of ‘&’ in the
<noscript>section and in--strictmode. Resolves Issue #9. - Fixed another bug in email obfuscation: If the text to be obfuscated contains an entity, this needs to be decoded before obfuscation. Thanks to thsutton for the patch. Resolves Issue #15.
- Changed the way the backlink is displayed in HTML footnotes. Instead of appearing on a line by itself, it now generally appears on the last line of the note. (Exception: when the note does not end with a Plain or Para block.) This saves space and looks better.
- Added automatic unique identifiers to headers:
- The identifier is derived from the header via a scheme documented in README.
- WriterState now includes a list of header identifiers and a table of contents in addition to notes.
- The function uniqueIdentifiers creates a list of unique identifiers from a list of inline lists (e.g. headers).
- This list is part of WriterState and gets consumed by blockToHtml each time a header is encountered.
- Include CSS for .strikethrough class in header only if strikethrough text appears in the document.
- If the ‘strict’ option is specified, elements that do not appear in standard markdown (like definition lists) are passed through as raw HTML.
- Simplified treatment of autolinks, using pattern matching instead of conditionals.
-
Markdown writer:
- Links in markdown output are now printed as inline links by default, rather than reference links. A –reference-links option has been added that forces links to be printed as reference links. Resolves Issue #4.
- Use autolinks when possible. Instead of
[site.com](site.com), use<site.com>.
-
LaTeX writer:
- Rewrote to use the State monad. The preamble now includes only those packages that are actually required, given the document’s content. Thus, for example, if strikeout is not used, ulem is not required. Modified LaTeXHeader accordingly.
- Modified LaTeX writer to insert
\,between consecutive quotes. - Removed unused function tableRowColumnWidths.
- Simplified code for escaping special characters.
- Leave extra blank line after
\maketitle. - Include empty
\author{}when no author specified to avoid LaTeX errors. - Include fancyvrb code in header only if needed – that is, only if there is actually code in a footnote.
- Use
\url{}for autolinks. - Include [mathletters] option in ucs package, so that basic unicode Greek letters will work correctly.
-
RST writer: Force blank line before lists, so that sublists will be handled correctly.
-
Docbook writer: Fixed a bug: email links with text, like foo, were being incorrectly treated as autolinks.
-
Removed Text.ParserCombinators.Pandoc and moved all its functions to Text.Pandoc.Shared.
-
Text.Pandoc.Shared:
- Added defaultWriterOptions.
- Added writerTableOfContents to WriterOptions.
- Added writerIgnoreNotes option to WriterOptions. This is needed for processing header blocks for a table of contents, since notes on headers should not appear in the TOC.
- Added prettyprinting for native Table format.
- Removed some unneeded imports.
- Moved escape and nullBlock parsers from Text.ParserCombinators.Pandoc, since the latter is for general-purpose parsers that don’t depend on Text.Pandoc.Definition.
- Moved isHeaderBlock from Text.Pandoc.Writers.HTML.
- Moved Element, headerAtLeast, and hierarchicalize from Docbook writer, because HTML writer now uses these in constructing a table of contents.
- Added clauses for new inline elements (Strikeout, Superscript, Subscript) to refsMatch.
- Removed backslashEscape; added new functions escapeStringUsing and backslashEscapes.
- Moved failIfStrict from markdown reader, since it is now used also by the HTML reader.
- Added a ‘try’ to the definition of indentSpaces.
- In definition of ‘reference’, added check to make sure it’s not a note reference.
- Added functions: camelCaseToHyphenated, toRomanNumeral, anyOrderedListMarker, orderedListmarker, orderedListMarkers, charsInBalanced’, withHorizDisplacement, romanNumeral
- Fixed a bug in the anyLine parser. Previously it would parse an empty string “”, but it should fail on an empty string, or we get an error when it is used inside “many” combinators.
- Removed followedBy’ parser, replacing it with the lookAhead parser from Parsec.
- Added some needed ‘try’s before multicharacter parsers, especially in ‘option’ contexts.
- Removed the ‘try’ from the ‘end’ parser in ‘enclosed’, so that ‘enclosed’ behaves like ‘option’, ‘manyTill’, etc.
- Added lineClump parser, which parses a raw line block up to and including any following blank lines.
- Renamed parseFromStr to parseFromString.
- Added a ‘try’ to the ‘end’ parser in ‘enclosed’. This makes errors in the use of ‘enclosed’ less likely. Removed some now-unnecessary ‘try’s in calling code.
- Removed unneeded ‘try’ in blanklines.
- Removed endsWith function and rewrote calling functions to use isSuffixOf instead.
- Added >>~ combinator.
- Fixed bug in normalizeSpaces: Space:Str “”:Space should compress to Space.
-
Refactored runtests.pl; added separate tests for tables.
-
Shell scripts:
- Added -asxhtml flag to tidy in html2markdown. This will perhaps help the parser, which expects closing tags.
- Modified markdown2pdf to run pdflatex a second time if –toc or –table-of-contents was specified; otherwise the table of contents won’t appear.
- Modified markdown2pdf to print a helpful message if the ‘ulem’ LaTeX package is required and not found.
-
Changes to build process:
- Dropped support for compilation with GHC 6.4. GHC 6.6 or higher is now required.
- Removed cabalize and Pandoc.cabal.in. The repository now contains pandoc.cabal itself.
- Pandoc.cabal has been changed to pandoc.cabal, because HackageDB likes the cabal file to have the same name as the tarball.
- Expanded and revised the package description in pandoc.cabal. Revised the package synopsis.
- The tarball built by ‘make tarball’ now contains files built from templates (including man pages and shell scripts), so pandoc can be built directly using Cabal tools, without preprocessing.
- Executable binaries are now stripped before installing.
- Man pages are now generated from markdown sources, using pandoc’s man page writer.
- Use HTML version of README (instead of RTF) in Mac OS X installer.
- Instead of testing for the existence of a pandoc symlink in build-exec, use ln -f.
-
Documentation:
- Updated README and man pages with information on new features.
- Updated INSTALL instructions with some useful clarifications and links.
- Updated web content.
-
Added FreeBSD port.
-
Changes in pandoc options:
- Allow options to follow or precede arguments.
- Changed ‘–smartypants’ to ‘–smart’ and adjusted symbols accordingly.
- Added ‘–strict’ option.
- Added ‘-o/–output’ option.
- Added ‘–dump-args’ and ‘–ignore-args’ options (for use in wrappers).
- Modified ‘-v’ and ‘-h’ output to go to STDERR, not STDOUT, and return error conditions. This is helpful for writing wrappers.
- Added copyright message to ‘-v’ output, modeled after FSF messages.
- Reformatted usage message so that it doesn’t wrap illegibly.
- Removed extra blanks after ‘-h’ and ‘-D’ output.
-
Added docbook writer.
-
Added implicit setting of default input and output format based on input and output filename extensions. These defaults are overridden if explicit input and output formats are specified using ‘-t’, ‘-f’, ‘-r’, or ‘-w’ options. Documented in pandoc(1) man page and README.
-
Allow ordered list items to begin with (single) letters, as well as numbers. The list item marker may now be terminated either by ‘.’ or by ‘)’. This extension to standard markdown is documented in README.
-
Revised footnote syntax. (See README for full details.) The ‘[^1]’ format now standard in markdown extensions is supported, as are inline footnotes with this syntax:
^[My note.]. The earlier footnote syntax^(1)is no longer supported. -
Improved HTML representation of footnotes. All footnotes are now auto-numbered and appear in an ordered list at the end of the HTML document. Since the default appearance is now acceptable, the old footnote styles have been removed from the HTML header.
-
Bug fixes:
- Fixed a serious bug in the markdown, LaTeX, and RST readers. These readers ran ‘runParser’ on processed chunks of text to handle embedded block lists in lists and quotation blocks. But then any changes made to the parser state in these chunks was lost, as the state is local to the parser. So, for example, footnotes didn’t work in quotes or list items. The fix: instead of calling runParser on some raw text, use setInput to make it the input, then parse it, then use setInput to restore the input to what it was before. This is shorter and more elegant, and it fixes the problem.
- Fixed bug in notFollowedBy’ combinator (adding ‘try’ before ‘parser’). Adjusted code that uses this combinator accordingly.
- Fixed bug in RTF writer that caused improper indentation on footnotes occurring in indented blocks like lists.
- Fixed parsing of metadata in LaTeX reader. Now the title, author, and date are parsed correctly. Everything else in the preamble is skipped.
- Modified escapedChar in LaTeX reader to allow a
\at the end of a line to count as escaped whitespace. - Modified LaTeX reader to produce inline links rather than reference links. Otherwise, links in footnotes aren’t handled properly.
- Fixed handling of titles in links in Markdown reader, so that embedded quotation marks are now handled properly.
- Fixed Markdown reader’s handling of embedded brackets in links.
- Fixed Markdown reader so that it only parses bracketed material as a reference link if there is actually a corresponding key.
- Revised inline code parsing in Markdown reader to conform to
markdown standard. Now any number of
s can begin inline code, which will end with the same number ofs. For example, to have two backticks as code, write``. Modified Markdown writer accordingly. - Fixed bug in text-wrapping routine in Markdown and RST writers. Now LineBreaks no longer cause wrapping problems.
- Supported hexadecimal numerical entity references as well as decimal ones.
- Fixed bug in Markdown reader’s handling of underscores and other inline formatting markers inside reference labels: for example, in ‘[A_B]: /url/a_b’, the material between underscores was being parsed as emphasized inlines.
- Changed Markdown reader’s handling of backslash escapes so that only non-alphanumeric characters can be escaped. Strict mode follows Markdown.pl in only allowing a select group of punctuation characters to be escaped.
- Modified HTML reader to skip a newline following a
<br>tag. Otherwise the newline will be treated as a space at the beginning of the next line.
-
Made handling of code blocks more consistent. Previously, some readers allowed trailing newlines, while others stripped them. Now, all readers strip trailing newlines in code blocks. Writers insert a newline at the end of code blocks as needed.
-
Modified readers to make spacing at the end of output more consistent.
-
Minor improvements to LaTeX reader:
\thanksnow treated like a footnote.- Simplified parsing of LaTeX command arguments and options. commandArgs now returns a list of arguments OR options (in whatever order they appear). The brackets are included, and a new stripFirstAndLast function is provided to strip them off when needed. This fixes a problem in dealing with \newcommand and \newenvironment.
-
Revised RTF writer:
- Default font is now Helvetica.
- An
\f0is added to each\pard, so that font resizing works correctly.
-
Moved handling of “smart typography” from the writers to the Markdown and LaTeX readers. This allows great simplification of the writers and more accurate smart quotes, dashes, and ellipses. DocBook can now use
<quote>. The ‘–smart’ option now toggles an option in the parser state rather than a writer option. Several new kinds of inline elements have been added: Quoted, Ellipses, Apostrophe, EmDash, EnDash. -
Changes in HTML writer:
- Include title block in header even when title is null.
- Made javascript obfuscation of emails even more obfuscatory, by combining it with entity obfuscation.
-
Changed default ASCIIMathML text color to black.
-
Test suite:
- Added –strip-trailing-cr option to diff in runtests.pl, for compatibility with Windows.
- Added regression tests with footnotes in quote blocks and lists.
-
Makefile changes:
- osx-pkg target creates a Mac OS X package (directory). New osx directory contains files needed for construction of the package.
- osx-dmg target creates a compressed disk image containing the package.
- win-pkg target creates Windows binary package.
- tarball target creates distribution source tarball.
- website target generates pandoc’s website automatically, including demos. New ‘web’ directory contains files needed for construction of the website (which will be created as the ‘pandoc’ subdirectory of ‘web’).
- Makefile checks to see if we’re running Windows/Cygwin; if so, a ‘.exe’ extension is added to each executable in EXECS.
-
Removed all wrappers except markdown2pdf and html2markdown.
-
Added new wrapper hsmarkdown, to be used as a drop-in replacement for Markdown.pl. hsmarkdown calls pandoc with the ‘–strict’ option and disables other options.
-
Added code to html2markdown that tries to determine the character encoding of an HTML file, by parsing the “Content-type” meta tag.
- If the encoding can’t be determined, then if the content is local, the local encoding is used; if it comes from a URL, UTF-8 is used by default.
- If input is from STDIN, don’t try to determine character encoding.
- Encoding can be specified explicitly using ‘-e’ option.
-
Improved warning messages in wrappers:
- Print warning if iconv not available
- More user-friendly error messages in markdown2pdf, when pdflatex fails.
-
Code cleanup:
- Renamed ‘Text/Pandoc/HtmlEntities’ module to ‘Text/Pandoc/Entities’. Also changed function names so as not to be HTML-specific.
- Refactored SGML string escaping functions from HTML and Docbook writers into Text/Pandoc/Shared. (escapeSGML, stringToSGML)
- Removed ‘BlockQuoteContext’ from ParserContext, as it isn’t used anywhere.
- Removed splitBySpace and replaced it with a general, polymorphic splitBy function.
- Refactored LaTeX reader for clarity (added isArg function).
- Converted some CR’s to LF’s in src/ui/default/print.css.
- Added license text to top of source files.
- Added module data for haddock to source files.
- Reformatted code for consistency.
-
Rewrote documentation and man pages. Split README into INSTALL and README.
-
Split LICENSE into COPYING and COPYRIGHT.
-
Removed TODO, since we now maintain ToDo on the wiki.
-
Made COPYRIGHT in top level a symlink to debian/copyright, to avoid duplication.