LEFT TEXT
Reading time: 134220 words, 610 minutes
<!-- composer >> metainfo box-begin 0 -->
#WORK
<!-- composer >> box-end -->
New input formats: endnotexml (EndNote XML bibliography), ris (RIS bibliography).
A RIS bibliography file may now be used with --citeproc.
Citeproc: Allow a formatted bibliography to be placed in metadata fields via a Div with class refs (#7969, #526). Thus, one can include a metadata field, say refs, whose content is an empty div with id refs, and the formatted bibliography will be put into this metadata field. It may then be interpolated into a template using the variable refs.
Ensure that you don’t get PDF output to terminal. -t pdf now behaves like -t docx and gives an error unless the output is redirected.
--version now prints hslua version (#7929) and Lua version (#7997, Albert Krewinkel).
Change --metadata-file parsing so that, when the input format is not markdown or a markdown variant, pandoc’s markdown is used (#6832, #7926). When the input format is a markdown variant, the same format is used. Reason for the change: it doesn’t make sense to run the markdown parser with a set of extensions designed for a non-markdown format, and this dramatically limits what people can do in metadata files.
Trim whitespace from math in --webtex (#7892). This fixes problems with –webtex and markdown output, when display math starts or ends with a newline.
New exported module Text.Pandoc.Readers.EndNote, exporting readEndNoteXML, readEndNoteXMLCitation, and readEndNoteXMLReferences. [API change]
--self-contained: issue warning rather than failing with an error if a resource can’t be found (#7904).
New exported module, Text.Pandoc.Readers.RIS, exporting readRIS (#7894).
LaTeX reader:
vbox (#7939).\today (#7905).\label and \ref for footnotes (#7930).\bgroup (#7953).\usepackage. If the package is local but causes parse errors, parse everything up to the error and skip the rest. Issue a CouldNotParseIncludeFile warning indicating that parsing failed at that point.HTML reader:
<a epub:type="noteref"> and the identifier doesn’t correspond to anything in the note table (#7884). Previously we just silently skipped these cases.DocBook reader:
--verbose.DokuWiki reader:
RST reader:
Span with these attributes.JATS reader:
<fn-group> elements are collected and re-inserted into the document as proper footnotes in the place where they are referenced.pub-date (#8000).issn and isbn; use simpler form for issued date.ref- prefix to the citation id to get the ref element’s id.Org reader:
Allow “:” in property drawer keys (Lucas V. R). Any non-space character is allowed as property drawer key, including “:” itself (so it is not really a delimiter). The real delimiter is a space character, so in a drawer like
:PROPERTIES:
::k:ey:: value
:END:“:k:ey:” is a key with value “value”.
Allow comments above property drawer.
More flexible LaTeX environments (Lucas V. R).
Handle #+bibliography: as metadata so that it can work with --citeproc.
Parse #+print_bibliography: as Div with id refs.
Allow multiple #+bibliography:.
Markdown reader:
Docx reader:
citations extension for docx reader (#7840). When enabled, Zotero, Mendeley, and EndNote citations embedded in a docx are parsed as native pandoc citations. (When disabled, the generated citation text and bibliography are passed through as regular text.) The bibliography generated by the plugin is suppressed. Instead, bibliographic data embedded in citation items is added to the references metadata field so that it can be used with --citeproc.Docbook writer:
<xref> elements. DocBook processors will generate appropriate cross-reference text when presented with an xref element.Docx writer:
Ipynb writer:
-- when smart enabled), so now we use the plain writer.LaTeX writer:
\CSLRightInline (#7932).scrreport to chaptersClasses (#6168, ivardb).page,trim,clip attributes on images (#7181).() after booktabs rules (#8001). These commands take optional arguments with () and [], which can lead to problems if the content of the table cell begins with these characters.RST writer:
HTML writer: performance improvements.
Org writer:
Markdown writer:
gfm_auto_identifiers extension is set (#7941).\. We now escape \ only if raw_tex is enabled or it is followed by a non-alphanumeric.JATS writer:
<etal/> (Albert Krewinkel). Citeproc adopted the BibTeX convention to use the author name “others” when there are additional authors that are not named. JATS uses the <etal> element for this.element_citations extension enabled, the references were put in a doubly-nested ref-list element (<ref-list><ref-list>...).EPUB writer: refactor for clarity (#7991, Jonathan Dönszelmann, Ola Wolska, Ivar de Bruin, Jaap de Jong).
Custom writer (Albert Krewinkel):
Text.Pandoc.Logging: add CouldNotParseIncludeFile constructor for LogMessage [API change].
Text.Pandoc.Shared:
ordNub as alias for nubOrd from containers package (#7963, Albert Krewinkel).ensureValidXmlIdentifiers. This function changes identifiers that don’t start with letters, and internal links to these identifiers, making them compatible with XML standards. The change is simple: we add id_ to the front. There is potential for duplication if there are already id_... identifiers defined, but this seems rare enough not to worry too much about.Ensure that valid XML identifiers are used in Docbook, EPUB, FB2, HTML4, S5, Slidy, Slideous, ICML, ODT, TEI writers. Thus, if you convert [anchor]{#1} and [link to](#1), id_1 will be used instead of 1 for the identifier.
Lua (Albert Krewinkel).
pandoc.layout to format and layout text.filter, map, and find_if. These previously required the argument to be of type function, which was too restrictive.Inlines instead of List.Sources to pandoc.read (#8002).Text.Pandoc.PDF:
wkhtmltopdf as default pdf engine for HTML (Albert Krewinkel).Text.Pandoc.MediaBag: improve detection of absolute paths (#7881).
Text.Pandoc.Extensions:
raw_tex extension from list of commonmark extensions, and from the commonmark_x defaults. commonmark doesn’t parse raw TeX, and it doesn’t make sense to write it if we don’t parse it.native_divs from allowed gfm extensions (#7965). This allows <div> to be suppressed using -raw_html. Previously native_divs was enabled but could not be suppressed, because it was not in the list of available extensions for commonmark-based formats.Text.Pandoc.Parsing:
Partition module into (internal) submodules (#7962, Albert Krewinkel).
Unify grid table parsing (#7971, Albert Krewinkel). Grid table parsing in Markdown and RST are updated use the same functions. Functions are generalized to meet requirements for both formats. This change also lays the ground for further generalizations in table parsers, including support for advanced table features. [API change] in Text.Pandoc.Parsing:
tableWith' and gridTableWith' are now a mf TableComponents instead of a quadruple of alignments, column widths, header rows and body rows.tableWith', TableComponents, TableNormalization, toTableComponents, toTableComponents'.Text.Pandoc.XML.Light: add versions of the parsers that allow specifying a custom entity map. Exports new functions: parseXMLElementWithEntities, parseXMLContentsWithEntities [API change].
Text.Pandoc.Writers.GridTable: improve module documentation (Albert Krewinkel).
Text.Pandoc.Parsing.GridTable: simplify column handling code (Albert Krewinkel).
Text.Pandoc.MIME: Add mime type for mkv extension (#7181).
Text.Pandoc.Asciify: Fix regression with ascii_identifiers and Turkish undotted i (#8003).
Relax upper bound for hslua, allow hslua-2.2. (#7929) Lua 5.4 is used by default after this is merged. Packagers may still include Lua 5.3 instead by building pandoc with --constraint='hslua <2.2'. Differences between 5.3 and 5.4 should not generally affect pandoc Lua filters. See list of incompatible changes here: https://www.lua.org/manual/5.4/manual.html#8.1
JATS template: allow multiple licenses (Albert Krewinkel).
LaTeX template:
\babelprovide if babel-lang is empty (#7945) to avoid an error.\usepackage{hyperref} to their header-includes to make it available there. (The redundant \usepackage will do no harm in this case.)\sout. This used to be necessary to avoid problems with hyperref, when headings contain strikeout text, but it does not seem to be necessary any more (tested).Tests: improve location reporting of failing tests (Albert Krewinkel).
Add tests for idempotency of makeSections (#7950).
Add armhf support in linux build script (#7944, Tony).
Use latest pandoc-types, so that toJSONFilter will work with Meta and MetaValue.
Use latest doclayout, texmath, commonmark, citeproc.
INSTALL.md: add reference to install via winget (#7951, Guriy Samarin).
MANUAL.txt:
smart works for html input.--self-contained does not work with --mathjax (#682).doc/org.md: remove obsolete citations section. This mostly described citation formats we no longer support.
doc/lua-filters.md: Fix typo (#7981, Mario Lang).
Makefile: Use cabal for default build
Add lua53 cabal flag. It is false by default. If set to true, compile with hslua 2.1 and Lua 5.3, otherwise hslua 2.2 and Lua 5.4.
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).
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
\fiDocx reader: Parse both Zotero citation and bibliography as FieldInfo (#7840).
LaTeX writer:
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:
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 Citations; 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).
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).
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:
Commonmark reader:
-f commonmark+sourcepos (#7769).Markdown reader:
^ at beginning of link or image label (#7723). This is reserved for footnotes. Fixes regression from 0a93acf.@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.inlinesInBalancedBrackets (commit fa83246), which caused regressions.Custom (Lua) readers:
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:
fancy_lists extension is enabled, alphabetical list markers are allowed, mimicking the behaviour of Org Mode when org-list-allow-alphabetical is enabled.#+ATTR_HTML: :width 100% (note the trailing spaces) are accepted.LaTeX reader:
\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.\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.panjabi -> punjabi in babel mappings (#7814).HTML reader:
Docx reader:
elemToParPart to return [ParPart] instead of ParPart. Also remove NullParPartconstructor, 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:
spacing="compact" is set, Para elements are turned into Plain, so we get a “tight” list.Markdown writer:
writeMarkua from Text.Pandoc.Writers.Markdown [API change] (#1871, Tim Wisotzki and Saumel Lemmenmeier).# (#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
endProvide 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:
panjabi -> punjabi in babel mappings (#7814).MediaWiki writer:
Docx writer:
Org writer:
Haddock writer:
Ipynb writer:
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:
JATS writer:
RTF writer:
Commonmark writer:
RST writer:
HTML writer:
--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.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.r-fit-text class to section. It must go on the header only.AsciiDoc writer:
OpenDocument writer:
vertical-rel to text rather than paragraph-content.JATS template (Albert Krewinkel):
<aff> element must come before any <email> element.articleauthoring output. Affiliations were xlinked 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.EPUB template:
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:
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:
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:
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.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):
pandoc.template module. The module provides a compile function to use strings as templates.pandoc.WriterOptions constructor.pandoc.write.PANDOC_WRITER_OPTIONS (#5221).Environment, instead of a ReaderOptions value [API change].Environment type is exported from Text.Pandoc.Filter and allows to combine ReaderOptions and WriterOptions in a single value [API change].PANDOC_WRITER_OPTIONS [API change].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).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.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.pandoc.read.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.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.Doc are no longer accepted as alternatives for Pandoc filter functions. This functionality was undocumented.from_simple_table #7776). Create truly empty table caption and body when these are empty in the simple table.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.pandoc.utils.stringify. Minor behavior change: plain strings nested in tables are now included in the result string.pandoc.utils.equals. The function is no longer required for element comparisons; it is now an alias for the == operator.pandoc.utils.references (#7752).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.blocks_to_inlines, make_sections. Ensures the returned lists have the correct type (Inlines and Blocks, respectively).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:
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.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 Lists.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.Citation objects, where setting a citation’s suffix modified it’s prefix, has been fixed.__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.
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:
<titleabbr> support (Rowan Rodrik van der Molen).<indexterm> (#7607, Rowan Rodrik van der Molen).LaTeX reader:
\autoref (#7693).\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:
<p> in list items (Albert Krewinkel). This prevents the generation of invalid output.<uri> to element-citation entries.HTML writer: Don’t create invalid data- attribute for empty attribute key (#7546).
LaTeX writer:
ancientgreek for grc.-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
lpeg, andrequire 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
pairs; andnil, 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.
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):
pandoc.path on startup (#7524). Previously the module always had to be loaded via require 'pandoc.path'.content property to Strikeout elements. Fixes a regression introduced in 2.15.caption property. Fixes a regression introduced in 2.15.pandoc.List properties.content property on Header elements.Allow tasty-bench 0.3.x.
Switch back from HsYAML to yaml for parsing YAML metadata (#6084). HsYAML is around 20 times slower in parsing large YAML bibliographies. In addition, HsYAML is not being actively maintained. This sets us back in our attempts to free ourselves from C dependencies (#4535). But I don’t see a good alternative until a faster pure Haskell parser is available. Notes:
Markdown writer: Ensure that special values are quoted in YAML metadata. These include “Y”, “yes”, “on”, and “off”, which are now (with yaml library) considered boolean values, as well as “null”.
Change JSON encodings of some types.
crlf, native.default-image-extension instead of readerDefaultImageExtension for field names.tex_math_dollars instead of Ext_tex_math_dollars as constructor.Extensions and an integer. (The integer representation is not supposed to be part of the public API.)tab-stop instead of optTabStop.Docx writer:
Lua (Albert Krewinkel, except as noted):
Use hslua module abstraction where possible.
Fix placement of tests for Block elements in pandoc module tests
Increase strictness when getting attribute keys
Re-add t and tag property to Attr values. Removal of these properties from Attr values was a regression.
Fix pandoc.utils.stringify regression. The pandoc.utils.stringify function returned empty strings when called with a string argument.
Fix a copy/paste bug in Lua marshalling code (John MacFarlane, #7639). This caused links to be changed to figures when Lua filters changed link properties.
Re-add content property to Link elements (#7647). This was a regression introduced in version 2.15.
Generate constants in module pandoc programmatically.
Marshal SimpleTable, ListAttributes, Citation, and Block values as userdata objects. Properties of Block values are marshalled lazily, which generally improves performance considerably. Script users may also notice the following differences:
.c field. The .c property now serves as an alias for .content, so some filter that used this undocumented method for property access may continue to work, while others will need to be updated and use proper property names.show method, and a __tostring metamethod. Both return the Haskell string representation of the element.userdata instead of table.Add a short guide to pandoc’s sources (Albert Krewinkel).
Fix epub files in epub reader tests, so that they are valid according to epubcheck (#7586).
Allow time 1.13.
Require latest skylighting (0.12.1).
Fix build on GHC 9.2 (Joseph C. Sible).
Fix trypandoc so it builds with aeson > 2.
Add --sandbox option (#5045).
--sandboxed is specified, readers won’t have access to the resource path, nor will anything have access to the user data directory.--self-contained: Fix bug that caused everything to be made a data URI (#7635, #7367). We only need to use data URIs in certain cases, but due to a bug they were being used always.
Pandoc will now fall back to latin1 encoding for inputs that can’t be read as UTF-8. This is what it did previously for content fetched from the web and not marked as to content type. It makes sense to do the same for local files. In this case a NotUTF8Encoded warning will be issued, indicating that pandoc is interpreting the input as latin1.
Markdown reader:
[link to (@a)](url) as a citation; similarly [(@a)]{#ident}. This is undesirable. One should be able to use example references in citations, and even if @a is not defined as an example reference, [@a](url) should be a link containing an author-in-text citation rather than a normal citation followed by literal (url).--strip-comments and list parsing (#7521). Use of --strip-comments was causing tight lists to be rendered as loose (as if the comment were a blank line).$(0,1]$) inside links, images, bracketed spans.--preserve-tabs (#7573). Previously they did not behave as the equivalent input with spaces would.DocBook reader:
linenumbering="numbered" on code blocks maps to the numberLines class internally.LaTeX reader:
\unit, \qty, \qtyrange, and \qtylist as synonynms of \si, \SI, \SIrange, and \SIlist.\^ followed by group closing (#7615).\vadjust sometimes takes “pre” (#7531).\endinput to current file (Simun Schuster).RST reader: handle escaped colons in reference definitions (#7568).
HTML reader:
Ipynb reader (Kolen Cheung):
raw_mimetype in addition to format. (format is what the spec calls for, but raw_mimetype is often used in practice; see jupyter/nbformat#229).rst.text/markdown, which is now a supported mime type for raw output (#7561).RTF reader:
\binN for binary image data.{\rtf1 ... } group.\pgdsc group. Otherwise we get style names treated as test.\* and bookmarks. We now ensure that groups starting with \* never cause text to be added to the document. In addition, bookmarks now create a span between the start and end of the bookmark, rather than an empty span.Docx reader:
instrText and no content, Pandoc didn’t understand these, causing other fields to be misunderstood because it seemed like a field was still open when it wasn’t.fldChar elements can contain other fields. Before, the nested fields would be ignored, except for the end, which would be considered the end of the parent field.Org reader:
:PROPERTIES: drawer to add to metadata (#7520).Docx writer:
native_numbering predictable (#7551). If the image has the id IMAGEID, then we use the id ref_IMAGEID for the figure number. This allows one to create a filter that adds a figure number with figure name, e.g. <w:fldSimple w:instr=" REF ref_superfig "><w:r><w:t>Figure X</w:t> </w:r></w:fldSimple>. If an image lack an id, an id of the form ref_fig1 is used.Ensure we have unique ids for wp:docPr and pic:cNvPr elements (#7527, #7503).
Handle SVG images (#4058). This change has several parts:
Powerpoint writer (Emily Bourke):
background-image attribute on the slide’s heading. Only the “stretch” mode is supported, and the background image is centred around the slide in the image’s larger axis, matching the observed default behaviour of PowerPoint.marL and indent values used for plain paragraphs and numbered lists, and changes the spacing defined in the reference doc master for bulleted lists. For paragraphs, there is now a left-indent taken from the otherStyle in the master. For numbered lists, the number is positioned where the text would be if this were a plain paragraph, and the text is indented to the next level. This means that continuation paragraphs line up nicely with numbered lists. Existing reference docs may need to be modified so that otherStyle and bodyStyle indent levels match, for this feature to work with them.rIds was inconsistent when making the presentation XML and when making the presentation relationships XML.notesMasterId.Asciidoc writer:
linesnum switch (Samuel Tardieu).-- in URLs (#7529).LaTeX writer:
header-includes to after babel setup so it can be modified.Markdown writer:
underline class rather than ul for underline. This only affects output with bracketed_spans enabled. The markdown reader parses spans with either .ul or .underline as Underline elements, but we’re moving towards preferring the latter.RST writer:
Properly handle anchors to ids with spaces or leading underscore (#7593). In this cases we need the quoted form, e.g.
.. _`foo bar`:
.. _`_foo`:Side note: rST will “normalize” these identifiers anyway, ignoring the underscore.
HTML writer:
\ref and \eqref as inline math, not display (see #7589).\ref and \eqref if MathJax is used (#7587).--reference-location for HTML output (#7461, Francesco Mazzoli).Native writer: Use pretty-show to format native output (#7580). Previously we used our own homespun formatting. But this produces over-long lines that aren’t ideal for diffs in tests. Performance is slower by about a factor of 10, but this isn’t really a problem because native isn’t suitable as a serialization format. (For serialization you should use json, because the reader is so much faster than native.)
Org writer:
Ipynb writer (Kolen Cheung):
raw_mimetype instead of format. Moreover, the mime-type of rst used in Jupyter deviated from that suggested by https://docutils.sourceforge.io/FAQ.html and is defined as text/restructuredtext when chosen from “Raw NBConvert Format” in Jupyter. The new behavior should matche the real world usage better, hence improving the round-trip “identity” in raw-cell.EPUB writer:
authority and term specific refinements to the subject tag. Specifying a plain subject tag in metadata will function as before.reveal.js template: Fix line numbers in source code (#7634). We need overflow: visible for these to work, and reveal’s default css disables this. So we re-enable it in the default template.
Text.Pandoc.Writers.Shared:
splitSentences as a Doc Text transform [API change]. Use this in man/ms. We used to attempt automatic sentence splitting in man and ms output, since sentence-ending periods need to be followed by two spaces or a newline in these formats. But it’s difficult to do this reliably at the level of [Inline].Text.Pandoc.Translations: small revisions for compatibility with aeson 2.
Don’t prepend file:// to --syntax-definition on Windows (#6374). This was a fix for a problem in skylighting, but this problem doesn’t exist now that we’ve moved from HXT to xml-conduit.
Text.Pandoc.Extensions:
Ext_footnotes to default gfm etxensions. Now gfm supports footnotes.--list-extensions).Text.Pandoc.Citeproc.Util: Better implementation of splitStrWhen. Previously the citeproc code had two less efficient implementations.
Update documentation for definition_list extension (#7594). In 2015, we relaxed indentation requirements for the first line of a definition (see commit d3544dc and issue #2087), but the documnentation wasn’t updated to reflect the change.
Text.Pandoc.Citeproc.BibTeX: Fix expansion of special strings in series e.g. newseries or library (#7591). Expansion should not happen when these strings are protected in braces, or when they’re capitalized.
Text.Pandoc.Logging: add NotUTF8Encoded constructor to LogMessage [API change].
Text.Pandoc.App.FormatHeuristics: remove .tei.xml extension for TEI (#7630). This never worked, because takeExtension only returns .xml. So it won’t be missed if we remove it.
Text.Pandoc.Image:
svgToPng to MonadIO.svgToPng, change first parameter from WriterOptions to Int.Text.Pandoc.Class:
readStdinStrict method to PandocMonad [API change].extractMedia [API change]. It was uselessly restricted to PandocIO, instead of any instance of PandocMonad and MonadIO.Text.Pandoc.Class.PandocIO: derive MonadCatch, MonadThrow, MonadMask. This allows us to use withTempDir [API change].
Add module Text.Pandoc.Class.Sandbox, defining sandbox. Exported via Text.Pandoc.Class. [API change]
Text.Pandoc.Filter: Generalize type of applyFilters from PandocIO to any instance of MonadIO and PandocMonad [API change].
Text.Pandoc.PDF: generalize type of makePDF: instead of PandocIO, it can be used in any instance of PandocMonad, MonadIO, and MonadMask [API change].
Lua subsystem and custom writers: generalize types from PandocIO to any instance of PandocMonad and MonadIO [API change]. The type of runLua is now
(PandocMonad m, MonadIO m) =>
LuaE PandocError a -> m (Either PandocError a)The change from Lua to LuaE PandocError is due to the switch to hslua-2.0; see next item.
Lua modules (Albert Krewinkel):
DoubleQuoted, SingleQuoted, DisplayMath, and InlineMath.pandoc.Span('test')[2] used to give pandoc.Str 'test', but yields nil now. This was undocumented behavior not intended to be used in user scripts. Use named properties instead..c to get a JSON-like tuple of all components no longer works. This was undocumented behavior.pandoc.AttributeList() constructor, which creates the associative attribute list that is used as the third component of Attr values. Values of this type can often be passed to constructors instead of Attr values.pandoc.pipe function (#7523).Text.Pandoc.PDF: Previously we had to run runIOorExplode inside withTempDir. Now that PandocIO is an instance of MonadMask, this is no longer necessary.
Text.Pandoc.App:
Text.Pandoc.App.OutputSettings: Generalize some types so we can run this with any instance of PandocMonad and MonadIO, not just PandocIO.
Use simpleFigure builder in readers and SimpleFigure pattern synonym in writers (Aner Lucero).
Allow time 1.12.
Use skylighting-0.12, skylighting-core-0.12. This fixes highlighting issues with typescript, scala, and other syntaxes that include keyword lists from different syntaxes.
Use citeproc 0.6, commonmark 0.2.2.1, commonmark-extensions 0.2.2, texmath 0.12.3.2, ipynb 0.1.0.2. (These changes also allow building with aeson >= 2.)
Require doclayout >= 0.3.1.1. This fixes recognition of “real widths” of emoji characters, which is important for tabular layout.
Cut out over 100K of fat in epub test golden files.
Make test/epub/wasteland.epub valid.
Add missing % on some command tests. This prevented --accept from working properly.
Command tests: raise error if command doesn’t begin with %.
OOXML tests: use pretty-printed form to display diffs. Otherwise everything is on one line and the diff is uninformative.
Fix compareXML helper in Tests.Writers.OOXML. Given how it is used, we were getting “mine” and “good” flipped in the test results.
MANUAL.txt:
attributes extension support (William Lupton).--reference-location.--slide-level=0 (Salim B).title-toc (#7171, Christophe Dervieux).doc/lua-filters.md:
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:
\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.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:
\global before \def, \let, etc. (#7494).\gdef and \xdef, which are global). In addition, environments must be treated as groups.\let.\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:
) was previously ignored when writing to pptx. This commit includes it in PowerPoint’s description of the image, along with the link.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:
\bin in \pict. According to the spec, this is not needed or wanted when the data is in hexadecimal format, as here.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:
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-linksText.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
Document use of the ‘underline’ class (#7492, #7484, William Lupton).
Add a FAQ about the “Cannot allocate memory” error on M1 macs.
Use texmath 0.12.3.1.
Use released citeproc 0.5.
Remove dependency on HTTP package (#7456, mt_caret).
Text.Pandoc.ImageSize: Add Tiff constructor for ImageType (#7405) [Minor API change]. This allows pandoc to get size information from tiff images.
Markdown reader: don’t try to read contents in self-closing HTML tag. Previously we had problems parsing raw HTML with self-closing tags like <col/>. The problem was that pandoc would look for a closing tag to close the markdown contents, but the closing tag had, in effect, already been parsed by htmlTag.
LaTeX reader:
\foreignlanguage{english} turned into <span lang="en-">. The same issue affected Arabic.\cline in LaTeX tables (#7442).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:
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:
data- prefix, it will be stripped. In particular, this preserves a data-external attribute as an external attribute in the pandoc AST.HTML writer:
aria-hidden when explicit alt text is provided (Aner Lucero).Docx writer:
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:
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:
$ characters in bibtex keys (#7409).deNote.--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.
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).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.emailAddress in Text.Pandoc.Parsing.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.\strut instead of ~ before \\ in empty line.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:
--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:
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:
pipe_tables to be disabled for commonmark formats (commonmark_x, gfm) (#7375).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:
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:
CONTRIBUTING.md: update modules overview (Albert Krewinkel).
using-the-pandoc-api.md: switch from String to Text (Albert Krewinkel).
Commonmark reader: Fix regression in 2.14 with YAML metdata block parsing, which could cause the document body to be omitted after metadata (#7339).
HTML reader: fix column width regression in 2.14 (#7334). Column widths specified with a style attribute were off by a factor of 100.
Markdown reader: in rebasePaths, check for both Windows and Posix absolute paths. Previously Windows pandoc was treating /foo/bar.jpg as non-absolute.
Text.Pandoc.Logging: In rendering LoadedResource, use relative paths.
Docx writer: fix regression on captions (#7328). The “Table Caption” style was no longer getting applied. (It was overwritten by “Compact.”)
Use commonmark-extensions 0.2.1.2
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
Sources as stream [API change].insertIncludedFileF. Give insertIncludedFile a more general type, allowing it to be used where insertIncludedFileF was.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:
@{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:
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:
LaTeX reader:
\xspace (#7299).\def macros. We previously set “verbatim mode” even for parsing the initial \def; this caused problems for \def nested inside another \def.\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:
<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.2*) in HTML column widths (#4063). See https://www.w3.org/TR/html4/types.html#h-6.6.DocBook/JATS readers:
DocBook reader: ensure that first and last names are separated (#6541).
Jira reader (Albert Krewinkel, #7218):
[alias|https://example.com|smart-card] syntax.{noformat}.file: schema is no longer allowed in bare links; these rarely make sense.Plain writer: handle superscript unicode minus (#7276).
LaTeX writer:
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.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:
HTML writer:
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.<header> as a Div (Albert Krewinkel).Org writer:
JATS writer (Albert Krewinkel):
content-type and the span is put inside a <named-content> element. Otherwise a <styled-content> element is used instead.<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).<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.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:
w:proofState for spelling or grammar to dirty, so that spell/grammar checking will be triggered on the generated docx.zoom, embedSystemFonts, doNotTrackMoves, defaultTabStop, drawingGridHorizontalSpacing, drawingGridVerticalSpacing, displayHorizontalDrawingGridEvery, displayVerticalDrawingGridEvery, characterSpacingControl, savePreviewPicture, mathPr, themeFontLang, decimalSymbol, listSeparator, autoHyphenation, compat.rsids from default settings.xml. Word will add these when revisions are made.Ms writer: Handle tables with multiple paragraphs (#7288). Previously they overflowed the table cell width. We now set line lengths per-cell and restore them after the table has been written.
Markdown writer:
@{..} syntax for citations when needed.# (see #6259).@. 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:
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.ConTeXt template:
enumerate itemgroup (#5016, Denis Maier).reveal.js template:
toc-title (#7171, Florian Kohrt).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:
Text key instead of [FilePath]. We normalize the path and use / separators for consistency.MediaItem type [API change].MediaBag type to a map from Text to MediaItem [API change].lookupMedia now returns a MediaItem [API 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:
fetchMediaResource [API change]. Use fetchItem to get resources in fillMediaBag.downloadOrRead indicating what path local resources have been loaded from.Text.Pandoc.Logging:
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:
entry-spacing won’t work when such Divs are used.lang for the lang parameter of citeproc, overriding localeLanguage.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:
splitAt' was dropped. This commit reinstates it and uses it to make splitTextByInstances char-width sensitive.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:
lang and bibliography sorting.institute variable works for HTML-based slides.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!
Use smaller images in tests, reducing the size of the source tarball by 8 MB.
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:
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).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.compactDL.Text.Pandoc.Parsing:
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.F type synonym [API change]. Muse and Org were defining their own F anyway.Text.Pandoc.Readers.Metadata:
yamlMetaBlock [API change].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):
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:
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.w:tblW (#7141).Jira writer (Albert Krewinkel):
bq. if they do not contain a linebreak.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:
getExecutablePath from base, avoiding the dependency on executable-path.setupEnvironment in Helpers, to avoid code duplication.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:
+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.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.
--resource-path now accumulates if specified multiple times (#6152). Resource paths specified later on the command line are prepended to those specified earlier. Thus, --resource-path foo --resource-path bar:baz is equivalent to --resource-path bar:bas:foo. (The previous behavior was for the last --resource-path to replace all the rest.) resource-path in defaults files behaves the same way: it will be prepended to the resource path set by earlier command line options or defaults files. This change facilitates the use of multiple defaults files: each can specify a directory containing resources it refers to without clobbering the resource paths set by the others.
Allow defaults files to refer to the home directory, the user data directory, and the directory containing the defaults file itself (#5871, #5982, #5977). In fields that expect file paths (and only in these fields),
${VARIABLE} will expand to the value of the environment variable VARIABLE (and in particular ${HOME} will expand to the path of the home directory). A warning will be raised for undefined variables.${USERDATA} will expand to the path of the user data directory in force when the defaults file is being processed.${.} will expand to the directory containing the defaults file. (This allows default files to be placed in a directory containing resources they make use of.)When downloading content from URL arguments, be sensitive to the character encoding (#5600). We can properly handle UTF-8 and latin1 (ISO-8859-1); for others we raise an error. Fall back to latin1 if no charset is given in the mime type and UTF-8 decoding fails.
Allow abbreviations that don’t end in a period to be specified using --abbreviations (#7124).
Add new unexported module Text.Pandoc.XML.Light, as well as Text.Pandoc.XML.Light.Types, Text.Pantoc.XML.Light.Proc, Text.Pandoc.XML.Light.Output. (Closes #6001, #6565, #7091).
This module exports definitions of Element and Content that are isomorphic to xml-light’s, but with Text instead of String. This allows us to keep most of the code in existing readers that use xml-light, but avoid lots of unnecessary allocation.
We also add versions of the functions from xml-light’s Text.XML.Light.Output and Text.XML.Light.Proc that operate on our modified XML types, and functions that convert xml-light types to our types (since some of our dependencies, like texmath, use xml-light).
We export functions that use xml-conduit’s parser to produce an Element or [Content]. This allows existing pandoc code to use a better parser without much modification.
The new parser is used in all places where xml-light’s parser was previously used. Benchmarks show a significant performance improvement in parsing XML-based formats (with docbook, opml, jats, and docx almost twice as fast, odt and fb2 more than twice as fast).
In addition, the new parser gives us better error reporting than xml-light. We report XML errors, when possible, using the new PandocXMLError constructor in PandocError.
These changes revealed the need for some changes in the tests. The docbook-reader.docbook test lacked definitions for the entities it used; these have been added. And the docx golden tests have been updated, because the new parser does not preserve the order of attributes.
DocBook reader:
informalfigure (#7079) (Nils Carlson).Docx reader:
HTML reader:
NamedTag(..) [API change]. This was just intended to smooth over the transition from String to Text and is no longer needed.isInlineTag and isBlockTag are no longer polymorphic; they apply to a Tag Text [API change].src attribute in iframe (#7099). If src is empty, we simply skip the iframe. If src is invalid or cannot be fetched, we issue a warning nd skip instead of failing with an error.JATS reader:
LaTeX reader:
tokenize, untokenize [API change]. These are internal implementation details, which were only exported for testing. They don’t belong in the public API.withRaw so it doesn’t rely on fragile assumptions about token positions (which break when macros are expanded) (#7092). This requires the addition of sEnableWithRaw and sRawTokens in LaTeXState, and a new combinator disablingWithRaw to disable collecting of raw tokens in certain contexts. Add parseFromToks to Text.Pandoc.Readers.LaTeX.Parsing. Fix parsing of single character tokens so it doesn’t mess up the new raw token collecting. These changes slightly increase allocations and have a small performance impact.satisfyTok, avoiding unnecessary macro expansion steps. Benchmarks after this change show 2/3 of the run time and 2/3 of the allocation of the Feb. 10 benchmarks.sExpanded in state. This isn’t actually needed and checking it doesn’t change anything.braced'. Remove the parameter, have it parse the opening brace, and make it more efficient.& in \verb (#7129).Make Text.Pandoc.Readers.LaTeX.Types an unexported module [API change].
Markdown reader:
OPML reader:
ODT reader:
Org reader:
task_lists extension (Albert Krewinkel, #6336).RST reader:
getTimestamp instead of getCurrentTime to fetch timestamp. Setting SOURCE_DATE_EPOCH will allow reproducible builds.Jira reader:
Text.Pandoc.Shared
splitByIndices, splitStringByIndicies, substitute, and underlineSpan (which had been deprecated in April 2020) [API change].handleTaskListItem (Albert Krewinkel) [API change].defaultUserDataDirs to defaultUserDataDir [API change]. We determine what is the default user data directory by seeing whether the XDG directory and/or legacy directory exist.BibTeX writer:
--wrap and --columns (#7068).CSL JSON writer:
[] if no references in input, instead of raising a PandocAppError as before.Docx writer:
getTimestamp instead of getCurrentTime for timestamp. Setting SOURCE_DATE_EPOCH will allow reproducible builds.EPUB writer:
getTimestamp instead of getCurrentTime for timestamp. Setting SOURCE_DATE_EPOCH will allow reproducible builds (#7093). This does not suffice to fully enable reproducible in EPUB, since a unique id is still being generated for each build.belongs-to-collection metadata (#7063) (Nick Berendsen).JATS writer:
Jira writer:
{noformat} instead of {code} for unknown languages (Albert Krewinkel). Code blocks which are not marked as a language supported by Jira are rendered as preformatted text via {noformat} blocks.LaTeX writer:
\vadjust pre so that the hypertarget takes you to the beginning of the paragraph rather than one line down. This makes a particular difference for links to citations using --citeproc and link-citations: true.jp to ja (Mauro Bieg, #7047).Markdown writer:
$ right before a digit, which pandoc will not recognize as a math delimiter.ODT writer:
getTimestamp instead of getCurrentTime for timestamp. Setting SOURCE_DATE_EPOCH will allow reproducible builds.reference.odt in light of this change.Org writer:
task_lists extension (Albert Krewinkel, #6336).Pptx writer:
getTimestamp instead of getCurrentTime for timestamp. Setting SOURCE_DATE_EPOCH will allow reproducible builds.JATS templates: tag author.name as string-name (Albert Krewinkel). The partitioning the components of a name into surname, given names, etc. is not always possible or not available. Using author.name allows to give the full name as a fallback to be used when author.surname is not available.
Add default templates for bibtex and biblatex, so that the variables header-include, include-before, include-after (or alternatively the command line options --include-in-header, --include-before-body, --include-after-body) may be used.
LaTeX template:
revealjs template: Add ‘center’ option for vertical slide centering. (maurerle, #7104).
Text.Pandoc.XML: Improve efficiency of fromEntities.
Text.Pandoc.MIME
getCharset [API change].Text.Pandoc.UTF8: change IO functions to return Text, not String [API change]. This affects readFile, getContents, writeFileWith, writeFile, putStrWith, putStr, putStrLnWith, putStrLn. hPutStrWith, hPutStr, hPutStrLnWith, hPutStrLn, hGetContents. This avoids the need to uselessly create a linked list of characters when emiting output.
Text.Pandoc.App
parseOptionsFromArgs [API change, new exported function].Opt [API change]: optCSL, optbibliography, optCitationAbbreviations.Text.Pandoc.Citeproc.BibTeX
Text.Pandoc.Citeproc.writeBibTeXString now returns Doc Text instead of Text (#7068).pages (= page in CSL) (#7067).langid (= language in CSL, #7067).raw_tex extension; this should be fixed).Text.Pandoc.Citeproc.MetaValue
Text.Pandoc.Citeproc
Text.Pandoc.Class
getTimestamp [API change]. This attempts to read the SOURCE_DATE_EPOCH environment variable and parse a UTC time from it (treating it as a unix date stamp, see https://reproducible-builds.org/specs/source-date-epoch/). If the variable is not set or can’t be parsed as a unix date stamp, then the function returns the current date.Text.Pandoc.Error
PandocUnsupportedCharsetError constructor for PandocError [API change].renderError [API change].handleError to use renderError. This allows us render error messages without exiting.Text.Pandoc.Extensions
Ext_task_lists is now supported by org (and turned on by default) (Albert Krewinkel, #6336).Ext_fenced_code_attributes from allowed commonmark attributes (#7097). This attribute was listed as allowed, but it didn’t actually do anything. Use attributes for code attributes and more.Lua subsystem:
pandoc and pandoc.List are now always loaded from the system’s default data directory. Loading from a different directory by overriding the default path, e.g. via --data-dir, is no longer supported to avoid unexpected behavior and to address security concerns.Text.Pandoc.PDF
smart extension when building PDF via LaTeX. This is to prevent accidental creation of ligatures like ?` and !` (especially in languages with quotations like German), and similar ligature issues. (See jgm/citeproc#54.)Text.Pandoc.CSV:
Test suite:
findPandoc that attempts to locate it relative to the test executable (which can be located using findExecutablePath). But the logic here is delicate and work with every combination of options. To solve both problems, we add an --emulate option to the test-pandoc executable. When --emulate occurs as the first argument passed to test-pandoc, the program simply emulates the regular pandoc executable, using the rest of the arguments (after --emulate). Thus, test-pandoc --emulate -f markdown -t latex is just like pandoc -f markdown -t latex. Since all the work is done by library functions, implementing this emulation just takes a couple lines of code and should be entirely reliable. With this change, we can test the pandoc executable by running the test program itself (locatable using findExecutablePath) with the --emulate option. This removes the need for the fragile findPandoc step, and it means we can run our integration tests even when we’re just building the library, not the executable. [Note: part of this change involved simplifying some complex handling to set environment variables for dynamic library paths. I have tested a build with --enable-dynamic-executable, and it works, but further testing may be needed.]test function.Documentation: Update URLs and use https where possible (#7122, Salim B).
Add doc/libraries.md, a description of libraries that support pandoc.
MANUAL.txt
tex_math_dollars extension. Note that no blank lines are allowed between the delimiters in display math.Makefile: in make bench, create CSV files for comparison and compare against previous benchmark run. Add timestamp to CSV filenames.
cabal.project: don’t explicitly set -trypandoc. If we do, this can’t be overridden on the cabal command line.
doc/lua-filters.md: improve documentation for pandoc.mediabag.insert, pandoc.mediabag.fetch, directory, normalize (Albert Krewinkel).
Allow base64-bytestring-1.2.* (Dmitrii Kovanikov)
Require jira-wiki-markup 1.3.3 (Albert Krewinkel)
Require citeproc 0.3.0.8, which correctly titlecases when titles contain non-ASCII characters.
Use skylighting 0.10.4. This version of skylighting uses xml-conduit rather than hxt. This speeds up parsing of XML syntax definitions fourfold, and removes four packages from pandoc’s dependency graph: hxt-charproperties, hxt-unicode, hxt-regex-xmlschema, hxt.
Add script tools/parseTimings.pl to help pin down which modules take the most time and memory to compile.
Avoid unnecessary use of NoImplicitPrelude pragma (#7089) (Albert Krewinkel)
Benchmarks
trypandoc: add 2 second timeout.
Use -split-sections in creating linux release binary. This reduces executable size significantly (by about 30%).
Remove weigh-pandoc. It’s not really useful any more, now that our regular benchmarks include data on allocation.
Improve linux package build process and add script to automate building an arm64 binary package.
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:
DONE and FINISHED are states with no further action required: #+TODO: UNFINISHED | DONE | FINISHED.verbatim (Dimitri Sabadie, #6998).LaTeX reader:
filecontents environment (#7003).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:
New module Text.Pandoc.Writers.BibTeX, exporting writeBibTeX and writeBibLaTeX. [API change]
LaTeX writer:
\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:
Format "html4", Format "html5" as raw HTML.Ms writer:
JATS writer:
<element-citation> if element_citations extension is enabled (Albert Krewinkel).<disp-quote> is always wrapped in <p> (#7041).Markdown writer:
gfm, commonmark, and commonmark_x as raw formats.RST writer:
Docx writer:
Commonmark writer:
HTML writer:
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:
Ext_element_citations constructor (Albert Krewinkel).Text.Pandoc.Citeproc.BibTeX: New unexported function writeBibtexString.
Text.Pandoc.Citeproc:
getStyle [API change].getReferences [API change, #7106].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:
-L/--lua-filter.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).
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.)
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:
lang attributes on body element (#6938). These (as well as lang attributes on the html element) should update lang in metadata.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:
specFor."" to avoid clutter in sourcepos output.Org reader:
#+LANGUAGE into lang metadata field (#6845, Albert Krewinkel).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:
fo stylesheets through an XML processing instruction, <?dbfo table-width="50%"?>.LaTeX reader:
], e.g. quotes, we return a plain string with the option contents. Previously we mistakenly included the brackets in this string.center environment are put in a Div with class center.\rule with width 0 as horizontal rule. These are sometimes used as spacers in LaTeX.Dokuwiki reader:
faquk>FAQ-mathml. This at least gives users the ability to modify the links using filters.Markdown writer:
RST writer:
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:
ICML writer:
LaTeX writer:
\strut that was added at the end of minipage environments in cells. Replace \tabularnewline with \\ \addlinespace.csl- display Spans (#6921).OpenDocument writer:
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:
Docbook writer:
xml:id instead of id.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.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:
csl- display spans (#6921). Previously inner Spans used to represent CSL display attributes were not rendered as div tags as intended.EPUB writer:
--toc is specified.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:
csquotes package if csquotes variable set.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.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:
Ext_sourcepos constructor for Extension [API change].Ext_xrefs_name and Ext_xrefs_number constructors for Extension (Nils Carson) [API change].Text.Pandoc.Citeproc:
[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.fetchItem to get external bibliography (#6940).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:
Text.Pandoc.CSS:
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).
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:
@foo [p. 33; @bar], the p. 33 would be incorrectly parsed as a prefix of @bar rather than a suffix of @foo.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:
getNextNumber from Readers.LaTeX to Readers.LaTeX.Parsing.\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:
<table> elements are put inside <table-wrap> elements, as the former are not valid as immediate child elements of <body>.Org writer:
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:
ATXHeadingInLHS to LogMessage [API change].EnvironmentVariableUndefined 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 -pthreadRemove obsolete bibutils flag setting in linux/make_artifacts.sh.
Manual:
link-citation -> link-citations.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).
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).
DocBook Reader: fix duplicate bibliography bug (#6773, Nils Carlson).
HTML reader:
raw_html is set in the reader (in which case the svg is passed through as raw HTML) (#6770).LaTeX reader:
\cL is defined as \mathcal{L}, and \til as \tilde{#1}, then \til\cL should expand to \tilde{\mathcal{L}}, but pandoc was expanding it to \tilde\mathcal{L}. This is fixed by parsing the arguments in “verbatim mode” when the macro expands arguments at the point of use.\blockquote from csquotes (#6802).LaTeX writer: Improved calculation of table column widths. We now have LaTeX do the calculation, using \tabcolsep. So we should now have accurate relative column widths no matter what the text width. The default template has been modified to load the calc package if tables are used.
HTML writer: Fix duplicate “class” attribute for table rows (Andy Morris).
Text.Pandoc.Filter: allow shorter YAML representation of Citeproc (Albert Krewinkel). The map-based YAML representation of filters expects type and path fields. The path field had to be present for all filter types, but is not used for citeproc filters. The field can now be omitted when type is “citeproc”, as described in the MANUAL.
Text.Pandoc.Error: Add PandocBibliographyError constructor for PandocError [API change]. This ensures that bibliography parsing errors generate messages that include the bibliography file name – otherwise it can be quite mysterious where it is coming from.
Citeproc: properly handle csl field with data: URI (#6783). This is used with the JATS writer, so this fixes a regression in pandoc 2.11 with JATS output and citeproc.
Allow citation-abbreviations in defaults file.
JATS templates: ensure jats_publishing output is valid (Albert Krewinkel).
LaTeX template: Fix CSLRightInline, so that it does not run over the right margin.
HTML template: default CSS tweaks (Mauro Bieg and John MacFarlane).
monobackgroundcolor variable, making the background color and padding of code optional.line-height: 1 for table cells.man template: Change comment that triggers tbl from .\"t to '\" t, as specified in groff_man(7) (#6803).
Use latest commonmark, commonmark-extensions. This fixes a bug with nested blocks in footnotes with the footnote extension to commonmark. See jgm/commonmark-hs#63.
Citeproc: use comma for in-text citations inside footnotes. When an author-in-text citation like @foo occurs in a footnote, we now render it with: AUTHOR NAME + COMMA + SPACE + REST. Previously we rendered: AUTHOR NAME + SPACE + "(" + REST + ")". This gives better results. Note that normal citations are still rendered in parentheses.
Use latest citeproc:
Clarify manual on --track-changes (#6801).
Add doc/jats.md to document pandoc’s handling of JATS (#6794, Albert Krewinkel).
Fix code example in lua-filters.md (#6795).
Commonmark writer: fix regression with fenced divs (#6768). Starting with 2.10.1, fenced divs no longer render with HTML div tags in commonmark output. This is a regression due to our transition from cmark-gfm. This commit fixes it.
Use released version of citeproc. (This fixes a mis-step in the 2.11.0.3 release, which is now deprecated.)
Use latest sylighting, with support for groovy.
Document that –html-q-tags requires the smart extension on the reader (#6766).
Use latest citeproc (closes #6765). This fixes a problem with author-in-text citations for references including both an author and an editor. Previously, both were included in the text, but only the author should be.
With --citeproc, ensure that the final period is removed when citations that occur in notes in note-based styles get put in parentheses. See jgm/citeproc#20.
Normalize rewritten image paths with --extract-media (#6761). This change will avoid mixed paths like this one when --extract-media is used with a Word file: . Instead we’ll get .
Modify --version output. Use space more efficiently and report the citeproc and ipynb versions, along with skylighting, texmath, and pandoc-types. Drop the word “default” before “user data directory.”
DocBook reader: bibliomisc and anchor support (#6754, Nils Carlson). Also ensure that bibliodiv without a title no longer results in an empty Header.
ConTeXt template: adds \setupinterlinespace to fonts larger than normal (#6763, Denis Maier).
LaTeX template: Do not load amssymb if not needed (#6469, Angelo Peronio). See https://tex.stackexchange.com/a/549938.
Relax upper bound on hslua, allow hslua-1.3.* (Albert Krewinkel).
MANUAL:
Fix handling of xdata in bibtex/biblatex bibliographies (#6752).
Fix some small typos in the API documentation (#6751, Michael Hoffmann).
Require citeproc 0.1.0.2. This fixes a regression from pandoc-citeproc involving spacing between components of a reference in certain styles (e.g. cell.csl).
Fix typos in comments, doc strings, error messages, and tests (Albert Krewinkel, #6738).
LaTeX reader: support more acronym commands (#6746): \acl, \aclp, and capitalized versions of already supported commands.
Commonmark reader: add pipe_table extension after defaults (#6739). Otherwise we get bad results for non-table, non-paragraph lines containing pipe characters.
Markdown writer: Fix autolinks rendering for gfm (#6740). Previously, autolinks rendered as raw HTML, due to the class="uri" added by pandoc’s markdown reader.
LaTeX writer:
lang pt-BR (#2953). For polyglossia we now use \setmainlanguage[variant=brazilian]{portuguese} and for babel \usepackage[shorthands=off,main=brazilian]{babel}.Depend on latest citeproc (0.1.0.1).
default.latex: fix CSLReference macro definition.
Fix MANUAL.txt CSL JSON conversion examples.
Fix spelling errors in changelog, MANUAL.txt, doc/org.md (#6738).
Add --citeproc (-C) option to trigger built-in citation processing. It is no longer necessary to use the external pandoc-citeproc filter. --citeproc behaves like a filter and can be positioned relative to other filters as they appear on the command line.
The new built-in citation processing uses the citeproc library, a reimplementation of CSL citation processing that fixes many of the shortcomings of pandoc-citeproc. In general, citation processing should work much the same as it did with pandoc-citeproc, but with greater fidelity to CSL styles and better performance. (The tests from the pandoc-citeproc package have been carried over to pandoc.) The following differences should be noted:
At this point, only some of the writers (HTML, ms, LaTeX) properly interpret CSL display styles. You should get decent output in all formats (at least as good as with pandoc-citeproc), but indentation and block-alignment may not be right.
pandoc-citeproc searches the ~/.csl directory for .csl styles. Pandoc instead searches the csl subdirectory of the pandoc user data directory (e.g., ~/.pandoc/csl or ~/.local/share/pandoc/csl). Users who already keep CSL styles in ~/.csl may find it convenient to add a symlink.
Some of the bibliography formats supported by pandoc-citeproc (via hs-bibutils) are no longer supported: Copac, EndNote, ISI, MEDLINE, MODS, and RIS. If you use one of these formats, you may use the bibutils utility to convert to BibLaTeX. We now support only BibTeX, BibLaTeX, CSL JSON, and pandoc’s YAML/Markdown analogue of CSL JSON.
pandoc-citeproc would always retrieve the independent parent of a dependent style by doing an HTTP request. pandoc will now first seek the independent parent locally (in the resource path or in the csl subdirectory of the pandoc user data directory) before resorting to HTTP. In addition, you may omit the .csl extension, e.g. --csl zoology.
Using the --bibliography option (or including bibliography in YAML metadata) no longer triggers citation processing implicitly: one must always use the --citeproc option if citation processing is wanted.
Add csljson as and input and output format. This allows pandoc to convert between csljson and other bibliography formats (e.g. -f csljson -t markdown -s or -f bibtex -t csljson), and to generate formatted versions of CSL JSON bibliographies (e.g., pandoc -f csljson --citeproc pl.json -o pl.pdf).
Added bibtex, biblatex as input formats. This allows pandoc to convert between BibLaTeX and BibTeX and other bibliography formats, and to generated formatted versions of BibTeX/BibLaTeX bibliographies (e.g., pandoc -f biblatex --citeproc pl.bib -o pl.pdf).
Raise informative errors when YAML metadata parsing fails (#6730). Previously the command would succeed, returning empty metadata, with no errors or warnings.
Sort languages in --list-highlight-languages output (#6718, Albert Krewinkel). Languages were previously sorted by their long name, which leads to unexpected results).
Add CSS to default HTML template (#6601, Mauro Bieg). This greatly improves the default typography in pandoc’s HTML output. The CSS is sensitive to a number of variables (e.g. mainfont, fontsize, linestretch): see the manual for details. To restore the earlier, more spartan output, you can disable this with -M document-css=false.
Support --toc-depth option for ODT writer (#6696, niszet).
Fix issues with Windows UNC paths with some options (#5127).
Remove fenced_code_blocks and backtick_code_blocks from allowed commonmark and gfm extensions. These shouldn’t really be counted as extensions, because they can’t be disabled in commonmark. Adjust markdown writer to check for the commonmark variant in addition to extensions.
Add these extensions to gfm and commonmark: fenced_code_blocks, backtick_code_blocks, fenced_code_attributes. These can’t really be disabled in the reader, but they need to be enabled in the writer or we just get indented code.
Make sure proper set of extensions is recognized for commonmark_x.
Allow gfm_auto_identifiers, ascii_identifiers extensions for docx.
Markdown reader:
Maybe FilePath parameter to yamlToMeta [API change].yamlToRefs [API change], a version of yamlToMeta specialized to references.citationNoteNum accurately in citations.LaTeX reader:
squared, cubed, tothe in siunitx (#6657).\newtheorem (#6734). Previously we were just treating it as a string and ignoring accents and formatting.\multirow and \multicolumn table cells (#6603, Laurent P. René de Cotret).SIRange to SIrange (#6617, Emerson Harkin).\author (#6324).DocBook reader:
JATS reader:
RST reader:
.. class:: directly to following Header rather than creating a surrounding Div (#6699).Docx reader:
Markdown writer:
Asciidoc writer:
LaTeX writer:
\item[].HTML writer:
doc-biblioentry role.ICML writer:
Docx writer:
Org writer:
OpenDocument writer:
Add Text.Pandoc.Citeproc module, exporting processCitations [API change]. This depends on several other, unexported modules under Text.Pandoc.Citeproc.
Add module Text.Pandoc.Writers.CslJson, exporting writeCslJson. [API change]
Add module Text.Pandoc.Readers.CslJson, exporting readCslJson. [API change]
Add module Text.Pandoc.Readers.BibTeX, exporting readBibTeX and readBibLaTeX. [API change]
Text.Pandoc.Filter: Add CiteprocFilter constructor to Filter. [API change] This runs the processCitations transformation. We need to treat it like a filter so it can be placed in the sequence of filter runs (after some, before others). In FromYAML, this is parsed from citeproc or {type: citeproc}, so this special filter may be specified either way in a defaults file (or by citeproc: true, though this gives no control of positioning relative to other filters).
Add new exported module Text.Pandoc.Writers.AnnotatedTable [API change] (#6655, Christian Despres). This module (which should generally be imported qualified to avoid name conflicts) provides a Table type that mirrors the structure of a pandoc Table, but with added inferred information so that the writers do not have to lay out tables themselves. The toTable and fromTable functions convert between an annotated Table and a regular pandoc Table. In addition to producing a Table with coherent and well-formed annotations, the toTable function also normalizes its input table like the table builder does. Tests ensure that toTable normalizes tables exactly like the table builder, and that its annotations are coherent.
Text.Pandoc.Logging:
CouldNotParseYamlMetadata constructor for LogMessage [API change].CiteprocWarning constructor to LogMessage [API change].Text.Pandoc.Readers.Metadata: export yamlBsToRefs [API change]. These allow specifying an id filter so we parse only references that are used in the document.
Text.Pandoc.Parsing:
stateInNote and stateNoteNumber to ParserState [API change]. These are used to populate note numbers for citation processing.Fix apparent typos in sample.lua (#6729, William Lupton). Also make the writer less aggressive in escaping quotes.
Text.Pandoc.Options:
defaultMathJaxURL: use tex-chtml-full instead of tex-mml-chtml (#6599, Kolen Cheung). This drops the MathML support (which we don’t need for HTML math rendering) and includes the full JavaScript, which makes it possible to use --self-contained (though there may still be issues if the required math fonts aren’t available). This change should also reduce latency in pages with lots of formulas./tex-chtml-full.js to defaultMathJaxURL (#6593) Previously we added this in processing command line options, but not in processing defaults files, which was inconsistent.epub.css: Fix cover page selectors and add note explaining their use (#6649, a-vrma).
Add data files needed for Text.Pandoc.Citeproc: these include default.csl in the data directory and a citeproc directory that is only used at compile-time for biblatex localizations. Note that we’ve added file-embed as a mandatory rather than a conditional dependency, because of the biblatex localization files.
Lua filters:
Add SimpleTable for backwards compatibility (#6575, Albert Krewinkel). A new type SimpleTable is made available to Lua filters. It is similar to the Table type in pandoc versions before 2.10; conversion functions from and to the new Table type are provided. Old filters using tables now require minimal changes and can use, e.g.,
if PANDOC_VERSION > {2,10,1} then
pandoc.Table = pandoc.SimpleTable
endand
function Table (tbl)
tbl = pandoc.utils.to_simple_table(tbl)
…
return pandoc.utils.from_simple_table(tbl)
endto work with the current pandoc version.
Make attr argument optional in Table constructor (Albert Krewinkel). This changes the Lua API. It is highly unlikely for this change to affect existing filters, since the documentation for the new Table constructor (and type) was incomplete and partly wrong before. The Lua API is now more consistent, as all constructors for elements with attributes now take attributes as the last parameter.
MANUAL.txt:
selnolig.seriespage (#6568, Blake Eryx).--list-extensions=FORMAT.doc/lua-filters.md:
body field (Albert Krewinkel).doc/org.md:
CONTRIBUTING.md: fix typo (#6584, Dmitry Volodin).
Use golden test framework for command tests. This means that --accept can be used to update expected output.
Use the smart extension when generating pandoc’s man page (#6613).
Release-candidate: don’t build windows i386. So far we haven’t been able to figure out how to get stack to use a 32-bit ghc.
Use null instead of deprecated Builder.isNull.
Makefile:
Remove duplicated dependency in pandoc.cabal (#6591, Felix Yan).
Sort build depends in pandoc.cabal alphabetically (#6691, Albert Krewinkel).
Add .travis.yml for macos release candidate build (#6622). We need to build the release candidate on Travis rather than GitHub actions, because GH has macos 10.15, and binaries compiled on that OS will not work with 10.13. This build is only triggered on rc/* branches.
Remove instructions for building pandoc-citeproc from CI and release binary build instructions. We will no longer distribute pandoc-citeproc.
Fix math rendering in trypandoc (this broke after commit d8ad766d17603784b86fc5c2e1b22864125d04d1).
Use latest versions of skylighting, commonmark (#6589), comonmark-extensions, commonmark-pandoc, texmath.
Relax version bounds for hslua, hslua-module-text, bytestring.
Use released pandoc-types 1.22. This changes the JSON encoding slightly for the new table types introduced in 1.21, so they’re more consistent with the rest. Developers of libraries for pandoc filters will want to take note.
Fix hlint suggestions, update hlint.yaml (#6680, Christian Despres).
Code cleanup (#6678, Joseph C. Sible).
Add haddocks to functions in Text.Pandoc.Writers.Shared (Albert Krewinkel).
Remove duplicate tshow definition.
Linux release candidate build: use ghc-musl container. This simplifies our build process (over using a customized alpine container).
Add commonmark_x output format. This is commonmark with a number of useful pandoc extensions enabled.
Many more extensions now work with commonmark and gfm.
Add generic attributes extension. This allows attributes to be added to any block or inline element in a uniform way. Since the Pandoc AST doesn’t include attributes on each element type, the attributes will sometimes be added by creating a surrounding Div or Span container. Currently this extension is only compatible with the commonmark and gfm readers.
To add an attribute to a block-level element, e.g. a paragraph, put it before the block:
{#mypara}
This is a paragraph.Multiple attributes may be used and will be combined:
{#mypara}
{.blue .warning key="val"}
This is a paragraph.To add an attribute to an inline-level element, put it immediately after the element:
*emphasized text*{.special}Support --number-sections for docx output (#1413).
LaTeX reader:
\SIRange reader (#6418, Emerson Harkin).\multirow and \multicolumn.\newtheorem, \theoremstyle, and theorem and proof environments, including labels and references. The only thing that is unsupported is the second optional argument, which causes numbering to be reset after the specified series is incremented.RST reader:
Commonmark reader:
commonmark and gfm.DocBook reader:
Docx reader:
bCs/iCs on runs with rtl or cs property (#6514, Nikolay Yakimov).Org reader (Albert Krewinkel):
\alpha, can be disabled with the #+OPTION: e:nil export setting (Albert Krewinkel).#+OPTION: f:nil export setting.#+OPTION: |:nil export setting.Markdown writer:
asciify out of escapeString. Otherwise unsmartify doesn’t catch quotes that have already been turned to entities.writeCommonmark (new exported function, API change).superscript or subscript extension or raw_html aren’t available.table_caption extension is not enabled.Commonmark writer:
writeCommonmark from the Markdown writer. This function calls the markdown writer with appropriate extensions and a few small modifications (e.g. not requiring backslashes before spaces inside super/subscripts). With this change comonmark and gfm output can be used with a wider selection of extensions.Jira writer: keep image caption as alt attribute (#6529, Albert Krewinkel).
HTML writer:
alt attribute and the figure caption, both of which come from the same source in pandoc. The figure caption is hidden from screen readers with the aria-hidden attribute. This improves accessibility. For HTML4, where aria-hidden is not allowed, pandoc still uses an empty alt attribute to avoid duplicate contents.Ms writer:
\& so that it is not interpreted as a roff command.Text.Pandoc.Extensions:
Add raw_markdown extension (which only affects ipynb input).
Trim down githubMarkdownExtensions. Previously it included all of the following, which make sense for the legacy markdown_github but not for gfm, since they are part of base commonmark and thus can’t be turned off in gfm:
Ext_all_symbols_escapableExt_backtick_code_blocksExt_fenced_code_blocksExt_space_in_atx_headerExt_intraword_underscoresExt_lists_without_preceding_blanklineExt_shortcut_reference_linksThese have been removed from githubMarkdownExtensions, though they’re still turned on for legacy markdown_github.
Add Ext_attributes constructor for Extension [API change].
LaTeX template: use selnolig to selectively suppress ligatures with lualatex (#6534).
Benchmark bytestring readers (Nikolay Yakimov).
Documentation:
Use pandoc-types 1.21. This adds two things:
Support new Underline element in readers and writers (#6277, Vaibhav Sagar).
Support new Table type (Christian Despres). The Builder.simpleTable now only adds a row to the TableHead when the given header row is not null. This uncovered an inconsistency in the readers: some would unconditionally emit a header filled with empty cells, even if the header was not present. Now every reader has the conditional behaviour. Only the XWiki writer depended on the header row being always present; it now pads its head as necessary.
Add an option to disable certificate validation (#6156, Cédric Couralet, Cécile Chemin, Juliette Fourcot). This commit adds the option --no-check-certificate, which disables certificate checking when resources are fetched by HTTP.
Unify defaults and markdown metadata parsers (#6328, Nikolay Yakimov). Clean up code in Text.Pandoc.Readers.Metadata and properly handle errors in yamlToMeta. This fixes parsing of Boolean fields in metadata withinin defaults files and reduces code duplication.
Docbook reader:
<procedure> (#6442, Mathieu Boespflug).<phrase> (#6438, Mathieu Boespflug).<replaceable> (#6437, Mathieu Boespflug)<simplesect> to unnumbered section (#6436, Mathieu Boespflug).JATS reader:
Jira reader (Albert Krewinkel):
!image.jpg|align=right! are retained as key-value pairs. Thumbnail images, such as !example.gif|thumbnail!, are marked by a thumbnail class in their attributes.inserted.(/), (x), (!), (?) (+), (-), (off), (*). (#6236, #6264).HTML reader:
<bdo> (#5794, Tristan de Cacqueray).summary to list of block-level HTML tags (#6385). This improves support for summary/details inside Markdown. NOTE: you need to include a blank line before the closing </details>, if you want the last part of the content to be parsed as a paragraph.Commonmark reader: Implement implicit_figures extension (#6350).
Markdown Reader:
LaTeX reader:
\end{document} (#6380). This required some internal changes to \subfile handling.\lettrine. SmallCaps instead of Span for the part after the initial capital. Ensure that both arguments are parsed, so that in Markdown both are treated as raw LateX. (Closes #6258.)Org reader (Albert Krewinkel):
#+SOMEWORD: value are no longer read as metadata, but kept as raw org blocks. This ensures that more information is retained when round-tripping org-mode files; additionally, this change makes it possible to support non-standard org extensions via filters.#+LINK) has been combined and unified.LATEX_HEADER_EXTRA and HTML_HEAD_EXTRA settings. These export settings are treated like their non-extra counterparts, i.e., the values are added to the header-includes metadata list.#+SUBTITLE export settings. The values of all lines are read as inlines and collected in the subtitle metadata field.#+INSTITUTE values as text with markup. The value is stored in the institute metadata field and used in the default beamer presentation template.#+AUTHOR and #+KEYWORD export settings has changed: Org now allows multiple such lines and adds a space between the contents of each line. Pandoc now always parses these settings as meta inlines; setting values are no longer treated as comma-separated lists. Note that a Lua filter can be used to restore the previous behavior.#+DESCRIPTION lines are now treated as text with markup. If multiple such lines are given, then all lines are read and separated by soft linebreaks.tex export option can be set with #+OPTION: tex:nil and allows three settings: t (the default) causes LaTeX fragments to be parsed as TeX or added as raw TeX. nil removes all LaTeX fragments from the document. verbatim treats LaTeX as text.RST reader:
date:: directive (#6276).Textile reader: support pre. for code blocks (#6454).
Ipynb reader:
raw_markdown extension (#5408). Specifying -f ipynb+raw_markdown will cause Markdown cells to be represented as raw Markdown blocks, instead of being parsed. This is not what you want when going from ipynb to other formats, but it may be useful when going from ipynb to Markdown or to ipynb, to avoid semantically insignificant changes in the contents of the Markdown cells that might otherwise be introduced.Docx reader:
MediaWiki reader:
gfm_auto_identifiers so that - is not replaced by _ (#6335).Vimwiki reader:
Add nested syntax highlighting (#6256, Vlad Hanciuta). Nested syntaxes are specified like this:
{{{sql
SELECT * FROM table
}}}The preformatted code block parser has been extended to check if the first attribute of the block is not a key=value pair, and in that case it will be considered as a class.
Jira writer (Albert Krewinkel):
+inserted+).LaTeX writer:
-M csquotes works even in fragment mode (#6265).^ specially for listings (#6460).HTML writer:
<br> for display math (#6372) Some CSS to ensure that display math is displayed centered and on a new line is now included in the default HTML-based templates; this may be overridden if the user wants a different behavior.Org writer:
Docx writer:
OpenDocument (and ODT) writer:
DocBook writer:
FB2 writer:
Markdown writer:
_ when intraword_underscores extension is enabled (#6296).RST writer:
AsciiDoc writer:
Haddock Writer:
PowerPoint writer (Jesse Rosenthal):
LaTeX template: Make polyglossia package options list-aware (#6444, Frederik Elwert).
Reveal.js template:
opendocument template: Add abstract and subtitle to opendocument template (#6369).
reference.odt: clean up styles. Add Abstract. Change Author, Date to centered paragraphs with no character styling.
epub.css: wrap overlong lines in highlighted code blocks (#6242). This fixes a problem in iBooks v2.4 with our earlier horizontally scrolling code blocks. The problem seems to be a bug in iBooks, not pandoc, but since iBooks is a major target we’re changing pandoc’s default behavior so that pandoc-produced epubs work on that platform.
Text.Pandoc.PDF:
--enable-local-file-access in invoking wkhtmltopdf (#6474). wkhtmltopdf changed in recent versions to require this for access to local files. This fixes PDF via HTML5 with --css.Text.Pandoc.MIME: Fix MIME type for TrueType fonts in EPUBs (#6464, Michael Reed).
Text.Pandoc.Shared:
makeSections: omit number attribute when unnumbered class is present (#6339). Previously the attribute was included but given an empty value, and this caused the table of contents creation functions in Text.Pandoc.Writers.Shared to think these items had numbers, which meant that they were included in the TOC even if the unlisted class was used.underlineSpan in Shared in favor of Text.Pandoc.Builder.underline (Vaibhav Sagar).renderTags': use self-closing tag for col element (#6295).Text.Pandoc.UUID: Fix getRandomUUID, which previously would return the same value twice in a row. Make getRandomUUID polymorphic in PandocMonad. Remove getUUID (#6228, Joseph C. Sible).
Text.Pandoc.Class: Generalize PandocIO functions to MonadIO.
Fixed Katex standalone script (#6399, Lucas Escot). Global macros are now persistent when using the HTML Writer with the --katex option.
Lua subsystem (Albert Krewinkel):
PandocLua is an instance of the PandocMonad typeclass and can thus be used in a way similar to PandocIO.LuaException type is removed and no longer exported from Text.Pandoc.Lua. In its place, a new constructor PandocLuaError is added to PandocError.Lua filters: improve error messages for failing filters (#6332, Albert Krewinkel). Print the Lua error properly instead of displaying their show string.
Use latest skylighting. This fixes a bug with lua multiline comments (and may improve handling of other syntaxes as well). IT also adds aria-hidden="true" to the empty a elements, which helps people who use screen readers.
Use latest texmath.
Require latest doctemplates 0.8.2. This adds support for template pipes first, rest, last, allbutlast.
Revert 0e48a02 and dependency on base-noprelude, which hasn’t been updated for ghc 8.10 (see #6187).
Dependency adjustments:
vector (#6462, Laurent P. René de Cotret).Significant code cleanup and simplification (Joseph C. Sible, #6223, #6209, #6225, #6229, #6226, #6340).
Remove unnecessary hlint ignores (#6341, Joseph C. Sible).
Remove obsolete RelaxedPolyRec extension (#6487, Nikolay Yakimov).
trypandoc improvements (Mike Tzou):
MANUAL.txt:
jira as “Jira/Confluence wiki markup” (#6351, Albert Krewinkel). In the past, Jira’s wiki markup was also used by – and could be imported into – Atlassian Confluence.org.md:
smart extension (#4387, Albert Krewinkel).lua-filters.md:
with_temporary_directory and with_working_directory.INSTALL.md: fix FreeBSD port link (#6422, Mo). The FreeBSD port was renamed from pandoc to hs-pandoc in 2010. The old pandoc port is still at version 1.5.1.1
Propagate (DY)LD_LIBRARY_PATH in tests (#6376, Lila).
Bump cabal-version to 2.2 (#6377).
Make it possible to compile using Stack on NixOS (#6439, Mathieu Boespflug).
CI action to check for commit message length (Nikolay Yakimov, #6398).
Markdown reader: Fix table alignment when heading begins with t (#6153). Due to a typo (t instead of \t) we were center aligning column headings that begin with a lowercase t!
Text.Pandoc.Readers.Roff:
\. in man/ms readers (#6175). Previously due to a typo it was being parsed as `.\' in man/ms readers (#6175). It was being parsed as a backtick.Jira reader (Albert Krewinkel):
| characters.Ms writer:
.QS/.QE instead of .RS/.RE for block quotes.EPUB writer: fix regression on detection of front/back/bodymatter (#6170). This bug caused sections with epub:type dedication to be misplaced in bodymatter instead of frontmatter as specified in the manual. The same problem would affect other epub:types. The pattern matching needed to be changed with the use of makeSection.
AsciiDoc writer: remove redundant otherwise guard in inlineToAsciiDoc (#6146, Ryan Scott).
Text.Pandoc.Class:
Text.Pandoc.XML: Add to list of HTML5 attributes: allow, autocapitalize, decoding, enterkeyhint, imagesizes, imagesrcset, loading.
Use implicit Prelude (#6187, Albert Krewinkel). The previous behavior was introduced as a fix for #4464. It seems that this change alone did not fix the issue, and stack ghci and cabal repl only work with GHC 8.4.1 or newer, as no custom Prelude is loaded for these versions. Given this, it seems cleaner to revert to the implicit Prelude.
Always use custom prelude (#6187, Albert Krewinkel). Previously, the custom prelude was used only with older GHC versions, as a workaround for problems with ghci. The ghci problems are resolved by replacing package base with base-noprelude, allowing for consistent use of the custom prelude across all GHC versions.
Remove outdated checks for no longer supported base versions (Albert Krewinkel).
PDF via wkhtmltopdf: put user-specified options last (#6171). Certain options (e.g. cover) need to come after flags on the command line.
Text.Pandoc.App: set resource path at the beginning so it can affect things like include-in-header (#5982).
Change macOS release candidate CI process so that notarized packages can be produced (#6169).
Make MANUAL more explicit about nonbreaking space handling by all_symbols_escapable (#6154, Fabien Schurter).
trypandoc (Mike Tzou):
Use details tag to make GitHub releases changelog collapsible.
Update filter code in doc/filters.md so it works with latest pandoc (#6185).
linux/Dockerfile: upgrade to alpine 3.11 (#6180, Albert Krewinkel). This is used to build the static linux binaries.
Add csv as an input format (#6100). The CSV table is converted into a pandoc simple table. A new module Text.Pandoc.Readers.CSV exports readCSV [API change].
Introduce new format variants for JATS writer (#6014, Albert Krewinkel):
jats_archiving for the “Archiving and Interchange Tag Set”,jats_publishing for the “Journal Publishing Tag Set”, andjats_articleauthoring for the “Article Authoring Tag Set.”The jats output format is now an alias for jats_archiving. The module Text.Pandoc.Writers.JATS now exports writeJatsArchiving, writeJatsPublishing, and writeJatsArticleAuthoring, as well as the legacy writeJATS [API change].
--defaults: Support bibliography and csl fields. Move addMeta from Text.Pandoc.App.CommandLineOptions to Text.Pandoc.App.Opt (internal change).
Add timing info for filters in --verbose mode (#6112). When verbose mode is specified (verbosity == INFO), print a notice when running a filter and when a filter completes (including timing).
LaTeX reader:
& in LaTeX citation keys (#6110).\ref to table numbers (#6137)._), try again as a verbatim environment, which is less sensitive to special characters. This allows us to capture special environments that change catcodes as raw tex when -f latex+raw_tex is used.RST reader:
MediaWiki writer:
[[[ which confuses MediaWiki (#6119).HTML reader:
data-id as id attribute. And similarly don’t parse any data-X as X when X is a valid HTML attribute.Org reader:
LaTeX writer:
HTML writer:
--number-offset with HTML TOC. Eventually it would be worth adding a parameter to makeSections so this could be done at that level; then it would also affect other writers that construct TOC manually.Markdown writer:
Docx writer:
Jira writer:
Add Text.Pandoc.Image with unexported svgToPng.
Text.Pandoc.XML: Export html5Attributes, html4Attributes, rdfaAttributes (formerly unexported in Text.Pandoc.Writers.HTML). [API change]
Text.Pandoc.Shared: Export a new function findM (#6125, Joseph C. Sible).
Text.Pandoc.Logging: Add RunningFilter, FilterCompleted constructors to LogMessage [API change].
Text.Pandoc.CSV: fix bug in CSV parser; previously an extra blank record would sometimes be inserted at the end.
LaTeX template: add space option to xeCJK with PassOptionsToPackage (#6002). Otherwise we can get a clash with documentclasses that already load the package.
Lua filters:
Allow filtering of element lists (#6038, Albert Krewinkel). Lists of Inline and Block elements can now be filtered via Inlines and Blocks functions, respectively. This is helpful if a filter conversion depends on the order of elements rather than a single element. For example, the following filter can be used to remove all spaces before a citation:
function isSpaceBeforeCite (spc, cite)
return spc and spc.t == 'Space'
and cite and cite.t == 'Cite'
end
function Inlines (inlines)
for i = #inlines-1,1,-1 do
if isSpaceBeforeCite(inlines[i], inlines[i+1]) then
inlines:remove(i)
end
end
return inlines
endAdd methods insert, remove, and sort to pandoc.List (Albert Krewinkel). Example of use:
local numbers = pandoc.List {2, 3, 1}
numbers:sort() -- numbers is now {1, 2, 3}Make pandoc.List a callable constructor (Albert Krewinkel). It is now possible to construct a new List via pandoc.List() instead of pandoc.List:new().
Add tests for pandoc.List module (Albert Krewinkel).
Text.Pandoc.App.CommandLineOptions: Change setVariable to use Text instead of String. This avoids some unnecessary unpacking.
Use versioned directory for windows release zipfile. Also remove old make-windows-installer.bat, superseded by GitHub actions workflow, and modify pandoc.wxs for new paths.
Extensive code cleanup (#6141, #6128, #6129, #6130, #6123, #6105, 6102, #6117, #6124, #6115, #6116, #6111, Joseph C. Sible).
Fix hlint warnings (Albert Krewinkel).
Use latest doclayout, doctemplates (#6031). The new version of doclayout fixes a memory leak that affected --include-in-header with large files (and possibly other cases involving extremely long lines).
Use latest texmath.
Use latest skylighting and fix test suite (#6086).
sample.lua: Fix typo in descriptive comments (#6136, Caleb Maclennan). Fix typo in error message (#6135).
Add Docker and GH Actions instructions/links to INSTALL.md.
Update filter documentation (#6065). Improve cabal v2 instructions. Remove example using pandoc API directly (we have other docs for that and it was outdated).
Lua filter docs:
In docs, update URLs and use https: wherever possible (#6090, Salim B).
Markdown reader:
LaTeX writer:
\paragraph command was used instead of \paragraph* for unnumbered level 4 headings.HTML writer:
Org writer:
JATS template: Update JATS dtd (Arfon Smith, #6020). Use the archiving and interchange DTD rather than the more restrictive journal publishing DTD (which doesn’t permit ext-link as a valid child).
Text.Pandoc.PDF: Fix runTeXProgram so that the input source is always overwritten (#6027). Previously it wasn’t overridden if the file already existed, which led to bad results on subsequent runs when pdf-engine-opt=-output-directory= was used to specify an explicit temp dir.
Text.Pandoc.BCP47: Change getLang to handle block-level contents (#6008). Some readers (e.g. RST) will populate the lang metadata field with block-level content. getLang has been modified to handle this. Previously in these cases the LaTeX writer would not properly set the “main language” of the document.
Fix test/tables.org (Albert Krewinkel).
Use HTTPS in copyright message (Felix Yan, #6010)
Add Jira reader (Albert Krewinkel, #5556).
Jira writer: use jira-wiki-markup renderer (Albert Krewinkel, #5926). The following improvements are included in this change:
--wrap=preserve is supported.Note that backslashes are rendered as HTML entities, as there appears no alternative to produce a plain backslash if it is followed by markup. This may cause problems when used with confluence, where rendering seems to fail in this case.
Fix regression with --number-sections. Starting with 2.8, --number-sections also had the effect of --section-divs, even if --section-divs was not specified.
Improved table of contents generation in markdown, RTF, commonmark, better handling cases where section headings are enclosed in divs.
Ensure that later default file values for variable replace earlier ones (5988).
HTML reader: Add nav to list of block-level tags.
Org reader (Albert Krewinkel):
#+NAME: or #+LABEL: are wrapped in an additional Div, with the name set as the Div’s ID.Text.Pandoc.PDF: Ensure UTF8 when printing source in --verbose mode, avoiding an error on platforms that default to something other than UTF-8 (#5997).
Text.Pandoc.Templates: Strip directory before trying to find partial in data files (#5987).
Text.Pandoc.Shared: Improve makeSections so we don’t get doubled “number” attributes in EPUB output (or anywhere else) (#5986).
Added tests for --toc and --section-divs.
Text.Pandoc.MIME: Added glsl MIME type for WebGL maps (#6000, Jared Lander).
MANUAL: A bit clearer explanation for --base-header-level. We now say exactly how to translate between the deprecated --base-header-level and --shift-heading-level-by.
lua-filters.md:
Text.Pandoc.Templates [API change]
WithDefaultPartials and WithPartials. Wrapping these around an instance of PandocMonad gives us different instances of TemplateMonad, with different search behavior in retrieving partials. To compile a template and limit partial search to pandoc’s data files, use runWithDefaultPartials (compileTemplate ...). To compile a template and allow partials to be found locally (either on the file system or via HTTP, in the event that the main template has an absolute URL), ue runWithPartials (compileTemplate ...).getTemplate, which seeks a template locally, or via HTTP if the template has an absolute URL, falling back to the data files if not found.compileDefaultTemplate – does getDefaultTemplate and compiles the result, raising an error on failure.Text.Pandoc.Class [API change]
TemplateMonad instances for PandocIO and PandocPure. These were too limiting and caused a bug whereby a local partial could be used even when the default template was requested. We now rely on instances provided in the Templates module.Text.Pandoc.App.OutputSettings: Simplify template retrieval code.
ConTeXt template: Adjust to title formatting (#5949, Denis Maier). Add \setupinterlinespace to title, subtitle, date and author elements: otherwise longer titles that run over multiple lines will look squashed as \tfd etc. won’t adapt the line spacing to the font size.
reveal.js template: Add title-slide-attributes variable (#5981, Frederik Elwert).
More informative JSON parse error (#5973).
Use external emojis package (forked from pandoc). Removed emoji data in Text.Pandoc.Emoji.
Fix regression in makeSections (#5965). Previously hierarchicalize (the ancestor of makeSections) would put header attributes on the containing Div. In 2.8 this behavior changed, which broke some tools depending on pandoc. Here we roll back this change, so that attributes again migrate from the header to the containing Div when makeSections is run. Note that attributes are retained on the header as well (unlike before) – with the exception of the id attribute, which of course cannot be duplicated.
Fix --toc-depth regression in 2.8 (#5967).
Use doctemplates 0.8. Rename template ‘filters’ as ‘pipes’ to avoid confusion with the other notion of filter used by pandoc.
Fix README.md so that relative links from manual become absolute. Previously they’d be broken links when viewed on GitHub or Hackage. So we add the base URL for the pandoc manual.
Document display math syntax in manual.
Add ascii_identifiers as a supported extension for markdown. This fixes a regression in 2.8.
Fix regression with behavior of --variable (#5962). Previously -Vfoo=1 -Vfoo=2 would produce a list value for foo; with 2.8 it produced just 2. This commit restores the earlier behavior.
Roll back part of of --shift-heading-level-by change (#5957). With positive heading shifts, starting in 2.8 this option caused metadata titles to be removed and changed to regular headings. This behavior is incompatible with the old behavior of --base-header-level and breaks old workflows, so we have rolled back the change. Note that there is now an asymmetry in positive and negative heading level shifts: With positive shifts, the metadata title stays the same and does not get changed to a heading in the body, while with negative shifts, a heading can be converted into the metadata title.
Text.Pandoc.Shared: Fix makeSections so it doesn’t turn column Divs into sections.
HTML writer: add task-list class to ul if all elements are task list items. This will allow styling unordered task lists in a way that omits the bullet.
HTML-based templates: Add CSS to suppress bullet on unordered task lists.
ConTeXt template: Fix \startcslreferences and use ConTeXt syntax conventions (#5945, Denis Maier). The old version had a too large a skip at the beginning of the reference list.
LaTeX template: keep the \author{} command even if author is not specified (#5961, Yihui Xie). Avoids a LaTeX warning.
Generate Emoji module with TH.
emoji.json using TH.emoji.json.tools/emoji.hs.Increase GC allocation space for compilation in cabal.project.
Clean up manual on PDF generation backend options (#5940).
Update release checklist to include code signing step and update Windows release-candidate builds (#5950).
pdf in --list-output-formats.--css (#5937). In 2.8 --css would not have an effect on EPUB output.nowrap filter to templates.nowrap for .TH heading (#5929).toc-title variable (#5930, Alexandre Franke).grffile (LaTeX package) requirement in MANUAL.txt (#5927, Ian Max Andolina).Improvements in templates system (from doctemplates):
elseif, it, partials, filters, and syntax to control nesting and reflowing of text. These changes make pandoc more suitable out of the box for generating plain-text documents from data in YAML metadata. It can create enumerated lists and even tabular structures.Add --defaults/-d option. This adds the ability to specify a collection of default values for options in a YAML file. For example, one might define a set of defaults for letters, and then do pandoc -d letter myletter.md -o myletter.pdf. See the documentation of this feature in MANUAL.txt.
Raise error on unsupported extensions (#4338).
The --list-extensions[=FORMAT] option now lists only extensions that affect the given FORMAT.
Add -L option as shortcut for --lua-filter.
Add --shift-heading-level-by option and deprecate --base-heading-level (#5615). The new option does everything the old one does, but also allows negative shifts. It also promotes the document metadata (if not null) to a level-1 heading with a +1 shift, and demotes an initial level-1 heading to document metadata with a -1 shift. This supports converting documents that use an initial level-1 heading for the document title.
Allow --metadata-file to be used repeatedly to include multiple metadata files (Owen McGrath, #5702). Values in files specified first will be overridden by those in later files.
--ascii now uses numerical hex character references (#5718).
Allow PDF output to stdout (#5751). PDF output now behaves like other binary formats: it will not be output to the terminal, but can be sent to stdout using either -o - or a pipe. The intermediate format will be determined based on the setting of --pdf-engine.
Make some writers sensitive to ‘unlisted’ class on headings (#1762). If this is present on a heading with the ‘unnumbered’ class, the heading won’t appear in the TOC. This class has no effect if ‘unnumbered’ is not also specified. This affects HTML-based writers (including slide shows and EPUB), LateX (including beamer), RTF, and PowerPoint. Other writers do not yet support unlisted.
Fix gfm_auto_identifiers behavior with emojis (#5813). Note that we also now use emoji names for emojis when ascii_identifiers is enabled.
When --ipynb-output is used with the default “best” format, strip ANSI escape codes for non-ipynb output (#5633). These cause problems in many formats, including LaTeX.
Don’t look for template files remotely for remote input (#5579). Previously pandoc would look for the template at a remote URL when a URL was used for the input file, instead of taking it from the data directory.
Allow combining -Vheader-includes and --include-in-header (#5904). Previously header-includes set as a variable would be clobbered by material included using --include-in-header.
Change merge behavior for metadata. Previously, if a document contained two YAML metadata blocks that set the same field, the conflict would be resolved in favor of the first. Now it is resolved in favor of the second (due to a change in pandoc-types). This makes the behavior more uniform with other things in pandoc (such as reference links and --metadata-file).
Don’t add a newline to fragment output if there’s already one.
Change exit codes and document in MANUAL.txt:
PandocAppError was 1, is now 4PandocOptionError was 2, is now 6PandocMakePDFError was 65, is now 66Switch to new pandoc-types and use Text instead of String [API change]. (Christian Despres, #5884).
HTML reader:
<q> with cite attribute (#5798, Ole Martin Ruud). If a <q> tag has a cite attribute, we interpret it as a Quoted element with an inner Span.<samp> element (#5792, Amogh Rathore). The <samp> element is parsed as Code with class sample.<var> element (#5799, Amogh Rathore). The <var> element is parsed as Code with class variable.<mark> elements (Florian B, #5797). Parse <mark> elements from HTML as Spans with class mark.<kbd> elements, parsing them as Span with class kbd (Daniele D’Orazio, #5796).<dfn>, parsing this as a Span with class dfn (#5882, Florian Beeres).Markdown reader:
take1WhileP for str, table row. This yields a small but measurable performance improvement.LaTeX reader:
raw_tex is set (#5673). When the raw_tex extension is set, we just carry through \usepackage, \input, etc. verbatim as raw LaTeX.\\ in \parbox inside a table cell (#5711).withRaw so it can handle cases where the token string is modified by a parser (e.g. accent when it only takes part of a Word token) (#5686). This fixes a bug that caused the ends of certain documents to be dropped.\passthrough macro used by latex writer (#5659).\tt command (#5654).\looseness command values better (#4439).mbox and hbox handling (Vasily Alferov, #5586). When +raw_tex is enabled, these are passed through literally. Otherwise, they are handled in a way that emulates LaTeX’s behavior.\providecommand and \provideenvironment (#5635). They are now ignored if the corresponding command or environment is already defined.ly environment from lilypond as verbatim (Urs Liska, #5671).tikzcd to list of special environments (Eigil Rischel). This allows it to be processed by filters, in the same way that one can do for tikzpicture.Roff reader:
while.\\} isn’t at the beginning of a line.RST reader:
name property in imgAttr (Brian Leung, #5619)._ (#5763).Org reader:
ATTR_LATEX in block attributes (Albert Krewinkel, #5648). Attributes for LaTeX output are accepted as valid block attributes; however, their values are ignored.-i switch to ignore leading spaces (Brian Leung).#+BEGIN_ aligned in a reasonable way, but their other components can be positioned otherwise.Muse reader (Alexander Krotov):
*.* not followed by space.DokuWiki reader:
Docx reader:
rtl=0 for every paragraph.Docbook reader:
MediaWiki reader:
{{table}} template (#5757).LaTeX reader:
untokenize, ensure space between control sequence and following letter (#5836).latex_macros was set). Now they are included in the document body.latex_macros is disabled. (When latex_macros is enabled, we omit them, since pandoc is applying the macros itself.)[Tok] parameter to rawLaTeXParser. This allows us to repeat retokenizing unnecessarily in e.g. rawLaTeXBlock.\dedication.\micro siunitx unit command (#5921, Jose Luis Duran).Markdown writer:
plain output plainer (#5741). Previously we used the following Project Gutenberg conventions for plain output: extra space before and after level 1 and 2 headings, all-caps for strong emphasis, underscores surrounding regular emphasis. Now these conventions are used only when the gutenberg extension is enabled. By default, Strong and Emph are rendered without special formatting, and headings are rendered without special formatting, and with only one blank line following. To restore the former behavior, use -t plain+gutenberg.raw_attribute will be used to mark raw bits, even HTML and LaTeX, and even when raw_html and raw_tex are enabled, as they are by default. To get the old behavior, disable raw_attribute in the writer.pipe_tables to raw HTML even when we must lose width information (#2608, #4497).AsciiDoc writer:
+ in code blocks for regular asciidoc. This is asciidoctor-specific.LaTeX writer:
\hspace{0pt} for 0-width space U+200B (#5756).cslreferences environment for csl bibliographies. This allows bibliographies to receive special formatting. The template now contains definition of this environment (enabled only when CSL is used). It also defines a \cslhangindent length. This is set to 2em by default when the bibliography style specifies a hanging indent. To override the length, you can use e.g. \setlength{\cslhangindent}{7em} in header-includes. See jgm/pandoc-citeproc#410.{} around locator for biblatex/natbib output (#5722).\hfill\break instead of \\. This is a revision of a PR by @sabine (#5591) who should be credited with the idea.csquotes package is used. To use csquotes for LaTeX, set csquotes in your variables or metadata. To specify a book style, use the documentclass variable or --top-level-division.\linethickness, which apparently only ever worked “by accident” and no longer works with recent updates to texlive.ConTeXt writer:
includesource) can be set to attach the source documents to the resulting PDF.pdfa variable may now be set in metadata. Also updated color profile settings in accordance with ConTeXt wiki, and made ICC profile and output intent for PDF/A customizable using pdfaiccprofile and pdfaintent.csl-hanging-indent variable if needed.HTML writer:
--ascii (#5718). Previously we used named character references with html5 output. But these aren’t valid XML, and we aim to produce html5 that is also valid XHTML (polyglot markup). (This is also needed for epub3.)--webtex may render formulas using inline or display style by default. Prefixing formulas with the appropriate command ensures they are rendered correctly.--webtex (Philip Pesca, #5655). We add \textstyle to the beginning of the formula to ensure it will be rendered in inline style.aria- attributes to HTML5 (#5642).cite attribute using a <q> tag (#5798, Ole Martin Ruud).mark using the <mark> element (Florian Beeres, #5797).dfn using <dfn> element (Florian Beeres, #5882).kbd using <kbd> element (Daniele D’Orazio, #5796).variable using <var> element (Amogh Rathore, #5799).sample using <samp> element (Amogh Rathore, #5799).EPUB writer:
makeSection.lang variable is set on all chapters (so that it will add an xml:lang attribute on the html element).RST writer:
admonition-title.:align: on figures and images (#4420). When the image has the align-right (etc.) class, we now use an :align: attribute.Dokuwiki writer:
XWiki writer:
Muse writer:
Man writer:
Ms writer:
.LP instead of .PP for line block (#5588).JATS writer:
<fn-group> (Mauro Bieg, #5595).data/jats.csl to avoid commas between editor name-part elements. (#5629)abstract to template (Mauro Bieg).TEI writer:
Jira writer:
OpenDocument writer:
native_numbering extension is set, use native OpenDocument enumeration for figures and tables (Nils Carlson).ODT writer:
Docx writer:
-. Code styles, i.e. “Source Code” and “Verbatim Char” now honor style inheritance. Docx Reader now honours “Compact” style (used in Pandoc-generated docx). The side-effect is that “Compact” style no longer shows up in docx+styles output. Styles inherited from “Compact” will still show up.proofState to list of elements carried over from settings.xml in the reference.docx (Krystof Beuermann, #5703).ilvl and numId in document.xml (Agustín Martín Barbero, #5645). Also, make list para properties go first. This reordering of properties shouldn’t be necessary but it seems Word Online does not understand the docx correctly otherwise.PowerPoint writer:
monofont option.Text.Pandoc.Parsing:
manyChar, many1Char, manyTillChar, many1TillChar, many1Till, manyUntil, mantyUntilChar: these are like their unsuffixed counterparts but pack some or all of their output (Christian Despres, #5884).stateAllowLineBreaks to ParserState [API change].setLastStrPos so it takes a Maybe SourcePos rather than a SourcePos [API change].parseFromString' and gridTableWith and gridTableWith' polymorphic in the parser state, constraining it with HasLastStrPosition [API change].parseFromString': reset stateLastStrPos to Nothing before parse.Text.Pandoc.PDF:
Text.Pandoc.Extensions:
getAllExtensions, which returns the extensions that affect a given format (whether enabled by default or not) [API change].parseFormatSpec from Either ParseError (String, Extensions -> Extensions) to Either ParseError (String, [Extension], [Extension]) [API change].Ext_gutenberg constructor to Extension [API change].Ext_native_numbering constructor to Extension [API change] (Nils Carlson).Text.Pandoc.Readers, Text.Pandoc.Writers:
getReader and getWriter so they return a value in the PandocMonad instance rather than an Either [API change]. Exceptions for unknown formats and unsupported extensions are now raised by these functions.Text.Pandoc.App
optMetadataFile type from Maybe FilePath to [FilePath] (Owen McGrath, #5702) [API change].Text.Pandoc.Logging:
CouldNotDeduceFormat constructor to LogMessage [API change]. Issue this warning when we’re falling back to markdown or html because we don’t recognize the extension of the input or output files.UnusualConversion constructor to LogMessage [API change] (Mauro Bieg, #5736). Emit warning on -f latex -o out.pdf.Lua filters:
Improve function documentation (Albert Krewkinkel).
Traverse nested blocks and inlines in correct order (Albert Krewinkel, #5667). Traversal methods are updated to use the new Walk module so that sequences with nested Inline (or Block) elements are traversed in the order in which they appear in the linearized document.
New unexported module Text.Pandoc.Lua.Walk (Albert Krewinkel). Lua filters must be able to traverse sequences of AST elements and to replace elements by splicing sequences back in their place. Special Walkable instances can be used for this; those are provided in a new module Text.Pandoc.Lua.Walk.
Attr values can now be given as normal Lua tables (Albert Krewinkel, #5744). This can be used as a convenient alternative to constructing Attr values with pandoc.Attr. Identifiers are taken from the id field, classes must be given as space separated words in the class field. All remaining fields are included as attributes. With this change, the following lines now create equal elements:
pandoc.Span('test', {id = 'test', class = 'a b', check = 1})
pandoc.Span('test', pandoc.Attr('test', {'a','b'}, {check = 1}))This also works when using the attr setter:
local span = pandoc.Span 'text'
span.attr = {id = 'test', class = 'a b', check = 1}Furthermore, the attributes field of AST elements can now be a plain key-value table even when using the attributes accessor:
local span = pandoc.Span 'test'
span.attributes = {check = 1} -- works as expected nowExport make_sections, remove hierarchicalize. Lua filters that use hierarchicalize will need to be rewritten to use make_sections.
Add a clone() method to all AST elements (Albert Krewinkel, #5568).
Fix Lua function names in pandoc.system (niszet). Change get_current_directory to get_working_directory and with_temp_directory to with_temporary_directory, to conform to the manual.
Text.Pandoc.Error:
PandocUnknownReaderError, PandocUnknownWriterError, PandocUnsupportedExtensionError. [API change].PandocShouldNeverHappenError.PandocTemplateError.Text.Pandoc.Emoji:
tools/emojis.hs, which uses the list from the gem GitHub uses. Future updates can be done with this tool.Text.Pandoc.PDF:
--dpi to rsvg-convert when converting SVG to PDF in the process of creating a PDF (#5721).Text.Pandoc.Shared:
Element and makeHierarchical with makeSections. Now that we have Divs, we can use them to represent the structure of sections, and we don’t need a special Element type. makeSections reorganizes a block list, adding Divs with class section around sections, and adding numbering if needed. This change also fixes some longstanding issues recognizing section structure when the document contains Divs (#3057, see also #997).Element type [API change]makeHierarchicalize [API change]makeSections [API change]deLink [API change]filterIpynbOutput strip ANSI escapes from code in output for non-ipynb formats, when the default “best” option is used with --ipynb-output (#5633).camelCaseToHyphenated so it handles ABCDef better.isTight (#5857). If a list has an empty item, this should not count against its being a tight list.htmlSpanLikeElements [API change] (Daniele D’Orazio, #5796). This is a mapping of HTML span-like elements that are internally represented as a Span with a single class.htmlSpanLikeElements to retain classes and attributes (#5882, Florian Beeres).Text.Pandoc.Slides: recognize content in Divs when determining slide level.
Text.Pandoc.SelfContained:
<style> (#5725). It doesn’t seem to be valid for HTML5, and as a result Chrome ignores the style element.Text.Pandoc.Pretty has been removed [API change]. We now use the new external doclayout module instead.
Text.Pandoc.Writers.Shared:
metaToJSON, metaToJSON' [API change].addVariablesToContext, defField, setField, getField, resetField to work with Context rather than JSON values. [API change]endsWithPlain [API change].gridTables so it does better at keeping the widths of columns (#4320) and does better at figuring out column widths when no widths are given (#5899).Text.Pandoc.Options
writerTemplate to Maybe Template instead of Maybe String.HTMLMathMethod, CiteMethod, ObfuscationMethod, TrackChanges, WrapOption, TopLevelDivision, ReferenceLocation, HTMLSlideVariant (#5790). In each case we use lowercase (or hyphenated lowercase) for constructors to line up more closely with command-line option values. This is a breaking change for those who manually decode or encode JSON for these data types (e.g. for ReaderOptions or WriterOptions).Text.Pandoc.Filters:
FromYAML instance for Filter.applyFilters: Add and apply filters in order (not reversed) This changes applyFilters from Text.Pandoc.Filter so that it does a left fold rather than a right fold, applying the filters in the order listed.Text.Pandoc.XML:
toEntities to emit numerical hex character references (#5718).Text.Pandoc.Highlighting:
Text.Pandoc.MediaBag:
Text.Pandoc.Templates:
varListToJSON [API change]. It is removed in doctemplates >= 0.3.renderTemplate' [API change]. Return value is now Text rather than being polymorphic. This makes room for upcoming removal of the TemplateTarget class from doctemplates.Text.Pandoc.App.Opt API changes:
strip-empty-paragraphs rather than optStripEmptyParagraphs. Anyone who is using JSON serialization of Opt will need to adjust things accordingly.optHighlightStyle to a Maybe String instead of Maybe Style. Do the parsing/loading of themes later, after option parsing.optBaseHeaderLevel from Opt. We now just use optShiftHeadingLevelBy, to avoid redundancy.optShiftHeadingLevel to optShiftHeadingLevelBy to match the option.LineEnding, so either CRLF or crlf will work.optVariables from [(String, String)] to Context Text.optMetadata to Meta, to allow structured values. The current behavior of the --metadata option stays the same.optReader, optWriter as optFrom, optTo.FromYAML instances to Opt and to all subsidiary types.optMetadataFile to optMetadataFiles.optPDFEngineArgs to optPDFEngineOpts.optWrapText to optWrap.IpynbOutput enumerated type: use this instead of a string for optIpynbOutput.Maybe [FilePath] (#5888) [API change]. Nothing means: nothing specified. Just [] means: an empty list specified (e.g. in defaults).optIncludeInHeader, etc. were in reverse order.sourcefile variable is now always a list. It used to be sometimes a string, sometimes a list (when there was more than one).Template changes:
cslreferences environment, to be used for pandoc-citeproc references. A csl-hanging-indent variable (set automatically if there is a hanging-ident class on the references Div) controls whether contents of this environment receive a hanging indent.space as default option for xeCJK, so that spaces between words are preserved (#5855, jeongminkim-islab). This is necessary for Korean.grffile (#5848). This package used to be needed for proper handling of image filenames containing periods (in addition to the period before the extension). It no longer works with the latest LaTeX kernel and graphicx, so we have removed it. Future versions of graphicx will handle these filenames without the need for grffile.pagenumbering variable is set.cslreferences to allow for hanging indents in the bibliography (#5875, Denis Maier).styles.html partial to avoid code duplication.reference.docx (#5820):
w:themeShade="B5".epub.css: Add CSS for hanging-indent div to support pandoc-citeproc’s new hanging indents.
pandoc.cabal:
-Wcpp-undef and -fhide-source-paths when possible (Albert Krewinkel).derive_json_via_th flag; always use TH. This cuts down on code duplication and reduces the chance for errors. See #4083.Makefile:
Benchmarks: fix failure on ipynb.
Use MathJax 3 (zorkow).
KaTeX math: respect classoption=fleqn variable, bump KaTeX version to 0.11.1 (#5815, Mauro Bieg).
Fix redundant constraint compiler warnings (Pete Ryland, #5625).
Use throwError instead of fail when appropriate.
Use Prelude.fail to avoid ambiguity with fail from GHC.Base.
Add diff-zip.sh to tools (John MacFarlane, Agustín Martín Barbero). This is intended to make it easier to test differences in zip containers, like epub, docx, or odt.
Add .gitattributes (#5747). This ensures that the golden files in test/fb2/reader/ don’t have newlines converted. This should fix a test failure on GitHub CI with Windows.
Reorder options in --help.
Revise code for HsYAML-0.2.0.0 (@vijayphoenix, #5704).
Remove blank line in code example in Haddocks (Leif Metcalf, #5679).
Fix trypandoc with getReader/getWriter changes.
Allow building pandoc with GHC 8.8.
linux tarball: add architecture -amd64 to filename. Now it will be: pandoc-VERSION-linux-ARCH.tar.gz.
MANUAL.txt:
. . . (#5701).data- prefix to unknown attributes in HTML5.hyperrefoptions (Wandmalfarbe).latex_macros is disabled.--dpi provides a default and doesn’t override dpi values specified in the images themselves (#5721).--standalone (#5866).--preserve-tabs default.INSTALL.md:
CONTRIBUTING.md:
Fix typos in changelog and comments (#5896, Brian Wignall).
doc/lua-filters.md:
Add jira (Atlassian’s Jira wiki markup) as output format (#2497, Albert Krewinkel).
Add tex_math_dollars to multimarkdownExtensions (#5512). This form is now supported in multimarkdown, in addition to tex_math_double_backslash.
Fix --self-contained so it works when output format has extensions. Previously if you used --self-contained with html-smart or html+smart, it wouldn’t work.
Add template variable curdir with working directory from which pandoc is run (#5464).
Markdown reader: don’t create implicit reference for empty header (#5549).
Muse reader: allow images inside link descriptions (Alexander Krotov).
HTML reader: epub related fixes.
epub:type in addition to type.pAnyTag to pAny.LaTeX reader:
\DeclareMathOperator (#5441). These seem to be needed for xelatex but not pdflatex.\mintinline.rawLaTeXInline: Include trailing {}s in raw latex commands (#5439). This change affects the markdown reader and other readers that allow raw LaTeX. Previously, trailing {} would be included for unknown commands, but not for known commands. However, they are sometimes used to avoid a trailing space after the command. The chances that a {} after a LaTeX command is not part of the command are very small.MediaWiki reader: handle multiple attributes in table row (#5471, chinapedia).
Docx reader: Add support for w:rtl (#5545). Elements with this property are put into Span inlines with dir="rtl".
DocBook reader: Issue IgnoredElement warnings.
Org reader (Albert Krewinkel):
\alpha are output plain and unemphasized, not as math.FB2 reader:
id element inside author); previously the reader would halt with an error. Now it skips the element and issues an IgnoredElement warning.OpenDocument writer: Roll back automatic figure/table numbering (#5474). This was added in pandoc 2.7.2, but it makes it impossible to use pandoc-crossref. So this has been rolled back for now, until we find a good solution to make this behavior optional (or a creative way to let pandoc-crossref and this feature to coexist).
New module Text.Pandoc.Writers.Jira, exporting writeJira [API change] (Albert Krewinkel).
EPUB writer:
type="text/css" from both <style> and <rel="stylesheet"> elements in all templates, which is valid according to the spec. However, Amazon’s kindlegen software relies on this attribute on <link> elements when detecting stylesheets to include.HTML writer:
needsVariationSelector. + Add class="heading" to level 7+ Headers rendered as <p> elements (#5457).RST writer: treat Span with no attributes as transparent (#5446). Previously an Emph inside a Span was being treated as nested markup and ignored. With this patch, the Span is just ignored.
LaTeX writer:
--listings (#5420).\mbox to get proper behavior inside \sout (#5529).EPUB writer: Fix document section assignments (#5546). For example, introduction should go in bodymatter, not frontmatter, and epigraph, conclusion, and afterward should go in bodymatter, not backmatter. For the full list of assignments, see the manual.
Markdown writer:
stPrevRefs to keep track of refs used in other document parts when using --reference-location=block|sectionTextile writer: fix closing tag for math output (Albert Krewinkel). Opening and closing tag for math output match now.
Org writer: always indent src blocks content by 2 spaces (#5440, Albert Krewinkel). Emacs always uses two spaces when indenting the content of src blocks, e.g., when exiting a C-c ' edit-buffer. Pandoc used to indent contents by the space-equivalent of one tab, but now always uses two spaces, too.
Asciidoc writer:
`+...+` form for inline code. The old `a__b__c` yields emphasis inside code in asciidoc. To get a pure literal code span, use `+a__b__c+`.JATS writer:
fn and list-item. So we wrap other elements inside <p specific-use="wrapper"> when needed.<fn-group> and use <xref> elements to link them.)<pub-date> by parsing the date and extracting year, month, and day, as expected. Also add an iso-8601-date attribute automatically.<break> element for LineBreak. It is only allowed in a few special contexts, and not in <p> elements.<string-name> a child of <string>, which is illegal.FB2 writer:
<sup> and brackets (Alexander Krotov). Existing FB2 readers, such as FBReader, already display links with type=“note” as a superscript.Muse writer: do not escape empty line after <br> (Alexander Krotov).
Add unicode code point in “Missing character” warning (#5538). If the character isn’t in the console font, the message is pretty useless, so we show the code point for anything non-ASCII.
Lua: add Version type to simplify comparisons (Albert Krewinkel). Version specifiers like PANDOC_VERSION and PANDOC_API_VERSION are turned into Version objects. The objects simplify version-appropriate comparisons while maintaining backward-compatibility. A function pandoc.types.Version is added as part of the newly introduced module pandoc.types, allowing users to create version objects in scripts.
pandoc lua module (Albert Krewinkel):
pandoc.mediabag lua module (Albert Krewinkel):
delete for deleting a single item.empty for removing all entries.items for iterating over mediabag.Text.Pandoc.Class: Fix handling of file: URL scheme in downloadOrRead (#5517, Mauro Bieg). Previously file:/ URLs were handled wrongly and pandoc attempted to make HTTP requests, which failed.
Text.Pandoc.MIME: add mediaCategory [API change] (Mauro Bieg).
Text.Pandoc.Shared:
onlySimpleTableCells [API change] (Mauro Bieg) and use this to consolidate simple-table detection (#5524). This fixes an inconsistency in the HTML reader, which did not treat tables with <p> inside cells as simple.metaToJSON: treat digits starting with 0 as a string, not a number (#5479). This fixes a regression in YAML metadata in pandoc 2.7.2.Text.Pandoc.Logging: Add IgnoredElement constructor for LogMessage. SkippedConetnt doesn’t work for some XML-based readers which don’t have access to parsec source positions.
Text.Pandoc.Asciify: Add Turkish undotted-i (#5433, Mauro Bieg).
Improve output of Lua tests (#5499, Albert Krewinkel). This makes use of tasty-lua, a package to write tests in Lua and integrate the results into Tasty output. Test output becomes more informative: individual tests and test groups become visible in test output. Failures are reported with helpful error messages.
Lua: add pandoc.system module (#5468, Albert Krewinkel). The system Lua module provides utility functions to interact with the operating- and file system. E.g. print(pandoc.system.get_current_directory()) or lua pandoc.system.with_temporary_directory('tikz', function (dir) -- write and compile a TikZ file with pdflatex end)
LaTeX template: Add pdflang to hypersetup if lang is set (#5443).
beamer template: Fix using Beamer with geometry (#5505, Daniel Maslowski). Beamer already loads geometry, so we need to use the \geometry command to set geometry options.
EPUB2/3 templates: Move inline styles to default epub.css (#5466). NOTE: Those who use a custom CSS stylesheet with EPUB should add these lines:
code{ white-space: pre-wrap; }
span.smallcaps{ font-variant: small-caps; }
span.underline{ text-decoration: underline; }
q { quotes: "“" "”" "‘" "’"; }
div.column{ display: inline-block; vertical-align: top; width: 50%; }reveal.js template:
Text.Pandoc.PDF:
</> with literal / (#5451). We use forward-slash for a directory separator in tmpDir, even on Windows (because that’s what tex likes). So we should not put a backslash between the tmpDir and the filename on Windows. This is harmless enough in normal Windows setups, but it breaks on Cygwin. Thanks to @cc2x for noticing and diagnosing the problem.-output-directory in --pdf-engine-opt (#5462). This is currently possible with mklatex and -outdir, but was not yet possible with xelatex and -output-directory.--pdf-engine-opt=--no-toc-relocation to your command line.Fix broken links in documents (#5473, Shim Myeongseob). Also, use absolute links to pandoc.org when possible, so that the links can be followed by people viewing these documents on GitHub.
Improved sample lua tikz filter in lua-filters docs (#5445, Matthew Doty). There are three changes:
\begin{tikzpicture}MANUAL.txt:
title-meta, author-meta, date-meta (#5486).add test/tables.xwiki to git and pandoc.cabal (#5498, Mauro Bieg).
Disable missing-home-modules warning in stack.yaml. Otherwise stack ghci fails.
Add XWiki writer (#1800, Derek Chen-Becker). Add Text.Pandoc.Writers.XWiki, exporting writeXWiki [API change].
Dokuwiki Reader: parse single curly brace (#5416, Mauro Bieg).
Vimwiki reader: improve handling of internal links (#5414). We no longer append .html to link targets, and we add a title wikilink. This mirrors behavior of other wiki readers. Generally the .html extension is not wanted. It may be important for output to HTML in certain circumstances, but it can always be added using a filter that matches on links with title wikilink.
If your workflow requires the current behavior, here is a lua filter that will add the .html extension:
ipynb reader:
ipynb for raw cell where no format given..0 on integers in metadata.Markdown reader: fenced div takes priority over setext header.
HTML reader: read data-foo attribute into foo (#5392). The HTML writer adds the data- prefix for HTML5 for nonstandard attributes. But the attributes are represented in the AST without the data- prefix, so we should strip this when reading HTML.
LaTeX reader: Improve autolink detection (#5340).
PowerPoint writer (Jesse Rosenthal):
handoutsMasterList from template presentation.xml--reference-doc correctly. We now apply correct shapes for content, and build shape trees correctly.ipynb writer:
ipynb for raw cell where no format given. According to nbformat docs, this is supposed to render in every format. We don’t do that, but we at least preserve it as a raw block in markdown, so you can round-trip.nbformat_minor if it’s given. This helps with round-tripping.LaTeX writer:
or ! ligatures (#5407). These are upside down ? and !, resp.\footnote commands, even in the table caption and the minipages containing cells. Apparently longtable knows how to handle this.HTML writer: Don’t add data- prefix to RDFa attributes (#5403).
JATS writer: Ensure that plain strings go inside <pub-id> tag (#5397).
Markdown writer:
{}, not empty string.Docx writer: Use w:br without attributes for line breaks (#5377). We previously added the attribute type="textWrapping", but this causes problems on Word Online.
LaTeX template (Andrew Dunning):
indent variable is enabled.subparagraph variable. The default is now to use run-in style for level 4 and 5 headings (\paragraph and \subparagraph). To get the previous default behavior (where these were formatted as blocks, like \subsubsection), set the block-headings variable.\setstretch after front matter (#5179). Ensures that \maketitle, \tableofcontents, and so forth are not affected by changes to line spacing.Update data/jats.csl to avoid commas between name-part elements (#5397).
Add support for golang (go) with --listings (#5427).
Text.Pandoc.Shared - improve metaToJSON behavior with numbers. We now do a better job marshalling numbers from MetaString or MetaInlines into JSON Number.
Text.Pandoc.Writers.Shared: metaValueToJSON: use Number Values for integers. Pandoc’s MetaValue doesn’t have a distinguished number type, so numbers are put in MetaStrings. If the MetaString consists entirely of digits, we convert it to a Number. We should probably consider adding a MetaNumber constructor to MetaValue, for better round-tripping with JSON etc. This change aids round-tripping in ipynb metadata fields, like toc_depth.
Text.Pandoc.Class: fetchItem: don’t treat UNC paths as protocol-relative URLs (#5127). These are paths beginning //?/UNC/....
Text.Pandoc.ImageSize: Improve pdfSize so it handles a wider range of PDFs (#4322, with help from Richard Davis).
Text.Pandoc.Pretty: avoid stack overflow by using strict sum (#5401).
Fix harmless error in file-scope code (#5422).
MANUAL.txt:
stack.yaml - remove -Wmissing-home-modules This seems to cause problems with stack ghci. Remove RTS options.
Add ghc-options to cabal.project.
appveyor.yml - use ghc 8.6.4. Fixes segfault issues on Windows (#5037).
linux build process: Remove clone of pandoc-citeproc (#5366). It wasn’t being used; cabal.project specifies the version to use.
Add tectonic as an option for –pdf-engine (#5345, Cormac Relf). Runs tectonic on STDIN instead of a temporary .tex file, so that it looks in the working directory for \include and \input like the rest of the engines. Allows overriding the output directory args with --pdf-engine-opt=--outdir --pdf-engine-opt="$DIR".
Allow -o/--output to be used with --print-default-data-file, --print-highlighting-style, --print-default-template. Note that -o must occur BEFORE the --print* command on the command line (this is documented, #5357).
LaTeX reader:
\underline, \ul, \uline (#5359, Paul Tilley). These are parsed as a Span with class underline, as with other readers.\Footcite and \Footcites get put in a note.ipynb reader:
raw_html, raw_tex extensions. We now include every output format. Pruning is handled by --ipynb-output.ipynb writer:
Docx writer: avoid extra copy of abstractNum and num elements in numbering.xml. This caused pandoc-produced docx files to be uneditable using Word Online (#5358).
Markdown writer: improve handling of raw blocks/inline. We now emit raw content using raw_attribute when no more direct method is available. Use of raw_attribute can be forced by disabling raw_html and raw_tex.
LaTeX writer: Add classes for frontmatter support (#5353, Andrew Dunning) and remove frontmatter from scrreprt.
LaTeX template:
\frontmatter, \mainmatter, and \backmatter. This is not so (e.g. report does not). So pandoc 2.7 breaks on report class by including an unsupported command. Instead of the book-class variable, we use two variables, has-chapters and has-frontmatter, and set these intelligently in the writer.Text.Pandoc.Shared: Improve filterIpynbOutput. Ensure that images are prioritized over text. best should include everything for ipynb.
Tests.Old: specify --data-dir=../data to ensure tests can find data files even if they haven’t been installed. Remove old pandoc_datadir environment variable, which hasn’t done anything for a long time.
MANUAL.txt: Add recommendation to use raw_attribute with ipynb (#5354).
Use cmark-gfm-hs 0.1.8 (note that 0.1.7 is buggy).
Use latest pandoc-citeproc, texmath.
Use XDG data directory for user data directory (#3582). Instead of $HOME/.pandoc, the default user data directory is now $XDG_DATA_HOME/pandoc, where XDG_DATA_HOME defaults to $HOME/.local/share but can be overridden by setting the environment variable. If this directory is missing, then $HOME/.pandoc is searched instead, for backwards compatibility. However, we recommend moving local pandoc data files from $HOME/.pandoc to $HOME/.local/share/pandoc. On Windows the default user data directory remains the same.
Slide show formats behavior change: content under headers less than slide level is no longer ignored, but included in the title slide (for HTML slide shows) or in a slide after the title slide (for beamer). This change makes possible 2D reveal.js slideshows with content in the top slide on each stack (#4317, #5237).
Add command line option --ipynb-output=all|none|best (#5339). Output cells in ipynb notebooks often contain several different versions of an output, with different MIME types, e.g. an HTML table and a plain-text fallback. Specifying --ipynb-output=best (the default) ensures that the best version for the output format is used. all includes all versions, and none suppresses them all, leaving output cells empty.
asciidoctor is now an output format separate from asciidoc, to accommodate some minor implementation-specific differences (currently just in the treatment of display math).
Add latexmk as an option for --pdf-engine (#3195). Note that you can use --pdf-engine-opt=-outdir=bar to specify a persistent temp directory.
Markdown reader:
yamlToMeta respect extensions (#5272, Mauro Bieg). This adds a ReaderOptions parameter to yamlToMeta [API change].LaTeX reader: don’t let \egroup match {. braced now actually requires nested braces. Otherwise some legitimate command and environment definitions can break.
Docx reader (Jesse Rosenthal):
getDocumentPath as getDocumentXmlPath.ReaderEnv.document.xml path once at the beginning of parsing, and add it to the environment, so we can avoid repeated lookups.word/document.xml, but the online word places it in word/document2.xml. This file path is actually stated in the root _rels/.rels file, in the Relationship element with an http://../officedocument type.Muse reader (Alexander Krotov):
<verbatim>.ipynb reader: handle images referring to attachments. Previously we didn’t strip off the attachment: prefix, so even though the attachment was available in the mediabag, pandoc couldn’t find it.
JATS reader:
fig:). More complex figures will still be parsed as divs.fig-group block element (#5317).rid attribute can have a space-separated list of ids.AsciiDoc Writer: Add writeAsciiDoctor [API change, Tarik Graba]. Handle display math appropriately for Asciidoctor.
JATS writer: wrap figure caption in <p> to fix validation (#5290, Mauro Bieg).
HTML writer:
ipynb writer:
jupyter field.--ipynb-output command line option for a way to control what formats are included in the output.Markdown writer: use markdown="1" when appropriate for Divs: when native_divs and markdown_in_html_blocks are disabled but raw_html and markdown_attribute are enabled.
LaTeX writer:
escapeString. This is more elegant than the explicit recursive code we were using.{} after control sequences when escaping. \ldots{}. doesn’t behave as well as \ldots. with the latex ellipsis package. This patch causes pandoc to avoid emitting the {} when it is not necessary. Now \ldots and other control sequences used in escaping will be followed by either a {}, a space, or nothing, depending on context.Powerpoint writer (Jesse Rosenthal): support underlines. Use span with single class “underline” as in docx writer.
Muse writer: escape secondary notes (Alexander Krotov).
FB2 writer: add section identifiers support (#5229, John KetzerX).
Make --fail-if-warnings work for PDF output (#5343).
Lua filters (Albert Krewinkel):
pandoc before calling init.lua (#5287). The file init.lua in pandoc’s data directory is run as part of pandoc’s Lua initialization process. Previously, the pandoc module was loaded in init.lua, and the structure for marshaling was set up after. This allowed simple patching of element marshaling, but made using init.lua more difficult. Now, all required modules are now loaded before calling init.lua. The file can be used entirely for user customization. Patching marshaling functions, while discouraged, is still possible via the debug module.pandoc.List, pandoc.mediabag, pandoc.utils, and text are re-exported from the pandoc module. They are assigned to the fields List, mediabag, utils, and text, respectively.Text.Pandoc.Lua (Albert Krewinkel):
StackInstances into smaller Marshaling modules.CommonState from Lua global. This allows more control over the common state from within Lua scripts.LaTeX template:
subject metadata variable (#5289, Pascal Wagler).\frontmatter, \mainmatter, \backmatter for book classes (#5306).epub3 template: Add titlepage class to section (#5269).
HTML5 template: Add ARIA role doc-toc for table of contents (#4213).
Make --metadata-file use selected extensions (#5279, #5272, Mauro Bieg).
Text.Pandoc.Shared:
withTempDir [API change].defaultUserDataDirs [API change].filterIpynbOutput [API change].compactify: Avoid lists with a mix of Plain and Para elements (#5285).Text.Pandoc.Translations: reorder alphabetically and remove Author (#5334, Mauro Bieg).
Text.Pandoc.Extensions:
all_symbols_escapable to githubMarkdownExtensions.Text.Pandoc.PDF:
epstopdf.pl would not be allowed to write to directories outside the working directory in restricted mode. We now (a) use the system temp dir except when the path includes tildes, and (b) set TEXMFOUTPUT when creating the PDF, so that subsidiary programs can use the system temp directory. This addresses problems that occurred when pandoc was used in a synced directory (such as Dropbox).Text.Pandoc.MIME: add WebP (#5267, Mauro Bieg).
Tests: avoid calling findPandoc multiple times.
Old tests: remove need for temp files by using pipeProcess.
Added simple ipynb reader/writer tests (#5274).
Rearrange --help output in a more rational way, with common options at the beginning and options grouped by function (#5336).
trypandoc: Add JATS and other missing formats (Arfon Smith, #5291).
Add missing copyright notices and remove license boilerplate (#4592, Albert Krewinkel).
Use latest basement/foundation on 32bit windows.
Use latest skylighting (#5328). Custom syntax definitions no longer try to load language.dtd.
Require texmath 0.11.2.1
Use latest pandoc-citeproc (0.16.1.1).
MANUAL.txt:
Support ipynb (Jupyter notebook) as input and output format.
ipynb as input and output format (extension .ipynb).PandocIpynbDecodingError constructor to Text.Pandoc.Error.Error [API change].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:
Ext_task_lists to Extension.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:
start attribute (see #5162).textarea as a verbatim environment (#5241) and preserve spacing.RST reader:
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.sourceCode class on code blocks (#5047).sourcecode directive as synonynm for code (#5204).Markdown reader:
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.<textarea> as a verbatim environment (#5241).Org reader:
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.:minlevel == 0 (#5190).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:
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.\DeclareMathOperator (#5149).\inputminted (#5103).\endinput (#5233).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:
mapLeft from Shared instead of defining own.Docx reader (Jesse Rosenthal):
Docx writer:
subject, lang, category, description.ICML writer (Mauro Bieg):
Texinfo writer: Use header identifier for anchor if present (#4731). Previously we were overwriting an existing identifier with a new one.
Org writer: Preserve line-numbering for example and code blocks (Brian Leung).
Man/Ms writers: Don’t escape - as \-. The \- gets rendered in HTML and PDF as a unicode minus sign.
Ms writer: Ensure we have a newline after .EN in display math (#5251).
RST writer: Don’t wrap simple table header lines (#5128).
Asciidoc writer: Shorter delimiters for tables, blockquotes (#4364). This matches asciidoctor reference docs.
Dokuwiki writer: Remove automatic : prefix before internal image links (#5183, Damien Clochard). This prevented users from making relative image links.
Zimwiki writer: remove automatic colon prefix before internal images (#5183, Damien Clochard).
MediaWiki writer: fix caption, use ‘thumb’ instead of ‘frame’ (#5105). Captions used to have the word ‘caption’ prepended; this has been removed. Also, ‘thumb’ is used instead of ‘frame’ to allow images to be resized.
reveal.js writer:
Markdown writer:
plain RawBlocks pass through in plain output.Commonmark writer:
hard_line_breaks (#5195).--toc (writerTableOfContents) in commonmark/gfm writers (#5172).EPUB writer:
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:
beamer pass through in beamer output (pandoc/lua-filters#40).fragile property in some cases (#5208).# 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:
subject, category, description (#5252, Agustín Martín Barbero).toTableOfContents from Shared to replace old duplicated code.ODT writer (Augustín Martín Barbero):
generator (Pandoc/VERSION), description, subject, keywords, initial-creator (from authors), creation-date (actual creation date) (#5252).Custom writers:
SingleQuoted, DoubleQuoted (#5104).> (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):
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).--pdf-engine=lualatex. It now matches the behaviour of other engines (#5212, #5218).romanfont variable. The functionality of mainfont is identical (#5218).\subtitle with the standard document classes. Previously, subtitle only appeared when using the KOMA-Script classes or Beamer (#5213, #5244).xurl package if available, improving the appearance of URLs by allowing them to break at additional points (#5193).bookmark if available to correct heading levels in PDF bookmarks: see the KOMA-Script 3.26 release notes (#5193).xcolor package to avoid a possible error when using additional packages alongside footnotes in tables (#5193, closes #4861).fixltx2e package, which has no functionality with TeX Live 2015 or later (#5193).fontfamilies.options (#5193, closes #5194).institute variable to Beamer (#5219).footnotehyper package if available to make footnotes in tables compatible with hyperref (#5234).numbersections variable is set, for consistency with other output formats. To return to the previous behaviour, use -V numbersections -V secnumdepth=0 (#5235).--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:
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:
hard_line_breaks works in gfm (see #5195).raw_attribute in documentation for raw_html and raw_tex (#5240, thanks to @eiro).$sep$ must come right before $endfor$ in templates (#5243, Lev Givon).date-meta template variable (#5260, Tristan Stenner).trypandoc: Fix CSS and viewport.
Text.Pandoc.App: split into several unexported submodules (Albert Krewinkel): Text.Pandoc.App.FormatHeuristics, Text.Pandoc.App.Opt, Text.Pandoc.App.CommandLineOptions, Text.Pandoc.App.OutputSettings. This is motivated partly by the desire to reduce recompilations when something is modified, since App previously depended on virtually every other module.
Text.Pandoc.Extensions
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).ascii_identifiers from githubMarkdownExtensions. GitHub doesn’t seem to strip non-ascii characters any more.Text.Pandoc.Lua.Module.Utils (Albert Krewinkel)
equals which performs this test has been added to the pandoc.utils module.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
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
tfoot before body rows (#5079).<small> as a Span with class “small” (#5080).td rather than th (#5014).Text.Pandoc.Readers.LaTeX
\\ in tables.\tiny, \scriptsize, etc. Parse as raw, but know that these font changing commands take no arguments.Text.Pandoc.Readers.Muse
Text.Pandoc.Shared
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.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
.+ as list markers to support nested ordered lists (#5087).[#id .class]#contents# (#5080).Text.Pandoc.Writers.CommonMark
--ascii (#5043, quasicomputational).--ascii affects quotes, super/subscript.Text.Pandoc.Writers.Docx
Text.Pandoc.Writers.EPUB: Handle calibre metadata (#5098). Nodes of the form
<meta name="calibre:series" content="Classics on War and Politics"/>are now included from an epub XML metadata file. You can also include this information in your YAML metadata, like so:
calibre:
series: Classics on War and PoliciticsIn addition, ibooks-specific metadata can now be included via an XML file. (Previously, it could only be included via YAML metadata, see #2693.)
Text.Pandoc.Writers.HTML: Use plain " instead of " outside of attributes.
Text.Pandoc.Writers.ICML: Consolidate adjacent strings, inc. spaces. This avoids splitting up the output unnecessarily into separate elements.
Text.Pandoc.Writers.LaTeX: Don’t emit [<+->] unless beamer output, even if writerIncremental is True (#5072).
Text.Pandoc.Writers.Muse (Alexander Krotov).
--reference-location.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
Templates
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:
MANUAL.txt:
--ascii works for gfm and commonmark too.man to --from options.doc/customizing-pandoc.md: various improvements (Mauro Bieg).
man (Yan Pashkovsky, John MacFarlane).--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 emitting 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:
meta:user-defined tags.lang in metadata. Uncaptioned tables are not enumerated.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
...
endRaw table fields of AST elements should be considered an implementation detail and might change in the future. Accessing element properties should always happen through the fields listed in the Lua filter docs.
Note that the iterator currently excludes the t/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.
Text.Pandoc.Options: add writerPreferAscii to WriterOptions.
Text.Pandoc.Shared:
splitSentences. This was previously duplicated in the Man and Ms writers.ToString typeclass (Alexander Krotov).New exported module Text.Pandoc.Filter (Albert Krewinkel).
Text.Pandoc.Parsing
gridTableWith to any Char Stream (Alexander Krotov).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
toSuperscript and toSubscript (quasicomputational, #4528).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.)metaValueToString.Text.Pandoc.Lua
Expose more useful internals (Albert Krewinkel):
runFilterFile to run a Lua filter from file;Global and its constructors; andsetGlobals 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).
Text.Pandoc.Parsing
uri accept any stream with Char tokens (Alexander Krotov).uri without withRaw (Alexander Krotov).parseFromString and parseFromString' to any streams with Char token (Alexander Krotov)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
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:
F, runF and stateMeta' in favor of stateMeta (Alexander Krotov).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 +\fooiiImprove 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
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)
museToPandocTable to get rid of partial functions.{{{ and }}}.+.Text.Pandoc.Writers.LaTeX
--listings, don’t pass through org-babel attributes (#4889).--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}.Text.Pandoc.Writers.Man
.SH and .SS lines (#5019)..RS/.RE pair in definition lists with one paragraph definitions.\f[CB] not \f[BC], see #4973).\f[R] instead of \f[] to reset font (Alexander Krotov, #4973).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
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
escapeBar. We don’t need this now that we use @ for math delim.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.
LaTeX template:
hyperrefoptions (#4925, Mathias Walter).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).
INSTALL.md
MANUAL.txt
groff -> roff.--ascii for Markdown writer.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).
Makefile
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.
RST reader:
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:
Muse reader (Alexander Krotov):
<literal> tag parsersConTeXt 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:
--biblatex (Brian Leung, #4930). The multiprenotes occur before the first prefix of a multicite, and the multipostnotes follow the last suffix.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:
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.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):
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:
ArgSpec (API change).Macro constructor is now [ArgSpec] instead of Int (API change).Markdown reader:
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.example_lists work for interrupted lists without startnum (#4908).HTML reader:
<script type="math/tex tags as math (#4877). These are used by MathJax in some configurations.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):
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.LaTeX reader:
\def (#4768, #4771). For example: \def\foo#1[#2]{#1 and #2}.% characters in URLs. This affects \href and \url (#4832).\texorpdfstring. We were returning the wrong argument as the content.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).\|, \b, \G, \h, \d, \f, \r, \t, \U, \i, \j, \newtie, \textcircled. Also fall back to combining characters when composed characters are not available.\ref for figure numbers.mintinline (#4365, Marc Schreiber).\l outside of an siunitx context should be l-slash, not l (for liter).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):
</quote> in indented tag test. There is already a separate test for unclosed </quote>.headingStart function.* or **.<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):
envInsideBlock = True when rendering notes."" instead of [] for empty String.-, ; and > in the beginning of strings.conditionalEscapeString never returns empty string.Muse type. This removes the need to pass envInsideLinkDescription to it.shouldEscapeString function.Docx writer:
HTML writer:
<dt> element, even if it is empty (#4883, Alexander Krotov).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:
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:
.. raw:: latex for tex content... container for generic Divs, instead of raw HTML.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:
--biblatex/--natbib don’t work directly for PDF (#4904).epub:type attribute (Mauro Bieg, #4901)--resource-path has an effect.--listings (#4871, Damien Clochard).--katex-stylesheet (Mauro Bieg, #4862).CONTRIBUTING.md:
lua-filters.md: add links to filters, and to lua-filters repository (#4874).
INSTALL.md:
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.
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.
RST reader: improve parsing of inline interpreted text roles (#4811).
B.text to split up contents into Spaces, SoftBreaks, and Strs for title-reference.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:
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.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:
csquotes is used in LaTeX writer (#4514).commonmark to list of output formats where raw_tex has an effect (see #4527).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:
gfm vs markdown_github (#4783, Mauro Bieg).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).
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:
lilypond as a verbatim environment (#4725).\graphicspath arguments (#4698).\input can now be used in an inline context, e.g. to provide part of a paragraph, as it can in LaTeX.rawLaTeXBlock, handle macros that resolve to a \begin or \end (#4667).rawLaTeXBlock, don’t expand macros in macro definitions (#4653). Note that this only affected LaTeX in markdown.\item), since they can occur in many contexts in beamer.Markdown reader:
` `.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):
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:
--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:
FB2 writer (Alexander Krotov):
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:
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:
true, True, TRUE. NOTE! y, yes, on no longer count as true values.-F as alias for --filter (thanks to Gandalf Saxe).--toc requires --standalone (#4703).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.
Restored and undeprecated gladtex for HTML math (#4607).
GladTeX constructor to Text.Pandoc.Options.HTMLMathMethod [API change, reverts removal in v2.2]--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:
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):
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:
title="" (#2944).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.EPUB reader:
LaTeX reader:
\ref and chapters (#4529).\MakeUppercase, \MakeLowercase, \uppercase, \lowercase, and also \MakeTextUppercase and \MakeTextLowercase from textcase (#4959).Textile reader:
Mediawiki reader:
! characters in cells.DocBook reader:
section element (#4526). Previously we just got section_title for section (though sect1, sect2, etc. were handled properly).Docx reader:
RST reader:
Muse reader (Alexander Krotov):
<math> tag support.<biblio> and <play> tags.<literal> tags to be on separate lines.- in anchors.Muse writer (Alexander Krotov):
> only at the beginning of a line.] in image title.] brackets in URLs as %5D.; to avoid accidental comments.--wrap=preserve for all tests by default.<verbatim> tags in output.RST writer:
EPUB writer:
pagetitle is always set, even when structured titles are used. This prevents spurious warnings about empty title elements (#4486).FB2 writer (Alexander Krotov):
abstract to book annotation.<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):
ParseXml.Maybe from SpeakerNotes in Slide. mempty means no speaker notes.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.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:
CommonMark writer:
raw_tex is not enabled (#4527, quasicomputational).EPUB writer:
epub:type="footnotes" to notes section in EPUB3 (#4489).LaTeX writer:
\lstinline delimiters (#4369, Tim Parenti).Ms writer:
\f[R] rather than \f[] to reset font (#4552).\f[BI] and \f[CB] in headers, instead of \f[I] and \f[C], since the header font is automatically bold (#4552).\f[CB] rather than \f[BC] for monospace bold (#4552)./ character in anchor ids (#4515).Man writer:
' (#4550).Text.Pandoc.Options:
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:
romanNumeral parser (#4480). We previously accepted ‘DDC’ as 1100.uri: don’t treat * characters at end as part of URI (#4561).Text.Pandoc.MIME:
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:
withTempDir in html2pdf.xelatex, don’t compress images til the last run (#4484). This saves time for image-heavy documents.pdflatex converts them itself, and JuicyPixels can’t do it.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:
beameroption variable (#4359, Étienne Bersac).pgfpages package; this is needed for notes on second screen in beamer (Étienne Bersac).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:
docx/openxml and some others.empty_paragraphs affects markdown output (#4540).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):
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).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):
<class> tag (supported by Emacs Muse).LaTeX reader:
\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:
Emph [], so we just ignore elements like this (Francesco Occhipinti).Muse writer (Alexander Krotov):
<verbatim></verbatim>.Dokuwiki writer: fix LineBreaks in Tables (#4313, Mauro Bieg).
Ms writer:
\-; 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 with current working directory (#4413, Mauro Bieg). This helps ensure that linked resources are included.
Add Semigroup instances for everything for which we defined a Monoid instance previously (API change):
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):
stripLeadingTrailingSpace.--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:
:::, 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:
--trace work.tabular* environment (#4279).RST reader:
Muse reader (Alexander Krotov):
<literal> tags even if amuse extension is enabled. Amusewiki disables <literal> tag contents.<quote> and other tags to be indented.parseFromString. Lists are parsed in linear instead of exponential time now.definitionListItem to definitionList.or list.
<code>.Docx reader (Jesse Rosenthal, except where noted):
+styles is enabled.+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.Muse writer (Alexander Krotov):
> instead of <verse> tag.<verse>.~~).Powerpoint writer (Jesse Rosenthal):
notesMaster to presentation.xml if necessary.Markdown writer: properly escape @ to avoid capture as citation (#4366).
LaTeX writer:
ConTeXt writer (Henri Menke):
--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.Docx writer:
getUniqueId now calls to the state to get an incremented digit, instead of calling to P.uniqueHash.--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:
height instead of depth for images (#4331).role attribute; that was a leftover from the Docbook writer.AsciiDoc writer:
asciidoc-auto_identifiers for old behaviour.RST writer:
blockToRST' moving its logic into fixBlocks (Francesco Occhipinti).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:
Text.Pandoc.Extensions:
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).Ext_raw_html default for commonmark format.Text.Pandoc.Parsing:
manyUntil (Alexander Krotov, API change).sepBy1 (Alexander Krotov).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).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:
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:
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:
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):
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):
~~ as non-breaking space in Text::Amuse mode.Powerpoint writer (Jesse Rosenthal):
notesSlide to endNotesSlide.picProps._rels/.rels file.Presentation.hs out of PandocMonad.--reference-doc. Templating should work much more reliably now.--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.[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.envCurSlideId available to blocks.curSlideId to environment.toc-title in metadata.Markdown writer:
pandoc -f markdown -t markdown.LaTeX writer:
& in lstinline (Robert Schütz).ConTeXt writer:
ntb extension is set.HTML writer:
--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):
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.pandoc.utils.run_json_filter, which runs a JSON filter on a Pandoc document.Text.Pandoc.Filter.JSON, Text.Pandoc.Filter.Lua, and Text.Pandoc.Filter.Path.data/pandoc.lua (Albert Krewinkel):
{pandoc.Str "text"} in constructors.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._VERSION. Having a _VERSION became superfluous, as this module is closely tied to the pandoc version, which is available via PANDOC_VERSION.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:
latex_macros extension.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:
inlinesInBalancedBrackets. The rewrite is much more direct, avoiding parseFromString. And it performs significantly better; unfortunately, parsing time still increases exponentially (see #1735).\ + letter seen. This seems to help with the performance problem, #4216.LaTeX reader: Simplified a check for raw tex command.
Muse reader (Alexander Krotov):
#cover into #cover-image. Amusewiki uses #cover directive to specify cover image.Docx reader (Jesse Rosenthal):
--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.w:sdtContents.Muse writer (Alexander Krotov): don’t escape URIs from AST
Docx writer:
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 2016Powerpoint writer (Jesse Rosenthal):
replaceNamedChildren function.[](http://www.example.com) will now produce a linked image in the resulting PowerPoint file.<a:p> tag, even if the cell contains no paragraphs—otherwise PowerPoint complains of corruption.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.:
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.
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.
readJATS (API change) (Hamish Mackenzie).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:
\placeformula as context.: 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.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.tokenize, untokenize (API change).applyMacros in rawLaTeXBlock, rawLaTeXInline.inlineCommand.^^ 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.\foreignlanguage from babel.& character (#4208). This allows us to parse unknown tabular environments as raw LaTeX.Muse reader (Alexander Krotov):
Org reader (Albert Krewinkel):
: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.OPML reader:
-f opml-smart-raw_html.RST reader:
`my *link*`_.Docx reader:
w:sdt elements (Jesse Rosenthal, #4190).Plain writer:
RST writer:
_.PowerPoint writer (Jesse Rosenthal):
blockQuote runProp, which only affected the size of blockquotes. We can use this for notes, etc.Docx writer:
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:
Muse writer (Alexander Krotov):
HTML writer:
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:
\renewcommand for \textlatin with babel (#4161). This avoids a clash with a deprecated \textlatin command defined in Babel.\endhead after \toprule in headerless tables (#4207).FB2 writer:
cover-image meta (Alexander Krotov, #4195).JATS writer (Hamish Mackenzie):
<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.<p> optional in <td> and <th> (#4178).Custom writer:
data/init) that is used to setup the Lua interpreter for Lua filters is also used to setup the interpreter of custom writers.lua.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.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):
pandoc.utils module, to hold utility functions.pandoc lua module.pandoc.mediabag modules to a separate Haskell module.sha1 from the main pandoc module to pandoc.utils.pandoc.utils.hierarchicalize (convert list of Pandoc blocks into (hierarchical) list of Elements).pandoc.utils.normalize_date (parses a date and converts it (if possible) to “YYYY-MM-DD” format).pandoc.utils.to_roman_numeral (allows conversion of numbers below 4000 into roman numerals).pandoc.utils.stringify (converts any AST element to a string with formatting removed).data/init.lua: load pandoc.utils by defaultpipe 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.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:
+smart by default.--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:
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.
--strip-empty-paragraphs option. Instead we now use an empty_paragraphs extension that can be enabled on the reader or writer. By default, disabled.Ext_empty_paragraphs constructor to Extension.empty_paragraphs extension in docx reader and writer, opendocument writer, html reader and writer.empty_paragraphs extension.Markdown reader:
--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):
#disable-tables directive in Emacs 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):
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.package.loaders in Lua 5.1 and LuaJIT, and package.searchers in Lua 5.2 and later.package.searchers. The modules pandoc and pandoc.mediabag can now be loaded via require.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):
nested.~~ as non-breaking space in Emacs mode.<literal> support.Docx writer: allow empty paragraphs (#2252).
CommonMark/gfm writer:
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):
<em>a</em><em>b</em><em>c</em>.---- to avoid accidental horizontal rules.</code> inside code tag.<verbatim> is not needed as <code> is verbatim already.LaTeX writer:
keepaspectratio, this yields the desired result.~ 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)
endThe 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
endAllow 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).
HasSyntaxExtensions typeclass for ReaderOptions and WriterOptions.isEnabled function from Options.hs to accept both ReaderOptions and WriterOptions.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):
--wrap=preserve.-amuse. Emacs Muse does not require indentation.HTML reader:
\( 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.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:
*{2}{r} (#4056). This is equivalent to rr. We now expand it like a macro.\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:
|-). 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:
--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):
unrecognised genre to <title-info> (Alexander Krotov). XML schema requires at least one genre.<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:
lineAnchors (or line-anchors) in HTML code blocks.cb1, cb2, etc.Added a few abbreviations to data/abbreviations, and sorted the list (#3984, Wandmalfarbe).
Improved support for columns in HTML writer (#4028).
width attribute from the div.<div class="column"> elements, since this prevents columns whose widths sum to 100% (the space takes up space).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).
INSTALL.md: MacOS instructions needed xar -f (adam234).
MANUAL.txt:
fenced_divs (#4039, Tristano Ajmone).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):
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):
<p> in definitions.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:
LaTeX reader:
Linux package build: ensure that pandoc-citeproc is statically linked.
trypandoc: add native, ms.
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 after 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.xhtmlAdded --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). Dfault abbreviations file (data/abbreviations) contains a list of strings that will be recognized by pandoc’s Markdown parser as abbreviations. (A nonbreaking space will be inserted after the period, preventing a sentence space in formats like LaTeX.) Users can override the default by putting a file abbreviations in their user data directory (~/.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
- bwill be parsed as a list item with a sublist; under the four-space rule, it would be a list with two items.
- a
codeHere we have an indented code block under the list item, even though it is only indented six spaces from the margin, because it is four spaces past the point where a continuation paragraph could begin. With the four-space rule, this would be a regular paragraph rather than a code block.
- a
codeHere the code block will start with two spaces, whereas under the four-space rule, it would start with code. With the four-space rule, indented code under a list item always must be indented eight spaces from the margin, while the new rules require only that it be indented four spaces from the beginning of the first non-space text after the list marker (here, a).
This change was motivated by a slew of bug reports from people who expected lists to work differently (#3125, #2367, #2575, #2210, #1990, #1137, #744, #172, #137, #128) and by the growing prevalance of CommonMark (now used by GitHub, for example). Those who prefer the old behavior can use -f markdown+four_space_rule.
Added four_space_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]: urlThis was previously enabled by default; now it is 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 requirse a space between the opening #’s and the header text in ATX headers (as CommonMark does but many other implementations do not). This is desirable to avoid falsely capturing things ilke
#hashtagor
#5Add 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: verticalReader 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:
-o option is not used, binary output is never sent to stdout by default; instead, an error is raised.-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 comments. In issue comments, a line break is treated as a hard line break. In README, wikis, etc., it is treated as a space as in regular Markdown. Since pandoc is more likely to be used to convert long-form documents from GitHub Markdown, -hard_line_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:
lang attribute (#1667).--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 I left a comment.some text to have a comment on it.
We assume also that the id attributes are unique and properly matched between comment-start and comment-end.
Bookmark improvements. Bookmark start/end now surrounds content rather than preceding it. Bookmarks generated for Div with id (jgm/pandoc-citeproc#205).
Add 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:
<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.footnoteBack to footnote back references (Timm Albers). This allows for easier CSS styling.data-src instead of src for images for lazy loading..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):
table.el tables (#3314).#+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.keywords (comma-separated list of inlines), subtitle (inline values), nocite (inline values, can be repeated).\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.comHere both hello and goodbye should link to example.com.
Support anchors (#262). E.g.
`hello`
.. _hello:
paragraphThis 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:
\graphicspath (#736).\begin{tabular}{>{$}l<{$}>{$}l<{$} >{$}l<{$}} each cell will be interpreted as if it has a $ before its content and a $ after (math mode).\dedication (#1845). It now adds a dedication field to metadata. It is up to the user to supply a template that uses this variable.\textXX commands, where XX = rm, tt, up, md, sf, bf (#3488). Spans with a class are used when there is nothing better.\newenvironment macros (#987).\vdots (Marc Schreiber, #3607).\textcolor support (Marc Schreiber).tabularx environment (Marc Schreiber, #3632).\end{eqnarray} inside an eqnarray (among other things).raw_tex extension is selected (#3692). Otherwise skip with a warning. This is better than trying to parse it as text!\colorbox support (Marc Schreiber).\label.\setmainlanguage set lang in metadata.\ifstrequal.plainbreak, fancybreak et al from the memoir class (bucklereed, #3833).\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.\def macros. Note that we still don’t support macros with fancy parameter delimiters, like \def\foo#1..#2{...}.\chaptername, \partname, \abstractname, etc. (#3559, obsoletes #3560).\ref, \label, \eqref commands into Span with attributes, so they can be handled in filters (Marc Schreiber, #3639)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.Link instead of Span for \ref. This makes more sense semantically and avoids unnecessary Span [Link] nestings when references are resolved.\hyperlink.\textquoteleft|right, \textquotedblleft|right (#3849).\lq, \rq.\newtoggle, \iftoggle, \toggletrue|false from etoolbox (#3853).\RN and \Rn, from biblatex (bucklereed, #3854).\hyperlink, \hypertarget (#2549).\k ogonek accent.\"{}.\faCheck and \faClose (Marc Schreiber, #3727).xspace (Marc Schreiber, #3797).\setmainlanguage or \setdefaultlanguage (polyglossia) and \figurename.\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.\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).\text(LANG){...} (bucklereed)\include wouldn’t work if the included file contained, e.g., a begin without a matching end.\expandafter (#3983).\DeclareRobustCommand (#3983). Currently it’s just treated as a synonym for \newcommand.\lettrine (Mauro Bieg).Math improvements due to updates in texmath:
\boldsymbol + a token without braces, and similarly with other styling commands.\mathop to allow multi-character operator names.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:
powershell has been added, and many syntax definitions have been updated.kate style.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.
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.)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.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.
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.
StringWriter -> TextWriter.getWriter 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.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', exportingMacro,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.SharedText.Pandoc.ParsingText.Pandoc.AsciifyText.Pandoc.EmojiText.Pandoc.ImageSizeText.Pandoc.Highlighting `New module Text.Pandoc.Extensions (Albert Krewinkel): Extension parsing and processing functions were defined in the top-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:
fromText, fromTextLazy, toText, toTextLazy. Define toString, toStringLazy in terms of them.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.SyntaxMap to highlight.Text.Pandoc.Writers.Math:
defaultMathJaxURL, defaultKaTeXURL. This will ensure that we only need to update these in one place.Text.Pandoc.SelfContained:
WriterOptions parameter from makeSelfContained.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.makeDataURI.Text.Pandoc.ImageSize:
lengthToDim, new function scaleDimension.inEm from ImageSize (#3450).showFl and show instance for Dimension so extra decimal places are omitted.Em as a constructor of Dimension.WriterOptions parameter to imageSize signature (Mauro Bieg).Text.Pandoc.Templates:
renderTemplate'. Now it runs in PandocMonad and raises a proper PandocTemplateError if there are problems, rather than failing with uncatchable error.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:
writerEpubSubdirectory to WriterOptions (#3720). The EPUB writer now takes its EPUB subdirectory from this option.WriterOptions, rename writerLaTeXEngine to writerPdfEngine and writerLaTeXArgs to writerPdfArgs (Mauro Bieg, #3909).writerSyntaxMap to WriterOptions.writerEpubStylesheet from WriterOptions.writerUserDataDir from WriterOptions. It is now carried in CommonState in PandocMonad instances. (And thus it can be used by readers too.)writerEpubMetadata to a Maybe String.readerApplyMacros from ReaderOptions. Now we just check the latex_macros reader extension.ReaderOptions.HTMLMathMethod, the KaTeX contsructor now takes only one string (for the KaTeX base URL), rather than two.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.normalizeSpaces (#1530).warn. (Use report from Text.Pandoc.Class instead.)crFilter.eastAsianLineBreakFilter (previously in Markdown reader).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.err.readDataFile, readDefaultDataFile, getReferenceDocx, getReferenceODT. These now live in Text.Pandoc.Class, where they are defined in terms of PandocMonad primitives and have different signatures.openURL. Use openURL from Text.Pandoc.Class instead.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.)
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:
r gets you <source> rather than <code> (among others).<math> tags (#3452). This allows display math to be rendered properly.</ref> (#2652).Org writer:
# from Org anchor links (Alexander Krotov).CommonMark writer:
--wrap=none.SmallCaps (#1592).RST writer:
+/-smart and improved escaping with +smart.gridTable in Writers.Shared, which is here improved to better handle 0-width cells.:literal: role (#3974).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:
DocBook writer:
writerIdentifierPrefix opt (#3397, Mauro Bieg).Docx writer:
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.Div.Set for dynamic styles to avoid duplicates.evenAndOddHeaders from reference docx (#3901, Augustín Martín Barbero).ODT/OpenDocument writer:
() delimiters. However, arguably it creates overly wide labels for bullets. Also, lists now start flush with the margin, rather than indented.FB2 writer:
RawBlock as code.LineBlock as poem (Alexander Krotov). Previously writer produced one paragraph with <empty-line/> elements, which are not allowed inside <p> according to FB2 schema.concatMap with cMap (Alexander Krotov).<p> (Alexander Krotov, #4004)HTML writer:
html4, html5 formats work for raw blocks/inlines.--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.lang is unspecified (#3486).dimensionsToAttributeList.uri class (#3716).writerIdentifierPrefix opt (#3397, Mauro Bieg).LaTeX writer:
--extract-media can be used when the input contains data: URIs.% after hypertarget before code block.\leavevmode before hypertarget at start of paragraph (#2704, fixes formatting problems in beamer citations).lstinline in \item[..] (#645). If you do, the contents of item disappear or are misplaced. Use \texttt instead.lstinline (#1629). Previously the LaTeX writer created invalid LaTeX when --listings was specified and a code span occurred inside emphasis or another construction.~ if no printable content has yet been emitted.--listings (#3422).€ directly, making the \euro command unneeded.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.\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.ConTeXt writer:
$ (Alexander Krotov, #3482).EPUB writer:
title_page.xhtml is now put in text/.Textile reader:
HTML reader:
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).details tag to list of block tags (#3694).button from block tag list (#3717). It is already in the eitherBlockOrInlineTag list, and should be both places.Sets instead of lists for block tag lookup.Text throughout. Effect on memory usage is modest (< 10%).<html> to set the lang meta value (bucklereed, #3765).</p> (#3794).<figure> and <figcaption> (Mauro Bieg, #3813).<main> like <div role=main> (bucklereed, #3791). <main> closes <p> and behaves like a block element generallywidth attribute or with text-width in a style attribute.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:
MediaWiki reader:
|- in tables (#2649).smart extension (#3585).<tt> contexts (#3585). Even if +smart.HasLogMessages, so registerHeader can issue warnings.TWiki reader (Alexander Krotov):
$ (#3597).linkText (#3605).EPUB reader:
Docx reader:
trimLineBreaks. This does the work of normalizeSpaces as well, so we avoid the need for that function here.ODT reader:
collectRights with Rights from Data.Either.Org reader (Albert Krewinkel, unless noted).
[ (#3577).-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.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.nullMeta by applying setMeta directly (Alexander Krotov).sequence . map with mapM.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.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.tags export option is set to nil.tag-name attribute instead of data-tag-name.org-language attribute rather than data-org-language.HasLogMessages, so registerHeader can issue warnings.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
- dHandle 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:
| character inside math. (Or for that matter something that the parser might mistake for raw HTML.)smallcaps as SmallCaps. This allows users to specify small caps in Markdown this way: [my text]{.smallcaps} (#1592).shortcut_reference_links to the list of mmd extensions.nonindentSpaces. Makes the benchmark go from 40 to 36 ms.markdown_in_html_blocks is used. This is better than having things interpreted as indented code blocks.*foo*'s 'foo'.anyLineNewline (Alexander Krotov).| 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.@ if the citations extension is enabled.-@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.\start (#3558). Previously these weren’t allowed because they were interpreted as starting ConTeXt environments, even without a corresponding \stop…inlines, inlines1.implicit_figures (#2844). A figure with an empty caption doesn’t make sense.LaTeX reader:
\, to \8198 (six-per-em space) (Henri Werth).\newcommand\foo{blah} without braces.\lstinputlisting (#2116).\parbox.\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.\hypertarget.\cite arguments.{{xxx}} the same as {xxx} (#2115).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.\ref{}, \label{} with +raw_tex. Now these commands are parsed as raw if +raw_tex; otherwise, their argument is parsed as a bracketed string.enumerate environment (#3707).& inside table cell (#3708).minipage is no longer required.0.9\linewidth. Anything else would have to be converted to a percentage, using some kind arbitrary assumptions about line widths.\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.\titleformat (#3804).\startXXX command (which might start a raw ConTeXt environment).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.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.label instead of data-label for label in caption (#3639).\figurename etc.\let\a=0 case, with single character token.@ 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.] inside group in option brackets (#3857).\noindent foo break and turn into \noindentfoo. Affects -f latex+raw_tex and -f markdown (and other formats that allow raw_tex).\texttt contexts.\includegraphics behaviour (Ben Firshman).= in bracketd options (Ben Firshman).\include filenames.Added Text.Pandoc.CSV, simple (unexported) CSV parser.
Text.Pandoc.PDF:
--resource-path working with PDF output (#852).report instead of warn, make it sensitive to verbosity settings.fillMediaBag and extractMedia to extract media to temp dir. This reduces code duplication.html2pdf: use stdin instead of intermediate HTML fileTEXINPUTS stuff for context2pdf. mkiv context doesn’t use TEXINPUTS.Text.Pandoc.Pretty:
realLength.Text.Pandoc.MIME:
application/javascript (not application/x-javascript).emf to mimeTypes with type application/x-msmetafile (#1713).Text.Pandoc.ImageSize:
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:
getDataURI in SelfContained.</script> or a style contains </.data-src (needed for lazy loading in reveal.js slide shows).data-background-image attribute on section (#3979).Text.Pandoc.Parsing:
indentWith (Alexander Krotov, #3687).stateCitations to ParserState.stateChapters from ParserState.ParserState, make stateNotes' a Map, add stateNoteRefs.gobbleSpaces and gobbleAtMostSpaces.insertIncludedFile so it can be used with token parser.insertIncludedFile.HasLogMessages, logMessage, reportLogMessages (#3447).HasIncludeFiles type class (Albert Krewinkel). The insertIncludeFile function is generalized to work with all parser states which are instances of that class.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.parseFromString (#3690). This is a version 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_.takeP, takeWhileP for efficient parsing of [Char].blanklines documentation (Alexander Krotov, #3843).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.”anyLineNewline (Alexander Krotov).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.returnF (Alexander Krotov).Notes:** as a bare URI (#3570). This avoids parsing bare URIs that start with a scheme + colon + *, _, or ].readerAbbreviations to ParserState. Markdown reader now consults this to determine what is an abbreviation.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.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 Futures.Text.Pandoc.Shared:
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:
metaToJSON', addVariablesToJSON (#3439). This allows us to add the variables AFTER using the metadata to generate a YAML header (in the Markdown writer).unsmartify (previously in RST writer). Undo literal double curly quotes. Previously we left these.metaToJSON so it can take a Text. Previously a String was needed as argument; now any ToJSON instance will do.gridTable (previously in Markdown writer).gridTable: Refactored to use widths in chars.gridTable: remove unnecessary extra space in cells.addVariablesToJSON. It was previously not allowing multiple values to become lists.HTML templates (including EPUB and HTML slide show templates):
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..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:
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.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.xcolor names (Andrew Dunning). Prevents changes to documents defined using the dvipsnames list (e.g. Blue gives a different result with svgnames enabled).polyglossia after header-includes (#3898). It needs to be loaded as late as possible.unicode-math (Vaclav Haisman). Use mathspec with only XeLaTeX on request.fontspec before unicode-math (over there). The unicode-math package loads fontspec so explicit loading of fontspec before unicode-math is not necessary.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).dvipsnames options when colorlinks specified (otherwise we get an error for maroon) (Thomas Hodgson).titlegraphic and logo variables (Thomas Hodgson).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.natbiboptions variable (#3768).\href robust.parskip before hyperref (Václav Haisman, #3654).luatexja-fontspec and luatexja-preset packages. Use existing CJKmainfont and CJKoptions template variables. Add luatexjafontspecoptions for luatexja-fontspec and luatexjapresetoptions for luatexja-preset.aspectratio variable to beamer template (Václav Haisman, #3723).lang variable handling to immediately before bidi.ConTeXt template: Improved font handling: simplefonts is now obsolete in ConTeXt (Pablo Rodríguez).
MANUAL.txt:
--webtex SVG url (Mauro Bieg, #3471)meta-json does not contain plain text values or JSON output format but field values transformed to the selected output format.COPYRIGHT:
INSTALL.md:
CONTRIBUTING.md:
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.
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:
make haddock from make full.lint target.make full. Disable optimizations. Build everything, inc. trypandoc and benchmarks. Use parallel build.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:
Org reader (Albert Krewinkel):
#+FORMAT: raw line, where FORMAT must be one of latex, beamer, html, or texinfo./*strong and emphasized*/) was interpreted incorrectly in that the inner markup was not recognized.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:
Markdown reader:
-f markdown_github-hard_line_breaks+escaped_line_breaks (#3341). Previously this did not properly enable escaped line breaks.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:
\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.)microtypeoptions to microtype (Václav Haisman).Moved make_osx_package.sh to osx/ directory.
Travis continuous integration:
MANUAL.txt:
--wrap=auto does not work in HTML output.--columns width is 72, not 80.@* in nocite section (#3333, John Muccigrosso).INSTALL.md:
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.
Set PANDOC_VERSION environment variable for filters (#2640). This allows filters to check the pandoc version that produced the JSON they are receiving.
Docx reader: Ensure one-row tables don’t have header (#3285, Jesse Rosenthal). Tables in MS Word are set by default to have special first-row formatting, which pandoc uses to determine whether or not they have a header. This means that one-row tables will, by default, have only a header – which we imagine is not what people want. This change ensures that a one-row table is not understood to be a header only. Note that this means that it is impossible to produce a header-only table from docx, even though it is legal pandoc. But we believe that in nearly all cases, it will be an accidental (and unwelcome) result
HTML reader:
style=width: as well as width in col (#3286).RST reader:
Print warnings when keys, substitition, notes not found. Previously the parsers failed and we got raw text. Now we get a link with an empty URL, or empty inlines in the case of a note or substitution.
Fix hyperlink aliases (#3283).
Man writer: Ensure that periods are escaped at beginning of line (#3270).
LaTeX writer: Fix unnumbered headers when used with --top-level (#3272, Albert Krewinkel). Fix interaction of top-level divisions part or chapter with unnumbered headers when emitting LaTeX. Headers are ensured to be written using stared commands (like \subsection*{}).
LaTeX template: use comma not semicolon to separate keywords for pdfkeywords. Thanks to Wandmalfarbe.
Markdown writer: Fixed incorrect word wrapping (#3277). Previously pandoc would sometimes wrap lines too early due to this bug.
Text.Pandoc.Pretty: Added afterBreak [API change]. This makes it possible to insert escape codes for content that needs escaping at the beginning of a line.
Removed old MathMLInHTML.js from 2004, which should no longer be needed for MathML with modern browsers.
Fixed tests with dynamic linking (#2709).
Makefile: Use stack instead of cabal for targets. This is just a convenience for developers.
Fixed bash completion of filenames with space (#2749).
MANUAL: improved documentation on how to create a custom reference.docx.
Fix minor spelling typos in the manual (#3273, Anthony Geoghegan)
Changed resolution of filter paths.
--filter as a full (absolute or relative) path, looking for a program there. If it’s found, we run it.$DATADIR/filters.Previously if you did --filter foo and you had foo in your path and also an executable foo in your working directory, the one in the path would be used. Now the one in the working directory is used.
In addition, when you do --filter foo/bar.hs, pandoc will now find a filter $DATADIR/filters/foo/bar.hs – assuming there isn’t a foo/bar.hs relative to the working directory.
Allow file:// URIs as arguments (#3196). Also improved default reader format detection. Previously with a URI ending in .md or .markdown, pandoc would assume HTML input. Now it treats these as markdown.
Allow to overwrite top-level division type heuristics (#3258, Albert Krewinkel). Pandoc uses heuristics to determine the most reasonable top-level division type when emitting LaTeX or Docbook markup. It is now possible to overwrite this implicitly set top-level division via the top-level-division command line parameter.
Text.Pandoc.Options [API changes]:
writerStandalone field in WriterOptions, made writerTemplate a Maybe value. Previously setting writerStandalone = True did nothing unless a template was provided in writerTemplate. Now a fragment will be generated if writerTemplate is Nothing; otherwise, the specified template will be used and standalone output generated.Division has been renamed TopLevelDivision (#3197). The Section, Chapter, and Part constructors were renamed to TopLevelSection, TopLevelChapter, and TopLevelPart, respectively. An additional TopLevelDefault constructor was added, which is now also the new default value of the writerTopLevelDivision field in WriterOptions.Improved error if they give wrong arg to --top-level-division.
Use new module from texmath to lookup MS font codepoints in Docx reader. Removed unexported module Text.Pandoc.Readers.Docx.Fonts. Its code now lives in texmath (0.9).
DocBook reader: Fixed xref lookup (#3243). It previously only worked when the qnames lacked the docbook namespace URI.
HTML reader:
<math> as MathML by default unless something else is explicitly specified in xmlns. Provided it parses as MathML, of course. Also fixed default which should be to inline math if no display attribute is used.Docx reader (Jesse Rosenthal):
[CHART] in a <span class="chart">. Note that it maps to inlines because, in docx, anything in a drawing tag can be part of a larger paragraph.w:drawing, because that could also include charts. Now we specify w:drawing/pic:pic. This shouldn’t change behavior at all, but it’s a first step toward allowing other sorts of drawing data as well.elemName. Previously, if given an empty namespace (elemName ns "" "foo") elemName would output a QName with a Just "" namespace. This is never what we want. Now we output a Nothing. If someone does want a Just "" in the namespace, they can enter the QName value explicitly.ODT reader/writer:
Inline code when text has a special style (Hubert Plociniczak). When a piece of text has a text Source_Text then we assume that this is a piece of the document that represents a code that needs to be inlined. Adapted the writer to also reflect that change. Previously it was just writing a ‘preformatted’ text using a non-distinguishable font style. Code blocks are still not recognized by the ODT reader. That’s a separate issue.
Infer table’s caption from the paragraph (#3224, Hubert Plociniczak). ODT’s reader always put empty captions for the parsed tables. This commit
The ODT writer used the TableCaption style for the caption paragraph. This commit follows the OpenOffice approach which allows for appending captions to table but uses a built-in style named Table instead of TableCaption. Users of a custom reference.odt should change the style’s name from TableCaption to Table.
ODT reader: Infer tables’ header props from rows (#3199, Hubert Plociniczak). ODT reader simply provided an empty header list which meant that the contents of the whole table, even if not empty, was simply ignored. While we still do not infer headers we at least have to provide default properties of columns.
Markdown reader:
Allow reference link labels starting with @... if citations extension disabled (#3209). Example: in
\[link text\]\[@a\]link text isn’t hyperlinked because [@a] is parsed as a citation. Previously this happened whether or not the citations extension was enabled. Now it happens only if the citations extension is enabled.
Allow alignments to be specified in Markdown grid tables. For example,
+-------+---------------+--------------------+
| Right | Left | Centered |
+=========:+:=================+:=============:+
| Bananas | $1.34 | built-in wrapper |
+-------+---------------+--------------------+Allow Small Caps elements to be created using bracketed spans (as they already can be using HTML-syntax spans) (#3191, Kolen Cheung).
LaTeX reader:
\vspace and \hspace as block commands (#3256). Fixed an error which came up, for example, with \vspace inside a caption. (Captions expect inlines.)[]s inside LaTeX optional args. Fixes cases like:<...> options in raw LaTeX (also in Markdown) (#3184). This allows use of things like \only<2,3>{my content} in Markdown that is going to be converted to beamer.Use pre-wrap for code in dzslides template (Nicolas Porcel). Otherwise overly long code will appear on every slide.
Org reader (Albert Krewinkel):
Respect column width settings (#3246). Table column properties can optionally specify a column’s width with which it is displayed in the buffer. Some exporters, notably the ODT exporter in org-mode v9.0, use these values to calculate relative column widths. The org reader now implements the same behavior. Note that the org-mode LaTeX and HTML exporters in Emacs don’t support this feature yet, which should be kept in mind by users who use the column widths parameters.
Allow HTML attribs on non-figure images (#3222). Images which are the only element in a paragraph can still be given HTML attributes, even if the image does not have a caption and is hence not a figure. The following will add set the width attribute of the image to 50%:
+ATTR\_HTML: :width 50%
=======================
\[\[file:image.jpg\]\]Support ATTR_HTML for special blocks (#3182). Special blocks (i.e. blocks with unrecognized names) can be prefixed with an ATTR_HTML block attribute. The attributes defined in that meta-directive are added to the Div which is used to represent the special block.
Support the todo export option. The todo export option allows to toggle the inclusion of TODO keywords in the output. Setting this to nil causes TODO keywords to be dropped from headlines. The default is to include the keywords.
Add support for todo-markers. Headlines can have optional todo-markers which can be controlled via the #+TODO, #+SEQ_TODO, or #+TYP_TODO meta directive. Multiple such directives can be given, each adding a new set of recognized todo-markers. If no custom todo-markers are defined, the default TODO and DONE markers are used. Todo-markers are conceptually separate from headline text and are hence excluded when autogenerating headline IDs. The markers are rendered as spans and labelled with two classes: One class is the markers name, the other signals the todo-state of the marker (either todo or done).
LaTeX writer:
\autocites* when “suppress-author” citation used.Markdown writer:
--columns is set in such a way that cells must be very tiny. Now cells are guaranteed to be big enough so that single words don’t need to line break, even if this pushes the line length above the column width.bracketed_spans enabled (#3229).Docx writer:
HTML writer:
renderHtml import from blaze-html.Text.Pandoc.Pretty:
blankline $$ blankline.minOffet [API change] (Björn Peemöller).block (Björn Peemöller).Text.Pandoc.Shared:
warn in MonadIO.fetchItem: Better handling of protocol-relative URL (#2635). If URL starts with // and there is no “base URL” (as there would be if a URL were used on the command line), then default to http:.Export Text.Pandoc.getDefaultExtensions [API change] (#3178).
In –version, trap error in getAppUserDataDirectory (#3241). This fixes a crash with pandoc --version on unusual systems with no real user (e.g. SQL Server 2016).
Added weigh-pandoc for memory usage diagnostics (#3169).
Use correct mime types for woff and woff2 (#3228).
Remove make_travis_yml.hs (#3235, Kolen Cheung).
changelog: Moved an item that was misplaced in the 1.17.2 section to the 1.18 section where it belongs.
CONTRIBUTING.md: minor change in wording and punctuation (#3252, Kolen Cheung).
Further revisions to manual for --version changes (#3244).
Added --list-input-formats, --list-output-formats, --list-extensions, --list-highlight-languages, and --list-highlight-styles (#3173). Removed list of highlighting languages from --version output. Removed list of input and output formats from default --help output.
Added --reference-location=block|section|document option (Jesse Rosenthal). This determines whether Markdown link references and footnotes are placed at the end of the document, the end of the section, or the end of the top-level block.
Added --top-level-division=section|chapter|part (Albert Krewinkel). This determines what a level-1 header corresponds to in LaTeX, ConTeXt, DocBook, and TEI output. The default is section. The --chapters option has been deprecated in favor of --top-level-division=chapter.
Added LineBlock constructor for Block (Albert Krewinkel). This is now used in parsing RST and Markdown line blocks, DocBook linegroup/line combinations, and Org-mode VERSE blocks. Previously Para blocks with hard linebreaks were used. LineBlocks are handled specially in the following output formats: AsciiDoc (as [verse] blocks), ConTeXt (\startlines/\endlines), HTML (div with a style), Markdown (line blocks if line_blocks is enabled), Org-mode (VERSE blocks), RST (line blocks). In other output formats, a paragraph with hard linebreaks is emitted.
Allow binary formats to be written to stdout (but not to tty) (#2677). Only works on posix, since we use the unix library to check whether output is to tty. On Windows, pandoc works as before and always requires an output file parameter for binary formats.
Changed JSON output format (Jesse Rosenthal). Previously we used generically generated JSON, but this was subject to change depending on the version of aeson pandoc was compiled with. To ensure stability, we switched to using manually written ToJSON and FromJSON instances, and encoding the API version. Note: pandoc filter libraries will need to be revised to handle the format change. Here is a summary of the essential changes:
{"pandoc-api-version" : [MAJ, MIN, REV], "meta" : META, "blocks": BLOCKS} instead of [{"unMeta": META}, [BLOCKS]]. Decoding fails if the major and minor version numbers don’t match.Space is encoded as {"t":"Space"} rather than {"t":"Space","c":[]} as before.Removed tests/Tests/Arbitrary.hs and added a Text.Pandoc.Arbitrary module to pandoc-types (Jesse Rosenthal). This makes it easier to use QuickCheck with pandoc types outside of pandoc itself.
Add bracketed_spans Markdown extension, enabled by default in pandoc markdown. This allows you to create a native span using this syntax: [Here is my span]{#id .class key="val"}.
Added angle_brackets_escapable Markdown extension (#2846). This is needed because github flavored Markdown has a slightly different set of escapable symbols than original Markdown; it includes angle brackets.
Export Text.Pandoc.Error in Text.Pandoc [API change].
Print highlighting-kate version in --version.
Text.Pandoc.Options:
Extension has new constructors Ext_brackted_spans and Ext_angle_brackets_escapable [API change].ReferenceLocation type [API change] (Jesse Rosenthal).writerReferenceLocation field to WriterOptions (Jesse Rosenthal).--filter: we now check $DATADIR/filters for filters before looking in the path (#3127, Jesse Rosenthal, thanks to Jakob Voß for the idea). Filters placed in this directory need not be executable; if the extension is .hs, .php, .pl, .js, or .rb, pandoc will run the right interpreter.
For --webtex, replace deprecated Google Chart API by CodeCogs as default (Kolen Cheung).
Removed raw_tex extension from markdown_mmd defaults (Kolen Cheung).
Execute .js filters with node (Jakob Voß).
Textile reader:
bc.. extended code blocks (#3037). Also, remove trailing newline in code blocks (consistently with Markdown reader).RST reader:
admonition and (if relevant) one of the following: attention, caution, danger, error, hint, important, note, tip, warning. Note: This will change the rendering of some RST documents! The word (“Warning”, “Attention”, etc.) is no longer added; that must be done with CSS or a filter.sidebar as well.Markdown reader:
LaTeX reader:
^ inside options for tikz.^ outside of math. Some custom environments give these a meaning, so we should try not to fall over when we encounter them.* in bibtexKeyChars (Albert Krewinkel)MediaWiki reader:
EPUB reader: don’t add root path to data: URIs (#3150). Thanks to @lep for the bug report and patch.
Org reader (Albert Krewinkel):
file: prefixes not being deleted from figure images. Thanks to @bsag for noticing this bug.#+AUTHOR meta line if they are given as a comma-separated list.#+LaTeX_header lines. They are parsed as format-specific inlines to ensure that they will only show up in LaTeX output.#+HTML_head lines. They are parsed as format-specific inlines to ensure that they will only show up in HTML output.author export option. The author option controls whether the author should be included in the final markup. Setting #+OPTIONS: author:nil will drop the author from the final meta-data output.email export option. The email option controls whether the email meta-field should be included in the final markup. Setting #+OPTIONS: email:nil will drop the email field from the final meta-data output.creator export option. The creator option controls whether the creator meta-field should be included in the final markup. Setting #+OPTIONS: creator:nil will drop the creator field from the final meta-data output. Org-mode recognizes the special value comment for this field, causing the creator to be included in a comment. This is difficult to translate to Pandoc internals and is hence interpreted the same as other truish values (i.e. the meta field is kept if it’s present).unnumbered property should, as the name implies, be excluded from the automatic numbering of section provided by some output formats. The Pandoc convention for this is to add an “unnumbered” class to the header. The reader treats properties as key-value pairs per default, so a special case is added to translate the above property to a class instead.#+CAPTION attribute before an image is enough to turn an image into a figure. This wasn’t the case because the parseFromString function, which processes the caption value, would fail on empty values. Adding a newline character to the caption value fixes this.Docx reader:
isElem and elemName (defined in Docx/Util.hs) make the code a lot cleaner than the original XML.Light functions, but they had been used inconsistently. This puts them in wherever applicable.ODT reader (Hubert Plociniczak)
fig: to title for Image with a caption (as expected by pandoc’s writers).DocBook writer:
LaTeX writer:
*s. But we still have numbers on the 4th and 5th level headers.?`.\,.[htbp] placement for figures (#3103, Václav Haisman). This allows figure placement defaults to be changed by the user in the template.TEI writer: remove heuristic to detect book template (Albert Krewinkel). TEI doesn’t have <book> elements but only generic <divN> division elements. Checking the template for a trailing </book> is nonsensical.
MediaWiki writer: transform filename with underscores in images (#3052). foo bar.jpg becomes foo_bar.jpg. This was already done for internal links, but it also needs to happen for images.
ICML writer: replace partial function (!!) in table handling (#3175, Mauro Bieg).
Man writer: allow section numbers that are not a single digit (#3089).
AsciiDoc writer: avoid unnecessary use of “unconstrained” emphasis (#3068). In AsciiDoc, you must use a special form of emphasis (double __) for intraword emphasis. Pandoc was previously using this more than necessary.
EPUB writer: use stringify instead of plain writer for metadata (#3066). This means that underscores won’t be used for emphasis, or CAPS for bold. The metadata fields will just have unadorned text.
Docx Writer:
custom-style key in the attributes will apply the corresponding key to the contained blocks or inlines.dir: rtl in YAML metadata, or use -M dir=rtl on the command line. For finer-grained control, you can set the dir attribute in Div or Span elements.Org writer (Albert Krewinkel):
Markdown writer:
raw_html extension is set (#3154). Emit [TABLE] if no suitable table formats are enabled and raw HTML is disabled.raw_html extension before emitting a raw HTML block.HTML, EPUB, slidy, revealjs templates: Use <p> instead of <h1> for subtitle, author, date (#3119). Note that, as a result of this change, authors may need to update CSS.
revealjs template: Added notes-server option (jgm/pandoc-templates#212, Yoan Blanc).
Beamer template:
themeoptions variable (Carsten Gips).beamerarticle variable. This causes the beamerarticle package to be loaded in beamer, to produce an article from beamer slides. (Carsten Gips)fontfamilies structured variable (Artem Klevtsov).LaTeX template:
\institute. This isn’t a standard command, and we want to avoid a crash when institute is used with the default template.[htbp] for figures. Users with custom templates will want to add this. See #3103.Moved template compiling/rendering code to a separate library. doctemplates. This allows the pandoc templating system to be used independently.
Text.Pandoc.Error: Fix out of index error in handleError (Matthew Pickering). The fix is to not try to show the exact line when it would cause an out-of-bounds error as a result of included files.
Text.Pandoc.Shared: Add linesToBlock function (Albert Krewinkel).
Text.Pandoc.Parsing.emailAddress: tighten up parsing of email addresses. Technically **@user is a valid email address, but if we allow things like this, we get bad results in markdown flavors that autolink raw email addresses (see #2940). So we exclude a few valid email addresses in order to avoid these more common bad cases.
Text.Pandoc.PDF: Don’t crash with nonexistent image (#3100). Instead, emit the alt text, emphasized. This accords with what the ODT writer currently does. The user will still get a warning about a nonexistent image.
Fix example in API documentation (#3176, Thomas Weißschuh).
Tell where to get tarball in INSTALL (#3062).
Rename README to MANUAL.txt and add GitHub-friendly README.md (Albert Krewinkel, Kolen Cheung).
Replace COPYING with Markdown version COPYING.md from GNU (Kolen Cheung).
MANUAL.txt:
--katex works best with html5 (#3077).biblio-title variable.Improve spacing of footnotes in --help output (Waldir Pimenta).
Update KaTeX to v0.6.0 (Kolen Cheung).
Allow latest dependencies.
Use texmath 0.8.6.6 (#3040).
Allow http-client 0.4.30, which is the version in stackage lts. Previously we required 0.5. Remove CPP conditionals for earlier versions.
Remove support for GHC < 7.8 (Jesse Rosenthal).
Added Zim Wiki writer, template and tests. zimwiki is now a valid output format. (Alex Ivkin)
Changed email-obfuscation default to no obfuscation (#2988).
writerEmailObfuscation in defaultWriterOptions is now NoObfuscation.--email-obfuscation option is now none.Docbook writer: Declare xlink namespace in Docbook5 output (Ivo Clarysse).
Org writer:
@@format:raw foreign format text@@.#+BEGIN…#+END block.HTML writer: Better support for raw LaTeX environments (#2758). Previously we just passed all raw TeX through when MathJax was used for HTML math. This passed through too much. With this patch, only raw LaTeX environments that MathJax can handle get passed through. This patch also causes raw LaTeX environments to be treated as math, when possible, with MathML and WebTeX output.
Markdown writer: use raw HTML for simple, pipe tables with linebreaks (#2993). Markdown line breaks involve a newline, and simple and pipe tables can’t contain one.
Make –webtex work with the Markdown writer (#1177). This is a convenient option for people using websites whose Markdown flavors don’t provide for math.
Docx writer:
LaTeX writer:
%20 ruins things.## Slide title {.standout}.RST reader: Fixed links with no explicit link text. The link `<foo>`_ should have foo as both its link text and its URL. See RST spec at http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#embedded-uris-and-aliases Closes Debian #828167 – reported by Christian Heller.
Textile reader:
_(class)emph_ but _(noclass) emph_.LaTeX reader:
\cite so it is a NormalCitation not AuthorInText.Org reader:
[prefix; @key; suffix]. Previously, parsing would have failed unless there was a space or other special character as the last @@format:raw foreign format text@@.head lead to avoidable errors and should be avoided. They are replaced with total functions.#+LABEL: thelabel are used as the ID of the respective image. This allows e.g. the LaTeX to add proper \label markup.arch option. Archived trees are either dropped, exported completely, or collapsed to include just the header when the arch option is nil, non-nil, or headline, respectively.H option. Deeper headlines will be converted to lists.=is_substr = True=). Forcing the parser to update the positions of allowed/forbidden markup border characters fixes this.LaTeX template: fix for obscure hyperref/xelatex issue. Here’s a minimal case:
\documentclass[]{article}
\usepackage{hyperref}
\begin{document}
\section{\%á}
\end{document}Without this change, this fails on the second invocation of xelatex. This affects inputs this like # %á with pdf output via xelatex.
trypandoc: call results ‘html’ instead of ‘result’. This is for better compatibility with babelmark2.
Document MultiMarkdown as input/output format (Albert Krewinkel, #2973). MultiMarkdown was only mentioned as a supported Markdown dialect but not as a possible input or output format. A brief mention is added everywhere the other supported markdown dialects are mentioned.
Document Org mode as a format containing raw HTML (Albert Krewinkel) Raw HTML is kept when the output format is Emacs Org mode.
Implement RawInline and RawBlock in sample lua custom writer (#2985).
Text.Pandoc.Shared:
[Block] -> [Inline]. Its main use, at the moment, is for docx comments, which can contain arbitrary blocks (except for footnotes), but which will be converted to spans. This is, at the moment, pretty useless for everything but the basic Para and Plain comments. It can be improved, but the docx reader should probably emit a warning if the comment contains more than this.normalizeDate (Jesse Rosenthal). We want to avoid illegal dates – in particular years with greater than four digits. We attempt to parse series of digits first as %Y%m%d, then %Y%m, and finally %Y.normalizeDate should reject illegal years (Jesse Rosenthal). We only allow years between 1601 and 9999, inclusive. The ISO 8601 actually says that years are supposed to start with 1583, but MS Word only allows 1601-9999. This should stop corrupted word files if the date is out of that range, or is parsed incorrectly.msum over the list of Maybe values. Anything failing the test will be Nothing, so will not be a candidate.Docx reader:
--track-changes=all. All comments are converted to inlines, which can list some information. In the future a warning will be added for comments with formatting that seems like it will be excessively denatured. Note that comments can extend across blocks. For that reason there are two spans: comment-start and comment-end. comment-start will contain the comment. comment-end will always be empty. The two will be associated by a numeric id.Docx.hs as well. The warnings are simply concatenated.--track-changes=all. We also test for emitting warnings if there is complicated formatting.README: update to include track-changes comments. (Jesse Rosenthal)
Improved Windows installer - don’t ignore properties set on command-line. See #2708. Needs testing to see if this resolves the issue. Thanks to @nkalvi.
Process markdown extensions on command line in L->R order (#2995). Previously they were processed, very unintuitively, in R->L order, so that markdown-tex_math_dollars+tex_math_dollars had tex_math_dollars disabled.
Added secnumdepth variable to LaTeX template (#2920).
Include table of contents in README.html in Windows package.
Writers: treat SoftBreak as space for stripping (Jesse Rosenthal) In Writers.Shared, we strip leading and trailing spaces for display math. Since SoftBreak’s are treated as spaces, we should strip those too.
beamer, latex templates: pass biblatexoptions directly in package load. This allows runtime optinos to be used. Fixes jgm/pandoc-citeproc#201
CPP workaround for deprecation of parseUrl in http-client.
Removed some redundant class constraints.
make_oxs_package.sh - use OSX env variable.
Added winpkg target to Makefile. This downloads the windows package from appveyor and signs it using the key.
Document Org mode as a format containing raw TeX (Albert Krewinkel). Raw TeX is kept verbatim when the output format is Emacs Org mode.
Support math with haddock-library >= 1.4.
Removed -rtsopts from library stanza. It has no effect, and Hackage wouldn’t accept the package.
Update library dependency versions.
New output format: docbook5 (Ivo Clarysse).
Text.Pandoc.Options: Add writerDocBook5 to WriterOptions (API change).
Org writer:
:PROPERTIES: drawers. All available attributes are stored as key/value pairs. This reflects the way the org reader handles :PROPERTIES: blocks.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.CUSTOM_ID in properties (Albert Krewinkel). 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:
--incremental unless output format is beamer (#2843).la-x-classic as Classical Latin (Andrew Dunning). This allows one to access the hyphenation patterns in CTAN’s hyph-utf8.\strut with \minipage inside tables (Jose Luis Duran). This improves spacing in multiline tables.{} around options containing special chars (#2892).foldl.ux5f.HTML writer: Ensure mathjax link is added when math appears in footnote (#2881). Previously if a document only had math in a footnote, the MathJax link would not be added.
EPUB writer: set navpage variable on nav page. This allows templates to treat it differently.
DocBook writer:
writerDocbook5 is set (Ivo Clarysse).ulink/link (Ivo Clarysse).EPUB reader:
Docx Reader:
moveTo and moveFrom (Jesse Rosenthal). 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.ODT, EPUB, Docx readers: throw PandocError on unzip failure (Jesse Rosenthal) 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:
-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 (roblabla).
RST reader: Support :class: option for code block in RST reader (Sidharth Kapur).
Org reader (all Albert Krewinkel, except where noted otherwise):
||| 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.\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.#+OPTIONS lines. Disabling simple sub- and superscripts is one of these export options, this options is now supported.... as ellipsis or -- as en dash) can be toggled using the - option.* 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.' option.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.ATTR_HTML attributes (#1906). 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.:PROPERTIES: drawer support (#1877). 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.CUSTOM_ID in properties. See above on Org writer changes.d export option can be used to control which drawers are exported and which are discarded. Basic support for this option is added here.#+BEGIN_<FORMAT>, where <FORMAT> is the format of the block’s content, the new format uses #+BEGIN_export <FORMAT> instead. Both types are supported.BEGIN...END block parsing.cite:citeKey and [[cite:citeKey][prefix text::suffix text]] syntax is added.Added docbook5 template.
--mathjax improvements:
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.Bumped upper version bounds to allow use of latest packages and compilation with ghc 8.
Require texmath 0.8.6.2. Closes several texmath-related bugs (#2775, #2310, #2310, #2824). This fixes behavior of roots, e.g. \sqrt[3]{x}, and issues with sub/superscript positioning and matrix column alignment in docx.
README:
implicit_header_references (#2904).--columns option.Added appveyor setup, with artefacts (Jan Schulz).
stack.yaml versions: Use proper flags used for texmath, pandoc-citeproc.
LaTeX template: support for custom font families (vladipus). Needed for correct polyglossia operation with Cyrillic fonts and perhaps can find some other usages. Example usage in YAML metadata:
fontfamilies:
- name: \cyrillicfont
font: Liberation Serif
- name: \cyrillicfonttt
options: Scale=MatchLowercase
font: LiberationCreate unsigned msi as build artifact in appveyor build.
On travis, test with ghc 8.0.1; drop testing for ghc 7.4.1.
\ref wouldn’t work properly.htmlInBalanced, which caused newlines to be omitted in some raw HTML blocks in Markdown (#2804).json reader was specified and input came from stdin, and this caused no output to be produced. (Fix due to Jesse Rosenthal; thanks to Fedor Sheremetyev for calling the bug to our attention.)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 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 (#2707).
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):
Modifiable typeclass.Reducible. We want to make sure that links have their spaces removed, and are appropriately smushed together (#2689).HTML reader:
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.htmlInBalanced. This version avoids an exponential performance problem with <script> tags, and it should be faster in general (#2730).<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:
+ 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.htmlInBalanced for rawVerbatimBlock, for better performance (#2730).LaTeX reader:
$ 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.Textile reader: Support >, <, =, <> text alignment attributes. Closes #2674.
Org reader (Albert Krewinkel):
fig:. The org reader failed to do this if a figure had no name.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:
memoir template with article option as article, instead of treating all memoir templates as books.[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.
Depend on deepseq rather than deepseq-generics (fpco/stackage#1096).
Fixed regression in latex smart quote parsing (#2645). In cases where a match was not found for a quote, everything from the open quote to the end of the paragraph was being dropped.
Fixed regression with --latex-engine (#2618). In 1.16 --latex-engine raises an error if a full path is given.
Org reader: Fix function dropping subtrees tagged :noexport (Albert Krewinkel, #2628):
Markdown reader: renormalize table column widths if they exceed 100% (#2626).
Textile reader: don’t allow block HTML tags in inline contexts. The reader previously did allow this, following redcloth, which happily parses
Html blocks can be <div>inlined</div> as well.as
<p>Html blocks can be <div>inlined</div> as well.</p>This is invalid HTML. The above sample now produces;
<p>Html blocks can be</p>
<div>
<p>inlined</p>
</div>
<p>as well.</p>Improved default template lookup for custom lua scripts (#2625). Previously, if you tried to do pandoc -s -t /path/to/lua/script.lua, pandoc would look for the template in ~/.pandoc/templates/default./path/to/lua/script.lua. With this change it will look in the more reasonable ~/.pandoc/templates/default.script.lua. This makes it possible to store default templates for custom writers.
RST, Markdown writers: Fixed rendering of grid tables with blank rows (#2615).
LaTeX writer: restore old treatment of Span (#2624). A Span is now rendered with surrounding {}, as it was before 1.16.
Entity handling fixes: improved handling of entities like ⟨ that require a trailing semicolon. Allow uppercase x in numerical hexadecimal character references, working around a tagsoup bug.
stack.yaml - use lts-4.0, but with older aeson to avoid excessive memory use on compile. With aeson 0.10 we were getting an out of memory error on a 2GB Ubuntu 64-bit VM.
Improved deb package creation script. Made DPKGVER work. Renamed COMMIT to TREE. You should now be able to do TREE=1.16.0.1 DPKGVER=2 make deb.
Added Attr field to Link and Image (Mauro Bieg, #261, API change).
Renamed link attribute extensions. The old link_attributes is now mmd_link_attributes, and link_attributes now enables the new pandoc-style link and image attributes (API change). Note: this change could break some existing workflows.
Implemented SoftBreak and new --wrap option (#1701, API change). Added threefold wrapping option.
--no-wrap, added --wrap=[auto|none|preserve]WrapOption, exported from Text.Pandoc.OptionswriterWrapText in WriterOptions from Bool to WrapOption.Text.Pandoc.Shared functions to allow SoftBreak.SoftBreak in readers and writers.Text.Pandoc.Options: Added writerDpi to WriterOptions (API change, Mauro Bieg).
Added --dpi command-line option (Mauro Bieg).
Rationalized behavior of --no-tex-ligatures and --smart (#2541). This change makes --no-tex-ligatures affect the LaTeX reader as well as the LaTeX and ConTeXt writers. If it is used, the LaTeX reader will parse characters `, ', and - literally, rather than parsing ligatures for quotation marks and dashes. And the LaTeX writer will print unicode quotation mark and dash characters literally, rather than converting them to the standard ASCII ligatures. Note that --smart has no effect on the LaTeX reader. --smart is still the default for all input formats when LaTeX or ConTeXt is the output format, unless --no-tex-ligatures is used.
Some examples to illustrate the logic:
% echo "'hi'" | pandoc -t latex
`hi'
% echo "'hi'" | pandoc -t latex --no-tex-ligatures
'hi'
% echo "'hi'" | pandoc -t latex --no-tex-ligatures --smart
‘hi’
% echo "'hi'" | pandoc -f latex --no-tex-ligatures
<p>'hi'</p>
% echo "'hi'" | pandoc -f latex
<p>’hi’</p>Removed deprecated options --offline and --html5.
Fixed language code for Czech (cs not cz) (#2597).
Implemented east_asian_line_breaks extension (#2586). In Text.Pandoc.Options, added Ext_east_asian_line_breaks constructor to Extension (API change). This extension is like ignore_line_breaks, but smarter – it only ignores line breaks between two East Asian wide characters. This makes it better suited for writing with a mix of East Asian and non-East Asian scripts.
Added support for PDF creation via wkhtmltopdf. To use this: pandoc -t html5 -o result.pdf (and add --mathjax if you have math.) Margins can be set using the variables margin-top, margin-bottom, margin-left, margin-right. Other styling can be done through CSS.
Fixed cite key parsing regression (jgm/pandoc-citeproc#201). We were capturing final colons as in [@foo: bar]; the citation id was being parsed as @foo:.
ICML writer:
writeICML (Mauro Bieg). API change: It is now WriterOptions -> Pandoc -> IO String. Also handle new image attributes.ParagraphStyleRange (Mauro Bieg, #2501).Cite style to citations (Mauro Bieg).HTML writer: Include example class for example lists (#2524).
ODT/OpenDocument writer: improved image attributes (Mauro Bieg).
Attr instead of title to get dimensions from ODT walker to writeOpenDocument.AsciiDoc writer:
Haddock writer: omit formatting inside links, which isn’t supported by Haddock (#2515).
MediaWiki writer: Fixed spacing issues in table cells.
| to avoid problems when the text begins with a character like - (#2604).Beamer writer: mark frame as fragile when it contains verbatim (#1613).
LaTeX writer:
header-includes content as well as templates when determining whether to use csquotes (Andreas Lööw).margin-left etc. If geometry has no value, but margin-left, margin-right, margin-top, and/or -margin-bottom are given, a default value for geometry is created from these. Note that these variables already affect PDF production via HTML5 with wkhtmltopdf.ConTeXt writer: set default layout based on margin-left, etc. This sets up \setuplayout based on the variables margin-left, margin-right, margin-bottom, and margin-top, if no layout is given.
Docx writer: better handling of PDF images. Previously we tried to get the image size from the image even if an explicit size was specified. Since we still can’t get image size for PDFs, this made it impossible to use PDF images in docx. Now we don’t try to get the image size when a size is already explicitly specified.
Markdown writer: use raw HTML for link/image attributes when the link_attributes extension is unset and raw_html is set (#2554).
MediaWiki reader: interpret markup inside <tt>, <code> (#2607).
LaTeX reader:
Markdown reader:
Textile reader: skip over attribute in image source (#2515). We don’t have a place yet for styles or sizes on images, but we can skip the attributes rather than incorrectly taking them to be part of the filename.
Docx reader: Handle dummy list items (Jesse Rosenthal). These come up when people create a list item and then delete the bullet. It doesn’t refer to any real list item, and we used to ignore it.
CommonMark reader/writer rewritten to use latest cmark.
Fixed Emoji character definitions (#2523). There were many bugs in the definitions.
Text.Pandoc.CSS:
pickStylesToKVs function to extract multiple properties at once (API change, Mauro Bieg).trypandoc: sort drop-down lists.
Beamer template:
\euro conditional on presence of character. for xelatex and lualatex, as it is for pdflatex (Andrew Dunning).header-includes before setting of title (Thomas Hodgson), to match the LaTeX template (jgm/pandoc-templates#168).section-titles variable (defaults to true) to enable/suppress section title pages in beamer slide shows (Thomas Hodgson).Beamer/LaTeX template changes (Thomas Hodgson):
thanks variableparskip.sty when indent isn’t set (fall back to using setlength as before if parskip.sty isn’t available).biblio-style with biblatex.biblatexoptions variable.LaTeX template changes:
paper after $papersize$ variable in latex template. Thus you can say papersize: a4 and the latex will contain a4paper. This change may break some existing workflows; if you currently specify a4paper, you’ll get a4paperpaper which is meaningless. However, the change seems worth it, as it will make the papersize variable work uniformly across ConTeXt, LaTeX, and html->pdf via wkhtmltopdf.colorlinks is set (Andrew Dunning).\euro conditional in xelatex/lualatex, as it is already for pdflatex (Andrew Dunning).subject in PDF metadata. This used to be set to the subtitle, but really the subtitle need not give the subject. Also, subtitle can contain formatting, so we’d need, at least, a plain text version for this.header-includes before setting of \title, \author, etc. This allows these macros to be redefined.\subtitle command for subtitle, instead of tacking it on to the title as before. We give a no-op fallback definition if it is not defined. This change should produce much better results in classes that support \subtitle. With the default article class, which does not define \subtitle, subtitles will no longer be printed unless the user defines \subtitle and redefines \maketitle.\paragraph and \subparagraph to before header-includes.Context template:
simplefonts for font loading (Paolo Rodríguez). This is needed for things to work on ConTeXt stable from TeXLive 2015.\setuphead in title block (Andrew Dunning, Rik Kabel).Update LaTeX/ConTeXt link colour usage (Andrew Dunning).
Fixed man template so disabling hyphenation actually works. The command needs to come after .TH.
Added ‘navigation’ variable to beamer template (#2543). Valid values are empty (the default), horizontal, vertical, and frame. Note that this changes the default behavior from horizontal to empty. Closes #2543.
Added toc to HTML slide format templates (Andrew Dunning), so that --toc creates a contents slide.
Added stack.full.yaml to build pandoc-citeproc as well.
Allow pipe tables with no body rows (#2556). Previously this raised a runtime error.
Shared: Improved fetchItem so that C:/Blah/Blah.jpg isn’t treated as URL. The Haskell URI parsing routines will accept “C:” as a scheme, so we rule that out manually. This helps with --self-contained and absolute Windows paths.
Define a meta-json variable for all writers (#2019). This contains a JSON version of all the metadata, in the format selected for the writer. So, for example, to get just the YAML metadata, you can run pandoc with the following custom template: $meta-json$. The intent is to make it easier for static site generators and other tools to get at the metadata.
Document limitations of –self-contained (#2553).
Improved Citations section of README (#2551). Added information about link-citations and a link to the pandoc-citeproc man page.
ImageSize: use safeRead instead of readMaybe, which isn’t in base < 4.6.
Allow .adoc file extension for AsciiDoc (Andrew Dunning).
Improved implicit pandoc-citeproc inclusion. The filter pandoc-citeproc is automatically used when --bibliography is specified on the command line, unless --natbib or --biblatex is used. However, previously this only worked if --bibliography was spelled out in full, and not if --biblio was used.
reveal.js: Interpret pauses correctly for all headers (#2530). Previously, when using headers below the slide level, pauses are left uninterpreted into pauses. In my opinion, unexpected behavior but intentional looking at the code.
Remove redundant center variable for reveal.js (Andrew Dunning).
Parsing: Add extractIdClass, modified type of KeyTable (Mauro Bieg, API change).
ImageSize: Added functions for converting between image dimensions (Mauro Bieg).
Use lts-3.18 in stack.yaml. This avoids Windows build issues with the HTTP library.
Bump version bounds for dependencies.
Added two missing test files, and stack.yaml, to extra-source-files so they’re included in the source tarball.
reveal.js template: Fixed parallaxBackground options. parallaxBackgroundHorizontal and parallaxBackgroundVertical need integer values, not strings. (Vaughn Iverson)
pandoc my.md -t context -o my.pdf will now create a PDF using ConTeXt rather than LaTeX (#2463).
Fixed omitted url(...) in CSS data-uri with --self-contained (#2489).
Added emoji Markdown extension, enabled by default in markdown_github (#2523). Added Ext_emoji to Extension in Text.Pandoc.Options (API change).
Text.Pandoc.Readers.HTML.parseTags: Fixed over-eager raw HTML inline parsing (#2469). Tightened up the inline HTML parser so it disallows TagWarnings.
Derive Generic instances for the types in Text.Pandoc.Options.
Org reader:
Markdown reader:
--columns or 80 by default), relative widths are computed based on the widths of the separator lines relative to the column width. This should solve persistent problems with long pipe tables in LaTeX/PDF output, and give more flexibility for determining relative column widths in other formats, too. For narrower pipe tables, column widths of 0 are used, telling pandoc not to specify widths explicitly in output formats that permit this.mmd_title_block. We now allow blank metadata fields. These were explicitly disallowed before.://, so URLs and DOIs can be used as citation keys (jgm/pandoc-citeproc#166).Beamer template: fix incompatibility of section slides with natbib. Natbib (and presumably biblatex) bibliography commands create their own section. Since these are in frame environments, we have an incompatibility with the \AtBeginSection macro which creates a special frame when a new section occurs. (We can’t have a frame inside another frame.) This change disables \AtBeginSection inside bibliography slides. Thinks to Yihui Xie for bringing the problem to my attention. This supersedes #145. See discussion there.
Textile reader: don’t do smart punctuation unless explicitly asked (#2480). Note that although smart punctuation is part of the textile spec, it’s not always wanted when converting from textile to, say, Markdown. So it seems better to make this an option.
LaTeX reader: Handle comment environment (Arata Mizuki). The comment environment is handled in a similar way to the verbatim environment, except that its content is discarded.
Docx reader: Follow relationships correctly in foot/endnotes (#2258, Jesse Rosenthal). This fixes a problem with links in notes.
LaTeX and ConTeXt writers: support lang attribute on divs and spans (mb21). For LaTeX, also collect lang and dir attributes on spans and divs to set the lang, otherlangs and dir variables if they aren’t set already. See #895.
LaTeX writer:
\textarabic (mb21).de-CH-1901, fixed el-polyton in toPloyglossia (Nick Bart).\hypertarget and \hyperlink for links. This works correctly to link to Div or Span elements. We now don’t bother defining \label for Div or Span elements. Closes jgm/pandoc-citeproc#174.\protect to \hyperlink (#2490). Thanks to Hadrien Mary.colorlinks if linkcolor, urlcolor, citecolor, or toccolor is set (#2508).Textile writer: support start number in ordered lists (#2465).
OpenDocument writer: Allow customization of opendocument automatic styles. Automatic styles can now be inserted in the template, which now provides the enclosing <office:automatic-styles> tags (#2520).
Docx writer: insert space between footnote reference and note (#2527). This matches Word’s default behavior.
EPUB writer: don’t download linked media when data-external attribute set (#2473). By default pandoc downloads all linked media and includes it in the EPUB container. This can be disabled by setting data-external on the tags linking to media that should not be downloaded. Example:
<audio controls="1">
<source src="http://www.sixbarsjail.it/tmp/bach_toccata.mp3"
type="audio/mpeg"></source>
</audio>HTML writer: use width on whole table if col widths sum to < 100%. Otherwise some browsers display the table with the columns separated far apart.
AsciiDoc template: Fix author and date; add keywords, abstract (Andrew Dunning).
HTML-based templates (Andrew Dunning):
keywords to metadata.lang, dir, quotes where missing.Man template: make “generated by” comment conditional.
LaTeX, Beamer templates:
babel-otherlangs for language divs/spans; babel-newcommands, filled by commands that make babel understand the polyglossia-style language directives (mb21, #137).$for$ is always provided to allow multiple options (Andrew Dunning, #141).Ligatures=TeX rather than Mapping=tex-text with fontspec to improve support for LuaTeX (Andrew Dunning, #135).hyperref usage (Andrew Dunning, #139, #141):
subtitle and keywords to PDF metadata;hyperref link coloring without user input, effectively making the hidelinks option the default (removed as a separate variable);colorlinks variable, automatically used by the LaTeX writer when custom colors are specified;pdfborder={0 0 0} is automatically set by hyperref with colorlinks, and is only applied if colorlinks is disabled.ConTeXt template (Andrew Dunning):
linkstyle, linkcolor, linkcontrastcolor, layout, pagenumbering, whitespace, indenting, interlinespace, headertext, footertext, mainfont, sansfont, monofont, mathfont, fontsize.title subtitle, author, date, keywords to PDF metadata.subtitle, abstract.lof), list of tables (lot).Beamer template: added code to prevent slide breaks inside paragraphs (#2422, thanks to Nick Bart). This will matter, in practice, only when allowframebreaks is used. It is especially helpful for bibliography slides.
OpenDocument template: Add <office:automatic-styles> tag around automatic styles. The writer now longer provides this (see #2520).
Restored Text.Pandoc.Compat.Monoid.
Do not export (<>) from custom Prelude. The Prelude now matches base 4.8 Prelude’s API.
Don’t use custom prelude with ghc 7.10. Use the custom prelude only for earlier versions. This change makes stack ghci and cabal repl work (#2503), at least with ghc 7.10.
Changed § to % in operators from Odt.Arrows.Utils (#2457). This prevents problems building haddocks with “C” locale.
Change default for old-locale flag to False.
Use stack in deb, osx, and Windows package generators.
Added Vagrantfile for building deb in vm. This should help in automating binary package creation. ‘make package’ will make the package. ‘make package COMMIT=blah’ will make the package from commit blah.
README:
auto_identifiers examples (Benoit Schweblin).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:
# Header {id="myid" class="foo bar"} is now equivalent to # Header {#myid .foo .bar}.--. 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:
\Cite (#2335).abstract metadata field.HTML reader:
<ol type="i"> (#2313).font-variant with pickStyleAttrProps (Ophir Lifshitz).<ol> type, class, and inline list-style(-type) CSS (Ophir Lifshitz).<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:
xref elements (Frerich Raabe). Added dbContent field to reader state, so we can lookup cross refs.informalexample (#2319).Docx Reader:
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:
EPUB reader: stop mangling external URLs (#2284).
RST writer:
\ when complex expression in matched pairs. E.g. [:sup:`3`] is okay; you don’t need [:sup:`3`\ ].\ is inserted when needed before Cite and Span elements that begin with a “complex” element (jgm/pandoc-citeproc#157).Haddock writer: escape * and ^ (G. Bataille).
Markdown writer:
superscripts and subscripts extensions are not enabled).Docx writer:
formattedString. This avoids an inefficient generic traversal (#2356).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.../data for data directory. This allows tests to be run without installing first.LaTeX writer:
--chapters was used. This was the default in earlier versions, but it has been broken for a little while.lang field, which is now always assumed to be in BCP47 format (mb21, #1614, #2437).\protect to \hyperdef in inline context. This way we don’t get an error when this is used as a moveable argument (#2136).HTML writer:
role="note" for speaker notes (#1693).section as <section> in HTML5.EPUB writer:
<br/> with space (#2105).--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 (#2191, mb21).
Reference Docx:
outlineLvl for Header styles (Ophir Lifshitz).Templates
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).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).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).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).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.
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.
Updated benchmark program for new criterion API.
Setup.hs: rewrite so as not to use process, directory, filepath. Using anything outside base is dangerous, since older versions of ghc may link against two different versions.
Added appveyor (Windows continuous integration) builds.
New .travis.yml. Autgenerated using make_travis_yml.hs. This script has been modified in a few ways, e.g. to add GHCOPTS. make .travis.yml regenerates it based on the tested-with field of the cabal file.
--self-contained: Fixed overaggressive CSS minimization (#2301, 2286). Previously --self-contained wiped out all spaces in CSS, including semantically significant spaces. This was a regression from 1.14.x.
Markdown reader: don’t allow bare URI links or autolinks in link label (#2300). Added test cases.
Text.Pandoc.Parsing, uri: Improved bare autolink detection (#2299). Previously we disallowed - at the end of an autolink, and disallowed the combination =-. This commit liberalizes the rules for allowing punctuation in a bare URI, and adds test cases. One potential drawback is that you can no longer put a bare URI in em dashes like this: this uri---http://example.com---is an example. But in this respect we now match github’s treatment of bare URIs.
HTML writer: support speaker notes in dzslides. With this change <div class="notes"> and also <div class="notes" role="note"> will be output if -t dzslides is used. So we can have speaker notes in dzslides too. Thanks to maybegeek.
Updated dzslides template.
Improved documentation of options to print system default files (#2298). --print-default-data-file and --print-default-template.
DokuWiki writer: use $..$ for Math instead of <math>..</math> (Tiziano Müller). MathJax seems currently to be the only maintained math rendering extension for DokuWiki.
Text.Pandoc.Shared: Changed hierarchicalize so it treats references div as top-level header (#2294). This fixes a bug with --section-divs, where the final references section added by pandoc-citeproc, enclosed in its own div, got nested in the div for the section previous to it.
Allow vector 0.11.
Require cmark > 0.4.
HTML writer: Fixed email javascript obfuscation with mailto: URLs (#2280). This fixes a potential security issue. Because single quotes weren’t being escaped in the link portion, a specially crafted email address could allow javascript code injection.
RST reader: allow inline formatting in definition list field names (Lars-Dominik Braun).
PDF: Make sure --latex-engine-opt goes before the filename on the command line. LaTeX needs the argument to come after the options (#1779).
CommonMark writer: fixed tags used for super/subscript.
ConTeXt template: activate hanging indent for definition lists (mb21).
Make cabal require hsb2hs >= 0.3.1 if embed_data_files specified. This is done by adding hookedPrograms in Setup.hs, which allows us to include hsb2hs in Build-Tools in cabal.
Improved Windows installer (thanks to nkalvi).
Travis: unpack sdist for build to catch packaging bugs.
Improved documentation on where user templates go (#2272).
Added pandoc.1 man page to the repository. It is no longer built as part of the cabal build process. (This proved too fragile.) pandoc.1 can be regenerated (make man/pandoc.1) when README is changed.
Copying of the man page now respects --destdir (#2262).
Improved error messages for filters. User is now informed if the filter requires an interpreter that isn’t found in the path, or if the filter returns an error status.
Man page changes:
--man1, --man5 options (breaking change).Text.Pandoc.ManPages module (breaking API change).man/man1/pandoc.1. This uses pandoc to create the man page from README using a custom template and filters.man/ directory with template and filters needed to build man page.pandoc.1 and pandoc_markdown.5. Now there is just pandoc.1, which has all the content from README. This change was needed because of the extensive cross-references between parts of the README.data/pandoc.1.template and data/pandoc_markdown.5.template.OpenDocument writer: Do not add a carriage return after a hard line break (Michael Chladek).
ConTeXt writer:
\goto for internal links.% at end for \reference to avoid spurious space.Ignore sandbox on ‘make quick’
Added --man1 and --man5 options to pandoc, allowing pandoc to generate its own man pages. Man pages are no longer automatically generated in the build process (the process for this was too complex and prone to failure, #2190). The make-pandoc-man-pages executable has been removed. The man/ directory has been removed, and man page templates have been moved to data/. NOTE TO PACKAGERS: You will no longer find pandoc’s man pages in man/, but you can generate them using pandoc --man1 > pandoc.1 and pandoc --man5 > pandoc_markdown.5.
Added new unexported module: Text.Pandoc.ManPages.
README now acts like a data file (even though it isn’t in data/). So, for example, pandoc --print-default-data-file README will produce the README.) This change was required for the --man1 and --man5 options, since the man pages are produced from the README, but it may be useful for other purposes as well.
Allow reference.docx and reference.odt to be used with --print-default-data-file and to shadow defaults if placed in the user data directory. Note that as of 1.14, we no longer include these files as data files; instead, we include their components. This change causes pandoc to behave as if it has these data files; they are constructed on demand when needed using getDefaultReferenceDocx and getDefaultReferenceODT.
Fixed regression in CSS parsing with --self-contained (#2224). Pandoc 1.14.0.x used css-text to parse the CSS, but its parser silently drops big sections of CSS. This commit replaces the use of css-text with a small but principled CSS preprocessor, which removes whitespace and comments and replaces url() with base 64 data when possible.
Use https:// instead of // for MathJax and KaTeX CDN URLs (#1920). This will allow math to work when pages are being viewed locally.
Text.Pandoc.Options: Export plainExtensions. These are the extensions used in plain output.
LaTeX reader: Don’t parse _ and ^ as sub/superscript outside of math mode; treat them as regular inline text. Normally these will cause an error in LaTeX, but there are contexts (e.g. alltt environments) where they are allowed.
HTML reader: allow <body> to close <head>.
DocBook reader: support mediaobjects and figures (#2184, mb21).
RST reader: Fix reference names with special characters (Lars-Dominik Braun).
Textile writer: escape + and - as entities (#2225).
DokuWiki writer: Use proper <code> tags for code blocks (#2213).
Plain writer: don’t use symbols for super/subscript (#2237). Simplified code by using plainExtensions.
InDesign writer: Properly escape URLs containing more than one colon character (gohai).
Docx writer: Make sure we use dist version of reference.docx (and not the user’s version) for certain settings. Taking some settings values from a user-supplied reference.docx can lead to corruption. This fixes a regression from the last release (#2249).
Text.Pandoc.Shared: exports getDefaultReferenceDocx and getDefaultReferenceODT (API change). These functions have been removed from the Docx and ODT writers.
LaTeX template (Xavier Olive):
CJKmainfont and CJKoptions variables.MidnightBlue) for colors (Xavier Olive).Epub templates: use author.role, not author.type.
Bump cmark version to >= 0.3.4.
Improved Windows installer (#2205, thanks to nkalvi). Users can now select a per-user or systemwide install, and can set the installation path. At the end of installation, the install location is given. The install location is also now given in the list of installed programs in Control Panel. Cleaner WiX syntax is used for setting the path.
Added download_stats target to Makefile.
Added missing commonmark template.
Improved try pandoc (moved button, show raw command).
Allow compilation with syb 0.5.*.
Custom writer: fixed some compiler warnings for ghc < 7.10.
Fixed problem with building of reference.docx and reference.odt when the embed_data_files flag is used. Instead of having a phase of the build where reference.docx and reference.odt are created from their constituent data files, we now construct these archives from their constituents when a docx or odt is built. The constituent files have been moved from extra-source-files to data-files, and reference.docx and reference.odt have been removed. Users can create their own reference.docx or reference.odt by using pandoc to create a simple docx or odt. make-reference-files.hs has been removed, simplifying the build process (#2187)
Don’t include generated man pages in extra-source-files (#2189).
Bumped upper bound for aeson.
ConTeXt writer: create internal link anchors for Div elements with identifiers. (This is needed for linked citations to work.)
Added commonmark as input and output format.
Added --verbose flag for debugging output in PDF production (#1840, #1653).
Allow wildcards in --epub-embed-font arguments (#1939).
Added --latex-engine-opt option (#969, #1779, Sumit Sahrawat).
Added shortcut_reference_links extension (Konstantin Zudov, #1977). This is enabled by default for those markdown flavors that support reading shortcut reference links, namely: markdown, markdown_strict, markdown_github, markdown_php. If the extension is enabled, the reader parses shortcut reference links like [foo], and the writer creates such links unless doing so would cause problems. Users of markdown flavors that support shortcut reference links should not notice a difference in reading markdown, but the markdown pandoc produces may differ. If shortcut links are not desired, the extension can be disabled in the normal way.
--toc is now supported for docx output (#458, Nikolay Yakimov). A “dirty” TOC is created at the beginning of document. It can be regenerated after the document has been opened.
An implicit --filter pandoc-citeproc is now triggered only when the --bibliography option is used, and not when the bibliography field in metadata is specified (#1849).
Markdown reader:
Reference links with implicit_header_references are no longer case-sensitive (#1606).
Definition lists no longer require indentation for first line (#2087). Previously the body of the definition (after the : or ~ marker) needed to be in column 4. This commit relaxes that requirement, to better match the behavior of PHP Markdown Extra. So, now this is a valid definition list:
foo
: barResolve a potentially ambiguity with table captions:
foo
: bar
-----
table
-----Is “bar” a definition, or the caption for the table? We’ll count it as a caption for the table.
Disallow headerless pipe tables (#1996), to conform to GFM and PHP Markdown Extra. Note: If you have been using headerless pipe tables, this change may cause existing tables to break.
Allow pipe tables with header but no body (#2017).
Allow a digit as first character of a citation key (Matthias Troffaes). See https://github.com/jgm/pandoc-citeproc/issues/97
LaTeX reader:
.tex extension (#1882). If the extension is not .tex, it must be given explicitly in the \input or \include.Docx reader:
Org reader:
:noexport: tag set are not exported. This mirrors org-mode.* Headline :TAG1:TAG2. Instead of being interpreted as part of the headline, the tags are now put into the attributes of empty spans. Spans without textual content won’t be visible by default, but they are detectable by filters. They can also be styled using CSS when written as HTML.Append newline to the LineBreak in Dokuwiki, HTML, EPUB, LaTeX, MediaWiki, OpenDocument, Texinfo writers (#1924, Tim Lin).
HTML writer:
--mathjax specified (#1938).div with class sourceCode. Also, the default highlighting CSS now adds div.sourceCode { x-overflow: auto; }, which means that code blocks (even with line numbers) will acquire a scroll bar on screens too small to display them (e.g. mobile phones). See also jgm/highlighting-kate#65.LaTeX writer:
fragile, add the [fragile] option to the slide (#2119).MediaWiki writer:
File: instead of the deprecated Image: for images and other media files (Greg Rundlett).DocBook writer:
Div (id,_,_) [Para _] element as a para element with an id attribute. This makes links to citations work in DocBook with pandoc-citeproc.RST writer:
:raw-latex:`...` and add a definition for this role to the template.EPUB writer:
linear=no from cover itemref (#1609).sup element for epub footnotes (#1995). Instead, just use an a element with class footnoteRef. This allows more styling options, and provides better results in some readers (e.g. iBooks, where anything inside the a tag breaks popup footnotes).toc-title metadata field.Docx writer:
FirstParagraph style (Jesse Rosenthal). Following the ODT writer, we add the FirstParagraph style to the first text paragraph following an image, blockquote, table, heading, or beginning of document. This allows it to be styled differently. The default is for it to be the same as Normal.BodyText style (Jesse Rosenthal). We apply a BodyText style to all unstyled paragraphs. This is, essentially, the same as Normal, except that since not everything inherits from BodyText (the metadata won’t, for example, or the headers or footnote numbers), we can change the text in the body without having to make exceptions for everything. If we do want to change everything, we can still do it through Normal.Blockquote style slightly (Jesse Rosenthal). Since BlockQuote derives from BodyText, we just want to specify by default that it won’t indent, regardless of what BodyText does. Note that this will not produce any visible difference in the default configuration.toc-title metadata field (Nikolay Yakimov).Figure. Figures with nonempty captions use style Figure with Caption, which is based on Figure, and additionally has keepNext set.ODT writer:
Figure – for figure with empty caption), FigureWithCaption (based on Figure) – for figure with caption, FigureCaption (based on Caption) – for figure captions. Also, TableCaption (based on Caption) is used for table captions.New Text.Pandoc.Error module with PandocError type (Matthew Pickering).
All readers now return Either PandocError Pandoc instead of Pandoc (Matthew Pickering). This allows better handling of errors.
Added Text.Pandoc.Writers.CommonMark, exporting writeCommonMark.
Added Text.Pandoc.Readers.CommonMark, exporting readCommonMark.
Derive Data and Typeable instances for MediaBag, Extension, ReaderOptions, EPUBVersion, CiteMethod, ObfuscationMethod, HTMLSlideVariant, TrackChanges, WriterOptions (Shabbaz Youssefi).
New Ext_shortcut_reference_links constructor for Extension (Konstantin Zudov).
Markdown reader:
' after inline math (#1909, Nikolay Yakimov).charsInBalancedBrackets for efficiency.</div> doesn’t get included in a definition list item (#2127).HTML reader:
htmlInBalanced (#2146).<th> in body rows (#1859, mb21).htmlTag (#1820). If the tag parses as a comment, we check to see if the input starts with <!--. If not, it’s bogus comment mode and we fail htmlTag.base tag; if it has an href value, this is added to all relative URLs in links and images.DocBook reader:
Docx reader:
LaTeX reader:
tabular* environment (#1850). Note that the table width is not actually parsed or taken into account, but pandoc no longer chokes on it.\lstinline rather than raising error (#1997).tabular environment allows non-empty column separators with the “@...” syntax. Previously, pandoc would fail to parse tables if a non-empty colsep was present. With this commit, these separators are still ignored, but the table gets parsed. A test case is included.\newpage as a block command.\title{} (#2001).\\ (#2007).Textile reader:
Org reader:
[[http://example.com][https://www.haskell.org/static/img/logo.png]].Docbook writer:
HTML writer:
alt attribute on img tag (#1131, Konstantin Zudov).LaTeX writer:
$ in URL (#1913).--chapters implicitly if the documentclass in metadata is a book documentclass. Previously this was done only if a book documentclass was set in a variable.\label in \hyperdef for Div, Span (or links don’t work).mainlang work when lang is in metadata (#2174).Texinfo writer:
RST writer:
Markdown writer:
< should not be escaped as \<, for compatibility with original Markdown. We now escape < and > with entities. Also, we now backslash-escape square brackets.MediaWiki writer:
AsciiDoc writer:
EPUB writer:
ICML writer:
icml, in which case they are passed through unescaped.Custom writer:
PandocLuaException instead of using ‘error’. Eventually we’ll change the return type so that no exception is involved, but at least this can be trapped.Docx writer:
noProof to docx syntax highlighting SourceCode style.reference.docx, they will end up with a settings.xml file that references these footnotes, but no such footnotes in the document. This will produce a corruption error. Here we add these to the document and settings.xml file, so future modifications won’t break the file.SourceCode style in reference.docx if it is defined there (Nikolay Yakimov, #1872). If --no-highlight specified, remove any SourceCode and *Tok styles in reference.docx.Author, Abstract, Compact, Image Caption, Table Caption, Definition Term, Definition, First Paragraph.Normal.dotm (Nikolay Yakimov): Block Quote -> Block Text, Link -> Hyperlink, Footnote Ref -> Footnote Reference.Caption style (Nikolay Yakimov).Image Caption <- Caption, Table Caption <- Caption.SourceCode style from reference.docx (#1872). This is added automatically by the docx writer.reference.docx (Nikolay Yakimov).Text.Pandoc.PDF
Text.Pandoc.Shared:
mapLeft, hush (Matthew Pickering).Text.Pandoc.Pretty:
Text.Pandoc.SelfContained:
;charset=utf-8 to script mime type if missing (#1842).text/* mime types.cssURLs no longer tries to fetch fragment URLs (#2121).text-css).Text.Pandoc.UTF8:
Text.Pandoc.ImageSize:
runGetOrFail (with binary >= 0.7) to return Left on parse failure (rather than error).Added woff2 to MIME types (Alfred Wechselberger).
pandoc: When a binary input format is used, warn that file arguments past the first one are being ignored (Matthew Pickering).
LaTeX template:
\paragraph not defined.grffile together with graphicx (#2074). This properly handles filenames containing spaces and dots.\paragraph, \subparagraph… to behave more like section headers (#1658).toccolor variable to control link color in toc (Kaixhin).LaTeX, Beamer templates:
\tightlist, which is now used by the LaTeX writer.bibliography instead of biblio-files (#1661). Also use \addbibresource instead of \bibliography for biblatex.setotherlanguages in polyglossia. This uses an otherlang variable that is derived from a comma-separated list in lang; the last language is mainlang and the others are otherlang.EPUB templates:
div, not p, for “rights” on title page.OpenDocument template:
text:p instead of text:h for title. Using text:h causes problems with numbering. Closes #2059. Thanks to @nkalvi for diagnosing this.reveal.js template:
center, maxScale, slideNuber (Dmitry Smirnov, pandoc-templates#89).center to be set to false.Removed pre-built reference.docx and reference.odt (Nikolay Yakimov). Instead the repository now includes the component text files, and the zipped binaries are built from these using a helper program, make-reference-files. This should make maintenance of these components easier going forward.
Text.Pandoc.Parsing:
<+?> combinator (Nikolay Yakimov).stateHeaderKeys to ParserState.make_deb.sh fixes:
fakeroot to get permissions right.mkdir and cp instead of install./usr rather than /usr/local.pandoc, pandoc-citeproc.Added Text.Pandoc.Compat.Locale and old-locale flag to assist with transition to time 1.5.
Updated CONTRIBUTING.md with information about issue tags (Matthew Pickering).
Updated travis installs to the new sudo-less syntax (Tim Lin).
Updated dependency version bounds.
EPUB tests: don’t use joinPath, which varies across platforms. Instead, use a forward-slash to join paths, regardless of the platform. This matches the way MediaBag now works.
Clarify JSON input and output in usage message (Caleb McDaniel).
Improved INSTALL instructions.
Always build man pages. Removed make-pandoc-man-pages flag.
Makefile: removed man target, now that we generate man pages by default.
README:
pandoc-citeproc’s --bib2json and --bib2yaml options (Nick Bart).mods2yaml (Nick Bart).toccolor variable.Updated to build with ghc 7.10.1.
Bumped package upper bounds for filepath, blaze-html, blaze-markup.
TWiki Reader: add new new twiki reader (API chaneg, Alexander Sulfrian).
Markdown reader:
> characters, but this is not a big issue.Ext_lists_without_preceding_blankline bug (#1636, Artyom).startnum to work without fancy_lists. Formerly pandoc -f markdown-fancy_lists+startnum did not work properly.RST reader (all Daniel Bergey):
Parse quoted literal blocks (#65). RST quoted literal blocks are the same as indented literal blocks (which pandoc already supports) except that the quote character is preserved in each line.
Parse RST class directives. The class directive accepts one or more class names, and creates a Div value with those classes. If the directive has an indented body, the body is parsed as the children of the Div. If not, the first block following the directive is made a child of the Div. This differs from the behavior of rst2xml, which does not create a Div element. Instead, the specified classes are applied to each child of the directive. However, most Pandoc Block constructors to not take an Attr argument, so we can’t duplicate this behavior.
Warn about skipped directives.
Literal role now produces Code. Code role should have “code” class.
Improved support for custom roles
sourceCode to classes for :code: role, and anything inheriting from it.:span: role.This differs somewhat from the rst2xml.py behavior. If a custom role inherits from another custom role, Pandoc will attach both roles’ names as classes. rst2xml.py will only use the class of the directly invoked role (though in the case of inheriting from a :code: role with a :language: defined, it will also provide the inherited language as a class).
Warn about ignored fields in role directives.
LaTeX reader:
\noindent and \greektext (#1783).\texorpdfstring more gracefully.\cref and \sep (Wikiwide).\smartcite and \Smartcite from biblatex.HTML reader:
<br> tags inside <pre> blocks (#1620, Matthew Pickering).embed tag either block or inline (#1756).DocBook reader:
keycombo, keycap (#1815).menuchoice elements better, with a > between (#1817).id on section headers (#1818).classname (Bryan O’Sullivan).Docx reader:
Org reader:
Added state changing blanklines (Jesse Rosenthal). This allows us to emphasize at the beginning of a new paragraph (or, in general, after blank lines).
Fixed bug with bulleted lists:
was being parsed as a list, even though an unindented * should make a heading. See http://orgmode.org/manual/Plain-lists.html#fn-1.
Org reader: absolute, relative paths in link (#1741, Albert Krewinkel). The org reader was too restrictive when parsing links; some relative links and links to files given as absolute paths were not recognized correctly.
Org reader: allow empty links (jgm/gitit#471, Albert Krewinkel). This is important for use in gitit, which uses empty links for wikilinks.
Respect indent when parsing Org bullet lists (#1650, Timothy Humphries). Fixes issue with top-level bullet list parsing.
Fix indent issue for definition lists (Timothy Humphries, see #1650, #1698, #1680).
Parse multi-inline terms correctly in definition list (#1649, Matthew Pickering).
Fix rules for emphasis recognition (Albert Krewinkel). Things like /hello,/ or /hi'/ were falsy recognized as emphasised strings. This is wrong, as , and ' are forbidden border chars and may not occur on the inner border of emphasized text.
Drop COMMENT document trees (Albert Krewinkel). Document trees under a header starting with the word COMMENT are comment trees and should not be exported. Those trees are dropped silently (#1678).
Properly handle links to file:target (Albert Krewinkel). Org links like [[file:target][title]] were not handled correctly, parsing the link target verbatim. The org reader is changed such that the leading file: is dropped from the link target (see #756, #1812).
Parse LaTeX-style MathML entities (#1657, Albert Krewinkel). Org supports special symbols which can be included using LaTeX syntax, but are actually MathML entities. Examples for this are \nbsp (non-breaking space), \Aacute (the letter A with accent acute) or \copy (the copyright sign ©)
EPUB reader:
fetchItem'. Also, do not include queries in file extensions (#1671).LaTeX writer:
\texorpdfstring for section captions when needed (Vaclav Zeman).\section/\subsection etc titles need to be \protected.~ before header in list item text (Jesse Rosenthal). Because of the built-in line skip, LaTeX can’t handle a section header as the first element in a list item.\lstinline delimiters (#1595).MediaWiki writer:
ICML writer:
RTF writer:
RST writer:
DokuWiki writer:
> rather than as HTML (#1738).HTML writer:
KaTeX to HTMLMathMethod (API change).email-obfuscation=none (#1625, Matthew Pickering).ODT writer:
FB2 writer:
EPUB writer:
sourceURL to absolute URIs (#1669).opf:title-type for epub2.--toc was requested. Previously we included it in the spine with linear="no", leading to odd results in some readers (#1593).nav.xhtml, including doctype (#1759).Docx writer:
<w:name val="heading #"> fallback, if there are no en-US “Heading#” stylesreference.docx.ConTeXt writer:
Text.Pandoc.Shared:
toChunks outside of CPP conditional (#1590).inDirectory to reset to the original directory in case an exception occurs (Freiric Barral).Templates:
LaTeX template: load polyglossia before bibtex (jgm/pandoc-templates#70). Thanks to bluebirch.
LaTeX template: Added \VerbatimFootnotes if there is verbatim in notes (#1616).
LaTeX template: Add shorthands=off to babel options (#1648).
EPUB, EPUB3 templates: Added id="cover" to body of cover page. This aids styling, making it possible for example to set 0 margins on the title page (#1758).
EPUB, EPUB3 templates: Handle structured metadata on titlepage. Previously we just expected ‘title’, ‘subtitle’, ‘author’, ‘date’. Now we still support those, but also support the format recommended for epub metadata in the pandoc README:
title:
Text.Pandoc.Templates.getDefaultTemplate: don’t fail when called with “fb2” (#1660).
Text.Pandoc.Parsing:
inlineMath so it handles \text{..} containing $. For example: $x = \text{the $n$th root of $y$} (#1677).parseFromString to fail if not all input is consumed. (Matthew Pickering)addWarning from Markdown reader to Parsing, so it can be used by more readers (API change, Daniel Bergey).Text.Pandoc.Pretty:
realLength (Matthew Pickering).Text.Pandoc.MIME:
otf to application/vnd.ms-opentype (#1761). This is needed for epub3 validation.Text.Pandoc.MediaBag:
Text.Pandoc.Shared:
collapseFilePath OS-agnostic (Matthew Pickering).Link the test suite using -threaded. This allows the test suite to be run using +RTS -N.
Added network dependency under network-uri flag in test section.
Give better error messages when someone tries to convert from pdf, doc, odt (#1683).
Added track to list of tags treated by --self-contained (#1664).
Fixed --self-contained with Windows paths (#1558). Previously C:\foo.js was being wrongly interpreted as a URI.
HTML reader: improved handling of tags that can be block or inline. Previously a section like this would be enclosed in a paragraph, with RawInline for the video tags (since video is a tag that can be either block or inline):
<video controls="controls">
<source src="../videos/test.mp4" type="video/mp4" />
<source src="../videos/test.webm" type="video/webm" />
<p>
The videos can not be played back on your system.<br/>
Try viewing on Youtube (requires Internet connection):
<a href="http://youtu.be/etE5urBps_w">Relative Velocity on
Youtube</a>.
</p>
</video>This change will cause the video and source tags to be parsed as RawBlock instead, giving better output. The general change is this: when we’re parsing a “plain” sequence of inlines, we don’t parse anything that COULD be a block-level tag.
Docx reader:
Plain (Jesse Rosenthal). This makes to docx reader’s native output fit with the way the markdown reader understands its markdown output.Txt2Tags reader:
title, the second is the author and third line is the date (Matthew Pickering).%%mtime macro (Matthew Pickering).Textile writer: Extended the range of cases where native textile tables will be used (as opposed to raw HTML): we now handle any alignment type, but only for simple tables with no captions.
EPUB writer: Don’t use page-progression-direction in EPUB2, which doesn’t support it. Also, if page-progression-direction not specified in metadata, don’t include the attribute even in EPUB3; not including it is the same as including it with the value “default”, as we did before. (#1550)
Org writer: Accept example lines with indentation at the beginning (Calvin Beck).
DokuWiki writer:
\\ instead of newlines (Jesse Rosenthal).Docx writer:
Bibliography style (#1559).LaTeX writer:
\strut to fix spacing in multiline tables (Jose Luis Duran).\tabularnewline instead of \\ in table cells (Jose Luis Duran).Text.Pandoc.MIME:
MimeType (type synonym for String) and getMimeTypeDef. Code cleanups (Artyom Kazak).Templates:
Improved OSX build procedure.
Added network-uri flag, to deal with split of network-uri from network.
Fix build dependencies for the trypandoc flag, so that they are ignored if trypandoc flag is set to False (Gabor Pali).
Updated README to remove outdated claim that --self-contained looks in the user data directory for missing files.
Docx writer:
Fixed a bug in Windows 8 which caused pandoc not to find the pandoc-citeproc filter (#1542).
Docx reader: miscellaneous under-the-hood improvements (Jesse Rosenthal). Most significantly, the reader now uses Builder, leading to some performance improvements.
HTML reader: Parse appropriately styled span as SmallCaps.
Markdown writer: don’t escape $, ^, ~ when tex_math_dollars, superscript, and subscript extensions, respectively, are deactivated (#1127).
Added trypandoc flag to build CGI executable used in the online demo.
Makefile: Added ‘quick’, ‘osxpkg’ targets.
Updated README in templates to indicate templates license. The templates are dual-licensed, BSD3 and GPL2+.
Added docx as an input format (Jesse Rosenthal). The docx reader includes conversion of native Word equations to pandoc LaTeX Math elements. Metadata is taken from paragraphs at the beginning of the document with styles Author, Title, Subtitle, Date, and Abstract.
Added epub as an input format (Matthew Pickering). The epub reader includes conversion of MathML to pandoc LaTeX Math elements.
Added t2t (Txt2Tags) as an input format (Matthew Pickering). Txt2tags is a lightweight markup format described at http://txt2tags.org/.
Added dokuwiki as an output format (Clare Macrae).
Added haddock as an output format.
Added --extract-media option to extract media contained in a zip container (docx or epub) while adjusting image paths to point to the extracted images.
Added a new markdown extension, compact_definition_lists, that restores the syntax for definition lists of pandoc 1.12.x, allowing tight definition lists with no blank space between items, and disallowing lazy wrapping. (See below under behavior changes.)
Added an extension epub_html_exts for parsing HTML in EPUBs.
Added extensions native_spans and native_divs to activate parsing of material in HTML span or div tags as Pandoc Span inlines or Div blocks.
--trace now works with the Markdown, HTML, Haddock, EPUB, Textile, and MediaWiki readers. This is an option intended for debugging parsing problems; ordinary users should not need to use it.
Changed behavior of the markdown_attribute extension, to bring it in line with PHP markdown extra and multimarkdown. Setting markdown="1" on an outer tag affects all contained tags, recursively, until it is reversed with markdown="0" (#1378).
Revised markdown definition list syntax (#1429). Both the reader and writer are affected. This change brings pandoc’s definition list syntax into alignment with that used in PHP markdown extra and multimarkdown (with the exception that pandoc is more flexible about the definition markers, allowing tildes as well as colons). Lazily wrapped definitions are now allowed. Blank space is required between list items. The space before a definition is used to determine whether it is a paragraph or a “plain” element. WARNING: This change may break existing documents! Either check your documents for definition lists without blank space between items, or use markdown+compact_definition_lists for the old behavior.
.numberLines now works in fenced code blocks even if no language is given (#1287, jgm/highlighting-kate#40).
Improvements to --filter:
--filter ./caps.py would run caps.py from the system path, even if there was a caps.py in the working directory.HTML reader:
div and span elements even without --parse-raw, provided native_divs and native_spans extensions are set. Motivation: these now generate native pandoc Div and Span elements, not raw HTML.epub_html_exts extension is enabled. These include switch, footnote, rearnote, noteref.Org reader:
\tau) and LaTeX commands (like \cite{Coffee}), can be used without any further escaping (Albert Krewinkel).Textile reader and writer:
raw_tex extension is no longer set by default. You can enable it with textile+raw_tex.DocBook reader:
equation, informalequation, inlineequation elements with mml:math content. This is converted into LaTeX and put into a Pandoc Math inline.Revised plain output, largely following the style of Project Gutenberg:
_underscores_, strong emphasis with ALL CAPS.[n] style.Markdown writer:
raw_html extension. pandoc -t markdown-raw_html no longer emits any raw HTML, including span and div tags generated by Span and Div elements.SmallCaps (#1360).HTML writer:
uri, and email autolinks have class email, so they can be styled.Docx writer:
reference.docx. This includes margins, page size, page orientation, header, and footer, including images in headers and footers.Abstract style (#1451).Subtitle style, rather than tacking it on to the title (#1451).Org writer:
Span ("uid",[],[]) [] becomes <<uid>>.LaTeX writer:
\(..\) instead of $..$ for inline math (#1464).\nolinkurl in email autolinks. This allows them to be styled using \urlstyle{tt}. Thanks to Ulrike Fischer for the solution.\textquotesingle for ' in inline code. Otherwise we get curly quotes in the PDF output (#1364).\footnote<.>{..} for notes in beamer, so that footnotes do not appear before the overlays in which their markers appear (#1525).\label{..} for a Div or Span element. Do produce a \hyperdef{..} (#1519).EPUB writer:
page-progression-direction (which can be ltr or rtl, the page-progression-direction attribute will be set in the EPUB spine (#1455).Custom lua writers:
--template.sample.lua.--normalize and Text.Pandoc.Shared.normalize now consolidate adjacent RawBlocks when possible.
Added Text.Pandoc.Readers.Docx, exporting readDocx (Jesse Rosenthal).
Added Text.Pandoc.Readers.EPUB, exporting readEPUB (Matthew Pickering).
Added Text.Pandoc.Readers.Txt2Tags, exporting readTxt2Tags (Matthew Pickering).
Added Text.Pandoc.Writers.DokuWiki, exporting writeDokuWiki (Clare Macrae).
Added Text.Pandoc.Writers.Haddock, exporting writeHaddock.
Added Text.Pandoc.MediaBag, exporting MediaBag, lookupMedia, insertMedia, mediaDirectory, extractMediaBag. The docx and epub readers return a pair of a Pandoc document and a MediaBag with the media resources they contain. This can be extracted using --extract-media. Writers that incorporate media (PDF, Docx, ODT, EPUB, RTF, or HTML formats with --self-contained) will look for resources in the MediaBag generated by the reader, in addition to the file system or web.
Text.Pandoc.Readers.TexMath: Removed deprecated readTeXMath. Renamed readTeXMath' to texMathToInlines.
Text.Pandoc: Added Reader data type (Matthew Pickering). readers now associates names of readers with Reader structures. This allows inclusion of readers, like the docx reader, that take binary rather than textual input.
Text.Pandoc.Shared:
capitalize (Artyom Kazak), and replaced uses of map toUpper (which give bad results for many languages).collapseFilePath, which removes intermediate . and .. from a path (Matthew Pickering).fetchItem', which works like fetchItem but searches a MediaBag before looking on the net or file system.withTempDir.removeFormatting.extractSpaces (from HTML reader) and generalized its type so that it can be used by the docx reader (Matthew Pickering).ordNub.normalizeInlines, normalizeBlocks.normalize is now Pandoc -> Pandoc instead of Data a :: a -> a. Some users may need to change their uses of normalize to the newly exported normalizeInlines or normalizeBlocks.Text.Pandoc.Options:
writerMediaBag to WriterOptions.readerStrict in ReaderOptions. This is handled by readerExtensions now.Ext_compact_definition_lists.Ext_epub_html_exts.Ext_native_divs and Ext_native_spans. This allows users to turn off the default pandoc behavior of parsing contents of div and span tags in markdown and HTML as native pandoc Div blocks and Span inlines.Text.Pandoc.Parsing:
readWith to readWithM (Matthew Pickering).runParserT and Stream (Matthew Pickering).HasQuoteContext type class (Matthew Pickering).mathInline, smartPunctuation, quoted, singleQuoted, doubleQuoted, failIfInQuoteContext, applyMacros (Matthew Pickering).token (Matthew Pickering).stateInHtmlBlock to ParserState. This is used to keep track of the ending tag we’re waiting for when we’re parsing inside HTML block tags.stateMarkdownAttribute to ParserState. This is used to keep track of whether the markdown attribute has been set in an enclosing tag.registerHeader, using new type classes HasReaderOptions, HasIdentifierList, HasHeaderMap (Matthew Pickering). These allow certain common functions to be reused even in parsers that use custom state (instead of ParserState), such as the MediaWiki reader.inlineMath, displayMath from Markdown reader to Parsing, and generalized their types (Matthew Pickering).Text.Pandoc.Pretty:
nestle.blanklines, which guarantees a certain number of blank lines (and no more).Markdown reader:
markdown_attribute, which caused incorrect tag nesting for input like <aside markdown="1">*hi*</aside>.enclosure/emphOrStrong code.RawBlock; we no longer try to consolidate them (though --normalize will do so).<span style="font-variant:small-caps;">foo</span> will be parsed as a SmallCaps inline, and will work in all output formats that support small caps (#1360).hard_line_breaks option was specified, pandoc would formerly produce a spurious line break after a tight list item.c++ and objective-c as language identifiers in github-style fenced blocks (#1318).$ (#1313).LaTeX reader:
\emph better. \emph{ hi } gets parsed as [Space, Emph [Str "hi"], Space] so that we don’t get things like * hi * in markdown output. Also applies to textbf and some other constructions (#1146).\caption (James Aspnes).HTML reader:
</table> tag close an open <tr> or <td> (#1167).<col> and </col>.audio and source in eitherBlockOrInline.video, svg, progress, script, noscript, svg from blockTags to eitherBlockOrInline.map and object were mistakenly in both lists; they have been removed from blockTags.DOCTYPE and xml declarations.MediaWiki reader:
<source> (#1445).{{ must be followed by an alphanumeric or :. This prevents the exponential slowdown in #1033.DocBook reader:
<?asciidoc-br?> (#1236).Textile reader:
Org reader:
code and verbatim parsers to accord with the org-mode manual.:exports header argument in code blocks (Craig Bosma).EPUB writer:
nav.xhtml. This should improve TOC view in iBooks (#1392).stringify instead of custom plainify.renderTags' for all tag rendering. This properly handles tags that should be self-closing. Previously <hr/> would appear in EPUB output as <hr></hr> (#1420).event attributes. Note: in EPUB3 we can have only one dc:date, so only the first one is used.LaTeX writer:
ConTeXt writer:
RTF writer:
fetchItem' is now used to get the images, and calculated image sizes are indicated in the RTF.HTML writer:
MediaWiki writer:
st prefixed names.AsciiDoc writer:
Markdown writer:
SmallCaps in plainify.Ext_fenced_code_attributes is not set, the first class attribute will be printed after the opening fence as a bare word.PDF writer:
Docx writer:
media/ in reference docx. This should be somewhat more robust and cover more types of images.entryFromArchive to avoid an unneeded parse.abstractNumId numbering. Instead of sequential numbering, we assign numbers based on the list marker styles.Text.Pandoc.Options:
Ext_fenced_code_attributes from markdown_github extensions.Text.Pandoc.ImageSize:
Text.Pandoc.Shared:
fetchItem: unescape URI encoding before reading local file (#1427).fetchItem: strip a fragment like ?#iefix from the extension before doing mime lookup, to improve mime type guessing.fetchItem: absolute URIs are fetched from the net; other things are treated as relative URIs if sourceURL is Just _, otherwise as file paths on the local file system.fetchItem now properly handles links without a protocol (#1477).fetchItem now escapes characters not allowed in URIs before trying to parse the URIs.compactify'DL on certain lists (#1452).pandoc.hs: Don’t strip path off of writerSourceURL: the path is needed to resolve relative URLs when we fetch resources (#750).
Text.Pandoc.Parsing
dash and ellipsis (#1419).(>>~) in favor of the equivalent (<*) (Matthew Pickering).ParsecT (Matthew Pickering).isbn and pmid to list of recognized schemes (Matthew Pickering).type attribute to link tags. They are supposed to be “advisory” in HTML5, but kindlegen seems to require them.epub:type="titlepage".\subtitle work properly (#1327).lot and lof variables, which can be set to get \listoftables and \listoffigures (#1407). Note that these variables can be set at the command line with -Vlot -Vlof or in YAML metadata.Rewrote normalize for efficiency (#1385).
Rewrote Haddock reader to use haddock-library (#1346).
@ code blocks.Added Text.Pandoc.Compat.Directory to allow building against different versions of the directory library.
Added Text.Pandoc.Compat.Except to allow building against different versions of mtl.
Code cleanup in some writers, using Reader monad to avoid passing options parameter around (Matej Kollar).
Improved readability in pandoc.hs.
Miscellaneous code cleanups (Artyom Kazak).
Avoid import Prelude hiding (catch) (#1309, thanks to Michael Thompson).
Changed http-conduit flag to https. Depend on http-client and http-client-tls instead of http-conduit. (Note: pandoc still depends on conduit via yaml.)
Require highlighting-kate >= 0.5.8.5 (#1271, #1317, Debian #753299). This change to highlighting-kate means that PHP fragments no longer need to start with <?php. It also fixes a serious bug causing failures with ocaml and fsharp.
Require latest texmath. This fixes \tilde{E} and allows \left to be used with ], ) etc. (#1319), among many other improvements.
Require latest zip-archive. This has fixes for unicode path names.
Added tests for plain writer.
Text.Pandoc.Templates:
ordNub (#1022).Benchmarks:
nfIO instead of the getLength trick to force full evaluation.Windows build script:
-windows to file name.make_osx_package: Call zip file pandoc-VERSION-osx.zip. The zip should not be named SOMETHING.pkg.zip, or OSX finder will extract it into a folder named SOMETHING.pkg, which it will interpret as a defective package (#1308).
README:
fenced_code_attributes extension (Caleb McDaniel).Require highlighting-kate >= 0.5.8. Fixes a performance regression.
Shared: addMetaValue now behaves slightly differently: if both the new and old values are lists, it concatenates their contents to form a new list.
LaTeX reader:
bibliography in metadata from \bibliography or \addbibresource command.%foo with no trailing newline.Org reader:
#+BEGIN_SRC ...) (Albert Krewinkel).org-citation as the input format.Markdown reader:
citeKey moved to Text.Pandoc.Parsing so it can be used by other readers (Albert Krewinkel).Text.Pandoc.Parsing:
citeKey (see above).HasLastStrPosition type class and updateLastStrPos and notAfterString functions.Updated copyright notices (Albert Krewinkel).
Added default.icml to data files so it installs with the package.
OSX package:
Made it possible to run filters that aren’t executable (#1096). Pandoc first tries to find the executable (searching the path if path isn’t given). If it fails, but the file exists and has a .py, .pl, .rb, .hs, or .php extension, pandoc runs the filter using the appropriate interpreter. This should make it easier to use filters on Windows, and make it more convenient for everyone.
Added Emacs org-mode reader (Albert Krewinkel).
Added InDesign ICML Writer (mb21).
MediaWiki reader:
LaTeX reader:
table environment (#1204). Positioning options no longer rendered verbatim.@{} and p{length} in tabular. The length is not actually recorded, but at least we get a table (#1180).\nocite. It now adds a nocite metadata field. Citations there will appear in the bibliography but not in the text (unless you explicitly put a $nocite$ variable in your template).Markdown reader:
divs. Formerly a closing div tag would be missed if it came right after other block-level tags.</div> not found.markdown_mmd.Textile reader:
*(foo)hi*, we’ll get <em><span class="foo">hi</span></em> instead of <em class="foo">hi</em>. But at least the data is not lost.DocBook reader:
formalpara. We now emit the title (if present) as a separate paragraph with boldface text (#1215).author not authors.authorgroup and releaseinfo elements (#1214, Matthew Pickering).HTML reader:
closes with rules from HTML5 spec.RST reader:
http in PEP links (Albert Krewinkel).author rather than authors in metadata.aafig directive as a code block with attributes, so it can be processed in a filter (#1212).LaTeX writer:
--toc-depth work well with books in latex/pdf output (#1210).\paragraph or \subparagraph in a quote environment. This adds an mbox{} in these contexts to work around the problem. See http://tex.stackexchange.com/a/169833/22451 (#1221).\/ to avoid en-dash ligature instead of -{}- (Vaclav Zeman). This is to fix LuaLaTeX output. The -{}- sequence does not avoid the ligature with LuaLaTeX but \/ does.hyperref and hyperdef (#1130).ConTeXt writer: Improved autolinks (#1270).
DocBook writer:
<literallayout> for the entire paragraph, not just for the newline character.spacing="compact" (Neil Mayhew, #1250).Docx writer: When needed files are not present in the user’s reference.docx, fall back on the versions in the reference.docx in pandoc’s data files. This fixes a bug that occurs when a reference.docx saved by LibreOffice is used. (#1185)
EPUB writer:
img tags (#1170).audio source tags (#1170). Note that we now use a media directory rather than images.video tags (#1170). src and poster will both be incorporated into content.opf and the epub container.HTML writer:
unnumbered) were getting numbers.<embed> to be used instead of <img>.Man writer: Ensure that terms in definition lists aren’t line wrapped (#1195).
Markdown writer:
RST writer: Avoid stack overflow with certain tables (#1197).
RTF writer: Fixed table cells containing paragraphs.
Custom writer:
+ or - (#1267). Note that getWriter in Text.Pandoc no longer returns a custom writer on input foo.lua.AsciiDoc writer: Handle multiblock and empty table cells (#1245, #1246). Added tests.
Text.Pandoc.Options: Added readerTrace to ReaderOptions
Text.Pandoc.Shared:
compactify'DL (formerly in markdown reader) (Albert Krewinkel).toRomanNumeral: numbers ending with ‘9’ would be rendered as Roman numerals ending with ‘IXIV’ (#1249). Thanks to Jesse Rosenthal.openURL: set proxy with value of http_proxy env variable (#1211). Note: proxies with non-root paths are not supported, due to limitations in http-conduit.Text.Pandoc.PDF:
/ as path separators in a few places, even on Windows. This seems to be necessary for texlive (#1151, thanks to Tim Lin).; for TEXINPUTS separator on Windows (#1151).Text.Pandoc.Templates:
Removed unneeded datatype context (Merijn Verstraaten).
YAML objects resolve to “true” in conditionals (#1133). Note: If address is a YAML object and you just have $address$ in your template, the word true will appear, which may be unexpected. (Previously nothing would appear.)
Text.Pandoc.SelfContained: Handle poster attribute in video tags (#1188).
Text.Pandoc.Parsing:
F an instance of Applicative (#1138).stateCaption.HasMacros, simplified other typeclasses. Removed updateHeaderMap, setHeaderMap, getHeaderMap, updateIdentifierList, setIdentifierList, getIdentifierList.Inlines rather than Inline (Matthew Pickering).HasReaderOptions, HasHeaderMap, HasIdentifierList from typeclasses of monads to typeclasses of states. This simplifies the instance definitions and provides more flexibility. Generalized type of getOption and added a default definition. Removed askReaderOption. Added extractReaderOption. Added extractHeaderMap and updateHeaderMap in HasHeaderMap. Gave default definitions for getHeaderMap, putHeaderMap, modifyHeaderMap. Added extractIdentifierList and updateIdentifierList in HasIdentifierList. Gave defaults for getIdentifierList, putIdentifierList, and modifyIdentifierList. The ultimate goal here is to allow different parsers to use their own, tailored parser states (instead of ParserState) while still using shared functions.Template changes:
fontenc package only with pdflatex (#1164).linestretch and fontfamily variables.\setkeys{Gin}{} to set appropriate defaults for \includegraphics (Yihui Xie, Garrick Aden-Buie). Load upquote only after fontenc (Yihui Xie).authorgroup if there are authors.include-after to end (certainlyakey).Bumped version bounds of dependencies.
Added a --trace command line option, for debugging backtracking bugs. So far this only works with the markdown reader.
MathMLinHTML: Fixed deprecation warning (#362, gwern, Albert Krewinkel).
Updated travis script to test with multiple GHC versions.
Force failure of a Travis build if GHC produces warnings (Albert Krewinkel).
Add .editorconfig (Albert Krewinkel). See http://editorconfig.org/ for details.
Give more useful error message if ‘-t pdf’ is specified (#1155).
Added Cite, SmallCaps to Arbitrary instance (#1269).
Allow html4 as a synonym of html as a reader (it already works as a writer).
README:
\nocite).--bibtex/--natbib: not for use in making PDF (#1194, thanks to nahoj).--natbib and --biblatex.Removed copyright statements for files that have been removed (Albert Krewinkel).
Moved some doc files from data-files to extra-source-files (#1123). They aren’t needed at runtime. We keep README and COPYRIGHT in data to ensure that they’ll be available on all systems on which pandoc is installed.
Use cabal sandboxes in Windows build script.
Bumped version bounds for blaze-html, blaze-markup.
ImageSize: Avoid use of lookAhead, which is not in binary >= 0.6 (#1124).
Fixed mediawiki ordered list parsing (#1122).
HTML reader: Fixed bug reading inline math with $$ (#225).
Added support for LaTeX style literate Haskell code blocks in rST (Merijn Verstraaten).
The --bibliography option now sets the biblio-files variable. So, if you’re using --natbib or --biblatex, you can just use --bibliography=foo.bib instead of -V bibliofiles=foo.
Don’t run pandoc-citeproc filter if --bibliography is used together with --natbib or --biblatex (Florian Eitel).
Template changes:
abstract variable to LaTeX template.header-includes after title in LaTeX template (#908).\includegraphics[size] in beamer. This just required porting a macro definition from the default LaTeX template to the default beamer template.reference.docx: Include FootnoteText style. Otherwise Word ignores the style, even when specified in the pPr. (#901)
reference.odt: Tidied styles.xml.
Relaxed version bounds for dependencies.
Added withSocketsDo around http conduit code in openURL, so it works on Windows (#1080).
Added Cite function to sample.lua.
Markdown reader:
LaTeX reader:
Verb macro (jrnold) (#1090)."`..."'.Properly handle script blocks in strict mode. (That is, markdown-markdown_in_html_blocks.) Previously a spurious <p> tag was being added (#1093).
Docbook reader: Avoid failure if tbody contains no tr or row elements.
LaTeX writer:
HTML reader: Parse name/content pairs from meta tags as metadata. Closes #1106.
Moved fixDisplayMath from Docx writer to Writer.Shared.
OpenDocument writer: Fixed RawInline, RawBlock so they don’t escape.
ODT writer: Use mathml for proper rendering of formulas. Note: LibreOffice’s support for this seems a bit buggy. But it should be better than what we had before.
RST writer: Ensure no blank line after def in definition list (#992).
Markdown writer: Don’t use tilde code blocks with braced attributes in markdown_github output. A consequence of this change is that the backtick form will be preferred in general if both are enabled. That is good, as it is much more widespread than the tilde form. (#1084)
Docx writer: Fixed problem with some modified reference docx files. Include word/_rels/settings.xml.rels if it exists, as well as other rels files besides the ones pandoc generates explicitly.
HTML writer:
--toc, headers no longer link to themselves (#1081).EPUB writer:
--epub-stylesheet. Now the contents of writerEpubStylesheet (set by --epub-stylesheet) should again work, and take precedence over a stylesheet specified in the metadata.Text.Pandoc.Pretty: Added nestle. API change.
Text.Pandoc.MIME: Added wmf, emf.
Text.Pandoc.Shared: fetchItem now handles image URLs beginning with //.
Text.Pandoc.ImageSize: Parse EXIF format JPEGs. Previously we could only get size information for JFIF format, which led to squished images in Word documents. Closes #976.
Removed old MarkdownTest_1.0.3 directory (#1104).
Metadata may now be included in YAML blocks in a markdown document. For example,
---
title:
- type: main
text: My Book
- type: subtitle
text: An investigation of metadata
creator:
- role: author
text: John Smith
- role: editor
text: Sarah Jones
identifier:
- scheme: DOI
text: doi:10.234234.234/33
publisher: My Press
rights: (c) 2007 John Smith, CC BY-NC
cover-image: img/mypic.jpg
stylesheet: style.css
...Metadata may still be provided using --epub-metadata; it will be merged with the metadata in YAML blocks.
EPUB writer:
meta tags are now used instead of opf attributes for EPUB3.imageTypeOf using getMimeType.cover-image item for EPUB 3.cover.xhtml if no cover!linear="no". Apparently this is best practice for other converters as well: http://www.idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.6.stylesheet in metadata. The value is a path to the stylesheet.YYYY, YYYY-MM.Markdown writer: Fix rendering of tight sublists (#1050). Previously a spurious blank line was included after a tight sublist.
ODT writer: Add draw:name attribute to draw:frame elements (#1069). This is reported to be necessary to avoid an error from recent versions of Libre Office when files contain more than one image Thanks to wmanley for reporting and diagnosing the problem.
ConTeXt writer: Don’t hardcode figure/table placement and numbering. Instead, let this be set in the template, using \setupfloat. Thanks to on4aa and Aditya Mahajan for the suggestion (#1067).
Implemented CSL flipflopping spans in DOCX, LaTeX, and HTML writers.
Fixed bug with markdown intraword emphasis. Closes #1066.
Docbook writer: Hierarchicalize block content in metadata. Previously headers just disappeared from block-level metadata when it was used in templates. Now we apply the ‘hierarchicalize’ transformation. Note that a block headed by a level-2 header will turn into a <sect1> element.
OpenDocument writer: Skip raw HTML (#1035). Previously it was erroneously included as verbatim text.
HTML/EPUB writer, footnotes: Put <sup> tag inside <a> tags. This allows better control of formatting, since the <a> tags have a distinguishing class (#1049).
Docx writer:
dc:creator nodes; instead separate by semicolons._rels/.rels (#1046).Plain writer: don’t print <span> tags.
LaTeX writer:
Updated beamer template. Now references should work properly (in a slide) when --biblatex or --natbib is used.
LaTeX reader:
" as quotes.\textnormal as span with class nodecor. This is needed for pandoc-citeproc.\citet{} (empty list of keys). It also ensures that empty keys don’t get produced.MediaWiki reader: Add automatic header identifiers.
HTML reader:
Div and Span for raw <div>, <span> when --parse-raw.svg tags as block level content (thanks to MinRK).Markdown reader:
---. If there’s a blank line after ---, we interpreted it as a horizontal rule.</div>.Slides: Preserve <div class="references"> in references slide.
Text.Pandoc.Writer.Shared:
tagWithAttrs. A space was omitted before key-value attributes, leading to invalid HTML.normalizeDate: Allow dates with year only (thanks to Shaun Attfield).openURL with data: URIs. Previously the base-64 encoded bytestring was returned. We now decode it so it’s a proper image!DocBook reader: Handle numerical attributes starting with decimal. Also use safeRead instead of read.
Text.Pandoc.Parsing:
registerHeader, using new type classes HasReadeOptions, HasIdentifierList, HasHeaderMap. These allow certain common functions to be reused even in parsers that use custom state (instead of ParserState), such as the MediaWiki reader.Text.Pandoc.Readers.TexMath: Export readTeXMath', which attends to display/inline. Deprecate readTeXMath, and use readTeXMath' in all the writers. Require texmath >= 0.6.5.2.
Text.Pandoc.MIME:
jfif.Templates: Changed how array variables are resolved. Previously if foo is an array (which might be because multiple values were set on the command line), $foo$ would resolve to the concatenation of the elements of foo. This is rarely useful behavior. It has been changed so that the first value is rendered. Of course, you can still iterate over the values using $for(foo)$. This has the result that you can override earlier settings using -V by putting new values later on the command line, which is useful for many purposes.
Text.Pandoc: Don’t default to pandocExtensions for all writers.
Allow “epub2” as synonym for “epub”, “html4” for “html”.
Don’t look for slidy files in data files with --self-contained.
Allow https: command line arguments to be downloaded.
Fixed make_osx_package.sh so data files embedded in pandoc-citeproc.
Text.Pandoc.Definition: Changed default JSON serialization format. Instead of {"Str": "foo"}, for example, we now have {"t": "Str", "c": "foo"}. This new format is easier to work with outside of Haskell. Incidentally, “t” stands for “tag”, “c” for “contents”.
MediaWiki reader: Trim contents of <math> tags, to avoid problems when converting to markdown (#1027).
LaTeX reader:
\url{}. Previously \~ wasn’t handled properly, among others.{groups} as Span. This is needed for accurate conversion of bibtex titles, since we need to know what was protected from titlecase conversions.LaTeX writer:
Throughout the code, use isURI instead of isAbsoluteURI. It allows fragments identifiers.
Slide formats:
\note{}, revealjs to <aside class="notes">, and the notes are simply suppressed in other formats (#925).. . . (pause) on HTML slide formats. Closes #1029. The old version caused a pause to be inserted before the first material on a slide. This has been fixed.HTML writer: Insert command to typeset mathjax only in slideous output (#966, #1012).
RST writer: Skip spaces after display math. Otherwise we get indentation problems, and part of the next paragraph may be rendered as part of the math.
OpenDocument writer: Fix formatting of strikeout code (#995), thanks to wilx. don’t use font-face-decls variable.
Fixed test suite so it works with cabal sandboxes.
stringable) from pandoc.cabal. This will help packagers, but users should not need to upgrade.Allow --metadata to be repeated for the same key to form a list. This also has the effect that --bibliography can be repeated, as before.
Handle boolean values in --metadata. Note that anything not parseable as a YAML boolean or string is treated as a literal string. You can get a string value with “yes”, or any of the strings interpretable as booleans, by quoting it:
-M boolvalue=yes -M stringvalue='"yes"'LaTeX writer: Don’t print references if --natbib or --biblatex option used.
DOCX writer: Add settings.xml to the zip container. Fixes a bug in which docx files could not be read by some versions of Word and LibreOffice (#990).
Fixed a regression involving slide shows with bibliographies. The Div container around references messed up the procedure for carving a document into slides. So we now remove the surrounding Div in prepSlides.
More informative error message when a filter is not found in path.
Depend on pandoc-types 1.12.1. This provide ToJSONFilter instances for Data a => a -> [a] and Data a => a -> IO [a].
Don’t use unicode_collation in building OSX package: it adds something like 50MB of dependencies to the package.
Declare alex and happy as build-tools (#986).
Much more flexible metadata, including arbitrary fields and structured values. Metadata can be specified flexibly in pandoc markdown using YAML metadata blocks, which may occur anywhere in the document:
---
title: Here is my title.
abstract: |
This is the abstract.
1. It can contain
2. block content
and *inline markup*
tags: [cat, dog, animal]
...Metadata fields automatically populate template variables.
Added opml (OPML) as input and output format. The _note attribute, used in OmniOutliner and supported by multimarkdown, is supported. We treat the contents as markdown blocks under a section header.
Added haddock (Haddock markup) as input format (David Lazar).
Added revealjs output format, for reveal.js HTML 5 slide shows. (Thanks to Jamie F. Olson for the initial patch.) Nested vertical stacks are used for hierarchical structure. Results for more than one level of nesting may be odd.
Custom writers can now be written in lua.
pandoc -t data/sample.luawill load the script sample.lua and use it as a custom writer. (For a sample, do pandoc --print-default-data-file sample.lua.) Note that pandoc embeds a lua interpreter, so lua need not be installed separately.
New --filter/-F option to make it easier to run “filters” (Pandoc AST transformations that operate on JSON serializations). Filters are always passed the name of the output format, so their behavior can be tailored to it. The repository https://github.com/jgm/pandocfilters contains a python module for writing pandoc filters in python, with a number of examples.
Added --metadata/-M option. This is like --variable/-V, but actually adds to metadata, not just variables.
Added --print-default-data-file option, which allows printing of any of pandoc’s data files. (For example, pandoc --print-default-data-file reference.odt will print reference.odt.)
Added syntax for “pauses” in slide shows:
This gives
. . .
me pause.New markdown extensions:
ignore_line_breaks: causes intra-paragraph line breaks to be ignored, rather than being treated as hard line breaks or spaces. This is useful for some East Asian languages, where spaces aren’t used between words, but text is separated into lines for readability.yaml_metadata_block: Parse YAML metadata blocks. (Default.)ascii_identifiers: This will force auto_identifiers to use ASCII only. (Default for markdown_github.) (#807)lists_without_preceding_blankline: Allow lists to start without preceding blank space. (Default for markdown_github.) (#972)--toc-level no longer implies --toc. Reason: EPUB users who don’t want a visible TOC may still want to set the TOC level for in the book navigation.
--help now prints in and out formats in alphabetical order, and says something about PDF output (#720).
--self-contained now returns less verbose output (telling you which URLs it is fetching, but not giving the full header). In addition, there are better error messages when fetching a URL fails.
Citation support is no longer baked in to core pandoc. Users who need citations will need to install and use a separate filter (--filter pandoc-citeproc). This filter will take bibliography, csl, and citation-abbreviations from the metadata, though it may still be specified on the command line as before.
A Cite element is now created in parsing markdown whether or not there is a matching reference.
The pandoc-citeproc script will put the bibliography at the end of the document, as before. However, it will be put inside a Div element with class “references”, allowing users some control over the styling of references. A final header, if any, will be included in the Div.
The markdown writer will not print a bibliography if the citations extension is enabled. (If the citations are formatted as markdown citations, it is redundant to have a bibliography, since one will be generated automatically.)
Previously we used to store the directory of the first input file, even if it was local, and used this as a base directory for finding images in ODT, EPUB, Docx, and PDF. This has been confusing to many users. So we now look for images relative to the current working directory, even if the first file argument is in another directory. Note that this change may break some existing workflows. If you have been assuming that relative links will be interpreted relative to the directory of the first file argument, you’ll need to make that the current directory before running pandoc. (#942)
Better error reporting in some readers, due to changes in readWith: the line in which the error occurred is printed, with a caret pointing to the column.
All slide formats now support incremental slide view for definition lists.
Parse \(..\) and \[..\] as math in MediaWiki reader. Parse :<math>...</math> as display math. These notations are used with the MathJax MediaWiki extension.
All writers: template variables are set automatically from metadata fields. However, variables specified on the command line with --variable will completely shadow metadata fields.
If --variable is used to set many variables with the same name, a list is created.
Man writer: The title, section, header, and footer can now all be set individually in metadata. The description variable has been removed. Quotes have been added so that spaces are allowed in the title. If you have a title that begins
COMMAND(1) footer here | header herepandoc will still parse it into a title, section, header, and footer. But you can also specify these elements explicitly (#885).
Markdown reader
Markdown writer
pandoc -t markdown-pipe_tables-simple_tables-multiline_tables and all tables will render as grid tables.Meta in Text.Pandoc.Definition has been changed to allow structured metadata. (Note: existing code that pattern-matches on Meta will have to be revised.) Metadata can now contain indefinitely many fields, with content that can be a string, a Boolean, a list of Inline elements, a list of Block elements, or a map or list of these.
A new generic block container (Div) has been added to Block, and a generic inline container (Span) has been added to Inline. These can take attributes. They will render in HTML, Textile, MediaWiki, Org, RST and Markdown (with markdown_in_html extension) as HTML <div> and <span> elements; in other formats they will simply pass through their contents. But they can be targeted by scripts.
Format is now a newtype, not an alias for String. Equality comparisons are case-insensitive.
Added Text.Pandoc.Walk, which exports hand-written tree-walking functions that are much faster than the SYB functions from Text.Pandoc.Generic. These functions are now used where possible in pandoc’s code. (Tests.Walk verifies that walk and query match the generic traversals bottomUp and queryWith.)
Added Text.Pandoc.JSON, which provides ToJSON and FromJSON instances for the basic pandoc types. They use GHC generics and should be faster than the old JSON serialization using Data.Aeson.Generic.
Added Text.Pandoc.Process, exporting pipeProcess. This is a souped-up version of readProcessWithErrorcode that uses lazy bytestrings instead of strings and allows setting environment variables. (Used in Text.Pandoc.PDF.)
New module Text.Pandoc.Readers.OPML.
New module Text.Pandoc.Writers.OPML.
New module Text.Pandoc.Readers.Haddock (David Lazar). This is based on Haddock’s own lexer/parser.
New module Text.Pandoc.Writers.Custom.
In Text.Pandoc.Shared, openURL and fetchItem now return an Either, for better error handling.
Made stringify polymorphic in Text.Pandoc.Shared.
Removed stripTags from Text.Pandoc.XML.
Text.Pandoc.Templates:
Template type to a newtype.Empty.renderTemplate: it now takes a JSON context and a compiled template.compileTemplate.renderTemplate' that takes a string instead of a compiled template.varListToJSON.Text.Pandoc.PDF exports makePDF instead of tex2pdf.
Text.Pandoc:
toJsonFilter an alias for toJSONFilter from Text.Pandoc.JSON.ToJsonFilter typeclass. ToJSONFilter from Text.Pandoc.JSON should be used instead. (Compiling against pandoc-types instead of pandoc will also produce smaller executables.)jsonFilter function.readJSON, writeJSON to the API (#817).Text.Pandoc.Options:
Ext_lists_without_preceding_blankline, Ext_ascii_identifiers, Ext_ignore_line_breaks, Ext_yaml_metadataBlock to Extension.writerSourceDirectory to writerSourceURL and changed the type to a Maybe. writerSourceURL is set to ‘Just url’ when the first command-line argument is an absolute URL. (So, relative links will be resolved in relation to the first page.) Otherwise, ‘Nothing’.ReaderOptions and WriterOptions: writerBiblioFiles, readerReferences, readerCitationStyle.The Text.Pandoc.Biblio module has been removed. Users of the pandoc library who want citation support will need to use Text.CSL.Pandoc from pandoc-citeproc.
In markdown, don’t autolink a bare URI that is followed by </a> (#937).
Text.Pandoc.Shared
openURL now follows redirects (#701), properly handles data: URIs, and prints diagnostic output to stderr rather than stdout.readDefaultDataFile: normalize the paths. This fixes bugs in --self-contained on pandoc compiled with embed_data_files (#833).readDefaultDataFile so it works on Windows.readDefaultDataFile. Instead of listing the last path tried, which can confuse people who are using --self-contained, so now we just list the data file name.Network.URI doesn’t regard them as legal in URLs. So we escape them first (#535).Mathjax in HTML slide shows: include explicit “Typeset” call. This seems to be needed for some formats (e.g. slideous) and won’t hurt in others (#966).
Text.Pandoc.PDF
TEXINPUTS (see #917).makePDF tries to download images that are not found locally, if the first argument is a URL (#917).pdflatex yields an encoding error, offer the suggestion to use --latex-engine=xelatex.Produce automatic header identifiers in parsing textile, RST, and LaTeX, unless auto_identifiers extension is disabled (#967).
Text.Pandoc.SelfContained: Strip off fragment, query of relative URL before treating as a filename. This fixes --self-contained when used with CSS files that include web fonts using the method described here: http://paulirish.com/2009/bulletproof-font-face-implementation-syntax/ (#739). Handle src in embed, audio, source, input tags.
Text.Pandoc.Parsing: uri parser no longer treats punctuation before percent-encoding, or a + character, as final punctuation.
Text.Pandoc.ImageSize: Handle EPS (#903). This change will make EPS images properly sized on conversion to Word.
Slidy: Use slidy.js rather than slidy.js.gz. Reason: some browsers have trouble with the gzipped js file, at least on the local file system (#795).
Markdown reader
[*infile*] [*outfile*] was getting improperly parsed: “infile” was emphasized, but “outfile” was literal (#883).+ in citation identifiers (#856).. or ) after # in ATX headers if no fancy_lists.Textile reader:
<pre> blocks (#927). Remove internal HTML tags in code blocks, rather than printing them verbatim. Parse attributes on <pre> tag for code blocks.HTML reader: Handle non-simple tables (#893). Column widths are read from col tags if present, otherwise divided equally.
LaTeX reader
\textasciitilde, \textasciicircum (#810).\textsl as emphasized text reader (#850).\begin{figure}.\v{} for hacek (#926).{ l r c }.RST reader:
rst2html doesn’t add <p> tags to list items (even when they are separated by blank lines) unless there are multiple paragraphs in the list. This commit changes the RST reader to conform more closely to what docutils does (#880).subtitle metadata field for subtitle.MediaWiki reader
<ref>URL</ref>. < is no longer allowed in URLs, according to the uri parser in Text.Pandoc.Parsing. Added a test case.| links inside table cells. Improved attribute parsing.Image: for images (#971).LaTeX writer
| in LaTeX math. This caused problems with array environments (#891).\ to / in paths. / works even on Windows in LaTeX. \ will cause major problems if unescaped.Beamer writer: when creating beamer slides, add allowframebreaks option to the slide if it is one of the header classes. It is recommended that your bibliography slide have this attribute:
# References {.allowframebreaks}This causes multiple slides to be created if necessary, depending on the length of the bibliography.
ConTeXt writer: Properly handle tables without captions. The old output only worked in MkII. This should work in MkIV as well (#837).
MediaWiki writer: Use native mediawiki tables instead of HTML (#720).
HTML writer:
--no-highlight (Alexander Kondratskiy).<title> and <meta> fields.AsciiDoc writer:
--atx-headers (Max Rydahl Andersen).([[]]) on headers (Max Rydahl Andersen).ODT writer:
reference.odt: Added pandoc as “generator” in meta.xml.contextual-spacing attribute, which is provided by LibreOffice itself and seems well supported.Docx writer:
w:br with w:type textWrapping for linebreaks. Previously we used w:cr (#873).reference.docx. We take the word/styles.xml, docProps/app.xml, word/theme/theme1.xml, and word/fontTable.xml from reference.docx, ignoring everything else. This should help with the corruption problems caused when different versions of Word resave the reference.docx and reorganize things.--no-highlight work properly.EPUB writer
dc:creator tags if present in EPUB metadata.id="toc-title" to h1 in nav.xhtml (#799).linear="no" if no title block. Addresses #797.--webtex in creating EPUBs. Math with --webtex is automatically made self-contained.data/epub.css, removed highlighting styles (which are no longer needed, since styles are added by the HTML writer according to --highlighting-style). Simplified margin fields.RTF writer:
Markdown writer:
Text.Pandoc.Templates:
author.institution will retrieve the institution field of the author variable.$for$. When foo is not a list, $for(foo)$...$endfor$ should behave like if(foo)…endif. So if foo resolves to ““, no output should be produced. See pandoc-templates#39.Citation processing improvements (now part of pandoc-citeproc):
endWithPunct The new version correctly sees a sentence ending in ‘.)’ as ending with punctuation. This fixes a bug which led such sentences to receive an extra period at the end: ‘.).’. Thanks to Steve Petersen for reporting.\citep[23]{item1} in LaTeX will be interpreted properly, with ‘23’ treated as a locator of type ‘page’.???.DocBook: Use DocBook 4.5 doctype.
Org: ‘#+TITLE:’ is inserted before the title. Previously the writer did this.
LaTeX: Changes to make mathfont work with xelatex. We need the mathspec library, not just fontspec, for this. We also need to set options for setmathfont (#734).
LaTeX: Use tex-ansi mapping for monofont. This ensures that straight quotes appear as straight, rather than being treated as curly. See #889.
Made \includegraphics more flexible in LaTeX template. Now it can be used with options, if needed. Thanks to Bernhard Weichel.
LaTeX/Beamer: Added classoption variable. This is intended for class options like oneside; it may be repeated with different options. (Thanks to Oliver Matthews.)
Beamer: Added fonttheme variable. (Thanks to Luis Osa.)
LaTeX: Added biblio-style variable (#920).
DZSlides: title attribute on title section.
HTML5: add meta tag to allow scaling by user (Erik Evenson)
Markdown reader:Improved strong/emph parsing, using the strategy of https://github.com/jgm/Markdown. The new parsing algorithm requires no backtracking, and no keeping track of nesting levels. It will give different results in some edge cases, but these should not affect normal uses.
Added Text.Pandoc.Compat.Monoid. This allows pandoc to compile with base < 4.5, where Data.Monoid doesn’t export <>. Thanks to Dirk Ullirch for the patch.
Added Text.Pandoc.Compat.TagSoupEntity. This allows pandoc to compile with tagsoup 0.13.x. Thanks to Dirk Ullrich for the patch.
Most of Text.Pandoc.Readers.TeXMath has been moved to the texmath module (0.6.4). (This allows pandoc-citeproc to handle simple math in bibliography fields.)
Added Text.Pandoc.Writers.Shared for shared functions used only in writers. metaToJSON is used in writers to create a JSON object for use in the templates from the pandoc metadata and variables. getField, setField, and defField are for working with JSON template contexts.
Added Text.Pandoc.Asciify utility module. This exports functions to create ASCII-only versions of identifiers.
Text.Pandoc.Parsing
readWith (API change).String input. (API change).ParserState, replace stateTitle, stateAuthors, stateDate with stateMeta and stateMeta'.Text.Pandoc.UTF8: use strict bytestrings in reading. The use of lazy bytestrings seemed to cause problems using pandoc on 64-bit Windows 7/8 (#874).
Factored out registerHeader from markdown reader, added to Text.Pandoc.Parsing.
Removed blaze_html_0_5 flag, require blaze-html >= 0.5. Reason: < 0.5 does not provide a monoid instance for Attribute, which is now needed by the HTML writer (#803).
Added http-conduit flag, which allows fetching https resources. It also brings in a large number of dependencies (http-conduit and its dependencies), which is why for now it is an optional flag (#820).
Added CONTRIBUTING.md.
Improved INSTALL instructions.
make-windows-installer.bat: Removed explicit paths for executables.
aeson is now used instead of json for JSON.
Set default stack size to 16M. This is needed for some large conversions, esp. if pandoc is compiled with 64-bit ghc.
Various small documentation improvements. Thanks to achalddave and drothlis for patches.
Removed comment that chokes recent versions of CPP (#933).
Removed support for GHC version < 7.2, since pandoc-types now requires at least GHC 7.2 for GHC generics.
Markdown reader:
--smart mode. These occur frequently in fiction, since it is customary not to close quotes in dialogue if the speaker does not change between paragraphs. The unmatched quotes now get turned into literal left double quotes. (No Quoted inline is generated, however.) Closes #99 (again).HTML writer: Fixed numbering mismatch between TOC and sections. --number-offset now affects TOC numbering as well as section numbering, as it should have all along. Closes #789.
Markdown writer: Reverted 1.11 change that caused citations to be rendered as markdown citations, even if --bibliography was specified, unless citation extension is disabled. Now, formatted citations are always printed if --bibliography was specified. If you want to reformat markdown keeping pandoc markdown citations intact, don’t use --bibliography. Note that citations parsed from LaTeX documents will be rendered as pandoc markdown citations when --bibliography is not specified.
ODT writer: Fixed regression leading to corrupt ODTs. This was due to a change in the Show instance for Text.Pandoc.Pretty.Doc. Closes #780.
Fixed spacing bugs involving code block attributes in RST reader and Markdown writer. Closes #763.
Windows package: Various improvements due to Fyodor Sheremetyev.
msiexec /i pandoc-1.11.msi ALLUSERS=1.Bumped QuickCheck version bound.
Added --number-offset option. (See README for description.)
Added --default-image-extension option. (See README for description.)
--number-sections behavior change: headers with class unnumbered will not be numbered.
--version now reports the default data directory.
Text.Pandoc.Parsing is no longer exposed. (API change.)
Text.Pandoc.Highlighting is no longer exposed. (API change.)
Text.Pandoc.Shared: Changed type of Element. Sec now includes a field for Attr rather than just String. (API change.)
Added markdown_github as input format. This was an accidental omission in 1.10.
Added readerDefaultImageExtension field to ReaderOptions. (API change.)
Added writerNumberOffset field in WriterOptions. (API change.)
Beamer template:
\Oldincludegraphics as in LaTeX template (Benjamin Bannier).LaTeX template:
secnumdepth to 5 if --number-sections specified. This yields behavior equivalent to the other writers, numbering level 4 and 5 headers too. Closes #753.HTML reader:
<colgroup> tag.LaTeX reader:
\hrule as HorizontalRule. Closes #746.\section etc. as headers with attribute unnumbered.lstlisting and Verbatim environments. We convert these to pandoc standard names, e.g. numberLines for numbers=left, startFrom=100 from firstnumber=100.Markdown reader:
- in an attribute context = .unnumbered. The point of this is to provide a way to specify unnumbered headers in non-English documents.mmd_title_blocks is specified, pandoc will parse a MMD title block if it sees one, even if pandoc_title_blocks is enabled.litChar now includes entities, so we don’t need to use fromEntities e.g. on titles.---- were disallowed, because the uri parser treated them as trailing punctuation. Closes #768.implicit_header_references work properly when headers are given explicit identifiers.& in emails (for entities).<http://göogle.com> should be a link to http://göogle.com. Closes #723.Textile reader:
LaTeX reader:
fig: as title for images with captions. This is needed for them to be rendered as figures. Closes #766.\caption for images in figures. Closes #766.\section*, etc. as unnumbered sections.HTML writer:
section or div tag if --section-divs is specified.LaTeX writer:
--listings. If numberLines class is present, we add numbers=left; if startFrom is present, we add firstnumber=. (#763)ConTeXt writer:
\placecontent. This produced a duplicate toc, in conjunction with \placelist.\title, \subject etc. for headers with unnumbered class.Textile writer:
Markdown writer:
[@item1], unless the citations extension is disabled. If you still want formatted citations in your markdown output, use pandoc -t markdown-citations.RST writer:
:number-lines: in code blocks.Docx writer:
reference.docx. This fixes problems that arise when you edit the reference.docx with Word.reference docx. FootnoteReference -> FootnoteRef, Hyperlink -> Link. The old names got changed by Word when the reference.docx was edited. Closes #414.EPUB writer:
--number-sections), though the numbers in the table of contents were correct.<spine>, but linear is set to no unless the --toc option is specified. Include <guide> element in OPF. This should allow the TOC to be usable in Kindles when converted with kindlegen. Closes #773.Text.Pandoc.Parsing: Optimized oneOfStringsCI. This dramatically reduces the speed penalty that comes from enabling the autolink_bare_uris extension. The penalty is still substantial (in one test, from 0.33s to 0.44s), but nowhere near what it used to be. The RST reader is also much faster now, as it autodetects URIs.
Text.Pandoc.Shared: hierarchicalize will not number section with class “unnumbered”. Unnumbered sections get [] for their section number.
Text.Pandoc.Pretty:
chomp so it works inside Prefixed elements.Show instance so it is better for debugging.Text.Pandoc.ImageSize: Added Pdf to ImageType.
Text.Pandoc.UTF8: Strip off BOM if present. Closes #743.
Windows installer improvements:
OSX installer improvements:
InstallationCheck script (jonahbull). Closes #580.Converted COPYING to markdown.
pandoc.cabal: Require latest versions of highlighting-kate, texmath, citeproc-hs, zip-archive.
Markdown reader: various optimizations, leading to a significant performance boost.
RST reader: Allow anonymous form of inline links: `hello <url>`__ Closes #724.
Mediawiki reader: Don’t require newlines after tables. Thanks to jrunningen for the patch. Closes #733.
Fixed LaTeX macro parsing. Now LaTeX macro definitions are preserved when output is LaTeX, and applied when it is another format. Partially addresses #730.
Markdown and RST readers: Added parser to block that skips blank lines. This fixes a subtle regression involving grid tables with empty cells. Also added test for grid table with empty cells. Closes #732.
RST writer: Use .. code:: language for code blocks with language. Closes #721.
DocBook writer: Fixed output for hard line breaks, adding a newline between <literallayout> tags.
Markdown writer: Use an autolink when link text matches url. Previously we also checked for a null title, but this test fails for links produced by citeproc-hs in bibliographies. So, if the link has a title, it will be lost on conversion to an autolink, but that seems okay.
Markdown writer: Set title, author, date variables as before. These are no longer used in the default template, since we use titleblock, but we set them anyway for those who use custom templates.
LaTeX writer: Avoid extra space at start/end of table cell. Thanks to Nick Bart for the suggestion of using @.
Text.Pandoc.Parsing:
anyLine.macro has changed; the parser now returns Blocks instead of Block.Relaxed old-time version bound, allowing 1.0.*.
Removed obsolete hsmarkdown script. Those who need hsmarkdown should create a symlink as described in the README.
Markdown reader: Try lhsCodeBlock before rawTeXBlock. Otherwise \begin{code}...\end{code} isn’t handled properly in markdown+lhs. Thanks to Daniel Miot for noticing the bug and suggesting the fix.
Markdown reader: Fixed bug with headerless grid tables. The 1.10 code assumed that each table header cell contains exactly one block. That failed for headerless tables (0) and also for tables with multiple blocks in a header cell. The code is fixed and tests provided. Thanks to Andrew Lee for pointing out the bug.
Markdown reader: Fixed regressions in fenced code blocks. Closes #722.
~~~ haskell), not just curly-bracketed attributes (~~~ {.haskell}).LaTeX template: Use \urlstyle{same} to avoid monospace URLs.
Markdown writer: Use proportional font for email autolinks with obfuscation. Closes #714.
Corrected name of blank_before_blockquote in README. Closes #718.
Text.Pandoc.Shared: Fixed bug in uri parser. The bug prevented an autolink at the end of a string (e.g. at the end of a line block line) from counting as a link. Closes #711.
Use the hsb2hs preprocessor instead of TH for embed_data_files. This should work on Windows, unlike the TH solution with file-embed.
Eliminated use of TH in test suite.
Added Text.Pandoc.Data (non-exported) to hold the association list of embedded data files, if the embed_data_files flag is selected. This isolates the code that needs special treatment with file-embed or hsb2hs.
Changes to make-windows-installer.bat.
highlighting-kate.cabal update; leave that to the user.Fixed EPUB writer so it builds with blaze-html 0.4.x. Thanks to Jens Petersen.
New input formats: mediawiki (MediaWiki markup).
New output formats: epub3 (EPUB v3 with MathML), fb2 (FictionBook2 ebooks).
New --toc-depth option, specifying how many levels of headers to include in a table of contents.
New --epub-chapter-level option, specifying the header level at which to divide EPUBs into separate files. Note that this normally affects only performance, not the visual presentation of the EPUB in a reader.
Removed the --strict option. Instead of using --strict, one can now use the format name markdown_strict for either input or output. This gives more fine-grained control that --strict did, allowing one to convert from pandoc’s markdown to strict markdown or vice versa.
It is now possible to enable or disable specific syntax extensions by appending them (with + or -) to the writer or reader name. For example,
pandoc -f markdown-footnotes+hard_line_breaksdisables footnotes and enables treating newlines as hard line breaks. The literate Haskell extensions are now implemented this way as well, using either +lhs or +literate_haskell. For a list of extension names, see the README under “Pandoc’s Markdown.”
The following aliases have been introduced for specific combinations of markdown extensions: markdown_phpextra, markdown_github, markdown_mmd, markdown_strict. These aliases work just like regular reader and writer names, and can be modified with extension modifiers as described above. (Note that conversion from one markdown dialect to another does not work perfectly, because there are differences in markdown parsers besides just the extensions, and because pandoc’s internal document model is not rich enough to capture all of the extensions.)
New --html-q-tags option. The previous default was to use <q> tags for smart quotes in HTML5. But <q> tags are also valid HTML4. Moreover, they are not a robust way of typesetting quotes, since some user agents don’t support them, and some CSS resets (e.g. bootstrap) prevent pandoc’s quotes CSS from working properly. We now just insert literal quote characters by default in both html and html5 output, but this option is provided for those who still want <q> tags.
The markdown reader now prints warnings (to stderr) about duplicate link and note references. Closes #375.
Markdown syntax extensions:
Added pipe tables. Thanks to François Gannaz for the initial patch. These conform to PHP Markdown Extra’s pipe table syntax. A subset of org-mode table syntax is also supported, which means that you can use org-mode’s nice table editor to create tables.
Added support for RST-style line blocks. These are useful for verse and addresses.
Attributes can now be specified for headers, using the same syntax as in code blocks. (However, currently only the identifier has any effect in most writers.) For example,
# My header {#foo}
See [the header above](#foo).Pandoc will now act as if link references have been defined for all headers without explicit identifiers. So, you can do this:
# My header
Link to [My header].
Another link to [it][My header].Closes #691.
LaTeX reader:
\input now works, as well as \include. TEXINPUTS is used. Pandoc looks recursively into included files for more included files.The Markdown reader no longer puts the text of autolinks in a Code inline. This means that autolinks will no longer appear in a monospace font.
The character / can now appear in markdown citation keys.
HTML blocks in strict_markdown are no longer required to begin at the left margin. Technically this is required, according to the markdown syntax document, but Markdown.pl and other markdown processors are more liberal.
The -V option has been changed so that if there are duplicate variables, those specified later on the command line take precedence.
Tight lists now work in LaTeX and ConTeXt output.
The LaTeX writer no longer relien on the enumerate package. Instead, it uses standard LaTeX commands to change the list numbering style.
The LaTeX writer now uses longtable instead of ctable. This allows tables to be split over page boundaries.
The RST writer now uses a line block to render paragraphs containing linebreaks (which previously weren’t supported at all).
The markdown writer now applies the --id-prefix to footnote IDs. Closes #614.
The plain writer no longer uses backslash-escaped line breaks (which are not very “plain”).
Text.Pandoc.UTF8: Better error message for invalid UTF8. Read bytestring and use Text’s decodeUtf8 instead of using System.IO.hGetContents. This way you get a message saying “invalid UTF-8 stream” instead of “invalid byte sequence.” You are also told which byte caused the problem.
Docx, ODT, and EPUB writers now download images specified by a URL instead of skipping them or raising an error.
EPUB writer:
toc.ncx. There is no longer a subsidiary table of contents at the beginning of each chapter.HTML writer:
data-cite attribute with a space-separated list of citation keys.Text.Pandoc.UTF8: use universalNewlineMode in reading. This treats both \r\n and \n as \n on input, no matter what platform we’re running on.
Citation processing is now done in the Markdown and LaTeX readers, not in pandoc.hs. This makes it easier for library users to use citations.
HTML: Added css to template to preserve spaces in <code> tags. Thanks to Dirk Laurie.
Beamer: Remove English-centric strings in section pages. Section pages used to have “Section” and a number as well as the section title. Now they just have the title. Similarly for part and subsection. Closes #566.
LaTeX, ConTeXt: Added papersize variable.
LaTeX, Beamer templates: Use longtable instead of ctable.
LaTeX, Beamer templates: Don’t require ‘float’ package for tables. We don’t actually seem to use the ‘[H]’ option.
Markdown, plain: Fixed titleblock so it is just a single string. Previously separate title, author, and date variables were used, but this didn’t allow different kinds of title blocks.
EPUB:
default.epub or default.epub3. It can now be overridden using --template, just like other templates. The titlepage is now folded into the default template. A titlepage variable selects it.Added scale-to-width feature to beamer template
Text.Pandoc.Definition: Added Attr field to Header. Previously header identifiers were autogenerated by the writers. Now they are added in the readers (either automatically or explicitly).
Text.Pandoc.Builder:
Inlines and Blocks are now synonyms for Many Inline and Many Block. Many is a newtype wrapper around Seq, with custom Monoid instances for Many Inline and Many Block. This allowsManyto be made an instance ofFoldableandTraversable`.Listable class has been removed.isNull, toList, fromList.Read and Show instances have been removed; derived instances are now used.headerWith.The readers now take a ReaderOptions rather than a ParserState as a parameter. Indeed, not all parsers use the ParserState type; some have a custom state. The motivation for this change was to separate user-specifiable options from the accounting functions of parser state.
New module Text.Pandoc.Options. This includes the WriterOptions formerly in Text.Pandoc.Shared, and its associated data types. It also includes a new type ReaderOptions, which contains many options formerly in ParserState, and its associated data types:
ParserState.stateParseRaw -> ReaderOptions.readerParseRaw.ParserState.stateColumns -> ReaderOptions.readerColumns.ParserState.stateTabStop -> ReaderOptions.readerTabStop.ParserState.stateOldDashes -> ReaderOptions.readerOldDashes.ParserState.stateLiterateHaskell -> ReaderOptions.readerLiterateHaskell.ParserState.stateCitations -> ReaderOptions.readerReferences.ParserState.stateApplyMacros -> ReaderOptions.readerApplyMacros.ParserState.stateIndentedCodeClasses -> ReaderOptions.readerIndentedCodeClasses.ReaderOptions.readerCitationStyle.WriterOptions now includes writerEpubVersion, writerEpubChapterLevel, writerEpubStylesheet, writerEpubFonts, writerReferenceODT, writerReferenceDocx, and writerTOCDepth. writerEPUBMetadata has been renamed writerEpubMetadata for consistency.
Changed signatures of writeODT, writeDocx, writeEPUB, since they no longer stylesheet, fonts, reference files as separate parameters.
Removed writerLiterateHaskell from WriterOptions, and readerLiterateHaskell from ReaderOptions. LHS is now handled by an extension (Ext_literate_haskell).
Removed deprecated writerXeTeX.
Removed writerStrict from WriterOptions. Added writerExtensions. Strict is now handled through extensions.
Text.Pandoc.Options exports pandocExtensions, strictExtensions, phpMarkdownExtraExtensions, githubMarkdownExtensions, and multimarkdownExtensions, as well as the Extensions type.
New Text.Pandoc.Readers.MediaWiki module, exporting readMediaWiki.
New Text.Pandoc.Writers.FB2 module, exporting writeFB2 (thanks to Sergey Astanin).
Text.Pandoc:
getReader, getWriter to Text.Pandoc.writers is now an association list (String, Writer). A Writer can be a PureStringWriter, an IOStringWriter, or an IOByteStringWriter. ALL writers are now in the ‘writers’ list, including the binary writers and FB2 writer. This allows code in pandoc.hs to be simplified.readers, so all readers are in IO. Users who want pure readers can still get them form the reader modules; this just affects the function getReader that looks up a reader based on the format name. The point of this change is to make it possible to print warnings from the parser.Text.Pandoc.Parsing:
Text.Parsec now exports all Parsec functions used in pandoc code. No other module directly imports Parsec. This will make it easier to change the parsing backend in the future, if we want to.Text.Parsec is used instead of Text.ParserCombinators.Parsec.Parser.widthsFromIndices, NoteTable', KeyTable', Key', toKey', withQuoteContext, singleQuoteStart, singleQuoteEnd, doubleQuoteStart, doubleQuoteEnd, ellipses, apostrophe, dash, nested, F(..), askF, asksF, runF, lineBlockLines.ParserState is no longer an instance of Show.stateSubstitutions and stateWarnings to ParserState.withQuoteContext.guardEnabled, guardDisabled, getOption.failIfStrict.lookupKeySrc and fromKey are no longer exported.Data.Default instances are now provided for ReaderOptions, WriterOptions, and ParserState. Text.Pandoc re-exports def. Now you can use def (which is re-exported by Text.Pandoc) instead of defaultWriterOptions (which is still defined). Closes #546.
Text.Pandoc.Shared:
safeRead.removedLeadingTrailingSpace to trim, removeLeadingSpace to triml, and removeTrailingSpace to trimr.\r as space in trim functions.renderTags' from HTML reader and Text.Pandoc.SelfContained to Shared.failUnlessLHS.compactify', formerly in Markdown reader.isTightList.findDataFile.readDataFile now returns a strict ByteString.readDataFileUTF8 which returns a String, like the old readDataFile.fetchItem and openURL.Text.Pandoc.ImageSize: Use strict, not lazy bytestrings. Removed readImageSize.
Text.Pandoc.UTF8: Export encodePath, decodePath, decodeArg, toString, fromString, toStringLazy, fromStringLazy.
Text.Pandoc.UTF8 is now an exposed module.
Text.Pandoc.Biblio:
String rather than a FilePath.processBiblio. It is no longer in the IO monad. It now takes a Maybe Style argument rather than parameters for CSL and abbrev filenames. (pandoc.hs now calls the functions to parse the style file and add abbreviations.)Markdown reader now exports readMarkdownWithWarnings.
Text.Pandoc.RTF now exports writeRTFWithEmbeddedImages instead of rtfEmbedImage.
Make --ascii work properly with --self-contained. Closes #568.
Markdown reader:
Fixed link parser to avoid exponential slowdowns. Closes #620. Previously the parser would hang on input like this:
[[[[[[[[[[[[[[[[[[hiWe fixed this by making the link parser parser characters between balanced brackets (skipping brackets in inline code spans), then parsing the result as an inline list. One change is that
[hi *there]* bud](/url)is now no longer parsed as a link. But in this respect pandoc behaved differently from most other implementations anyway, so that seems okay.
Look for raw html/latex blocks before tables. Otherwise the following gets parsed as a table:
\begin{code}
--------------
-- My comment.
\end{code}Closes #578.
RST reader:
Added support for :target: on .. image:: blocks and substitutions.
Field list fixes:
Don’t recognize inline-markup starts inside words. For example, 2*2 = 4*1 should not contain an emphasized section. Added test case for “Literal symbols”. Closes #569.
Allow dashes as separator in simple tables. Closes #555.
Added support for container, compound, epigraph, rubric, highlights, pull-quote.
Added support for .. code::.
Made directive labels case-insensitive.
Removed requirement that directives begin at left margin. This was (correctly) not in earlier releases; docutils doesn’t make the requirement.
Added support for replace:: and unicode:: substitutions.
Ignore unknown interpreted roles.
Renamed image parser to subst, since it now handles all substitution references.
Textile reader:
Allow newlines before pipes in table. Closes #654.
Fixed bug with list items containing line breaks. Now pandoc correctly handles hard line breaks inside list items. Previously they broke list parsing.
Implemented comment blocks.
Fixed bug affected words ending in hyphen.
Properly handle links with surrounding brackets. Square brackets need to be used when the link isn’t surrounded by spaces or punctuation, or when the URL ending may be ambiguous. Closes #564.
Removed nullBlock. Better to know about parsing problems than to skip stuff when we get stuck.
Allow ID attributes on headers.
Textile reader: Avoid parsing dashes as strikeout. Previously the input
text--
text--
text--
text--would be parsed with strikeouts rather than dashes. This fixes the problem by requiring that a strikeout delimiting - not be followed by a -. Closes #631.
Expanded list of stringBreakers. This fixes a bug on input like “(hello)” which should be a parenthesized emphasized “hello”. The new list is taken from the PHP source of textile 2.4.
Fixed autolinks. Previously the textile reader and writer incorrectly implemented RST-style autolinks for URLs and email addresses. This has been fixed. Now an autolink is done this way: "$":http://myurl.com.
Fixed footnotes bug in textile. This affected notes occurring before punctuation, e.g. foo[1].. Closes #518.
LaTeX reader:
\noindent.\begin without {. Closes #622.rawLaTeXInline try to parse block commands as well. This is usually what we want, given how rawLaTeXInline is used in the markdown and textile readers. If a block-level LaTeX command is used in the middle of a paragraph (e.g. \subtitle inside a title), we can treat it as raw inline LaTeX.\slash command. Closes #605.\enquote support.HTML reader:
htmlBalanced, which caused hangs in parsing certain markdown input using strict mode.<q> as Quoted DoubleQuote.<q> tags properly.htmlTag for fewer false positives. A tag must start with < followed by !,?, /, or a letter. This makes it more useful in the wikimedia and markdown parsers.DocBook reader: Support title in “figure” element. Closes #650.
MediaWiki writer:
<br/> in translation of LineBreak There’s no particular need for a newline (other than making the generated MediaWiki source look nice to a human), and in fact sometimes it is incorrect: in particular, inside an enumeration, list items cannot have embedded newline characters. (Brent Yorgey)<code> not <tt> for Code.Man writer: Escape - as \-. Unescaped -’s become hyphens, while \-’s are left as ascii minus signs. That is preferable for use with command-line options. See http://lintian.debian.org/tags/hyphen-used-as-minus-sign.html. Thanks to Andrea Bolognani for bringing the issue to our attention.
RST writer:
:target: field when you have a simple linked image.:align: center to figures.Texinfo writer: Fixed internal cross-references. Now we insert anchors after each header, and use @ref instead of @uref for links. Commas are now escaped as @comma{} only when needed; previously all commas were escaped. (This change is needed, in part, because @ref commands must be followed by a real comma or period.) Also insert a blank line in from of @verbatim environments.
DocBook writer:
LaTeX writer:
\hspace* for nonbreaking space after line break, since ~ spaces after a line break are just ignored. Closes #687._ in URLs or hyperref identifiers.\url{}. Closes #576.[fragile] only for slides containing code rendered using listings. Closes #649.| as \vert in LaTeX math. This avoids a clash with highlighting-kate’s macros, which redefine | as a short verbatim delimiter. Thanks to Björn Peemöller for raising this issue.HTML writer:
highlighting-css for code spans, too. Previously it was only included if used in a code block. Closes #653.<dd> tags. We now put a newline between </dd> and <dd> when there are multiple definitions.--self-contained.) See #609.EPUB writer:
--number-sections now works properly.ODT writer: properly set title property (Arlo O’Keeffe).
Docx writer:
Fixed bug with nested lists. Previously a list like
1. one
- a
- b
2. twowould come out with a bullet instead of “2.” Thanks to Russell Allen for reporting the bug.
Use w:cr in w:r instead of w:br for linebreaks. This seems to fix a problem viewing pandoc-generated docx files in LibreOffice.
Use integer ids for bookmarks. Closes #626.
Added nsid to abstractNum elements. This helps when merging word documents with numbered or bulleted lists. Closes #627.
Use separate footnotes.xml for notes. This seems to help LibreOffice convert the file, even though it was valid docx before. Closes #637.
Use rIdNN identifiers for r:embed in images.
Avoid reading image files again when we’ve already processed them.
Fixed typo in referenc.docx that prevented image captions from working. Thanks to Huashan Chen.
Text.Pandoc.Parsing:
withRaw, which didn’t correctly handle the case where nothing is parsed.emailAddress parser more correct. Now it is based on RFC 822, though it still doesn’t implement quoted strings in email addresses.'s', 'l', etc. parse properly. Formerly we had some English-centric heuristics, but they are no longer needed. Closes #698.Text.Pandoc.Pretty: Added wide punctuation range to charWidth. This fixes bug with Chinese commas in markdown and reST tables, and a bug that caused combining characters to be dropped.
Text.Pandoc.MIME: Added MIME types for .wof and .eot. Closes #640.
Text.Pandoc.Biblio:
mvPunc and deNote on metadata too. This fixed a bug with notes on titles using footnote styles.pandoc.hs: Give correct value to writerSourceDirectory when a URL is provided. It should be the URL up to the path.
Fixed/simplified diff output for tests. Biblio: Make sure mvPunc and deNote run on metadata too. This fixed a bug with notes on titles using footnote styles.
We no longer depend on utf8-string. Instead we use functions defined in Text.Pandoc.UTF8 that use Data.Text’s conversions.
Use safeRead instead of using reads directly (various modules).
“Implicit figures” (images alone in a paragraph) are now handled differently. The markdown reader gives their titles the prefix fig:; the writers look for this before treating the image as a figure. Though this is a bit of a hack, it has two advantages: (i) implicit figures can be limited to the markdown reader, and (ii) they can be deactivated by turning off the implicit_figures extension.
catch from Control.Exception is now used instead of the old Preface catch.
Text.Pandoc.Shared: Improved algorithm for normalizeSpaces and oneOfStrings (which is now non-backtracking).
Text.Pandoc.Biblio: Remove workaround for toCapital. Now citeproc-hs is fixed upstream, so this is no longer needed. Closes #531.
Textile reader: Improved speed of hyphenedWords. This speeds up the textile reader by about a factor of 4.
Use Text.Pandoc.Builder in RST reader, for more flexibility, better performance, and automatic normalization.
Major rewrite of markdown reader:
Text.Pandoc.Builder instead of lists. This also means that everything is normalized automatically.In HTML writer, we now use toHtml instead of pre-escaping. We work around the problem that blaze-html unnecessarily escapes ' by pre-escaping just the ' characters, instead of the whole string. If blaze-html later stops escaping ' characters, we can simplify strToHtml to toHtml. Closes #629.
Moved code for embedding images in RTFs from pandoc.hs to the RTF writer (which now exports writeRTFWithEmbeddedImages).
Moved citation processing from pandoc.hs into the readers. This makes things more convenient for library users.
The man pages are now built by an executable make-pandoc-man-pages, which has its own stanza in the cabal file so that dependencies can be handled by Cabal. Special treatment in Setup.hs ensures that this executable never gets installed; it is only used to create the man pages.
The cabal file has been modified so that the pandoc library is used in building the pandoc executable. (This required moving pandoc.hs from src to ..) This cuts compile time in half.
The executable and library flags have been removed.
-threaded has been removed from ghc-options.
Version bounds of dependencies have been raised, and the blaze_html_0_5 flag now defaults to True. Pandoc now compiles on GHC 7.6.
We now require base >= 4.2.
Integrated the benchmark program into cabal. One can now do:
cabal configure --enable-benchmarks && cabal build
cabal bench --benchmark-option='markdown' --benchmark-option='-s 20'The benchmark now uses README + testsuite, so benchmark results from older versions aren’t comparable.
Integrated test suite with cabal. To run tests, configure with --enable-tests, then cabal test. You can specify particular tests using --test-options='-t markdown'. No output is shown unless tests fail. The Haskell test modules have been moved from src/ to tests/.
Moved all data files and templates to the data/ subdirectory.
Added an embed_data_files cabal flag. This causes all data files to be embedded in the binary, so that the binary is self-sufficient and can be relocated anywhere, copied on a USB key, etc. The Windows installer now uses this. (Since we no longer have the option to build the executable without the library, this is the only way to get a relocatable binary on Windows.)
Removed pcre3.dll from windows package. It isn’t needed unless highlighting-kate is compiled with the pcre-light flag. By default, regex-prce-builtin is used.
Removed tests flag and made test suite into a proper cabal test suite, which can now be enabled using --enable-tests and run with cabal test.
Moved man page creation out of Setup.hs and into an executable built by Cabal, but never installed. This allows dependencies to be specified, and solves a problem with 1.9.4.3, which could only be installed if data-default had already been installed.
Updated lhs-latex.tex test for latest highlighting-kate representation of backticks.
Removed -threaded from default compile flags.
Modified modules to compile with GHC 7.6 and latest version of time package.
Don’t encode/decode file paths if base >= 4.4. Prior to base 4.4, filepaths and command line arguments were treated as unencoded lists of bytes, not unicode strings, so we had to work around that by encoding and decoding them. This commit adds CPP checks for the base version that intelligibly enable encoding/decoding when needed. Fixes a bug with multilingual filenames when pandoc was compiled with ghc 7.4 (#540).
Don’t generate an empty H1 after hrule slide breaks. We now use a slide-level header with contents [Str "\0"] to mark an hrule break. This avoids creation of an empty H1 in these contexts. Closes #484.
Docbook reader: Added support for “bold” emphasis. Thanks to mb21.
In make_osx_package.sh, ensure citeproc-hs is built with the embed_data_files flag.
MediaWiki writer: Avoid extra blank lines after sublists (Gavin Beatty).
ConTeXt writer: Don’t escape &, ^, <, >, _, simplified escapes for } and { to \{ and \} (Aditya Mahajan).
Fixed handling of absolute URLs in CSS imports with --self-contained. Closes #535.
Added webm to mime types. Closes #543.
Added some missing exports and tests to the cabal file (Alexander V Vershilov).
Compile with -rtsopts and -threaded by default.
Markdown reader: Added cf. and cp. to list of likely abbreviations.
LaTeX template: Added linkcolor, urlcolor and links-as-notes variables. Make TOC links black.
LaTeX template improvements.
Biblio:
@item1 [50]. Motivation: @item1 [50] should be as close as possible to [@item1, 50].Fixed documentation on mixed lists. Closes #533.
Simplified Text.Pandoc.Biblio and fixed bugs with citations inside footnotes and captions. We now handle note citations by inserting footnotes during initial citation processing, and doing a separate pass later to remove notes inside notes.
Added ‘zenburn’ highlight style from highlighting-kate.
Added Slideous writer. Slideous is an HTML + javascript slide show format, similar to Slidy, but works with IE 7. (Jonas Smedegaard)
LaTeX writer:
Beamer writer: When --incremental is used, lists inside a block quote should appear all at once. (This makes Beamer output consistent with the HTML slide show formats.)
ConTeXt writer:
% as \letterpercent{} not \letterpercent, to avoid gobbling spaces after the % sign.\stopformula.Markdown writer:
: form instead of ~ in definition lists, for better compatibility with other markdown implementations.Org writer: Add space before language name. Closes #523.
Docx writer: Simplified bullet characters so they work properly with Word 2007. Closes #520.
LaTeX reader: Support \centerline.
RST reader: handle figures. Closes #522.
Textile reader: fix for <notextile> and ==. Closes #517. (Paul Rivier)
Added docbook reader (with contributions from Mauro Bieg).
Fixed bug in fromEntities. The previous version would turn hi & low you know; into hi &.
HTML reader:
would be rendered as an empty paragraph. Thanks to Paul Vorbach for pointing out the bug.<col> and <caption> in tables. Closes #486.Markdown reader:
LaTeX reader:
\bgroup, \egroup, \begingroup, \endgroup.\begingroup was parsed as \begin followed by group.\parindent0pt\label and \ref sensitive to --parse-raw. If --parse-raw is selected, these will be parsed as raw latex inlines, rather than bracketed text.\vspace{10pt}) inside \author; just skip them. Closes #505.Textile reader:
== and <notextile>. Closes #473.Docx writer: Fixed multi-paragraph list items. Previously they each got a list marker. Closes #457.
LaTeX writer:
--no-tex-ligatures option to avoid replacing quotation marks and dashes with TeX ligatures.fixltx2e package to provide \textsubscript.ConTeXt writer: Fixed escaping of %. In text, % needs to be escaped as \letterpercent, not \% Inside URLs, % needs to be escaped as \% Thanks to jmarca and adityam for the fix. Closes #492.
Texinfo writer: Escape special characters in node titles. This fixes a problem pointed out by Joost Kremers. Pandoc used to escape an ‘@’ in a chapter title, but not in the corresponding node title, leading to invalid texinfo.
Fixed document encoding in texinfo template. Resolves Debian Bug #667816.
Markdown writer:
< and $.LaTeX writer: Use \hyperref[ident]{text} for internal links. Previously we used \href{\#ident}{text}, which didn’t work on all systems. Thanks to Dirk Laurie.
RST writer: Don’t wrap link references. Closes #487.
Updated to use latest versions of blaze-html, mtl.
LaTeX reader:
lstlisting work as a proper verbatim environment.LaTeX writer:
{} around ctable caption, so that formatting can be used.LaTeX template: Added variables for geometry, romanfont, sansfont, mathfont, mainfont so users can more easily customize fonts.
PDF writer:
Texinfo writer: retain directories in image paths. (Peter Wang)
RST writer: Better handling of inline formatting, in accord with docutils’ “inline markup recognition rules” (though we don’t implement the unicode rules fully). Now hi*there*hi gets rendered properly as hi\ *there*\ hi, and unnecessary \ are avoided around :math:, :sub:, :sup:.
RST reader:
\ as null, not escaped space.:math:`...` even when not followed by blank or \. This does not implement the complex rule docutils follows, but it should be good enough for most purposes.Text.Pandoc.Parsing: Added stateRstDefaultRole field to ParserState. (Greg Maslov)
Markdown reader: Properly handle citations nested in other inline elements.
Markdown writer: don’t replace empty alt in image with “image”.
DZSlides: Updated template.html and styles in default template. Removed bizarre CSS for q in dzslides template.
Avoid repeated id attribute in section and header in HTML slides.
README improvements: new instructions on internal links, removed misleading note on reST math.
Build system:
Added beamer+lhs as output format.
Don’t escape < in <style> tags with --self-contained. This fixes a bug which prevented highlighting from working when using --self-contained.
PDF: run latex engine three times if --toc specified. This fixes page numbers in the table of contents.
Docx writer: Added TableNormal style to tables.
LaTeX math environment fixes. aligned is now used instead of the nonexistent aligned*. multline instead of the nonexistent multiline.
LaTeX writer: Use \textasciitilde for literal ~.
HTML writer: Don’t escape contents of EQ tags with –gladtex. This fixes a regression from 1.8.
Use <q> tags for Quoted items for HTML5 output. The quote style can be changed by modifying the template or including a css file. A default quote style is included.
LaTeX reader: Fixed accents (~{a}, \c{c}). Correctly handle ^{}. Support “minted” as a LaTeX verbatim block.
Updated LaTeX template for better language support. Use polyglossia instead of babel with xetex. Set lang as documentclass option. \setmainlanguage will use the last of a comma-separated list of languages. Thanks to François Gannaz.
Fixed default LaTeX template so \euro and € work. The eurosym package is needed if you are using pdflatex.
Fixed escaping of period in man writer (thanks to Michael Thompson).
Fixed list label positions in beamer.
Set mainlang variable in context writer. This parallels behavior of latex writer. mainlang is the last of a comma-separated list of languages in lang.
EPUB language metadat: convert e.g. en_US from locale to en-US.
Changed -V so that you can specify a key without a value. Such keys get the value true.
Fixed permissions on installed man pages - thanks Magnus Therning.
Windows installer: require XP or higher. The installer is now compiled on a Windows 7 machine, which fixes a problem using citation functions on Windows 7.
OSX package: Check for 64-bit Intel CPU before installing.
Better handling of raw latex environments in markdown. Now
\begin{equation}
a_1
\end{equation}turns into a raw latex block as expected.
Improvements to LaTeX reader:
{\\} in braced., to suffix if it doesn’t start with space or punctuation. Otherwise we get no space between the year and the suffix in author-date styles.Added two needed data files for S5. This fixes a problem with pandoc -t s5 --self-contained. Also removed slides.min.js, which was no longer being used.
Fixed some minor problems in reference.docx: name on “Date” style, xCs instead of xIs.
Fixed a problem creating docx files using a reference docx modified using Word. The problem seems to be that Word modifies _rels/.rels, changing the Type of the Relationship to docProps/core.xml. Pandoc now changes this back to the correct value if it has been altered, fixing the problem.
Fixed html5 template so it works properly with highlighting.
LaTeX reader:
Markdown reader:
a**a*a**a*a**a*a**a*a**a*a**a*a**a*a**.Headers no longer wrap in markdown or RST writers.
Added stateMaxNestingLevel to ParserState. We set this to 6, so you can still have Emph inside Emph, just not indefinitely.
More efficient implementation of nowrap in Text.Pandoc.Pretty.
Text.Pandoc.PDF: Only run latex twice if \tableofcontents is present.
Require highlighting-kate >= 0.5.0.2, texmath >= 0.6.0.2.
Changed cabal file so that build-depends for the test program are not required unless the tests flag is used.
LaTeX writer: insert {} between adjacent hyphens so they don’t form ligatures (dashes) in code spans.
Raised version bound on test-framework to avoid problems compiling tests on GHC 7.4.1.
LaTeX reader: Use raw LaTeX as fallback inline text for Cites, so citations don’t just disappear unless you process with citeproc. Ignore \bibliographystyle, \nocite.
Simplified tex2pdf; it will always run latex twice to resolve table of contents and hyperrefs.
Require Cabal >= 1.10.
Tweaked cabal file to meet Cabal 1.10 requirements.
Added a Microsoft Word docx writer. The writer includes support for highlighted code and for math (which is converted from TeX to OMML, Office’s native math markup language, using texmath’s new OMML module). A new option --reference-docx allows the user to customize the styles.
Added an asciidoc writer (http://www.methods.co.nz/asciidoc/).
Better support for slide shows:
Added a dzslides writer. DZSlides is a lightweight HTML5/javascript slide show format due to Paul Rouget (http://paulrouget.com/dzslides/).
Added a LaTeX beamer writer. Beamer is a LaTeX package for creating slide presentations.
New, flexible rules for dividing documents into sections and slides (see the “Structuring the slide show” in the User’s Guide). These are backward-compatible with the old rules, but they allow slide shows to be organized into sections and subsections containing multiple slides.
A new --slide-level option allows users to override defaults and select a slide level below the first header level with content.
A new --self-contained option produces HTML output that does not depend on an internet connection or the presence of any external files. Linked images, CSS, and javascript is downloaded (or fetched locally) and encoded in data: URIs. This is useful for making portable HTML slide shows. The --offline option has been deprecated and is now treated as a synonym or --self-contained.
Support for PDF output:
markdown2pdf.pandoc can now create PDFs (assuming you have latex and a set of appropriate packages installed): just specify an output file with the .pdf extension.--latex-engine allows you to specify pdflatex, xelatex, or lualatex as the processor.Highlighting changes:
highlighting flag is no longer needed when compiling.--no-highlight option allows highlighting to be disabled.docx, latex, and epub, as well as html, html5, dzslides, s5, and slidy.--highlight-style option selects between various highlighting color themes.Internal links to sections now work in ConTeXt and LaTeX as well as HTML.
LaTeX \include and \usepackage commands are now processed, provided the files are in the working directory.
EPUB improvements:
--epub-embed-font option.epub-page.html, epub-coverimage.html, epub-titlepage.html.--mathml now works with DocBook.
Added support for math in RST reader and writer. Inline math uses the :math:`...` construct. Display math uses
.. math:: ...or if the math is multiline,
.. math::
...These constructions are now supported now by rst2latex.py.
Github syntax for fenced code blocks is supported in pandoc’s markdown. You can now write
```ruby
x = 2
```instead of
~~~ {.ruby}
x = 2
~~~~Easier scripting: a new toJsonFilter function makes it easier to write Haskell scripts to manipulate the Pandoc AST. See Scripting with pandoc.
Fixed parsing of consecutive lists in markdown. Pandoc previously behaved like Markdown.pl for consecutive lists of different styles. Thus, the following would be parsed as a single ordered list, rather than an ordered list followed by an unordered list:
1. one
2. two
- one
- twoThis change makes pandoc behave more sensibly, parsing this as two lists. Any change in list type (ordered/unordered) or in list number style will trigger a new list. Thus, the following will also be parsed as two lists:
1. one
2. two
a. one
b. twoSince we regard this as a bug in Markdown.pl, and not something anyone would ever rely on, we do not preserve the old behavior even when --strict is selected.
Dashes work differently with --smart: --- is always em-dash, and -- is always en-dash. Pandoc no longer tries to guess when - should be en-dash. Note: This may change how existing documents look when processed with pandoc. A new option, --old-dashes, is provided for legacy documents.
The markdown writer now uses setext headers for levels 1-2. The old behavior (ATX headers for all levels) can be restored using the new --atx-headers option.
Links are now allowed in markdown image captions. They are also allowed in links, but will appear there as regular text. So,
[link with [link](/url)](/url)will turn into
<p><a href="/url">link with link</a></p>Improved handling of citations using citeproc-hs-0.3.4. Added --citation-abbreviations option.
Citation keys can no longer end with a punctuation character. This means that @item1. will be parsed as a citation with key ‘item1’, followed by a period, instead of a citation with key ‘item1.’, as was the case previously.
In HTML output, citations are now put in a span with class citation.
The markdown reader now recognizes DocBook block and inline tags. It was always possible to include raw DocBook tags in a markdown document, but now pandoc will be able to distinguish block from inline tags and behave accordingly. Thus, for example,
<sidebar>
hello
</sidebar>will not be wrapped in <para> tags.
The LaTeX parser has been completely rewritten; it is now much more accurate, robust, and extensible. However, there are two important changes in how it treats unknown LaTeX. (1) Previously, unknown environments became BlockQuote elements; now, they are treated as “transparent”, so \begin{unknown}xyz\end{unknown} is the same as xyz. (2) Previously, arguments of unknown commands were passed through with their braces; now the braces are stripped off.
--smart is no longer selected automatically with man output.
The deprecated --xetex option has been removed.
The --html5/-5 option has been deprecated. Use -t html5 instead. html5 and html5+lhs are now separate output formats.
Single quotes are no longer escaped in HTML output. They do not need to be escaped outside of attributes.
Pandoc will no longer transform leading newlines in code blocks to <br/> tags.
The ODT writer now sizes images appropriately, using the image size and DPI information embedded in the image.
--standalone is once again implicitly for a non-text output format (ODT, EPUB). You can again do pandoc test.txt -o test.odt and get a standalone ODT file.
The Docbook writer now uses <sect1>, <sect2>, etc. instead of <section>.
The HTML writer now uses <del> for strikeout.
In HTML output with --section-divs, the classes section and level[1,2,..6] are put on the div tags so they can be styled. In HTML 5 output with --section-divs, the classes level[1,2,...6] are put on section tags.
EPUB writer changes:
lang variable now sets the language in the metadata (if it is not set, we default to the locale).Added titleslide class to title slide in S5 template.
In HTML, EPUB, and docx metadata, the date is normalized into YYYY-MM-DD format if possible. (This is required for validation.)
Attributes in highlighted code blocks are now preserved in HTML. The container element will have the classes, id, and key-value attributes you specified in the delimited code block. Previously these were stripped off.
The reference backlink in the HTML writer no longer has a special footnoteBacklink class.
The HTML template has been split into html and html5 templates.
Author and date are treated more consistently in HTML templates. Authors are now <h2>, date <h3>.
URLs are hyphenated in the ConTeXt writer (B. Scott Michel).
In Text.Pandoc.Builder, +++ has been replaced by <>.
Better support for combining characters and East Asian wide characters in markdown and reST.
Better handling of single quotes with --smart. Previously D'oh l'*aide* would be parsed with left and right single quotes instead of apostrophes. This kind of error is now fixed.
Highlighting: Use reads instead of read for better error handling. Fixes crash on startNum="abc".
Added blank comment after directives in rst template.
Unescape entities in citation refId. The refIds coming from citeproc contain XML numeric entities, and these don’t match with the citation keys parsed by pandoc. Solution is to unescape them.
HTML reader: Fixed bug parsing tables with both thead and tbody.
Markdown reader:
RST reader: allow footnotes followed by newline without space characters.
LaTeX reader:
\@.\itemsep.RST writer: Fixed bug involving empty table cells. isSimple was being calculated in a way that assumed there were no non-empty cells.
ConTeXt writer:
--toc work even without --number-sections.LaTeX writer:
~ inside \href{...}.# in href URLs.documentclass variable, and if that is not set, we look through the template itself. Also, we have added the KOMA classes scrreprt and scrbook. You can now make a book using pandoc -V documentclass:book mybook.txt -o mybook.pdfcode environment will be included in the template.hyperref settings in the template).lang variable to LaTeX template.HTML writer:
<section> for footnotes if HTML5.S5/slidy writer: Make footnotes appear on separate slide at end.
MIME: Added ‘layout-cache’ to getMimeType. This ensures that the META-INF/manifest.xml for ODT files will have everything it needs, so that ODT files modified by LibreOffice can be used as --reference-odt.
Text.Pandoc.Templates: Return empty string for json template.
Text.Pandoc.Biblio:
\160 as space when parsing locator and suffix. This fixes a bug with “p. 33” when --smart is used. Previously the whole “p. 33” would be included in the suffix, with no locator.Updated chicago-author-date.csl. The old version did not work properly for edited volumes with no author.
EPUB writer:
cover-image.jpg.Modified make_osx_package.sh to use cabal-dev. Items are no longer installed as root. Man pages are zipped and given proper permissions.
Modified windows installer generator to use cabal-dev.
Setup: Making man pages now works with cabal-dev (at least on OSX). In Setup.hs we now invoke ‘runghc’ in a way that points it to the correct package databases, instead of always falling back to the default user package db.
Updated to work with GHC 7.4.1.
Removed dependency on old-time.
Removed dependency on dlist.
New slidy directory for “self-contained.”
TeXMath writer: Use unicode thin spaces for thin spaces.
Markdown citations: don’t strip off initial space in locator.
Removed Apostrophe, EmDash, EnDash, and Ellipses from the native Inline type in pandoc-types. Now we use Str elements with unicode.
Improvements to Text.Pandoc.Builder:
Inlines and Blocks are now newtypes (not synonyms for sequences).IsString, Show, Read, Monoid, and a new Listable class, which allows these to be manipulated to some extent like lists. Monoid append includes automatic normalization.+++ has been replaced by <> (mappend).Use blaze-html instead of xhtml for HTML generation. This changes the type of writeHtml.
Text.Pandoc.Shared:
warn and err.unescapeURI, modified escapeURI. (See under behavior changes, above.)Changes in URI escaping: Previously the readers escaped URIs by converting unicode characters to octets and then percent encoding. Now unicode characters are left as they are, and escapeURI only percent-encodes space characters. This gives more readable URIs, and works well with modern user agents. URIs are no longer unescaped at all on conversion to markdown, asciidoc, rst, org.
New module Text.Pandoc.SelfContained.
New module Text.Pandoc.Docx.
New module Text.Pandoc.PDF.
Added writerBeamer to WriterOptions.
Added normalizeDate to Text.Pandoc.Shared.
Added splitStringWithIndices in Text.Pandoc.Shared. This is like splitWithIndices, but it is sensitive to distinctions between wide, combining, and regular characters.
Text.Pandoc.Pretty:
chomp combinator.beforeNonBreak combinator. This allows you to include something conditionally on it being before a nonblank. Used for RST inline math.charWidth function. All characters marked W or F in the unicode spec EastAsianWidth.txt get width 2.realLength, based on charWidth. realLength is now used in calculating offsets.New module Text.Pandoc.Slides, for common functions for breaking a document into slides.
Removed Text.Pandoc.S5, which is no longer needed.
Removed Text.Pandoc.CharacterReferences. Moved characterReference to Text.Pandoc.Parsing. decodeCharacterReferences is replaced by fromEntities in Text.Pandoc.XML.
Added Text.Pandoc.ImageSize. This is intened for use in docx and odt writers, so the size and dpi of images can be calculated.
Removed writerAscii in WriterOptions.
Added writerHighlight to WriterOptions.
Added DZSlides to HTMLSlideVariant.
writeEPUB has a new argument for font files to embed.
Added stateLastStrPos to ParserState. This lets us keep track of whether we’re parsing the position immediately after a regular (non-space, non-symbol) string, which is useful for distinguishing apostrophes from single quote starts.
Text.Pandoc.Parsing:
escaped now returns a Char.charsInBalanced', added a character parser as a parameter of charsInBalanced. This is needed for proper handling of escapes, etc.withRaw.Added toEntities to Text.Pandoc.XML.
Text.Pandoc.Readers.LaTeX:
handleIncludes.rawLaTeXBlock instead of rawLaTeXEnvironment'.Added ToJsonFilter class and toJsonFilter function to Text.Pandoc, deprecating the old jsonFilter function.
Text.Pandoc.Highlighting:
highlightHtml, defaultHighlightingCss.formatLaTeXInline, formatLaTeXBlock, and highlight, plus key functions from highlighting-kate.highlight returns a Maybe, not an Either.Adjusted Arbitrary instance to help avoid timeouts in tests.
Added Tests.Writers.Markdown to cabal file.
Relaxed version bounds on pandoc-types, test-framework.
Added script to produce OS X package.
Made templates directory a git submodule. This should make it easier for people to revise their custom templates when the default templates change.
Changed template naming scheme: FORMAT.template -> default.FORMAT. Note: If you have existing templates in ~/.pandoc/templates, you must rename them to conform to the new scheme!
Default template improvements:
s5-url and slidy-url variables, instead of hard-coding. If you want to put your slidy files in the slidy subdirectory, for example, you can do pandoc -t slidy -V slidy-url=slidy -s.\and to separate authors in LaTeX documents (reader & writer). Closes #279.\emergencystretch to prevent overfull lines.hyperref options for xetex, fixing problems with unicode bookmarks (thanks to CircleCode).ucs package, use utf8 rather than utf8x with inputenc. This covers fewer characters but is more robust with other packages, and ucs is unmaintained. Users who need better unicode support should use xelatex or lualatex.If a template specified with --template is not found, look for it in datadir. Also, if no extension is provided, supply one based on the writer. So now you can put your special.latex template in ~/.pandoc/templates, and use it from any directory via pandoc -t latex --template special.
Added nonspaceChar to Text.Pandoc.Parsing.
Fixed smart quotes bug, now handling '...hi' properly.
RST reader:
simpleReferenceName parser.HTML reader:
LaTeX reader: Handle \subtitle command (a subtitle is added to the title, after a colon and linebreak). Closes #280.
Leaner reference.odt.
Added unexported module Text.Pandoc.MIME for use in the ODT writer.
ODT writer: Construct manifest.xml based on archive contents. This fixes a bug in ODTs containing images. Recent versions of LibreOffice would reject these as corrupt, because manifest.xml did not contain a reference to the image files.
LaTeX writer:
\texttt and escapes insntead of \verb!...!, which is too fragile (doesn’t work in command arguments).\enquote{} for quotes if the template includes the csquotes package. This provides better support for local quoting styles. (Thanks to Andreas Wagner for the idea.)ConTeXt writer: Make \starttyping/\stoptyping flush with margin, preventing spurious blank lines.
Slidy writer:
slidy.css with --offline option, so users can more easily edit it.S5 writer:
s5/default/slides.js.{comment,packed} with new compressed s5/default/slides.min.js.data: protocol to embed S5 CSS in <link> tags, when --offline is specified. Using inline CSS didn’t work with Chrome or Safari. This fixes offline S5 on those browsers.HTML writer: Removed English title on footnote backlinks. This is incongrous in non-English documents.
Docbook writer:
programlisting tags (instead of screen) for code blocks.markdown2pdf:
-halt-on-error -interaction nonstopmode instead of -interaction=batchmode, which essentially just ignored errors, leading to bad results. Better to know when something is wrong.pdflatex.--mathjax now takes an optional URL argument. If it is not provided, pandoc links directly to the (secure) mathjax CDN, as now recommended (thanks to dsanson).
Deprecated --xetex option in pandoc. It is no longer needed, since the LaTeX writer now produces a file that can be processed by latex, pdflatex, lualatex, or xelatex.
Introduced --luatex option to markdown2pdf. This causes lualatex to be used to create the PDF.
Added --epub-cover-image option.
Documented --biblatex and --natbib options.
Allow --section-divs with slidy output. Resolves Issue #296.
Disallow notes within notes in reST and markdown. These previously caused infinite looping and stack overflows. For example:
[^1]
[^1]: See [^1]Note references are allowed in reST notes, so this isn’t a full implementation of reST. That can come later. For now we need to prevent the stack overflows. Partially resolves Issue #297.
EPUB writer: Allow non-plain math methods.
Forbid ()s in citation item keys. Resolves Issue #304: problems with (@item1; @item2) because the final paren was being parsed as part of the item key.
Changed URI parser so it doesn’t include trailing punctuation. So, in RST, http://google.com. should be parsed as a link followed by a period. The parser is smart enough to recognize balanced parentheses, as often occur in wikipedia links: http://foo.bar/baz_(bam).
Markdown+lhs reader: Require space after inverse bird tracks, so that HTML tags can be used freely at the left margin of a markdown+lhs document. Thanks to Conal Elliot for the suggestion.
Markdown reader: Fixed bug in footnote order (reported by CircleCode).
RST reader:
specialChars, so (http://google.com) will be parsed as a link in parens. Resolves Issue #291.| followed by newline in RST line block.LaTeX reader:
\dots.\\[10pt].Textile reader:
HTML reader:
<b>, <emph>, etc.Paras instead of Plains in some contexts.OpenDocument writer: Use special First paragraph style for first paragraph after most non-paragraph blocks. This allows users to specify e.g. that only paragraphs after the first paragraph of a block are to be indented. Thanks to Andrea Rossato for the patch. Closes #20.
LaTeX writer: use deVerb on table and picture captions. Otherwise LaTeX complains about \verb inside command argument. Thanks to bbanier for reporting the bug.
Markdown writer: Insert HTML comment btw list and indented code block. This prevents the code block from being interpreted as part of the list.
EPUB writer: Add a meta element specify the cover. Some EPUB e-readers, such as the Nook, require a meta element inside the OPF metadata block to ensure the cover image is properly displayed. (Kelsey Hightower)
HTML writer: Use embed tag for images with non-image extensions. (e.g. PDFs). Closes #264.
LaTeX writer: Improved tables.
Un-URI-escape image filenames in LaTeX, ConTeXt, RTF, Texinfo. Also do this when copying image files into EPUBs and ODTs. Closes #263.
Changed to github issue tracker.
Added failing emph/strong markdown test case due to Perry Wagle.
Slidy improvements:
duration variable in template. Setting this activates the timer.markdown2pdf: Removed some debugging lines accidentally included in the 1.8.1 release. With those lines, the temp directory is created in the working directory, and it is not deleted. This fix restores the original behavior.Added --ascii option. Currently supported only in HTML writer, which it causes to use numerical entities instead of UTF-8.
EPUB writer: --toc now works to provide a table of contents at the beginning of each chapter.
LaTeX writer: Change figure defaults to htbp. This prevents “too many unprocessed floats.” Resolves Issue #285.
Text.Pandoc.UTF8: Encode filenames even when using recent base.
markdown2pdf: Fixed filename encoding issues. With help from Paulo Tanimoto. Resolves Issue #286.
HTML writer: Put line breaks in section divs.
Text.Pandoc.Shared: Make writerSectionDivs default to False.
HTML writer:
Markdown reader: Fixed bug in footnote block parser (pointed out by Jesse Rosenthal). The problem arose when the blank line at the end of a footnote block contained indenting spaces.
Shared: Improved ‘normalize’ function so it normalizes Spaces too. In normal form, Space elements only occur to separate two non-Space elements. So, we never have [Space], or [, …, Space].
Tests:
README:
markdown2pdf: Fixed bug with output file extensions. Previously markdown2pdf test.txt -o test.en.pdf would produce test.pdf, not test.en.pdf. Thanks to Paolo Tanimoto for the fix.
Revised Interact.hs so that it works with the CPP macros in the UTF8 module.
Revised Setup.hs so that we don’t call MakeManPage.hs unless the man pages are out of date.
Support for citations using Andrea Rossato’s citeproc-hs 0.3. You can now write, for example,
Water is wet [see @doe99, pp. 33-35; also @smith04, ch. 1].and, when you process your document using pandoc, specifying a citation style using --csl and a bibliography using --bibliography, the citation will be replaced by an appropriately formatted citation, and a list of works cited will be added to the end of the document.
This means that you can switch effortlessly between different citation and bibliography styles, including footnote, numerical, and author-date formats. The bibliography can be in any of the following formats: MODS, BibTeX, BibLaTeX, RIS, EndNote, EndNote XML, ISI, MEDLINE, Copac, or JSON. See the README for further details.
Citations are supported in the markdown reader, using a special syntax, and in the LaTeX reader, using natbib or biblatex syntax. (Thanks to Nathan Gass for the natbib and biblatex support.)
New textile reader and writer. Thanks to Paul Rivier for contributing the textile reader, an almost complete implementation of the textile syntax used by the ruby RedCloth library. Resolves Issue #51.
New org writer, for Emacs Org-mode, contributed by Puneeth Chaganti.
New json reader and writer, for reading and writing a JSON representation of the native Pandoc AST. These are much faster than the native reader and writer, and should be used for serializing Pandoc to text. To convert between the JSON representation and native Pandoc, use encodeJSON and decodeJSON from Text.JSON.Generic.
A new jsonFilter function in Text.Pandoc makes it easy to write scripts that transform a JSON-encoded pandoc document. For example:
-- removelinks.hs - removes links from document
import Text.Pandoc
main = interact $ jsonFilter $ bottomUp removeLink
where removeLink (Link xs _) = Emph xs
removeLink x = xTo use this to remove links while translating markdown to LaTeX:
pandoc -t json | runghc removelinks.hs | pandoc -f json -t latexAttributes are now allowed in inline Code elements, for example:
In this code, `ulist ! [theclass "special"] << elts`{.haskell} is...The attribute syntax is the same as for delimited code blocks. Code inline has an extra argument place for attributes, just like CodeBlock. Inline code will be highlighted in HTML output, if pandoc is compiled with highlighting support. Resolves Issue #119.
New RawBlock and RawInline elements (replacing RawHtml, HtmlInline, and TeX) provide lots of flexibility in writing scripts to transform Pandoc documents. Scripts can now change how each element is rendered in each output format.
You can now define LaTeX macros in markdown documents, and pandoc will apply them to TeX math. For example,
\newcommand{\plus}[2]{#1 + #2}
$\plus{3}{4}$yields 3+4. Since the macros are applied in the reader, they will work in every output format, not just LaTeX.
LaTeX macros can also be used in LaTeX documents (both in math and in non-math contexts).
A new --mathjax option has been added for displaying math in HTML using MathJax. Resolves issue #259.
Footnotes are now supported in the RST reader. (Note, however, that unlike docutils, pandoc ignores the numeral or symbol used in the note; footnotes are put in an auto-numbered ordered list.) Resolves Issue #258.
A new --normalize option causes pandoc to normalize the AST before writing the document. This means that, for example, *hi**there* will be rendered as <em>hithere</em> instead of <em>hi</em><em>there</em>. This is not the default, because there is a significant performance penalty.
A new --chapters command-line option causes headers in DocBook, LaTeX, and ConTeXt to start with “chapter” (level one). Resolves Issue #265.
In DocBook output, <chapter> is now used for top-level headers if the template contains <book>. Resolves Issue #265.
A new --listings option in pandoc and markdown2pdf causes the LaTeX writer to use the listings package for code blocks. (Thanks to Josef Svennigsson for the pandoc patch, and Etienne Millon for the markdown2pdf patch.)
markdown2pdf now supports --data-dir.
URLs in autolinks now have class “url” so they can be styled.
Improved prettyprinting in most formats. Lines will be wrapped more evenly and duplicate blank lines avoided.
New --columns command-line option sets the column width for line wrapping and relative width calculations for tables.
Made --smart work in HTML, RST, and Textile readers, as well as markdown.
Added --html5 option for HTML5 output.
Added support for listings package in LaTeX reader (Puneeth Chaganti).
Added support for simple tables in the LaTeX reader.
Added support for simple tables in the HTML reader.
Significant performance improvements in many readers and writers.
Moved Text.Pandoc.Definition from the pandoc package to a new auxiliary package, pandoc-types. This will make it possible for other programs to supply output in Pandoc format, without depending on the whole pandoc package.
Added Attr field to Code.
Removed RawHtml, HtmlInline, and TeX elements; added generic RawBlock and RawInline.
Moved generic functions to Text.Pandoc.Generic. Deprecated processWith, replacing it with two functions, bottomUp and topDown. Removed previously deprecated functions processPandoc and queryPandoc.
Added Text.Pandoc.Builder, for building Pandoc structures.
Text.Pandoc now exports association lists readers and writers.
Added Text.Pandoc.Readers.Native, which exports readNative. readNative can now read full pandoc documents, block lists, blocks, inline lists, or inlines. It will interpret Str "hi" as if it were Pandoc (Meta [] [] []) [Plain [Str "hi"]]. This should make testing easier.
Removed deprecated -C/--custom-header option. Use --template instead.
--biblio-file has been replaced by --bibliography. --biblio-format has been removed; pandoc now guesses the format from the file extension (see README).
pandoc will treat an argument as a URI only if it has an http(s) scheme. Previously pandoc would treat some Windows pathnames beginning with C:/ as URIs.
The --sanitize-html option and the stateSanitize field in ParserState have been removed. Sanitization is better done in the resulting HTML using xss-sanitize, which is based on pandoc’s sanitization, but improved.
pandoc now adds a newline to the end of its output in fragment mode (= not --standalone).
Added support for lang in html tag in the HTML template, so you can do pandoc -s -V lang=es, for example.
highlightHtml in Text.Pandoc.Highlighting now takes a boolean argument that selects between “inline” and “block” HTML.
Text.Pandoc.Writers.RTF now exports rtfEmbedImage. Images are embedded in RTF output when possible (png, jpeg). Resolves Issue #275.
Added Text.Pandoc.Pretty. This is better suited for pandoc than the pretty package. Changed all writers that used Text.PrettyPrint.HughesPJ to use Text.Pandoc.Pretty instead.
Rewrote writeNative using the new prettyprinting module. It is now much faster. The output has been made more consistent and compressed. writeNative is also now sensitive to writerStandalone, and will simplyprint a block list if writerStandalone` is False.
Removed Text.Pandoc.Blocks. Text.Pandoc.Pretty allows you to define blocks and concatenate them, so a separate module is no longer needed.
Text.Pandoc.Shared:
writerColumns, writerChapters, and writerHtml5 to WriterOptions.normalize.wrapped, wrapIfNeeded, wrappedTeX, wrapTeXIfNeeded, hang', BlockWrapper, wrappedBlocksToDoc.splitBy take a test instead of an element.findDataFile, refactored readDataFile.stringify. Rewrote inlineListToIdentifier using stringify.inlineListToIdentifier to treat \160 as ’ ’.Text.Pandoc.Readers.HTML:
rawHtmlBlock, anyHtmlBlockTag, anyHtmlInlineTag, anyHtmlTag, anyHtmlEndTag, htmlEndTag, extractTagType, htmlBlockElement, htmlCommenthtmlTag, htmlInBalanced, isInlineTag, isBlockTag, isTextTagMoved smartPunctuation from Text.Pandoc.Readers.Markdown to Text.Pandoc.Readers.Parsing, and parameterized it with an inline parser.
Ellipses are no longer allowed to contain spaces. Previously we allowed ‘. . .’, ’ . . . ’, etc. This caused too many complications, and removed author’s flexibility in combining ellipses with spaces and periods.
Allow linebreaks in URLs (treat as spaces). Also, a string of consecutive spaces or tabs is now parsed as a single space. If you have multiple spaces in your URL, use %20%20.
Text.Pandoc.Parsing:
refsMatch.Key constructor.Ord and Eq instances for Key.toKey and fromKey to convert between Key and [Inline].readWith.Small change in calculation of relative widths of table columns. If the size of the header > the specified column width, use the header size as 100% for purposes of calculating relative widths of columns.
Markdown writer now uses some pandoc-specific features when --strict is not specified: \ newline is used for a hard linebreak instead of two spaces then a newline. And delimited code blocks are used when there are attributes.
HTML writer: improved gladTeX output by setting ENV appropriately for display or inline math (Jonathan Daugherty).
LaTeX writer: Use \paragraph, \subparagraph for level 4,5 headers.
LaTeX reader:
\label{foo} and \ref{foo} now become {foo} instead of (foo).\index{} commands are skipped.Added fontsize variable to default LaTeX template. This makes it easy to set the font size using markdown2pdf: markdown2pdf -V fontsize=12pt input.txt.
Fixed problem with strikeout in LaTeX headers when using hyperref, by adding a command to the default LaTeX template that disables \sout inside pdf strings. Thanks to Joost Kremers for the fix.
The COLUMNS environment variable no longer has any effect.
Pandoc now compiles with GHC 7. (This alone leads to a significant performance improvement, 15-20%.)
Completely rewrote HTML reader using tagsoup as a lexer. The new reader is faster and more accurate. Unlike the old reader, it does not get bogged down on some input (Issues #277, 255). And it handles namespaces in tags (Issue #274).
Replaced escapeStringAsXML with a faster version.
Rewrote spaceChar and some other parsers in Text.Pandoc.Parsing for a significant performance boost.
Improved performance of all readers by rewriting parsers.
Simplified Text.Pandoc.CharacterReferences by using entity lookup functions from TagSoup.
Text.Pandoc.UTF8 now uses the unicode-aware IO functions from System.IO if base >= 4.2. This gives support for windows line endings on windows.
Remove duplications in documentation by generating the pandoc man page from README, using MakeManPage.hs.
README now includes a full description of markdown syntax, including non-pandoc-specific parts. A new pandoc_markdown man page is extracted from this, so you can look up markdown syntax by doing man pandoc_markdown.
Completely revised test framework (with help from Nathan Gass). The new test framework is built when the tests Cabal flag is set. It includes the old integration tests, but also some new unit and quickcheck tests. Test output has been much improved, and you can now specify a glob pattern after cabal test to indicate which tests should be run; for example cabal test citations will run all the citation tests.
Added a shell script, stripansi.sh, for filtering ANSI control sequences from test output: cabal test | ./stripansi.sh > test.log.
Added Interact.hs to make it easier to use ghci while developing. Interact.hs loads ghci from the src directory, specifying all the options needed to load pandoc modules (including specific package dependencies, which it gets by parsing dist/setup-config).
Added Benchmark.hs, testing all readers + writers using criterion.
Added stats.sh, to make it easier to collect and archive benchmark and lines-of-code stats.
Added upper bounds to all cabal dependencies.
Include man pages in extra-source-files. This allows users to install pandoc from the tarball without needing to build the man pages.
Filenames are encoded as UTF8. Resolves Issue #252.
Handle curly quotes better in --smart mode. Previously, curly quotes were just parsed literally, leading to problems in some output formats. Now they are parsed as Quoted inlines, if --smart is specified. Resolves Issue #270.
Text.Pandoc.Parsing: Fixed bug in grid table parser. Spaces at end of line were not being stripped properly, resulting in unintended LineBreaks.
Markdown reader:
aaa <!-- comment --> bbb can be a single paragraph.^[link](/foo)^ gets recognized as a superscripted link, not an inline note followed by garbage.Mr.) at the end of a line.RST reader:
Para instead of Plain, matching behavior of rst2xml.py.LaTeX reader:
\begin{document} in, say, a verbatim block.\begin or \end and {.\L and \l.LaTeX writer:
\href{..}.\parbox.OpenDocument writer: don’t print raw TeX.
Markdown writer:
Image. URI was getting unescaped twice!LaTeX and ConTeXt: Escape [ and ] as {[} and {]}. This avoids unwanted interpretation as an optional argument.
ConTeXt writer: Fixed problem with inline code. Previously } would be rendered \type{}}. Now we check the string for ‘}’ and ‘{’. If it contains neither, use \type{}; otherwise use \mono{} with an escaped version of the string.
: now allowed in HTML tags. Resolves Issue #274.
New EPUB and HTML Slidy writers. (Issue #122)
All input is assumed to be UTF-8, no matter what the locale and ghc version, and all output is UTF-8. This reverts to pre-1.5 behavior. Also, a BOM, if present, is stripped from the input.
Markdown now supports grid tables, whose cells can contain arbitrary block elements. (Issue #43)
Sequentially numbered example lists in markdown with @ marker.
Markdown table captions can begin with a bare colon and no longer need to include the English word “table.” Also, a caption can now occur either before or after the table. (Issue #227)
New command-line options:
--epub-stylesheet allows you to specify a CSS file that will be used to style your ebook.--epub-metadata allows you to specify metadata for the ebook.--offline causes the generated HTML slideshow to include all needed scripts and stylesheets.--webtex causes TeX math to be converted to images using the Google Charts API (unless a different URL is specified).--section-divs causes div tags to be added around each section in an HTML document. (Issue #230, 239)Default behavior of S5 writer in standalone mode has changed: previously, it would include all needed scripts and stylesheets in the generated HTML; now, only links are included unless the --offline option is used.
Default behavior of HTML writer has changed. Between 1.2 and 1.5, pandoc would enclose sections in div tags with identifiers on the div tags, so that the sections can be manipulated in javascript. This caused undesirable interactions with raw HTML div tags. So, starting with 1.6, the default is to put the identifiers directly on the header tags, and not to include the divs. The --section-divs option selects the 1.2-1.5 behavior.
API changes:
HTMLMathMethod: Added WebTeX, removed MimeTeX.WriterOptions: Added writerUserDataDir, writerSourceDirectory, writerEPUBMetadata fields. Removed writerIncludeBefore, writerIncludeAfter.headerShift to Text.Pandoc.Shared.ParserState from Text.Pandoc.Shared to a new module, Text.Pandoc.Parsing.stateHasChapters to ParserState.HTMLSlideVariant.KeyTable a map instead of an association list.Meta fields (docTitle, docAuthors, docDate).Pandoc, Meta, Inline, and Block have been given Ord instances.Key), with its own Ord instance for case-insensitive comparison.Text.Pandoc.Writers.EPUB.Text.Pandoc.UUID.Text.Pandoc.ODT, added Text.Pandoc.Writers.ODT. Removed saveOpenDocumentAsODT, added writeODT.Text.Pandoc.Writers.Native and writeNative. Removed prettyPandoc.Text.Pandoc.UTF8 for portable UTF8 string IO.Text.Pandoc.Writers.S5 and the writeS5 function. Moved s5Includes to a new module, Text.Pandoc.S5. To write S5, you now use writeHtml with writerSlideVariant set to S5Slides or SlidySlides.Template changes. If you use custom templates, please update them, particularly if you use syntax highlighting with pandoc. The old HTML templates hardcoded highlighting CSS that will no longer work with the most recent version of highlighting-kate.
<body> tag, as documented. (Issue #241)Removed excess newlines at the end of output. Note: because output will not contain an extra newline, you may need to make adjustments if you are inserting pandoc’s output into a template.
In S5 and slidy, horizontal rules now cause a new slide, so you are no longer limited to one slide per section.
Improved handling of code in man writer. Inline code is now monospace, not bold, and code blocks now use .nf (no fill) and .IP (indented para).
HTML reader parses <tt> as Code. (Issue #247)
html+lhs output now contains bird tracks, even when compiled without highlighting support. (Issue #242)
Colons are now no longer allowed in autogenerated XML/HTML identifiers, since they have a special meaning in XML.
Code improvements in ODT writer. Remote images are now replaced with their alt text rather than a broken link.
LaTeX reader improvements:
\section, \chapter parsers more forgiving of whitespace.\chapter{} in latex.rawLaTeXInline to accept \section, \begin, etc.rawLaTeXInline' in LaTeX reader, and export rawLaTeXInline for use in markdown reader.\section{foo} was not recognized as raw TeX in markdown document.LaTeX writer: images are automatically shrunk if they would extend beyond the page margin.
Plain, markdown, RST writers now use unicode for smart punctuation.
Man writer converts math to unicode when possible, as in other writers.
markdown2pdf can now recognize citeproc options.
Command-line arguments are converted to UTF-8. (Issue #234)
Text.Pandoc.TeXMath has been rewritten to use texmath’s parser. This allows it to handle a wider range of formulas. Also, if a formula cannot be converted, it is left in raw TeX; formulas are no longer partially converted.
Unicode curly quotes are left alone when parsing smart quotes. (Issue #143)
Cabal file changes:
Use explicit imports from Data.Generics. Otherwise we have a conflict with the ‘empty’ symbol, introduced in syb >= 0.2. (Issue #237)
New data files: slidy/slidy.min.js, slidy/slidy.min.css, epub.css.
--mathml option, for display of TeX math as MathML.--data-dir option, allowing users to specify a data directory other than ~/.pandoc. Files placed in this directory will be used instead of system defaults.--base-header-level option. For example, --base-header-level=2 changes level 1 headers to level 2, level 2 to level 3, etc.html2markdown has been removed; it is no longer necessary, given the last two changes. pandoc can be used by itself to convert web pages to markdown or other formats.hsmarkdown has also been removed. Use pandoc --strict instead. Or symlink pandoc’s executable to hsmarkdown; pandoc will then behave like hsmarkdown used to.= head = is now level 1 instead of level 2.-B and -A options now imply -s and no longer work in fragment mode.\chapter is now used instead of \section. when the documentclass is book, report, or memoir.--standalone mode. Added --template and --variable options. The --print-default-header option is now --print-default-template. See README under “Templates” for details.--custom-header option should still work, but it has been deprecated.--reference-odt option allows users to customize styles in ODT output.~/.pandoc directory, where they will override system defaults. See README for details.>, <, ", &).--xetex option for pandoc and markdown2pdf.markdown2pdf and hsmarkdown wrappers.--id-prefix option to help prevent duplicate identifiers when you’re generating HTML fragments.--indented-code-classes option, which specifies default highlighting syntax for indented code blocks.--number-sections now affects HTML output.--smart).--strict compatible with --standalone and --toc.--email-obfuscation option.--jsmath option supporting use of pandoc with [jsMath].--sanitize-html option (and a corresponding parameter in ParserState for those using the pandoc libraries in programs). This option causes pandoc to sanitize HTML (in HTML or Markdown input) using a whitelist method. Possibly harmful HTML elements are replaced with HTML comments. This should be useful in the context of web applications, where pandoc may be used to convert user input into HTML.--gladtex, --mimetex, and --asciimathml options are provided. See the User’s Guide for details.--no-wrap option that disables line wrapping and minimizes whitespace in HTML output.[ John MacFarlane ]
Fixed bug in HTML writer: when –toc was used, anchors were put around headers, which is invalid XHTML (block content within inline element). Now the anchors are put inside the header tags. Resolves Issue #23.
Added xmlns attribute to html element in html writer tests. This attribute is added by more recent versions of the xhtml library (>= 3000), and is required for valid XHTML.
[ Recai Oktaş ]
On configure, compile ‘Setup.hs’ to ‘setup’ and use ‘setup’ as the build command instead of ‘runhaskell’, which, on some platforms (such as s390, alpha, m68k), throws the following error:
runhaskell Setup.hs configure --prefix=/usr
ghc-6.6.1: not built for interactive useThis causes a serious FTBFS bug. Closes: #440668.
[ John MacFarlane ]
The focus of this release is performance. The markdown parser is about five times faster than in 0.42, based on benchmarks with the TextMate manual.
Main.hs: Replaced CRFilter and tabFilter with single function tabFilter, which operates on the whole string rather than breaking it into lines, and handles dos-style line-endings as well as tabs.
Added separate LaTeX reader and native reader tests; removed round-trip tests.
Text.Pandoc.Shared:
Writers:
\usepackage{url} to be put in the document header. Also, changes to state in enumerated list items would be overwritten.Text.Pandoc.Reades.LaTeX:
Text.Pandoc.Readers.RST:
Text.Pandoc.Readers.Markdown:
[LC_TYPE]: my_type as [LC<em>TYPE]:my</em>type.'s with which the section began, followed by a non- character. So, for example, h ``` i -> <code>h ``` i</code>.Text.Pandoc.CharacterReferences:
Build process:
Website and documentation:
[ John MacFarlane ]
Main.hs: Use utf8 conversion on the extra files loaded with the -H, -C, -B, and -A options. This fixes problems with unicode characters in these files.
Exposed Text.Pandoc.ASCIIMathML, since it is imported in Text.Pandoc.Readers.HTML and without it we get a linking error when using the library.
Markdown reader:
LaTeX writer: When a footnote ends with a Verbatim environment, the close } of the footnote cannot occur on the same line or an error occurs. Fixed this by adding a newline before the closing } of every footnote.
HTML writer:
Build process:
Website:
[ Recai Oktaş ]
[ John MacFarlane ]
Fixed bugs in HTML reader:
</html> is present (previously, only part of the document would be parsed if an error was found; now a proper error message is given).Fixed bug in markdown ordered list parsing. The problem was that anyOrderedListStart did not check for a space following the ordered list marker. So in ‘A.B. 2007’ the parser would be expecting a list item, but would not find one, causing an error. Fixed a similar bug in the RST reader. Resolves Issue #22.
Refactored RST and Markdown readers using parseFromString.
LaTeX reader will now skip anything after \end{document}.
Fixed blockquote output in markdown writer: previously, block quotes in indented contexts would be indented only in the first line.
Added note to INSTALL about variations in versions of the xhtml library that can lead to failed tests (thanks to Leif LeBaron).
[ John MacFarlane ]
Added two new output formats: groff man pages and ConTeXt. By default, output files with extensions “.ctx” and “.context” are assumed to be ConTeXt, and output files with single-digit extensions are assumed to be man pages.
Enhanced ordered lists (documented in README, under Lists):
Added support for tables (with a new Table block element). Two kinds of tables are supported: a simple table with one-line rows, and a more complex variety with multiline rows. All output formats are supported, but only markdown tables are parsed at the moment. The syntax is documented in README.
Added support for definition lists (with a new DefinitionList block element). All output and input formats are supported. The syntax is documented in README.
Added support for superscripts and subscripts (with new Superscript and Subscript inline elements). All input and output formats. The syntax is documented in README.
Added support for strikeout (with a new Strikeout inline element). All input and output formats are supported. Thanks to Bradley Kuhn, who contributed a patch. The syntax is documented in README. Resolves Issue #18.
Added a –toc|–table-of-contents option. This causes an automatically generated table of contents (or an instruction that creates one) to be inserted at the beginning of the document. Not supported in S5, DocBook, or man page writers.
Modified the -m|–asciimathml option:
Removed Blank block element as unnecessary.
Removed Key and Note blocks from the Pandoc data structure. All links are now stored as explicit links, and note contents are stored with the (inline) notes.
Added Text.Pandoc module that exports basic readers, writers, definitions, and utility functions. This should export everything needed for most uses of Pandoc libraries. The haddock documentation includes a short example program.
Text.Pandoc.ASCIIMathML is no longer an exported module.
Added Text.Pandoc.Blocks module to help in printing markdown and RST tables. This module provides functions for working with fixed-width blocks of text–e.g., placing them side by side, as in a table row.
Refactored to avoid reliance on Haskell’s Text.Regex library, which
Renamed Text.Pandoc.Entities as Text.Pandoc.CharacterReferences.
Changed handling of XML entities. Entities are now parsed (and unicode characters returned) in the Markdown and HTML readers, rather than being handled in the writers. In HTML and Docbook writers, UTF-8 is now used instead of entities for characters above 128. This makes the HTML and DocBook output much more readable and more easily editable.
Text.Pandoc.UTF8: Renamed encodeUTF8 to toUTF8, decodeUTF8 to fromUTF8, for clarity.
Replaced old haskell98 module names replaced by hierarchical module names, e.g. List by Data.List. Removed haskell98 from dependencies in pandoc.cabal, and added mtl (needed for state monad). Substituted xhtml for html.
Refactored and cleaned up character escaping in writers, using backslashEscapes and escapeStringUsing functions.
Instead of adding \n\n to the end of an input string in Main.hs, this is now done in the readers. This makes the libraries behave the way you’d expect from the pandoc program. Resolves Issue #10.
URLs and email addresses in autolinks are now typeset as Code.
In Main.hs, changed putStr to putStrLn – mainly because MacOS X doesn’t display the whole output unless there’s a line ending.
Major code cleanup in all modules, for greater consistency, concision, and readability.
HTML reader:
Markdown reader:
<google.com> is not treated as a link, but <http://google.com>, <ftp://google.com>, and <mailto:google@google.com> are.RST reader:
would not be correctly parsed as a verbatim.# was seen by ‘inline’ as a potential link or image. Fix: inserted ‘notFollowedBy (char’`‘)’ in link parsers. Resolves Issue #8.LaTeX reader:
choice [(try (string ...), ...] idiom with oneOfStrings, for clarity.\ensuremath{\sim}, and caret is \^{}, not \^ as before.\url.\texttt{} as code, provided there’s nothing fancy inside.HTML writer:
<noscript> section and in --strict mode. Resolves Issue #9.Markdown writer:
[site.com](site.com), use <site.com>.LaTeX writer:
\, between consecutive quotes.\maketitle.\author{} when no author specified to avoid LaTeX errors.\url{} for autolinks.RST writer: Force blank line before lists, so that sublists will be handled correctly.
Docbook writer: Fixed a bug: email links with text, like foo, were being incorrectly treated as autolinks.
Removed Text.ParserCombinators.Pandoc and moved all its functions to Text.Pandoc.Shared.
Text.Pandoc.Shared:
Refactored runtests.pl; added separate tests for tables.
Shell scripts:
Changes to build process:
Documentation:
Added FreeBSD port.
[ Recai Oktaş ]
debian/control:
[ John MacFarlane ]
Changes in pandoc options:
Added docbook writer.
Added implicit setting of default input and output format based on input and output filename extensions. These defaults are overridden if explicit input and output formats are specified using ‘-t’, ‘-f’, ‘-r’, or ‘-w’ options. Documented in pandoc(1) man page and README.
Allow ordered list items to begin with (single) letters, as well as numbers. The list item marker may now be terminated either by ‘.’ or by ‘)’. This extension to standard markdown is documented in README.
Revised footnote syntax. (See README for full details.) The ‘[^1]’ format now standard in markdown extensions is supported, as are inline footnotes with this syntax: ^[My note.]. The earlier footnote syntax ^(1) is no longer supported.
Improved HTML representation of footnotes. All footnotes are now auto-numbered and appear in an ordered list at the end of the HTML document. Since the default appearance is now acceptable, the old footnote styles have been removed from the HTML header.
Bug fixes:
\ at the end of a line to count as escaped whitespace.s can begin inline code, which will end with the same number ofs. For example, to have two backticks as code, write ``. Modified Markdown writer accordingly.<br> tag. Otherwise the newline will be treated as a space at the beginning of the next line.Made handling of code blocks more consistent. Previously, some readers allowed trailing newlines, while others stripped them. Now, all readers strip trailing newlines in code blocks. Writers insert a newline at the end of code blocks as needed.
Modified readers to make spacing at the end of output more consistent.
Minor improvements to LaTeX reader:
\thanks now treated like a footnote.Revised RTF writer:
\f0 is added to each \pard, so that font resizing works correctly.Moved handling of “smart typography” from the writers to the Markdown and LaTeX readers. This allows great simplification of the writers and more accurate smart quotes, dashes, and ellipses. DocBook can now use <quote>. The ‘–smart’ option now toggles an option in the parser state rather than a writer option. Several new kinds of inline elements have been added: Quoted, Ellipses, Apostrophe, EmDash, EnDash.
Changes in HTML writer:
Changed default ASCIIMathML text color to black.
Test suite:
Makefile changes:
Removed all wrappers except markdown2pdf and html2markdown.
Added new wrapper hsmarkdown, to be used as a drop-in replacement for Markdown.pl. hsmarkdown calls pandoc with the ‘–strict’ option and disables other options.
Added code to html2markdown that tries to determine the character encoding of an HTML file, by parsing the “Content-type” meta tag.
Improved warning messages in wrappers:
Code cleanup:
Rewrote documentation and man pages. Split README into INSTALL and README.
Split LICENSE into COPYING and COPYRIGHT.
Removed TODO, since we now maintain ToDo on the wiki.
Made COPYRIGHT in top level a symlink to debian/copyright, to avoid duplication.
[ Recai Oktaş ]
Revamped build process to conform to debian standards and created a proper debian package. Closes: #391666.
Modified build process to support GHC 6.6.
Refactored template processing (fillTemplates.pl).
Modified wrapper scripts to make them more robust and portable. To avoid code duplication and ensure consistency, wrappers are generated via a templating system from templates in src/wrappers.