diff --git a/man/pandoc-lua.1 b/man/pandoc-lua.1 --- a/man/pandoc-lua.1 +++ b/man/pandoc-lua.1 @@ -1,6 +1,6 @@ -.\" Automatically generated by Pandoc 3.10.2 +.\" Automatically generated by Pandoc 3.11 .\" -.TH "pandoc-lua" "1" "September 22, 2022" "pandoc 3.10.2" "Pandoc User\[cq]s Guide" +.TH "pandoc-lua" "1" "September 22, 2022" "pandoc 3.11" "Pandoc User\[cq]s Guide" .SH NAME pandoc\-lua \- Lua interface to pandoc API .SH SYNOPSIS diff --git a/man/pandoc-server.1 b/man/pandoc-server.1 --- a/man/pandoc-server.1 +++ b/man/pandoc-server.1 @@ -1,6 +1,6 @@ -.\" Automatically generated by Pandoc 3.10.2 +.\" Automatically generated by Pandoc 3.11 .\" -.TH "pandoc-server" "1" "August 15, 2022" "pandoc 3.10.2" "Pandoc User\[cq]s Guide" +.TH "pandoc-server" "1" "August 15, 2022" "pandoc 3.11" "Pandoc User\[cq]s Guide" .SH NAME pandoc\-server \- web server exposing pandoc API .SH SYNOPSIS @@ -250,7 +250,7 @@ cause the first section to be numbered \(lq1\(rq and the first subsection \(lq1.2.\(rq .TP -\f[CR]html\-math\-method\f[R] (\f[CR]\(dqplain\(dq|\(dqwebtex\(dq|\(dqgladtex\(dq|\(dqmathml\(dq|\(dqmathjax\(dq|\(dqkatex\(dq\f[R]) +\f[CR]math\-method\f[R] (\f[CR]\(dqplain\(dq|\(dqwebtex\(dq|\(dqgladtex\(dq|\(dqmathml\(dq|\(dqmathjax\(dq|\(dqkatex\(dq\f[R]) Determines how math is represented in HTML. .TP \f[CR]listings\f[R] (boolean, default false) diff --git a/man/pandoc.1 b/man/pandoc.1 --- a/man/pandoc.1 +++ b/man/pandoc.1 @@ -1,6 +1,6 @@ -.\" Automatically generated by Pandoc 3.10.2 +.\" Automatically generated by Pandoc 3.11 .\" -.TH "pandoc" "1" "2026\-08\-11" "pandoc 3.10.2" "Pandoc User\[cq]s Guide" +.TH "pandoc" "1" "2026\-08\-28" "pandoc 3.11" "Pandoc User\[cq]s Guide" .SH NAME pandoc - general markup converter .SH SYNOPSIS @@ -531,17 +531,39 @@ Settings from the defaults file may be overridden or extended by subsequent options on the command line. .TP -\f[CR]\-\-bash\-completion\f[R] -Generate a bash completion script. -To enable bash completion with pandoc, add this to your -\f[CR].bashrc\f[R]: +\f[CR]\-\-completion=\f[R]\f[I]SHELL\f[R] +Generate a shell completion script for the given shell, one of +\f[CR]bash\f[R], \f[CR]zsh\f[R], or \f[CR]fish\f[R]. +To enable completion with pandoc, evaluate the output of this command in +your shell\(cqs startup file. +For example, for bash, add this to your \f[CR].bashrc\f[R]: .RS .IP .EX -eval \(dq$(pandoc \-\-bash\-completion)\(dq +eval \(dq$(pandoc \-\-completion=bash)\(dq .EE +.PP +For zsh, you will need to create a directory to store zsh completions +(e.g., \f[CR]\(ti/.local/share/zsh/site\-functions\f[R]) or use one of +the existing directories listed by \f[CR]zsh \-\-pathdirs\f[R]. +Create the pandoc completion script in that directory: +.IP +.EX +pandoc \-\-completion=zsh > \(ti/.local/share/zsh/site\-functions/_pandoc +.EE +.PP +Then add these lines to your \f[CR].zshrc\f[R]: +.IP +.EX +fpath=(\(ti/.local/share/zsh $fpath) +autoload \-Uz compinit && compinit +.EE .RE .TP +\f[CR]\-\-bash\-completion\f[R] +\f[I]Deprecated. +Use \f[CI]\-\-completion=bash\f[I] instead.\f[R] +.TP \f[CR]\-\-sandbox[=true|false]\f[R] Run pandoc in a sandbox, limiting IO operations in readers and writers to reading the files specified on the command line. @@ -1146,9 +1168,9 @@ document. Limitation: resources that are loaded dynamically through JavaScript cannot be incorporated; as a result, fonts may be missing when -\f[CR]\-\-mathjax\f[R] is used, and some advanced features (e.g.\ zoom -or speaker notes) may not work in an offline \(lqself\-contained\(rq -\f[CR]reveal.js\f[R] slide show. +\f[CR]\-\-math\-method=mathjax\f[R] is used, and some advanced features +(e.g.\ zoom or speaker notes) may not work in an offline +\(lqself\-contained\(rq \f[CR]reveal.js\f[R] slide show. .RS .PP For SVG images, \f[CR]img\f[R] tags with \f[CR]data:\f[R] URIs are used, @@ -1744,18 +1766,21 @@ with PDF output. It is intended for use in producing a LaTeX file that can be processed with \f[CR]bibtex\f[R] or \f[CR]biber\f[R]. -.SS Math rendering in HTML -The default is to render TeX math as far as possible using Unicode -characters. -Formulas are put inside a \f[CR]span\f[R] with -\f[CR]class=\(dqmath\(dq\f[R], so that they may be styled differently -from the surrounding text if needed. -However, this gives acceptable results only for basic math, usually you -will want to use \f[CR]\-\-mathjax\f[R] or another of the following -options. +.SS Math rendering .TP -\f[CR]\-\-mathjax\f[R][\f[CR]=\f[R]\f[I]URL\f[R]] -Use MathJax to display embedded TeX math in HTML output. +\f[CR]\-\-math\-method\f[R]=\f[I]METHOD\f[R][\f[CR]:\f[R]\f[I]URL\f[R]] +Specify the method used to display TeX math. +The following methods are possible (some take an optional URL, separated +from the method name by a colon). +The default value is \f[CR]mathml\f[R]. +.RS +.TP +\f[CR]plain\f[R] +Render math using Unicode characters, to the extent possible. +When this is not possible, fall back to plain TeX. +.TP +\f[CR]mathjax\f[R][\f[CR]:\f[R]\f[I]URL\f[R]] +Render math using MathJaX. TeX math will be put between \f[CR]\(rs(...\(rs)\f[R] (for inline math) or \f[CR]\(rs[...\(rs]\f[R] (for display math) and wrapped in \f[CR]\f[R] tags with class \f[CR]math\f[R]. @@ -1763,36 +1788,36 @@ The \f[I]URL\f[R] should point to the \f[CR]MathJax.js\f[R] load script. If a \f[I]URL\f[R] is not provided, a link to the Cloudflare CDN will be inserted. +This method works in HTML and HTML\-derived formats. .TP -\f[CR]\-\-mathml\f[R] -Convert TeX math to MathML (in \f[CR]epub3\f[R], \f[CR]docbook4\f[R], -\f[CR]docbook5\f[R], \f[CR]jats\f[R], \f[CR]html4\f[R] and -\f[CR]html5\f[R]). -This is the default in \f[CR]odt\f[R] output. -MathML is supported natively by the main web browsers and select e\-book +\f[CR]mathml\f[R] +Convert TeX math to MathML. +MathML is supported natively by the main web browsers and most e\-book readers. +This option works in HTML and XML formats. .TP -\f[CR]\-\-webtex\f[R][\f[CR]=\f[R]\f[I]URL\f[R]] +\f[CR]webtex\f[R][\f[CR]:\f[R]\f[I]URL\f[R]] Convert TeX formulas to \f[CR]\f[R] tags that link to an external script that converts formulas to images. The formula will be URL\-encoded and concatenated with the URL provided. For SVG images you can for example use -\f[CR]\-\-webtex https://latex.codecogs.com/svg.latex?\f[R]. +\f[CR]\-\-math\-method=webtex:https://latex.codecogs.com/svg.latex?\f[R]. If no URL is specified, the CodeCogs URL generating PNGs will be used (\f[CR]https://latex.codecogs.com/png.latex?\f[R]). -Note: the \f[CR]\-\-webtex\f[R] option will affect Markdown output as -well as HTML, which is useful if you\(cqre targeting a version of -Markdown without native math support. +Note: this method works not just in HTML but in Markdown, which is +useful if you\(cqre targeting a version of Markdown without native math +support. .TP -\f[CR]\-\-katex\f[R][\f[CR]=\f[R]\f[I]URL\f[R]] +\f[CR]katex\f[R][\f[CR]:\f[R]\f[I]URL\f[R]] Use KaTeX to display embedded TeX math in HTML output. The \f[I]URL\f[R] is the base URL for the KaTeX library. That directory should contain a \f[CR]katex.min.js\f[R] and a \f[CR]katex.min.css\f[R] file. If a \f[I]URL\f[R] is not provided, a link to the KaTeX CDN will be inserted. +This method works in HTML and HTML\-derived formats. .TP -\f[CR]\-\-gladtex\f[R] +\f[CR]gladtex\f[R] Enclose TeX math in \f[CR]\f[R] tags in HTML output. The resulting HTML can then be processed by GladTeX to produce SVG images of the typeset formulas and an HTML file with these images @@ -1800,11 +1825,35 @@ .RS .IP .EX -pandoc \-s \-\-gladtex input.md \-o myfile.htex +pandoc \-s \-\-math\-method=gladtex input.md \-o myfile.htex gladtex \-d image_dir myfile.htex # produces myfile.html and images in image_dir .EE .RE +.RE +.TP +\f[CR]\-\-mathjax\f[R][\f[CR]=\f[R]\f[I]URL\f[R]] +\f[I]Deprecated. +Use \f[CI]\-\-math\-method=mathjax\f[I][\f[CI]:\f[I]\f[R]URL\f[I]] +instead.\f[R] +.TP +\f[CR]\-\-mathml\f[R] +\f[I]Deprecated. +Use \f[CI]\-\-math\-method=mathml\f[I] instead.\f[R] +.TP +\f[CR]\-\-webtex\f[R][\f[CR]=\f[R]\f[I]URL\f[R]] +\f[I]Deprecated. +Use \f[CI]\-\-math\-method=webtex\f[I][\f[CI]:\f[I]\f[R]URL\f[I]] +instead.\f[R] +.TP +\f[CR]\-\-katex\f[R][\f[CR]=\f[R]\f[I]URL\f[R]] +\f[I]Deprecated. +Use \f[CI]\-\-math\-method=katex\f[I][\f[CI]:\f[I]\f[R]URL\f[I]] +instead.\f[R] +.TP +\f[CR]\-\-gladtex\f[R] +\f[I]Deprecated. +Use \f[CI]\-\-math\-method=gladtex\f[I] instead.\f[R] .SS Options for wrapper scripts .TP \f[CR]\-\-dump\-args[=true|false]\f[R] @@ -2246,29 +2295,21 @@ command line defaults file \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - \-\-mathjax html\-math\-method: + \-\-math\-method=mathjax math\-method : method: mathjax - \-\-mathml html\-math\-method: - method: mathml - - \-\-webtex html\-math\-method: + \-\-math\-method=webtex:URL math\-method: method: webtex - - \-\-katex html\-math\-method: - method: katex + url: mathjax - \-\-gladtex html\-math\-method: - method: gladtex + \-\-math\-method=mathml math\-method: + method: mathml .EE .RE .PP -In addition to the values listed above, \f[CR]method\f[R] can have the -value \f[CR]plain\f[R]. -.PP If the command line option accepts a URL argument, an \f[CR]url:\f[R] -field can be added to \f[CR]html\-math\-method:\f[R]. +field can be added to \f[CR]math\-method:\f[R]. .SS Options for wrapper scripts .RS -14n .IP @@ -2905,8 +2946,9 @@ .SS Variables for HTML math .TP \f[CR]classoption\f[R] -when using \f[CR]\-\-katex\f[R], you can render display math equations -flush left using YAML metadata or with \f[CR]\-M classoption=fleqn\f[R]. +when using \f[CR]\-\-math\-method=katex\f[R], you can render display +math equations flush left using YAML metadata or with +\f[CR]\-M classoption=fleqn\f[R]. .SS Variables for HTML slides These affect HTML output when producing slide shows with pandoc. .TP @@ -3473,7 +3515,9 @@ Number of columns for body text. .TP \f[CR]thanks\f[R] -contents of acknowledgments footnote after document title +contents of acknowledgments footnote after document title. +(Note: as of typst 0.15, this does not work properly, due to an upstream +issue; see jgm/pandoc#11807.) .TP \f[CR]mathfont\f[R], \f[CR]codefont\f[R] Name of system font to use for math and code, respectively. @@ -4732,6 +4776,19 @@ This only works reliably, though, if the repeated item is in a list by itself, because each numbered example list will be numbered continuously from its starting number. +.PP +In a longer (book\-length) work, one might need to reset the example +list counter at the beginning of each chapter. +One can do that using the following syntax: +.IP +.EX +(1\(atfoo) This item will be numbered 1, and subsequent example + list items will be numbered 2, 3, etc. +.EE +.PP +Any number may be used instead of \f[CR]1\f[R]. +Note that if there are several example list items in a row, the number +only has an effect if placed on the first of them. .SS Ending a list What if you want to put an indented code block after a list? .IP @@ -5593,7 +5650,7 @@ It will be rendered, if possible, using MathML. .TP DocBook -If the \f[CR]\-\-mathml\f[R] flag is used, it will be rendered using +If \f[CR]\-\-math\-method=mathml\f[R] is used, it will be rendered using MathML in an \f[CR]inlineequation\f[R] or \f[CR]informalequation\f[R] tag. Otherwise it will be rendered, if possible, using Unicode characters. @@ -5602,7 +5659,7 @@ It will be rendered using OMML math markup. .TP FictionBook2 -If the \f[CR]\-\-webtex\f[R] option is used, formulas are rendered as +If \f[CR]\-\-math\-method=webtex\f[R] is used, formulas are rendered as images using CodeCogs or other compatible web service, downloaded and embedded in the e\-book. Otherwise, they will appear verbatim. @@ -6488,7 +6545,8 @@ for strong emphasis, surround by underscores for regular emphasis, add extra blank space around headings. .SS Extension: \f[CR]sourcepos\f[R] -Include source position attributes when parsing \f[CR]commonmark\f[R]. +Include source position attributes when parsing \f[CR]commonmark\f[R] or +\f[CR]djot\f[R]. For elements that accept attributes, a \f[CR]data\-pos\f[R] attribute is added; other elements are placed in a surrounding Div or Span element with a \f[CR]data\-pos\f[R] attribute. diff --git a/pandoc-cli.cabal b/pandoc-cli.cabal --- a/pandoc-cli.cabal +++ b/pandoc-cli.cabal @@ -1,6 +1,6 @@ cabal-version: 2.4 name: pandoc-cli -version: 3.10.2 +version: 3.11 build-type: Simple license: GPL-2.0-or-later license-file: COPYING.md @@ -69,7 +69,7 @@ buildable: True -- Note: we always link to an exact version of pandoc, with the -- same version as this package: - build-depends: pandoc == 3.10.2, text + build-depends: pandoc == 3.11, text other-modules: PandocCLI.Lua , PandocCLI.Server