pandoc 3.4

[jgm]

Click to expand changelog

• 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-position and --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-engine via HTML to WeasyPrint (Change default pdf-engine for HTML from wkhtmltopdf to weasyprint #10142). wkhtmltopdf is deprecated. weasyprint is the easiest-to-install, maintained alternative. For better results, one might prefer pagedjs-cli.

• Org reader:

  • Fix parsing of src blocks with an -i flag (Leading tabs in code block are not retained in org reader with -p #10071, Albert Krewinkel). Tabs are now preserved in the contents of src blocks if the the block has the -i flag.

• RTF reader:

  • Handle images inside shp contexts (RTF reader doesn't include image inside \shp #10145).

• RST reader:

• Improve simple table support (Incorrent simple table parsing for RST->Markdown #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 (parsing issue with tex #10160).
  • Parse nested tabular environments (Latex reader fails parse nested tables #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) (HTML reader should ignore everything outside of main element, 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 (Detect KaTeX math in HTML input and extract only LaTeX source #9971).
  • Better handle KaTeX-generated math (Detect KaTeX math in HTML input and extract only LaTeX source #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.

• New module: Text.Pandoc.Writers.ANSI [API change] (Evan Silberman).

• Docx writer:

  • Add “SuppressAuthor” and “AuthorOnly” to citationMode when +citations is used (thomjur).
  • Support custom-style attribute for docx table (Sebbones).
  • Support --number-offsets.
  • Make table/figure rendering sensitive to caption position settings.

• 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 (Unnecessary semicolon added to detailed citations when converting to Typst #10148).
  • Template: move header-includes before show doc (Move header-includes earlier in Typst template? #9996, Gordon Woodhull).

• LaTeX writer:

  • Make table/figure rendering sensitive to caption position settings (Provide a way to specify caption position in LaTeX output #5116).
  • Preserve locator labels with --natbib (Pandoc with --natbib swallows locators in its output #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 makeSectionsWithOffsets for writerNumberOffsets, instead of the old, inefficient code.
  • Don’t add doc-biblioref role to every link in a citation; only to links to the bibliography (All links in citations get the role doc-biblioref #10156).
  • Add data- when rendering label attribute (label in epub from tex: issue with validation #10048).

• Markdown writer:

  • Avoid emitting markdown caption if table has fallen back to raw HTML, which will then contain a <caption> tag (Parsing a table RST->MD(HTML table) results in double captions #10094).

  • Make math sensitive to tex_math_gfm extension (gfm reader/writer?: support new inline and display math formats #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 (Missing link: macro in AsciiDoc for uncommon URL protocols #10105). AsciiDoc requires it except for http, https, irc, mailto, ftp schemes (Missing link: macro in AsciiDoc for uncommon URL protocols #10105).
  • Preserve original base level (Inconsistent heading levels with AsciiDoc output #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 (Fix asciidoc figure with empty title #10047).

• ODT writer:

  • Add TableCaption to styles.xml (Add TableCaption to styles.xml #10058, Ian Max Andolina).

• LaTeX template:

  • Fix wrong beamer color in (sub)section page (Jonathan).

• Text.Pandoc.Options:

  • Add CaptionPosition and new WriterOptions fields writerFigureCaptionPosition and writerTableCaptionPosition [API change].

• Text.Pandoc.Opt:

  • Change default for optNumberOffset to []. This behaves the same as [0,0,0,0,0].
  • Add Opt fields optFigureCaptionPosition and optTableCaptionPosition [API change].

• Text.Pandoc.Format: change formatFromFilePaths so that it is smarter about URLs. URLs are parsed, and we take the format from the path component, if present (If you specify a URL ending in .org, pandoc treats it as org-mode rather than HTML content #10141). This means that https://emacs.org/ will be treated as HTML, while https://emacs.org/sample.org will be treated as Org.

• Text.Pandoc.URI:

  • Add unofficial gemini: to list of URI schemes (Pau RE).

• Text.Pandoc.Shared:

  • Add makeSectionsWithOffsets [API change].
  • Remove `stripEmptyParagraphs [API change] (Albert Krewinkel). This function is no longer used.

• 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-offset option should only directly affect numbering of the first section heading in a document; subsequent headings will increment normally.
  • Fix asciidoc link (Obsolete link in manual #10039).
  • Fix CSL Docs broken link (User Guide: Fix CSL Docs broken link #10100, Tristano Ajmone).
  • Document the use of luatexja when CJKmainfont is used with lualatex (Allow setting Japanese fonts when using LuaLaTeX #3873, Kolen Cheung).
  • Add a citations (typst) section to the manual (Document typst-citations to enable citeproc for typst output #9127).
  • Clarify that citations affects both input and output for org.
  • Add note on --citeproc that you may need to disable citations extension on the output format (e.g., -t markdown-citations) to see the rendered citation (Document typst-citations to enable citeproc for typst output #9127, Missing bibliography in markdown output? #10012).

• INSTALL.md — reorganise info on static binaries and add conda-forge install options (INSTALL.md — reorganise info on static binaries and add conda-forge install options #10098, pandoc-lua can't require binary packages when installed with Conda #10069, Ian Max Andolina).

---

This discussion was created from the release pandoc 3.4.

[jgm]

I'm pleased to announce the release of pandoc 3.4,
available in the usual places:

Binary packages & changelog:
https://github.com/jgm/pandoc/releases/tag/3.4

Source & API documentation:
http://hackage.haskell.org/package/pandoc-3.4

Some changes of particular note (inspect changelog for the full list):

  * New output format: ansi (for formatted console output).
  * Add command line options --table-caption-position and
    --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-engine via HTML to WeasyPrint (#10142).
  * --number-offsets now works with docx output.

API changes:

  * New module: Text.Pandoc.Writers.ANSI, exporting writeANSI.
  * Text.Pandoc.Options: Add CaptionPosition and new WriterOptions fields
    writerFigureCaptionPosition and writerTableCaptionPosition.
  * Text.Pandoc.Opt: Add Opt fields optFigureCaptionPosition and
    optTableCaptionPosition.
  * Text.Pandoc.Shared: Add makeSectionsWithOffsets. Remove
    stripEmptyParagraphs.
  * Text.Pandoc.Highlighting: Add formatANSI.
  * Text.Pandoc.Writers.Shared: add toSubscriptInline, toSuperscriptInline.

Thanks to all who contributed, and a special welcome to new contributors
Evan Silberman (who created the ANSI writer and modified doclayout to
make it possible), Jonathan, Pau RE, Sebbones, Tristano Ajmone,
closeobserve, and thomjur.

[estedeahora]

I think there is a mistake in the description. It seems to me that the item:

Add “SuppressAuthor” and “AuthorOnly” to citationMode when +citations is used (thomjur).

should be like in a "Docx Reader" title.

[jgm]

You're right; I'll update changelog.md.