pandoc 3.10

[jgm]

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

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

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

In addition to the usual basket of bug fixes and small improvements,
the following changes are worth mention:

- This release adds a --typst-input option, which allows passing
  arbitrary `sys.inputs` parameters to the typst evaluator.

- groff is now the default pdf-engine for the ms format, replacing
  pdfroff.

- The auto_identifiers extension (and related extensions) are
  now available for the man reader.

- OpenDocument/ODT now uses predefined styles instead of emitting
  automatic styles for every paragraph. This yields more idiomatic,
  and more easily stylable, output, resolving a handful of longstanding
  issues. If you use a custom reference.odt, it may need some updating.

API changes:

- Text.Pandoc.App.Opt: Opt has a new fieldi optTypstInputs.
- Text.Pandoc.Options: ReaderOptions has a new field readerTypstInputs.

Thanks to all who contributed, especially new contributors Dan Jacobson,
Johan Larsson, Keenan Brock, Meher Chaitanya, Sai Asish Y, and nibras shami.

Click to expand changelog

• Add --typst-input CLI option (Support Typst sys.inputs #11588). This allows one to pass parameters to typst, which are available at sys.inputs, just as typst itself does with its --input option.

• Avoid trailing spaces in --help output (Could cut size of --help in half by removing trailing blanks #11623).

• Make groff the default pdf-engine for ms output (update default pdf-engine for ms output format #11558). Formerly it was pdfroff.

• Set default User-Agent request header to pandoc/VERSION. This can be overridden using the --request-header option.

• Markdown reader:

  • Allow grid tables to be indented (Markdown reader: allow grid tables to be indented #11671, Johan Larsson). Like the other table syntaxes (pipe, simple, and multiline tables) and block-level constructs generally, a grid table may now be indented by up to three spaces and still be recognized as a table. Previously the grid-table parser required the table to begin at the left margin, so an indented grid table was parsed as a paragraph.
  • Fix calculation of column widths for default columns in grid tables (col width attribute changes the rendered width of the table #11664). This fixes a bug which produced too-narrow columns in some cases.
  • Don’t produce empty Raw element with --strip-comments (--strip-comments still leaves 0-length RawInline #11625).
  • Fix quotes in inline notes (Quotations in footnotes within a quotation not detected as Quoted #11613, Andrew Dunning).
  • Allow spaces inside attributes in super/sub (Markdown reader: whitespace inside span attributes break superscrript/subscript #11589).
  • Simplify checkNotes, remove dead code
  • Various small performance optimizations.

• HTML reader:

  • Parse aside as a Div with class “aside” (instead of using raw HTML) (unable to convert epub to pdf via typst engine #11626).
  • Add “header” class to Divs created from headers.

• Docx reader:

  • Fix bug in bitmask checking (Additional heuristics for table headers in docx tables #8299). This led to some table rows being wrongly considered header rows.
  • Improve treatment of tblHeader element (Additional heuristics for table headers in docx tables #8299). If tblHeader exists but has w:val="0", then don’t consider the element a header.
  • With citations extension, prefer citation-key as the key for item data, if it is defined (DOCX Reader + Citations: Don't use Zotero id field when other fields are present? #11581; cf. docx+citations from zotero: different ids used for in-text and CSL-YAML #10366, Given a DOCX with Zotero citations, how can I convert its contents to LaTeX? #11567). The id key used by Zotero is not exposed by their API and is generally not what is wanted when converting to biblatex.
  • Don’t look to ext tags for image extent (Images and page orientation lost between .docx to PDF conversion #11580). This reverts a change from 7ff1b79. The change was mistaken and could cause images to be parsed with the wrong sizes.

• Man reader:

  • Support auto_identifiers, gfm_auto_identifiers, and ascii_identifiers extensions (enable auto_identifiers for man reader #8852, Meher Chaitanya). Section headings parsed from .SH and .SS macros now receive auto-generated id attributes when the extension is enabled (as it is by default). This enables --toc to produce working anchor links.
  • Better handling of .TP macro (Indentation is reset on .TS (table start) when converting man to html #11668). We parse these as DefinitionList items, but we previously sometimes stopped prematurely in including material in the definition. We should include everything until we hit a new indentation-changing macro.

• Roff reader:

  • Handle \ line continuation in table cells (Unable to read man pages that contain tables with multiline row definitions #11635).

• LaTeX reader:

  • Evaluate theorem name when used rather than evaluating it when the \newtheorem command is encountered (latex input: problem with order of command definitions #11608). It may include macros only defined later.
  • Put identifier from label on table attributes rather than adding an enclosing Div (LaTeX → Typst: Labeled tables have unwanted #block[…] #11604).

• Typst reader:

  • Fix issue parsing figure inside rotate or box (Figure caption lost when converting rotated figure (typst to docx) #11598).
  • Implement “rotate” as pass-through (text inside a typst #rotate block disappears when converting to docx or pdf #11531). Information about the angle is encoded in an attribute of an enclosing span or div.

• RTF reader:

  • Fix tables parsed as deeply nested tables (Require support with Pandoc's processing of RTF tables #11682).

• Docx writer:

  • Fix display of paragraph with just inline math (DOCX: standalone inline math is rendered like display math in Word #11674). Word displays a paragraph containing just one inline math element as if it were display math. We don’t want that, so we add a zero-width space to defeat this behavior.
  • Fix FirstParagraph style lost after heading with footnote (docx: paragraph after heading with footnote gets BodyText instead of FirstParagraph #11573).
  • Fix empty keywords in core document properties (Docx writer: fix empty keywords in core document properties #11666, Sai Asish Y).

• OpenDocument/ODT writer:

  • Use predefined styles (Unable to generate epub from large number of markdown files on Windows due to long filename issue #9316, Feature Request: list construction in ODT #5086, ODF output Blockquotes should not have a non-style indent applied #2747, DocBook to ODT: Multiplied paragraph styles #3426, OpenDocument.hs: When using well-known inlines styles, it should emit well-known style names (and NOT automatic styles) #7336). Previously the OpenDocument writer emitted a fresh automatic style (L1..Ln, P1..Pn, T1..Tn) for nearly every list, list-item paragraph, block quote, preformatted block, and inline text style. This commit teaches the writer to reference the predefined styles that LibreOffice ships and that pandoc’s reference.odt now exports:

    • Bullet lists use List_20_1; ordered lists with default start and decimal format use Numbering_20_1. Non-default ordered lists generate a single named override style (Pandoc_Numbering_N) memoised by (ListNumberStyle, ListNumberDelim); a non-default start value with the default format is expressed via text:start-value on the text:list element instead of a new style.
    • List-item paragraphs use List_20_Bullet[_Tight] and List_20_Number[_Tight]. The Tight variants are pandoc-specific (zero top/bottom margin) and are injected into the user’s reference.odt if missing, just like the Skylighting token styles.
    • Block quotes use the predefined Quotations paragraph style directly. Nested block quotes use a single automatic style that inherits from Quotations and only adds extra margin-left, so a list inside a block quote now inherits its container’s indent (ODF output Blockquotes should not have a non-style indent applied #2747).
    • Preformatted blocks use Preformatted_20_Text directly.
    • Emphasis, Strong, Strikeout, Subscript, Superscript and Code spans use the predefined Emphasis, Strong_20_Emphasis, Strikeout, Subscript, Superscript and Source_20_Text text styles.
    • paraStyle/paraStyleFromParent no longer emit a wrapper automatic style when its only attribute would be parent-style-name; the parent name is returned directly.

• EPUB writer:

  • Support multiple EPUB versions for raw content (Enhance EPUB writer to support multiple EPUB versions and improve HTML format detection. #11628, nibras shami). This change ensures that raw content marked epub2 will appear in (only) EPUBv2 output and content marked epub3 will appear in (only) EPUBv3 output.

• Typst writer:

  • Add zero-width space before a Span label if otherwise the label doesn’t come after anything (DOCX > Typst — problems with links / references #11568). (In this case typst will raise an error.)
  • Add newline after #set text directive (Typst writer: Div with lang attribute breaks lists #11583). This ensures that blocks such as lists are parsed correctly after a set text.

• LaTeX writer:

  • Fix fr-CA babel language mapping (LaTeX writer: lang: fr-CA fails with babel (canadien is deprecated in babel-french) #11575, Christophe Dervieux). Map fr-CA to french instead of deprecated canadien. The babel-french package’s canadien.ldf is deprecated and broken: it never calls \ldf@finish, so \bbl@main@language is left undefined, causing babel to crash at \begin{document}. Since canadien was always just an unconditional alias for french, use french directly.

• MediaWiki writer:

  • Handle some technically malformed URLs (Mediawiki writer generates incorrect output for URLs with more than one # #11562).
  • Fix escaping to avoid accidental lists (Mediawiki writer generates incorrect output for paragraph beginning with literal # #11563).

• Markdown writer:

  • Fix spacing issues with definition lists.
    • Properly handle the case where the first item is an indented code block (Markdown writer loses fenced code block structure inside definition list #11542).
    • Use correct indentation when four_space_rule extension is disabled.
  • Escape ::: to avoid triggering unintended divs (Markdown writer idempotency failure for :::\nA\n::: #11571).

• Man writer:

• Don’t run together successive definitions in a tight definition list with multiple definitions after a term (No paragraph between multiple DDs in man output #11547).

• Text.Pandoc.Writers.Shared:

  • htmlAttrs: use data- prefix when needed (Conversion from HTML to MediaWiki strips data- from all data attributes #11680). This now behaves like the HTML writer, adding the data- prefix for custom attributes. This will affect, e.g., the mediawiki writer.

• Text.Pandoc.Error:

  • Display IOError without stack trace (Unwanted stack trace in error message. #11676).
  • Use single quotes around paths and format names (Add quote marks, 'Could not find data file' "" <== Here #11645) in displayed messages.

• Text.Pandoc.App.Opt:

  • Opt has a new field optTypstInputs [API change].

• Text.Pandoc.Options:

  • Change defaultMathJaxURL to use MathJax v4 (MathJax bug #11669).
  • ReaderOptions has a new field readerTypstInputs [API change].

• Text.Pandoc.Citeproc.BibTeX:

  • Prevent wrong combination of subtitle and titleaddon with maintitle (Biblatex reader: Fix wrong combination of subtitle and titleaddon with maintitle #11677, Amir Dekel). When maintitle is present, subtitle should not be added to title, but only to volume-title.
  • BibLaTeX inbook should be CSL book, not chapter (biblatex: bookinbook wrongly interpreted as type chapter instead of book #11552).
  • Allow doi field in bibtex (input and output) (Bibtex DOIs #11617, Thomas Hodson).

• Text.Pandoc.Translations:

  • Find lang-script type translations (Pandoc and citeproc conflicting zh-Hant zh-TW locale names #11648). E.g. for zh-Hant-TW look for (in order) zh-Hant-TW.yaml, zh-Hant.yaml, zh.yaml.

• Text.Pandoc.Parsing:

  • Various small optimizations.
  • Fix bug in extractIdClass to ensure that both id and class are stripped from key/value attributes..

• Text.Pandoc.Shared:

  • Various small optimizations.

• ODT reference doc: demonstrate predefined styles (310327). This mirrors the demonstration content already present in the Word reference doc.

• HTML templates:

  • Include pandoc-version in generator meta tag (Include version in meta generator HTML tag #11624).
  • Styles: make screen-only CSS conditional (Default inline HTML CSS emits avoidable WeasyPrint warnings (while syntax-highlighted PDF output is otherwise fine) #11524, Keenan Brock).

• EPUB templates:

  • Add dir attribute to html element (dir rtl: different behavior in html and epub #11554).

• LaTeX template: Define \xmpquote if not defined (keywords are enumerated wrongly in PDF #11528). \xmpquote is defined by the hyperref driver hyperxmp; we need a fallback for those who aren’t using that.

• Lua subsystem:

  • Add constructor pandoc.TableBody.

• doc/lua-filters.md: Re-indent definition list items (Albert Krewinkel).

• wasm/index.js: include filter to embed images for pdf-via-typst. Auto-inject embed_images filter for PDF via Typst. Otherwise conversion fails because we can’t write the images in a temporary directory in the WASM sandbox. See pandoc for the people error #11584.

• Fix test suite parallel execution failures ((at least) Tests.Old can fail due to implicit parallelism in tasty >= 1.5.4 #11566).

• linux/make_artifacts.sh: add loong64 support (linux/make_artifacts.sh: add loong64 support #11597, Olivier Benz).

• bash_completion.tpl: add groff to --pdf-engine completions (Update bash completion options for --pdf-engine #11555).

• MANUAL.txt:

  • Improve description of reference links (Examples disregard introduction #11643).
  • Update instructions for modifying reference.docx (Update instructions for modifying reference.docx #11600, Dan Jacobson). Mention LibreOffice as an alternative.
  • Clarify indentation rules for definition lists (Markdown writer loses fenced code block structure inside definition list #11542).
  • Move --sandbox to general options.
  • Reword restrictions on YAML metadata in commonmark (Misleading info in User's Guide concerning restrictions to the yaml_metadata_block extension #11561).

• Bump upper bound for time, tls, aeson.

• Use latest releases of doclayout, asciidoc, texmath, typst, typst-symbols, pandoc-types, citeproc, commonmark, commonmark-pandoc, commonmark-extensions.

• Add missing NAME heading to pandoc-lua, pandoc-server man pages (pandoc-lua man page lacks NAME header, dropping it from apropos(1) #11634).

---

This discussion was created from the release pandoc 3.10.

[benz0li]

Unofficial Linux/RISC-V (64-bit, linux/riscv64) release assets are available at https://gitlab.b-data.ch/jgm/pandoc/-/releases/3.10.

Due to ongoing DDoS attacks, access to b-data's IT infrastructure has been blocked for all Chinese servers.
ℹ️ For any requests to unblock individual Chinese IPs or CIDR blocks, please contact olivier.benz@b-data.ch.

[ngothinguyenngoc]

thank you so much for this project

[yuwalakkon-a11y]

Hi there, I am not a technical IT person, I tried immensely read about installing Pandoc for a week and still dont know what to do? Could anyone olease shade some light for me? I downloaded the latest version and my operating system is Window. it seem like I downloaded Github to my laptop... what is it?

[benz0li]

See https://pandoc.org/installing.html#windows

Windows installer available at https://github.com/jgm/pandoc/releases/tag/3.10:

• pandoc-3.10-windows-x86_64.msi

[benz0li]

Getting started with pandoc: https://pandoc.org/getting-started.html

[yuwalakkon-a11y]

Thank you so much, Olivier. you are so kind.

[jujonogi2030]

Hi, How can i install this? IDK so much about this topics; it´s for wondows