| AArch64 | |
| ppc64le | |
| s390x | |
| x86-64 |
- Update pandoc to version 2.6.
pandoc (2.6) PROVISIONAL
* Support ipynb (Jupyter notebook) as input and output format.
+ Add `ipynb` as input and output format (extension `.ipynb`).
+ Added Text.Pandoc.Readers.Ipynb [API change].
+ Added Text.Pandoc.Writers.Ipynb [API change].
+ Add `PandocIpynbDecodingError` constructor to Text.Pandoc.Error.Error
[API change].
+ Depend on ipynb library.
+ Note: there is no template for ipynb.
* Add DokuWiki reader (#1792, Alexander Krotov). This adds
Text.Pandoc.Readers.DokuWiki [API change], and adds `dokuwiki`
as an input format.
* Implement task lists (#3051, Mauro Bieg). Added `task_lists`
extension. 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_lists` to `Extension`.
+ Added `taskListItemFromAscii` and `taskListItemToAscii` to
Text.Pandoc.Shared.
* 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 `start` attribute (see #5162).
+ Treat `textarea` as a verbatim environment (#5241) and preserve
spacing.
* RST reader:
+ Change treatment of `number-lines` directive (Brian Leung,
[#5207]). Directives of this type without numeric inputs should
not have a `startFrom` attribute; with a blank value, the
writers can produce extra whitespace.
+ Removed superfluous `sourceCode` class on code blocks (#5047).
+ Handle `sourcecode` directive as synonynm for `code` (#5204).
* Markdown reader:
+ Remove `sourceCode` class for literate Haskell code blocks
(#5047). Reverse order of `literate` and `haskell` classes on
code blocks when parsing literate Haskell, so `haskell` is
first.
+ Treat `<textarea>` as a verbatim environment (#5241).
* Org reader:
+ Handle `minlevel` option differently (#5190, Brian Leung).
When `minlevel` exceeds 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).
* 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 `sourceCode` class for literate Haskell code blocks
(#5047). Reverse order of `literate` and `haskell` classes on
code blocks when parsing literate Haskell, so `haskell` is
first.
+ Support `\DeclareMathOperator` (#5149).
+ Support `\inputminted` (#5103).
+ Support `\endinput` (#5233).
+ Allow includes with dots like `cc_by_4.0`. Previously the `.0`
was 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.
* Man reader:
+ Use `mapLeft` from Shared instead of defining own.
* 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).
* 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 disply 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 `plain` RawBlocks pass through in `plain` output.
+ Include needed whitespace after HTML figure (#5121).
We use HTML for a figure in markdown dialects that can't
represent it natively.
* Commonmark writer:
+ Fix handling of SoftBreak with `hard_line_breaks` (#5195).
+ Implement `--toc` (`writerTableOfContents`)
in commonmark/gfm writers (#5172).
* 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 match `nav#toc ol, nav#landmarks ol`.
We keep the `toc` class on `ol` for backwards compatibility.
* LaTeX writer:
+ Make raw content marked `beamer` pass through in `beamer`
output (pandoc/lua-filters#40).
+ Beamer: avoid duplicated `fragile` property in some cases
(#5208).
+ Add `#` special characters for listings (#4939).
This character needs special handling in `\lstinline`.
* RTF writer: use `toTableOfContents` from 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 `toTableOfContents` from Shared to replace old duplicated code.
* 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 `zoomKey` config (#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 `mainfont` to 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 `romanfont` variable. The functionality of
`mainfont` is identical (#5218).
+ Render `\subtitle` with the standard document classes.
Previously, `subtitle` only 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 [`xurl`](https://ctan.org/pkg/xurl) package if
available, improving the appearance of URLs by allowing them to
break at additional points (#5193).
+ Use [`bookmark`](https://ctan.org/pkg/bookmark) if available
to correct heading levels in PDF bookmarks: see the [KOMA-Script
3.26 release notes](https://komascript.de/release3.26) (#5193).
+ Require the [`xcolor`](https://ctan.org/pkg/xcolor) package to
avoid a possible error when using additional packages alongside
footnotes in tables (#5193, closes #4861).
+ Remove obsolete `fixltx2e` package, which has no functionality
with TeX Live 2015 or later (#5193).
+ Allow multiple `fontfamilies.options` (#5193, closes #5194).
+ Restrict `institute` variable to Beamer (#5219).
+ Use [`footnotehyper`](https://ctan.org/pkg/footnotehyper)
package if available to make footnotes in tables compatible
with `hyperref` (#5234).
+ Number parts and chapters in book classes only if the
`numbersections` variable 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
(currenty 5.3 for lua and x86masm for assembler), you can use
`--include-in-header` to inject something like
`\lstset{defaultdialect=[5.2]Lua}`.
* 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 `PandocUTF8DecodingError` constructor
for `PandocError`. [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 of `pipeProcess` was rewritten to fix sporadic
failures caused by prematurely closed pipes.
* Use `safeRead` instead of `read` everywhere in the code
(John MacFarlane, Mauro Bieg, #5162, #5180).
* Text.Pandoc.SelfContained: Decompress `.svgz` when
converting to `data:` 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 `\\server` no longer work.
This commit rewrites such patsh to `\\?\UNC\server` which works.
The change operates at the level of argument parsing, so it
only affects the command line program.
* Simplify/fix reading of `--metadata` values 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 `findPandoc` in `Tests.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-convert` is 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_breaks` works in `gfm` (see #5195).
+ Mention `raw_attribute` in documentation for `raw_html` and
`raw_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-meta` template variable (#5260, Tristan Stenner).
* trypandoc: Fix CSS and viewport.
- Patch build to cope with with recent versions of 'http-client'.
- Increase required memory in _constraints to avoid OOM failures
- Update Cabal build instructions to support zip-archive 0.4.
- Update pandoc to version 2.5.
* 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_identifiers` is now a modifier of
`auto_identifiers`; for identifiers to be set, `auto_identifiers` must
be turned on, and then the type of identifier produced depends on
`gfm_auto_identifiers` and `ascii_identifiers` are set. Accordingly,
`auto_identifiers` is now added to `githubMarkdownExtensions` (#5057).
+ Remove `ascii_identifiers` from `githubMarkdownExtensions`.
GitHub doesn't seem to strip non-ascii characters any more.
* 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 `equals` which performs this test has been added to the
`pandoc.utils` module.
+ 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.
* 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 `tfoot` before body rows (#5079).
+ Parse `<small>` as a Span with class "small" (#5080).
+ Allow thead containing a row with `td` rather than `th` (#5014).
* 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 class `references`.
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 id `refs` rather than one with class `references`.
+ Exactly match GitHub's identifier generating algorithm (#5057).
+ Add parameter for `Extensions` to `uniqueIdent` and
`inlineListToIdentifier` (#5057). [API change]
This allows these functions to be sensitive to the settings of
`Ext_gfm_auto_identifiers` and `Ext_ascii_identifiers`, and allows us to
use `uniqueIdent` in the CommonMark reader, replacing custom code. It
also means that `gfm_auto_identifiers` can now be used in all formats.
* 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).
* Text.Pandoc.Writers.CommonMark
+ Respect `--ascii` (#5043, quasicomputational).
+ Make sure `--ascii` affects quotes, super/subscript.
* 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 Policitics
In 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
if `writerIncremental` is 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 `@menu` section (#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 `--ascii` works for gfm and commonmark too.
+ Add `man` to `--from` options.
* doc/customizing-pandoc.md: various improvements (Mauro Bieg).
- Update pandoc to version 2.4.
pandoc (2.4)
[new features]
* New input format `man` (Yan Pashkovsky, John MacFarlane).
[behavior changes]
* `--ascii` is now implemented in the writers, not in Text.Pandoc.App,
via the new `writerPreferAscii` field in `WriterOptions`.
Now the `write*` functions for Docbook, HTML, ICML, JATS, LaTeX,
Ms, Markdown, and OPML are sensitive to `writerPreferAscii`.
Previously the to-ascii translation was done in Text.Pandoc.App,
and thus not available to those using the writer functions
directly.
* `--ascii` now works with Markdown output. HTML5 character reference
entities are used.
* `--ascii` now works with LaTeX output. 100% ASCII output can't be
guaranteed, but the writer will use commands like `\"{a}` and `\l`
whenever possible, to avoid emiting a non-ASCII character.
* For HTML5 output, `--ascii` now 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-headers` was 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_html` disabled. 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 when `raw_html` is 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 `--katex` in 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-defined` tags.
+ 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 `lang` in 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 `lang` in 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.
* RST reader: Pass through fields in unknown directives as div attributes
(#4715). Support `class` and `name` attributes for all directives.
* Org reader: Add partial support for `#+EXCLUDE_TAGS` option. (#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`, and `delimiter`).
+ 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 generic `for` loop with pairs`:
for field_name, field_content in pairs(element) do
...
end
Raw 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`/`tag` field.
+ 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.MetaList` now 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, `meta` and `blocks`. The field content is only
marshaled on-demand, performance of scripts not accessing the
fields remains unaffected.
[API changes]
* Text.Pandoc.Options: add `writerPreferAscii` to `WriterOptions`.
* Text.Pandoc.Shared:
+ Export `splitSentences`. This was previously duplicated in the Man and
Ms writers.
+ Add `ToString` typeclass (Alexander Krotov).
* New exported module Text.Pandoc.Filter (Albert Krewinkel).
* Text.Pandoc.Parsing
+ Generalize `gridTableWith` to any `Char` Stream (Alexander Krotov).
+ Generalize `readWithM` from `[Char]` to any `Char` Stream
that is a `ToString` instance (Alexander Krotov).
* New exposed module Text.Pandoc.Filter (Albert Krewinkel).
* Text.Pandoc.XML: add `toHtml5Entities`.
* New exported module Text.Pandoc.Readers.Man (Yan Pashkovsky, John
MacFarlane).
* Text.Pandoc.Writers.Shared
+ Add exported functions `toSuperscript` and
`toSubscript` (quasicomputational, #4528).
+ Remove exported functions `metaValueToInlines`,
`metaValueToString`. Add new exported functions
`lookupMetaBool`, `lookupMetaBlocks`, `lookupMetaInlines`,
`lookupMetaString`. Use these whenever possible for uniformity
in writers (Mauro Bieg, #4907). (Note that
removed function `metaValueToInlines` was in previous
released versions.)
+ Add `metaValueToString`.
* Text.Pandoc.Lua
+ Expose more useful internals (Albert Krewinkel):
- `runFilterFile` to run a Lua filter from file;
- data type `Global` and its constructors; and
- `setGlobals` to add globals to a Lua environment.
This module also contains `Pushable` and `Peekable` instances
required to get pandoc's data types to and from Lua. Low-level
Lua operation remain hidden in Text.Pandoc.Lua.
+ Rename `runPandocLua` to `runLua` (Albert Krewinkel).
+ Remove `runLuaFilter`, merging this into Text.Pandoc.Filter.Lua's
`apply` (Albert Krewinkel).
[bug fixes and under-the-hood improvements]
* Text.Pandoc.Parsing
+ Make `uri` accept any stream with Char tokens (Alexander Krotov).
+ Rewrite `uri` without `withRaw` (Alexander Krotov).
+ Generalize `parseFromString` and `parseFromString'` to any
streams with Char token (Alexander Krotov)
+ Rewrite `nonspaceChar` using `noneOf` (Alexander Krotov)
* Text.Pandoc.Shared: Reimplement `mapLeft` using `Bifunctor.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 `htmlTag` and `isInlineTag` to
accept processing instructions (#3123, regression since 2.0).
* Text.Pandoc.Readers.JATS: Use `foldl'` instead of `maximum` to
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`, `runF` and `stateMeta'` in favor of `stateMeta`
(Alexander Krotov).
+ Parse `Text` without converting to `[Char]` (Alexander Krotov).
* Text.Pandoc.Readers.Creole: Parse `Text` without converting to
`[Char]` (Alexander Krotov).
* Text.Pandoc.Readers.LaTeX
+ Allow space at end of math after `\` (#5010).
+ Add support for `nolinkurl` command (#4992, Brian Leung).
+ Simplified type on `doMacros'`.
+ Tokenize before pulling tokens, rather than after (#4408). This
has some performance penalty but is more reliable.
+ Make macroDef polymorphic and allow in inline context.
Otherwise we can't parse something like `\lowercase{\def\x{Foo}}`.
I have actually seen tex like this in the wild.
+ Improved parsing of `\def`, `\let`. We now correctly parse:
```
\def\bar{hello}
\let\fooi\bar
\def\fooii{\bar}
\fooi +\fooii
\def\bar{goodbye}
\fooi +\fooii
```
+ Improve parsing of `\def` argspec.
+ Skip `\PackageError` commands (see #4408).
+ Fix bugs omitting raw tex (#4527). The default is `-raw_tex`,
so no raw tex should result unless we explicitly say `+raw_tex`.
Previously some raw commands did make it through.
+ Moved `isArgTok` to Text.Pandoc.Readers.LaTeX.Parsing.
+ Moved `babelLangToBCP`, `polyglossiaLangToBCP` to new module,
Text.Pandoc.Readers.LaTeX.Lang (unexported).
+ Simplified accent code using unicode-transforms.
New dependency on unicode-transforms package for normalization.
+ Allow verbatim blocks ending with blank lines (#4624).
+ Support `breq` math environments: `dmath`, `dgroup`, `darray`.
This collects some of the general-purpose code from the LaTeX reader,
with the aim of making the module smaller.
* 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 `museToPandocTable` to 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 `\autocite` when 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 `.SH` and `.SS` lines (#5019).
+ Avoid unnecessary `.RS`/`.RE` pair 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 `splitSentences` to Text.Pandoc.Shared.
* 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:p`
element 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 `css` instead of
`stylesheet` (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 `splitSentences` to Text.Pandoc.Shared (to avoid duplication
with the man writer).
* Text.Pandoc.Writers.Muse (Alexander Krotov).
+ Add support for grid tables.
+ Fix Muse writer style.
+ Use `length` instead of `realLength` to calculate definition
indentation. Muse parsers don't take character width into
account when calculating indentation.
+ Do not insert newline before lists.
+ Use lightweight markup after `</em>` tag.
* New unexported module Text.Pandoc.Writers.Roff, providing functions
useful for all roff format writers (man, ms).
* Text.Pandoc.Lua
+ Move globals handling to separate module Text.Pandoc.Lua.Global
(Albert Krewinkel).
+ Lua filter internals: push Shared.Element as userdata (Albert
Krewinkel). Hierarchical Elements were pushed to Lua as plain
tables. This is simple, but has the disadvantage that marshaling
is eager: all child elements will be marshaled as part of the
object. Using a Lua userdata object instead allows lazy access
to fields, causing content marshaling just (but also each time)
when a field is accessed. Filters which do not traverse the full
element contents tree become faster as a result.
[default template changes]
* LaTeX template:
+ Add variable `hyperrefoptions` (#4925, Mathias Walter).
+ Add variable `romanfont`, `romanfontoptions` (#4665, OvidiusCicero).
* AsciiDoc template: use single-line style for title.
* revealjs template: Fix typo in the socket.io javascript plugin (#5006,
Yoan Blanc).
* Text.Pandoc.Lua.Util: add missing docstring to `defineHowTo`
(Albert Krewinkel).
* data/pandoc.lua: add datatype ListAttributes (Albert Krewinkel)
* data/sample.lua: replace custom pipe function with pandoc.utils.pipe
(Albert Krewinkel).
[documentation improvements]
* INSTALL.md
+ Add chromeos install instructions (#4958) (Evan Pratten).
+ Add note about TinyTeX.
* MANUAL.txt
+ Change `groff` -> `roff`.
+ Implement `--ascii` for Markdown writer.
+ Clarify LaTeX image dimensions output (Mauro Bieg).
* doc/customizing-pandoc.md: added skeleton (Mauro Bieg, #3288).
* doc/getting-started.md: Added title to test1.md to avoid warning.
* doc/lua-filters.md: merge type references into main document,
fix description of Code.text (Albert Krewinkel).
[build infrastructure improvements]
* Makefile
+ Makefile: added quick-cabal, full-cabal targets.
+ Make .msi download targets insensitive to order of appveyor builds.
* Update benchmarks for ghc 8.6.1.
* pandoc.cabal:
+ Enable more compiler warnings (Albert Krewinkel).
+ Make base lower bound 4.8.
+ Bump upper bound for QuickCheck.
+ Bump upper bound for binary.
+ Updated version bounds for containers and haddock-library (#4974).
+ Added docx/docPropos/custom.xml to cabal data-files.
+ Require skylighting 0.7.4 (#4920).
+ New dependency on unicode-transforms package for normalization.
* Improved .travis.yml testing and test with GHC 8.6.1 (Albert Krewinkel).
* Added `tools/changelog-helper.sh`.
* Added test/grofftest.sh for testing the man reader on real man pages.
- Update pandoc to version 2.3.1.
* RST reader:
+ Parse RST inlines containing newlines (#4912, Francesco Occhipinti).
This eliminates a regression introduced after pandoc 2.1.1, which
caused inline constructions containing newlines not to be recognized.
+ Fix bug with internal link targets (#4919). They were gobbling up
indented content underneath.
* Markdown reader: distinguish autolinks in the AST. With this change,
autolinks are parsed as Links with the `uri` class. (The same is true
for bare links, if the `autolink_bare_uris` extension is enabled.)
Email autolinks are parsed as Links with the `email` class. This
allows the distinction to be represented in the AST.
* Org reader:
+ Force inline code blocks to honor export options (Brian Leung).
+ Parse empty argument array in inline src blocks (Brian Leung).
* Muse reader (Alexander Krotov):
+ Added additional tests.
+ Do not allow code markup to be followed by digit.
+ Remove heading level limit.
+ Simplify `<literal>` tag parsers
+ Parse Text instead of String. Benchmark shows 7% improvement.
+ Get rid of HTML parser dependency.
+ Various code improvements.
* ConTeXt writer: change `\` to `/` in Windows image paths (#4918).
We do this in the LaTeX writer, and it avoids problems.
Note that `/` works as a LaTeX path separator on Windows.
* LaTeX writer:
+ Add support for multiprenote and multipostnote arguments
with `--biblatex` (Brian Leung, #4930). The multiprenotes occur before
the first prefix of a multicite, and the multipostnotes follow the
last suffix.
+ Fix a use of `last` that might take empty list. If you ran with
`--biblatex` and have an empty document (metadata but no blocks),
pandoc would previously raise an error because of the use of
`last` on an empty list.
* RTF writer: Fix build failure with ghc-8.6.1 caused by missing
MonadFail instance (Jonas Scholl).
* ODT Writer: Improve table header row style handling (Nils Carlson).
This changes the way styles for cells in the header row
and normal rows are handled in ODT tables.
Previously a new (but identical) style was generated for
every table, specifying the style of the cells within the table.
After this change there are two style definitions for table cells,
one for the cells in the header row, one for all other cells.
This doesn't change the actual styles, but makes post-processing
changes to the table styles much simpler as it is no longer
necessary to introduce new styles for header rows and there are
now only two styles where there was previously one per table.
* HTML writer:
+ Don't add `uri` class to presumed autolinks. Formerly the `uri`
class was added to autolinks by the HTML writer, but it had to
guess what was an autolink and could not distinguish
`[http://example.com](http://example.com)` from
`<http://example.com>`. It also incorrectly recognized
`[pandoc](pandoc)` as an autolink. Now the HTML writer
simply passes through the `uri` attribute if it is present,
but does not add anything.
+ Avoid adding extra section nestings for revealjs.
Previously revealjs title slides at level (slidelevel - 1)
were nested under an extra section element, even when
the section contained no additional (vertical) content.
That caused problems for some transition effects.
+ Omit unknown attributes in EPUB2 output. For example,
`epub:type` attributes should not be passed through,
or the epub produced will not validate.
* JATS writer: remove 'role' attribute on 'bold' and 'sc' elements (#4937).
The JATS spec does not allow these.
* Textile writer: don't represent `uri` class explicitly
for autolinks (#4913).
* Lua filters (Albert Krewinkel):
+ Cleanup filter execution code.
+ Better error on test failure.
* HTML, Muse reader tests: reduce time taken by round-trip test.
* Added cabal.project.
* MANUAL: `epub:type` is only useful for epub3 (Maura Bieg).
* Use hslua v1.0.0 (Albert Krewinkel).
* Fix `translations/ru` to use modern Russian orthography
(Ivan Trubach).
* Build Windows binary using ghc 8.6.1 and cabal new-build. This
fixes issues with segfaults in the 32-bit Windows binaries (#4283).
* Add `--metadata-file` option (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 `Macro` constructor is now `[ArgSpec]` instead of
`Int` (API change).
* Markdown reader:
+ Use `tex` instead of `latex` for raw tex-ish content. We can't
always tell if it's LaTeX, ConTeXt, or plain TeX. Better just to
use `tex` always. Note that if `context` or `latex` specifically
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 (Format `latex`). In most cases it should be
trivial to modify the filters to accept `tex` as well.
+ Refactor and reorganize YAML code (Mauro Bieg).
+ Make `example_lists` work for interrupted lists
without `startnum` (#4908).
* HTML reader:
+ Parse `<script type="math/tex` tags 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_tex` extension (#1126). This now
allows raw LaTeX environments, `\ref`, and `\eqref` to be parsed
(which is helpful for translation HTML documents using MathJaX).
* Org reader (Albert Krewinkel):
+ Respect export option `p` for planning info. Inclusion of planning info
(`*DEADLINE*`, `*SCHEDULED*`, and `*CLOSED*`) can be controlled via the
`p` export option: setting the option to `t` will 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).
* LaTeX reader:
+ Split some general-purpose definitions into a separate, unexported
module, Text.Pandoc.Readers.LaTeX.Parsing. This is to avoid
out-of-memory errors compiling the LaTeX reader.
+ Handle parameter patterns for `\def` (#4768, #4771).
For example: `\def\foo#1[#2]{#1 and #2}`.
+ Allow `%` characters in URLs. This affects `\href` and `\url` (#4832).
+ Fixed parsing of `\texorpdfstring`. We were returning the wrong
argument as the content.
+ Support `blockcquote`, `foreignblockquote`, `foreigncblockquote`,
`hyphenblockquote`, `hyphencblockquote`, `enquote*`, `foreignquote`,
`hyphenquote` from `csquotes` (#4848). Note that `foreignquote`
will 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 `\ref` for figure numbers.
+ Support `mintinline` (#4365, Marc Schreiber).
+ Fix siunitx unit commands so they are only recognized in
siunitx contexts (#4842). For example, `\l` outside of an
siunitx context should be l-slash, not l (for liter).
+ Fix double `unnumbered` class (#4838). The `unnumbered` class
was being included twice for starred sections.
* 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 `headingStart` function.
+ 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 using
`parseFromString`. This change makes it possible to have
verbatim `</verse>` tag inside verse.
* 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 = True` when 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 `conditionalEscapeString`
never returns empty string.
+ Wrap conditionalEscapeString result into `Muse` type.
This removes the need to pass `envInsideLinkDescription` to it.
+ Separate `shouldEscapeString` function.
+ 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 with `data-`.
* 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:type` on body element in each chapter,
depending on the `epub:type` of the first section (#4823). This
only affects epub3. See
http://www.idpf.org/epub/profiles/edu/structure/#h.l0bzsloklt10
* FB2 writer: put `coverpage` element between title and date rather than in
`document-info` element (#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 `filecolor` variable (#4822).
`linkcolor` only affects internal links, and `urlcolor` only
affects linked URLs. For external links, the option to use is
`filecolor`.
* ConTeXt writer: output raw `tex` blocks as well as `context` (#969).
* RST writer:
+ Use `.. raw:: latex` for `tex` content.
+ Use `.. container` for 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.
* Text.Pandoc.PDF: fix message printed when rsvg-convert is not available
(#4855, Antonio Terceiro).
* HTML5 template: add the `title-block-header` identifier to the
`header` element, 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 for
`publisher`, `address`, `pubPlace`, and `date` variables.
* 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/--natbib` don't work directly for PDF
(#4904).
+ Document `epub:type` attribute (Mauro Bieg, #4901)
+ Clarify when `--resource-path` has 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).
* 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.
- Add _constraints to avoid OOM errors
- Update pandoc to version 2.2.3.2.
* Markdown reader: Properly handle boolean values in YAML metadata (#4819).
This fixes a regression in 2.2.3, which cause boolean values to
be parsed as MetaInlines instead of MetaBool.
We here record another undocumented (but desirable) change in 2.2.3:
numerical metadata fields are now parsed as MetaInlines rather than
MetaString.
* Markdown reader: Fix parsing of embedded mappings in YAML metadata
(#4817). This fixes a regression in 2.2.3 which caused embedded
mappings (e.g. mappings in sequences) not to work in YAML metadata.
* RST reader: improve parsing of inline interpreted text roles (#4811).
+ Use a Span with class "title-reference" for the default
title-reference role.
+ Use `B.text` to split up contents into `Space`s, `SoftBreak`s,
and `Str`s for `title-reference`.
+ Use Code with class "interpreted-text" instead of Span and Str for
unknown roles. (The RST writer has also been modified to round-trip
this properly.)
+ Disallow blank lines in interpreted text.
+ Backslash-escape now works in interpreted text.
+ Backticks followed by alphanumerics no longer end interpreted text.
+ Remove support for nested inlines (Francesco Occhipinti).
RST does not allow nested emphasis, links, or other inline
constructs. This fixes several bugs (#4581, #4561, #4792).
* Org reader: fix parsers relying on `parseFromString` (#4784, Albert
Krewinkel). Emphasis was not parsed when it followed directly after
some block types (e.g., lists).
* Markdown reader: Allow unquoted numbers and booleans as YAML mapping
keys. Previously in 2.2.2 you could not do
```
- --
0: bar
...
```
but only
```
- --
'0': bar
...
```
With this change, both forms work.
* DocBook reader: metadata handling improvements.
Now we properly parse title and subtitle elements that are direct
children of book and article (as well as children of bookinfo,
articleinfo, or info). We also now use the `subtitle` metadata
field for subtitles, rather than tacking the subtitle on to the
title.
* RST writer:
+ Allow images to be directly nested within links (#4810, Francesco
Occhipinti).
+ Use `titleblock` instead of `title` variable for title block (#4803,
Francesco Occhipinti). `titleblock` contains a properly formatted
title and subtitle (using top-level headers). `title` and
`subtitle` variables are still available and just contain the
title and subtitle text. Note that this change will require an
update to custom rst templates.
+ Render Code with class "interpreted-text" as interpreted text role.
* MediaWiki writer: Avoid extra blank line in tables with empty cells
(#4794). Note that the old output is semantically identical, but the
new output looks better.
* Lua Utils module: add function `blocks_to_inlines` (#4799, Albert
Krewinkel). Exposes a function converting which flattenes a list of
blocks into a list of inlines. An example use case would be the
conversion of Note elements into other inlines.
* RST template: use `titleblock` instead of `title`. Users of
custom RST templates will want to update this.
* LaTeX template: Moved some beamer code in default.latex template.
This change allows beamer themes to change the template and font (as
Metropolis does) (#4450).
* Better error message on `-t pdf -o out.pdf` (#1155, Mauro Bieg).
* Added test case for #4669 to repository.
* INSTALL.md: Fix broken link for cabal-install (#4806, ChanHoHo).
* MANUAL.txt:
+ Add beamer info for slide backgrounds (#4802, John Muccigrosso).
+ Clarify when `csquotes` is used in LaTeX writer (#4514).
+ Add `commonmark` to list of output formats where `raw_tex` has an
effect (see #4527).
- Update pandoc to version 2.2.2.1.
pandoc (2.2.2.1)
* Fix regression finding templates in user data directory (#4777).
Under version 2.2.1 and prior pandoc found latex templates in the
templates directory under the data directory, but this broke in 2.2.2.
* Fix for bug in parsing `\input` in `rawLaTeXBlock` and
`rawLaTeXInline` (#4781). (This primarily affects the markdown
reader, and other readers that accept raw tex.)
Starting in 2.2.2, everything after an `\input` (or `\include`)
in a markdown file would be parsed as raw LaTeX.
* MANUAL:
+ Clarify `gfm` vs `markdown_github` (#4783, Mauro Bieg).
* Use `keywords` instead of `tags` in YAML metadata example (#4779).
Unlike `tags`, `keywords` is used in some of the writers
and default templates.
* Add missing `rollingLinks` option to revealjs template (#4778,
Igor Khorlo).
- Cosmetic: replace tabs with blanks, strip trailing white space, and update copyright headers with spec-cleaner.
- Update pandoc to version 2.2.2.
* 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`, and `on` no longer count as true values.
* Fix regression: make `--pdf-engine` work with full paths (#4681, Mauro
Bieg).
* CommonMark reader: Handle `ascii_identifiers` extension (#4742,
Anders Waldenborg). Non-ascii characters were not stripped from
identifiers even if the `ascii_identifiers` extension 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 `lilypond` as a verbatim environment (#4725).
+ Parse figure label into Image id (#4700, Mauro Bieg).
+ Beamer: Allow "noframenumbering" option (#4696, Raymond Ehlers).
+ Allow spaces around `\graphicspath` arguments (#4698).
+ Handle includes without surrounding blanklines (#4553).
In addition, `\input` can 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
`\begin` or `\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).
* Markdown reader:
+ Allow empty code spans, e.g. `` ` ` ``.
+ Emojis are now wrapped in Spans with class `emoji` and
attribute `data-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).
* 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 `@sup` and `@sub` instead of custom macros (#4728,
Alexander Krotov).
* Markdown writer: Preserve `implicit_figures` with attributes, even if
`implicit_attributes` is not set, by rendering in raw HTML (#4677).
* Markdown and commonmark/github writers now respect the `emoji`
extension. So, `-f markdown+emoji -t markdown+emoji` now leaves
`:smile:` as `:smile:` rather than converting it to a smile
character.
* Docx writer: Be sensitive to `toc` in 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-sections` via the `section-numbering`
directive in standalone output.
* reveal.js writer and template: reuse mathjax URL
provided by the argument to `--mathjax` or 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
(class `emoji`, attribute `data-emoji` with 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 `--template` to take a URL as argument.
* Text.Pandoc.Highlighting: Add missing re-export of `breezeDark`
highlighting 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`, `on` no longer count as true values.
+ Document `-F` as alias for `--filter` (thanks to Gandalf Saxe).
+ Update manual on how math is rendered in LaTeX.
+ Add proxy description (#4131, Mauro Bieg).
+ Clarify that `--toc` requires `--standalone` (#4703).
+ Update citation styles link (#4699, wiefling).
* In API docs, clarify how `Ext_east_asian_line_breaks` extension 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 `.orig` files from repository (#4648).
* Remove `network-uri` flag and use 'Network.Socket'.
This removes a compiler warning. There is no need for the old
`network-uri` flag, 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.
- Avoid use of '[' and ']' characters in %files section entries. This allows building for older distributions.
- Update pandoc to version 2.2.1.
* Restored and undeprecated gladtex for HTML math (#4607).
+ Added `GladTeX` constructor to `Text.Pandoc.Options.HTMLMathMethod`
[API change, reverts removal in v2.2]
+ Restored and undeprecated `--gladtex` option, removed in v2.2.
* 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
`singleQuoteStart` and `doubleQuoteStart` (#4637).
* `test-pandoc-utils.lua`: more robust testing on both windows
and \*nix. Previously the pipe tests were only run if
`\bin/false` and `/bin/sed` were present, which they aren't
in default MacOS and Windows systems. Fixed by using `tr`
and `false`, which should always be in the path on a \*nix
system, and `find` and `echo` for 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:/foo` gets interpreted as `c:/foo`, but on Linux,
`/c:/foo` gets interpreted as `/c:/foo`. See #4613.
* Use `uriPathToPath` with 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 `--ascii` work for all XML formats (ICML, OPML, JATS,...),
and for `ms` and `man`.
* Remove deprecated `--latexmathml`, `--gladtex`, `--mimetex`, `--jsmath`, `-m`,
`--asciimathml` options.
* 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 `doubleQuote` parser. 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.
* EPUB reader:
+ Fix images with space in file path (#4344).
* LaTeX reader:
+ Properly resolve section numbers with `\ref` and 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 `\MakeTextUppercase` and `\MakeTextLowercase` from textcase
(#4959).
* 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.
* DocBook reader:
+ Properly handle title in `section` element (#4526).
Previously we just got `section_title` for `section` (though `sect1`,
`sect2`, etc. were handled properly).
+ Read tex math as output by asciidoctor (#4569, Joe Hermaszewski).
* 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=preserve` for all tests by default.
+ Reduced `<verbatim>` tags in output.
+ Internal changes.
* 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 `pagetitle` is always set, even when structured titles
are used. This prevents spurious warnings about empty title
elements (#4486).
* 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 `abstract` to book annotation.
+ Use `<empty-line />` for `HorizontalRule` rather than `LineBreak`.
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 `Maybe` from `SpeakerNotes` in `Slide`. `mempty`
means 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, `column` divs). 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.jpeg` in 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_tex` is not
enabled (#4527, quasicomputational).
* EPUB writer:
+ Add `epub:type="footnotes"` to notes section in EPUB3 (#4489).
* 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 `\lstinline` delimiters (#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.
* Man writer:
+ Don't escape U+2019 as `'` (#4550).
* Text.Pandoc.Options:
+ Removed `JsMath`, `LaTeXMathML`, and `GladTeX` constructors from
`Text.Pandoc.Options.HTMLMathMethod` [API change].
* Text.Pandoc.Class:
+ `writeMedia`: unescape URI-escaping in file path. This avoids
writing things like `file%20one.png` to the file system.
* Text.Pandoc.Parsing:
+ Fix `romanNumeral` parser (#4480). We previously accepted 'DDC'
as 1100.
+ `uri`: don't treat `*` characters at end as part of URI (#4561).
* Text.Pandoc.MIME:
+ Use the alias `application/eps` for EPS (#2067).
This will ensure that we retain the eps extension after reading the
image into a mediabag and writing it again.
* Text.Pandoc.PDF:
+ Use `withTempDir` in `html2pdf`.
+ 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). `pdflatex` converts 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`.
* 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 `beamer` same as `latex`.
* LaTeX template:
+ Add `beameroption` variable (#4359, Étienne Bersac).
+ Use `pgfpages` package; this is needed for notes on second
screen in beamer (Étienne Bersac).
+ Add `background-image` variable (#4601, John Muccigrosso).
* reveal.js template: Add `background-image` variable (#4600,
John Muccigrosso).
* ms template: Fix date. Previously `.ND` was 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 with `embed_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`/`openxml` and
some others.
+ Don't say that `empty_paragraphs` affects 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 `-threaded` GHC 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 `unwrap` function 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):
+ 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.
+ Don't allow footnote references inside links.
+ Allow URL to be empty.
+ Require that comment semicolons are in the first column (#4551).
+ Various internal improvements.
* LaTeX reader:
+ Add support to parse unit string of `\SI` command (closes #4296,
Marc Schreiber).
* 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 `DefaultStyle` ordered 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
the `plain` attribute, 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 wih 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. `NoImplicitPrelude` is 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.
* Raise error if someone tries to print docx, odt, etc. template (#4441).
* LaTeX template: Provide `bidi` package's option using
`\PassOptionsToPackage` (#4357, Václav Haisman). This avoid a
clash when `polyglossia` loads it first and then it is loaded again
for XeLaTeX.
* ConTeXt template: Added `pdfa` variable 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 consistently `NoImplicitPrelude`. Everything else to be specified
in the module header as needed.
* Removed `old-locale` flag and Text.Pandoc.Compat.Time.
This is no longer necessary since we no longer support ghc 7.8.
* Make `weigh-pandoc` into a benchmark program.
Remove `weigh-pandoc` flag. `weigh-pandoc` is 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.
* Commonmark reader:
+ `raw_html` is 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-pre` and
`#+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 `--trace` work.
+ 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 <literal> 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 `definitionListItem` to `definitionList`.
+ Paragraph indentation does not indicate nested quote.
Muse allows indentation to indicate quotation or alignment,
but only on the top level, not within a <quote> 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.
* Docx reader (Jesse Rosenthal, except where noted):
+ Handle nested sdt tags (#4415).
+ Don't look up dependant run styles if `+styles` is 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 `+styles` extension (`-f docx+styles`).
This can be used in conjunction with the `custom-style` feature 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.
* 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 `notesMaster` to `presentation.xml` if 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-divs` option to
write sections in the fenced style, with `\startsection` and
`\stopsection`.
+ xtables: correct wrong usage of caption (Henri Menke).
* 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).
- `getUniqueId` now 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=all` were 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 `height` instead of `depth` for images (#4331).
+ Ensure that id prefix is always used.
+ Don't emit `role` attribute; that was a leftover from the
Docbook writer.
+ Use 'xml:id', not 'id' attribute (#4371).
* AsciiDoc writer:
+ Do not output implicit heading IDs (#4363, Alexander
Krotov). Convert to `asciidoc-auto_identifiers` for old behaviour.
* RST writer:
+ Remove `blockToRST'` moving its logic into `fixBlocks`
(Francesco Occhipinti).
+ Insert comment between lists and quotes (#4248, Francesco Occchipinti).
* 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
`incremental` or `nonincremental`.
* 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_html` default for `commonmark` format.
* 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).
* 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.md` Add 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).
* Markdown reader:
+ Don't coalesce adjacent raw LaTeX blocks if they are separated by a
blank line. See lierdakil/pandoc-crossref#160.
+ Improved `inlinesInBalancedBrackets` (#4272, jgm/pandoc-citeproc#315).
The change both improves performance and fixes a regression whereby
normal citations inside inline notes and figure captions were not
parsed correctly.
* RST reader:
+ Better handling for headers with an anchor (#4240). Instead of creating a
Div containing the header, we put the id directly on the header.
This way header promotion will work properly.
+ Add aligned environment when needed in math (#4254). `rst2latex.py`
uses an `align*` environment for math in `.. math::` blocks, so this
math may contain line breaks. If it does, we put the math in an
`aligned` environment to simulate `rst2latex.py`'s behavior.
* HTML reader:
+ Fix col width parsing for percentages < 10% (#4262, n3fariox).
* LaTeX reader:
+ Advance source position at end of stream.
+ Pass through macro defs in `rawLaTeXBlock` even if the `latex_macros`
extension is set (#4246). This reverts to earlier behavior and is
probably safer on the whole, since some macros only modify things in
included packages, which pandoc's macro expansion can't modify.
+ Fixed pos calculation in tokenizing escaped space.
+ Allow macro definitions inside macros (#4253). Previously we went into
an infinite loop with
```
\newcommand{\noop}[1]{#1}
\noop{\newcommand{\foo}[1]{#1}}
\foo{hi}
```
+ Fix inconsistent column widths (#4238). This fixes a bug whereby column
widths for the body were different from widths for the header in some
tables.
* Docx reader (Jesse Rosenthal):
+ Parse hyperlinks in `instrText` tags (#3389, #4266). This was a form of
hyperlink found in older versions of word. The changes introduced for
this, though, create a framework for parsing further fields in MS Word
(see the spec, ECMA-376-1:2016, 17.16.5, for more on these fields).
We introduce a new module, `Text.Pandoc.Readers.Docx.Fields` which
contains a simple parsec parser. At the moment, only simple hyperlink
fields are accepted, but that can be extended in the future.
* Muse reader (Alexander Krotov):
+ Parse `~~` as non-breaking space in Text::Amuse mode.
+ Refactor list parsing.
* Powerpoint writer (Jesse Rosenthal):
+ Change reference to `notesSlide` to `endNotesSlide`.
+ Move image sizing into `picProps`.
+ Improve table placement.
+ Make our own `_rels/.rels` file.
+ Import reference-doc images properly.
+ Move `Presentation.hs` out of `PandocMonad`.
+ Refactor into separate modules. T.P.W.Powerpoint.Presentation
defines the Presentation datatype and goes Pandoc->Presentation;
T.P.W.Pandoc.Output goes Presentation->Archive.
Text.Pandoc.Writers.Powerpoint a thin wrapper around the two modules.
+ Avoid overlapping blocks in column output.
+ Position images correctly in two-column layout.
+ Make content shape retrieval environment-aware.
+ Improve image handling. We now determine image and caption placement
by getting the dimensions of the content box in a given layout.
This allows for images to be correctly sized and positioned in a
different template. Note that images without captions and headers are
no longer full-screened. We can't do this dependably in different
layouts, because we don't know where the header is (it could be to
the side of the content, for example).
+ Read presentation size from reference file. Our presentation size is
now dependent on the reference/template file we use.
+ Handle (sub)headers above slidelevel correctly. Above the slidelevel,
subheaders will be printed in bold and given a bit of extra space
before them. Note that at the moment, no distinction is made between
levels of headers above the slide header, though that can be changed.
+ Check for required files. Since we now import from reference/dist
file by glob, we need to make sure that we're getting the files we
need to make a non-corrupt Powerpoint. This performs that check.
+ Improve templating using `--reference-doc`. Templating should work
much more reliably now.
+ Include Notes slide in TOC.
+ Set notes slide header to slide-level.
+ Add table of contents. This is triggered by the `--toc` flag. Note
that in a long slide deck this risks overrunning the text box. The user
can address this by setting `--toc-depth=1`.
+ Set notes slide number correctly.
+ Clean up adding metadata slide. We want to count the slide numbers
correctly if it's in there.
+ Add anchor links. For anchor-type links (`[foo](#bar)`) we produce
an anchor link. In powerpoint these are links to slides, so we keep
track of a map relating anchors to the slides they occur on.
+ Make the slide number available to the blocks. For anchors,
block-processing functions need to know what slide number
they're in. We make the `envCurSlideId` available to blocks.
+ Move `curSlideId` to environment.
+ Allow setting `toc-title` in metadata.
+ Link notes to endnotes slide.
* Markdown writer:
+ Fix cell width calculation (#4265). Previously we could get
ever-lengthening cell widths when a table was run repeatedly through
`pandoc -f markdown -t markdown`.
* LaTeX writer:
+ Escape `&` in lstinline (Robert Schütz).
* ConTeXt writer:
+ Use xtables instead of Tables (#4223, Henri Menke).
Default to xtables for context output. Natural Tables are used
if the new `ntb` extension is set.
* HTML writer:
+ Fixed footnote backlinks with `--id-prefix` (#4235).
* `Text.Pandoc.Extensions`: Added `Ext_ntb` constructor (API change,
Henri Menke).
* `Text.Pandoc.ImageSize`: add derived `Eq` instance to `Dimension`
(Jesse Rosenthal, API change).
* Lua filters (Albert Krewinkel):
+ Make `PANDOC_READER_OPTIONS` available.
The options which were used to read the document are made available to
Lua filters via the `PANDOC_READER_OPTIONS` global.
+ Add lua module `pandoc.utils.run_json_filter`, which runs a JSON filter
on a Pandoc document.
+ Refactor filter-handling code into `Text.Pandoc.Filter.JSON`,
`Text.Pandoc.Filter.Lua`, and `Text.Pandoc.Filter.Path`.
+ Improve error messages. Provide more context about the task
which caused an error.
* data/pandoc.lua (Albert Krewinkel):
+ Accept singleton inline as a list. Every constructor which accepts a
list of inlines now also accepts a single inline element for
convenience.
+ Accept single block as singleton list. Every constructor which accepts
a list of blocks now also accepts a single block element for
convenience. Furthermore, strings are accepted as shorthand for
`{pandoc.Str "text"}` in constructors.
+ Add attr, listAttributes accessors. Elements with
attributes got an additional `attr` accessor. Attributes were
accessible only via the `identifier`, `classes`, and `attributes`,
which was in conflict with the documentation, which indirectly states
that such elements have the an `attr` property.
+ Drop `_VERSION`. Having a `_VERSION` became superfluous, as this
module is closely tied to the pandoc version, which is available via
`PANDOC_VERSION`.
+ Fix access to Attr components. Accessing an Attr value (e.g.,
` Attr().classes`) was broken; the more common case of accessing it via
an Inline or Block element was unaffected by this.
* Move `metaValueToInlines` to from Docx writer to
`Text.Pandoc.Writers.Shared`, so it can be used by other writers
(Jesse Rosenthal).
* MANUAL.txt:
+ Clarify otherlangs in LaTeX (#4072).
+ Clarify `latex_macros` extension.
+ Recommend use of `raw_attribute` extension in header includes (#4253).
* Allow latest QuickCheck, tasty, criterion.
* Remove custom prelude and ghc 7.8 support.
* Reduce compiler noise (exact paths for compiled modules).
* Allow filters and lua filters to be interspersed (#4196). Previously
we ran all lua filters before JSON filters. Now we run filters in
the order they are presented on the command line, whether lua or JSON.
There are two incompatible API changes: The type of `applyFilters`
has changed, and `applyLuaFilters` has been removed. `Filter` is
also now exported.
* Use latest skylighting and omit the `missingIncludes` check, fixing
a major performance regression in earlier releases of the 2.x series
(#4226). Behavior change: If you use a custom syntax definition that
refers to a syntax you haven't loaded, pandoc will now complain when
it is highlighting the text, rather than doing a check at the start.
This change dramatically speeds up invocations of pandoc on short
inputs.
* Text.Pandoc.Class: make `FileTree` opaque (don't export
`FileTree` constructor). This forces users to interact with it using
`insertInFileTree` and `getFileInfo`, which normalize file names.
* Markdown reader:
+ Rewrite `inlinesInBalancedBrackets`. The rewrite is much more
direct, avoiding `parseFromString`. And it performs significantly
better; unfortunately, parsing time still increases exponentially
(see #1735).
+ Avoid parsing raw tex unless `\` + letter seen. This seems to
help with the performance problem, #4216.
* LaTeX reader: Simplified a check for raw tex command.
* Muse reader (Alexander Krotov):
+ Enable round trip test (#4107).
+ Automatically translate `#cover` into `#cover-image`.
Amusewiki uses #cover directive to specify cover image.
* Docx reader (Jesse Rosenthal):
+ Allow for insertion/deletion of paragraphs (#3927).
If the paragraph has a deleted or inserted paragraph break (depending
on the track-changes setting) we hold onto it until the next
paragraph. This takes care of accept and reject. For this we introduce
a new state which holds the ils from the previous para if necessary.
For `--track-changes=all`, we add an empty span with class
`paragraph-insertion`/`paragraph-deletion` at the end of the paragraph
prior to the break to be inserted or deleted.
+ Remove unused anchors (#3679). Docx produces a lot of anchors with
nothing pointing to them---we now remove these to produce cleaner
output. Note that this has to occur at the end of the process
because it has to follow link/anchor rewriting.
+ Read multiple children of `w:sdtContents`.
+ Combine adjacent anchors. There isn't any reason to have numerous
anchors in the same place, since we can't maintain docx's
non-nesting overlapping. So we reduce to a single anchor.
+ Improved tests.
* Muse writer (Alexander Krotov): don't escape URIs from AST
* Docx writer:
+ Removed redundant subtitle in title (Sebastian Talmon).
+ `firstRow` table definition compatibility for Word 2016 (Sebastian
Talmon). Word 2016 seems to use a default value of "1" for table
headers, if there is no firstRow definition (although a default
value of 0 is documented), so all tables get the first Row formatted
as header. Setting the parameter to 0 if the table has no header
row fixes this for Word 2016
+ Fix custom styles with spaces in the name (#3290).
* Powerpoint writer (Jesse Rosenthal):
+ Ignore Notes div for parity with other slide outputs.
+ Set default slidelevel correctly. We had previously defaulted to
slideLevel 2. Now we use the correct behavior of defaulting to the
highest level header followed by content. We change an expected test
result to match this behavior.
+ Split blocks correctly for linked images.
+ Combine adjacent runs.
+ Make inline code inherit code size. Previously (a) the code size
wasn't set when we force size, and (b) the properties was set from
the default, instead of inheriting.
+ Simplify `replaceNamedChildren` function.
+ Allow linked images. The following markdown:
`[](http://www.example.com)`
will now produce a linked image in the resulting PowerPoint file.
+ Fix error with empty table cell. We require an empty `<a:p>` tag,
even if the cell contains no paragraphs---otherwise PowerPoint
complains of corruption.
+ Implement two-column slides. This uses the columns/column div
format described in the pandoc manual. At the moment, only two
columns (half the screen each) are allowed. Custom widths are not
supported.
+ Added more tests.
* OpenDocument/ODT writers: improved rendering of formulas (#4170, oltolm).
* Lua filters (Albert Krewinkel):
+ `data/pandoc.lua`: drop 'pandoc-api-version' from Pandoc objects
+ The current pandoc-types version is made available to Lua programs in
the global `PANDOC_API_VERSION`. It contains the version as a list of
numbers.
+ The pandoc version available as a global `PANDOC_VERSION` (a list
of numbers).
+ `data/pandoc.lua`: make `Attr` an `AstElement`.
+ `data/pandoc.lua`: make all types subtypes of `AstElement`.
`Pandoc`, `Meta`, and `Citation` were just plain functions and did
not set a metatable on the returned value, which made it difficult
to amend objects of these types with new behavior. They are now
subtypes of AstElement, meaning that all their objects can gain
new features when a method is added to the behavior object
(e.g., `pandoc.Pandoc.behavior`).
+ `data/pandoc.lua`: split type and behavior tables. Clearly distinguish
between a type and the behavioral properties of an instance of that
type. The behavior of a type (and all its subtypes) can now be
amended by adding methods to that types `behavior` object, without
exposing the type objects internals. E.g.:
```lua
pandoc.Inline.behavior.frob = function () print'42' end
local str = pandoc.Str'hello'
str.frob() -- outputs '42'
```
+ `data/pandoc.lua`: fix Element inheritance. Extending all elements
of a given type (e.g., all inline elements) was difficult, as the
table used to lookup unknown methods would be reset every time a
new element of that type was created, preventing recursive property
lookup. This is was changed in that all methods and attributes of
supertypes are now available to their subtypes.
+ `data/pandoc.lua`: fix attribute names of Citation (#4222). The
fields were named like the Haskell fields, not like the documented,
shorter version. The names are changed to match the documentation
and Citations are given a shared metatable to enable simple
extensibility.
+ `data/pandoc.lua`: drop function `pandoc.global_filter`.
+ Bump `hslua` version to 0.9.5. This version fixes a bug that made it
difficult to handle failures while getting lists or a Map from Lua.
A bug in pandoc, which made it necessary to always pass a tag when
using MetaList or MetaBlock, is fixed as a result. Using the pandoc
module's constructor functions for these values is now optional
(if still recommended).
+ Stop exporting `pushPandocModule` (API change). The introduction
of `runPandocLua` renders direct use of this function obsolete.
+ Update generation of module docs for lua filters.
+ `Lua.Module.Utils`: make stringify work on `MetaValues` (John
MacFarlane). I'm sure this was intended in the first place,
but currently only `Meta` is supported.
* Improve benchmarks.
+ Set the default extensions properly.
+ Improve benchmark argument parsing. You can now say
`make bench BENCHARGS="markdown latex reader"` and both the
markdown and latex readers will be benchmarked.
* MANUAL.txt simplify and add more structure (Mauro Bieg).
* Generate README.md from template and MANUAL.txt.
`make README.md` will generate the README.md after changes
to MANUAL.txt have been made.
* Update copyright notices to include 2018 (Albert Krewinkel).
* Added `jats` as 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 `references` field 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.
* Allow `--list-extensions` to 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 `\placeformula` as 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_macros` extension changes described below
under the LaTeX reader.
* LaTeX reader:
+ `latex_macros` extension changes (#4179). Don't pass through macro
definitions themselves when `latex_macros` is set. The macros
have already been applied. If `latex_macros` is enabled, then
`rawLaTeXBlock` in 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 `applyMacros` in `rawLaTeXBlock`, `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 `\foreignlanguage` from 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 `:minlevel` parameter. E.g.
`#+include: "tour.org" :minlevel 1` will 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`.
* 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:sdt` elements (Jesse Rosenthal,
[#4190]).
* Plain writer:
+ Don't linkify table of contents.
* RST writer:
+ 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 `distArchive` is the one that comes with pandoc
(#4182). Previously a `reference.docx` in `~/.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 the `distArchive` to supply.
* 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-block` removed. Those maintaining custom templates will want
to remove this too. We still enclose line blocks in a div with class
`line-block`.
* LaTeX writer:
+ Use `\renewcommand` for `\textlatin` with babel (#4161).
This avoids a clash with a deprecated `\textlatin` command defined
in Babel.
+ Allow fragile=singleslide attribute in beamer slides (#4169).
+ Use `\endhead` after `\toprule` in headerless tables (#4207).
* FB2 writer:
+ Add cover image specified by `cover-image` meta (Alexander Krotov,
[#4195]).
* 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 of `fig`, `table-wrap` or `caption` (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.
* 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 `ToLuaStack` instance definitions, which made
it difficult to share code with Lua filters, as this could result
in conflicting instances. A `Stringify` wrapper is introduced to
avoid this problem.
+ Added tests for custom writer.
+ Fixed definition lists and tables in `data/sample.lua`.
* Fixed regression: when target is PDF, writer extensions were being
ignored. So, for example, `pandoc -t latex-smart -o file.pdf`
did not work properly.
* Lua modules (Albert Krewinkel):
+ Add `pandoc.utils` module, to hold utility functions.
+ Create a Haskell module Text.Pandoc.Lua.Module.Pandoc to
define the `pandoc` lua module.
+ Make a Haskell module for each Lua module. Move definitions for the
`pandoc.mediabag` modules to a separate Haskell module.
+ Move `sha1` from the main `pandoc` module to `pandoc.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`: load `pandoc.utils` by default
+ Turn pipe, read into full Haskell functions. The `pipe` and `read`
utility functions are converted from hybrid lua/haskell functions
into full Haskell functions. This avoids the need for intermediate
`_pipe`/`_read` helper functions, which have dropped.
+ pandoc.lua: re-add missing MetaMap function. This was a bug
introduced in version 2.0.4.
* Text.Pandoc.Class: Add `insertInFileTree` [API change]. This gives
a pure way to insert an ersatz file into a `FileTree`. 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.theme` data file (#4096). It is no longer needed now
that we have `--print-highlight-style`.
* Added `stack.lts9.yaml` for 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 need `stack.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 `+smart` by 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).
* filters.md: say that Text.Pandoc.JSON comes form pandoc-types.
Closes jgm/pandoc-website#16.
* epub.md: Delete removed `-S` option from command (#4151, Georger Araújo).
* Fix a bug in 2.0.4, whereby pandoc could not read the theme files
generated with `--print-highlight-style` (#4133). Improve JSON
serialization of styles.
* Fix CSS issues involving line numbers (#4128).
Highlighted code blocks are now enclosed in a div with class `sourceCode`.
Highlighting CSS no longer sets a generic color for pre and code; we only
set these for class `sourceCode`.
* `--pdf-engine-opt`: fix bug where option order was reversed (#4137).
* Add PowerPoint (pptx) writer (Jesse Rosenthal).
It works following the standard Pandoc conventions for making other
sorts of slides. Caveats:
+ Syntax highlighting is not yet implemented. (This is difficult
because there are no character classes in Powerpoint.)
+ Footnotes and Definition lists are not yet implemented. (Notes will
usually take the form of a final slide.
+ Image placement and auto-resizing has a few glitches.
+ Reference powerpoint files don't work dependably from the command
line. This will be implemented, but at the moment users are advised
to change themes from within Powerpoint.
* Create shared Text.Pandoc.Writers.OOXML module (Jesse Rosenthal).
This is for functions used by both Powerpoint and Docx writers.
* Add default pptx data for Powerpoint writer (Jesse Rosenthal).
* Add `empty_paragraphs` extension.
+ Deprecate `--strip-empty-paragraphs` option. Instead we now
use an `empty_paragraphs` extension that can be enabled on
the reader or writer. By default, disabled.
+ Add `Ext_empty_paragraphs` constructor to `Extension`.
+ Revert "Docx reader: don't strip out empty paragraphs."
This reverts commit d6c58eb836f033a48955796de4d9ffb3b30e297b.
+ Implement `empty_paragraphs` extension in docx reader and writer,
opendocument writer, HTML reader and writer.
+ Add tests for `empty_paragraphs` extension.
* Markdown reader:
+ Don't parse native div as table caption (#4119).
+ Improved computation of column widths in pipe tables.
Pipe tables with lines longer than the text width (as set
by `--columns`) are now scaled to text width, with the relative
widths of columns determined by the ratios between the
header lines. Previously we computed column widths using
the ratio of header line lengths to column width, so that
tables with narrow header lines were extremely thin, which
was very rarely the desired result.
* LaTeX reader: fix `\` before newline (#4134). This should be a space,
as long as it's not followed by a blank line. This has been fixed at the
tokenizer level.
* Muse reader (Alexander Krotov):
+ Add test for `#disable-tables` directive in Emacs mode.
+ Don't allow emphasis to be preceded by letter.
+ Add underline support in Emacs Muse mode..
+ Support multiline directives in Amusewiki mode
* Man writer: omit internal links (#4136). That is, just print the link
text without the URL.
* Markdown reader: accept processing instructions as raw HTML (#4125).
* Lua filters (Albert Krewinkel):
+ Use script to initialize the interpreter. The file `init.lua` is
used to initialize the Lua interpreter which is used in Lua filters.
This gives users the option to require libraries which they want to
use in all of their filters, and to extend default modules.
+ Fix package loading for Lua 5.1. The list of package searchers is
named `package.loaders` in Lua 5.1 and LuaJIT, and `package.searchers`
in Lua 5.2 and later.
+ Refactor lua module handling. The integration with Lua's package/module
system is improved: A pandoc-specific package searcher is prepended to
the searchers in `package.searchers`. The modules `pandoc` and
`pandoc.mediabag` can now be loaded via `require`.
+ Bump lower bound of hslua. The release hslua 0.9.3 contains a new
function which makes using Haskell functions as package loaders much
easier.
* reveal.js template: add title-slide identifier to title slide (#4120).
This allows it to be styled more easily.
* LaTeX template: Added support for `pagestyle` variable (#4135,
Thomas Hodgson)
* Add `-threaded` to ghc-options for executable (#4130, fixes a build
error on linux).
* Add `--print-highlight-style` option. This generates a JSON version
of a highlighting style, which can be saved as a `.theme` file, modified,
and used with `--highlight-style` (#4106, #4096).
* Add `--strip-empty-paragraphs` option. 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 `--webtex` for `gfm` output.
* Recognize `.muse` file extension.
* Support beamer `\alert` in 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-paragraphs` to 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_html` and `raw_tex` extensions. Note that `raw_html`
is enabled by default for `gfm`, while `raw_tex` is 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.
* 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).
* 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 `fixDisplayMath` from `Text.Pandoc.Writers.Shared`
so that it no longer produces empty `Para`'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 `tex2jax` configuration 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.lua` module 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 given `List` as 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 have `List` as a metatable):
function Emph (emph)
local s = {pandoc.Space(), pandoc.Str 'emphasized'}
return pandoc.Span(emph.content .. s)
end
The `List` metatable is assigned to the tables which get passed to
the constructors `MetaBlocks`, `MetaInline`, and `MetaList`. 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 the `blocks` value.
+ 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 `numberLines` is used (#4103).
* Make `normalizeDate` more forgiving (Mauro Bieg, #4101), not
requiring a leading 0 on single-digit days.
* Fix `--help` output for `--highlight-style` to include `FILE` (Mauro
Bieg, #4095).
* Clearer deprecation warning for `--latexmathml, --asciimathml, -m`.
Previously we only mentioned `--latexmathml`, even if `-m` was
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-types` dependency (Justus Sagemüller, #4084).
* Add `epub.md`, `getting-started.md` to docs. These used to live in
the website repo.
* Add `packages` target to Makefile.
* Bump bounds for binary, http-types, tasty-hunit
* Lua filters: preload text module (Albert Krewinkel, #4077).
The `text` module is preloaded in lua. The module contains some UTF-8
aware string functions, implemented in Haskell. The module is loaded on
request only, e.g.:
text = require 'text'
function Str (s)
s.text = text.upper(s.text)
return s
end
* Allow table-like access to attributes in lua filters (Albert Krewinkel,
[#4071]). Attribute lists are represented as associative lists in Lua. Pure
associative lists are awkward to work with. A metatable is attached to
attribute lists, allowing to access and use the associative list as if
the attributes were stored in as normal key-value pair in table.
Note that this changes the way `pairs` works on attribute lists. Instead
of producing integer keys and two-element tables, the resulting iterator
function now returns the key and value of those pairs. Use `ipairs` to
get the old behavior. Warning: the new iteration mechanism only works if
pandoc has been compiled with Lua 5.2 or later (current default: 5.3).
* Text.Pandoc.Parsing.uri: allow `&` and `=` as word characters (#4068).
This fixes a bug where pandoc would stop parsing a URI with an
empty attribute: for example, `&a=&b=` wolud stop at `a`.
(The uri parser tries to guess which punctuation characters
are part of the URI and which might be punctuation after it.)
* Introduce `HasSyntaxExtensions` typeclass (Alexander Krotov, #4074).
+ Added new `HasSyntaxExtensions` typeclass for `ReaderOptions` and
`WriterOptions`.
+ Reimplemented `isEnabled` function from `Options.hs` to accept both
`ReaderOptions` and `WriterOptions`.
+ Replaced `enabled` from `CommonMark.hs` with new `isEnabled`.
* Add `amuse` extension (Alexander Krotov) to enable Amuse wiki
behavior for `muse`. New `Ext_amuse` constructor for
`Extension`. Note: this is switched on by default; for
Emacs behavior, use `muse-amuse`.
* Muse reader (Alexander Krotov):
+ Count only one space as part of list item marker.
+ Produce SoftBreaks on newlines. Now wrapping can be preserved
with `--wrap=preserve`.
+ Add Text::Amuse footnote extensions. Footnote end is indicated by
indentation, so footnotes can be placed anywhere in the text,
not just at the end of it.
+ Accept Emacs Muse definition lists when `-amuse`.
Emacs Muse does not require indentation.
* HTML reader:
+ Ensure we don't produce level 0 headers (#4076), even for chapter
sections in epubs. This causes problems because writers aren't set
up to expect these.
+ Allow spaces after `\(` and before `\)` with `tex_math_single_backslash`.
Previously `\( \frac{1}{a} < \frac{1}{b} \)` was not parsed as math in
`markdown` or `html` `+tex_math_single_backslash`.
+ Parse div with class `line-block` as LineBlock.
+ Don't fail with block-level content in figcaption (Mauro Bieg, #4183).
* MANUAL: clarify that math extensions work with HTML.
Clarify that `tex_math_dollars` and `tex_math_single_backslash`
will work with HTML as well as Markdown.
* Creole reader: Fix performance issue for longer lists (Sascha Wilde,
[#4067]).
* RST reader: better support for 'container' directive (#4066).
Create a div, incorporate name attribute and classes.
* LaTeX reader:
+ Support column specs like `*{2}{r}` (#4056). This is equivalent to
`rr`. We now expand it like a macro.
+ Allow optional args for parbox (#4056).
+ Allow optional arguments on `\footnote` (#4062).
* EPUB writer: Fixed path for cover image (#4069). It was previously
`media/media/imagename`, and should have been `media/imagename`.
* Markdown writer: fix bug with doubled footnotes in grid tables
(#4061).
* LaTeX template: include natbib/biblatex after polyglossia (#4073).
Otherwise we seem to get an error; biblatex wants polyglossia
language to be defined.
* Added examples to lua filters documentation.
* Deprecated ancient HTML math methods: `--latexmathml`, `--gladtex`,
`--mimetex`, `--jsmath`.
* Fixed URIs in `data/jats.csl`. They were being rendered twice,
leading to invalid XML in default JATS output with pandoc-citeproc.
* `lua-filters.md`: use real-world man page filter as example.
* Add lua filter functions `walk_inline` and `walk_block`
in the pandoc module, to apply filters inside particular
inline and block elements.
* Refactored some code from `Text.Pandoc.Lua.PandocModule`
into new internal module `Text.Pandoc.Lua.Filter`.
* Markdown reader:
+ Allow fenced code blocks to be indented 1-3 spaces (#4011).
This brings our handling of them into alignment with CommonMark's.
+ Fix YAML metadata with "chomp" (`|-`). Previously if a
YAML block under `|-` contained a blank line, pandoc would
not parse it as metadata.
* Removed `etc.` from abbreviations file. Often `etc.` ends a
sentence, and we want the period to be treated as a
sentence-ending period.
* Fix regression with `--metadata` (#4054). Values specified with
`--metadata` should replace a metadata value set in the document
itself, rather than creating a list including a new value.
* EPUB writer:
+ Fix EPUB OCF structure. #3720 had been improperly implemented.
+ Fix modified paths for raw HTML tags (src, poster, etc.)
(#4050, #4055). This had not been updated for the new EPUB
container layout, with a separate text/ subdirectory.
+ Fix image paths with empty `--epub-subdirectory`.
* Miscellaneous code cleanup (Alexander Krotov).
* Use pandoc-types 1.17.3, which adds `Walkable` instances
for `[Block] Block` and `[Inline] Inline`.
* Remove obsolete `stack.full.yaml` (#4052).
* Change to using pandoc-citeproc 0.12.1 in binary packages.
* Consolidate math output method documentation (#4049, Mauro Bieg).
* `MANUAL.txt`: fix header level of "Extension: emoji" (Albert Krewinkel).
* Use lua filter to generate man page from `MANUAL.txt`, replacing old
Haskell filters. This is easier and faster.
* Improved `INSTALL.md`.
* Update commands to extract deb archive on Linux (#4043, Salim B).
* Improved fix to #3989 (parsing of HTML tags containing
`>` in an attribute or comment). The previous fix (in 2.0.1) only
worked in certain cases.
* FB2 writer (Alexander Krotov):
+ Add `unrecognised` genre to `<title-info>`
(Alexander Krotov). XML schema requires at least one genre.
+ Remove `<annotation>` from `<body>`.
* CommonMark writer: fix strikethrough for `gfm` (#4038).
* Use texmath 0.10, which adds support for a wider range of
symbols and fixes default column alignments in MathML
and OMML.
* Highlighting fixes, using skylighting 0.4.3.2:
+ Fix invalid CSS.
+ Support `lineAnchors` (or `line-anchors`) in HTML code blocks.
+ Ensure that code lines don't get duplicate identifiers (#4031).
The line identifiers are built using the code block's identifier
as a prefix. If the code block has null identifier, we use
`cb1`, `cb2`, etc.
* Added a few abbreviations to `data/abbreviations`,
and sorted the list (#3984, Wandmalfarbe).
* Improved support for columns in HTML writer (#4028).
+ Remove `width` attribute from the `div`.
+ Remove space between `<div class="column">` elements,
since this prevents columns whose widths sum to 100%
(the space takes up space).
+ Move as much as possible of the CSS to the template.
+ Ensure that all the HTML-based templates (including epub)
contain the CSS for columns.
+ Columns default to 50% width unless they are given a width
attribute. So if you want two equal-width columns, you
can use a div with class `column` and no `width` attribute.
* SelfContained: use `base64` for css links with media attribute (#4026).
This fixes `--self-contained` with S5.
* Improve `pandoc-template-mode.el` (Vaclav Haisman).
* Issue INFO, not WARNING, when a .sty file cannot be
read in LaTeX reader. It is normally not an issue requiring
a fix from the user if .sty files are not found.
* INSTALL.md: MacOS instructions needed xar -f (adam234).
* MANUAL.txt:
+ Clarify that --setext-headers doesn't affect gfm output (#4035).
+ Clarify what is needed to open and close a div in `fenced_divs`
(#4039, Tristano Ajmone).
+ Removed reference to `default.beamer` in docs (#4024).
Also added mention of other templates affecting PDF output
with different settings.
* Fixed regression in parsing of HTML comments in markdown and other
non-HTML formats (`Text.Pandoc.Readers.HTML.htmlTag`) (#4019).
The parser stopped at the first `>` character, even if it wasn't
the end of the comment.
* Creole reader (Sascha Wilde):
+ Fix some minor typos and formatting.
+ Add additional test on nowiki-block after para.
+ Fix lists with trailing white space.
* LaTeX reader: handle `%` comment right after command.
For example, `\emph%`.
* Markdown reader: make sure fenced div closers work in lists.
Previously the following failed:
::: {.class}
1. one
2. two
:::
and you needed a blank line before the closing `:::`.
* Make `fenced_divs` affect the Markdown writer. If `fenced_divs` is
enabled, Divs will be rendered as fenced divs.
* LaTeX/Beamer writer: support "blocks" inside columns and other Divs
(#4016).
* HTML Writer: consistently use dashed class-names (Mauro Bieg, #3556).
Note: this change may require some changes in CSS rules.
`footnoteRef` has become `footnote-ref`, `titleslide` has
become `title-slide`, and `footnoteBack` has become `footnote-back`.
* JATS writer: Properly pass through author metadata (#4020).
* FB2 writer (Alexander Krotov):
+ Write blocks outside of `<p>` in definitions.
+ Make bullet lists consistent with ordered lists, repeating
the marker for the outer list rather than indenting sublists,
since indentation does not work in readers.
+ Add new style FB2 tests.
* `Text.Pandoc.ImageSize`: Add `Millimeter` constructor to `Dimension`
(#4012) [API change]. Now sizes given in 'mm' are no longer converted
to 'cm'.
* Revise documentation of small caps syntax (Andrew Dunning, #4013).
* Fix broken reference links in manual (Andrew Dunning, #4014)
* Fixed example of slide columns structure in changelog (#4015).
Also documented this feature in MANUAL.txt.
* EPUB writer:
+ Fixed filepaths for nonstandard epub-subdirectory values.
+ Ensure that epub2 is recognized as a non-text format,
so that a template is used.
+ Don't include "prefix" attribute for ibooks for epub2.
It doesn't validate.
+ Fix stylesheet paths; previously we had an incorrect
stylesheet path for the cover page and nav page.
* LaTeX reader:
+ Insert space when needed in macro expansion (#4007).
Sometimes we need to insert a space after a control sequence
to prevent it merging with a following letter.
+ Allow unbraced arguments for macros (#4007).
+ Allow body of macro definition to be unbraced (#4007).
* Linux package build: ensure that pandoc-citeproc is statically linked.
* trypandoc: add native, ms.
[new features]
* 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 with `groff -ms -e` if
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_github`
has been deprecated in favor of `gfm`.
* 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_github`
has been deprecated in favor of `gfm`.
* 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_divs` extension 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_attribute` extension (which is on by default
for `markdown` and `multimarkdown`). The syntax is the same as
for fenced code blocks or code inlines, only with `{=FORMAT}` for
attributes, where `FORMAT` is 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|native` flag and writer option to control line endings
(Stefan Dresselhaus, #3663, #2097).
* Add `--log` option to save log messages in JSON format to a file (#3392).
* Add `--request-header` option, 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-filter`
option works like `--filter` but 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 before
regular filters, regardless of their position on the command line.
For documentation of lua filters, see `doc/lua-filters.md`.
* Set `PANDOC_READER_OPTIONS` in environment where filters are run.
This contains a JSON representation of `ReaderOptions`, so filters
can access it.
* Support creation of pdf via groff `ms` and pdfroff.
`pandoc -t ms -o output.pdf input.txt`.
* Support for PDF generation via HTML and `weasyprint` or `prince`
(Mauro Bieg, #3909). `pandoc -t html5 -o output.pdf --pdf-engine=prince`.
* Added `--epub-subdirectory` option (#3720). This specifies the
subdirectory in the OCF container that holds the EPUB specific content.
We now put all EPUB related content in an `EPUB/` 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=SEARCHPATH` command 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-path` option is used.
* Added `--abbreviations=FILE` option for custom abbreviations file
(#256). Default 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 (`~/.pandoc` on *nix).
* Allow a theme file as argument to `--highlight-style`.
Also include a sample, `default.theme`, in `data/`.
* Allow `--syntax-definition` option for dynamic loading of syntax
highlighting definitions (#3334).
* Lists in `markdown` by 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
- b
will be parsed as a list item with a sublist; under the four-space
rule, it would be a list with two items.
- a
code
Here 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
code
Here 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_rule` extension. This triggers the old pandoc
parsing rule for content nested under list items (the "four space
rule").
* Added `spaced_reference_links` extension (#2602). It allows whitespace
between the two parts of a reference link: e.g.
[a] [b]
[b]: url
This was previously enabled by default; it is now forbidden by default.
* Add `space_in_atx_header` extension (#3512). This is enabled by default
in pandoc and GitHub markdown but not the other flavors.
This requires 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 like
[#]hashtag
or
[#5]
* Add `sourcefile` and `outputfile` template 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
```
[behavior changes]
* 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 in `data/translations`.
* Make `--ascii` work with DocBook output too.
* Rename `--latex-engine` to `--pdf-engine`,
and `--latex-engine-opt` to `--pdf-engine-opt`.
* Removed `--parse-raw` and `readerParseRaw`. These were confusing.
Now we rely on the `+raw_tex` or `+raw_html` extension with latex or html
input. Thus, instead of `--parse-raw -f latex` we use `-f latex+raw_tex`,
and instead of `--parse-raw -f html` we use `-f html+raw_html`.
* With `--filter` R 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 `--css` instead (#3472, #847).
Multiple stylesheets may be used. Stylesheets will be taken both from
`--css` and from the `stylesheet` metadata field (which can contain
either a file path or a list of them).
* `--mathml` and 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.
* `--katex` improvements. 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 with `data-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-contained` is used. This is
similar to a feature already supported by the EPUB writer.
* Allow `--extract-media` to work with non-binary input formats
(#1583, #2289). If `--extract-media` is 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: a4` work regardless of the case of `a4`.
It is converted to `a4` in LaTeX and `A4` in ConTeXt.
* Make `east_asian_line_breaks` affect 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_identifiers` when 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-contents` for contents of toc, make `toc` a boolean
(#2872). Changed markdown, rtf, and HTML-based templates accordingly.
This allows you to set `toc: true` in the metadata; this
previously produced strange results in some output formats.
For backwards compatibility, `toc` is still set to the
toc contents. But it is recommended that you update templates
to use `table-of-contents` for the toc contents and `toc`
for 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 `-o` option 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 `error` have been replaced by
raising of `PandocError`, which can be trapped and handled by the
calling program.
* Removed `hard_line_breaks` extension from `markdown_github` (#3594).
GitHub has two Markdown modes, one for long-form documents like READMEs
and one for short things like issue coments. 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_breaks` is a better default.
* Include `backtick_code_blocks` extension in `mardkown_mmd` (#3637).
* Escape `MetaString` values (as added with `-M/--metadata` flag) (#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`, `in` for image height/width in HTML, LaTeX (#3450).
* HTML writer: Insert `data-` in front of unsupported attributes. Thus,
a span with attribute `foo` gets written to HTML5 with `data-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-links` in Markdown writer (#3701). With
`--reference-location` of `section` or `block`, 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 `lang` attribute (#1667).
+ Added support for `--toc` (#2836). Thanks to @anayrat.
* Docx writer:
+ `lang` meta, see #1667 (Mauro Bieg, #3515).
+ Change `FigureWithCaption` to `CaptionedFigure` (iandol, #3658).
+ Use `Table` rather than `Table Normal` for table style (#3275).
`Table Normal` is 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 <span class="comment-start" id="0" author="Jesse Rosenthal"
date="2016-05-09T16:13:00Z">I left a comment.</span>some text to
have a comment <span class="comment-end" id="0"></span>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 `keywords` metadata to docx document properties (Ian).
* RST writer: support unknown interpreted text roles by
parsing them as `Span` with `role` attributes (#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
for `line-block` in the default templates, instead of hard-coding a
`style` on the div.
+ Add class `footnoteBack` to 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-src` instead of `src` for images for
lazy loading.
+ Special-case `.stretch` class for images in reveal.js (#1291).
Now in reveal.js, an image with class `stretch` in a paragraph
by itself will stretch to fill the whole screen, with no
caption or figure environment.
* 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 `findExecutable`
unless `.exe` is 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`,
and `raw_html` extensions.
* 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.el` tables (#3314).
+ Support macros (#3401).
+ Support the `#+INCLUDE:` file inclusion mechanism (#3510).
Recognized include types are `example`, `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 `\n` export option (#3940). This turns all newlines in the
text into hard linebreaks.
* RST reader:
+ Improved admonition support (#223). We no longer add an
`admonition` class, we just use the class for the type of admonition,
`note` for example. We put the word corresponding to the label in
a paragraph inside a `Div` at the beginning of the admonition with
class `admonition-title`. This is about as close as we can get to
RST's own output.
+ Initial support of `.. table` directive. This allows adding captions
to tables.
+ Support `.. line-block` directive. 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.com
Here both `hello` and `goodbye` should link to `example.com`.
+ Support anchors (#262). E.g.
`hello`
.. _hello:
paragraph
This is supported by putting "paragraph" in a `Div` with id `hello`.
+ 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 `smallcaps` as `SmallCaps`.
* 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 a
`dedication` field to metadata. It is up to the user to supply
a template that uses this variable.
+ Support all `\textXX` commands, where XX = `rm`, `tt`, `up`, `md`,
`sf`, `bf` (#3488). Spans with a class are used when there is
nothing better.
+ Expand `\newenvironment` macros (#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 `\textcolor` support (Marc Schreiber).
+ Add support for `tabularx` environment (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_tex` extension
is selected (#3692). Otherwise skip with a warning. This is better
than trying to parse it as text!
+ Add `\colorbox` support (Marc Schreiber).
+ Set identifiers on Spans used for `\label`.
+ Have `\setmainlanguage` set `lang` in metadata.
+ Support etoolbox's `\ifstrequal`.
+ Support `plainbreak`, `fancybreak` et 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. `\let` macros,
by contrast, are expanded at the point of definition. Added an
`ExpansionPoint` field to `Macro` to track this difference.
+ Support simple `\def` macros. 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`, `\eqref` commands into `Span` with
attributes, so they can be handled in filters (Marc Schreiber, #3639)
+ Add Support for `glossaries` and `acronym` package (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 `Link` instead of `Span` for `\ref`. This makes more sense
semantically and avoids unnecessary `Span [Link]` nestings when
references are resolved.
+ Rudimentary support for `\hyperlink`.
+ Support `\textquoteleft|right`, `\textquotedblleft|right` (#3849).
+ Support `\lq`, `\rq`.
+ Implement `\newtoggle`, `\iftoggle`, `\toggletrue|false` from etoolbox
(#3853).
+ Support `\RN` and `\Rn`, from biblatex (bucklereed, #3854).
+ Improved support for `\hyperlink`, `\hypertarget` (#2549).
+ Support `\k` ogonek accent.
+ Improve handling of accents. Handle ogonek, and fall back correctly
with forms like `\"{}`.
+ Better support for ogonek accents.
+ Support for `\faCheck` and `\faClose` (Marc Schreiber, #3727).
+ Support for `xspace` (Marc Schreiber, #3797).
+ Support `\setmainlanguage` or `\setdefaultlanguage` (polyglossia)
and `\figurename`.
+ Better handling of `\part` in 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 `\part` will
always produce a header; no command-line options are needed.
+ Add block version of `\textcolor` (Marc Schreiber).
+ `\textcolor` works as inline and block command (Marc Schreiber).
+ `\textcolor` will 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 `\include` wouldn'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).
* 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 `\mathop` to allow multi-character operator names.
+ Add thin space after math operators when "faking it with
unicode."
* `walk` is now used instead of `bottomUp` in the `ToJSONFilter`
instance for `a -> [a]` (pandoc-types). Note that behavior
will be slightly different, since `bottomUp`'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 `skylighting` library:
+ Support for `powershell` has been added, and many syntax
definitions have been updated.
+ Background colors have been added to the `kate` style.
+ 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.)
[API changes]
* New module `Text.Pandoc.Class` (Jesse Rosenthal, John MacFarlane).
This contains definitions of the `PandocMonad` typeclass, the
`PandocIO` and `PandocPure` monads, and associated functions.
* Changed types of all writers and readers.
+ We now use `Text` instead of `String` in the interface (#3731).
(We have not yet changed the internals of most readers to work
with `Text`, but making this change in the API now opens up a
path to doing that.)
+ The result is now of form `m a` with constraint `PandocMonad m`.
Readers and writers can be combined to form monadic values which
can be run using either `runIO` or `runPure`. If `runIO` is used,
then both readers and writers will be able to do IO when needed
(for include files, for example); if `runPure` is used,
then the functions are pure and will not touch IO.
+ Where previously you used
`writeRST def (readMarkdown def "[foo](url)")`, now you
would use
`runPure $ readMarkdown def (pack "[foo](url)") >>= writeRST def`.
* New module `Text.Pandoc.Readers` (Albert Krewinkel). This
contains reader helper functions formerly defined in the
top-level `Text.Pandoc` module.
+ Changed `StringReader` -> `TextReader`.
+ `getReader` now returns a pair of a reader and
`Extensions`, instead of building the extensions into the
reader (#3659). The calling code must explicitly set
`readerExtensions` using the `Extensions` returned. The
point of the change is to make it possible for the calling
code to determine what extensions are being used.
* New module `Text.Pandoc.Writers` (Albert Krewinkel).
This contains writer helper functions formerly defined in the
top-level `Text.Pandoc` module.
+ Changed `StringWriter` -> `TextWriter`.
+ `getWriter` now retuns a pair of a reader and
`Extensions`, instead of building the extensions into the
reader (#3659). The calling code must explicitly set
`readerExtensions` using the `Extensions` returned. The
point of the change is to make it possible for the calling
code to determine what extensions are being used.
* New module `Text.Pandoc.Lua`, exporting `runLuaFilter` (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 of `Text.Pandoc.App` to recover. `pandoc.hs` is 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 the `Verbosity` definition previously in
`Text.Pandoc.Options`, as well as a new `LogMessage` datatype 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`, with `getLang`, `Lang(..)`, `parseBCP47`.
* New module `Text.Pandoc.Translations`, exporting `Term`,
`Translations`, `readTranslations`.
* New module `Text.Pandoc.Readers.LaTeX.Types', exporting `Macro`, `Tok`,
`TokType`, `Line`, `Column`.
* `Text.Pandoc.Error`: added many new constructors for `PandocError`.
* Expose some previously private modules (#3260). These are often
helpful to people writing their own reader or writer modules:
+ `Text.Pandoc.Writers.Shared`
+ `Text.Pandoc.Parsing`
+ `Text.Pandoc.Asciify`
+ `Text.Pandoc.Emoji`
+ `Text.Pandoc.ImageSize`
+ `Text.Pandoc.Highlighting`
`
* New module `Text.Pandoc.Extensions` (Albert Krewinkel):
Extension parsing and processing functions were defined in the top-level
`Text.Pandoc` module. These functions are moved to the Extensions
submodule as to enable reuse in other submodules.
* Add `Ext_raw_attribute` constructor for `Extension`.
* Add `Ext_fenced_divs` constructor for `Extension'.
* Add `Ext_four_space_rule` constructor in `Extension`.
* Add `Ext_gfm_auto_identifiers` constructor for `Extension`.
* Add `Monoid` instance for `Extensions`.
* Add `Text.Pandoc.Writers.Ms`, exporting `writeMs`.
* Add `Text.Pandoc.Writers.JATS`, exporting `writeJATS`.
* Add `Text.Pandoc.Writers.Muse`, exporting `writeMuse`.
* Add `Text.Pandoc.Readers.Muse`, exporting `readMuse`.
* Add `Text.Pandoc.Readers.TikiWiki`, exporting `readTikiWiki`.
* Add `Text.Pandoc.Readers.Vimwiki`, exporting `readVimwiki`.
* Add `Text.Pandoc.Readers.Creole`, exporting `readCreole`.
* Export `setVerbosity` from `Text.Pandoc`.
* `Text.Pandoc.Pretty`: Add `Eq` instance for `Doc`.
* `Text.Pandoc.XML`: `toEntities`: changed type to `Text -> Text`.
* `Text.Pandoc.UTF8`:
+ Export `fromText`, `fromTextLazy`, `toText`, `toTextLazy`.
Define `toString`, `toStringLazy` in terms of them.
+ Add new functions parameterized on `Newline`: `writeFileWith`,
`putStrWith`, `putStrLnWith`, `hPutStrWith`, `hPutStrLnWith`.
* `Text.Pandoc.MediaBag`: removed `extractMediaBag`.
* `Text.Pandoc.Highlighting`:
+ `highlighting` now 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 `SyntaxMap` to `highlight`.
* `Text.Pandoc.Writers.Math`:
+ Export `defaultMathJaxURL`, `defaultKaTeXURL`. This will ensure that
we only need to update these in one place.
* `Text.Pandoc.SelfContained`:
+ Removed `WriterOptions` parameter from `makeSelfContained`.
+ Put `makeSelfContained` in 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`.
* `Text.Pandoc.ImageSize`:
+ Export `lengthToDim`, new function `scaleDimension`.
+ Export `inEm` from ImageSize (#3450).
+ Change `showFl` and `show` instance for `Dimension` so
extra decimal places are omitted.
+ Added `Em` as a constructor of `Dimension`.
+ Add `WriterOptions` parameter to `imageSize` signature (Mauro Bieg).
* `Text.Pandoc.Templates`:
+ Change type of `renderTemplate'`. Now it runs in `PandocMonad`
and raises a proper `PandocTemplateError` if there are problems, rather
than failing with uncatchable `error`.
+ Change signature of `getDefaultTemplate`. Now it runs in any instance
of `PandocMonad`, and returns a `String` rather than an `Either` value.
And it no longer takes a `datadir` parameter, since this can be
retrieved from `CommonState`.
* `Text.Pandoc.Options`:
+ Added `writerEpubSubdirectory` to `WriterOptions` (#3720).
The EPUB writer now takes its EPUB subdirectory from this option.
+ In `WriterOptions`, rename `writerLaTeXEngine` to `writerPdfEngine`
and `writerLaTeXArgs` to `writerPdfArgs` (Mauro Bieg, #3909).
+ Add `writerSyntaxMap` to `WriterOptions`.
+ Removed `writerEpubStylesheet` from `WriterOptions`.
+ Remove `writerUserDataDir` from `WriterOptions`. It is now carried
in `CommonState` in `PandocMonad` instances. (And thus it can be used
by readers too.)
+ Changed `writerEpubMetadata` to a `Maybe String`.
+ Removed `readerApplyMacros` from `ReaderOptions`. Now we just check
the `latex_macros` reader extension.
+ FromJSON/ToJSON instances for `ReaderOptions`.
+ In `HTMLMathMethod`, the `KaTeX` contsructor now takes only
one string (for the KaTeX base URL), rather than two.
+ Removed `writerSourceURL` from `WriterOptions`. We now use
`stSourceURL` in `CommonState`, which is set by `setInputFiles`.
* `Text.Pandoc.Shared`:
+ `tabFilter` now takes a `Text`, not `String`.
+ `openURL`: Changed type from an Either. Now it will just raise
an exception to be trapped later.
+ Remove `normalizeSpaces` (#1530).
+ Remove `warn`. (Use `report` from `Text.Pandoc.Class` instead.)
+ Export a new function `crFilter`.
+ Add `eastAsianLineBreakFilter` (previously in Markdown reader).
+ Provide custom `isURI` that rejects unknown schemes.
(Albert Krewinkel, #2713). We also export the set of known
`schemes`. The new function replaces the function of the same name
from `Network.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 schemes
`doi`, `isbn`, `javascript`, and `pmid` are kept.
+ Remove `err`.
+ Remove `readDataFile`, `readDefaultDataFile`, `getReferenceDocx`,
`getReferenceODT`. These now live in `Text.Pandoc.Class`,
where they are defined in terms of `PandocMonad`
primitives and have different signatures.
+ Remove `openURL`. Use `openURL` from `Text.Pandoc.Class` instead.
+ Add `underlineSpan`.
* `Text.Pandoc.Readers.HTML`: export new `NamedTag` class.
* `Text.Pandoc.Readers.Markdown`: remove `readDocxWithWarnings`.
With the new API one can simply use `getLog` after running
the reader.
* `Text.Pandoc.Readers.LaTeX`: Changed types for `rawLaTeXInline`
and `rawLaTeXBlock`. (Both now return a `String`, and they are
polymorphic in state.)
[bug fixes and under-the-hood improvements]
* TEI writer: Added identifiers on `<div>` elements.
* DokuWiki reader: Better handling for code block in list item (#3824).
* Custom writer: Remove old preprocesesor conditionals (Albert Krewinkel).
* ZimWiki writer: Removed internal formatting from note and table cells,
because ZimWiki does not support it (Alex Ivkin, #3446).
* MediaWiki writer:
+ Updated list of syntax highlighting languages (#3461).
Now `r` gets you `<source>` rather than `<code>` (among others).
+ Add display attribute on `<math>` tags (#3452). This allows display
math to be rendered properly.
+ Remove newline before `</ref>` (#2652).
+ Don't softbreak lines inside list items (#3531).
* Org writer:
+ Reduce to two spaces after bullets (#3417, Albert Krewinkel).
+ Add unit tests (Alexander Krotov).
+ Stop using raw HTML to wrap divs (Albert Krewinkel, #3771).
+ Do not strip `#` from Org anchor links (Alexander Krotov).
* CommonMark writer:
+ Avoid excess blank lines at end of output.
+ Prefer pipe tables to HTML tables even if it means losing relative
column width information (#3734).
+ Support table, strikethrough extensions, when enabled (as with gfm).
Note that we bypass the commonmark writer from cmark and construct our
own pipe tables, with better results.
+ Properly support `--wrap=none`.
+ Use smallcaps class for `SmallCaps` (#1592).
+ Omit "fig:" prefix in image titles. This is used internally to
indicate internal figures.
* RST writer:
+ Properly handle table captions.
+ Don't wrap lines in in definition list terms. Wrapping is not allowed.
+ Implemented `+/-smart` and improved escaping with `+smart`.
+ Add empty comments when needed to avoid including a blockquote
in the indented content of a preceding block (#3675).
+ Improve grid table output, fix bug with empty rows (#3516).
Uses the new `gridTable` in Writers.Shared, which is here
improved to better handle 0-width cells.
+ Remove space at beginning/end of RST code span (#3496). Otherwise
we get invalid RST. There seems to be no way to escape the space.
+ Add header anchors when header has non-standard id (#3937).
+ Correctly handle inline code containing backticks, using a `:literal:`
role (#3974).
+ Don't backslash-escape word-internal punctuation (#3978).
* Markdown writer:
+ Don't include variables in metadata blocks. Previously variables set
on the command line were included in e.g. YAML metadata, contrary to
documentation and intentions.
+ Improved escaping with `+smart`.
+ Fixed grid tables embedded in grid tables (#2834).
+ Use span with class 'smallcaps' for SmallCaps, instead of a style
attribute as before (#1592).
+ Escape initial `%` in a paragraph if the `pandoc_title_blocks`
extension is enabled (#3454). Otherwise in a document starting with
a literal `%` the first line is wrongly interpreted as a title.
+ Fixed false ordered lists in YAML metadata (#3492, #1685). Now we
properly escape things that would otherwise start ordered lists,
such as
- --
title: 1. inline
...
+ Better handling of tables with empty columns (#3337). We now
calculate the number of columns based on the longest row (or the
length of aligns or widths).
+ Escape unordered list markers at beginning of paragraph (#3497), to
avoid false interpretation as a list.
+ Escape `|` appropriately.
+ Ensure space before list at top level (#3487).
+ Avoid spurious blanklines at end of document after tables and list,
for example.
+ Fixed bugs in simple/multiline list output (#3384).
Previously we got overlong lists with `--wrap=none`. This is fixed.
Previously a multiline list could become a simple list (and would
always become one with `--wrap=none`).
+ Don't emit a simple table if `simple_tables` disabled (#3529).
+ Case-insensitive reference links (David A Roberts, #3616).
Ensure that we do not generate reference links whose labels differ only
by case. Also allow implicit reference links when the link
text and label are identical up to case.
+ Put space before reference link definitions (Mauro Bieg, #3630).
+ Better escaping for links (David A. Roberts, #3619). Previously the
Markdown writer would sometimes create links where there were none
in the source. This is now avoided by selectively escaping bracket
characters when they occur in a place where a link might be created.
+ Added missing `\n` (David A. Roberts, #3647).
+ Fixed duplicated reference links with `--reference-links`
and `--reference-location=section` (#3674). Also ensure that there
are no empty link references `[]`.
+ Avoid inline surround-marking with empty content (#3715).
E.g. we don't want `<strong></strong>` to become `****`.
Similarly for emphasis, super/subscript, strikeout.
+ Don't allow soft break in header (#3736).
+ Make sure `plain`, `markdown_github`, etc. work for raw.
Previously only `markdown` worked. Note: currently a raw block labeled
`markdown_github` will be printed for any `markdown` format.
+ Ensure that `+` and `-` are escaped properly so they don't cause
spurious lists (#3773). Previously they were only
if succeeded by a space, not if they were at end of line.
+ Use pipe tables if `raw_html` disabled and `pipe_tables` enabled,
even if the table has relative width information (#3734).
+ Markdown writer: don't crash on `Str ""`.
+ Make `Span` with null attribute transparent. That is, we don't use
brackets or `<span>` tags to mark spans when there are no attributes;
we simply output the contents.
+ Escape pipe characters when `pipe_tables` enabled (#3887).
+ Better escaping of `<` and `>`. If `all_symbols_escapable` is set,
we backslash escape these. Otherwise we use entities as before.
+ When writing plain, don't use ` ` to separate list and indented
code. There's no need for it in this context, since this isn't to be
interpreted using Markdown rules.
+ Preserve classes in JS obfuscated links (Timm Albers, #2989).
HTML links containing classes originally now preserve them when using
JavaScript email obfuscation.
+ Render `SmallCaps` as a native span when `native_spans` are enabled.
+ Always write attributes with `bracketed_spans` (d-dorazio).
* Man writer:
+ Fix handling of nested font commands (#3568). Previously pandoc emitted
incorrect markup for bold + italic, for example, or bold + code.
+ Avoid error for definition lists with no definitions (#3832).
* DocBook writer:
+ Fix internal links with `writerIdentifierPrefix opt`
(#3397, Mauro Bieg).
* Docx writer:
+ Don't include bookmarks on headers unless non-null id (#3476).
+ Support 9 levels of headers (#1642).
+ Allow 9 list levels (#3519).
+ Don't take `distArchive` from datadir (#3322). The docx writer takes
components from the distribution's version of `reference.docx` when it
can't find them in a user's custom `reference.docx`. Previously, we
allowed a `reference.docx` in the data directory (e.g. `~/.pandoc`)
to be used as the distribution's reference.docx. This led to a
bizarre situation where pandoc would produce a good docx using
`--template ~/.pandoc/ref.docx`, but if `ref.docx` were moved to
`~/.pandoc/reference.docx`, it would then produce a corrupted docx.
+ Fixed handling of soft hyphen (0173) (#3691).
+ Better handling of keywords (#3719).
+ Cleaner code for handling dir and style attributes for `Div`.
+ Use `Set` for dynamic styles to avoid duplicates.
+ Removed redundant element from data/docx/word/numbering.xml.
The elements we need are generated when the document is
compiled; this didn't do anything.
+ Activate `evenAndOddHeaders` from reference docx (#3901,
Augustín Martín Barbero).
* ODT/OpenDocument writer:
+ Calculate aspect ratio for percentage-sized images (Mauro Bieg, #3239).
+ Use more widely available bullet characters (#1400). The old
characters weren't available in some font sets. These seem to work
well on Windows and Linux versions of LibreOffice.
+ Wider labels for lists (#2421). This avoids overly narrow labels for
ordered lists with `()` delimiters. However, arguably it creates
overly wide labels for bullets. Also, lists now start flush with
the margin, rather than indented.
+ Fixed dropped elements in some ordered lists (#2434).
* FB2 writer:
+ Don't render `RawBlock` as code.
+ Don't fail with an error on interior headers (e.g. in list) (#3750).
Instead, omit them with an INFO message.
+ Add support for "lang" metadata (Alexander Krotov, #3625).
+ Format `LineBlock` as poem (Alexander Krotov). Previously writer
produced one paragraph with `<empty-line/>` elements, which are not
allowed inside `<p>` according to FB2 schema.
+ Replace `concatMap` with `cMap` (Alexander Krotov).
+ Write FB2 lists without nesting blocks inside `<p>` (Alexander
Krotov, #4004)
* HTML writer:
+ Make sure `html4`, `html5` formats work for raw blocks/inlines.
+ Render raw inline environments when `--mathjax` used (#3816).
We previously did this only with raw blocks, on the assumption
that math environments would always be raw blocks. This has changed
since we now parse them as inline environments.
+ Ensure we don't get two style attributes for width and height.
+ Report when not rendering raw inline/block.
+ Issue warning if no title specified and template used (#3473).
+ Info message if `lang` is unspecified (#3486).
+ Removed unused parameter in `dimensionsToAttributeList`.
+ Avoid two class attributes when adding `uri` class (#3716).
+ Fix internal links with `writerIdentifierPrefix opt` (#3397, Mauro
Bieg).
+ Use revealjs's math plugin for mathjax (#3743). This is a thin
wrapper around mathjax that makes math look better on revealjs.
+ Slidy: use h1 for all slides, even if they were originally
level 2 headers (#3566). Otherwise the built-in table of contents
in Slidy breaks.
* LaTeX writer:
+ Don't render LaTeX images with data: URIs (#3636). Note that
`--extract-media` can be used when the input contains data: URIs.
+ Make highlighted code blocks work in footnotes (Timm Albers).
+ Don't use figure inside table cell (#3836).
+ Use proper code for list enumerators (#3891). This should fix problems
with lists that don't use arabic numerals.
+ Always add hypertarget when there's a non-empty identifier (#2719).
Previously the hypertargets were only added when there was actually
a link to that identifier.
+ Use `%` after hypertarget before code block.
+ Add `\leavevmode` before hypertarget at start of paragraph (#2704,
fixes formatting problems in beamer citations).
+ Don't use `lstinline` in \item[..] (#645). If you do, the contents
of item disappear or are misplaced. Use `\texttt` instead.
+ Fix problem with escaping in `lstinline` (#1629). Previously the
LaTeX writer created invalid LaTeX when `--listings` was specified and
a code span occured inside emphasis or another construction.
+ Fix error with line breaks after empty content (#2874). LaTeX
requires something before a line break, so we insert a `~` if no
printable content has yet been emitted.
+ Use BCP47 parser.
+ Fixed detection of otherlangs (#3770). We weren't recursing into
inline contexts.
+ Handle language in inline code with `--listings` (#3422).
+ Write euro symbol directly in LaTeX (Andrew Dunning, #3801).
The textcomp package allows pdfLaTeX to parse `?` directly, making the
`\euro` command unneeded.
+ Fixed footnotes in table captions (#2378). Note that if the table has
a first page header and a continuation page header, the notes will
appear only on the first occurrence of the header.
+ In `writeBeamer` output, allow hyperlinks to frames (#3220).
Previously you could link to a header above or below slide level but
not *to* slide level. This commit changes that. Hypertargets are
inserted inside frame titles; technically the reference is to just
after the title, but in normal use (where slides are viewed full
screen in a slide show), this does not matter.
+ Remove `\strut` at beginning of table cells (#3436). This fixes a
problem with alignment of lists in table cells. The `\strut` at the
end seems to be enough to avoid the too-close spacing that motivated
addition of the strut in #1573.
+ Add partial siunitx Support (Marc Schreiber, #3588).
* ConTeXt writer:
+ Refactored to use BCP47 module.
+ Remove unnecessary `$` (Alexander Krotov, #3482).
+ Use header identifiers for chapters (#3968).
* EPUB writer:
+ `title_page.xhtml` is now put in `text/`.
+ Don't strip formatting in TOC (#1611).
* Textile reader:
+ Fix bug for certain links in table cells (#3667).
+ Allow 'pre' code in list item (#3916).
* HTML reader:
+ Added warnings for ignored material (#3392).
+ Better sanity checks to avoid parsing unintended things as
raw HTML in the Markdown reader (#3257).
+ Revise treatment of `li` with `id` attribute (#3596). Previously we
always added an empty div before the list item, but this created
problems with spacing in tight lists. Now we do this: If the list
item contents begin with a `Plain` block, we modify the `Plain`
block by adding a `Span` around its contents. Otherwise, we add a
`Div` around the contents of the list item (instead of adding an
empty `Div` to the beginning, as before).
+ Add `details` tag to list of block tags (#3694).
+ Removed `button` from block tag list (#3717). It is already in the
`eitherBlockOrInlineTag` list, and should be both places.
+ Use `Set`s instead of lists for block tag lookup.
+ Rewrote to use `Text` throughout. Effect on memory usage is modest
(< 10%).
+ Use the lang value of `<html>` to set the lang meta value (bucklereed,
[#3765]).
+ Ensure that paragraphs are closed properly when the parent block
element closes, even without `</p>` (#3794).
+ Parse `<figure>` and `<figcaption>` (Mauro Bieg, #3813).
+ Parse `<main>` like `<div role=main>` (bucklereed, #3791).
`<main>` closes `<p>` and behaves like a block element generally
+ Support column alignments (#1881). These can be set either
with a `width` attribute or with `text-width` in a `style` attribute.
+ Modified state type to be an instance of `HasLogMessages`, so
`registerHeader` can issue warnings.
+ `</td>` or `</th>` should close any open block tag (#3991).
+ `<td>` should close an open `<th>` or `<td>`.
+ `htmlTag` improvements (#3989). We previously failed on cases
where an attribute contained a `>` character. This patch fixes the
bug, which especially affects raw HTML in Markdown.
* Txt2Tags reader:
+ Newline is not indentation (Alexander Krotov).
* MediaWiki reader:
+ Allow extra hyphens after `|-` in tables (#2649).
+ Allow blank line after table start (#2649).
+ Fixed more table issues (#2649).
+ Ensure that list starts begin at left margin (#2606). Including when
they're in tables or other list items.
+ Make smart double quotes depend on `smart` extension (#3585).
+ Don't do curly quotes inside `<tt>` contexts (#3585). Even if `+smart`.
+ Modified state type to be an instance of `HasLogMessages`, so
`registerHeader` can issue warnings.
* TWiki reader (Alexander Krotov):
+ Remove unnecessary `$` (#3597).
+ Simplify `linkText` (#3605).
* EPUB reader:
+ Minor refactoring, avoiding explicit MediaBag handling.
This all works behind the scenes in CommonState plumbing.
* Docx reader:
+ Don't drop smartTag contents (#2242).
+ Handle local namespace declarations (#3365). Previously we didn't
recognize math, for example, when the xmlns declaration occured on
the element and not the root.
+ More efficient trimSps (#1530). Replacing `trimLineBreaks`. This
does the work of `normalizeSpaces` as well, so we avoid the need for
that function here.
+ Avoid 0-level headers (Jesse Rosenthal, #3830). We used to parse
paragraphs styled with "HeadingN" as "nth-level header." But if a
document has a custom style named "Heading0", this will produce a
0-level header, which shouldn't exist. We only parse this style
if N>0. Otherwise we treat it as a normal style name, and
follow its dependencies, if any.
+ Add tests for avoiding zero-level header (Jesse Rosenthal).
* ODT reader:
+ Replaced `collectRights` with Rights from `Data.Either`.
+ Remove dead code (Albert Krewinkel).
* Org reader (Albert Krewinkel, unless noted).
+ Don't allow tables inside list items (John MacFarlane, #3499).
+ Disallow tables on list marker lines (#3499).
+ Convert markup at beginning of footnotes (John MacFarlane, #3576).
+ Allow emphasized text to be followed by `[` (#3577).
+ Handle line numbering switch for src blocks.
The line-numbering switch that can be given to source blocks (`-n` with
an start number as an optional parameter) is parsed and translated to a
class/key-value combination used by highlighting and other readers and
writers.
+ Stop adding rundoc prefix to src params. Source block parameter names
are no longer prefixed with `rundoc`. This was intended to simplify
working with the rundoc project, a babel runner. However, the rundoc
project is unmaintained, and adding those markers is not the reader's
job anyway. The original language that is specified for a source
element is now retained as the `data-org-language` attribute and only
added if it differs from the translated language.
+ Allow multi-word arguments to src block params (#3477). The reader now
correctly parses src block parameter list even if parameter arguments
contain multiple words.
+ Avoid creating `nullMeta` by applying `setMeta` directly
(Alexander Krotov).
+ Replace `sequence . map` with `mapM`.
+ Fix smart parsing behavior. Parsing of smart quotes and special
characters can either be enabled via the `smart` language extension or
the `'` and `-` export options. Smart parsing is active if either the
extension or export option is enabled. Only smart parsing of special
characters (like ellipses and en and em dashes) is enabled by default,
while smart quotes are disabled. Previously, all smart parsing was
disabled unless the language extension was enabled.
+ Subject full doc tree to headline transformations (Albert Krewinkel,
[#3695]). Emacs parses org documents into a tree structure, which is
then post-processed during exporting. The reader is changed to do the
same, turning the document into a single tree of headlines starting
at level0.
+ Fix cite parsing behaviour (Herwig Stuetz). Until now, `org-ref`
cite keys included special characters also at the end. This caused
problems when citations occur right before colons or at the end of
a sentence. With this change, all non alphanumeric characters at
the end of a cite key are ignored. This also adds `,` to the list
of special characters that are legal in cite keys to better mirror
the behaviour of org-export.
+ Fix module names in haddock comments. Copy-pasting had lead to
haddock module descriptions containing the wrong module names.
+ Recognize babel result blocks with attributes (#3706). Babel
result blocks can have block attributes like captions and names.
Result blocks with attributes were not recognized and were parsed
as normal blocks without attributes.
+ Include tags in headlines. The Emacs default is to include tags in the
headline when exporting. Instead of just empty spans, which contain the
tag name as attribute, tags are rendered as small caps and wrapped in
those spans. Non-breaking spaces serve as separators for multiple tags.
+ Respect export option for tags (#3713). Tags are appended to
headlines by default, but will be omitted when the `tags` export option
is set to nil.
+ Use `tag-name` attribute instead of `data-tag-name`.
+ Use `org-language` attribute rather than `data-org-language`.
+ Modified state type to be an instance of `HasLogMessages`, so
`registerHeader` can issue warnings.
+ End footnotes after two blank lines. Footnotes can not only be
terminated by the start of a new footnote or a header, but also by two
consecutive blank lines.
+ Update emphasis border chars (#3933). The org reader was updated to
match current org-mode behavior: the set of characters which are
acceptable to occur as the first or last character in an org emphasis
have been changed and now allows all non-whitespace chars at the
inner border of emphasized text (see `org-emphasis-regexp-components`).
* RST reader:
+ Fixed small bug in list parsing (#3432). Previously the parser didn't
handle properly this case:
* - a
- b
* - c
- d
+ Handle multiline cells in simple tables (#1166).
+ Parse list table directive (Keiichiro Shikano, #3432).
+ Make use of `anyLineNewline` (Alexander Krotov, #3686).
+ Use `anyLineNewline` in `rawListItem` (Alexander Krotov, #3702).
+ Reorganize block parsers for ~20% faster parsing.
+ Fixed `..include::` directive (#3880).
+ Handle blank lines correctly in line blocks (Alexander Krotov, #3881).
Previously pandoc would sometimes combine two line blocks separated
by blanks, and ignore trailing blank lines within the line block.
+ Fix indirect hyperlink targets (#512).
* Markdown reader:
+ Allow attributes in reference links to start on next line (#3674).
+ Parse YAML metadata in a context that sees footnotes defined in
the body of the document (#1279).
+ When splitting pipe table cells, skip tex math (#3481).
You might have a `|` character inside math. (Or for that matter
something that the parser might mistake for raw HTML.)
+ Treat span with class `smallcaps` as SmallCaps.
This allows users to specify small caps in Markdown this way:
`[my text]{.smallcaps}` (#1592).
+ Fixed internal header links (#2397).
This patch also adds `shortcut_reference_links` to the list
of mmd extensions.
+ Treat certain environments as inline
when they occur without space surrounding them (#3309, #2171).
E.g. equation, math. This avoids incorrect vertical space
around equations.
+ Optimized `nonindentSpaces`. Makes the benchmark go from 40 to 36 ms.
+ Allow latex macro definitions indented 1-3 spaces.
Previously they only worked if nonindented.
+ Improved parsing of indented raw HTML blocks (#1841).
Previously we inadvertently interpreted indented HTML as
code blocks. This was a regression. We now seek to determine the
indentation level of the contents of an HTML block, and (optionally)
skip that much indentation. As a side effect, indentation may be
stripped off of raw HTML blocks, if `markdown_in_html_blocks` is
used. This is better than having things interpreted as indented
code blocks.
+ Fixed smart quotes after emphasis (#2228). E.g. in `*foo*'s 'foo'`.
+ Warn for notes defined but not used (#1718).
+ Use `anyLineNewline` (Alexander Krotov).
+ Interpret YAML metadata as Inlines when possible (#3755). If
the metadata field is all on one line, we try to interpret it as
Inlines, and only try parsing as Blocks if that fails. If it
extends over one line (including possibly the `|` or `>` character
signaling an indented block), then we parse as Blocks. This was
motivated by some German users finding that `date: '22. Juin 2017'`
got parsed as an ordered list.
+ Fixed spurious parsing as citation as reference def (#3840).
We now disallow reference keys starting with `@` if the
`citations` extension is enabled.
+ Parse `-@roe` as suppress-author citation (pandoc-citeproc#237).
Previously only `[-@roe]` (with brackets) was recognized as
suppress-author, and `-@roe` was treated the same as `@roe`.
+ Fixed parsing of fenced code after list when there is no intervening
blank line (#3733).
+ Allow raw latex commands starting with `\start` (#3558). Previously
these weren't allowed because they were interpreted as starting
ConTeXt environments, even without a corresponding `\stop`...
+ Added `inlines`, `inlines1`.
+ Require nonempty alt text for `implicit_figures` (#2844).
A figure with an empty caption doesn't make sense.
+ Removed texmath macro material; now all this is handled
in the LaTeX reader functions.
+ Fixed bug with indented code following raw LaTeX (#3947).
* LaTeX reader:
+ Rewrote LaTeX reader with proper tokenization (#1390,
[#2118], #3236, #3779, #934, #982). This rewrite is primarily
motivated by the need to get macros working properly. A side benefit
is that the reader is significantly faster. We now tokenize the
input text, then parse the token stream. Macros modify the token
stream, so they should now be effective in any context, including
math. Thus, we no longer need the clunky macro processing
capacities of texmath.
+ Parse `\,` to `\8198` (six-per-em space) (Henri Werth).
+ Allow `\newcommand\foo{blah}` without braces.
+ Support `\lstinputlisting` (#2116).
+ Issue warnings when skipping unknown latex commands (#3392).
+ Include contents of `\parbox`.
+ Allow `\hspace` and `\vspace` to count as raw block or inline.
Previously we would refuse to parse anything as raw inline if
it was in the `blockCommands` list. Now we allow exceptions
if they're listed under ignoreInlines in inlineCommands.
This should make it easier e.g. to include an `\hspace`
between two side-by-side raw LaTeX tables.
+ Don't drop contents of `\hypertarget`.
+ Handle spaces before `\cite` arguments.
+ Allow newpage, clearpage, pagebreak in inline contexts as well as
block contexts (#3494).
+ Treat `{{xxx}}` the same as `{xxx}` (#2115).
+ Use `pMacroDefinition` in macro (for more direct parsing).
Note that this means that `macro` will now parse one
macro at a time, rather than parsing a whole group together.
+ Fixed failures on \ref{}, \label{} with `+raw_tex`. Now these
commands are parsed as raw if `+raw_tex`; otherwise, their argument
is parsed as a bracketed string.
+ Don't crash on empty `enumerate` environment (#3707).
+ Handle escaped `&` inside table cell (#3708).
+ Handle block structure inside table cells (#3709). `minipage` is no
longer required.
+ Handle some width specifiers on table columns (#3709). Currently
we only handle the form `0.9\linewidth`. Anything else would have
to be converted to a percentage, using some kind arbitrary assumptions
about line widths.
+ Make sure `\write18` is parsed as raw LaTeX. The change is in the
LaTeX reader's treatment of raw commands, but it also affects the
Markdown reader.
+ Fixed regression with starred environment names (#3803).
+ Handle optional args in raw `\titleformat` (#3804).
+ Improved heuristic for raw block/inline. An unknown command at the
beginning of the line that could be either block or inline is
treated as block if we have a sequence of block commands followed by
a newline or a `\startXXX` command (which might start a raw ConTeXt
environment).
+ Don't remove macro definitions from the output, even if
`Ext_latex_macros` is set, so that macros will be applied.
Since they're only applied to math in Markdown, removing the macros
can have bad effects. Even for math macros, keeping them should be
harmless.
+ Removed `macro`. It is no longer necessary, since the
`rawLaTeXBlock` parser will parse macro definitions. This also avoids
the need for a separate `latexMacro` parser in the Markdown reader.
+ Use `label` instead of `data-label` for label in caption (#3639).
+ Fixed space after \figurename etc.
+ Resolve references to section numbers.
+ Fix `\let\a=0` case, with single character token.
+ Allow `@` as a letter in control sequences. `@` is commonly used
in macros using `\makeatletter`. Ideally we'd make the tokenizer
sensitive to `\makeatletter` and `\makeatother`, but until then this
seems a good change.
+ Track header numbers and correlate with labels.
+ Allow `]` inside group in option brackets (#3857).
+ lstinline with braces can be used (verb cannot be used with braces)
(Marc Schreiber, #3535).
+ Fix keyval funtion: pandoc did not parse options in braces correctly
(Marc Schreiber, #3642).
+ When parsing raw LaTeX commands, include trailing space (#1773).
Otherwise things like `\noindent foo` break and turn into
`\noindentfoo`. Affects `-f latex+raw_tex` and `-f markdown` (and other
formats that allow `raw_tex`).
+ Don't treat "..." as Quoted (#3958). This caused quotes to be omitted in
`\texttt` contexts.
+ Add tests for existing `\includegraphics` behaviour (Ben Firshman).
+ Allow space before `=` in bracketd options (Ben Firshman).
+ Be more forgiving in parsing command options. This was needed, for
example, to make some minted options work.
+ Strip off quotes in `\include` filenames.
* Added `Text.Pandoc.CSV`, simple (unexported) CSV parser.
* `Text.Pandoc.PDF`:
+ Got `--resource-path` working with PDF output (#852).
+ Fetch images when generating PDF via context (#3380).
To do this, we create the temp directory as a subdirectory
of the working directory. Since context mk IV by default looks
for images in the parent directory, this works.
+ Use `report` instead of `warn`, make it sensitive to verbosity settings.
+ Use `fillMediaBag` and `extractMedia` to extract media to temp dir.
This reduces code duplication.
+ `html2pdf`: use stdin instead of intermediate HTML file
+ Removed useless `TEXINPUTS` stuff for `context2pdf`. mkiv context
doesn't use `TEXINPUTS`.
* `Text.Pandoc.Pretty`:
+ Simplified definition of `realLength`.
+ Don't error for blocks of size < 1. Instead, resize to 1 (see #1785).
* `Text.Pandoc.MIME`:
+ Use `application/javascript` (not `application/x-javascript`).
+ Added `emf` to mimeTypes with type `application/x-msmetafile` (#1713).
* `Text.Pandoc.ImageSize`:
+ Improve SVG image size code (Marc Schreiber, #3580).
+ Make `imageSize` recognize basic SVG dimensions (Mauro Bieg, #3462).
* Use `Control.Monad.State.Strict` throughout. This gives 20-30% speedup
and reduction of memory usage in most of the writers.
* Use `foldrWithKey` instead of deprecated `foldWithKey`.
* `Text.Pandoc.SelfContained`:
+ Fixed problem with embedded fonts (#3629).
+ Refactored getData from `getDataURI` in `SelfContained`.
+ Don't use data URIs for script or style (#3423). Instead, just use
script or style tags with the content inside. The old method with
data URIs prevents certain optimizations outside pandoc. Exception:
data URIs are still used when a script contains `</script>` or a
style contains `</`.
+ SelfContained: Handle URL inside material retrieved from a URL
(#3629). This can happen e.g. with an @import of a google web font.
(What is imported is some CSS which contains an url reference
to the font itself.) Also, allow unescaped pipe (|) in URL.
+ Load resources from `data-src` (needed for lazy loading in
reveal.js slide shows).
+ Handle `data-background-image` attribute on section (#3979).
* `Text.Pandoc.Parsing`:
+ Added `indentWith` (Alexander Krotov, #3687).
+ Added `stateCitations` to `ParserState`.
+ Removed `stateChapters` from `ParserState`.
+ In `ParserState`, make `stateNotes'` a Map, add `stateNoteRefs`.
+ Added `gobbleSpaces` and `gobbleAtMostSpaces`.
+ Adjusted type of `insertIncludedFile` so it can be used with token
parser.
+ Replace old texmath macro stuff from Parsing. Use Macro from
Text.Pandoc.Readers.LaTeX.Types instead.
+ Export `insertIncludedFile`.
+ Added `HasLogMessages`, `logMessage`, `reportLogMessages` (#3447).
+ Replace partial with total function (Albert Krewinkel).
+ Introduce `HasIncludeFiles` type class (Albert Krewinkel). The
`insertIncludeFile` function is generalized to work with all parser
states which are instances of that class.
+ Add `insertIncludedFilesF` which returns F blocks (Albert Krewinkel).
The `insertIncludeFiles` function was generalized and renamed
to `insertIncludedFiles'`; the specialized versions are based on that.
+ `many1Till`: Check for the end condition before parsing (Herwig
Stuetz). By not checking for the end condition before the first
parse, the parser was applied too often, consuming too much of the
input. This only affects `many1Till p end` where `p` matches on a
prefix of `end`.
+ Provide `parseFromString` (#3690). This is a verison of
`parseFromString` specialied to ParserState, which resets
`stateLastStrPos` at the end. This is almost always what we want.
This fixes a bug where `_hi_` wasn't treated as emphasis in the
following, because pandoc got confused about the position of the
last word: `- [o] _hi_`.
+ Added `takeP`, `takeWhileP` for efficient parsing of `[Char]`.
+ Fix `blanklines` documentation (Alexander Krotov, #3843).
+ Give less misleading line information with `parseWithString`.
Previously positions would be reported past the end of the chunk.
We now reset the source position within the chunk and report
positions "in chunk."
+ Add `anyLineNewline` (Alexander Krotov).
+ Provide shared F monad functions for Markdown and Org readers
(Albert Krewinkel). The `F` monads used for delayed evaluation
of certain values in the Markdown and Org readers are based on a
shared data type capturing the common pattern of both `F` types.
+ Add `returnF` (Alexander Krotov).
+ Avoid parsing `Notes:**` as a bare URI (#3570). This avoids parsing
bare URIs that start with a scheme + colon + `*`, `_`, or `]`.
+ Added `readerAbbreviations` to `ParserState`. Markdown reader
now consults this to determine what is an abbreviation.
+ Combine grid table parsers (Albert Krewinkel, #3638). The grid table
parsers for markdown and rst was combined into one single
parser `gridTable`, slightly changing parsing behavior of both
parsers: (1) The markdown parser now compactifies block content
cell-wise: pure text blocks in cells are now treated as paragraphs
only if the cell contains multiple paragraphs, and as plain blocks
otherwise. Before, this was true only for single-column tables. (2)
The rst parser now accepts newlines and multiple blocks in header
cells.
+ Generalize tableWith, gridTableWith (Albert Krewinkel).
The parsing functions `tableWith` and `gridTableWith` are generalized
to work with more parsers. The parser state only has to be an
instance of the `HasOptions` class instead of requiring a concrete
type. Block parsers are required to return blocks wrapped into a
monad, as this makes it possible to use parsers returning results
wrapped in `Future`s.
* `Text.Pandoc.Shared`:
+ Simplify `toRomanNumeral` using guards (Alexander Krotov, #3445)
+ `stringify`: handle Quoted better (#3958). Previously we were losing
the quotation marks in Quoted elements.
* `Text.Pandoc.Writers.Shared`:
+ Export `metaToJSON'`, `addVariablesToJSON` (#3439).
This allows us to add the variables AFTER using the metadata
to generate a YAML header (in the Markdown writer).
+ Added `unsmartify` (previously in RST writer).
Undo literal double curly quotes. Previously we left these.
+ Generalize type of `metaToJSON` so it can take a Text. Previously a
String was needed as argument; now any ToJSON instance will do.
+ Added `gridTable` (previously in Markdown writer).
+ `gridTable`: Refactored to use widths in chars.
+ `gridTable`: remove unnecessary extra space in cells.
+ Fixed `addVariablesToJSON`. It was previously not allowing multiple
values to become lists.
+ Pipe tables: impose minimum cell size (see #3526).
[default template changes]
* HTML templates (including EPUB and HTML slide show templates):
+ Make default.html5 polyglot markup conformant (John Luke Bentley,
[#3473]). Polyglot markup is HTML5 that is also valid XHTML. See
<https://www.w3.org/TR/html-polyglot>. With this change, pandoc's
html5 writer creates HTML that is both valid HTML5 and valid XHTML.
+ Regularized CSS in html/epub/html slide templates (#3485).
All templates now include `code{white-space: pre-wrap}`
and CSS for `q` if `--html-q-tags` is used. Previously some templates
had `pre` and others `pre-wrap`; the `q` styles were only sometimes
included.
+ CSS for `.smallcaps`, (Mauro Bieg, #1592)
+ `default.revealjs`: make `history` default to true.
+ `default.revealjs`: use lazy loading (#2283).
+ `default.revealjs`: add `mathjax` variable and some conditional code
to use the MathJaX plugin.
+ `default.slidy` uses `https` instead of `http` (ickc, #3848).
+ `default.dzslides`: Load Google Font using HTTPS by default
(Yoan Blanc).
* DocBook5 template: Use `lang` and `subtitle` variables (Jens Getreu,
[#3855]).
* LaTeX/Beamer template:
+ Combine LaTeX/Beamer templates (Andrew Dunning, #3878).
`default.beamer` has been removed; beamer now uses the
`default.latex` template. Beamer-specific parts are conditional
on the `beamer` variable set by the writer. Note that
`pandoc -D beamer` will return this (combined) template.
+ Use `xcolor` for `colorlinks` option (Andrew Dunning, #3877).
Beamer loads `xcolor` rather than `color`, and thus the
`dvipsnames` option doesn't take effect. This also provides a wider
range of colour selections with the `svgnames` option.
+ Use starred versions of `xcolor` names (Andrew Dunning).
Prevents changes to documents defined using the `dvipsnames` list (e.g.
`Blue` gives a different result with svgnames enabled).
+ Load `polyglossia` after header-includes (#3898). It needs to be
loaded as late as possible.
+ Use `unicode-math` (Vaclav Haisman). Use `mathspec` with only
XeLaTeX on request.
+ Don't load `fontspec` before `unicode-math` (over there).
The `unicode-math` package loads `fontspec` so explict loading of
`fontspec` before `unicode-math` is not necessary.
+ Use `unicode-math` by default in default.latex template. mathspec will
be used in xelatex if the `mathspec` variable is set; otherwise
unicode-math will be used (Václav Haisman).
+ Use `dvipsnames` options when `colorlinks` specified (otherwise
we get an error for `maroon`) (Thomas Hodgson).
+ Added beamer `titlegraphic` and `logo` variables (Thomas Hodgson).
+ Fix typo in fix for notes in tables (#2378, zeeMonkeez).
+ Fix `hyperref` options clash (Andrew Dunning, #3847) Avoids an options
clash when loading a package (e.g. `tufte-latex`) that uses
`hyperref` settings different from those in the template.
+ Add `natbiboptions` variable (#3768).
+ Fix links inside captions in LaTeX output with links-as-notes
(Václav Haisman, #3651). Declare our redefined `\href` robust.
+ Load `parskip` before `hyperref` (Václav Haisman, #3654).
+ Allow setting Japanese fonts when using LuaLaTeX (Václav Haisman,
[#3873]). by using the `luatexja-fontspec` and `luatexja-preset`
packages. Use existing `CJKmainfont` and `CJKoptions` template
variables. Add `luatexjafontspecoptions` for `luatexja-fontspec`
and `luatexjapresetoptions` for `luatexja-preset`.
+ Added `aspectratio` variable to beamer template (Václav Haisman,
[#3723]).
+ Modified template.latex to fix XeLaTex being used with tables
(lwolfsonkin, #3661). Reordered `lang` variable handling to
immediately before `bidi`.
* ConTeXt template: Improved font handling: `simplefonts` is now
obsolete in ConTeXt (Pablo Rodríguez).
[documentation improvements]
* MANUAL.txt:
+ Add URL for Prince HTML > PDF engine (Ian, #3919).
+ Document that content above slide-level will be omitted in
slide shows. See #3460, #2265.
+ Explain `--webtex` SVG url (Mauro Bieg, #3471)
+ Small clarification in YAML metadata section.
+ Document that html4 is technically XHTML 1.0 transitional.
+ Remove refs to highlighting-kate (#3672).
+ Document ibooks specific epub metadata.
+ Clarify that mathml is used for ODT math.
+ Mention limitations of Literate Haskell Support (#3410,
Joachim Breitner).
+ Add documentation of limitations of grid tables (Stephen
McDowell, #3864).
+ Clarify that meta-json contains transformed values (Jakob Voß,
[#3491]) Make clear that template variable `meta-json` does not
contain plain text values or JSON output format but field values
transformed to the selected output format.
* COPYRIGHT:
+ Clarify that templates are dual-licensed.
+ Clarify that pandoc-types is BSD3 licensed.
+ List new files not written by jgm (Albert Krewinkel).
+ Update dates in copyright notices (Albert Krewinkel). This follows
the suggestions given by the FSF for GPL licensed software.
<https://www.gnu.org/prep/maintain/html_node/Copyright-Notices.html>
* INSTALL.md:
+ Improved instructions for tests with patterns.
+ Put RPM-based distros on separate point (Mauro Bieg, #3449)
* CONTRIBUTING.md:
+ Fixed typos (Wandmalfarbe, #3479).
+ Add "ask on pandoc-discuss" (Mauro Bieg).
* Add lua filter documentation in `doc/lua-filters.md`. Note that the
end of this document is autogenerated from `data/pandoc.lua`
using `make doc/lua-filters.md`, which uses `tools/ldoc.ltp`
(Albert Krewinkel).
* Add `doc/filters.md`. This is the old scripting tutorial from
the website.
* Add `doc/using-the-pandoc-api.md` (#3289). This gives an introduction
to using pandoc as a Haskell library.
[build infrastructure improvements]
* Removed `data/templates` submodule. Templates are now a subtree
in `data/templates`. This removes the need to do `git submodule
update`.
* Renamed `tests` -> `test`.
* Remove `https` flag. Always build with HTTPS support.
* Use `file-embed` instead of `hsb2hs` to embed data files when
`embed_data_files` flag is set. `file-embed` gives us better dependency
tracking: if a data file changes, ghc/stack/cabal know to recompile
the Data module. This also removes `hsb2hs` as a build dependency.
* Add `custom-setup` stanza to pandoc, lowercase field names.
* Add `static` Cabal 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 `deb` directory has been replaced with a `linux`
directory. Running `make` in the `linux` directory should
perform the build, putting the binary packages in `artifacts/`.
* `linux/control.in`: add `Replaces:`, 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.yaml` with `stack.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 haddock` from `make full`.
+ Add BRANCH variable for winpkg.
+ Add `lint` target.
+ Improve `make full`. Disable optimizations.
Build everything, inc. trypandoc and benchmarks. Use parallel build.
+ Allow `make test` to take `TESTARGS`.
* Added new command tests (`Tests.Command`), using small text files
in `test/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 `compareOutput` in 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 `listings` languages (#3374).
This allows more languages to be used when using the `--listings`
option.
* 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`,
where `FORMAT` must be one of `latex`, `beamer`, `html`, or `texinfo`.
+ 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).
* 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).
* 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 `\VerbatimNotes`
and `fancyvrb`. 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 `microtypeoptions` to microtype
(Václav Haisman).
+ default.latex: Add hyphen option to url package.
+ default.docbook5: Fix namespace declarations (Mauro Bieg).
* Moved `make_osx_package.sh` to `osx/` 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=auto` does not work in HTML output.
+ Default `--columns` width 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.
- Updated with latest spec-cleaner version 0.9.8-8-geadfbbf.
- Update to version 1.19.2.1 revision 5.
- Fix requires
- Update to version 1.19.2.1 revision 4.
- Update to version 1.19.2.1 revision 3 with cabal2obs.
- Update to version 1.19.2.1 revision 2 with cabal2obs.
- Update to version 1.19.2.1 revision 1 with cabal2obs.
- Update to version 1.19.2.1 with cabal2obs.
- Drop obsolete suggestion of "texlive-latex-bin-bin". This package is now a dependency of the pandoc-pdf sub-package.
- add constraints to fix build on aarch64
- Update to version 1.17.1 revision 1 with cabal2obs.
- update to 1.17.1
* New output format: `docbook5`
* `Text.Pandoc.Options`: Add `writerDocBook5` to `WriterOptions`
* Org writer:
+ Add :PROPERTIES: drawer support
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. 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 `drawer` class defines
that the `Div` constructor 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_ID` in properties. The `ID` property is
reserved for internal use by Org-mode and should not be used.
The `CUSTOM_ID` property is to be used instead, it is converted to the
`ID` property for certain export format.
* LaTeX writer:
+ Ignore `--incremental` unless output format is beamer.
+ Fix polyglossia to babel env mapping.
Allow for optional argument in square brackets.
+ Recognize `la-x-classic` as Classical Latin.
This allows one to access the hyphenation patterns in CTAN's
hyph-utf8.
+ Add missing languages from hyph-utf8.
+ Improve use of `\strut` with `\minipage` inside tables
. This improves spacing in multiline
tables.
+ Use `{}` around options containing special chars.
+ Avoid lazy `foldl`.
+ Don't escape underscore in labels. Previously they were
escaped as `ux5f`.
+ brazilian -> brazil for polyglossia.
* HTML writer: Ensure mathjax link is added when math appears in footnote
. Previously if a document only had math in a footnote, the
MathJax link would not be added.
* EPUB writer: set `navpage` variable on nav page.
This allows templates to treat it differently.
* DocBook writer:
+ Use docbook5 if `writerDocbook5` is set.
+ Properly handle `ulink`/`link`.
* EPUB reader:
+ Unescape URIs in spine.
+ EPUB reader: normalise link id.
* Docx Reader:
+ Parse `moveTo` and `moveFrom`.
`moveTo` and `moveFrom` are 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 as `insert` and `delete`, respectively. So,
`--track-changes=accept` will show the moved version, while
`--track-changes=reject` will show the original version.
+ Tests for track-changes moving.
* ODT, EPUB, Docx readers: throw `PandocError` on unzip failure
Previously, `readDocx`, `readEPUB`, and `readOdt`
would error out if zip-archive failed. We change the archive extraction
step from `toArchive` to `toArchiveOrFail`, 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.
+ Added `-s` to markdown-reader-more test.
* HTML reader: fixed bug in `pClose`. This caused exponential parsing
behavior in documnets with unclosed tags in `dl`, `dd`, `dt`.
* MediaWiki reader: Allow spaces before `!` in MediaWiki table header
* RST reader: Support `:class:` option for code block in RST reader
* Org reader:
+ 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.
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 droping space after unescaped LaTeX-style symbol
commands: `\ForAll \Auml` resulted 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 `#+OPTIONS` lines.
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_HTML` attributes.
Arbitrary key-value pairs can be added to some block types using a
`#+ATTR_HTML` line 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.
Headers can have optional `:PROPERTIES:` drawers associated with them.
These drawers contain key/value pairs like the header's `id`. The
reader adds all listed pairs to the header's attributes; `id` and
`class` attributes are handled specially to match the way `Attr` are
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_ID` in properties. See above on Org writer changes.
+ Respect drawer export setting. The `d` export 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.
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...END` block 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:citeKey` and
`[[cite:citeKey][prefix text::suffix text]]` syntax is added.
+ Split code into separate modules, making for cleaner code and
better decoupling.
* Added `docbook5` template.
* `--mathjax` improvements:
+ Use new CommonHTML output for MathJax (updated default MathJax URL)
+ Change default mathjax setup to use `TeX-AMS_CHTML` configuration.
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.
* Require texmath 0.8.6.2. Closes several texmath-related bugs
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`.
+ Improved documentation of `--columns` option.
* Added appveyor setup, with artefacts.
* stack.yaml versions: Use proper flags used for texmath, pandoc-citeproc.
* LaTeX template: support for custom font families.
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
- update to 1.17.0.3
* LaTeX writer: Fixed position of label in figures. Previously the label wasn't
in the right place, and `\ref` wouldn't work properly.
* Added .tei test files to pandoc.cabal so they'll be included in tarball.
- update to 1.17.0.2
* Fixed serious regression in `htmlInBalanced`, which caused
newlines to be omitted in some raw HTML blocks in Markdown
* File scope is no longer used when there are no input files (i.e.,
when input comes from stdin). Previously file scope was triggered
when the `json` reader was specified and input came from `stdin`,
and this caused no output to be produced.
* Improved documentation of templates
* Added `--file-scope` option (Jesse Rosenthal).
By default pandoc operates on multiple files by first concatenating
them (around extra line breaks) and then processing the joined file. So
it only parses a multi-file document at the document scope. This has the
benefit that footnotes and links can be in different files, but for
some purposes it is useful to parse the individual files first
and then combine their outputs (e.g. when the files use footnotes
or links with the same labels). The `--file-scope` option causes
pandoc to parse the files first, and then combine the parsed output,
instead of combining before parsing. `--file-scope` is selected
automatically for binary input files (which cannot be concatenated)
and for pandoc json.
* Add TEI Writer (Chris Forster) and `tei` output format.
* Added a general `ByteStringReader` with warnings, used by the docx
reader (API change, Jesse Rosenthal).
* Add `readDocxWithWarnings` (API change, Jesse Rosenthal).
* Changed type of `Shared.uniqueIdent`'s argument from `[String]`
to `Set String.` This avoids performance problems in documents with
many identically named headers (API change, #2671).
* Removed `tex_math_single_backslash` from `markdown_github` options
* Make language extensions as well as full language names
trigger syntax highlighting. For example, `py` will now work as
well as `python` (jgm/highlighting-kate#83).
* Added `institute` variable to latex, beamer templates (Fraser
Tweedale, Josef Svenningsson).
* 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 `Modifiable` typeclass.
+ 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/foo`
combines with `bar.html` to give `http://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.html` to give `http://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..
* 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 `htmlInBalanced` for `rawVerbatimBlock`, for better
performance (#2730).
+ Fixed bug with smart quotes around tex math.
* LaTeX reader:
+ Handle interior `$` characters in math (#2743). For example,
`$$\hbox{$i$}$$`.
+ `inlineCommand` now 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).
* Textile reader: Support `>`, `<`, `=`, `<>` text alignment attributes.
* 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).
* 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 `memoir` template with `article` option as article, instead
of treating all `memoir` templates 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 variables `LTleft` and `LTright`. For example,
`\setlength\LTleft\parindent\setlength\LTright\fill`
will 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 `tagsoup` lower bound to 0.13.7 to fix entity-related
problems (#2734).
* Allow `zip-archive` 0.3.
* Allow `aeson` 0.11.
- remove unused flag
- update to 1.16.0.2
- very long changelog again. For details please see changelog file or
https://hackage.haskell.org/package/pandoc-1.16.0.2/changelog
- create placeholder package for pdf support
- update to 1.15.2.1 - correct license to GPL-2.0+ - very long changelog again, for details please see changelog file or https://hackage.haskell.org/package/pandoc-1.15.2.1/changelog
- update to 1.15.1.1 * `Text.Pandoc.Data`: store paths in dataFiles using posix separators. + add Suggests: texlive-latex-bin-bin
- update to 1.15.1
* `pandocVersion` is now defined in `Text.Pandoc.Shared`
and reexported from `Text.Pandoc` (Alex Vong). This allows
writers to access it. (Alex Vong) (API change)
* For `markdown_mmd`, add: `implicit_figures`, `superscripts`,
`subscripts` (#2401).
* Added `odt` as input format (MarLinn). Added new module
`Text.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
`abstract` metadata 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-variant` with `pickStyleAttrProps` (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".
* MediaWiki reader: handle unquoted table attributes (#2355).
* DocBook reader:
+ Added proper support for DocBook `xref` elements (Frerich Raabe).
Added `dbContent` field to reader state, so we can lookup
cross refs.
+ Handle `informalexample` (#2319).
* Docx Reader:
+ Create special punctuation test (Ophir Lifshitz).
+ Parse soft, no-break hyphen elements (Ophir Lifshitz).
+ Updated headers test (Ophir Lifshitz). Replaced `styles.xml`
in `headers.docx` with pandoc's current `styles.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).
* 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 `superscripts` and `subscripts` extensions are
not enabled).
* Docx writer:
+ Moved invalid character stripping to `formattedString`.
This avoids an inefficient generic traversal (#2356).
+ Use user data directory for `reference.docx` archive.
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 `../data` for data directory.
This allows tests to be run without installing first.
+ Tests: Use real jpg (not empty) for docx tests to avoid warning.
* 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
`--chapters` was 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 `lang` field, which is now always
assumed to be in BCP47 format (mb21, #1614, #2437).
+ Add `\protect` to `\hyperdef` in 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 '<','>','|','"','{','}','[',']','^', '`'.
* 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 `section` as `<section>` in HTML5.
* EPUB writer:
+ In TOC, replace literal "<br/>" with space (#2105).
+ With `--webtex`, include image file rather than `data:` URI (#2363).
* Native writer: format Div properly, with blocks separated.
* Support bidirectional text output with XeLaTeX, ConTeXt and HTML
* Reference Docx:
+ Add missing Header 6 style (steel blue) (Ophir Lifshitz).
+ Correct `outlineLvl` for Header styles (Ophir Lifshitz).
* Templates
+ Beamer: Add `innertheme`, `outertheme` variables
(Guilhem Bonnefille, #121). Add space after colon in figure caption.
Integrate recent font and language updates from LaTeX template;
allow use of `mainfont` variable 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 the `realscripts` package
(via `xltxtra`). To restore use of OpenType characters for these
features under XeTeX or LuaTeX, add `\usepackage{realscripts}` to
`header-includes` (Andrew Dunning, #130). Remove redundant
reference to `xunicode` (Andrew Dunning, #130). Add `fontenc`,
`indent`, `subparagraph` variables (Andrew Dunning).
Allow use of `hidelinks` variable for `hyperref` package (Hugo Roy,
[#113]). Prevent package clash with `tufte-latex` and other classes that
include `hyperref` or `color` (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 use `babel-lang` and
`polyglossia-lang` and `context-lang`. These variables are set by
the writers to the necessary values, based on the `lang` variable
(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`, `progress` variables (Grégoire Pineau, #127).
Add `width`, `height` variables (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 `adjusting` and `hyphenate` variables
(Alex Vong, #123).
* epub.css: added selectors for nested emphasis (Pablo Rodriguez).
* MediaBag: ensure that `/` is always used as path separator.
* `sample.lua`: define `CaptionedImage`, add newline at end (#2393).
* Added `--bash-completion` option. 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_identifiers` for 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.ymal` and 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 `newManager` instead of `withManager` in recent `http-client`.
This avoids a deprecation warning.
* Allow building with latest versions of http-types,
HUnit, criterion, syb, aeson.
* 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.
- Update pandoc to version 2.17.1.1.
[#]# pandoc 2.17.1.1 (2022-01-31)
* Fix regression in 2.17.1 which caused problems finding
default files in the default user data directory. (Reverts
the item "logic bug in `fullDefaultsPath`", which was
misguided.)
* Sample custom writer: use single quotes for strings (#7487,
Albert Krewinkel).
[#]# pandoc 2.17.1 (2022-01-30)
* Support `pagedjs-cli` as pdf engine (#7838, Albert Krewinkel).
PagedJS is a polyfill and supports the Paged Media standards by the W3C.
<https://www.pagedjs.org/>
* CommonMark reader: fix source position after YAML metadata (#7863).
* LaTeX reader:
+ Remove retokenizing in `rawLaTeXParser`.
+ Ensure that `\raggedright` doesn't gobble an argument (#7757).
+ Improve `descItem`. For some reason we were skipping
arbitrary blocks before `\item`. This is now changed to "skip
whitespace and comments."
+ Improve handling of `\newif`. Adding a pair of braces around the
second argument of `\def` prevents LaTeX from an emergency stop
on input like the following (#6096).
```
\newif\ifepub
\epubtrue
\ifepub
hi
\fi
```
* Docx reader: Parse both Zotero citation and bibliography as
`FieldInfo` (#7840).
* LaTeX writer:
+ Allow arbitrary frameoptions to be passed to a beamer
frame, using the frameoptions attribute (#7869).
+ Add s and squeeze to recognized beamer frameoptions (#7869).
* Markdown writer: handle explicit column widths with pipe tables (#7847).
If a table has explicit column width information *and* the content
extends beyond the `--columns` width, we need to adjust the
widths of the pipe separators to encode this width information.
* Docx writer: Separate tables even with RawBlocks between (#7224,
Michael Hoffmann). Adjacent docx tables need to be separated by an
empty paragraph. If there's a RawBlock between tables which renders
to nothing, be sure to still insert the empty paragraph so that
they will not collapse together.
* Man writer: use custom font V for inline code (#7506).
The V font is defined conditionally, so that it renders
like CB in output formats that support that, and like B
in those that don't (e.g. the terminal).
Aliases also defined for VI, VB, VBI.
* Asciidoc writer: Support checklists in asciidoctor writer (#7832,
Nikolai Korobeinikov, ricnorr). The checklist syntax (similar to
`task_list` in markdown) seems to be an asciidoctor-only addition.
* HTML writer:
+ Avoid duplicate "style" attributes on table cells (#7871).
+ Don't break lines inside code elements. With the new (default)
line wrapping of HTML, in conjunction with the default CSS which
includes `code { whitespace: pre-wrap; }`, spurious line
breaks could be introduced into inline code (#7858).
* Custom writer: preserve order of element attributes (#7489, Albert
Krewinkel). Attribute key-value pairs are marshaled as AttributeList,
i.e., as a userdata type that behaves both like a list and a map. This
allows to preserve the order of key-value pairs.
* Switch to hslua-2.1 (Albert Krewinkel). This allows for some code
simplification and improves stability.
* Don't read files outside of user data directory (Even Brenden).
If a file path does not exist relative to the working directory, and
it does exist relative to the user data directory, but outside of
of the user data directory, do not read it. This applies to
`readDataFile` and `readMetadataFile` in PandocMonad and, by
extension, any module that uses these by passing them relative paths.
* Text.Pandoc.Class.`makeCanonical`: Correctly handle consecutive ".."s
at the beginning of a path (Even Brenden). Prior to this commit,
`../../file` would evaluate to `file`, when it should be unchanged.
* Search for metadata files in `$DATADIR/metadata` (#7851, Even Brenden).
If files specified with `--metadata-file` are not found in the working
directory, look in `$DATADIR/metadata` (#5876).
* Text.Pandoc.Class: export `readMetadataFile` [API change] (#5876).
* Text.Pandoc.Error: export new `PandocCouldNotFindMetadataFileError`
constructor for `PandocError` [API change] (#5876).
* Avoid putting a frame around speaker notes in beamer (#7857).
If speaker notes (a Div with class 'notes') occur right
after a section heading, but above slide level, the
resulting `\note{..}` caommand should not be wrapped in
a frame, as that will cause a spurious blank slide.
* CSS in HTML template: adjust #TOC and h1 on mobile (#7835, Mauro Bieg).
* Text.Pandoc.Readers.LaTeX.Parsing: don't export `totoks`.
Make the first param of `tokenize` a SourcePos instead of
SourceName, and use it instead of `totoks`.
* Text.Pandoc.Shared: Modify `stringify` so it ignores `[Citation]`
inside `Cite` (#7855). Otherwise we'll sometimes get two copies of
things, one from the `citationPrefix` or `citationSuffix` and another
from the embedded fallback text. When there is no fallback text,
we'll get no content. However, it really isn't an alternative to just
rely on the result of running `query` on the embedded `Citation`s;
this will result in a jumble of text rather than anything structured.
* Omit `--enable-doc` in the cabal haddock invocation in
`tools/build-and-upload-api-docs.sh`.
* Text.Pandoc.App.Opt: fix logic bug in `fullDefaultsPath`.
Previously we would (also) search the default user data directory
for a defaults file, even if a different user data directory
was specified using `--data-dir`. This was a mistake; if
`--data-dir` is used, the default user data directory should
not be searched.
* Text.Pandoc.Shared: `defaultUserDataDir` behavior change (#7842).
If the XDG data directory is not defined (e.g. because
it's not supported in the OS or HOME isn't defined), we
return the empty string instead of raising an exception.
* Update command tests to distinguish stderr and test exit status.
* MANUAL: add that speaker notes can be used with beamer (#7856).
* Update `build-and-upload-api-docs.sh`.
* Document `--trace` option.
Document `no-check-certificate` in defaults files.
Document 'sandbox' option for defaults files. (#7873).
* Fix pattern syntax in sample readability custom reader.
* doc/custom-readers.lua: add example for "readable HTML."
* Fix message in man page about where code can be found.
* `manfilter.lua`: remove extra indent in table cells with code blocks.
* Fix lua-filters documentation for table column widths (#7864).
* epub.doc: Update links to KindleGen (#7846, Benson Muite, Mauro Bieg).
KindleGen has been deprecated and we need to link to archived versions.
* Use tables in defaults files documentation, so each
default option is paired with the corresponding command-line
option (Carsten Allefeld).
* Use skylighting 0.12.2.
* Add pandoc-lua-marshal to Nix shell (#7849, Even Brenden).
[#]# pandoc 2.17.0.1 (2022-01-14)
* Require pandoc-lua-marshal 0.1.3.1 (#7831, Albert Krewinkel).
Fixes a problem with `List.includes` and `List.find` that caused a
Lua stackoverflow and subsequent program crash.
* HTML template: load header-includes before math (#7833, Kolen Cheung).
MathJax expect the config comes before loading the MathJax script.
This change of order allows one to config MathJax via
header-includes, which loads before the MathJax script. Cf. #2750.
* When reading defaults file, stop at a line `...`. This line signals
the end of a YAML document. This restores the behavior we got with
HsYaml. yaml complains about content past this line. See
https://github.com/jgm/pandoc/issues/4627#issuecomment-1012438765
* Text.Pandoc.Citeproc: allow `notes-after-punctuation` to work with
numerical styles that use superscripts (e.g.
american-medical-association.csl), as well as with note styles. The
default setting of `notes-after-punctuation` is true for note styles
and false otherwise. This restores a behavior of pandoc-citeproc
that wasn't properly carried over to Citeproc (#7826, cf.
jgm/pandoc-citeproc#384).
* Use commonmark-pandoc 0.2.1.2 (#7769).
* Add FAQ on images in ipynb containers (#7749, Kolen Cheung).
[#]# pandoc 2.17 (2022-01-12)
* Support `markua` as an output format (#1871, Tim Wisotzki and
Saumel Lemmenmeier). Markua is a markdown variant used by Leanpub.
* Add text wrapping for HTML output (#7764). Previously the HTML writer
was exceptional in not being sensitive to the `--wrap` option. With
this change `--wrap` now works for HTML. The default (as with other
formats) is automatic wrapping. Note that the contents of `script`,
`textarea`, and `pre` tags are always laid out with the `flush`
combinator, so that unwanted spaces won't be introduced if these occur
in an indented context in a template.
* Don't read sources until in/out format are verified (#7797).
* Issue error with `--list-extensions` for invalid formats (#7797).
* Make `--citeproc` recognize `.yml` as well as `.yaml` extensions
as YAML bibliography files (#7707, Jörn Krenzer).
* Use latest version of KaTeX with `--katex`.
* Fix parsing of footnotes in `--metadata-file` (#7813). Previously
non-inline footnotes were not being parsed.
* ODT reader:
+ Parse list-header as a list item (Tuong Nguyen Manh).
* Commonmark reader:
+ Put sourcepos attribute on header, not enclosing div
with `-f commonmark+sourcepos` (#7769).
* Markdown reader:
+ Don't allow `^` at beginning of link or image label (#7723).
This is reserved for footnotes. Fixes regression from 0a93acf.
+ Fix parsing of "bare locators" after author-in-text citations.
Previously `@item [p. 12; @item2]` was incorrectly parsed as
three citations rather than two. This is now fixed by ensuring
that `prefix` doesn't gobble any semicolons.
+ Revert changes to `inlinesInBalancedBrackets` (commit fa83246),
which caused regressions.
+ Improve detection of pipe table line widths (#7713). Fixed
calculation of maximum column widths in pipe tables. It is
now based on the length of the markdown line, rather than a
"stringified" version of the parsed line. This should be
more predictable for users. In addition, we take into account
double-wide characters such as emojis.
* Custom (Lua) readers:
+ First argument is now a list of sources instead of the
concatenated text (Albert Krewinkel). The list
structure can easily be converted to a string by applying
`tostring`, but it is also possible to access the elements
(each with a `text` and `name`). A small example is added
to the custom reader documentation, showcasing its use in a
reader that creates a syntax-highlighted code block for
each source code file passed as input. Existing readers
will still work through a fallback mechanism, issuing a
deprecation notice.
* Org reader:
+ Parse official org-cite citations (#7329). We also support the older
org-ref style as a fallback. We no longer support the
"markdown style" or "Berkeley style" citations.
+ Support alphabetical (fancy) lists (Lucas Viana). When the
`fancy_lists` extension is enabled, alphabetical list markers are
allowed, mimicking the behaviour of Org Mode when
`org-list-allow-alphabetical` is enabled.
+ Support counter cookies in lists (Lucas Viana). Such cookies are
used to override the item counter in ordered lists. In org it is
possible to set the counter at any list item, but since Pandoc AST
does not support this, we restrict the usage to setting an offset for
the entire ordered list, by using the cookie in the first list item.
+ Allow trailing spaces after key/value pairs in directives (Albert
Krewinkel). Ensures that spaces at the end of attribute directives like
`#+ATTR_HTML: :width 100%` (note the trailing spaces) are accepted.
* LaTeX reader:
+ Omit visible content for `\label{...}`. Previously we
included the text of the label in square brackets, but this is
undesirable in many cases. See discussion in
<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 `\cref` but not for `\ref`. To support `\cref`
we need to store the environment label separately.
+ Add babel mappings for Guajati (gu) and Oriya (or) (#7815).
+ Fix typo `panjabi` -> `punjabi` in babel mappings (#7814).
* HTML reader:
+ Parse attributes on links and images (#6970).
* Docx reader:
+ Handle multiple pic elements inside a drawing (#7786).
+ Change `elemToParPart` to return `[ParPart]` instead of `ParPart`.
Also remove `NullParPart `constructor, as it is no longer
needed. This will allow us to handle elements that contain
multiple ParParts, e.g. `w:drawing` elements with multiple `pic:pic`.
* DocBook reader:
+ Collapse internal spaces in literal and other similar tags (#7821),
as the standard docbook toolchain does.
+ Be sensitive to spacing="compact" in lists (#7799). When
`spacing="compact"` is set, Para elements are turned into Plain,
so we get a "tight" list.
* Markdown writer:
+ Add new exported function `writeMarkua` from Text.Pandoc.Writers.Markdown
[API change] (#1871, Tim Wisotzki and Saumel Lemmenmeier).
+ Fix indentation issue in footnotes (#7801).
+ Avoid extra space before citation suffix if it already starts
with a space.
+ Ensure semicolon between the locator and the next citation when an
author-in-text citation has a locator and following citations.
+ Improve escaping for `#` (#7726).
* Custom (Lua) writers:
+ Allow variables to be set via second return value of `Doc`
(#6731, Albert Krewinkel). New templates variables can be added by
giving variable-value pairs as a second return value of the
global function `Doc`. 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 as
`pandoc.utils.references`, or to inspect the document contents with
`walk()`.
* LaTeX writer:
+ Fix typo `panjabi` -> `punjabi` in babel mappings (#7814).
* MediaWiki writer:
+ Remove redundant display text for wiki links (Jesse Hathaway).
* Docx writer:
+ Handle bullets correctly in lists by not reusing numIds
(#7689, Michael Hoffmann). This fixes a bug in which a Div in
a list item would receive bullets on its contained paragraphs.
* Org writer:
+ Fix list items starting with a code block or other non-paragraph
content (#7810).
+ Avoid blank lines after tight sublists (#7810).
+ Fix extra blank line inserted after empty list item (#7810).
+ Don't add blank line before lists (#7810).
+ Support starting number cookies (Lucas Viana). This is necessary
for lists that start at a number other than 1.
+ Support the new org-cite syntax (#7329).
* Haddock writer:
+ Avoid blank lines after tight sublists (#7810).
* Ipynb writer:
+ Ensure deterministic order of keys.
+ Handle cell output with raw block of markdown (#7563, Kolen Cheung).
Write RawBlock of markdown in code-cell output. This is designed
to fit the behavior of #7561, which makes the ipynb reader parse
code-cell output with mime "text/markdown" to a RawBlock of markdown.
This commit makes the ipynb writer writes this RawBlock of markdown
back inside a code-cell output with the same mime, preserving this
information in round-trip.
+ In choosing between multiple output options, always favor
those marked with the output format over images (Kolen Cheung).
Previously, both `fmt == f` case and Image have a rank of 1.
* Ipynb reader & writer: properly handle cell "id" (#7728).
This is passed through if it exists (in Nb4); otherwise
the writer will add a random one so that all cells have an "id".
* Ms writer:
+ Properly encode strings for PDF contents (#7731).
* JATS writer:
+ Keep quotes in element-citations (Albert Krewinkel).
Fixed a bug that lead to quote characters being lost in
element-citations.
* RTF writer:
+ Properly handle images in data URIs (#7771).
* Commonmark writer:
+ Allow ')' delimiters on ordered lists.
* RST writer:
+ Avoid extra blank line after empty list item (#7810).
* HTML writer:
+ Make line breaks more consistent. With `--wrap=none`, we now
output line breaks between block-level elements. Previously they
were omitted entirely, so the whole document was on one line, unless
there were literal line breaks in pre sections. This makes
the HTML writer's behavior more consistent with that of
other writers. Also, regardless of wrap settings,
put newline after `<dd>` and after block-level elements in
the footnotes section. And add a line break between an `img` tag
and the associated `figcaption`.
+ reveal.js: Make sure images with `r-stretch` are not in p tags.
They must be direct children of the section. There was previously
code to make this work with the older class name `stretch`, but
the name has changed in reveal.js.
+ reveal.js: don't add `r-fit-text` class to section. It must go on
the header only.
* AsciiDoc writer:
+ Improve detection of intraword emphasis (#7803).
* OpenDocument writer:
+ Fix vertical alignment bug with display math (#7777). Previously some
displayed formulas would be floated above a preceding text line.
This is fixed by setting `vertical-rel` to `text` rather than
`paragraph-content`.
* JATS template (Albert Krewinkel):
+ Fix position of contrib affiliations in authoring set. Any
`<aff>` element must come before any `<email>` element.
+ Fix affiliation tagging in `articleauthoring` output.
Affiliations were `xlink`ed even in the articleauthoring tag set, but
`<aff>` are not allowed as children of `contrib-group` elements in that
tag set. Each affiliation must be listed directly in the contrib
element.
+ Add support for article subtitles.
* EPUB template:
+ Include abstract in default template.
+ Ensure that the essential styles needed by pandoc (`styles.html`
partial) are included in the templates. This is important for correct
formatting of CSL bibliographies. Note that much of the styling in
`styles.html` will be ignored for EPUB, because of the conditional on
`document-css`. Setting the `document-css` variable will cause it
not to be ignored.
* HTML template: Add abstract (#7588, Jannik Buhr, John MacFarlane).
By default, a localized title (the word "Abstract") will be
used, unless the variable `abstract-title` is set.
* ConTeXt template: Make title appear in PDF title bar. This is
recommended for accessibility reasons. Note: doesn't work with macOS
Preview.app.
* `reference.pptx`: change to use 16:9 aspect ratio, Powerpoint's default.
* Text.Pandoc.Writers:
+ Do not export `writeCustom` [API change]. This ensures that all
writers exported in T.P.Writers are parameterized and work with any
`PandocMonad` type. This is consistent with T.P.Readers, as
`readCustom` is not exported from that module either.
* Text.Pandoc.Writers.Shared:
+ `endsWithPlain` now returns True if the list ends with a list
that ends with a Plain, and so on recursively (#7810).
* Text.Pandoc.Class.IO:
+ `writeMedia`: unescape percent-encoding in creating file path.
This addresses a problem with spaces in image filenames
when creating PDFs (#7819); it also affects `--extract-media`.
* New internal module Text.Pandoc.Writers.Blaze, exporting `layoutMarkup`.
This converts a blaze Html structure into a doclayout Doc Text.
* Text.Pandoc.Extensions:
+ `parseFormatSpec`: cleaner error message for invalid extensions.
* Text.Pandoc.MediaBag:
+ Fix bug in `extractMedia`, which caused the test for `..`
in paths to fail, with the result that images with `..`
in the path name could be extracted outside of the
directory specified by `extractMedia`. It also led a check for
`media` in resource paths to fail in the docx reader.
* Text.Pandoc.Citeproc:
+ Avoid adding comma before an author-in-text citation in a note
if it begins with a title (no author) (#7761).
+ Text.Pandoc.Citeproc.Locator now exports `toLocatorMap`,
`LocatorInfo`, and `LocatorMap`. The type of `parseLocator`
has changed, so it now takes a `LocatorMap` rather than a `Locale`
as parameter, and returns a `LocatorInfo` instead of a tuple.
+ Fix citation locator detection for German. `toLocatorMap` now
stores keys case-folded. We want to do a case-insensitive
comparison when parsing locators, so that e.g. both
`Chap.` and `chap.` work. Previously we case-folded terms
when doing the lookup, but they weren't case-folded in the
map itself, which led to locator-detection breaking for
German (where the terms have uppercase letters).
* Lua (Albert Krewinkel):
+ Allow single elements as singleton MetaBlocks/MetaInlines. Single
elements should always be treated as singleton lists in the Lua
subsystem.
+ Add `pandoc.template` module. The module provides a `compile`
function to use strings as templates.
+ Add `pandoc.WriterOptions` constructor.
+ Add function `pandoc.write`.
+ Provide global `PANDOC_WRITER_OPTIONS` (#5221).
+ The function Text.Pandoc.Filter.applyFilters now takes a filter
environment of type `Environment`, instead of a ReaderOptions value
[API change].
+ The `Environment` type is exported from Text.Pandoc.Filter
and allows to combine ReaderOptions and WriterOptions in a single
value [API change].
+ Global, exported from Text.Pandoc.Lua, has a new type constructor
`PANDOC_WRITER_OPTIONS` [API change].
+ Add constructors `pandoc.Blocks` and `pandoc.Inlines`.
The functions convert their argument into a list of Block and Inline
values, respectively. When applied to a string, they split the
string into `Str` elements separated by `Space` or `SoftBreak`
(#7712).
+ Support topdown traversals The traversal order of filters can now
be selected by setting the key `traverse` of the filter to either
`'topdown'` or `'typewise'`; the default remains `'typewise'`.
Topdown traversals can be cut short by returning `false` as a
second value from the filter function. No child-element of the
returned element is processed in that case.
+ Marshal ReaderOptions field `extensions`, `track_changes` via JSON.
Extensions are now available as a list of strings; the track-changes
settings are given as the kebab-case representation used in JSON.
+ Allow binary (byte string) readers to be used with `pandoc.read`.
+ Use global state when parsing documents in `pandoc.read`.
The function `pandoc.read` is updated to use the same state that was
used while parsing the main input files. This ensures that log
messages are preserved and that images embedded in the input are
added to the mediabag.
+ Cleanup stack in `peekReadOptionsTable`. A ReaderOptions element was
left on top of the stack when the `peekReadOptionsTable` function
was invoked.
+ `walk` methods are added to `Pandoc`, `Block`, `Inline`,
`Blocks`, `Inlines` values; the methods are similar to
`pandoc.utils.walk_block` and `pandoc.utils.walk_inline`, but
apply to filter to the element's contents.
+ Functions of name `Doc` are no longer accepted as alternatives for
`Pandoc` filter functions. This functionality was undocumented.
+ Improve handling of empty caption, body by `from_simple_table`
[#7776]). Create truly empty table caption and body when these are
empty in the simple table.
+ Change representation of `TableHead`, `TableFoot`, and `Row` values
(#7718). The objects now also follow the principle that element
attributes are accessible through the `.attr` field. Rows in `TableHead`
and `TableFoot` are available via the `.rows` field. Row objects have a
`.cells` field, containing the list of table cells.
+ [Simplify](Simplify) code of `pandoc.utils.stringify`. Minor behavior change:
plain strings nested in tables are now included in the result string.
+ Simplify and deprecate function `pandoc.utils.equals`. The function
is no longer required for element comparisons; it is now an alias
for the `==` operator.
+ Add function `pandoc.utils.references` (#7752).
+ Add new library function `pandoc.utils.type`. The function behaves
like the default `type` function from Lua's standard library,
but is aware of pandoc userdata types. A typical use-case would be
to determine the type of a metadata value.
+ Fix return types of `blocks_to_inlines`, `make_sections`.
Ensures the returned lists have the correct type (`Inlines` and
`Blocks`, respectively).
+ Use more natural representation for Reference values
Omit `false` boolean values, push integers as numbers.
* Lua: use package pandoc-lua-marshal (#7719, Albert Krewinkel).
The marshaling functions for pandoc's AST are extracted into a separate
package. The package comes with a number of changes:
+ Pandoc's List module was rewritten in C, and error messages were
improved.
+ Lists of `Block` and `Inline` elements are marshaled using the new
list types `Blocks` and `Inlines`, respectively. These types
currently behave identical to the generic List type, but give better
error messages. This also opens up the possibility of adding
element-specific methods to these lists in the future.
+ Elements of type `MetaValue` are no longer pushed as values which
have `.t` and `.tag` properties. This was already true for
`MetaString` and `MetaBool` values, which are still marshaled as Lua
strings and booleans, respectively. Affected values:
- `MetaBlocks` values are marshaled as a `Blocks` list;
- `MetaInlines` values are marshaled as a `Inlines` list;
- `MetaList` values are marshaled as a generic pandoc `List`s.
- `MetaMap` values are marshaled as plain tables and no longer
given any metatable.
+ `Cell` values are now marshaled as userdata objects; a constructor
function for table cells is provided as `pandoc.Cell`.
+ The test suite for marshaled objects and their constructors has
been extended and improved.
+ A bug in `Citation` objects, where setting a citation's suffix
modified it's prefix, has been fixed.
+ Inlines, Blocks, and List objects now have an `__eq` metamethod,
testing equality by comparing two lists element-wise.
* Powerpoint tests: shorten lines by grouping tests (Albert
Krewinkel). This makes the test output more pleasant to read
in narrow terminal windows.
* make check: check for unreleased dependencies.
* Add `tools/build-and-upload-api-docs.sh`.
* Update cabal description.
* `MANUAL.txt`: Add section on EPUB styling.
* `MANUAL.txt`: clarify "standard Markdown" as "original Markdown"
(#7802, Martin Fischer).
* `doc/custom-writers.md`: use filter to include source of example.
* Add an example to `doc/custom-readers.md`.
* Fix typo in `custom-readers.md` (#7722, Mauro Bieg).
* `doc/jats.md`: add link to JATS documentation (Martin Fischer).
* `doc/lua-filters.md`: many improvements (Albert Krewinkel,
John MacFarlane).
* Use commonmark-extensions 0.2.3. This allows a bare-word class attribute
on fenced divs.
* Use ipynb 0.2.
* Use citeproc 0.6.0.1.
* Use texmath 0.12.4.
* Use doctemplates 0.10.0.1.
[#]# pandoc 2.16.2 (2021-11-21)
* Add interface for custom readers written in Lua (#7669).
Users can now do `-f myreader.lua` and pandoc will treat the
script `myreader.lua` as a custom reader, which parses an input
string to a pandoc AST, using the pandoc module defined for
Lua filters. A sample custom reader can be found in `data/creole.lua`.
Also see documentation in `doc/custom-readers.md`.
* New module Text.Pandoc.Readers.Custom, exporting `readCustom` [API change].
* Allow `plain` to be used in raw attribute syntax.
* Accept empty `--metadata-file` (#7675).
This was a regression from 2.15 behavior.
* Markdown reader: Improve `inlinesInBalancedBrackets`.
This is just a small improvement in terms of performance, but it's simpler
and more direct code. Also, we avoid parsing interparagraph spaces in
balanced brackets, as the original did.
* BibTeX reader: Properly handle commented lines in BibTeX/BibLaTeX (#7668).
* RST reader: handle class attribute for for custom roles (#7699,
willj-dev). Previously the class attribute was ignored, and the name
of the role used as the class.
* DocBook reader:
+ Add `<titleabbr>` support (Rowan Rodrik van der Molen).
+ Support for `<indexterm>` (#7607, Rowan Rodrik van der Molen).
* LaTeX reader:
+ Add rudimentary support for `\autoref` (#7693).
+ Add 'uri' class when parsing `\url`, for consistency
with treatment of autolinks in other formats (#7672).
* JATS reader: Capture `alt-text` in figures (#7703, Aner Lucero).
* MediaWiki writer: use HTML spans for anchors when header has id (#7697).
We need to generate a span when the header's ID doesn't match
the one MediaWiki would generate automatically. Note that MediaWiki's
generation scheme is different from pandoc's (it uses uppercase letters,
and `_` instead of `-`, for example). This means that in going from
markdown to mediawiki, we'll now get spans before almost every heading,
unless explicit identifiers are used that correspond to the ones MediaWiki
auto-generates. This is uglier output but it's necessary for internal
links to work properly.
* Markdown writer: don't create autolinks when this loses information
(#7692). Previously we sometimes lost attributes when rendering links
as autolinks.
* Text.Pandoc.Readers.Metadata: allow multiple YAML documents when parsing
YAML for `yamlBsToRefs`. Some people use `---` as the end delimiter in
YAML bibliography files, which causes the `yaml` library to emit an
error unless we explicitly allow multiple YAML documents (and just
consider the first).
* 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.
* HTML writer: Don't create invalid `data-` attribute for empty
attribute key (#7546).
* LaTeX writer:
+ Babel mappings: use `ancientgreek` for `grc`.
+ With `-t latex-smart`, don't generate `\ldots` from ellipsis (#7674).
Instead just use unicode ellipsis.
* JATS template: fix `equal-contrib` attribute (Albert Krewinkel).
The standard requires the value to be either `yes` or `no`, but is was
set to `true` for authors who contributed equally.
* reveal.js template: Add `disableLayout` variable (Christophe Dervieux).
* Text.Pandoc.Error: sort errors in `handleError` by exit code
(Albert Krewinkel).
* Text.Pandoc.Writers.Shared: Improve toLegacyTable (#7683,
Christian Despres).
* Lua subsystem:
+ Include lpeg module (#7649, Albert Krewinkel). Compiles the `lpeg`
library (Parsing Expression Grammars For Lua) into
the program. Package maintainers may choose to rely on package
dependencies to make lpeg available, in which case they can compile
the with the constraint `lpeg +rely-on-shared-lpeg-library`.
`lpeg` and `re` are always made available in global variables,
without the need for a `require`.
+ Set `lpeg` and `re` as globals; allow shared lib access via `require`.
The `lpeg` and `re` modules are loaded into globals of the respective
name, but they are not necessarily registered as loaded packages. This
ensures that
- the built-in library versions are preferred when setting the globals,
- a shared library is used if pandoc has been compiled without `lpeg`,
and
- the `require` mechanism can be used to load the shared library if
available, falling back to the internal version if possible and
necessary.
+ Fix argument order in constructor `pandoc.Cite` (Albert Krewinkel).
This restores the old behavior; argument order had been switched
accidentally in pandoc 2.15.
+ Add Pushable instance for `ReaderOptions` (Albert Krewinkel).
+ Allow to pass custom reader options to `pandoc.read` as an
optional third argument (#7656, Albert Krewinkel).
The object can either be a table or a ReaderOptions value
like `PANDOC_READER_OPTIONS`. Creating new ReaderOptions objects is
possible through the new constructor `pandoc.ReaderOptions`.
+ Display Pandoc values using their native Haskell representation
(Albert Krewinkel).
+ Require latest hslua (2.0.1) (#7661, #7657, Albert Krewinkel).
This fixes issues with
- misleading error messages when a required function parameter is
omitted;
- absent properties still being listed in the output of `pairs`; and
- alias accessing leading to errors instead of returning `nil`, e.g.
with `(pandoc.Str '').identifier`.
+ Add missing space in "package not found" message (#7658, Albert
Krewinkel).
* Update build files (#7696, Fabián Heredia Montiel).
Drop old windows 32-bit constraints.
Update cabal `tested-with` field to correspond to `ci.yml` matrix
* Remove unneeded package dependencies from benchmark target.
* Require ghc >= 8.6, base >= 4.12.
This allows us to get rid of the old custom prelude and
some crufty cpp. But the primary reason for this is that
conduit has bumped its base lower bound to 4.12, making it
impossible for us to support lower base versions.
* Require Cabal 2.4. Use wildcards to ensure that all pptx tests are
included (#7677).
* Update `bash_completion.tpl` (S.P.H.).
* Add `data/creole.lua` as sample custom reader.
* Add `doc/custom-readers.md` and `doc/custom-writers.md`.
* `doc/lua-filters.md`: add section on global modules, including lpeg
(Albert Krewinkel).
* `MANUAL.txt`: update table of exit codes and corresponding errors
(Albert Krewinkel).
* Use latest texmath.
- Update pandoc to version 2.16.1.
[#]# pandoc 2.16.1 (2021-11-02)
* Docx reader: don't let first line indents trigger block quotes (#7655).
This fixes a regression introduced in pandoc 2.15.
* Docx writer: use `getTimestamp` for modification times in
reference.docx (#7654). This ensures that when `SOURCE_DATE_EPOCH` is
set, the modification times of files taken from the reference.docx will
be set deterministically, allowing for reproducible builds.
* Lua subsystem (Albert Krewinkel):
+ Load module `pandoc.path` on startup (#7524). Previously the module
always had to be loaded via `require 'pandoc.path'`.
+ Fix typo in SoftBreak constructor.
+ Re-add `content` property to Strikeout elements.
Fixes a regression introduced in 2.15.
+ Be more forgiving when retrieving the Image `caption` property.
Fixes a regression introduced in 2.15.
+ Display Attr values using their native Haskell representation.
+ Allow omitting the 2nd parameter in pandoc.Code constructor.
Fixes a regression introduced in 2.15 which required users to always
specify an Attr value when constructing a Code element.
+ Allow to compare, show Citation values. Comparisons of Citation
values are performed in Haskell; values are equal if they represent
the same Haskell value. Converting a Citation value to a string
now yields its native Haskell string representation.
+ Restore List behavior of MetaList (#7650). Fixes a regression
introduced in 2.16 which had MetaList elements lose
the `pandoc.List` properties.
+ Restore `content` property on Header elements.
+ Ensure Block elements have all expected properties.
+ Ensure Inline elements have all expected properties.
* Allow tasty-bench 0.3.x.
- Update pandoc to version 2.16. Upstream has edited the change log file since the last release in a non-trivial way, i.e. they did more than just add a new entry at the top. You can review the file at: http://hackage.haskell.org/package/pandoc-2.16/src/changelog.md
- relax dep on skylighting
- Update pandoc to version 2.14.2.
[#]# pandoc 2.14.2 (provisional)
* Allow `--slide-level=0` (#7476). When the slide level is set
to 0, headings won't be used at all in splitting the document
into slides. Horizontal rules must be used to separate slides.
* Add RTF reader (#3982). `rtf` is now supported as an input
format as well as an output format. New module
Text.Pandoc.Readers.RTF (exporting `readRTF`). [API change]
* HTML reader: treat comments as blank when parsing (#7482).
* Markdown reader:
+ Fix raw LaTeX injection issue (#7497). Using a code block
containing `\end{verbatim}`, one could inject raw TeX into a
LaTeX document even when `raw_tex` is disabled. Thanks to
Augustin Laville for noticing the bug.
+ Multimarkdown sub- and superscripts (#5512, OCzarnecki).
Added an extension `short_subsuperscripts` which modifies
the behavior of `subscript` and `superscript`, allowing
subscripts or superscripts containing only alphanumerics
to end with a space character (eg. `x^2 = 4` or `H~2 is
combustible`). This improves support for multimarkdown.
* RST reader: Fix `:literal:` includes (#7513). These should create
code blocks, not insert raw RST.
* LaTeX reader:
+ Proper implicit grouping around environment macros.
+ Support `\global` before `\def`, `\let`, etc. (#7494).
+ Fix scope for LaTeX macros (#7494). They should by default
scope over the group in which they are defined (except `\gdef`
and `\xdef`, which are global). In addition, environments must
be treated as groups.
+ Improve handling of plain TeX macro primitives (#7474).
Fixed semantics for `\let`.
+ Implement `\edef`, `\gdef`, and `\xdef`.
* Docx reader: Improve docx reader's robustness in extracting
images (#7511). The docx reader made some assumptions about
how docx containers were laid out that were not always true, with
the result that some images in documents did not get
extracted.
* LaTeX writer: Increase table column width precision (#7466,
Peter Fabinski). In some cases, the rounding performed by the
LaTeX table writer would introduce visible overrun outside
the text area. This adds two more decimal places to the width
values.
* Powerpoint writer:
+ Include image title in description (#7352, Emily Bourke). The
image title (i.e. ``) was previously
ignored when writing to pptx. This commit includes it in
PowerPoint's description of the image, along with the link.
+ Select layouts from reference doc by name (Emily Bourke). Until
now, users had to make sure that their reference doc contains
layouts in a specific order: the first four layouts in the file
had to have a specific structure. Now the layout selection uses
the layout names rather than order: users must make sure their
reference doc contains four layouts with specific names, and if
a layout with the right name isn?t found pandoc will emit
a warning and use the corresponding layout from the default
reference doc as a fallback.
* Docx writer: be sensitive to the `native_numbering` extension
(#7499). Figure and table numbers are now only included if
`native_numbering` is enabled. (By default it is disabled.)
This is a behavior change with respect to 2.14.1, but the
default behavior is now that of previous versions. The
change was necessary to avoid incompatibilities between
pandoc's native numbering and third-party cross reference
filters like pandoc-crossref.
* RTF writer:
+ Omit `\bin` in `\pict`. According to the spec, this is not
needed or wanted when the data is in hexadecimal format, as
here.
+ Emit `\outlinelevel`` for section headings.
* RTF template: specify font family for fixed-width font f1.
According to the spec, this is mandatory.
* LaTeX writer: Use ulem for underline (#7351). ulem is
conditionally included already when the `strikeout` variable
is set, so we set this when there is underlined text, and use
`\uline` instead of `\underline`. This fixes wrapping for
underlined text.
* Text.Pandoc.Citeproc:
+ Revise citeproc code to fit new citeproc 0.5 API (thanks to
Benjamin Bray). Linkification of URLs in the bibliography
is now done in the citeproc library, depending on the
setting of an option. We set that option depending on the
value of the metadata field `link-bibliography` (defaulting
to true, for consistency with earlier behavior). If a DOI,
PMID, PMCID, or URL field is present but not explicitly
rendered, the title (or if no title, the whole entry) is
hyperlinked. These changes implement the recommendations
from the draft CSL v1.0.2 spec (Appendix VI):
<https://github.com/citation-style-language/documentation/blob/master/specification.rst#appendix-vi-links>
+ Avoid odd handling of quotes. Recent citeproc changes
allow us to ignore Quoted elements; citeproc now uses its own
method for represented quoted things, and only localizes and
flipflops quotes it adds itself. Convert Quoted in bib
entries to special Spans before passing them off to
citeproc. This ensures that we get proper localization and
flipflopping if, e.g., quotes are used in titles
(jgm/citeproc#87).
+ Removed quote localization from citeproc processing.
This is now done in citeproc itself.
* Text.Pandoc.Logging: Add PowerpointTemplateWarning log message
type [API change] (Emily Bourke).
* Text.Pandoc.Extension: Add `Ext_short_subsuperscripts`
constructor to `Extension` [API change] (OCzarnecki).
* Various sample.lua editorial fixes (#7493, #7487, William
Lupton).
* Bump base-compat version so we get compatibility with base 4.12.
* Use Prelude from base-compat for ghc 8.4 too.
* Add haskell-language-server to shell.nix (#7496, Emily Bourke).
* Tests.Helpers: export testGolden and use it in RTF reader.
This gives a diff output on failure.
* Remove obsolete and incorrect sentence in `--slide-level` docs.
* Add internal module Text.Pandoc.Network.HTTP, exporting
`urlEncode`.
* Text.Pandoc.Parsing: `parseFromString`: preserve at least
the source directory (#7464). Previously we just set the
source name to "chunk" when parsing from strings, to avoid
misleading source positions. This had the side effect that
`rebase_relative_paths` would break inside sections that
were parsed as strings. So, now we use
"ORIGINAL_SOURCE_PATH_chunk" instead of just "chunk".
* Text.Pandoc.MIME: use image/x-xcf instead of application/x-xcf
(#7454).
* Don?t compare `cdLine` in OOXML golden tests (Emily Bourke).
The `cdLine` field gives the line of the file some CData was
found on, which reflects irrelevant formatting differences.
* Provide more detailed XML diff in tests (Emily Bourke).
* OOXML tests: silence warnings. These can make the test output
confusing, making people think tests are failing when they're
passing.
* INSTALL.md: Add GitLab CI/CD example (#7448, Veratyr).
* 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).
- Include manpage in distribution.
- Update pandoc to version 2.14.1.
[#]# pandoc 2.14.1 (2021-07-18)
* 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 by `htmlTag`.
* LaTeX reader:
+ Avoid trailing hyphen in translating languages (#7447).
Previously `\foreignlanguage{english}` turned into `<span lang="en-">`.
The same issue affected Arabic.
+ Support `\cline` in LaTeX tables (#7442).
+ Improved parsing of raw LaTeX from Text streams (`rawLaTeXParser`,
used to read LaTeX in Markdown files, #7434). We now use source
positions from the token stream to tell us how much of the text stream
to consume. Getting this to work required a few other changes to
make token source positions accurate.
* DocBook reader:
+ Handle images with imageobjectco elements (#7440).
+ Add support for citerefentry (#7437, Jan Tojnar).
* RST reader: fix regression with code includes (#7436).
With the recent changes to include infrastructure,
included code blocks were getting an extra newline.
* HTML reader:
+ Recognize data-external when reading HTML img tags (#7429,
Michael Hoffmann). Preserve all attributes in img tags. If attributes
have a `data-` prefix, it will be stripped. In particular, this
preserves a `data-external` attribute as an `external` attribute in
the pandoc AST.
+ Add col, colgroup to 'closes' definitions
* HTML writer:
+ Remove duplicated alt text in HTML output (Aner Lucero).
+ Remove `aria-hidden` when explicit alt text is provided (Aner Lucero).
+ Set boolean values for reveal.js variables.
* Docx writer:
+ Add table numbering for captioned tables.
The numbers are added using fields, so that Word can
create a list of tables that will update automatically.
+ Support figure numbers. These are set up in such a way that they
will work with Word's automatic table of figures (#7392).
* Markdown writer: put space between Plain and following fenced Div
(#4465).
* EPUB writer: Don't incorporate externally linked images in EPUB documents
(#7430, Michael Hoffmann). Just as it is possible to avoid incorporating
an image in EPUB by passing `data-external="1"` to a raw HTML snippet,
this makes the same possible for native Images, by looking for an
associated `external` attribute.
* Text.Pandoc.PDF:
+ Fix `svgIn` path error (#7431). We were duplicating
the temp directory; this didn't cause problems on macOS or linux
because there we use absolute paths for the temp directory.
But on Windows it caused errors converting SVG files.
+ `convertImage`: normalize paths (#7431). This will avoid paths
on Windows with mixed path separators.
* Text.Pandoc.Class: Always use / when adding directory to image destination
with `extractMedia`, even on Windows.
* Text.Pandoc.Citeproc:
+ Allow `$` characters in bibtex keys (#7409).
+ Set proper initial source name in parsing BibTeX (for better error
messages.)
+ Revamp note citation handling (#7394). Use latest
citeproc, which uses a Span with a class rather than a Note for notes.
This helps us distinguish between user notes and citation notes. Don't
put citations at the beginning of a note in parentheses. Fix small bug
in handling of citations in notes, which led to commas at the end of
sentences in some cases.
+ Cleanup and efficiency improvement in `deNote`.
+ Improve punctuation moving with `--citeproc`. Previously, using
`--citeproc` could cause punctuation to move in quotes even when
there aer no citations. This has been changed; punctuation moving
is now limited to citations. In addition, we only move footnotes
around punctuation if the style is a note style, even if
`notes-after-punctuation` is `true`.
* Use citeproc 0.10. This helps improve note citations (see above)
and eliminates double hyperlinks in author-in-text citations.
Author-only citations are no longer hyperlinked. See jgm/citeproc#77.
It also fixes moving of punctuation inside quotes to conform to
the CSL spec: only comma and period are moved, not question
mark or exclamation point.
* Text.Pandoc.Error: fix line calculations in reporting parsec errors.
Also remove a spurious initial newline in the error report.
* Use doctemplates 0.4.1, which gives us better support for boolean
variable values. Previously `$if(foo)$` would evaluate to true
for variables with boolean `false` values, because it cared only
about the string rendering (#7402).
* Require commonmark-pandoc >= 0.2.2.1.
This fixes task lists with multiple paragraphs.
* Use skylighting 0.11.
* CSS in HTML template: reset overflow-wrap on code blocks
(Mauro Bieg, #7423).
* LaTeX template: Revert change in PR #7295: "move title, author, date up
to top of preamble." The change caused problem for people who used
LaTeX commands defined defined later in the preamble in the title
or author fields (#7422).
* Add `doc/faqs.md`. This is imported from the website; in the future the
website version will be drawn from here.
Added a FAQ on the use of `\AtEndPreamble` for cases when the contents of
`header-includes` need to refer to definitions that come later in the
preamble. See #7422.
* Upgrade Debian 10 AMI for build-arm.sh.
* CircleCI: change to using xcode 11.1.0 (macOS 10.14.4).
We previously built on 10.13, but 10.13 no longer gets
security updates and CirclCI is deprecating.
- Update pandoc to version 2.14.0.3.
[#]# pandoc 2.14.0.3 (2021-06-22)
* Text.Pandoc.MediaBag `insertMediaBag`: ensure we get a sane mediaPath
for URLs (#7391). In earlier 2.14.x versions, we'd get
incorrect paths for resources downloaded from URLs when the
media are extracted (including in PDF production).
* Text.Pandoc.Parsing: improve `emailAddress` (#7398).
Previously the parser would accept characters in domains
that are illegal in domains, and this sometimes caused it
to gobble bits of the following text.
* txt2tags reader: modify the email address parser so
it still includes form parameters, even after the change to
`emailAddress` in Text.Pandoc.Parsing.
* Text.Pandoc.Readers.Metadata: Fix regression with comment-only YAML
metadata blocks (#7400).
* reveal.js writer and template: better handling of options. Previously
it was impossible to specify false values for options that default to
true (e.g. `center`); setting the option to false just caused the portion
of the template setting the option to be omitted. Now we prepopulate
all the variables with their default values, including them all
unconditionally and allowing them to be overridden.
* Markdown writer: Fix regression in code blocks with attributes (#7397).
Code blocks with a single class but nonempty attributes
were having attributes drop as a result of #7242.
* LaTeX writer:
+ Add strut at end of minipage if it contains line breaks.
Without them, the last line is not as tall as it should be in
some cases.
+ Always use a minipage for cells with line breaks, when
width information is available (#7393). Otherwise the way we treat them
can lead to content that overflows a cell.
+ Use `\strut` instead of `~` before `\\` in empty line.
* Use lts-18.0 stack resolver.
* Require skylighting 0.10.5.2 (adding support for Swift).
* Require commonmark 0.2.1.
* Rephrase section on unsafe HTML in manual.
* Create SECURITY.md
- Update pandoc to version 2.14.0.2.
[#]# pandoc 2.14.0.2 (2021-06-13)
* Fix MediaBag regressions (#7345). iIn the 2.14 release `--extract-media`
stopped working as before; there could be mismatches between the
paths in the rendered document and the extracted media.
This patch makes several changes that restore the earlier behavior
(while keeping the same API). The `mediaPath` in 2.14 was always
constructed from the SHA1 hash of the media contents. Now, we
preserve the original path unless it's an absolute path or contains
`..` segments (in that case we use a path based on the SHA1 hash of
the contents).
In Text.Pandoc.MediaBag, `mediaDirectory` and `mediaItems` now use the
`mediaPath`, rather than the mediabag key, for the first component of the
tuple. This makes more sense, I think, and fits with the documentation of
these functions; eventually, though, we should rework the API so that
`mediaItems` returns both the keys and the MediaItems.
In Text.Pandoc.Class.IO, rewriting of source paths in `extractMedia` has
been fixed.
In Text.Pandoc.Class.PandocMonad, `fillMediaBag` has been modified so that
it doesn't modify image paths (that was part of the problem in #7345).
We now do path normalization (e.g. `\` separators on Windows) in
writing the media.
* Text.Pandoc.PDF:
+ Text.Pandoc.PDF: Fix regression in 2.14 for generation of PDFs with
SVGs (#7344).
+ Only print relevant part of environment on `--verbose`. Since
`--verbose` output might be put in an issue, we want to avoid
spilling out secrets in environment variables.
* Markdown reader: fix pipe table regression in 2.11.4 (#7343).
Previously pipe tables with empty headers (that is, a header
line with all empty cells) would be rendered as headerless
tables. This broke in 2.11.4. The fix here is to produce an
AST with an empty table head when a pipe table has all empty
header cells.
* LaTeX reader: don't allow optional `*` on symbol control sequences
(#7340). Generally we allow optional starred variants of LaTeX commands
(since many allow them, and if we don't accept these explicitly,
ignoring the star usually gives acceptable results). But we
don't want to do this for `\(*\)` and similar cases.
* Docx reader: handle absolute URIs in Relationship Target (#7374).
* Docx writer: fix handling of empty table headers (Albert Krewinkel,
[#7369]). A table header which does not contain any cells is now treated as
an empty header.
* LaTeX writer: Fix regression in table header position (#7347).
In recent versions the table headers were no longer bottom-aligned
(if more than one line). This patch fixes that by using minipages
for table headers in non-simple tables.
* CommonMark writer:
+ Do not use simple class for fenced-divs (Jan Tojnar, amends #7242.)
+ Do not throw away attributes when `Ext_attributes` is enabled.
`Ext_attributes` covers at least the following:
`Ext_fenced_code_attributes`, `Ext_header_attributes`,
`Ext_inline_code_attributes`, `Ext_link_attributes`.
* Markdown writer:
+ Allow `pipe_tables` to be disabled for commonmark formats
(`commonmark_x`, `gfm`) (#7375).
+ Re-use functions from Text.Pandoc.Markdown.Inline (Jan Tojnar).
* DocBook writer: Remove non-existent admonitions (Jan Tojnar).
`attention`, `error` and `hint` are reStructuredText specific.
* HTML writer: Don't omit width attribute on div (#7342).
* Text.Pandoc.MIME, `extensionFromMimeType`: add a few special cases.
When we do a reverse lookup in the MIME table, we just get the
last match, so when the same mime type is associated with several
different extensions, we sometimes got weird results, e.g. `.vs`
for `text/plain`. These special cases help us get the most standard
extensions for mime types like `text/plain`.
* Lua utils: fix handling of table headers in `from_simple_table` (Albert
Krewinkel, #7369). Passing an empty list of header cells now results
in an empty table header.
* Text.Pandoc.Citeproc:
+ Avoid duplicate classes and attributes on references div.
+ Fix regression in citeproc processing (#7376). If inline
references are used (in the metadata `references` field), we
should still only include in the bibliography items that are
actually cited (unless `nocite` is used).
* Require citeproc 0.4.0.1. This fixes a bug which led to doubled
"et al." in some (rare) circumstances.
* MANUAL.txt:
+ Mention GladTeX for EPUB export (Sebastian Humenda).
This updates the manual and the web site about the GladTeX usage.
+ More details and a useful link for YAML syntax.
* CONTRIBUTING.md: update modules overview (Albert Krewinkel).
* using-the-pandoc-api.md: switch from String to Text (Albert Krewinkel).
- Update pandoc to version 2.14.0.1. Upstream has edited the change log file since the last release in a non-trivial way, i.e. they did more than just add a new entry at the top. You can review the file at: http://hackage.haskell.org/package/pandoc-2.14.0.1/src/changelog.md
- Update pandoc to version 2.14.
[#]# pandoc 2.14 (2021-05-28)
* 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_paths` extension (#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 `Sources` type and a
`ToSources` class. A `Sources` wraps a list of `(SourcePos, Text)` pairs
[API change]. A parsec `Stream` instance is provided for `Sources`. The
module also exports versions of parsec's `satisfy` and other Char parsers
that track source positions accurately from a `Sources` stream (or any
instance of the new `UpdateSourcePos` class).
* Text.Pandoc.Parsing
+ Export the modified Char parsers defined in Text.Pandoc.Sources
instead of the ones parsec provides. Modified parsers to use a
`Sources` as stream [API change].
+ Improve include file functions [API change]. Remove old
`insertIncludedFileF`. Give `insertIncludedFile` a more general type,
allowing it to be used where `insertIncludedFileF` was.
+ Add parameter to the `citeKey` parser from
Text.Pandoc.Parsing, which controls whether the `@{..}`
syntax is allowed [API change].
* Text.Pandoc.Error: Modified the constructor `PandocParsecError` to take a
`Sources` rather than a `Text` as 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 key `foo_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 `insertIncludedFile` from 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 `\def` macros. We previously set "verbatim mode"
even for parsing the initial `\def`; this caused problems
for `\def` nested 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=-1` to 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.
* 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 `exampleblock` and `alertblock` (#7278).
A block will be rendered as an `exampleblock` if the heading
has class `example` and an `alertblock` if it has class `alert`.
+ 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 `annote` field (#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 `pre` tag (#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 leading `language-` prefix is dropped in the code's
`class` attribute are dropped to improve syntax highlighting.
+ Ensure headings only have valid attribs in HTML4 (#5944, Albert
Krewinkel).
+ Parse `<header>` as a Div (Albert Krewinkel).
* 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-type` and 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`,
where `xxxx` is the character's hex code.
* 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:proofState` for spelling or grammar to `dirty`,
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 `rsid`s 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 `monofont` to 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 (`indent` variable
not set), we would get interparagraph spaces separating bib
entries even with `entry-spacing="0"`. On the other hand,
setting `entry-spacing="2"` gave ridiculously large spacing.
This change makes the spacing caused by `entry-spacing` a multiple
of `\parskip` by default, which gives aesthetically reasonable
output. Those who want a larger or smaller unit (e.g. because
they use `indent` which sets `\parskip` to 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: List of figures before list of tables (#7235,
Julien Dutant).
* reveal.js template:
+ Support `toc-title` (#7171, Florian Kohrt).
+ Use `hash: true` by default rather than `history: true` (#6968).
* HTML-based slide shows: add support for `institute` (#7289, Thomas
Hodgson).
* Text.Pandoc.Extensions: Add constructor `Ext_rebase_relative_paths` to
`Extensions` [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 `Text` key instead of `[FilePath]`.
We normalize the path and use `/` separators for consistency.
+ Export `MediaItem` type [API change].
+ Change `MediaBag` type to a map from Text to MediaItem [API change].
+ `lookupMedia` now returns a `MediaItem` [API change].
+ Change `insertMedia` so it sets the `mediaPath` to a filename based on
the SHA1 hash of the contents. This will be used when contents
are extracted.
* Text.Pandoc.Class.PandocMonad:
+ Remove `fetchMediaResource` [API change]. Use `fetchItem` to get
resources in `fillMediaBag`.
+ Add informational message in `downloadOrRead` indicating what path
local resources have been loaded from.
* 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-scope` flag is used.
* Add new internal module Text.Pandoc.Writers.GridTable (Albert Krewinkel).
* Text.Pandoc.Highlighting: Change type of `languagesByExtension`, adding
a parameter for a `SyntaxMap` [API change] (Jan Tojnar, #7241).
Languages defined using `--syntax-definition` were not recognized by
`languagesByExtension`. 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-definition` won'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-spacing` won't work when
such Divs are used.
+ Use metadata's `lang` for the lang parameter of citeproc, overriding
`localeLanguage`.
+ 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).
* 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 make
`splitTextByInstances` char-width sensitive.
+ Add `getLang` (formerly in the now-removed BCP47) [API change].
* Text.Pandoc.SelfContained: use `application/octet-stream`
for 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 `lang` and bibliography sorting.
+ Add info about YAML escape sequences, link to spec (#7152,
Albert Krewinkel).
+ Note that `institute` variable works for HTML-based slides.
+ Update documentation on citation syntax.
+ Add citation example for locators and suffixes (Tristan Stenner)
* 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.md` test. It is basically the same
as `biblaetx-quotes.md`.
* Command tests: fail if a file contains no tests---and fix a
test that failed in that way!
- Update pandoc to version 2.13.
[#]# pandoc 2.13 (2021-03-21)
* Support `yaml_metadata_block` extension for `commonmark`, `gfm` (#6537).
This supported is a bit more limited than with pandoc's
`markdown`. 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 `nocite` better with `--biblatex` and `--natbib` (#4585).
Previously the nocite metadata field was ignored with these formats.
Now it populates a `nocite-ids` template variable and causes a
`\nocite` command to be issued.
* Text.Pandoc.Citeproc: apply `fixLinks` correctly (#7130). This is code
that incorporates a prefix like `https://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`, `ToText` typeclasses [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`.
* Text.Pandoc.Parsing:
+ Change type of `readWithM` so that it is no longer polymorphic
[API change]. The `ToText` class has been removed, and now that we've
completed the transition to Text we no longer need this to operate
on Strings.
+ Remove `F` type synonym [API change]. Muse and Org were defining their
own `F` anyway.
* Text.Pandoc.Readers.Metadata:
+ Export `yamlMetaBlock` [API change].
+ Make `yamlBsToMeta`, `yamlBsToRefs` polymorphic on the parser state
[API change].
* 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) and `id` (DocBook 4).
* Docx writer:
+ Make `nsid` in `abstractNum` deterministic. 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).
* 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 `panel` as panels, and
avoid nesting of panels.
* 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 `DuplicateAttribute` constructor to `LogMessage`.
[API change]
* Use `-j4` for 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 of `foldl` everywhere.
* 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 `getExecutablePath` from base, avoiding the dependency on
`executable-path`.
+ Factor out `setupEnvironment` in Helpers, to avoid code duplication.
+ Fix finding of data files by setting teh `pandoc_datadir` environment
variable when we shell out to pandoc. This avoids the need to use
`--data-dir` for the tests, which caused problems finding `pandoc.lua`
when compiling without the `embed_data_files` flag (#7163).
* Benchmark improvements:
+ Build `+RTS -A8m -RTS` into 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 `readFile` in benchmarks early (Bodigrim).
* CONTRIBUTING: suggest using a `cabal.project.local` file (#7153,
Albert Krewinkel).
* Add ghcid-test to Makefile. This loads the test suite in ghcid.
- Update pandoc to version 2.12. Upstream has edited the change log file since the last release in a non-trivial way, i.e. they did more than just add a new entry at the top. You can review the file at: http://hackage.haskell.org/package/pandoc-2.12/src/changelog.md
- Update pandoc to version 2.11.4.
[#]# pandoc 2.11.4 (2021-01-22)
* Add `biblatex`, `bibtex` as output formats (closes #7040).
* Recognize more extensions as markdown by default (#7034):
`mkdn`, `mkd`, `mdwn`, `mdown`, `Rmd`.
* Implement defaults file inheritance (#6924, David Martschenko).
Allow defaults files to inherit options from other defaults files by
specifying them with the following syntax:
`defaults: [list of defaults files or single defaults file]`.
* Fix infinite HTTP requests when writing epubs from URL source (#7013).
Due to a bug in code added to avoid overwriting the cover image
if it had the form `fileX.YYY`, pandoc made an endless sequence
of HTTP requests when writing epub with input from a URL.
* Org reader:
+ Allow multiple pipe chars in todo sequences (Albert Krewinkel, #7014).
Additional pipe chars, used to separate "action" state from "no further
action" states, are ignored. E.g., for the following sequence, both
`DONE` and `FINISHED` are states with no further action required:
`#+TODO: UNFINISHED | DONE | FINISHED`.
+ Restructure output of captioned code blocks (Albert Krewinkel, #6977).
The Div wrapper of code blocks with captions now has the class
"captioned-content". The caption itself is added as a Plain block
inside a Div of class "caption". This makes it easier to write filters
which match on captioned code blocks. Existing filters will need to be
updated.
+ Mark verbatim code with class `verbatim` (Dimitri Sabadie, #6998).
* LaTeX reader:
+ Handle `filecontents` environment (#7003).
+ Put contents of unknown environments in a Div when `raw_tex` is not
enabled (#6997). (When `raw_tex` is enabled, the whole environment is
parsed as a raw block.) The class name is the name of the environment.
Previously, we just included the contents without the surrounding Div,
but having a record of the environment's boundaries and name can be
useful.
* Mediawiki reader:
+ Allow space around storng/emph delimiters (#6993).
* New module Text.Pandoc.Writers.BibTeX, exporting
writeBibTeX and writeBibLaTeX. [API change]
* LaTeX writer:
+ Revert table line height increase in 2.11.3 (#6996).
In 2.11.3 we started adding `\addlinespace`, which produced less dense
tables. This wasn't an intentional change; I misunderstood a comment in
the discussion leading up to the change. This commit restores the earlier
default table appearance. Note that if you want a less dense table, you
can use something like `\def\arraystretch{1.5}` in your header.
* EPUB writer:
+ Adjust internal links to identifiers defined in raw HTML sections
after splitting into chapters (#7000).
+ Recognize `Format "html4"`, `Format "html5"` as raw HTML.
+ Adjust internal links to images, links, and tables after splitting into
chapters. Previously we only did this for Div and Span and Header
elements (see #7000).
* Ms writer:
+ Don't justify text inside table cells.
* JATS writer:
+ Use `<element-citation>` if `element_citations`
extension is enabled (Albert Krewinkel).
+ Fix citations (Albert Krewinkel, #7018). By default
we use formatted citations.
+ Ensure that `<disp-quote>` is always wrapped in `<p>` (#7041).
* Markdown writer:
+ Cleaned up raw formats. We now react appropriately
to `gfm`, `commonmark`, and `commonmark_x` as raw formats.
* RST writer:
+ Fix bug with dropped content from inside spans with a class in
some cases (#7039).
* Docx writer:
+ Handle table header using styles (#7008). Instead of hard-coding
the border and header cell vertical alignment, we now let this
be determined by the Table style, making use of Word's
"conditional formatting" for the table's first row. For
headerless tables, we use the tblLook element to tell Word
not to apply conditional first-row formatting.
* Commonmark writer:
+ Implement start number on ordered lists (#7009). Previously they always
started at 1, but according to the spec the start number is respected.
* HTML writer:
+ Fix implicit_figure at end of footnotes (#7006).
* ConTeXt template: Remove `\setupthinrules` from default template.
The width parameter this used is not actually supported,
and the command didn't do anything.
* Text.Pandoc.Extensions:
+ Add `Ext_element_citations` constructor (Albert Krewinkel).
* Text.Pandoc.Citeproc.BibTeX: New unexported function
`writeBibtexString`.
* Text.Pandoc.Citeproc:
+ Use finer grained imports (Albert Krewinkel).
+ Factor out and export `getStyle` [API change].
+ Export `getReferences` [API change, #7106].
+ Factor out getLang.
* Text.Pandoc.Parsing: modify `gridTableWith'` for headerless tables.
If the table lacks a header, the header row should be an empty
list. Previously we got a list of empty cells, which caused
an empty header to be emitted instead of no header. In LaTeX/PDF
output that meant we got a double top line with space between.
* ImageSize: use `viewBox` for SVG if no length, width attributes (#7045).
This change allows pandoc to extract size information from more SVGs.
* Add simple default.nix.
* Use commonmark 0.1.1.3.
* Use citeproc 0.3.0.5.
* Update default CSL to use latest chicago-author-date.csl.
* CONTRIBUTING.md: add note on GNU xargs.
* MANUAL.txt:
+ Update description of `-L`/`--lua-filter`.
+ Document use of citations in note styles (#6828).
- Update pandoc to version 2.11.3.2.
[#]# pandoc 2.11.3.2 (2020-12-29)
* HTML reader: use renderTags' from Text.Pandoc.Shared (Albert Krewinkel).
A side effect of this change is that empty `<col>` elements are written
as self-closing tags in raw HTML blocks.
* Asciidoc writer: Add support for writing nested tables (#6972, timo-a).
Asciidoc supports one level of nesting. If deeper tables are to be
written, they are omitted and a warning is issued.
* Docx writer: fix nested tables with captions (#6983).
Previously we got unreadable content, because docx seems
to want a `<w:p>` element (even an empty one) at the end of
every table cell.
* Powerpoint writer: allow arbitrary OOXML in raw inline elements
(Albert Krewinkel). The raw text is now included verbatim in the
output. Previously is was parsed into XML elements, which prevented
the inclusion of partial XML snippets.
* LaTeX writer: support colspans and rowspans in tables (#6950,
Albert Krewinkel). Note that the multirow package is needed for
rowspans. It is included in the latex template under a variable,
so that it won't be used unless needed for a table.
* HTML writer: don't include p tags in CSL bibliography entries
(#6966). Fixes a regression in 2.11.3.
* Add `meta-description` variable to HTML templates (#6982). This
is populated by the writer by stringifying the `description`
field of metadata (Jerry Sky). The `description` meta tag will
make the generated HTML documents more complete and SEO-friendly.
* Citeproc: fix handling of empty URL variables (`DOI`, etc.).
The `linkifyVariables` function was changing these to links
which then got treated as non-empty by citeproc, leading
to wrong results (e.g. ignoring nonempty URL when empty DOI is present).
See jgm/citeproc#41.
* Use citeproc 0.3.0.3. Fixes an issue in author-only citations when
both an author and translator are present, and an issue with
citation group delimiters.
* Require texmath 0.12.1. This improves siunitx support in math,
fixes bugs with `\*mod` family operators and arrays, and avoids
italicizing symbols and operator names in docx output.
* Ensure that the perl interpreter used for filters with `.pl`
extension (wuffi).
* MANUAL: note that textarea content is never parsed as Markdown
(Albert Krewinkel).
- Update pandoc to version 2.11.3.1.
[#]# pandoc 2.11.3.1 (2020-12-18)
* Added some missing files to extra-source-files and data
files, so they are included in the sdist tarball. Closes #6961.
Cleaned up some extraneous data and test files, and added
a CI check to ensure that the test and data files included
in the sdist match what is in the git repository.
* Use citeproc 0.3.0.1, which avoids removing nonbreaking
space at the end of the `initialize-with` attribute. (Some
journals require nonbreaking space after initials, and this
makes that possible.)
- Update pandoc to version 2.11.3.
[#]# pandoc 2.11.3 (2020-12-17)
* With `--bibliography` (or `bibliography` in 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 `sourcepos` extension for `commonmark`, `gfm`, `commonmark_x`
(#4565). With the `sourcepos` extension set set, `data-pos`
attributes are added to the AST by the commonmark reader. No other
readers are affected. The `data-pos` attributes 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`: replace `auto_identifiers`
with `gfm_auto_identifiers` (#6863). `commonmark_x` never actually
supported `auto_identifiers` (it didn't do anything), because the
underlying library implements gfm-style identifiers only. Attempts
to add the `auto_identifiers` extension to `commonmark` will 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 `lang` attributes on body element (#6938).
These (as well as `lang` attributes on the html element) should update
lang in metadata.
+ Retain attribute prefixes and avoid duplicates (#6938).
Previously we stripped attribute prefixes, reading `xml:lang` as
`lang` for example. This resulted in two duplicate `lang`
attributes when `xml:lang` and `lang` were 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.
* Org reader:
+ Parse `#+LANGUAGE` into `lang` metadata 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 attribute `target` set to the link's
original target. This allows to recover and fix broken or unknown
links with filters.
* 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 `fo` stylesheets through an XML
processing instruction, `<?dbfo table-width="50%"?>`.
* 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 `center` environment are put in a `Div`
with class `center`.
+ Don't parse `\rule` with 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.
* 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.
* 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
`alt` attribute 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 classes `align-center`, `align-left`, or
`align-right` are ignored. However, `align-top`, `align-middle`,
`align-bottom` will generate a corresponding `align` attribute.
* 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 `\strut` that was added at the end of minipage
environments in cells. Replace `\tabularnewline` with
`\\ \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.
* 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_name` and `xrefs_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 for `xrefs_name` or the
number for `xrefs_number`. For the `xrefs_number` to be useful
heading numbers must be enabled in the generated document and
table and figure captions must be enabled using for example the
`native_numbering` extension. 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:id` instead of `id`.
+ Handle admonition titles better (Jan Tojnar).
Docbook reader produces a `Div` with `title` class for `<title>`
element within an ?admonition? element. Markdown writer then turns
this into a fenced div with `title` class 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 `xmlns` attributes 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
`--standalone` flag, since those will already have xmlns attribute on
the root element in the template.
* 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.
* EPUB writer:
+ Include title page in landmarks (#6919).
Note that the toc is also included if `--toc` is specified.
+ Add frontmatter type on body element for nav.xhtml (#6918).
* 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 `csquotes` package if `csquotes` variable 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.22`
gets rendered as `122`, and `et~al.` as `etal`.
One would think that babel's `shorthands=off` option (which
we were using) would disable these, but it doesn't. So we
remove `shorthands=off` and add some code that redefines
the shorthands macro. Eventually this will be fixed in babel,
I hope, and we can revert to something simpler.
* 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_sourcepos` constructor for `Extension` [API change].
+ Add `Ext_xrefs_name` and `Ext_xrefs_number` constructors for
`Extension` (Nils Carson) [API change].
* Text.Pandoc.Citeproc:
+ Fix truncation of `[Citation]` list in `Cite` inside 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 `fetchItem` to 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 `getRawField`
which 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).
* 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).
* 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 `app` directory 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).
- disable %{ix86} build
- Update pandoc to version 2.11.2.
[#]# pandoc 2.11.2 (2020-11-19)
* Default to using ATX (`##`-style) headings for Markdown output
(#6662, Aner Lucero). Previously we used Setext (underlined) headings
by default for levels 1--2.
* Add option `--markdown-headings=atx|setext`, and deprecate
`--atx-headers` (#6662, Aner Lucero).
* Support `markdown-headings` in defaults files.
* Fix corner case in YAML metadata parsing (#6823). Previously YAML
metadata would sometimes not get recognized if a field ended with a
newline followed by spaces.
* `--self-contained`: increase coverage (#6854).
Previously we only self-contained attributes for certain tag names
(`img`, `embed`, `video`, `input`, `audio`, `source`, `track`,
`section`). Now we self-contain any occurrence of `src`,
`data-src`, `poster`, or `data-background-image`, on any tag; and
also `href` on `link` tags.
* Markdown reader:
+ Fix detection of locators following in-text citations.
Prevously, if we had `@foo [p. 33; @bar]`, the `p. 33` would be
incorrectly parsed as a prefix of `@bar` rather than a suffix of
`@foo`.
+ Improve period suppression algorithm for citations in notes
in note citation styles (#6835).
+ Don't increment `stateNoteNumber` for example list references.
This helps with #6836 (a bug in which example list references
disturb calculation of citation note number and affect when
`ibid` is triggered).
* LaTeX reader:
+ Move `getNextNumber` from Readers.LaTeX to Readers.LaTeX.Parsing.
+ Fix negative numbers in siunitx commands. A change in pandoc 2.11
broke negative numbers, e.g. `\SI{-33}{\celcius}` or `\num{-3}`.
This fixes the regression.
* DocBook reader: drop period in formalpara title
and put it in a div with class `formalpara-title`, so that
people can reformat with filters (#6562).
* Man reader: improve handling of `.IP` (#6858). We now better handle
`.IP` when it is used with non-bullet, non-numbered lists, creating a
definition list. We also skip blank lines like groff itself.
* Bibtex reader: fall back on `en-US` if locale for LANG not found.
This reproduces earlier pandoc-citeproc behavior (jgm/citeproc#26).
* 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.
* 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 `filterIpynbOutput` if input format is ipynb (#6841).
Before this change content could go missing from divs with class
`output`, even when non-ipynb was being converted.
* When checking reader/writer name, check base name now that we permit
extensions on formats other than markdown.
* Text.Pandoc.PDF: Fix `changePathSeparators` for Windows (#6173).
Previously a path beginning with a drive, like `C:\foo\bar`, was
translated to `C:\/foo/bar`, which caused problems.
With this fix, the backslashes are removed.
* Text.Pandoc.Logging: Add constructor `ATXHeadingInLHS` constructor
to `LogMessage` [API change].
* Fix error that is given when people specify `doc` output (#6834,
gison93).
* LaTeX template: add a `\break` after parbox in `CSLRightInline`.
This should fix spacing problems between entries with numeric styles.
Also fix number of params on `CSLReferences`.
* reveal.js template: Put quotes around `controlsLayout`,
`controlsBackArrows`, and `display`, since these require strings.
Add `showSlideNumber`, `hashOneBasedIndex`, `pause`.
* Use citeproc 0.2. This fixes a bug with title case around parentheses.
* pandoc.cabal: remove 'static' flag.
This isn't really necessary and can be misleading (e.g. on macOS,
where a fully static build isn't possible). cabal's new option
`--enable-executable-static` does the same. On stack you can add
something like this to the options for your executable in package.yaml:
ld-options: -static -pthread
* Remove obsolete bibutils flag setting in `linux/make_artifacts.sh`.
* Manual:
+ Correct `link-citation` -> `link-citations`.
+ Add a sentence about `pagetitle` for HTML (#6843, Alex Toldaiev).
* INSTALL.md: Remove references to `pandoc-citeproc` (#6857).
* CONTRIBUTING: describe hlint and how it's used (#6840, Albert
Krewinkel).
- Update pandoc to version 2.11.1.1.
[#]# pandoc 2.11.1.1 (2020-11-07)
* Citeproc: improve punctuation in in-text note citations (#6813).
Previously in-text note citations inside a footnote would sometimes have
the final period stripped, even if it was needed (e.g. on the end of
'ibid').
* Use citeproc 0.1.1.1. This improves the decision about when
to use `ibid` in cases where citations are used inside
a footnote (#6813).
* Support `nocase` spans for `csljson` output.
* Require latest commonmark, commonmark-extensions.
This fixes a bug with `autolink_bare_uris` and commonmark.
* LaTeX reader: better handling of `\\` inside math in table cells (#6811).
* DokuWiki writer: translate language names for code elements
and improve whitespace (#6807).
* MediaWiki writer: use `syntaxhighlight` tag instead of deprecated
`source` for highlighted code (#6810). Also support `startFrom`
attribute and `numberLines`.
* Lint code in PRs and when committing to master (#6790,
Albert Krewinkel).
* doc/filters.md: describe technical details of filter invocations (#6815,
Albert Krewinkel).