needsVariationSelector
. + Add class="heading"
to level 7+ Headersrendered as <p>
elements (#5457).RST writer: treat Span with no attributes as transparent (#5446).Previously an Emph inside a Span was being treated asnested markup and ignored. With this patch, the Spanis just ignored.
LaTeX writer:
- Include inline code attributes with
--listings
(#5420). - Don't produce columns environment unless beamer (#5485).
- Fix footnote in image caption. Regression: the fix for #4683 brokethis case.
- Don't highlight code in headings (#5574). This causescompilation errors.
- Use
\mbox
to get proper behavior inside\sout
(#5529).
EPUB writer: Fix document section assignments (#5546).For example, introduction should go in bodymatter, not frontmatter, andepigraph, conclusion, and afterward should go in bodymatter, notbackmatter. For the full list of assignments, see the manual.
Markdown writer:
- Add backslashes to avoid unwanted interpretation ofdefinition list terms as other kinds of block (#554).
- Ensure the code fence is long enough (#5519).Previously too few backticks were used when the code blockcontained an indented line of backticks. (Ditto tildes.)
- Handle labels with integer names (Jesse Rosenthal, #5495).Previously if labels had integer names, it could produce a conflictwith auto-labeled reference links. Now we test for a conflict andfind the next available integer. This involves adding a new statevariable
stPrevRefs
to keep track of refs used in other documentparts when using--reference-location=block|section
Textile 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, AlbertKrewinkel). Emacs always uses two spaces when indenting the content ofsrc blocks, e.g., when exiting a C-c '
edit-buffer. Pandoc used toindent contents by the space-equivalent of one tab, but now always usestwo spaces, too.
Asciidoc writer:
- Use
`+...+`
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+`
. - Use proper smart quotes with asciidoctor (#5487).Asciidoctor has a different format for smart quotes.
- Use doubled ## when necessary for spans (#5566).
- Ensure correct nesting of strong/emph (#5565): strongmust be the outer element.
JATS writer:
- Wrap elements with p when needed (#5570). The JATS spec restrictswhat elements can go inside
fn
andlist-item
. So we wrap otherelements inside<p specific-use="wrapper">
when needed. - Properly handle footnotes (#5511) according to "best practice."(Group them at the end in
<fn-group>
and use<xref>
elementsto link them.) - Fix citations with PMID so they validate (#5481). This includesan update to data/jats.csl.
- Ensure validity of
<pub-date>
by parsing the date andextracting year, month, and day, as expected. Also add aniso-8601-date attribute automatically. - Don't use
<break>
element for LineBreak. It is onlyallowed in a few special contexts, and not in<p>
elements. - Don't make
<string-name>
a child of<string>
, which is illegal.
FB2 writer:
- Do not wrap note references into
<sup>
and brackets(Alexander Krotov). Existing FB2 readers, such as FBReader, alreadydisplay links with type="note" as a superscript. - Use genre metadata field (#5478).
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
areturned into Version
objects. The objects simplify version-appropriatecomparisons while maintaining backward-compatibility.A function pandoc.types.Version
is added as part of the newlyintroduced module pandoc.types
, allowing users to create versionobjects in scripts.
pandoc lua module (Albert Krewinkel):
- Fix deletion of nonexistent attributes (#5569).
- Better tests for Attr and AttributeList.
pandoc.mediabag lua module (Albert Krewinkel):
- Add function
delete
for deleting a single item. - Add function
empty
for removing all entries. - Add function
items
for iterating over mediabag.
Text.Pandoc.Class: Fix handling of file:
URL scheme indownloadOrRead
(#5517, Mauro Bieg). Previously file:/
URLs were handled wrongly and pandoc attempted to make HTTPrequests, which failed.
Text.Pandoc.MIME: add mediaCategory
[API change] (Mauro Bieg).
Text.Pandoc.Shared:
- Add
onlySimpleTableCells
[API change](Mauro Bieg) and use this to consolidate simple-table detection(#5524). This fixes an inconsistency in the HTML reader, which did nottreat 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 forLogMessage
. SkippedConetnt
doesn't work for some XML-basedreaders 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 Luaand integrate the results into Tasty output. Test output becomesmore informative: individual tests and test groups become visiblein 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 theoperating- and file system. E.g.print(pandoc.system.get_current_directory())
or
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 shouldadd 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:
- Updates for revealjs 3.8.0 (#5435, ebiim).
- Remove reference to head.min.js (#5448, Winnie Hellmann).NOTE: users will need to update reveal.js to at least 3.8.0for their presentations generated with this version of pandocto work correctly.
Text.Pandoc.PDF:
- Replace
</>
with literal/
(#5451).We use forward-slash for a directory separator in tmpDir,even on Windows (because that's what tex likes). So weshould not put a backslash between the tmpDir and thefilename on Windows. This is harmless enough in normalWindows setups, but it breaks on Cygwin.Thanks to @cc2x for noticing and diagnosing the problem. - Allow use of
-output-directory
in--pdf-engine-opt
(#5462).This is currently possible withmklatex
and-outdir
, butwas not yet possible with xelatex and-output-directory
. - For PDF via ms/pdfroff, make TOC appear at beginning and inPDF bookmarks (#5553). Previously the TOC appeared at the endof the document, and was not bookmarked. To keep it at the end,add
--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 thatthe links can be followed by people viewing these documentson GitHub.
Improved sample lua tikz filter in lua-filters docs (#5445,Matthew Doty). There are three changes:
- It only processes elements which begin with
\begin{tikzpicture}
- It uses pdf2svg instead of imagemagick to preserve fidelity
- The images produced have transparent backgrounds
MANUAL.txt:
- Add note about
title-meta
,author-meta
,date-meta
(#5486). - Fix typo (#5489, Christian Krause).
add test/tables.xwiki to git and pandoc.cabal (#5498, Mauro Bieg).
Disable missing-home-modules warning in stack.yaml
.Otherwise stack ghci
fails.
pandoc 2.7.2 (2019-04-05)
Add XWiki writer (#1800, Derek Chen-Becker).Add
Text.Pandoc.Writers.XWiki
, exportingwriteXWiki
[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 titlewikilink
. This mirrors behavior of other wiki readers. Generallythe.html
extension is not wanted. It may be important for outputto HTML in certain circ*mstances, but it can always be added using afilter that matches on links with titlewikilink
.If your workflow requires the current behavior, here is a lua filterthat will add the
.html
extension:function Link(el) if el.title == 'wikilink' then el.target = el.target .. ".html" end return elend
ipynb reader:
- Use format
ipynb
for raw cell where no format given. - Avoid introducing spurious
.0
on integers in metadata.
- Use format
Markdown reader: fenced div takes priority over setext header.
HTML reader: read
data-foo
attribute intofoo
(#5392).The HTML writer adds thedata-
prefix for HTML5 for nonstandardattributes. But the attributes are represented in the AST withoutthedata-
prefix, so we should strip this when reading HTML.LaTeX reader: Improve autolink detection (#5340).
PowerPoint writer (Jesse Rosenthal):
- Expand builtin reference doc to model all layouts.The previous built-in reference doc had only title and contentlayouts. Add in a section-header slide and a two-content slide, sousers can more easily modify it to build their own templates.
- Always open up in slide view. When editing atemplate/reference-doc, the user might be in Master view, but whenproducing a slide show, it is assumed that slide view will bedesired.
- Remove
handoutsMasterList
from template presentation.xml - Fix numerous errors in templating (#5402). Previously, some templatesproduced by Office 365 (MacOS) would not render with
--reference-doc
correctly. We now apply correct shapes for content, and buildshape trees correctly. - Make default placeholder type for template lookup.
- Apply speaker notes to metadata slide if applicable.
- Test for speaker notes after breaking header.
- Correctly handle notes after section-title header.Previously, if notes came after a section-title header (ie, a level-1header in a slide-level=2 presentation), they would go on the nextslide. This keeps them on the slide with the header.
- Internal improvements.
ipynb writer:
- Use format
ipynb
for raw cell where no format given.According to nbformat docs, this is supposed to render in everyformat. We don't do that, but we at least preserve it as a rawblock in markdown, so you can round-trip. - Consolidate adjacent raw blocks. Sometimes pandoc creates twoHTML blocks, e.g. one for the open tag and one for a close tag.If these aren't consolidated, only one will show up in output cell.
- Fixed carry-over of nbformat from metadata.
- Preserve
nbformat_minor
if it's given. This helps with round-tripping.
- Use format
LaTeX writer:
- Avoid inadvertently creating ?
or !
ligatures (#5407).These are upside down ? and !, resp. - Fix footnotes in table caption and cells (#5367). This fixes abug wherein footnotes appeared in the wrong order, and withduplicate numbers, when in table captions and cells.We now use regular
\footnote
commands, even in the tablecaption and the minipages containing cells. Apparentlylongtable knows how to handle this.
- Avoid inadvertently creating ?
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:
- Better rendering of numbers (#5398). If the number is integral,we render it as an integral not a float.
- Proper rendering of empty map in YAML metadata (#5398). Shouldbe
{}
, not empty string. - Properly escape attributes in Markdown writer (#5369).
- Be sure implicit figures work in list contexts (#5368).Previously they would sometimes not work: e.g., when theyoccurred in final paragraphs in lists that were originallyparsed as Plain and converted later using PlainToPara.
Docx writer: Use
w:br
without attributes for line breaks (#5377).We previously added the attributetype="textWrapping"
, butthis causes problems on Word Online.LaTeX template (Andrew Dunning):
- Ensure correct heading/table order (#5365). Improve workaround(#1658) for tables following headings. The new solution works whetheror not the
indent
variable is enabled. - Remove
subparagraph
variable. The default is now to use run-instyle for level 4 and 5 headings (\paragraph
and\subparagraph
).To get the previous default behavior (where these were formatted asblocks, like\subsubsection
), set theblock-headings
variable. - Add pandoc to PDF metadata (#5388).
- Group graphics-related code (#5389).
- Move
\setstretch
after front matter (#5179). Ensures that\maketitle
,\tableofcontents
, and so forth are not affected bychanges to line spacing.
- Ensure correct heading/table order (#5365). Improve workaround(#1658) for tables following headings. The new solution works whetheror not the
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 MetaStringor MetaInlines into JSON Number.Text.Pandoc.Writers.Shared:
metaValueToJSON
: use Number Values forintegers. Pandoc's MetaValue doesn't have a distinguished number type,so numbers are put in MetaStrings. If the MetaString consistsentirely of digits, we convert it to a Number. We should probablyconsider adding a MetaNumber constructor to MetaValue, for betterround-tripping with JSON etc. This change aids round-tripping inipynb metadata fields, liketoc_depth
.Text.Pandoc.Class:
fetchItem
: don't treat UNC paths asprotocol-relative URLs (#5127). These are paths beginning//?/UNC/...
.Text.Pandoc.ImageSize: Improve
pdfSize
so it handlesa 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:
- Improve 'header' and 'heading' usage (#5423, AndrewDunning). The term 'header' was being used where 'heading'is more appropriate.
- Add paragraph on options affecting markdown in ipynb.
stack.yaml - remove -Wmissing-home-modulesThis 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.
pandoc 2.7.1 (2019-03-14)
Add tectonic as an option for --pdf-engine (#5345, Cormac Relf).Runs tectonic on STDIN instead of a temporary .tex file, so that itlooks in the working directory for
\include
and\input
like the restof the engines. Allows overriding the output directoryargs 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 commandline (this is documented, #5357).LaTeX reader:
- Support
\underline
,\ul
,\uline
(#5359, PaulTilley). These are parsed as a Span with classunderline
, aswith other readers. - Ensure that
\Footcite
and\Footcites
get put in a note.
- Support
ipynb reader:
- Remove sensitivity to
raw_html
,raw_tex
extensions.We now include every output format. Pruning is handled by--ipynb-output
. - Better handling of cell metadata. We now include even complex cellmetadata in the Div's attributes (as JSON, in complex cases, oras plain strings in simple cases).
- Remove sensitivity to
ipynb writer:
- Recurse into native divs for output cell data (#5354).
- Render cell metadata fields from div attributes.
Docx writer: avoid extra copy of abstractNum and num elementsin numbering.xml. This caused pandoc-produced docx files tobe uneditable using Word Online (#5358).
Markdown writer: improve handling of raw blocks/inline.We now emit raw content using
raw_attribute
when no moredirect method is available. Use ofraw_attribute
can beforced by disablingraw_html
andraw_tex
.LaTeX writer: Add classes for frontmatter support (#5353, Andrew Dunning)and remove frontmatter from
scrreprt
.LaTeX template:
- Improve readability (#5363, Andrew Dunning).
- Robust section numbering removal (#5351, Andrew Dunning).Ensures that section numbering does not reappear with customsection levels. See https://tex.stackexchange.com/questions/473653/.
- Better handling of front/main/backmatter (#5348).In pandoc 2.7 we assumed that every class with chapters would accept
\frontmatter
,\mainmatter
, and\backmatter
. This is not so (e.g.report does not). So pandoc 2.7 breaks on report class by including anunsupported command. Instead of thebook-class
variable, we use twovariables,has-chapters
andhas-frontmatter
, and set theseintelligently in the writer.
Text.Pandoc.Shared: Improve
filterIpynbOutput
. Ensure thatimages are prioritized over text.best
should include everythingfor ipynb.Tests.Old: specify
--data-dir=../data
to ensure tests can finddata files even if they haven't been installed. Remove oldpandoc_datadir
environment variable, which hasn't done anything for along 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.
pandoc 2.7 (2019-03-03)
Use XDG data directory for user data directory (#3582). Instead of
$HOME/.pandoc
, the default user data directory is now$XDG_DATA_HOME/pandoc
, whereXDG_DATA_HOME
defaults to$HOME/.local/share
but can be overridden by setting theenvironment 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 thedefault user data directory remains the same.Slide show formats behavior change: content under headersless than slide level is no longer ignored, but included inthe title slide (for HTML slide shows) or in a slide afterthe title slide (for beamer). This change makes possible2D reveal.js slideshows with content in the top slide oneach stack (#4317, #5237).
Add command line option
--ipynb-output=all|none|best
(#5339).Output cells in ipynb notebooks often contain several differentversions of an output, with different MIME types, e.g. an HTMLtable and a plain-text fallback. Specifying--ipynb-output=best
(the default) ensures that the best version for the output formatis used.all
includes all versions, andnone
suppresses themall, leaving output cells empty.asciidoctor
is now an output format separate fromasciidoc
,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 specifya persistent temp directory.Markdown reader:
- Improve tight/loose list handling (#5285). Previously thealgorithm allowed list items with a mix of Para and Plain, whichis never wanted.
- Add newline when parsing blocks in YAML (#5271). Otherwise lastblock gets parsed as a Plain rather than a Para. This is aregression in pandoc 2.x. This patch restores pandoc 1.19behavior.
- Make
yamlToMeta
respect extensions (#5272, Mauro Bieg).This adds aReaderOptions
parameter toyamlToMeta
[API change]. - Fix bug parsing fenced code blocks (#5304). Previously parsingwould break if the code block contained a string of backticks ofsufficient length followed by something other than end of line.
LaTeX reader: don't let
\egroup
match{
.braced
now actuallyrequires nested braces. Otherwise some legitimate command andenvironment definitions can break.Docx reader (Jesse Rosenthal):
- Rename
getDocumentPath
asgetDocumentXmlPath
. - Use field notation for setting
ReaderEnv
. - Figure out
document.xml
path once at the beginning of parsing, andadd it to the environment, so we can avoid repeated lookups. - Dynamically determine main document xml path (#5277).The desktop Word program places the main document file in
word/document.xml
, but the online word places it inword/document2.xml
. This file path is actually stated in the root_rels/.rels
file, in theRelationship
element with anhttp://../officedocument
type. - Fix paths in archive to prevent Windows failure (#5277).Some paths in archives are absolute (have an opening slash) which, forreasons unknown, produces a failure in the test suite on MSWindows. This fixes that by removing the leading slash if it exists.
- Add comments to aid code readability.
- Trim space inside the last inline (#5273).
- Unwrap sdt elements in footnotes and comments (#5302).
- Rename
Muse reader (Alexander Krotov):
- Test that block level markup does not break
<verbatim>
. - Add secondary note support.
- Test that block level markup does not break
ipynb reader: handle images referring to attachments. Previouslywe didn't strip off the attachment: prefix, so even though theattachment was available in the mediabag, pandoc couldn't find it.
JATS reader:
- Fix parsing of figures (#5321). This ensures that a figurecontaining a single image is parsed as a pandoc "implicitfigure" (i.e., a Para with a single Image whose title attributebegins with
fig:
). More complex figures will still be parsedas divs. - Support
fig-group
block element (#5317). - Handle citations with multiple references (#5310). The
rid
attribute can have a space-separated list of ids.
- Fix parsing of figures (#5321). This ensures that a figurecontaining a single image is parsed as a pandoc "implicitfigure" (i.e., a Para with a single Image whose title attributebegins with
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:
- Implement WAI-ARIA roles for (end)notes, citations, andbibliography (#4213). Note that doc-biblioref is only used whenlink-citations produces links, since it belongs on links.
- Include content (including speaker notes) in title slides(#4317, #5237).
ipynb writer:
- Ensure final newline.
- Only include metadata under
jupyter
field. - Don't create attachments for images with absolute URIs,including data: URIs (#5303).
- Keep plain text fallbacks in output even if a richer format isincluded (#5293). We don't know what output format will be needed.See the
--ipynb-output
command line option for a way to controlwhat formats are included in the output.
Markdown writer: use
markdown="1"
when appropriate for Divs:whennative_divs
andmarkdown_in_html_blocks
are disabledbutraw_html
andmarkdown_attribute
are enabled.LaTeX writer:
- Use right fold for
escapeString
. This is more elegant thanthe explicit recursive code we were using. - Avoid
{}
after control sequences when escaping.\ldots{}.
doesn't behave as well as\ldots.
with the latexellipsis package. This patch causes pandoc to avoid emittingthe{}
when it is not necessary. Now\ldots
and othercontrol sequences used in escaping will be followed by eithera{}
, a space, or nothing, depending on context. - For beamer, include contents under headers superordinate toslidelevel (#4317). Currently we keep the fancy title slide, andadd a new slide with the same title and whatever content wasunder the header.
- Use right fold for
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):
- Load module
pandoc
before callinginit.lua
(#5287). The fileinit.lua
in pandoc's data directory is run as part of pandoc'sLua initialization process. Previously, thepandoc
module wasloaded ininit.lua
, and the structure for marshaling wasset up after. This allowed simple patching of elementmarshaling, but made usinginit.lua
more difficult. Now, allrequired modules are now loaded before callinginit.lua
. Thefile can be used entirely for user customization. Patchingmarshaling functions, while discouraged, is still possible viathedebug
module. - All Lua modules bundled with pandoc, i.e.,
pandoc.List
,pandoc.mediabag
,pandoc.utils
, andtext
are re-exported from thepandoc
module. They are assigned to the fieldsList
,mediabag
,utils
, andtext
, respectively.
- Load module
Text.Pandoc.Lua (Albert Krewinkel):
- Split
StackInstances
into smaller Marshaling modules. - Get
CommonState
from Lua global. This allows more control overthe common state from within Lua scripts.
- Split
LaTeX template:
- Support the
subject
metadata variable (#5289, Pascal Wagler). - Add
\frontmatter
,\mainmatter
,\backmatter
for book classes (#5306).
- Support the
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:
- Remove
withTempDir
[API change]. - Add new exported function
defaultUserDataDirs
[API change]. - Add
filterIpynbOutput
[API change]. compactify
: Avoid lists with a mix of Plain and Para elements(#5285).
- Remove
Text.Pandoc.Translations: reorder alphabetically and remove
Author
(#5334, Mauro Bieg).Text.Pandoc.Extensions:
- More carefully groom ipynb default extensions.
- Add
all_symbols_escapable
togithubMarkdownExtensions
.
Text.Pandoc.PDF:
- Use system temp directory when possible (#1192). Previously wecreated temp dirs in the working directory, partly (a) becausethere were problems using the system temp directory on Windows,when their pathnames included tildes, and partly (b) becauseprograms like
epstopdf.pl
would not be allowed to write todirectories outside the working directory in restricted mode. Wenow (a) use the system temp dir except when the path includestildes, and (b) setTEXMFOUTPUT
when creating the PDF, so thatsubsidiary programs can use the system temp directory. Thisaddresses problems that occurred when pandoc was used in asynced directory (such as Dropbox). - Change types of subsidiary functions to PandocIO, to allowwarnings to be threaded through (#5343).
- Use system temp directory when possible (#1192). Previously wecreated temp dirs in the working directory, partly (a) becausethere were problems using the system temp directory on Windows,when their pathnames included tildes, and partly (b) becauseprograms like
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 commonoptions 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 basem*nt/foundation on 32bit windows.
Use latest skylighting (#5328). Custom syntax definitions nolonger try to load
language.dtd
.Require texmath 0.11.2.1
Use latest pandoc-citeproc (0.16.1.1).
MANUAL.txt:
- Clarify variable substitution indentation in templates (#5338,Agustín Martín Barbero).
- Reorder custom-styles section (#5324, Mauro Bieg).
pandoc 2.6 (2019-01-30)
Support ipynb (Jupyter notebook) as input and output format.
- Add
ipynb
as input and output format (extension.ipynb
). - Added Text.Pandoc.Readers.Ipynb [API change].
- Added Text.Pandoc.Writers.Ipynb [API change].
- Add
PandocIpynbDecodingError
constructor to Text.Pandoc.Error.Error[API change]. - Depend on ipynb library.
- Note: there is no template for ipynb.
- Add
Add DokuWiki reader (#1792, Alexander Krotov). This addsText.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 inmost formats you'll get a bullet list with a unicode character forthe box. In HTML, you get checkboxes and in LaTeX/PDF output, abox is used as the list marker. API changes:- Added constructor
Ext_task_lists
toExtension
. - Added
taskListItemFromAscii
andtaskListItemToAscii
toText.Pandoc.Shared.
- Added constructor
Allow some command line options to take URL in addition to FILE.
--include-in-header
,--include-before-body
,--include-after-body
.HTML reader:
- Handle empty
start
attribute (see #5162). - Treat
textarea
as a verbatim environment (#5241) and preservespacing.
- Handle empty
RST reader:
- Change treatment of
number-lines
directive (Brian Leung,#5207). Directives of this type without numeric inputs shouldnot have astartFrom
attribute; with a blank value, thewriters can produce extra whitespace. - Removed superfluous
sourceCode
class on code blocks (#5047). - Handle
sourcecode
directive as synonynm forcode
(#5204).
- Change treatment of
Markdown reader:
- Remove
sourceCode
class for literate Haskell code blocks(#5047). Reverse order ofliterate
andhaskell
classes oncode blocks when parsing literate Haskell, sohaskell
isfirst. - Treat
<textarea>
as a verbatim environment (#5241).
- Remove
Org reader:
- Handle
minlevel
option differently (#5190, Brian Leung).Whenminlevel
exceeds the original minimum level observed inthe file to be included, every heading should be shiftedrightward. - Allow for case of
:minlevel == 0
(#5190). - Fix treatment of links to images (#5191, Albert Krewinkel).Links with descriptions which are pointing to images are nolonger parsed as inline images, but as links.
- Add support for #+SELECT_TAGS (Brian Leung).
- Separate filtering logic from conversion function (Brian Leung).
- Handle
TWiki reader: Fix performance issue with underscores (#3921).
MediaWiki reader: use
_
instead of-
in auto-identifiers (#4731).We may not still be exactly matching mediawiki's algorithm.LaTeX reader:
- Remove
sourceCode
class for literate Haskell code blocks(#5047). Reverse order ofliterate
andhaskell
classes oncode blocks when parsing literate Haskell, sohaskell
isfirst. - Support
\DeclareMathOperator
(#5149). - Support
\inputminted
(#5103). - Support
\endinput
(#5233). - Allow includes with dots like
cc_by_4.0
. Previously the.0
was interpreted as a file extension, leading pandoc not to add.tex
(and thus not to find the file). The new behavior matchestex more closely.
- Remove
Man reader:
- Use
mapLeft
from Shared instead of defining own.
- Use
Docx reader (Jesse Rosenthal):
- Handle level overrides (#5134).
Docx writer:
- Support custom properties (#3024, #5252, Agustín Martín Barbero).Also supports additional core properties:
subject
,lang
,category
,description
. - Make Level into a real type, instead of an alias for a tuple(Jesse Rosenthal).
- Support custom properties (#3024, #5252, Agustín Martín Barbero).Also supports additional core properties:
ICML writer (Mauro Bieg):
- Support custom-styles (#5137, see #2106).
- Support unnumbered headers (#5140).
Texinfo writer: Use header identifier for anchor if present (#4731).Previously we were overwriting an existing identifier with a new one.
Org writer: Preserve line-numbering for example and code blocks(Brian Leung).
Man/Ms writers: Don't escape
-
as\-
. The\-
gets renderedin HTML and PDF as a unicode minus sign.Ms writer: Ensure we have a newline after .EN in disply math (#5251).
RST writer: Don't wrap simple table header lines (#5128).
Asciidoc writer: Shorter delimiters for tables, blockquotes(#4364). This matches asciidoctor reference docs.
Dokuwiki writer: Remove automatic
:
prefix before internal imagelinks (#5183, Damien Clochard). This prevented users from makingrelative image links.Zimwiki writer: remove automatic colon prefix before internalimages (#5183, Damien Clochard).
MediaWiki writer: fix caption, use 'thumb' instead of 'frame'(#5105). Captions used to have the word 'caption' prepended; thishas been removed. Also, 'thumb' is used instead of 'frame' toallow images to be resized.
reveal.js writer:
- Ensure that we don't get > 2 levels of section nesting,even with slide level > 2 (#5168).
- If slide level == N but there is no N-level header, makesure the next header with level > N gets treated as a slideand put in a section, rather than remaining loose (#5168).
Markdown writer:
- Make
plain
RawBlocks pass through inplain
output. - Include needed whitespace after HTML figure (#5121).We use HTML for a figure in markdown dialects that can'trepresent it natively.
- Make
Commonmark writer:
- Fix handling of SoftBreak with
hard_line_breaks
(#5195). - Implement
--toc
(writerTableOfContents
)in commonmark/gfm writers (#5172).
- Fix handling of SoftBreak with
EPUB writer:
- Ensure that picture transforms are done on metadata too.
- Small fixes to
nav.xhtml
:Add 'landmarks' id attribute to the landmarks nav.Replace old default CSS removing numbers from ol.toc liwith new rules that matchnav#toc ol, nav#landmarks ol
.We keep thetoc
class onol
for backwards compatibility.
LaTeX writer:
- Make raw content marked
beamer
pass through inbeamer
output (pandoc/lua-filters#40). - Beamer: avoid duplicated
fragile
property in some cases(#5208). - Add
#
special characters for listings (#4939).This character needs special handling in\lstinline
.
- Make raw content marked
RTF writer: use
toTableOfContents
from Shared to replaceold duplicated code.Pptx writer:
- Support custom properties. Also supports additional coreproperties:
subject
,category
,description
(#5252,Agustín Martín Barbero). - Use
toTableOfContents
from Shared to replace old duplicated code.
- Support custom properties. Also supports additional coreproperties:
ODT writer (Augustín Martín Barbero):
- Fix typo in custom properties (#2839).
- Improve standard properties, including the following coreproperties:
generator
(Pandoc/VERSION),description
,subject
,keywords
,initial-creator
(from authors),creation-date
(actual creation date) (#5252).
Custom writers:
- Allow '-' in filenames for custom lua writers (#5187).
- sample.lua: add
SingleQuoted
,DoubleQuoted
(#5104). - sample.lua: Add a missing
>
(MichaWiedenmann).
reveal.js template: Add
zoomKey
config (#4249).HTML5 template: Remove unnecessary type="text/css" on style andlink for HTML5 (#5146).
LaTeX template (Andrew Dunning, except where noted):
- Prevent fontspec from scaling
mainfont
to match the defaultfont, Latin Modern. A main font set to 12pt couldpreviously appear between 11pt to 13pt depending on its design.To return to the earlier rendering, use-V mainfontoptions="Scale=MatchLowercase"
(#5212, #5218). - Display monospaced fonts without TeX ligatures when using
--pdf-engine=lualatex
. It now matches the behaviour of otherengines (#5212, #5218). - Remove the deprecated
romanfont
variable. The functionality ofmainfont
is identical (#5218). - Render
\subtitle
with the standard document classes.Previously,subtitle
only appeared when using the KOMA-Scriptclasses or Beamer (#5213, #5244). - Use Babel instead of Polyglossia for LuaLaTeX. This avoidsseveral language selection problems, notably with retainingFrench spacing conventions when switching to a verbatimenvironment or another language; and in printing Greek textwithout hyphenation (#5193).
- Use the
xurl
package ifavailable, improving the appearance of URLs by allowing them tobreak at additional points (#5193). - Use
bookmark
if availableto correct heading levels in PDF bookmarks: see the KOMA-Script3.26 release notes (#5193). - Require the
xcolor
package toavoid a possible error when using additional packages alongsidefootnotes in tables (#5193, closes #4861). - Remove obsolete
fixltx2e
package, which has no functionalitywith TeX Live 2015 or later (#5193). - Allow multiple
fontfamilies.options
(#5193, closes #5194). - Restrict
institute
variable to Beamer (#5219). - Use
footnotehyper
package if available to make footnotes in tables compatiblewithhyperref
(#5234). - Number parts and chapters in book classes only if the
numbersections
variable is set, for consistency with otheroutput formats. To return to the previous behaviour, use-V numbersections -V secnumdepth=0
(#5235). - Reindent file (#5193).
- Use built-in parskip handling with KOMA-Script classes (#5143, Enno).
- Set default listings language for lua, assembler (#5227, JohnMacFarlane). Otherwise we get an error when trying to compile codewith lua or assembler code. To change the default dialect(currenty 5.3 for lua and x86masm for assembler), you can use
--include-in-header
to inject something like\lstset{defaultdialect=[5.2]Lua}
.
- Prevent fontspec from scaling
Text.Pandoc.Readers: Changed types of
readJSON
; it now runsin an instance of PandocMonad, like the other readers andwriters. [API change]Text.Pandoc.Writers: Changed types of
writeJSON
; it now runsin an instance of PandocMonad, like the other readers andwriters. [API change]Text.Pandoc.Error: Added
PandocUTF8DecodingError
constructorforPandocError
. [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 givethe 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 ofpipeProcess
was rewritten to fix sporadicfailures caused by prematurely closed pipes.Use
safeRead
instead ofread
everywhere in the code(John MacFarlane, Mauro Bieg, #5162, #5180).Text.Pandoc.SelfContained: Decompress
.svgz
whenconverting todata:
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 treateddifferently, 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 itonly affects the command line program.Simplify/fix reading of
--metadata
values on command lineto avoid problems relating to hvr/HsYAML#7 (#5177).data/pandoc.lua: auto-fix nested constructor arguments (AlbertKrewinkel). Incorrect types to pandoc element constructors areautomatically converted to the correct types when possible. This wasalready done for most constructors, but conversions are now also donefor nested types (like lists of lists).
Removed custom Setup.hs, use build-type: simple. The only thing wegained from the custom build was automatic installation of the manpage when using 'cabal install'. But custom builds cause problems,e.g., with cross-compilation. Installation of the man page isbetter handled by packagers. Note to packagers (e.g. Debian): itmay be necessary to add a step installing the man page with thenext release.
Allow latest http-client, tasty, zip-archive, Glob.
Require skylighting >= 0.7.5, adding support for sml, J,typescript.
Tests: Cleaned up
findPandoc
inTests.Helpers
, so itworks well with cabal v2.INSTALL.md:
- Use button for installer links (John MacFarlane, Mauro Bieg,#5167).
- Fix links and bump required stack version (max).
- Improve installation notes on associated software (AndrewDunning). Includes explanation of how to install related toolswith package managers (since the method of installing
rsvg-convert
is not obvious).
doc/org.md: improve documentation of org features (AlbertKrewinkel).
doc/lua-filters.md: use 3rd level headers for module fields.
MANUAL:
- Clarify automatic identifiers (#5201). We removenon-alphanumerics. This includes, e.g., emojis.
- Fix example for Div with id (Geoffrey Ely).
- Update list of LaTeX packages used.
- Make it clear that
hard_line_breaks
works ingfm
(see #5195). - Mention
raw_attribute
in documentation forraw_html
andraw_tex
(#5240, thanks to @eiro). - Clarify that
$sep$
must come right before$endfor$
in templates(#5243, Lev Givon). - Document metadata support for docx, odt, pptx writers (AgustínMartín Barbero).
- Reorganize template variables (#5249, Andrew Dunning).Add additional headings to categorize variables, andalphabetize when there is large number; add more examples.
- Document
date-meta
template variable (#5260, Tristan Stenner).
trypandoc: Fix CSS and viewport.
pandoc 2.5 (2018-11-27)
Text.Pandoc.App: split into several unexported submodules (AlbertKrewinkel): Text.Pandoc.App.FormatHeuristics,Text.Pandoc.App.Opt, Text.Pandoc.App.CommandLineOptions,Text.Pandoc.App.OutputSettings. This is motivated partly by thedesire to reduce recompilations when something is modified,since App previously depended on virtually every other module.
Text.Pandoc.Extensions
- Semantically,
gfm_auto_identifiers
is now a modifier ofauto_identifiers
; for identifiers to be set,auto_identifiers
mustbe turned on, and then the type of identifier produced depends ongfm_auto_identifiers
andascii_identifiers
are set. Accordingly,auto_identifiers
is now added togithubMarkdownExtensions
(#5057). - Remove
ascii_identifiers
fromgithubMarkdownExtensions
.GitHub doesn't seem to strip non-ascii characters any more.
- Semantically,
Text.Pandoc.Lua.Module.Utils (Albert Krewinkel)
- Test AST object equality via Haskell (#5092). Equality of Luaobjects representing pandoc AST elements is tested by unmarshallingthe objects and comparing the result in Haskell.A new function
equals
which performs this test has been added to thepandoc.utils
module. - Improve stringify. Meta value strings (MetaString)and booleans (MetaBool) are now converted to the literal string and thelowercase boolean name, respectively. Previously, all values of thesetypes were converted to the empty string.
- Test AST object equality via Haskell (#5092). Equality of Luaobjects representing pandoc AST elements is tested by unmarshallingthe objects and comparing the result in Haskell.A new function
Text.Pandoc.Parsing: Remove Functor and Applicative constraints where Monadalready exists (Alexander Krotov).
Text.Pandoc.Pretty: Don't render BreakingSpace at end of lineor beginning of line (#5050).
Text.Pandoc.Readers.Markdown
- Fix parsing of citations, quotes, and underline emphasisafter symbols. Starting with pandoc 2.4, citations, quoted inlines,and underline emphasis were no longer recognized after certainsymbols, like parentheses (#5099, #5053).
- In pandoc 2.4, a soft break after an abbreviation would berelocated before it to allow for insertion of a nonbreakingspace after the abbreviation. This behavior is here reverted.A soft break after an abbreviation will remain, and no nonbreakingspace will be added. Those who care about this issue should take care notto end lines with an abbreviation, or to insert nonbreaking spacesmanually.
Text.Pandoc.Readers.FB2: Do not throw error for unknown elements in
<body>
(Alexander Krotov). Some libraries include custom elementsin their FB2 files.Text.Pandoc.Readers.HTML
- Allow
tfoot
before body rows (#5079). - Parse
<small>
as a Span with class "small" (#5080). - Allow thead containing a row with
td
rather thanth
(#5014).
- Allow
Text.Pandoc.Readers.LaTeX
- Cleaned up handling of dimension arguments. Allow decimal points,preceding space.
- Don't allow arguments for verbatim, etc.
- Allow space before bracketed options.
- Allow optional arguments after
\\
in tables. - Improve parsing of
\tiny
,\scriptsize
, etc. Parse as raw,but know that these font changing commands take no arguments.
Text.Pandoc.Readers.Muse
- Trim whitespace before parsing grid table cells (Alexander Krotov).
- Add grid tables support (Alexander Krotov).
Text.Pandoc.Shared
- For bibliography match Div with id
refs
, not classreferences
.This was a mismatch between pandoc's docx, epub, latex, and markdownwriters and the behavior of pandoc-citeproc, which actually looks for adiv with idrefs
rather than one with classreferences
. - Exactly match GitHub's identifier generating algorithm (#5057).
- Add parameter for
Extensions
touniqueIdent
andinlineListToIdentifier
(#5057). [API change]This allows these functions to be sensitive to the settings ofExt_gfm_auto_identifiers
andExt_ascii_identifiers
, and allows us touseuniqueIdent
in the CommonMark reader, replacing custom code. Italso means thatgfm_auto_identifiers
can now be used in all formats.
- For bibliography match Div with id
Text.Pandoc.Writers.AsciiDoc
- Use
.
+ as list markers to support nested ordered lists (#5087). - Support list number styles (#5089).
- Render Spans using
[#id .class]#contents#
(#5080).
- Use
Text.Pandoc.Writers.CommonMark
- Respect
--ascii
(#5043, quasicomputational). - Make sure
--ascii
affects quotes, super/subscript.
- Respect
Text.Pandoc.Writers.Docx
- Fix bookmarks to headers with long titles (#5091).Word has a 40 character limit for bookmark names. In addition, bookmarksmust begin with a letter. Since pandoc's auto-generated identifiers maynot respect these constraints, some internal links did not work. Withthis change, pandoc uses a bookmark name based on the SHA1 hash of theidentifier when the identifier isn't a legal bookmark name.
- Add bookmarks to code blocks (Nikolay Yakimov).
- Add bookmarks to images (Nikolay Yakimov).
- Refactor common bookmark creation code into a function (Nikolay Yakimov).
Text.Pandoc.Writers.EPUB: Handle calibre metadata (#5098).Nodes of the form
<meta name="calibre:series" content="Classics on War and Politics"/>
are now included from an epub XML metadata file. You can also includethis information in your YAML metadata, like so:
calibre: series: Classics on War and Policitics
In addition, ibooks-specific metadata can now be included via an XMLfile. (Previously, it could only be included via YAML metadata, see#2693.)
Text.Pandoc.Writers.HTML: Use plain
"
instead of"
outside ofattributes.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, evenifwriterIncremental
is True (#5072).Text.Pandoc.Writers.Muse (Alexander Krotov).
- Output tables as grid tables if they have multi-line cells.
- Indent simple tables only on the top level.
- Output tables with one column as grid tables.
- Add support for
--reference-location
. - Internal improvements.
Text.Pandoc.Writers.OpenDocument: Fix list indentation (Nils Carlson,#5095). This was a regression in pandoc 2.4.
Text.Pandoc.Writers.RTF: Fix warnings for skipped raw inlines.
Text.Pandoc.Writers.Texinfo: Add blank line before
@menu
section (#5055).Text.Pandoc.XML: in
toHtml5Entities
, prefer shorter entitieswhen there are several choices for a particular character.data/abbreviations
- Add additional abbreviations (Andrew Dunning)Many of these borrowed from the Chicago Manual of Style 10.42,'Scholarly abbreviations'.
Templates
- Asciidoc template: add :lang: to title header is lang is set inmetadata (#5088).
pandoc.cabal: Add cabal flag
derive_json_via_th
(Albert Krewinkel)Disabling the flag will cause derivation of ToJSON and FromJSONinstances via GHC Generics instead of Template Haskell. The flag isenabled by default, as deriving via Generics can be slow (see #4083).trypandoc:
- Tweaked drop-down lists.
- Put link to site in footer.
- Preselect output format.
- Update on change of in or out format.
- Add man input format.
MANUAL.txt:
- Fix outdated description of latex_macros extension.
- Clarified placement of bibliography.
- Added "A note on security."
- Fix note on curly brace syntx for locators.
- Document new explicit syntax for citeproc locators.
- Remove confusing cross-links for some extensions.
- Don't put pandoc in code ticks in heading.
- Document that
--ascii
works for gfm and commonmark too. - Add
man
to--from
options.
doc/customizing-pandoc.md: various improvements (Mauro Bieg).
pandoc 2.4 (2018-11-03)
New features
- New input format
man
(Yan Pashkovsky, John MacFarlane).
Behavior changes
--ascii
is now implemented in the writers, not in Text.Pandoc.App,via the newwriterPreferAscii
field inWriterOptions
.Now thewrite*
functions for Docbook, HTML, ICML, JATS, LaTeX,Ms, Markdown, and OPML are sensitive towriterPreferAscii
.Previously the to-ascii translation was done in Text.Pandoc.App,and thus not available to those using the writer functionsdirectly.--ascii
now works with Markdown output. HTML5 character referenceentities are used.--ascii
now works with LaTeX output. 100% ASCII output can't beguaranteed, 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 referenceentities 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 aformat that has a pandoc writer but not a reader, it won't justdefault 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-linestyle would be used if
--atx-headers
was specified, butnow 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 unconditionallyemit HTML output for subscripts, superscripts, strikeouts (if thestrikeout extension is disabled) and small caps, even with
raw_html
disabled. Now there are plain-text (and, wherepossible, fancy Unicode) fallbacks for all of these corresponding(mostly) to the Markdown fallbacks, and the HTML output is onlyused whenraw_html
is enabled.Powerpoint writer: support raw openxml (Jesse Rosenthal, #4976).This allows raw openxml blocks and inlines to be used in the pptxwriter. Caveats: (1) It's up to the user to writewell-formed openxml. The chances for corruption, especially withsuch a brittle format as pptx, is high. (2) Because ofthe tricky way that blocks map onto shapes, if you are usinga raw block, it should be the only block on a slide(otherwise other text might end up overlapping it). (3) Thepptx ooxml namespace abbreviations are different from thedocx ooxml namespaces. Again, it's up to the user to get itright. Unzipped document and ooxml specification should beconsulted.
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 withclass "math". Since math has already been identified, thisavoids wasted time parsing for LaTeX delimiters. Note, however,that this may yield unexpected results if you have span elementswith class "math" that don't contain LaTeX math.Also, use latest version of KaTeX by default (0.9.0).The man writer now produces ASCII-only output, using groff escapes,for portability.
ODT writer:
- Add title, author and date to metadata; any remainingmetadata fields are added as
meta:user-defined
tags. - Implement table caption numbering (#4949, Nils Carlson).Captioned tables are numbered and labeled with format "Table 1:caption", where "Table" is replaced by a translation, dependingon the value of
lang
in metadata. Uncaptioned tables are notenumerated. - OpenDocument writer: Implement figure numbering in captions (#4944,Nils Carlson). Figure captions are now numbered 1, 2, 3, ...The format in the caption is "Figure 1: caption" and so on(where "Figure" is replaced by a translation, depending on thevalue of
lang
in the metadata). Captioned figures are numberedconsecutively and uncaptioned figures are not enumerated. Thisis necessary in order for LibreOffice to generate anIllustration Index (Table of Figures) for included figures.
- Add title, author and date to metadata; any remainingmetadata fields are added as
RST reader: Pass through fields in unknown directives as div attributes(#4715). Support
class
andname
attributes for all directives.Org reader: Add partial support for
#+EXCLUDE_TAGS
option. (#4284,Brian Leung). Headers with the corresponding tags should notappear in the output.Log warnings about missing title attributes now include asuggestion about how to fix the problem (#4909).
Lua filter changes (Albert Krewinkel):
Report traceback when an error occurs. A proper Lua traceback isadded if either loading of a file or execution of a filterfunction fails. This should be of help to authors of Lua filterswho need to debug their code.
Allow access to pandoc state (#5015). Lua filters and customwriters now have read-only access to most fields of pandoc'sinternal 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
, anddelimiter
).Rename ReaderOptions fields, use snake_case. Snake case is usedin most variable names, using camelCase for these fields was anoversight. A metatable is added to ensure that the old fieldnames remain functional.
Iterate over AST element fields when using
pairs
. This makesit possible to iterate over all ield names of an AST element byusing a genericfor
loop with pairs`:for field_name, field_content in pairs(element) do...end
Raw table fields of AST elements should be considered animplementation detail and might change in the future. Accessingelement properties should always happen through the fieldslisted in the Lua filter docs.
Note that the iterator currently excludes the
t
/tag
field.Ensure that MetaList elements behave like Lists. Methods usableon Lists can also be used on MetaList objects.
Fix MetaList constructor (Albert Krewinkel). Passing a MetaListobject to the constructor
pandoc.MetaList
now returns thepassed list as a MetaList. This is consistent with theconstructor behavior when passed an (untagged) list.
Custom writers: Custom writers have access to the global variable
PANDOC_DOCUMENT
(Albert Krewinkel, #4957). The variable containsa userdata wrapper around the full pandoc AST and exposes twofields,meta
andblocks
. The field content is onlymarshaled on-demand, performance of scripts not accessing thefields remains unaffected.
API changes
Text.Pandoc.Options: add
writerPreferAscii
toWriterOptions
.Text.Pandoc.Shared:
- Export
splitSentences
. This was previously duplicated in the Man andMs writers. - Add
ToString
typeclass (Alexander Krotov).
- Export
New exported module Text.Pandoc.Filter (Albert Krewinkel).
Text.Pandoc.Parsing
- Generalize
gridTableWith
to anyChar
Stream (Alexander Krotov). - Generalize
readWithM
from[Char]
to anyChar
Streamthat is aToString
instance (Alexander Krotov).
- Generalize
New exposed module Text.Pandoc.Filter (Albert Krewinkel).
Text.Pandoc.XML: add
toHtml5Entities
.New exported module Text.Pandoc.Readers.Man (Yan Pashkovsky, JohnMacFarlane).
Text.Pandoc.Writers.Shared
- Add exported functions
toSuperscript
andtoSubscript
(quasicomputational, #4528). - Remove exported functions
metaValueToInlines
,metaValueToString
. Add new exported functionslookupMetaBool
,lookupMetaBlocks
,lookupMetaInlines
,lookupMetaString
. Use these whenever possible for uniformityin writers (Mauro Bieg, #4907). (Note thatremoved functionmetaValueToInlines
was in previousreleased versions.) - Add
metaValueToString
.
- Add exported functions
Text.Pandoc.Lua
Expose more useful internals (Albert Krewinkel):
runFilterFile
to run a Lua filter from file;- data type
Global
and its constructors; and setGlobals
to add globals to a Lua environment.
This module also contains
Pushable
andPeekable
instancesrequired to get pandoc's data types to and from Lua. Low-levelLua operation remain hidden in Text.Pandoc.Lua.Rename
runPandocLua
torunLua
(Albert Krewinkel).Remove
runLuaFilter
, merging this into Text.Pandoc.Filter.Lua'sapply
(Albert Krewinkel).
Bug fixes and under-the-hood improvements
Text.Pandoc.Parsing
- Make
uri
accept any stream with Char tokens (Alexander Krotov). - Rewrite
uri
withoutwithRaw
(Alexander Krotov). - Generalize
parseFromString
andparseFromString'
to anystreams with Char token (Alexander Krotov) - Rewrite
nonspaceChar
usingnoneOf
(Alexander Krotov)
- Make
Text.Pandoc.Shared: Reimplement
mapLeft
usingBifunctor.first
(Alexander Krotov).Text.Pandoc.Pretty: Simplify
Text.Pandoc.Pretty.offset
(Alexander Krotov).Text.Pandoc.App
- Work around HXT limitation for --syntax-definition with windowsdrive (#4836).
- Always preserve tabs for man format. We need it for tables.
- Split command line parsing code into a separate unexportedmodule, Text.Pandoc.App.CommandLineOptions (Albert Krewinkel).
Text.Pandoc.Readers.Roff: new unexported module for tokenizingroff documents.
New unexported module Text.Pandoc.RoffChar, provided characterescape tables for roff formats.
Text.Pandoc.Readers.HTML: Fix
htmlTag
andisInlineTag
toaccept processing instructions (#3123, regression since 2.0).Text.Pandoc.Readers.JATS: Use
foldl'
instead ofmaximum
toaccount for empty lists (Alexander Krotov).Text.Pandoc.Readers.RST: Don't allow single-dash separator inheaderless table (#4382).
Text.Pandoc.Readers.Org: Parse empty argument array in inline srcblocks (Brian Leung).
Text.Pandoc.Readers.Vimwiki:
- Get rid of
F
,runF
andstateMeta'
in favor ofstateMeta
(Alexander Krotov). - Parse
Text
without converting to[Char]
(Alexander Krotov).
- Get rid of
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). Thishas some performance penalty but is more reliable.
- Make macroDef polymorphic and allow in inline context.Otherwise we can't parse something like
\lowercase{\def\x{Foo}}
.I have actually seen tex like this in the wild. - Improved parsing of
\def
,\let
. We now correctly parse:\def\bar{hello}\let\fooi\bar\def\fooii{\bar}\fooi +\fooii\def\bar{goodbye}\fooi +\fooii
- Improve parsing of
\def
argspec. - Skip
\PackageError
commands (see #4408). - Fix bugs omitting raw tex (#4527). The default is
-raw_tex
,so no raw tex should result unless we explicitly say+raw_tex
.Previously some raw commands did make it through. - Moved
isArgTok
to Text.Pandoc.Readers.LaTeX.Parsing. - Moved
babelLangToBCP
,polyglossiaLangToBCP
to new module,Text.Pandoc.Readers.LaTeX.Lang (unexported). - Simplified accent code using unicode-transforms.New dependency on unicode-transforms package for normalization.
- Allow verbatim blocks ending with blank lines (#4624).
- Support
breq
math environments:dmath
,dgroup
,darray
.This collects some of the general-purpose code from the LaTeX reader,with the aim of making the module smaller.
- Allow space at end of math after
Text.Pandoc.Readers.Markdown
- Fix awkward soft break movements before abbreviations (#4635).
- Add updateStrPos in a couple places where needed.
Text.Pandoc.Readers.Docx: Trigger bold/italic with bCs, iCs(#4947). These are variants for "complex scripts" like Arabicand are now treated just like b, i (bold, italic).
Text.Pandoc.Readers.Muse (Alexander Krotov)
- Try to parse lists before trying to parse table.This ensures that tables inside lists are parsed correctly.
- Forbid whitespace after opening and before closing markupelements.
- Parse page breaks.
- Simplify
museToPandocTable
to get rid of partial functions. - Allow footnotes to start with empty line.
- Make sure that the whole text is parsed.
- Allow empty headers. Previously empty headers caused parser toterminate without parsing the rest of the document.
- Allow examples to be indented with tabs.
- Remove indentation from examples indicated by
{{{
and}}}
. - Fix parsing of empty cells.
- Various changes to internals.
- Rewrite some parsers in applicative style.
- Avoid tagsoup dependency.
- Allow table caption to contain
+
.
Text.Pandoc.Writers.LaTeX
- Add newline if math ends in a comment (#4880). This prevents theclosing delimiter from being swalled up in the comment.
- With
--listings
, don't pass through org-babel attributes (#4889). - With
--biblatex
, use\autocite
when possible (#4960).\autocites{a1}{a2}{a3}
will not collapse the entries. So, ifwe don't have prefixes and suffixes, we use instead\autocite{a1,a2,a3}
. - Fix description lists contining highlighted code (#4662).
Text.Pandoc.Writers.Man
- Don't wrap
.SH
and.SS
lines (#5019). - Avoid unnecessary
.RS
/.RE
pair in definition lists withone paragraph definitions. - Moved common groff functions to Text.Pandoc.Writers.Groff.
- Fix strong/code combination on man (should be
\f[CB]
not\f[BC]
, see #4973).
- Man writer: use
\f[R]
instead of\f[]
to reset font(Alexander Krotov, #4973). - Move
splitSentences
to Text.Pandoc.Shared.
- Don't wrap
Text.Pandoc.Writers.Docx
Add framework for custom properties (#3034). So far, we don'tactually write any custom properties, but we have theinfrastructure to add this.
Handle tables in table cells (#4953). Although this is notdocumented in the spec, some versions of Word require a
w:p
element inside every table cell. Thus, we add one when thecontents of a cell do not already include one (e.g. when a tablecell contains a table).
Text.Pandoc.Writers.AsciiDoc: Prevent illegal nestings.Adjust header levels so that n+1 level headers are onlyfound under n level headers, and the top level is 1.
Text.Pandoc.Writers.OpenDocument: Improve bullet/numberingalignment (#4385). This change eliminates the large gap we usedto have between bullet and text, and also ensures that numbersin numbered lists will be right-aligned.
Text.Pandoc.Writers.ZimWiki
- Number ordered list items sequentially, rather than alwayswith 1 (#4962).
- Remove extra indentation on lists (#4963).
Text.Pandoc.Writers.EPUB: Use metadata field
css
instead ofstylesheet
(Mauro Bieg, #4990).Text.Pandoc.Writers.Markdown: Ensure blank between raw block andnormal content (#4629). Otherwise a raw block can prevent aparagraph from being recognized as such.
Text.Pandoc.Writers.Ms
- Removed old
escapeBar
. We don't need this now that we use@
for math delim. - Moved common code to Text.Pandoc.Writers.Roff and toText.Pandoc.RoffChar.
- Move
splitSentences
to Text.Pandoc.Shared (to avoid duplicationwith the man writer).
- Removed old
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 functionsuseful 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 (AlbertKrewinkel). Hierarchical Elements were pushed to Lua as plaintables. This is simple, but has the disadvantage that marshalingis eager: all child elements will be marshaled as part of theobject. Using a Lua userdata object instead allows lazy accessto fields, causing content marshaling just (but also each time)when a field is accessed. Filters which do not traverse the fullelement contents tree become faster as a result.
Default template changes
LaTeX template:
- Add variable
hyperrefoptions
(#4925, Mathias Walter). - Add variable
romanfont
,romanfontoptions
(#4665, OvidiusCicero).
- Add variable
AsciiDoc template: use single-line style for title.
revealjs template: Fix typo in the socket.io javascript plugin (#5006,Yoan Blanc).
Text.Pandoc.Lua.Util: add missing docstring to
defineHowTo
(Albert Krewinkel).data/pandoc.lua: add datatype ListAttributes (Albert Krewinkel)
data/sample.lua: replace custom pipe function with pandoc.utils.pipe(Albert Krewinkel).
Documentation improvements
INSTALL.md
- Add chromeos install instructions (#4958) (Evan Pratten).
- Add note about TinyTeX.
MANUAL.txt
- Change
groff
->roff
. - Implement
--ascii
for Markdown writer. - Clarify LaTeX image dimensions output (Mauro Bieg).
- Change
doc/customizing-pandoc.md: added skeleton (Mauro Bieg, #3288).
doc/getting-started.md: Added title to test1.md to avoid warning.
doc/lua-filters.md: merge type references into main document,fix description of Code.text (Albert Krewinkel).
Build infrastructure improvements
Makefile
- Makefile: added quick-cabal, full-cabal targets.
- Make .msi download targets insensitive to order of appveyor builds.
Update benchmarks for ghc 8.6.1.
pandoc.cabal:
+ Enable more compiler warnings (Albert Krewinkel).+ Make base lower bound 4.8.+ Bump upper bound for QuickCheck.+ Bump upper bound for binary.+ Updated version bounds for containers and haddock-library (#4974).+ Added docx/docPropos/custom.xml to cabal data-files.+ Require skylighting 0.7.4 (#4920).+ New dependency on unicode-transforms package for normalization.
Improved .travis.yml testing and test with GHC 8.6.1 (Albert Krewinkel).
Added
tools/changelog-helper.sh
.Added test/grofftest.sh for testing the man reader on real man pages.
pandoc 2.3.1 (2018-09-28)
RST reader:
- Parse RST inlines containing newlines (#4912, Francesco Occhipinti).This eliminates a regression introduced after pandoc 2.1.1, whichcaused inline constructions containing newlines not to be recognized.
- Fix bug with internal link targets (#4919). They were gobbling upindented content underneath.
Markdown reader: distinguish autolinks in the AST. With this change,autolinks are parsed as Links with the
uri
class. (The same is truefor bare links, if theautolink_bare_uris
extension is enabled.)Email autolinks are parsed as Links with theemail
class. Thisallows the distinction to be represented in the AST.Org reader:
- Force inline code blocks to honor export options (Brian Leung).
- Parse empty argument array in inline src blocks (Brian Leung).
Muse reader (Alexander Krotov):
- Added additional tests.
- Do not allow code markup to be followed by digit.
- Remove heading level limit.
- Simplify
<literal>
tag parsers - Parse Text instead of String. Benchmark shows 7% improvement.
- Get rid of HTML parser dependency.
- Various code improvements.
ConTeXt writer: change
\
to/
in Windows image paths (#4918).We do this in the LaTeX writer, and it avoids problems.Note that/
works as a LaTeX path separator on Windows.LaTeX writer:
- Add support for multiprenote and multipostnote argumentswith
--biblatex
(Brian Leung, #4930). The multiprenotes occur beforethe first prefix of a multicite, and the multipostnotes follow thelast suffix. - Fix a use of
last
that might take empty list. If you ran with--biblatex
and have an empty document (metadata but no blocks),pandoc would previously raise an error because of the use oflast
on an empty list.
- Add support for multiprenote and multipostnote argumentswith
RTF writer: Fix build failure with ghc-8.6.1 caused by missingMonadFail instance (Jonas Scholl).
ODT Writer: Improve table header row style handling (Nils Carlson).This changes the way styles for cells in the header rowand normal rows are handled in ODT tables.Previously a new (but identical) style was generated forevery 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-processingchanges to the table styles much simpler as it is no longernecessary to introduce new styles for header rows and there arenow only two styles where there was previously one per table.
HTML writer:
- Don't add
uri
class to presumed autolinks. Formerly theuri
class was added to autolinks by the HTML writer, but it had toguess 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 writersimply passes through theuri
attribute if it is present,but does not add anything. - Avoid adding extra section nestings for revealjs.Previously revealjs title slides at level (slidelevel - 1)were nested under an extra section element, even whenthe section contained no additional (vertical) content.That caused problems for some transition effects.
- Omit unknown attributes in EPUB2 output. For example,
epub:type
attributes should not be passed through,or the epub produced will not validate.
- Don't add
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 explicitlyfor autolinks (#4913).Lua filters (Albert Krewinkel):
- Cleanup filter execution code.
- Better error on test failure.
HTML, Muse reader tests: reduce time taken by round-trip test.
Added cabal.project.
MANUAL:
epub:type
is only useful for epub3 (Maura Bieg).Use hslua v1.0.0 (Albert Krewinkel).
Fix
translations/ru
to use modern Russian orthography(Ivan Trubach).Build Windows binary using ghc 8.6.1 and cabal new-build. Thisfixes issues with segfaults in the 32-bit Windows binaries (#4283).
pandoc 2.3 (2018-09-16)
Add
--metadata-file
option (Mauro Bieg, #1960), which allowsusers to specify metadata in a YAML file, regardless of theinput format (#1960).Text.Pandoc.Writers.Shared: export
isDisplayMath
(API change).Text.Pandoc.Readers.Markdown: export
yamlToMeta
(API change,Mauro Bieg).Text.Pandoc.Readers.LaTeX.Types:
- New type
ArgSpec
(API change). - Second parameter of
Macro
constructor is now[ArgSpec]
instead ofInt
(API change).
- New type
Markdown reader:
- Use
tex
instead oflatex
for raw tex-ish content. We can'talways tell if it's LaTeX, ConTeXt, or plain TeX. Better just tousetex
always. Note that ifcontext
orlatex
specificallyis desired, you can still force that in a markdown document byusing the raw attribute. Note that this change may affect somefilters, if they assume that raw tex parsed by the Markdown readerwill be RawBlock (Formatlatex
). In most cases it should betrivial to modify the filters to accepttex
as well. - Refactor and reorganize YAML code (Mauro Bieg).
- Make
example_lists
work for interrupted listswithoutstartnum
(#4908).
- Use
HTML reader:
- Parse
<script type="math/tex
tags as math (#4877).These are used by MathJax in some configurations. - Extract spaces inside links instead of trimming them(Alexander Krotov, #4845).
- Added round-trip tests (Alexander Krotov).
- Make parsing sensitive to the
raw_tex
extension (#1126). This nowallows raw LaTeX environments,\ref
, and\eqref
to be parsed(which is helpful for translation HTML documents using MathJaX).
- Parse
Org reader (Albert Krewinkel):
- Respect export option
p
for planning info. Inclusion of planning info(*DEADLINE*
,*SCHEDULED*
, and*CLOSED*
) can be controlled via thep
export option: setting the option tot
will add all planninginformation in a Plain block below the respective headline. - Org reader internals: don't rely on RecordWildCards and ViewPatternsghc extensions.
- Strip planning info from output. Planning info is parsed, but notincluded in the output (as is the default with Emacs Org-mode, #4867).
- Respect export option
LaTeX reader:
- Handle parameter patterns for
\def
(#4768, #4771).For example:\def\foo#1[#2]{#1 and #2}
. - Allow
%
characters in URLs. This affects\href
and\url
(#4832). - Fixed parsing of
\texorpdfstring
. We were returning the wrongargument as the content. - Support
blockcquote
,foreignblockquote
,foreigncblockquote
,hyphenblockquote
,hyphencblockquote
,enquote*
,foreignquote
,hyphenquote
fromcsquotes
(#4848). Note thatforeignquote
will be parsed as a regular Quoted inline (not using the quotesappropriate to the foreign language). - Support more text-mode accents (#4652). Add support for
\|
,\b
,\G
,\h
,\d
,\f
,\r
,\t
,\U
,\i
,\j
,\newtie
,\textcircled
. Also fall back to combining characters when composedcharacters are not available. - Resolve
\ref
for figure numbers. - Support
mintinline
(#4365, Marc Schreiber). - Fix siunitx unit commands so they are only recognized insiunitx contexts (#4842). For example,
\l
outside of ansiunitx context should be l-slash, not l (for liter). - Fix double
unnumbered
class (#4838). Theunnumbered
classwas being included twice for starred sections.
- Handle parameter patterns for
RST reader: Don't skip link definitions after comments (#4860).
Muse reader (Alexander Krotov):
- Close the
</quote>
in indented tag test.There is already a separate test for unclosed</quote>
. - Autonumber sections in the correct order. Parsing now stopsat each section header to ensure the header is registered beforeparsing of the next section starts.
- Move duplicate code into
headingStart
function. - Allow newline after opening
*
or**
. - Don't allow digits after closing marker in lightweight markupThis change makes reader more compatible with Emacs Muse.
- Parse
<verse>
tag in one pass instead of usingparseFromString
. This change makes it possible to haveverbatim</verse>
tag inside verse.
- Close the
ODT reader: deal gracefully with missing
<office:font-face-decls/>
(#4336). This allows pandoc to parse ODT document produced by KDE'sCalligra.Muse writer (Alexander Krotov):
- Output headers without asterisks if not on the top level.
- Never wrap definition list terms.
- Set
envInsideBlock = True
when rendering notes. - Use
""
instead of[]
for empty String. - Check for whitespace in the beginning and end of Str's.
- Escape
-
,;
and>
in the beginning of strings. - Escape list markers in the beginning of notes.
- Normalize inline list before testing if tags should be used.
- Use tags instead of lightweight markup for empty strings.
- Use lightweight markup when possible.
- Escape empty strings. This guarantees that
conditionalEscapeString
never returns empty string. - Wrap conditionalEscapeString result into
Muse
type.This removes the need to passenvInsideLinkDescription
to it. - Separate
shouldEscapeString
function. - Simplify inline list rendering.
- Replace newlines in strings with spaces.
Docx writer:
- Add MetaString case for abstract, subtitle (#4900, Mauro Bieg).
- Properly handle display math in spans (#4826). This isn't acomplete solution, since other nestings of display math may stillcause problems, but it should work for what is by far the mostcommon case.
HTML writer:
- Always output
<dt>
element, even if it is empty (#4883,Alexander Krotov). - Don't prefix
epub:
attributes withdata-
.
- Always output
Org writer: Don't escape literal
_
,^
(#4882). Org doesn'trecognize 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 theepub:type
of the first section (#4823). Thisonly affects epub3. Seehttp://www.idpf.org/epub/profiles/edu/structure/#h.l0bzsloklt10FB2 writer: put
coverpage
element between title and date rather than indocument-info
element (#4854).Markdown writer: Escape
~
if strikeout extension enabled (#4840).Haddock writer: Use proper format for latex math in haddock (#4571, JoeHermaszewski). Inline math in
\(..\)
, display math in\[..\]
,tex is now used. Previously we'd "fake it with unicode" and fallback to tex when that didn't work. But newer haddock versionssupport latex math.TEI writer:
- Ensure that title element is always present, even if empty (#4839).
- Put author tags in the template, rather than adding them inthe writer (#4839).
LaTeX writer/template: be sensitive to
filecolor
variable (#4822).linkcolor
only affects internal links, andurlcolor
onlyaffects linked URLs. For external links, the option to use isfilecolor
.ConTeXt writer: output raw
tex
blocks as well ascontext
(#969).RST writer:
- Use
.. raw:: latex
fortex
content. - Use
.. container
for generic Divs, instead of raw HTML. - Render Divs with admonition classes as admonitions (#4833).Also omit Div with class
admonition-title
. These are generatedby the RST reader and should be omitted on round-trip.
- Use
Text.Pandoc.PDF: fix message printed when rsvg-convert is not available(#4855, Antonio Terceiro).
HTML5 template: add the
title-block-header
identifier to theheader
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 forpublisher
,address
,pubPlace
, anddate
variables.beamer template: Support "toc-title" (#4835, Cyril Roelandt).
Text.Pandoc.Extensions: Fix haddock on
Ext_footnotes
(Chris Martin).Lua: cleanup Lua utils, remove unused functions (Albert Krewinkel).
MANUAL.txt:
- Clarify that
--biblatex/--natbib
don't work directly for PDF(#4904). - Document
epub:type
attribute (Mauro Bieg, #4901) - Clarify when
--resource-path
has an effect. - More detail on customization in syntax highlighting section.
- Document encoding issue with
--listings
(#4871, Damien Clochard). - Remove docs on removed
--katex-stylesheet
(Mauro Bieg, #4862). - Use https for context wiki links (#4910).
- Clarify that
CONTRIBUTING.md:
- Link to lua-filters repository (#4874).
- Fix mistake in REPL instructions for stack. (#4849, Brian Leung).
lua-filters.md: add links to filters, and to lua-filters repository(#4874).
INSTALL.md:
- Indicate that cabal >= 2.0 is needed.
- Added chocolatey installation method (#4844, Miodrag Milić).
Travis: exclude round-trip tests, except for nightly test which can fail.
Use latest texmath, pandoc-citeproc.
Use a patched version of foundation untilhttps://github.com/haskell-foundation/foundation/pull/503is 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. TheWiX-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.
pandoc 2.2.3.2 (2018-08-07)
Markdown reader: Properly handle boolean values in YAML metadata (#4819).This fixes a regression in 2.2.3, which cause boolean values tobe 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 thanMetaString.
pandoc 2.2.3.1 (2018-08-06)
- Markdown reader: Fix parsing of embedded mappings in YAML metadata(#4817). This fixes a regression in 2.2.3 which caused embeddedmappings (e.g. mappings in sequences) not to work in YAML metadata.
pandoc 2.2.3 (2018-08-05)
RST reader: improve parsing of inline interpreted text roles (#4811).
- Use a Span with class "title-reference" for the defaulttitle-reference role.
- Use
B.text
to split up contents intoSpace
s,SoftBreak
s,andStr
s fortitle-reference
. - Use Code with class "interpreted-text" instead of Span and Str forunknown roles. (The RST writer has also been modified to round-tripthis properly.)
- Disallow blank lines in interpreted text.
- Backslash-escape now works in interpreted text.
- Backticks followed by alphanumerics no longer end interpreted text.
- Remove support for nested inlines (Francesco Occhipinti).RST does not allow nested emphasis, links, or other inlineconstructs. This fixes several bugs (#4581, #4561, #4792).
Org reader: fix parsers relying on
parseFromString
(#4784, AlbertKrewinkel). Emphasis was not parsed when it followed directly aftersome block types (e.g., lists).Markdown reader: Allow unquoted numbers and booleans as YAML mappingkeys. 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 directchildren of book and article (as well as children of bookinfo,articleinfo, or info). We also now use the
subtitle
metadatafield for subtitles, rather than tacking the subtitle on to thetitle.RST writer:
- Allow images to be directly nested within links (#4810, FrancescoOcchipinti).
- Use
titleblock
instead oftitle
variable for title block (#4803,Francesco Occhipinti).titleblock
contains a properly formattedtitle and subtitle (using top-level headers).title
andsubtitle
variables are still available and just contain thetitle and subtitle text. Note that this change will require anupdate to custom rst templates. - Render Code with class "interpreted-text" as interpreted text role.
MediaWiki writer: Avoid extra blank line in tables with empty cells(#4794). Note that the old output is semantically identical, but thenew output looks better.
Lua Utils module: add function
blocks_to_inlines
(#4799, AlbertKrewinkel). Exposes a function converting which flattenes a list ofblocks into a list of inlines. An example use case would be theconversion of Note elements into other inlines.RST template: use
titleblock
instead oftitle
. Users ofcustom 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 (asMetropolis does) (#4450).
Better error message on
-t pdf -o out.pdf
(#1155, Mauro Bieg).Added test case for #4669 to repository.
INSTALL.md: Fix broken link for cabal-install (#4806, ChanHoHo).
MANUAL.txt:
- Add beamer info for slide backgrounds (#4802, John Muccigrosso).
- Clarify when
csquotes
is used in LaTeX writer (#4514). - Add
commonmark
to list of output formats whereraw_tex
has aneffect (see #4527).
pandoc 2.2.2.1 (2018-07-19)
Fix regression finding templates in user data directory (#4777).Under version 2.2.1 and prior pandoc found latex templates in thetemplates directory under the data directory, but this broke in 2.2.2.
Fix for bug in parsing
\input
inrawLaTeXBlock
andrawLaTeXInline
(#4781). (This primarily affects the markdownreader, and other readers that accept raw tex.)Starting in 2.2.2, everything after an\input
(or\include
)in a markdown file would be parsed as raw LaTeX.MANUAL:
- Clarify
gfm
vsmarkdown_github
(#4783, Mauro Bieg).
- Use
keywords
instead oftags
in YAML metadata example (#4779).Unliketags
,keywords
is used in some of the writersand default templates.
- Clarify
Add missing
rollingLinks
option to revealjs template (#4778,Igor Khorlo).
pandoc 2.2.2 (2018-07-16)
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 truevalues are
true
,True
,TRUE
. This means a change inthe semantics of YAML metadata that could affect users:y
,yes
, andon
no longer count as true values.Fix regression: make
--pdf-engine
work with full paths (#4681, MauroBieg).CommonMark reader: Handle
ascii_identifiers
extension (#4742,Anders Waldenborg). Non-ascii characters were not stripped fromidentifiers even if theascii_identifiers
extension wasenabled (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 spaceafter marker.
LaTeX reader:
- Treat
lilypond
as a verbatim environment (#4725). - Parse figure label into Image id (#4700, Mauro Bieg).
- Beamer: Allow "noframenumbering" option (#4696, Raymond Ehlers).
- Allow spaces around
\graphicspath
arguments (#4698). - Handle includes without surrounding blanklines (#4553).In addition,
\input
can now be used in an inline context,e.g. to provide part of a paragraph, as it can in LaTeX. - In
rawLaTeXBlock
, handle macros that resolve to a\begin
or\end
(#4667). - In
rawLaTeXBlock
, don't expand macros in macro definitions (#4653).Note that this only affected LaTeX in markdown. - Tighten up reading of beamer overlay specifications (#4669).Ideally we'd turn these on only when reading beamer, but currentlybeamer is not distinguished from latex as an input format.This commit also activates parsing of overlay specificationsafter commands in general (e.g.
\item
), since they can occurin many contexts in beamer. - Parse more siunitx unit commands (#4296, #4773).
- Be more forgiving in key/value option parsing (#4761).
- Treat
Markdown reader:
- Allow empty code spans, e.g.
` `
. - Emojis are now wrapped in Spans with class
emoji
andattributedata-emoji
(Anders Waldenborg, #4743).This allows the writer to handle them in a special way(e.g. using a special font, or just rendering theemoji name).
- Allow empty code spans, e.g.
Muse reader (Alexander Krotov, except where indicated):
- Get rid of non-exhaustive pattern match warning (Mauro Bieg).
- Add support for floating images.
- Add support for images with specified width.
- Parse image URLs without "guard" and "takeExtension".
- Split link and image parsing into separate functions.
- Parse links starting with "URL:" explicitly instead of trying to strip"URL:" prefix after parsing.
Texinfo writer: Use
@sup
and@sub
instead of custom macros (#4728,Alexander Krotov).Markdown writer: Preserve
implicit_figures
with attributes, even ifimplicit_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 smilecharacter.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'tescaping
&
and other XML characters in the pagetitle, so a titlecontaining a&
would be invalid.AsciiDoc Writer: Eescape square brackets at start of line (#4545,Mauro Bieg).
RST writer:
- Don't treat 'example' as a syntax name (#4748).This fixes conversions from org with example blocks.
- Support
--number-sections
via thesection-numbering
directive in standalone output.
reveal.js writer and template: reuse mathjax URLprovided by the argument to
--mathjax
or the normal pandoc default,rather than a hard-coded one in the template (#4701).LaTeX writer:
- Properly handle footnotes in table captions (#4683).Refactored code from figure captions to use in both places.
- In beamer output, fix single digit column percentage (#4690, MauroBieg).
FB2 writer (Alexander Krotov):
- Convert Plain to Para in annotation (#2424).
- Fix order of items in title-info (#2424).
Custom writer: fix error message on script failure (Albert Krewinkel).Error messages produced by Lua were not displayed by Pandoc.
Text.Pandoc.Emoji now exports
emojiToInline
, which returns a Spaninline containing the emoji character and some attributes with metadata(classemoji
, attributedata-emoji
with emoji name). (API change,Anders Waldenborg, #4743).Text.Pandoc.PDF:
- Revert fix for #4484 (only compress images on last run, #4755).This will mean some increase in the time it takes toproduce an image-heavy PDF with xelatex, but it willmake tables of contents correct, which is more important.
- Fix logic error in
runTeXProgram
. We were running the tex programone 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 packageinstaller the recommended method, and note that on some older versions ofmacOS, homebrew installs from source and takes a lot of disk space(#4664, Ian).
MANUAL:
- Clarify EPUB linked media (#4756, Mauro Bieg)
- Update manual for "true" YAML values. Now that we're using HsYAML andYAML 1.2, the valid true values are
true
,True
,TRUE
. NOTE!y
,yes
,on
no longer count as true values. - Document
-F
as alias for--filter
(thanks to Gandalf Saxe). - Update manual on how math is rendered in LaTeX.
- Add proxy description (#4131, Mauro Bieg).
- Clarify that
--toc
requires--standalone
(#4703). - Update citation styles link (#4699, wiefling).
In API docs, clarify how
Ext_east_asian_line_breaks
extension works(kaizshang91). Note that it will not take effect when readers/writersare 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 oldnetwork-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 getsconfused because of the way ghc 7.10 is excluded in foundation'scabal file. This can be removed when haskell-foundation/foundation#500is fixed.
Require cabal-version >= 2.0. This is needed for haddock-library.
pandoc 2.2.1 (2018-05-10)
Restored and undeprecated gladtex for HTML math (#4607).
- Added
GladTeX
constructor toText.Pandoc.Options.HTMLMathMethod
[API change, reverts removal in v2.2] - Restored and undeprecated
--gladtex
option, removed in v2.2.
- Added
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 avalid file name. The custom validity checker that was used before gavewrong results (e.g. for absolute file paths on Windows,kawabata/ox-pandoc#52).
FB2 reader: Replace some errors with warnings (Alexander Krotov).
HTML writer:
- Strip links from headers when creating TOC (#4340).Otherwise the TOC entries will not link to the sections.
- Fix regression with tex math environments in HTML + MathJax (#4639).
Muse writer (Alexander Krotov): Add support for left-align andright-align classes (#4542).
Docx writer: Support underline (#4633).
Text.Pandoc.Parsing: Lookahead for non-whitespace after
singleQuoteStart
anddoubleQuoteStart
(#4637).test-pandoc-utils.lua
: more robust testing on both windowsand *nix. Previously the pipe tests were only run if\bin/false
and/bin/sed
were present, which they aren'tin default MacOS and Windows systems. Fixed by usingtr
andfalse
, which should always be in the path on a *nixsystem, andfind
andecho
for Windows.Text.Pandoc.Shared: add
uriPathToPath
.This adjusts the path from a file: URI in a way that is sensitiveto Windows/Linux differences. Thus, on Windows,/c:/foo
gets interpreted asc:/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 tempfile as before.
Text.Pandoc.Class: Catch IO errors when writing media filesand issue a warning, rather than an error (Francesco Occhipinti, #4559).
Don't lowercase custom writer filename (Alexander Krotov, #4610).
MANUAL (Mauro Bieg):
- Clarify truthiness in template variables (#2281).
- Clarify pipe table width calculation (#4520).
ConTeXt template: New Greek fallback typeface (Pablo Rodríguez, #4405).CMU Serif gives better typographic results than the previousGreek 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-ASCIIcharacters in math (#4642).
pandoc 2.2 (2018-04-27)
New input format:
fb2
(FictionBook2) (Alexander Krotov).Make
--ascii
work for all XML formats (ICML, OPML, JATS,...),and forms
andman
.Remove deprecated
--latexmathml
,--gladtex
,--mimetex
,--jsmath
,-m
,--asciimathml
options.New module Text.Pandoc.Readers.FB2, exporting readFB2 (AlexanderKrotov, API change).
Markdown reader:
- Allow empty key-value attributes, like
title=""
(#2944). - Handle table w/o following blank line in fenced div (#4560).
- Remove "fallback" for
doubleQuote
parser. Previously theparser tried to be efficient -- if no end double quote was found,it would just return the contents. But this could backfire in acase**this should "be bold**
, since the fallback would returnthe content"be bold**
and the closing boldface delimiterwould never be encountered. - Improve computation of the relative width of the last column in amultiline table, so we can round-trip tables without constantlyshrinking the last column.
- Allow empty key-value attributes, like
EPUB reader:
- Fix images with space in file path (#4344).
LaTeX reader:
- Properly resolve section numbers with
\ref
and chapters (#4529). - Parse sloppypar environment (#4517, Marc Schreiber).
- Improve handling of raw LaTeX (for markdown etc.) (#4589, #4594).Previously there were some bugs in how macros were handled.
- Support
\MakeUppercase
,\MakeLowercase
,\uppercase
,\lowercase
, and also\MakeTextUppercase
and\MakeTextLowercase
from textcase (#4959).
- Properly resolve section numbers with
Textile reader:
- Fixed tables with no body rows (#4513).Previously these raised an exception.
Mediawiki reader:
- Improve table parsing (#4508). This fixes detection of tableattributes and also handles
!
characters in cells.
- Improve table parsing (#4508). This fixes detection of tableattributes and also handles
DocBook reader:
- Properly handle title in
section
element (#4526).Previously we just gotsection_title
forsection
(thoughsect1
,sect2
, etc. were handled properly). - Read tex math as output by asciidoctor (#4569, Joe Hermaszewski).
- Properly handle title in
Docx reader:
- Combine adjacent CodeBlocks with the same attributes intoa single CodeBlock. This prevents a multiline codeblock inWord from being read as different paragraphs.
RST reader:
- Allow < 3 spaces indent under directives (#4579).
- Fix anonymous redirects with backticks (#4598).
Muse reader (Alexander Krotov):
- Add support for Text::Amuse multiline headings.
- Add
<math>
tag support. - Add support for
<biblio>
and<play>
tags. - Allow links to have empty descriptions.
- Require block
<literal>
tags to be on separate lines. - Allow
-
in anchors. - Allow verse to be indented.
- Allow nested footnotes.
- Internal improvements.
Muse writer (Alexander Krotov):
- Escape
>
only at the beginning of a line. - Escape
]
in image title. - Escape
]
brackets in URLs as%5D
. - Only escape brackets when necessary.
- Escape ordered list markers.
- Do not escape list markers unless preceded by space.
- Escape strings starting with space.
- Escape semicolons and markers after line break.
- Escape
;
to avoid accidental comments. - Don't break headers, line blocks and tables with line breaks.
- Correctly output empty headings.
- Escape horizontal rule only if at the beginning of the line.
- Escape definition list terms starting with list markers.
- Place header IDs before header.
- Improve span writing.
- Do not join Spans in normalization.
- Don't align ordered list items.
- Remove key-value pairs from attributes before normalization.
- Enable
--wrap=preserve
for all tests by default. - Reduced
<verbatim>
tags in output. - Internal changes.
- Escape
RST writer:
- Use more consistent indentation (#4563). Previously weused an odd mix of 3- and 4-space indentation. Now we use 3-spaceindentation, except for ordered lists, where indentation mustdepend on the width of the list marker.
- Flatten nested inlines (#4368, Francesco Occhipinti).Nested inlines are not valid RST syntax, so we flatten them followingsome readability criteria discussed in #4368.
EPUB writer:
- Ensure that
pagetitle
is always set, even when structured titlesare used. This prevents spurious warnings about empty titleelements (#4486).
- Ensure that
FB2 writer (Alexander Krotov):
- Output links inline instead of producing notes. Previously all linkswere turned into footnotes with unclickable URLs inside.
- Allow emphasis and notes in titles.
- Don't intersperse paragraph with empty lines.
- Convert metadata value
abstract
to book annotation. - Use
<empty-line />
forHorizontalRule
rather thanLineBreak
.FB2 does not have a way to represent line breaks inside paragraphs;previously we used<empty-line />
elements, but these are not allowedinside paragraphs.
Powerpoint writer (Jesse Rosenthal):
- Handle Quoted Inlines (#4532).
- Simplify code with
ParseXml
. - Allow fallback options when looking for placeholder type.
- Check reference-doc for all layouts.
- Simplify speaker notes logic.
- Change notes state to a simpler per-slide value.
- Remove
Maybe
fromSpeakerNotes
inSlide
.mempty
means no speaker notes. - Add tests for improved speaker notes.
- Handle speaker notes earlier in the conversion process.
- Keep notes with related blocks (#4477). Some blocks automaticallysplit slides (imgs, tables,
column
divs). We assume that anyspeaker notes immediately following these are connected to theseelements, and keep them with the related blocks, splitting after them. - Remove
docProps/thumbnail.jpeg
in data dir (Jesse Rosenthal, #4588).It contained a nonfree ICC color calibration profile and is not neededfor production of a powerpoint document.
Markdown writer:
- Include a blank line at the end of the row in a single-row multilinetable, to prevent it from being interpreted as a simple table (#4578).
CommonMark writer:
- Correctly ignore LaTeX raw blocks when
raw_tex
is notenabled (#4527, quasicomputational).
- Correctly ignore LaTeX raw blocks when
EPUB writer:
- Add
epub:type="footnotes"
to notes section in EPUB3 (#4489).
- Add
LaTeX writer:
- In beamer, don't use format specifier for default ordered lists(#4556). This gives better results for styles that put ordered listmarkers in boxes or circles.
- Update
\lstinline
delimiters (#4369, Tim Parenti).
Ms writer:
- Use
\f[R]
rather than\f[]
to reset font (#4552). - Use
\f[BI]
and\f[CB]
in headers, instead of\f[I]
and\f[C]
,since the header font is automatically bold (#4552). - Use
\f[CB]
rather than\f[BC]
for monospace bold (#4552). - Create pdf anchor for a Div with an identifier (#4515).
- Escape
/
character in anchor ids (#4515). - Improve escaping for anchor ids: we now use uNNN instead of uNNNto avoid ambiguity.
- Use
Man writer:
- Don't escape U+2019 as
'
(#4550).
- Don't escape U+2019 as
Text.Pandoc.Options:
- Removed
JsMath
,LaTeXMathML
, andGladTeX
constructors fromText.Pandoc.Options.HTMLMathMethod
[API change].
- Removed
Text.Pandoc.Class:
writeMedia
: unescape URI-escaping in file path. This avoidswriting things likefile%20one.png
to the file system.
Text.Pandoc.Parsing:
- Fix
romanNumeral
parser (#4480). We previously accepted 'DDC'as 1100. uri
: don't treat*
characters at end as part of URI (#4561).
- Fix
Text.Pandoc.MIME:
- Use the alias
application/eps
for EPS (#2067).This will ensure that we retain the eps extension after reading theimage into a mediabag and writing it again.
- Use the alias
Text.Pandoc.PDF:
- Use
withTempDir
inhtml2pdf
. - With
xelatex
, don't compress images til the last run (#4484).This saves time for image-heavy documents. - Don't try to convert EPS files (#2067).
pdflatex
converts themitself, and JuicyPixels can't do it. - For
pdflatex
, use a temp directory in the working directory.Otherwise we can have problems with the EPS conversion pdflatextries to do, which can't operate on a file above the workingdirectory without--shell-escape
.
- Use
Changes to tests to accommodate changes in pandoc-types.In https://github.com/jgm/pandoc-types/pull/36 we changedthe table builder to pad cells. This commit changes tests(and two readers) to accord with this behavior.
Set default extensions for
beamer
same aslatex
.LaTeX template:
- Add
beameroption
variable (#4359, Étienne Bersac). - Use
pgfpages
package; this is needed for notes on secondscreen in beamer (Étienne Bersac). - Add
background-image
variable (#4601, John Muccigrosso).
- Add
reveal.js template: Add
background-image
variable (#4600,John Muccigrosso).ms template: Fix date. Previously
.ND
was used, but this onlyworks 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 pandocwas compiled withembed_data_files
(and sometimes it lookedin a nonexistent build directory). Now the bash completionscript just includes a hard-coded list of data file names.MANUAL:
- Clarify template vs metadata variables (#4501, Mauro Bieg).
- Fix raw content example (#4479, Mauro Bieg).
- Specify that you use html for raw output in epub.
- Add examples for raw docx blocks (#4472, Tristan Stenner).The documentation states that the target format name should matchthe output format, which isn't the case for
docx
/openxml
andsome others. - Don't say that
empty_paragraphs
affects markdown output (#4540). - Consolidate input/output format documentation (#4577, Mauro Bieg).
New README template. Take in/out formats from manual.
Fix example in lua-filters docs (#4459, HeirOfNorton).
Use the
-threaded
GHC flag when building benchmarks (#4587,Francesco Occhipinti).Bump temporary upper bound to 1.4.
Use pandoc-citeproc 0.14.3.1.
Use texmath-0.10.1.2 (fixes escapes in math in ms, #4597).
Removed old lib directory. This was used for something long ago,but plays no role now.
Removed unneeded data file
LaTeXMathML.js
.Create 64- and 32-bit versions of Windows binary packages.
pandoc 2.1.3 (2018-03-18)
Docx reader (Jesse Rosenthal):
- Add tests for nested smart tags.
- Parse nested smart tags.
- Make unwrapSDT into a general
unwrap
function that can unwrap bothnested SDT tags and smartTags. This makes the SmartTags constructor inthe Docx type unnecessary, so we remove it (#4446). - Remove unused
docxWarnings
(Alexander Krotov).
RST reader: Allow unicode bullet characters (#4454).
Haddock reader: Better table handling, using haddock-library'snew table support, if compiled against a version thatincludes it. Note that tables with col/rowspans will nottranslate well into Pandoc.
Muse reader (Alexander Krotov):
- Various internal improvements.
- Require closing tag to have the same indentation as opening.
- Do not reparse blocks inside unclosed block tag (#4425).
- Parse
<class>
tag (supported by Emacs Muse). - Do not produce empty Str element for unindented verse lines.
LaTeX reader:
- Add support to parse unit string of
\SI
command (closes #4296,Marc Schreiber).
- Add support to parse unit string of
Haddock writer: In the writer, we now render tables always asgrid tables, since Haddock supports these.
DokuWiki writer: rewrite backSlashLineBreaks (#4445, Mauro Bieg).
Docx writer: Fixed formatting of
DefaultStyle
ordered lists indocx writer. We want decimal for the top level, not lower roman.RST writer:
- Strip whitespace at beginning and ending of inline containers(#4327, Francesco Occhipinti).
- Filter out empty inline containers (#4434). There is nothing inRST that corresponds to e.g.
Emph []
, so we just ignore elementslike this (Francesco Occhipinti).
Muse writer (Alexander Krotov):
- Support spans with anchors.
- Replace smallcaps with emphasis before normalization.
- Output smallcaps as emphasis.
- Expand Cite before list normalization.
- Write empty inline lists as
<verbatim></verbatim>
. - Remove empty Str from the beginning of inline lists during normalization.
- Escape "-" to avoid creating bullet lists.
- Fix math expansion for more than one expression per paragraph.
- Expand math before inline list normalization.
Dokuwiki writer: fix LineBreaks in Tables (#4313, Mauro Bieg).
Ms writer:
- Asciify pdf anchors, since unicode anchors don't work (#4436).Internal links should be converted automatically, so this shouldn'taffect users directly.
- Don't escape hyphens as
\-
; that's for a minus sign (#4467).
Beamer writer: put hyperlink after
\begin{frame}
and not in the title(#4307). If it's in the title, then we get a titlebar on slides withtheplain
attribute, when the id is non-null. This fixes a regressionin 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, MauroBieg). This helps ensure that linked resources are included.
Add Semigroup instances for everything for which we defined aMonoid instance previously (API change):
- Text.Pandoc.Class.FileTree.
- Text.Pandoc.Translations.Translations.
- Text.Pandoc.Extensions.Extensions.
- Text.Pandoc.Readers.Odt.StyleReader.Styles.
- Text.Pandoc.Pretty.Doc.
- Text.Pandoc.MediaBag.MediaBag.
Add custom Prelude to give clean code for Monoid and Semigroupthat works with ghc 7.10-8.4. The custom Prelude (
prelude/Prelude
)is used for ghc versions < 8.4.NoImplicitPrelude
is usedin all source files, and Prelude is explicitly imported(this is necessary for ghci to work properly with the custom prelude).Text.Pandoc.Writers.Shared (Francesco Occhipinti):
- Export
stripLeadingTrailingSpace
. - Don't wrap lines in grid tables when
--wrap=none
(#4320). gridTable
: Don't wrap lines in tables when--wrap=none
. Instead,expand cells, even if it results in cells that don't respect relativewidths or surpass page column width. This change affects RST,Markdown, and Haddock writers.
- Export
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 aclash whenpolyglossia
loads it first and then it is loaded againfor XeLaTeX.ConTeXt template: Added
pdfa
variable to generate PDF/A (#4294, HenriMenke). Instructions on how to install the ICC profiles on ConTeXtstandalone can be found in the wiki:http://wiki.contextgarden.net/PDFX#ICC_profiles.If the ICC profiles are not available the log will contain errormessages.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-extensionsis consistentlyNoImplicitPrelude
. Everything else to be specifiedin 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.Removeweigh-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, JohnMuccigrosso).
appveyor: use VS 2013 environment instead of VS 2015 for Windows builds.
pandoc 2.1.2 (2018-03-02)
Markdown reader:
- Fix parsing bug with nested fenced divs (#4281). Previously we allowed"nonindent spaces" before the opening and closing
:::
, but thisinterfered with list parsing, so now we require the fences to be flush withthe margin of the containing block.
- Fix parsing bug with nested fenced divs (#4281). Previously we allowed"nonindent spaces" before the opening and closing
Commonmark reader:
raw_html
is now on by default. It can be disabled explicitlyusing-f commonmark-raw_html
.
Org reader (Albert Krewinkel):
Move citation tests to separate module.
Allow changing emphasis syntax (#4378). The characters allowed beforeand after emphasis can be configured via
#+pandoc-emphasis-pre
and#+pandoc-emphasis-post
, respectively. This allows to change whichstrings are recognized as emphasized text on a per-document or evenper-paragraph basis. Example:#+pandoc-emphasis-pre: "-\t ('\"{"#+pandoc-emphasis-post: "-\t\n .,:!?;'\")}["
LaTeX reader:
- Fixed comments inside citations (#4374).
- Fix regression in package options including underscore (#4424).
- Make
--trace
work. - Fixed parsing of
tabular*
environment (#4279).
RST reader:
- Fix regression in parsing of headers with trailing space (#4280).
Muse reader (Alexander Krotov):
- Enable
<literal>
tags even if amuse extension is enabled.Amusewiki disables tags for security reasons.If user wants similar behavior in pandoc, RawBlocks and RawInlinescan be removed or replaced with filters. - Remove space prefix from
<literal>
tag contents. - Do not consume whitespace while looking for closing end tag.
- Convert alphabetical list markers to decimal in round-trip test.Alphabetical lists are an addition of Text::Amuse.They are not present in Emacs Muse and can be ambiguouswhen list starts with "i.", "c." etc.
- Allow
<quote>
and other tags to be indented. - Allow single colon in definition list term.
- Fix parsing of verse in lists.
- Improved parsing efficiency. Avoid
parseFromString
.Lists are parsed in linear instead of exponential time now. - Replace ParserState with MuseState.
- Prioritize lists with roman numerals over alphabetical lists.This is to make sure "i." starts a roman numbered list,instead of a list with letter "i" (followed by "j", "k", ...").
- Fix directive parsing.
- Parse definition lists with multiple descriptions.
- Parse next list item before parsing more item contents.
- Fixed a bug: headers did not terminate lists.
- Move indentation parsing from
definitionListItem
todefinitionList
. - Paragraph indentation does not indicate nested quote.Muse allows indentation to indicate quotation or alignment,but only on the top level, not within a or list.
- Require that block tags are on separate lines.Text::Amuse already explicitly requires it anyway.
- Fix matching of closing inline tags.
- Various internal changes.
- Fix parsing of nested definition lists.
- Require only one space for nested definition list indentation.
- Do not remove trailing whitespace from
<code>
. - Fix parsing of trailing whitespace. Newline after whitespace nowresults in softbreak instead of space.
- Enable
Docx reader (Jesse Rosenthal, except where noted):
- Handle nested sdt tags (#4415).
- Don't look up dependant run styles if
+styles
is enabled. - Move pandoc inline styling inside custom-style span.
- Read custom styles (#1843). This will read all paragraph andcharacter classes as divs and spans, respectively. Dependent styleswill still be resolved, but will be wrapped with appropriate styletags. It is controlled by the
+styles
extension (-f docx+styles
).This can be used in conjunction with thecustom-style
feature in thedocx writer for a pandoc-docx editing workflow. Users can convert froman input docx, reading the custom-styles, and then use that same inputdocx file as a reference-doc for producing an output docx file. Styleswill be maintained across the conversion, even if pandoc doesn'tunderstand them. - Small change to Fields hyperlink parser. Previously, unquoted stringrequired a space at the end of the line (and consumed it). Now weeither take a space (and don't consume it), or end of input.
- Pick table width from the longest row or header (Francesco Occhipinti,#4360).
Muse writer (Alexander Krotov):
- Change verse markup:
>
instead of<verse>
tag. - Remove empty strings during inline normalization.
- Don't indent nested definition lists.
- Use unicode quotes for quoted text.
- Write image width specified in percent in Text::Amuse mode.
- Don't wrap displayMath into
<verse>
. - Escape nonbreaking space (
~~
). - Join code with different attributes during normalization.
- Indent lists inside Div.
- Support definitions with multiple descriptions.
- Change verse markup:
Powerpoint writer (Jesse Rosenthal):
- Use table styles This will use the default table style in thereference-doc file. As a result they will be easier when usingin a template, and match the color scheme.
- Remove empty slides. Because of the way that slides were split, thesecould be accidentally produced by comments after images. When animationsare added, there will be a way to add an empty slide with eitherincremental lists or pauses.
- Implement syntax highlighting. Note that background colors can'tbe implemented in PowerPoint, so highlighting styles that requirethese will be incomplete.
- New test framework for pptx. We now compare the output of thePowerpoint writer with files that we know to (a) not be corrupt,and (b) to show the desired output behavior (details below).
- Add
notesMaster
topresentation.xml
if necessary. - Ignore links and (end)notes in speaker notes.
- Output speaker notes.
- Read speaker note templates conditionally. If there are speakernotes in the presentation, we read in the notesMasters templatesfrom the reference pptx file.
- Fix deletion track changes (#4303, Jesse Rosenthal).
Markdown writer: properly escape @ to avoid capture as citation(#4366).
LaTeX writer:
- Put hypertarget inside figure environment (#4388).This works around a problem with the endfloat package andmakes pandoc's output compatible with it.
- Fix image height with percentage (#4389). This previously causedthe image to be resized to a percentage of textwidth, rather thantextheight.
ConTeXt writer (Henri Menke):
- New section syntax and support
--section-divs
(#2609).\section[my-header]{My Header}
->\section[title={My Header},reference={my-header}]
.The ConTeXt writer now supports the--section-divs
option towrite sections in the fenced style, with\startsection
and\stopsection
. - xtables: correct wrong usage of caption (Henri Menke).
- New section syntax and support
Docx writer:
- Fix image resizing with multiple images (#3930, Andrew Pritchard).
- Use new golden framework (Jesse Rosenthal).
- Make more deterministic to facilitate testing (Jesse Rosenthal).
getUniqueId
now calls to the state to get an incremented digit,instead of calling to P.uniqueHash.- we always start the PRNG in mkNumbering/mkAbstractNum with the sameseed (1848), so our randoms should be the same each time.
- Fix ids in comment writing (Jesse Rosenthal). Comments from
--track-changes=all
were producing corrupt docx, because thewriter was trying to get id from the(ID,_,_)
field ofthe attributes, and ignoring the "id" entry in the key-value pairs. Wenow check both.
Ms writer: Added papersize variable.
TEI writer:
- Use
height
instead ofdepth
for images (#4331). - Ensure that id prefix is always used.
- Don't emit
role
attribute; that was a leftover from theDocbook writer. - Use 'xml:id', not 'id' attribute (#4371).
- Use
AsciiDoc writer:
- Do not output implicit heading IDs (#4363, AlexanderKrotov). Convert to
asciidoc-auto_identifiers
for old behaviour.
- Do not output implicit heading IDs (#4363, AlexanderKrotov). Convert to
RST writer:
- Remove
blockToRST'
moving its logic intofixBlocks
(Francesco Occhipinti). - Insert comment between lists and quotes (#4248, Francesco Occchipinti).
- Remove
RST template: remove definition of 'math' role as raw.This used to be needed prior to v 0.8 of docutils, butnow math support is built-in.
Slides: Use divs to set incremental/non-incremental (#4381,Jesse Rosenthal). The old method (list inside blockquote) stillworks, but we are encouraging the use of divs with class
incremental
ornonincremental
.Text.Pandoc.ImageSize:
- Make image size detection for PDFs more robust (#4322).
- Determine image size for PDFs (#4322).
- EMF Image size support (#4375, Andrew Pritchard).
Text.Pandoc.Extensions:
- Add
Ext_styles
(Jesse Rosenthal, API change). This will be used inthe docx reader (defaulting to off) to read pargraph and characterstyles not understood by pandoc (as divs and spans, respectively). - Made
Ext_raw_html
default forcommonmark
format.
- Add
Text.Pandoc.Parsing:
- Export
manyUntil
(Alexander Krotov, API change). - Export improved
sepBy1
(Alexander Krotov). - Export list marker parsers:
upperRoman
,lowerRoman
,decimal
,lowerAlpha
,upperAlpha
(Alexander Krotov, API change).
- Export
Tests/Lua: fix tests on windows (Albert Krewinkel).
Lua: register script name in global variable (#4393). The name of the Luascript 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 outthe basic testing function so it can be used for docx as well. Thisshould allow us to catch some errors in the docx writer that slippedby the roundtrip testing.
Lua filters: store constructors in registry (Albert Krewinkel). Luafunctions used to construct AST element values are stored in the Luaregistry for quicker access. Getting a value from the registry is muchfaster than getting a global value (partly to idiosyncrasies of hslua);this change results in a considerable performance boost.
Documentation:
doc/org.md
Add draft of Org-mode documentation (Albert Krewinkel).doc/lua-filters.md
: document global vars set for filters(Albert Krewinkel).- INSTALL.md: mention Stack version. (#4343, Adam Brandizzi).
- MANUAL: add documentation on custom styles (Jesse Rosenthal).
- MANUAL.txt: Document incremental and nonincremental divs (JesseRosenthal). Blockquoted lists are still described, but fenced divs arepresented in preference.
- MANUAL.txt: document header and footer variables (newmana).
- MANUAL.txt: self-contained implies standalone (#4304, Daniel Lublin).
- CONTRIBUTING.md: label was renamed. (#4310, Alexander Brandizzi).
Require tagsoup 0.14.3 (#4282), fixing HTML tokenization bug.
Use latest texmath.
Use latest pandoc-citeproc.
Allow exceptions 0.9.
Require aeson-pretty 0.8.5 (#4394).
Bump blaze-markup, blaze-html lower bounds to 0.8, 0.9 (#4334).
Update tagsoup to 0.14.6 (Alexander Krotov, #4282).
Removed ghc-prof-options. As of cabal 1.24, sensible defaults are used.
Update default.nix to current nixpkgs-unstable for hslua-0.9.5 (#4348,jarlg).
pandoc 2.1.1 (2018-01-18)
Markdown reader:
- Don't coalesce adjacent raw LaTeX blocks if they are separated by ablank line. See lierdakil/pandoc-crossref#160.
- Improved
inlinesInBalancedBrackets
(#4272, jgm/pandoc-citeproc#315).The change both improves performance and fixes a regression wherebynormal citations inside inline notes and figure captions were notparsed correctly.
RST reader:
- Better handling for headers with an anchor (#4240). Instead of creating aDiv containing the header, we put the id directly on the header.This way header promotion will work properly.
- Add aligned environment when needed in math (#4254).
rst2latex.py
uses analign*
environment for math in.. math::
blocks, so thismath may contain line breaks. If it does, we put the math in analigned
environment to simulaterst2latex.py
's behavior.
HTML reader:
- Fix col width parsing for percentages < 10% (#4262, n3fariox).
LaTeX reader:
- Advance source position at end of stream.
- Pass through macro defs in
rawLaTeXBlock
even if thelatex_macros
extension is set (#4246). This reverts to earlier behavior and isprobably safer on the whole, since some macros only modify things inincluded 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 intoan infinite loop with
\newcommand{\noop}[1]{#1}\noop{\newcommand{\foo}[1]{#1}}\foo{hi}
- Fix inconsistent column widths (#4238). This fixes a bug whereby columnwidths for the body were different from widths for the header in sometables.
Docx reader (Jesse Rosenthal):
- Parse hyperlinks in
instrText
tags (#3389, #4266). This was a form ofhyperlink found in older versions of word. The changes introduced forthis, 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
whichcontains a simple parsec parser. At the moment, only simple hyperlinkfields are accepted, but that can be extended in the future.
- Parse hyperlinks in
Muse reader (Alexander Krotov):
- Parse
~~
as non-breaking space in Text::Amuse mode. - Refactor list parsing.
- Parse
Powerpoint writer (Jesse Rosenthal):
- Change reference to
notesSlide
toendNotesSlide
. - Move image sizing into
picProps
. - Improve table placement.
- Make our own
_rels/.rels
file. - Import reference-doc images properly.
- Move
Presentation.hs
out ofPandocMonad
. - Refactor into separate modules. T.P.W.Powerpoint.Presentationdefines the Presentation datatype and goes Pandoc->Presentation;T.P.W.Pandoc.Output goes Presentation->Archive.Text.Pandoc.Writers.Powerpoint a thin wrapper around the two modules.
- Avoid overlapping blocks in column output.
- Position images correctly in two-column layout.
- Make content shape retrieval environment-aware.
- Improve image handling. We now determine image and caption placementby getting the dimensions of the content box in a given layout.This allows for images to be correctly sized and positioned in adifferent template. Note that images without captions and headers areno longer full-screened. We can't do this dependably in differentlayouts, because we don't know where the header is (it could be tothe side of the content, for example).
- Read presentation size from reference file. Our presentation size isnow dependent on the reference/template file we use.
- Handle (sub)headers above slidelevel correctly. Above the slidelevel,subheaders will be printed in bold and given a bit of extra spacebefore them. Note that at the moment, no distinction is made betweenlevels of headers above the slide header, though that can be changed.
- Check for required files. Since we now import from reference/distfile by glob, we need to make sure that we're getting the files weneed to make a non-corrupt Powerpoint. This performs that check.
- Improve templating using
--reference-doc
. Templating should workmuch more reliably now. - Include Notes slide in TOC.
- Set notes slide header to slide-level.
- Add table of contents. This is triggered by the
--toc
flag. Notethat in a long slide deck this risks overrunning the text box. The usercan address this by setting--toc-depth=1
. - Set notes slide number correctly.
- Clean up adding metadata slide. We want to count the slide numberscorrectly if it's in there.
- Add anchor links. For anchor-type links (
[foo](#bar)
) we producean anchor link. In powerpoint these are links to slides, so we keeptrack of a map relating anchors to the slides they occur on. - Make the slide number available to the blocks. For anchors,block-processing functions need to know what slide numberthey're in. We make the
envCurSlideId
available to blocks. - Move
curSlideId
to environment. - Allow setting
toc-title
in metadata. - Link notes to endnotes slide.
- Change reference to
Markdown writer:
- Fix cell width calculation (#4265). Previously we could getever-lengthening cell widths when a table was run repeatedly through
pandoc -f markdown -t markdown
.
- Fix cell width calculation (#4265). Previously we could getever-lengthening cell widths when a table was run repeatedly through
LaTeX writer:
- Escape
&
in lstinline (Robert Schütz).
- Escape
ConTeXt writer:
- Use xtables instead of Tables (#4223, Henri Menke).Default to xtables for context output. Natural Tables are usedif the new
ntb
extension is set.
- Use xtables instead of Tables (#4223, Henri Menke).Default to xtables for context output. Natural Tables are usedif the new
HTML writer:
- Fixed footnote backlinks with
--id-prefix
(#4235).
- Fixed footnote backlinks with
Text.Pandoc.Extensions
: AddedExt_ntb
constructor (API change,Henri Menke).Text.Pandoc.ImageSize
: add derivedEq
instance toDimension
(Jesse Rosenthal, API change).Lua filters (Albert Krewinkel):
- Make
PANDOC_READER_OPTIONS
available.The options which were used to read the document are made available toLua filters via thePANDOC_READER_OPTIONS
global. - Add lua module
pandoc.utils.run_json_filter
, which runs a JSON filteron a Pandoc document. - Refactor filter-handling code into
Text.Pandoc.Filter.JSON
,Text.Pandoc.Filter.Lua
, andText.Pandoc.Filter.Path
. - Improve error messages. Provide more context about the taskwhich caused an error.
- Make
data/pandoc.lua (Albert Krewinkel):
- Accept singleton inline as a list. Every constructor which accepts alist of inlines now also accepts a single inline element forconvenience.
- Accept single block as singleton list. Every constructor which acceptsa list of blocks now also accepts a single block element forconvenience. Furthermore, strings are accepted as shorthand for
{pandoc.Str "text"}
in constructors. - Add attr, listAttributes accessors. Elements withattributes got an additional
attr
accessor. Attributes wereaccessible only via theidentifier
,classes
, andattributes
,which was in conflict with the documentation, which indirectly statesthat such elements have the anattr
property. - Drop
_VERSION
. Having a_VERSION
became superfluous, as thismodule is closely tied to the pandoc version, which is available viaPANDOC_VERSION
. - Fix access to Attr components. Accessing an Attr value (e.g.,
Attr().classes
) was broken; the more common case of accessing it viaan Inline or Block element was unaffected by this.
Move
metaValueToInlines
to from Docx writer toText.Pandoc.Writers.Shared
, so it can be used by other writers(Jesse Rosenthal).MANUAL.txt:
- Clarify otherlangs in LaTeX (#4072).
- Clarify
latex_macros
extension. - Recommend use of
raw_attribute
extension in header includes (#4253).
Allow latest QuickCheck, tasty, criterion.
Remove custom prelude and ghc 7.8 support.
Reduce compiler noise (exact paths for compiled modules).
pandoc 2.1 (2018-01-07)
Allow filters and lua filters to be interspersed (#4196). Previouslywe ran all lua filters before JSON filters. Now we run filters inthe order they are presented on the command line, whether lua or JSON.There are two incompatible API changes: The type of
applyFilters
has changed, andapplyLuaFilters
has been removed.Filter
isalso now exported.Use latest skylighting and omit the
missingIncludes
check, fixinga major performance regression in earlier releases of the 2.x series(#4226). Behavior change: If you use a custom syntax definition thatrefers to a syntax you haven't loaded, pandoc will now complain whenit is highlighting the text, rather than doing a check at the start.This change dramatically speeds up invocations of pandoc on shortinputs.Text.Pandoc.Class: make
FileTree
opaque (don't exportFileTree
constructor). This forces users to interact with it usinginsertInFileTree
andgetFileInfo
, which normalize file names.Markdown reader:
- Rewrite
inlinesInBalancedBrackets
. The rewrite is much moredirect, avoidingparseFromString
. And it performs significantlybetter; unfortunately, parsing time still increases exponentially(see #1735). - Avoid parsing raw tex unless
\
+ letter seen. This seems tohelp with the performance problem, #4216.
- Rewrite
LaTeX reader: Simplified a check for raw tex command.
Muse reader (Alexander Krotov):
- Enable round trip test (#4107).
- Automatically translate
#cover
into#cover-image
.Amusewiki uses #cover directive to specify cover image.
Docx reader (Jesse Rosenthal):
- Allow for insertion/deletion of paragraphs (#3927).If the paragraph has a deleted or inserted paragraph break (dependingon the track-changes setting) we hold onto it until the nextparagraph. This takes care of accept and reject. For this we introducea new state which holds the ils from the previous para if necessary.For
--track-changes=all
, we add an empty span with classparagraph-insertion
/paragraph-deletion
at the end of the paragraphprior to the break to be inserted or deleted. - Remove unused anchors (#3679). Docx produces a lot of anchors withnothing pointing to them---we now remove these to produce cleaneroutput. Note that this has to occur at the end of the processbecause it has to follow link/anchor rewriting.
- Read multiple children of
w:sdtContents
. - Combine adjacent anchors. There isn't any reason to have numerousanchors in the same place, since we can't maintain docx'snon-nesting overlapping. So we reduce to a single anchor.
- Improved tests.
- Allow for insertion/deletion of paragraphs (#3927).If the paragraph has a deleted or inserted paragraph break (dependingon the track-changes setting) we hold onto it until the nextparagraph. This takes care of accept and reject. For this we introducea new state which holds the ils from the previous para if necessary.For
Muse writer (Alexander Krotov): don't escape URIs from AST
Docx writer:
- Removed redundant subtitle in title (Sebastian Talmon).
firstRow
table definition compatibility for Word 2016 (SebastianTalmon). Word 2016 seems to use a default value of "1" for tableheaders, if there is no firstRow definition (although a defaultvalue of 0 is documented), so all tables get the first Row formattedas header. Setting the parameter to 0 if the table has no headerrow fixes this for Word 2016- Fix custom styles with spaces in the name (#3290).
Powerpoint writer (Jesse Rosenthal):
- Ignore Notes div for parity with other slide outputs.
- Set default slidelevel correctly. We had previously defaulted toslideLevel 2. Now we use the correct behavior of defaulting to thehighest level header followed by content. We change an expected testresult to match this behavior.
- Split blocks correctly for linked images.
- Combine adjacent runs.
- Make inline code inherit code size. Previously (a) the code sizewasn't set when we force size, and (b) the properties was set fromthe default, instead of inheriting.
- Simplify
replaceNamedChildren
function. - Allow linked images. The following markdown:
[![Image Title](image.jpg)](http://www.example.com)
will now produce a linked image in the resulting PowerPoint file. - Fix error with empty table cell. We require an empty
<a:p>
tag,even if the cell contains no paragraphs---otherwise PowerPointcomplains of corruption. - Implement two-column slides. This uses the columns/column divformat described in the pandoc manual. At the moment, only twocolumns (half the screen each) are allowed. Custom widths are notsupported.
- Added more tests.
OpenDocument/ODT writers: improved rendering of formulas (#4170, oltolm).
Lua filters (Albert Krewinkel):
data/pandoc.lua
: drop 'pandoc-api-version' from Pandoc objects- The current pandoc-types version is made available to Lua programs inthe global
PANDOC_API_VERSION
. It contains the version as a list ofnumbers. - The pandoc version available as a global
PANDOC_VERSION
(a listof numbers). data/pandoc.lua
: makeAttr
anAstElement
.data/pandoc.lua
: make all types subtypes ofAstElement
.Pandoc
,Meta
, andCitation
were just plain functions and didnot set a metatable on the returned value, which made it difficultto amend objects of these types with new behavior. They are nowsubtypes of AstElement, meaning that all their objects can gainnew features when a method is added to the behavior object(e.g.,pandoc.Pandoc.behavior
).data/pandoc.lua
: split type and behavior tables. Clearly distinguishbetween a type and the behavioral properties of an instance of thattype. The behavior of a type (and all its subtypes) can now beamended by adding methods to that typesbehavior
object, withoutexposing the type objects internals. E.g.:pandoc.Inline.behavior.frob = function () print'42' endlocal str = pandoc.Str'hello'str.frob() -- outputs '42'
data/pandoc.lua
: fix Element inheritance. Extending all elementsof a given type (e.g., all inline elements) was difficult, as thetable used to lookup unknown methods would be reset every time anew element of that type was created, preventing recursive propertylookup. This is was changed in that all methods and attributes ofsupertypes are now available to their subtypes.data/pandoc.lua
: fix attribute names of Citation (#4222). Thefields were named like the Haskell fields, not like the documented,shorter version. The names are changed to match the documentationand Citations are given a shared metatable to enable simpleextensibility.data/pandoc.lua
: drop functionpandoc.global_filter
.- Bump
hslua
version to 0.9.5. This version fixes a bug that made itdifficult to handle failures while getting lists or a Map from Lua.A bug in pandoc, which made it necessary to always pass a tag whenusing MetaList or MetaBlock, is fixed as a result. Using the pandocmodule's constructor functions for these values is now optional(if still recommended). - Stop exporting
pushPandocModule
(API change). The introductionofrunPandocLua
renders direct use of this function obsolete. - Update generation of module docs for lua filters.
Lua.Module.Utils
: make stringify work onMetaValues
(JohnMacFarlane). I'm sure this was intended in the first place,but currently onlyMeta
is supported.
Improve benchmarks.
- Set the default extensions properly.
- Improve benchmark argument parsing. You can now say
make bench BENCHARGS="markdown latex reader"
and both themarkdown 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 changesto MANUAL.txt have been made.Update copyright notices to include 2018 (Albert Krewinkel).
pandoc 2.0.6 (2017-12-28)
Added
jats
as an input format.- Add Text.Pandoc.Readers.JATS, exporting
readJATS
(APIchange) (Hamish Mackenzie). - Improved citation handling in JATS reader. JATS citationsare now converted to pandoc citations, and JATS ref-listsare converted into a
references
field in metadata, suitablefor use with pandoc-citeproc. Thus a JATS article with embeddedbibliographic information can be processed with pandoc andpandoc-citeproc to produce a formatted bibliography.
- Add Text.Pandoc.Readers.JATS, exporting
Allow
--list-extensions
to take an optional FORMAT argument.This lists the extensions set by default for the selected FORMAT.The extensions are now alphabetized, and the+
or-
indicating the default setting comes before, rather than after,the extension.Markdown reader:
- Preserve original whitespace between blocks.
- Recognize
\placeformula
as context. - Be pickier about table captions. A caption starts with a
:
whichcan't be followed by punctuation. Otherwise we can falsely interpretthe start of a fenced div, or even a table header line like:--:|:--:
, as a caption. - Always use four space rule for example lists. It would be awkwardto indent example list contents to the first non-space character afterthe label, since example list labels are often long. Thanks toBernhard Fisseni for the suggestion.
- Improve raw tex parsing. Note that the Markdown reader is alsoaffected by the
latex_macros
extension changes described belowunder the LaTeX reader.
LaTeX reader:
latex_macros
extension changes (#4179). Don't pass through macrodefinitions themselves whenlatex_macros
is set. The macroshave already been applied. Iflatex_macros
is enabled, thenrawLaTeXBlock
in Text.Pandoc.Readers.LaTeX will succeed in parsinga macro definition, and will update pandoc's internal macro mapaccordingly, but the empty string will be returned.- Export
tokenize
,untokenize
(API change). - Use
applyMacros
inrawLaTeXBlock
,rawLaTeXInline
. - Refactored
inlineCommand
. - Fix bug in tokenizer. Material following
^^
wasdropped if it wasn't a character escape. This only affectedinvalid LaTeX, so we didn't see it in the wild, but it appearedin a QuickCheck test failure. - Fix regression in LateX tokenization (#4159). This mainly affects theMarkdown reader when parsing raw LaTeX with escaped spaces.
- Add tests of LaTeX tokenizer.
- Support
\foreignlanguage
from babel. - Be more tolerant of
&
character (#4208). This allows us to parseunknown tabular environments as raw LaTeX.
Muse reader (Alexander Krotov):
- Parse anchors immediately after headings as IDs.
- Require that note references does not start with 0.
- Parse empty comments correctly.
Org reader (Albert Krewinkel):
- Fix asterisks-related parsing error (#4180).
- Support minlevel option for includes (#4154). The level of headersin included files can be shifted to a higher level by specifying aminimum header level via the
:minlevel
parameter. E.g.#+include: "tour.org" :minlevel 1
will shift the headers intour.org such that the topmost headers become level 1 headers. - Break-up org reader test file into multiple modules.
OPML reader:
- Enable raw HTML and other extensions by default for notes(#4164). This fixes a regression in 2.0. Note that extensions cannow be individually disabled, e.g.
-f opml-smart-raw_html
.
- Enable raw HTML and other extensions by default for notes(#4164). This fixes a regression in 2.0. Note that extensions cannow be individually disabled, e.g.
RST reader:
- Allow empty list items (#4193).
- More accurate parsing of references (#4156). Previously we erroneouslyincluded the enclosing backticks in a reference ID (#4156). Thischange also disables interpretation of syntax inside references, asin docutils. So, there is no emphasis in
`my *link*`_
.
Docx reader:
- Continue lists after interruption (#4025, Jesse Rosenthal).Docx expects that lists will continue where they left off after aninterruption and introduces a new id if a list is starting again. Sowe keep track of the state of lists and use them to define a "start"attribute, if necessary.
- Add tests for structured document tags unwrapping (Jesse Rosenthal).
- Preprocess Document body to unwrap
w:sdt
elements (Jesse Rosenthal,#4190).
Plain writer:
- Don't linkify table of contents.
RST writer:
- Fix anchors for headers (#4188). We were missing an
_
.
- Fix anchors for headers (#4188). We were missing an
PowerPoint writer (Jesse Rosenthal):
- Treat lists inside BlockQuotes as lists. We don't yet produceincremental lists in PowerPoint, but we should at least treat listsinside BlockQuotes as lists, for compatibility with other slide formats.
- Add ability to force size. This replaces the more specific
blockQuote runProp
, which only affected the size of blockquotes. Wecan use this for notes, etc. - Implement notes. This currently prints all notes on a final slide.Note that at the moment, there is a danger of text overflowing thenote slide, since there is no logic for adding further slides.
- Implement basic definition list functionality to PowerPoint writer.
- Don't look for default template file for Powerpoint (#4181).
- Add pptx to isTextFormat list. This is used to check standaloneand not writing to the terminal.
- Obey slide level option (Jesse Rosenthal).
- Introduce tests.
Docx writer:
- Ensure that
distArchive
is the one that comes with pandoc(#4182). Previously areference.docx
in~/.pandoc
(or the user datadir) would be used instead, and this could cause problems because auser-modified docx sometimes lacks vital sections that we counton thedistArchive
to supply.
- Ensure that
Org writer:
- Do not wrap "-" to avoid accidental bullet lists (Alexander Krotov).
- Don't allow fn refs to wrap to beginning of line (#4171, with help fromAlexander Krotov). Otherwise they can be interpreted as footnotedefinitions.
Muse writer (Alexander Krotov):
- Don't wrap note references to the next line (#4172).
HTML writer:
- Use br elements in line blocks instead of relying on CSS(#4162). HTML-based templates have had the custom CSS for
div.line-block
removed. Those maintaining custom templates will wantto remove this too. We still enclose line blocks in a div with classline-block
.
- Use br elements in line blocks instead of relying on CSS(#4162). HTML-based templates have had the custom CSS for
LaTeX writer:
- Use
\renewcommand
for\textlatin
with babel (#4161).This avoids a clash with a deprecated\textlatin
command definedin Babel. - Allow fragile=singleslide attribute in beamer slides (#4169).
- Use
\endhead
after\toprule
in headerless tables (#4207).
- Use
FB2 writer:
- Add cover image specified by
cover-image
meta (Alexander Krotov,#4195).
- Add cover image specified by
JATS writer (Hamish Mackenzie):
- Support writing
<fig>
and<table-wrap>
elementswith<title>
and<caption>
inside them by using Divs with class setto one offig
,table-wrap
orcaption
(Hamish Mackenzie). Thetitle is included as a Heading so the constraint on where Heading canoccur is also relaxed. - Leave out empty alt attributes on links.
- Deduplicate image mime type code.
- Make
<p>
optional in<td>
and<th>
(#4178). - Self closing tags for empty xref (#4187).
- Improve support for code language.
- Support writing
Custom writer:
- Use init file to setup Lua interpreter (Albert Krewinkel).The same init file (
data/init
) that is used to setup the Luainterpreter for Lua filters is also used to setup the interpreter ofcustom writers.lua. - Define instances for newtype wrapper (Albert Krewinkel). The customwriter used its own
ToLuaStack
instance definitions, which madeit difficult to share code with Lua filters, as this could resultin conflicting instances. AStringify
wrapper is introduced toavoid this problem. - Added tests for custom writer.
- Fixed definition lists and tables in
data/sample.lua
.
- Use init file to setup Lua interpreter (Albert Krewinkel).The same init file (
Fixed regression: when target is PDF, writer extensions were beingignored. So, for example,
pandoc -t latex-smart -o file.pdf
did not work properly.Lua modules (Albert Krewinkel):
- Add
pandoc.utils
module, to hold utility functions. - Create a Haskell module Text.Pandoc.Lua.Module.Pandoc todefine the
pandoc
lua module. - Make a Haskell module for each Lua module. Move definitions for the
pandoc.mediabag
modules to a separate Haskell module. - Move
sha1
from the mainpandoc
module topandoc.utils
. - Add function
pandoc.utils.hierarchicalize
(convert list ofPandoc blocks into (hierarchical) list of Elements). - Add function
pandoc.utils.normalize_date
(parses a date andconverts it (if possible) to "YYYY-MM-DD" format). - Add function
pandoc.utils.to_roman_numeral
(allows conversionof numbers below 4000 into roman numerals). - Add function
pandoc.utils.stringify
(converts any AST elementto a string with formatting removed). data/init.lua
: loadpandoc.utils
by default- Turn pipe, read into full Haskell functions. The
pipe
andread
utility functions are converted from hybrid lua/haskell functionsinto full Haskell functions. This avoids the need for intermediate_pipe
/_read
helper functions, which have dropped. - pandoc.lua: re-add missing MetaMap function. This was a bugintroduced in version 2.0.4.
- Add
Text.Pandoc.Class: Add
insertInFileTree
[API change]. This givesa pure way to insert an ersatz file into aFileTree
. In addition, wenormalize 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 alwaysproperly UTF8-encoded (#4200).
Update latex template to work with recent versions of beamer.The old template produced numbered sections with some recentversions of beamer. Thanks to Thomas Hodgson.
Updated reference.docx (#4175). Instead of just "Hello, world", thedocument now contains exemplars of most of the styles that have aneffect on pandoc documents. This makes it easier to see the effectof style changes.
Removed
default.theme
data file (#4096). It is no longer needed nowthat 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, sincewe don't have ghc 8.2.2 for that yet.Removed
stack.pkg.yaml
. We only really needstack.yaml
; wecan put flag settings for pandoc-citeproc there.Makefile: Add 'trypandoc' and 'pandoc-templates' targets tomake releases easier.
MANUAL.txt:
- Add note on what formats have
+smart
by default. - Use native syntax for custom-style (#4174, Mauro Bieg).
- Introduce dedicated Extensions section, since some extensionsaffect formats other than markdown (Mauro Bieg, #4204).
- Clarify default html output for
--section-divs
(Richard Edwards).
- Add note on what formats have
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).
pandoc 2.0.5 (2017-12-12)
Fix a bug in 2.0.4, whereby pandoc could not read the theme filesgenerated with
--print-highlight-style
(#4133). Improve JSONserialization 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 onlyset these for classsourceCode
.--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 othersorts of slides. Caveats:
- Syntax highlighting is not yet implemented. (This is difficultbecause there are no character classes in Powerpoint.)
- Footnotes and Definition lists are not yet implemented. (Notes willusually take the form of a final slide.
- Image placement and auto-resizing has a few glitches.
- Reference powerpoint files don't work dependably from the commandline. This will be implemented, but at the moment users are advisedto change themes from within Powerpoint.
Create shared Text.Pandoc.Writers.OOXML module (Jesse Rosenthal).This is for functions used by both Powerpoint and Docx writers.
Add default pptx data for Powerpoint writer (Jesse Rosenthal).
Add
empty_paragraphs
extension.- Deprecate
--strip-empty-paragraphs
option. Instead we nowuse anempty_paragraphs
extension that can be enabled onthe reader or writer. By default, disabled. - Add
Ext_empty_paragraphs
constructor toExtension
. - Revert "Docx reader: don't strip out empty paragraphs."This reverts commit d6c58eb836f033a48955796de4d9ffb3b30e297b.
- Implement
empty_paragraphs
extension in docx reader and writer,opendocument writer, html reader and writer. - Add tests for
empty_paragraphs
extension.
- Deprecate
Markdown reader:
- Don't parse native div as table caption (#4119).
- Improved computation of column widths in pipe tables.Pipe tables with lines longer than the text width (as setby
--columns
) are now scaled to text width, with the relativewidths of columns determined by the ratios between theheader lines. Previously we computed column widths usingthe ratio of header line lengths to column width, so thattables with narrow header lines were extremely thin, whichwas 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 thetokenizer level.Muse reader (Alexander Krotov):
- Add test for
#disable-tables
directive in Emacs mode. - Don't allow emphasis to be preceded by letter.
- Add underline support in Emacs Muse mode..
- Support multiline directives in Amusewiki mode
- Add test for
Man writer: omit internal links (#4136). That is, just print the linktext without the URL.
Markdown reader: accept processing instructions as raw HTML (#4125).
Lua filters (Albert Krewinkel):
- Use script to initialize the interpreter. The file
init.lua
isused to initialize the Lua interpreter which is used in Lua filters.This gives users the option to require libraries which they want touse in all of their filters, and to extend default modules. - Fix package loading for Lua 5.1. The list of package searchers isnamed
package.loaders
in Lua 5.1 and LuaJIT, andpackage.searchers
in Lua 5.2 and later. - Refactor lua module handling. The integration with Lua's package/modulesystem is improved: A pandoc-specific package searcher is prepended tothe searchers in
package.searchers
. The modulespandoc
andpandoc.mediabag
can now be loaded viarequire
. - Bump lower bound of hslua. The release hslua 0.9.3 contains a newfunction which makes using Haskell functions as package loaders mucheasier.
- Use script to initialize the interpreter. The file
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 builderror on linux).
pandoc 2.0.4 (2017-12-03)
Add
--print-highlight-style
option. This generates a JSON versionof 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 whereempty paragraphs have been used for inter-paragraph spaces.Support
--webtex
forgfm
output.Recognize
.muse
file extension.Support beamer
\alert
in LaTeX reader. Closes #4091.Docx reader: don't strip out empty paragraphs (#2252).Users who have a conversion pipeline from docx may want to consider adding
--strip-empty-paragraphs
to the command line.Org reader (Albert Krewinkel): Allow empty list items (#4090).
Muse reader (Alexander Krotov):
- Parse markup in definition list terms.
- Allow definition to end with EOF.
- Make code blocks round trip.
- Drop common space prefix from list items.
- Add partial round trip test.
- Don't interpret XML entities.
- Remove
nested
. - Parse
~~
as non-breaking space in Emacs mode. - Correctly remove indentation from notes. Exactly one space isrequired and considered to be part of the marker.
- Allow list items to be empty.
- Add ordered list test.
- Add more multiline definition tests.
- Don't allow blockquotes within lists.
- Fix reading of multiline definitions.
- Add inline
<literal>
support. - Concatenate inlines of the same type
Docx writer: allow empty paragraphs (#2252).
CommonMark/gfm writer:
- Use raw html for native divs/spans (#4113). This allows a pandocmarkdown native div or span to be rendered in gfm using raw html tags.
- Implement
raw_html
andraw_tex
extensions. Note thatraw_html
is enabled by default forgfm
, whileraw_tex
is disabled by default.
Muse writer (Alexander Krotov):
- Test that inline math conversion result is normalized.Without normalization this test produced
<em>a</em><em>b</em><em>c</em>
. - Improve inline list normalization and move to writer.
- Escape hash symbol.
- Escape
----
to avoid accidental horizontal rules. - Escape only
</code>
inside code tag. - Additional
<verbatim>
is not needed as<code>
is verbatim already.
- Test that inline math conversion result is normalized.Without normalization this test produced
LaTeX writer:
- Allow specifying just width or height for image size.Previously both needed to be specified (unless the image wasbeing resized to be smaller than its original size).If height but not width is specified, we now set width totextwidth. If width but not height is specified, we now setheight to textheight. Since we have
keepaspectratio
, thisyields the desired result. - Escape
~
and_
in code with--listings
(#4111).
- Allow specifying just width or height for image size.Previously both needed to be specified (unless the image wasbeing resized to be smaller than its original size).If height but not width is specified, we now set width totextwidth. If width but not height is specified, we now setheight to textheight. Since we have
HTML writer: export
tagWithAttributes
. This is a helper allowingother writers to create single HTML tags.Let papersizes
a0
,a1
,a2
, ... be case-insensitive byconverting the case as needed in LaTeX and ConTeXt writers.Change
fixDisplayMath
fromText.Pandoc.Writers.Shared
so that it no longer produces emptyPara
's as an artifact.Text.Pandoc.Shared.blocksToInlines
: rewrote using builder.This gives us automatic normalization, so we don't getfor example two consecutive Spaces.Include default CSS for 'underline' class in HTML-based templates.
revealjs template: add
tex2jax
configuration for themath plugin. With the next release of reveal.js, this willfix the problem of$
s outside of math contexts beinginterpreted as math delimiters (#4027).pandoc.lua
module for use in lua filters (Albert Krewinkel):Add basic lua List module (#4099, #4081). The List module isautomatically loaded, but not assigned to a global variable. It can beincluded in filters by calling
List = require 'List'
. Lists of blocks,lists of inlines, and lists of classes are now givenList
as a metatable,making working with them more convenient. E.g., it is now possible toconcatenate lists of inlines using Lua's concatenation operator..
(requires at least one of the operants to haveList
as a metatable):function Emph (emph) local s = {pandoc.Space(), pandoc.Str 'emphasized'} return pandoc.Span(emph.content .. s)end
The
List
metatable is assigned to the tables which get passed tothe constructorsMetaBlocks
,MetaInline
, andMetaList
. Thisenables 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 respectiveconstructor functions of the pandoc Lua module. This makes serializationconsistent with the way blocks and inlines are pushed to lua and allowsto use List methods with theblocks
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 textwhen
numberLines
is used (#4103).Make
normalizeDate
more forgiving (Mauro Bieg, #4101), notrequiring a leading 0 on single-digit days.Fix
--help
output for--highlight-style
to includeFILE
(MauroBieg, #4095).Clearer deprecation warning for
--latexmathml, --asciimathml, -m
.Previously we only mentioned--latexmathml
, even if-m
wasused.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 dealwith files in the mediabag. The changelog is updated to describe thatfeature 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 inthe website repo.Add
packages
target to Makefile.Bump bounds for binary, http-types, tasty-hunit
pandoc 2.0.3 (2017-11-20)
Lua filters: preload text module (Albert Krewinkel, #4077).The
text
module is preloaded in lua. The module contains some UTF-8aware string functions, implemented in Haskell. The module is loaded onrequest only, e.g.:text = require 'text'function Str (s) s.text = text.upper(s.text) return send
Allow table-like access to attributes in lua filters (Albert Krewinkel,#4071). Attribute lists are represented as associative lists in Lua. Pureassociative lists are awkward to work with. A metatable is attached toattribute lists, allowing to access and use the associative list as ifthe attributes were stored in as normal key-value pair in table.Note that this changes the way
pairs
works on attribute lists. Insteadof producing integer keys and two-element tables, the resulting iteratorfunction now returns the key and value of those pairs. Useipairs
toget the old behavior. Warning: the new iteration mechanism only works ifpandoc 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 anempty attribute: for example,&a=&b=
wolud stop ata
.(The uri parser tries to guess which punctuation charactersare part of the URI and which might be punctuation after it.)Introduce
HasSyntaxExtensions
typeclass (Alexander Krotov, #4074).- Added new
HasSyntaxExtensions
typeclass forReaderOptions
andWriterOptions
. - Reimplemented
isEnabled
function fromOptions.hs
to accept bothReaderOptions
andWriterOptions
. - Replaced
enabled
fromCommonMark.hs
with newisEnabled
.
- Added new
Add
amuse
extension (Alexander Krotov) to enable Amuse wikibehavior formuse
. NewExt_amuse
constructor forExtension
. Note: this is switched on by default; forEmacs behavior, usemuse-amuse
.Muse reader (Alexander Krotov):
- Count only one space as part of list item marker.
- Produce SoftBreaks on newlines. Now wrapping can be preservedwith
--wrap=preserve
. - Add Text::Amuse footnote extensions. Footnote end is indicated byindentation, so footnotes can be placed anywhere in the text,not just at the end of it.
- Accept Emacs Muse definition lists when
-amuse
.Emacs Muse does not require indentation.
HTML reader:
- Ensure we don't produce level 0 headers (#4076), even for chaptersections in epubs. This causes problems because writers aren't setup to expect these.
- Allow spaces after
\(
and before\)
withtex_math_single_backslash
.Previously\( \frac{1}{a} < \frac{1}{b} \)
was not parsed as math inmarkdown
orhtml
+tex_math_single_backslash
.
MANUAL: clarify that math extensions work with HTML.Clarify that
tex_math_dollars
andtex_math_single_backslash
will work with HTML as well as Markdown.Creole reader: Fix performance issue for longer lists (Sascha Wilde,#4067).
RST reader: better support for 'container' directive (#4066).Create a div, incorporate name attribute and classes.
LaTeX reader:
- Support column specs like
*{2}{r}
(#4056). This is equivalent torr
. We now expand it like a macro. - Allow optional args for parbox (#4056).
- Allow optional arguments on
\footnote
(#4062).
- Support column specs like
EPUB writer: Fixed path for cover image (#4069). It was previously
media/media/imagename
, and should have beenmedia/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 polyglossialanguage to be defined.
Added examples to lua filters documentation.
pandoc 2.0.2 (2017-11-12)
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
andwalk_block
in the pandoc module, to apply filters inside particularinline and block elements.Refactored some code from
Text.Pandoc.Lua.PandocModule
into new internal moduleText.Pandoc.Lua.Filter
.Markdown reader:
- Allow fenced code blocks to be indented 1-3 spaces (#4011).This brings our handling of them into alignment with CommonMark's.
- Fix YAML metadata with "chomp" (
|-
). Previously if aYAML block under|-
contained a blank line, pandoc wouldnot parse it as metadata.
Removed
etc.
from abbreviations file. Oftenetc.
ends asentence, and we want the period to be treated as asentence-ending period.Fix regression with
--metadata
(#4054). Values specified with--metadata
should replace a metadata value set in the documentit*elf, rather than creating a list including a new value.EPUB writer:
- Fix EPUB OCF structure. #3720 had been improperly implemented.
- Fix modified paths for raw HTML tags (src, poster, etc.)(#4050, #4055). This had not been updated for the new EPUBcontainer layout, with a separate text/ subdirectory.
- Fix image paths with empty
--epub-subdirectory
.
Miscellaneous code cleanup (Alexander Krotov).
Use pandoc-types 1.17.3, which adds
Walkable
instancesfor[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 oldHaskell filters. This is easier and faster.Improved
INSTALL.md
.Update commands to extract deb archive on Linux (#4043, Salim B).
pandoc 2.0.1.1 (2017-11-04)
Improved fix to #3989 (parsing of HTML tags containing
>
in an attribute or comment). The previous fix (in 2.0.1) onlyworked in certain cases.FB2 writer (Alexander Krotov):
- Add
unrecognised
genre to<title-info>
(Alexander Krotov). XML schema requires at least one genre. - Remove
<annotation>
from<body>
.
- Add
CommonMark writer: fix strikethrough for
gfm
(#4038).Use texmath 0.10, which adds support for a wider range ofsymbols and fixes default column alignments in MathMLand OMML.
Highlighting fixes, using skylighting 0.4.3.2:
- Fix invalid CSS.
- Support
lineAnchors
(orline-anchors
) in HTML code blocks. - Ensure that code lines don't get duplicate identifiers (#4031).The line identifiers are built using the code block's identifieras a prefix. If the code block has null identifier, we use
cb1
,cb2
, etc.
Added a few abbreviations to
data/abbreviations
,and sorted the list (#3984, Wandmalfarbe).Improved support for columns in HTML writer (#4028).
- Remove
width
attribute from thediv
. - Remove space between
<div class="column">
elements,since this prevents columns whose widths sum to 100%(the space takes up space). - Move as much as possible of the CSS to the template.
- Ensure that all the HTML-based templates (including epub)contain the CSS for columns.
- Columns default to 50% width unless they are given a widthattribute. So if you want two equal-width columns, youcan use a div with class
column
and nowidth
attribute.
- Remove
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:
- Clarify that --setext-headers doesn't affect gfm output (#4035).
- Clarify what is needed to open and close a div in
fenced_divs
(#4039, Tristano Ajmone). - Removed reference to
default.beamer
in docs (#4024).Also added mention of other templates affecting PDF outputwith different settings.
pandoc 2.0.1 (2017-10-31)
Fixed regression in parsing of HTML comments in markdown and othernon-HTML formats (
Text.Pandoc.Readers.HTML.htmlTag
) (#4019).The parser stopped at the first>
character, even if it wasn'tthe end of the comment.Creole reader (Sascha Wilde):
- Fix some minor typos and formatting.
- Add additional test on nowiki-block after para.
- Fix lists with trailing white space.
LaTeX reader: handle
%
comment right after command.For example,\emph%
.Markdown reader: make sure fenced div closers work in lists.Previously the following failed:
::: {.class}1. one2. two:::
and you needed a blank line before the closing
:::
.Make
fenced_divs
affect the Markdown writer. Iffenced_divs
isenabled, 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 becomefootnote-ref
,titleslide
hasbecometitle-slide
, andfootnoteBack
has becomefootnote-back
.JATS writer: Properly pass through author metadata (#4020).
FB2 writer (Alexander Krotov):
- Write blocks outside of
<p>
in definitions. - Make bullet lists consistent with ordered lists, repeatingthe marker for the outer list rather than indenting sublists,since indentation does not work in readers.
- Add new style FB2 tests.
- Write blocks outside of
Text.Pandoc.ImageSize
: AddMillimeter
constructor toDimension
(#4012) [API change]. Now sizes given in 'mm' are no longer convertedto '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.
pandoc 2.0.0.1 (2017-10-30)
EPUB writer:
- Fixed filepaths for nonstandard epub-subdirectory values.
- Ensure that epub2 is recognized as a non-text format,so that a template is used.
- Don't include "prefix" attribute for ibooks for epub2.It doesn't validate.
- Fix stylesheet paths; previously we had an incorrectstylesheet path for the cover page and nav page.
LaTeX reader:
- Insert space when needed in macro expansion (#4007).Sometimes we need to insert a space after a control sequenceto prevent it merging with a following letter.
- Allow unbraced arguments for macros (#4007).
- Allow body of macro definition to be unbraced (#4007).
Linux package build: ensure that pandoc-citeproc is statically linked.
trypandoc: add native, ms.
pandoc 2.0 (2017-10-29)
New features
New output format
ms
(groff ms). Complete support, includingtables, math, syntax highlighting, and PDF bookmarks. The writer usestexmath's new eqn writer to convert math to eqn format, so a ms fileproduced with this writer should be processed withgroff -ms -e
ifit contains math.New output format
jats
(Journal Article Tag Suite). This is an XMLformat used in archiving and publishing articles. Note that aURI-encoded CSL stylesheet (data/jats.csl
) is added automaticallyunless 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 parsegfm exactly as GitHub does (excepting certain postprocessingsteps, involving notifications, emojis, etc.).markdown_github
has been deprecated in favor ofgfm
.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 ofgfm
.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 canbe used to display the HTML produced by this reader andpandoc's HTML writer in the style of vimwiki's own HTMLexport.New input format
creole
(Creole 1.0) (#3994, Sascha Wilde).New syntax for Divs, with
fenced_divs
extension enabled bydefault (#168). This gives an attractive, plain-text way to createcontainers 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 defaultformarkdown
andmultimarkdown
). The syntax is the same asfor fenced code blocks or code inlines, only with{=FORMAT}
forattributes, whereFORMAT
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 pandocmakes 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 filtersand uses the lua interpreter baked into pandoc, so that no externalinterpreter is needed. Note that lua filters are all applied afterregular filters, regardless of their position on the command line.For documentation of lua filters, seedoc/lua-filters.md
.Set
PANDOC_READER_OPTIONS
in environment where filters are run.This contains a JSON representation ofReaderOptions
, so filterscan 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
orprince
(Mauro Bieg, #3909).pandoc -t html5 -o output.pdf --pdf-engine=prince
.Added
--epub-subdirectory
option (#3720). This specifies thesubdirectory in the OCF container that holds the EPUB specific content.We now put all EPUB related content in anEPUB/
subdirectory by default(later this will be configurable).mimetype META-INF/ com.apple.ibooks.display-options.xml container.xml EPUB/ <<--configurable-->> fonts/ <<--static-->> font.otf media/ <<--static-->> cover.jpg fig1.jpg styles/ <<--static-->> stylesheet.css content.opf toc.ncx text/ <<--static-->> ch001.xhtml
Added
--resource-path=SEARCHPATH
command line option (#852).SEARCHPATH is separated by the usual character, depending on OS(: on unix, ; on windows). Default resource path is just workingdirectory. However, the working directory must be explicitlyspecified if the--resource-path
option is used.Added --abbreviations=FILE option for custom abbreviations file(#256). Dfault abbreviations file (
data/abbreviations
) containsa list of strings that will be recognized by pandoc'sMarkdown parser as abbreviations. (A nonbreaking space willbe inserted after the period, preventing a sentence space informats like LaTeX.) Users can override the default by putting a fileabbreviations in their user data directory (~/.pandoc
on *nix).Allow a theme file as argument to
--highlight-style
.Also include a sample,default.theme
, indata/
.Allow
--syntax-definition
option for dynamic loading of syntaxhighlighting definitions (#3334).Lists in
markdown
by default now use the CommonMark variablenesting rules (#3511). The indentation required for a block-levelitem to be included in a list item is no longer fixed, but isdetermined by the first line of the list item. To be included inthe list item, a block must be indented to the level of the firstnon-space content after the list marker. Exception: if are 5 or morespaces after the list marker, then the content is interpreted as anindented code block, and continuation paragraphs must be indentedtwo spaces beyond the end of the list marker. See the CommonMarkspec 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 examplesof texts that will be parsed differently:
- a - b
will be parsed as a list item with a sublist; under the four-spacerule, it would be a list with two items.
- a code
Here we have an indented code block under the list item, even though itis only indented six spaces from the margin, because it is four spacespast the point where a continuation paragraph could begin. With thefour-space rule, this would be a regular paragraph rather than a codeblock.
- a code
Here the code block will start with two spaces, whereas underthe four-space rule, it would start with
code
. With the four-spacerule, indented code under a list item always must be indented eightspaces from the margin, while the new rules require only that itbe indented four spaces from the beginning of the first non-spacetext after the list marker (here,a
).This change was motivated by a slew of bug reports from peoplewho expected lists to work differently (#3125, #2367, #2575, #2210,#1990, #1137, #744, #172, #137, #128) and by the growing prevalanceof CommonMark (now used by GitHub, for example). Those whoprefer the old behavior can use
-f markdown+four_space_rule
.Added
four_space_rule
extension. This triggers the old pandocparsing rule for content nested under list items (the "four spacerule").Added
spaced_reference_links
extension (#2602). It allows whitespacebetween the two parts of a reference link: e.g.[a] [b][b]: url
This was previously enabled by default; now it is forbidden by default.
Add
space_in_atx_header
extension (#3512). This is enabled by defaultin pandoc and GitHub markdown but not the other flavors.This requirse a space between the opening #'s and the headertext in ATX headers (as CommonMark does but many other implementationsdo not). This is desirable to avoid falsely capturing things ilke#hashtag
or
#5
Add
sourcefile
andoutputfile
template variables (Roland Hieber,#3431).Allow ibooks-specific metadata in epubs (#2693). You can now havethe following fields in your YAML metadata, and it will be treatedappropriately in the generated EPUB:
ibooks: version: 1.3.4 specified-fonts: false ipad-orientation-lock: portrait-only iphone-orientation-lock: landscape-only binding: true scroll-axis: vertical
Behavior changes
Reader functions no longer presuppose that CRs have beenstripped from the input. (They strip CRs themselves, beforeparsing, to simplify the parsers.)
Added support for translations (localization) (#3559).Currently this only affects the LaTeX reader, for thingslike
\figurename
. Translation data files for 46 languagescan be found indata/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
andreaderParseRaw
. These were confusing.Now we rely on the+raw_tex
or+raw_html
extension with latex or htmlinput. 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 arenot 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 thestylesheet
metadata field (which can containeither 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 necessaryin 2004. We have removed the script already.--katex
improvements. The latest version is used, and theautoload 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 haveto update manually in subsequent pandoc releases in order totake advantage of mathjax improvements.
--self-contained
: don't incorporate elements withdata-external="1"
(#2656). You can leave an external link as it is by adding the attributedata-external="1" to the element. Pandoc will then not try toincorporate its content when--self-contained
is used. This issimilar 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-binaryinput format, pandoc will attempt to extract the contents of alllinked 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 ofa4
.It is converted toa4
in LaTeX andA4
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 readershave been changed.Improved behavior of
auto_identifiers
when there are explicit ids(#1745). Previously only autogenerated ids were added to the listof header identifiers in state, so explicit ids weren't takeninto account when generating unique identifiers. Duplicatedidentifiers could result. This simple fix ensures that explicitly givenidentifiers are also taken into account.Use
table-of-contents
for contents of toc, maketoc
a boolean(#2872). Changed markdown, rtf, and HTML-based templates accordingly.This allows you to settoc: true
in the metadata; thispreviously produced strange results in some output formats.For backwards compatibility,toc
is still set to thetoc contents. But it is recommended that you update templatesto usetable-of-contents
for the toc contents andtoc
for a boolean flag.Change behavior with binary format output to stdout.Previously, for binary formats, output to stdout was disabledunless we could detect that the output was being piped (and notsent to the terminal). Unfortunately, such detection is notpossible on Windows, leaving windows users no way to pipe binaryoutput. So we have changed the behavior in the following way:
- Output to stdout is allowed when it can be determined thatthe output is being piped (on non-Windows platforms).
- If the
-o
option is not used, binary output is never sentto stdout by default; instead, an error is raised. - If
-o -
is used, binary output is sent to stdout, regardlessof whether it is being piped. This works on Windows too.
Better error behavior: uses of
error
have been replaced byraising ofPandocError
, which can be trapped and handled by thecalling program.Removed
hard_line_breaks
extension frommarkdown_github
(#3594).GitHub has two Markdown modes, one for long-form documents like READMEsand one for short things like issue coments. In issue comments, a linebreak is treated as a hard line break. In README, wikis, etc., it istreated as a space as in regular Markdown. Since pandoc is more likely tobe used to convert long-form documents from GitHub Markdown,-hard_line_breaks
is a better default.Include
backtick_code_blocks
extension inmardkown_mmd
(#3637).Escape
MetaString
values (as added with-M/--metadata
flag) (#3792).Previously they would be transmitted to the template without anyescaping. Note that--M title='*foo*'
yields a different result from---title: *foo*---
In the latter case, we have emphasis; in the former case, justa string with literal asterisks (which will be escapedin 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 attributefoo
gets written to HTML5 withdata-foo
, soit is valid HTML5. HTML4 is not affected. This will allow us to usecustom attributes in pandoc without producing invalid HTML. (With helpfrom Wandmalfarbe, #3817.)Plain writer: improved super/subscript rendering. We nowhandle more non-digit characters for which there aresub/superscripted unicode characters. When unicodesub/superscripted characters are not available, we use
_(..)
or^(..)
(#3518).Docbook, JATS, TEI writers: print INFO message when omitting interiorheader (#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
ofsection
orblock
, pandoc will now repeatreferences that have been used in earlier sections. The Markdownreader has also been modified, so that exactly repeated referencesdo not generate a warning, only references with the same label butdifferent targets. The idea is that, with references after every block,one might want to repeat references sometimes.ODT/OpenDocument writer:
- Support
lang
attribute (#1667). - Added support for
--toc
(#2836). Thanks to @anayrat.
- Support
Docx writer:
lang
meta, see #1667 (Mauro Bieg, #3515).Change
FigureWithCaption
toCaptionedFigure
(iandol, #3658).Use
Table
rather thanTable 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 asparsed by the docx reader:
I want I left a comment.some text tohave a comment on it.
We assume also that the id attributes are unique and properlymatched between comment-start and comment-end.
Bookmark improvements. Bookmark start/end now surrounds content ratherthan 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 byparsing them as
Span
withrole
attributes (#3407). Thisway they can be manipulated in the AST.HTML writer:
- Line block: Use class instead of style attribute (#1623). We nowissue
<div class="line-block">
and include a default definitionforline-block
in the default templates, instead of hard-coding astyle
on the div. - Add class
footnoteBack
to footnote back references (Timm Albers).This allows for easier CSS styling. - Render SmallCaps as span with smallcaps class (#1592), rather thanusing a style attribute directly. This gives the user more flexibilityin styling small caps in CSS.
- With reveal.js we use
data-src
instead ofsrc
for images forlazy loading. - Special-case
.stretch
class for images in reveal.js (#1291).Now in reveal.js, an image with classstretch
in a paragraphby itself will stretch to fill the whole screen, with nocaption or figure environment.
- Line block: Use class instead of style attribute (#1623). We nowissue
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 somecharacters (#3742).
Remove initial check for PDF-creating program (#3819).Instead, just try running it and raise the exception if itisn't found at that point. This improves things for users of Cygwinon Windows, where the executable won't be found by
findExecutable
unless.exe
is added. The same exception is raised as before, butat a later point.Readers issue warning for duplicate header identifiers (#1745).Autogenerated header identifiers are given suffixes so as not to clashwith previously used header identifiers. But they may still coincide withan 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 issuea warning in this case, so users can supply an explicit identifier.
CommonMark reader now supports
emoji
,hard_line_breaks
,smart
,andraw_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 formerlyproduced a header with two lines separated by a line break, willnow produce a header followed by a paragraph:
there
This may affect some existing documents that relied onthis undocumented and unintended behavior. This change makes pandocmore consistent with other Markdown implementations, and with itself(since the two-space version of a line break doesn't work inside ATXheaders, and neither version works inside Setext headers).
Org reader (Albert Krewinkel, unless noted):
- Support
table.el
tables (#3314). - Support macros (#3401).
- Support the
#+INCLUDE:
file inclusion mechanism (#3510).Recognized include types areexample
,export
,src
, andnormal org file inclusion. Advanced features like line numbersand level selection are not implemented yet. - Interpret more meta value as inlines. The values of the followingmeta variables are now interpreted using org-markup instead oftreating them as pure strings:
keywords
(comma-separated list ofinlines),subtitle
(inline values),nocite
(inline values, canbe repeated). - Support
\n
export option (#3940). This turns all newlines in thetext into hard linebreaks.
- Support
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 ina paragraph inside aDiv
at the beginning of the admonition withclassadmonition-title
. This is about as close as we can get toRST's own output.Initial support of
.. table
directive. This allows adding captionsto tables.Support
.. line-block
directive. This is deprecated but may stillbe 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 endof 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 thanto emit it. This isn't guaranteed to have good results;it will fail spectacularly for unknown raw or verbatim directives.
Handle chained link definitions (#262). For example,
.. _hello:.. _goodbye: example.com
Here both
hello
andgoodbye
should link toexample.com
.Support anchors (#262). E.g.
`hello`.. _hello:paragraph
This is supported by putting "paragraph" in a
Div
with idhello
.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 Spanwith "role" attributes (#3407). This way they can be manipulated inthe AST.
HTML reader: parse a span with class
smallcaps
asSmallCaps
.LaTeX reader:
- Implemented
\graphicspath
(#736). - Properly handle column prefixes/suffixes. For example, in
\begin{tabular}{>{$}l<{$}>{$}l<{$} >{$}l<{$}}
each cell will be interpreted as if it has a$
before its content and a$
after (math mode). - Handle komascript
\dedication
(#1845). It now adds adedication
field to metadata. It is up to the user to supplya template that uses this variable. - Support all
\textXX
commands, where XX =rm
,tt
,up
,md
,sf
,bf
(#3488). Spans with a class are used when there isnothing better. - Expand
\newenvironment
macros (#987). - Add support for LaTeX subfiles package (Marc Schreiber, #3530).
- Better support for subfigure package (#3577).A figure with two subfigures turns into two pandocfigures; the subcaptions are used and the main captionignored, unless there are no subcaptions.
- Add support for
\vdots
(Marc Schreiber, #3607). - Add basic support for hyphenat package (Marc Schreiber, #3603).
- Add basic
\textcolor
support (Marc Schreiber). - Add support for
tabularx
environment (Marc Schreiber, #3632). - Better handling of comments inside math environments (#3113).This solves a problem with commented out
\end{eqnarray}
insidean eqnarray (among other things). - Parse tikzpicture as raw verbatim environment if
raw_tex
extensionis selected (#3692). Otherwise skip with a warning. This is betterthan trying to parse it as text! - Add
\colorbox
support (Marc Schreiber). - Set identifiers on Spans used for
\label
. - Have
\setmainlanguage
setlang
in metadata. - Support etoolbox's
\ifstrequal
. - Support
plainbreak
,fancybreak
et al from the memoir class(bucklereed, #3833). - Support
\let
. Also, fix regular macros so they're expanded at thepoint of use, and NOT also the point of definition.\let
macros,by contrast, are expanded at the point of definition. Added anExpansionPoint
field toMacro
to track this difference. - Support simple
\def
macros. Note that we still don't supportmacros with fancy parameter delimiters, like\def\foo#1..#2{...}
. - Support
\chaptername
,\partname
,\abstractname
, etc. (#3559,obsoletes #3560). - Put content of
\ref
,\label
,\eqref
commands intoSpan
withattributes, so they can be handled in filters (Marc Schreiber, #3639) - Add Support for
glossaries
andacronym
package (Marc Schreiber,#3589). Acronyms are not resolved by the reader, but acronym andglossary information is put into attributes on Spans so that theycan be processed in filters. - Use
Link
instead ofSpan
for\ref
. This makes more sensesemantically and avoids unnecessarySpan [Link]
nestings whenreferences are resolved. - Rudimentary support for
\hyperlink
. - Support
\textquoteleft|right
,\textquotedblleft|right
(#3849). - Support
\lq
,\rq
. - Implement
\newtoggle
,\iftoggle
,\toggletrue|false
from etoolbox(#3853). - Support
\RN
and\Rn
, from biblatex (bucklereed, #3854). - Improved support for
\hyperlink
,\hypertarget
(#2549). - Support
\k
ogonek accent. - Improve handling of accents. Handle ogonek, and fall back correctlywith forms like
\"{}
. - Better support for ogonek accents.
- Support for
\faCheck
and\faClose
(Marc Schreiber, #3727). - Support for
xspace
(Marc Schreiber, #3797). - Support
\setmainlanguage
or\setdefaultlanguage
(polyglossia)and\figurename
. - Better handling of
\part
in LaTeX (#1905). Now we parse chapters aslevel 0 headers, and parts as level -1 headers. After parsing, wecheck for the lowest header level, and if it's less than 1 we bumpeverything up so that 1 is the lowest header level. So\part
willalways produce a header; no command-line options are needed. - Add block version of
\textcolor
(Marc Schreiber). \textcolor
works as inline and block command (Marc Schreiber).\textcolor
will be parse as span at the beginning of a paragraph(Marc Schreiber).- Read polyglossia/babel
\text(LANG){...}
(bucklereed) - Improved handling of include files in LaTeX reader (#3971).Previously
\include
wouldn't work if the included filecontained, e.g., a begin without a matching end. - Support
\expandafter
(#3983). - Handle
\DeclareRobustCommand
(#3983). Currently it's just treatedas a synonym for\newcommand
. - Handle
\lettrine
(Mauro Bieg).
- Implemented
Math improvements due to updates in texmath:
- Improved handling of accents and upper/lower delimiters.
- Support for output in GNU eqn format (used with *roff).
- Allow
\boldsymbol
+ a token without braces, and similarlywith other styling commands. - Improve parsing of
\mathop
to allow multi-character operator names. - Add thin space after math operators when "faking it withunicode."
walk
is now used instead ofbottomUp
in theToJSONFilter
instance fora -> [a]
(pandoc-types). Note that behaviorwill be slightly different, sincebottomUp
's treatment ofa function[a] -> [a]
is to apply it to each sublist of alist, while walk applies it only to maximal sublists.Usually the latter behavior is what is wanted, and theformer can be simulated when needed. But there may beexisting filters that need to be rewritten in light of thenew behavior. Performance should be improved.There are some changes to syntax highlighting due to revisionsin the
skylighting
library:- Support for
powershell
has been added, and many syntaxdefinitions have been updated. - Background colors have been added to the
kate
style. - The way highlighted code blocks are formatted in HTML hasbeen changed (David Baynard), in ways that may requirechanges in hard-coded CSS affecting highlighting.(If you haven't included hard-coded highlighting CSS inyour template, you needn't change anything.)
- Support for
API changes
New module
Text.Pandoc.Class
(Jesse Rosenthal, John MacFarlane).This contains definitions of thePandocMonad
typeclass, thePandocIO
andPandocPure
monads, and associated functions.Changed types of all writers and readers.
- We now use
Text
instead ofString
in the interface (#3731).(We have not yet changed the internals of most readers to workwithText
, but making this change in the API now opens up apath to doing that.) - The result is now of form
m a
with constraintPandocMonad m
.Readers and writers can be combined to form monadic values whichcan be run using eitherrunIO
orrunPure
. IfrunIO
is used,then both readers and writers will be able to do IO when needed(for include files, for example); ifrunPure
is used,then the functions are pure and will not touch IO. - Where previously you used
writeRST def (readMarkdown def "[foo](url)")
, now youwould userunPure $ readMarkdown def (pack "[foo](url)") >>= writeRST def
.
- We now use
New module
Text.Pandoc.Readers
(Albert Krewinkel). Thiscontains reader helper functions formerly defined in thetop-levelText.Pandoc
module.- Changed
StringReader
->TextReader
. getReader
now returns a pair of a reader andExtensions
, instead of building the extensions into thereader (#3659). The calling code must explicitly setreaderExtensions
using theExtensions
returned. Thepoint of the change is to make it possible for the callingcode to determine what extensions are being used.
- Changed
New module
Text.Pandoc.Writers
(Albert Krewinkel).This contains writer helper functions formerly defined in thetop-levelText.Pandoc
module.- Changed
StringWriter
->TextWriter
. getWriter
now retuns a pair of a reader andExtensions
, instead of building the extensions into thereader (#3659). The calling code must explicitly setreaderExtensions
using theExtensions
returned. Thepoint of the change is to make it possible for the callingcode to determine what extensions are being used.
- Changed
New module
Text.Pandoc.Lua
, exportingrunLuaFilter
(Albert Krewinkel,#3514).New module
Text.Pandoc.App
. This abstracts out the functionalityof the command line program (convertWithOpts
), so it can be reproducede.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 otherusers ofText.Pandoc.App
to recover.pandoc.hs
is now a 2-liner.The module also exports some utility functions for parsing optionsand running filters.New module
Text.Pandoc.Logging
(exported module) (#3392).This now contains theVerbosity
definition previously inText.Pandoc.Options
, as well as a newLogMessage
datatype that willeventually be used instead of raw strings for warnings. This will enableus, among other things, to provide machine-readable warnings if desired.Include ToJSON instance and showLogMessage. This gives us the possibilityof both machine-readable and human-readable output for log messages.New module
Text.Pandoc.BCP47
, withgetLang
,Lang(..)
,parseBCP47
.New module
Text.Pandoc.Translations
, exportingTerm
,Translations
,readTranslations
.New module
Text.Pandoc.Readers.LaTeX.Types', exporting
Macro,
Tok,
TokType,
Line,
Column`.Text.Pandoc.Error
: added many new constructors forPandocError
.Expose some previously private modules (#3260). These are oftenhelpful to people writing their own reader or writer modules:
Text.Pandoc.Writers.Shared
Text.Pandoc.Parsing
Text.Pandoc.Asciify
Text.Pandoc.Emoji
Text.Pandoc.ImageSize
Text.Pandoc.Highlighting
`
New module
Text.Pandoc.Extensions
(Albert Krewinkel):Extension parsing and processing functions were defined in the top-levelText.Pandoc
module. These functions are moved to the Extensionssubmodule as to enable reuse in other submodules.Add
Ext_raw_attribute
constructor forExtension
.Add
Ext_fenced_divs
constructor for `Extension'.Add
Ext_four_space_rule
constructor inExtension
.Add
Ext_gfm_auto_identifiers
constructor forExtension
.Add
Monoid
instance forExtensions
.Add
Text.Pandoc.Writers.Ms
, exportingwriteMs
.Add
Text.Pandoc.Writers.JATS
, exportingwriteJATS
.Add
Text.Pandoc.Writers.Muse
, exportingwriteMuse
.Add
Text.Pandoc.Readers.Muse
, exportingreadMuse
.Add
Text.Pandoc.Readers.TikiWiki
, exportingreadTikiWiki
.Add
Text.Pandoc.Readers.Vimwiki
, exportingreadVimwiki
.Add
Text.Pandoc.Readers.Creole
, exportingreadCreole
.Export
setVerbosity
fromText.Pandoc
.Text.Pandoc.Pretty
: AddEq
instance forDoc
.Text.Pandoc.XML
:toEntities
: changed type toText -> Text
.Text.Pandoc.UTF8
:- Export
fromText
,fromTextLazy
,toText
,toTextLazy
.DefinetoString
,toStringLazy
in terms of them. - Add new functions parameterized on
Newline
:writeFileWith
,putStrWith
,putStrLnWith
,hPutStrWith
,hPutStrLnWith
.
- Export
Text.Pandoc.MediaBag
: removedextractMediaBag
.Text.Pandoc.Highlighting
:highlighting
now returns an Either rather than Maybe.This allows us to display error information returned by the skylightinglibrary. Display a warning if the highlighting library throws an error.- Add parameter for
SyntaxMap
tohighlight
.
Text.Pandoc.Writers.Math
:- Export
defaultMathJaxURL
,defaultKaTeXURL
. This will ensure thatwe only need to update these in one place.
- Export
Text.Pandoc.SelfContained
:- Removed
WriterOptions
parameter frommakeSelfContained
. - Put
makeSelfContained
in PandocMonad instead of IO. This removesthe need to pass MediaBag around and improves exceptions. It alsoopens up the possibility of using makeSelfContained purely. - Export
makeDataURI
.
- Removed
Text.Pandoc.ImageSize
:- Export
lengthToDim
, new functionscaleDimension
. - Export
inEm
from ImageSize (#3450). - Change
showFl
andshow
instance forDimension
soextra decimal places are omitted. - Added
Em
as a constructor ofDimension
. - Add
WriterOptions
parameter toimageSize
signature (Mauro Bieg).
- Export
Text.Pandoc.Templates
:- Change type of
renderTemplate'
. Now it runs inPandocMonad
and raises a properPandocTemplateError
if there are problems, ratherthan failing with uncatchableerror
. - Change signature of
getDefaultTemplate
. Now it runs in any instanceofPandocMonad
, and returns aString
rather than anEither
value.And it no longer takes adatadir
parameter, since this can beretrieved fromCommonState
.
- Change type of
Text.Pandoc.Options
:- Added
writerEpubSubdirectory
toWriterOptions
(#3720).The EPUB writer now takes its EPUB subdirectory from this option. - In
WriterOptions
, renamewriterLaTeXEngine
towriterPdfEngine
andwriterLaTeXArgs
towriterPdfArgs
(Mauro Bieg, #3909). - Add
writerSyntaxMap
toWriterOptions
. - Removed
writerEpubStylesheet
fromWriterOptions
. - Remove
writerUserDataDir
fromWriterOptions
. It is now carriedinCommonState
inPandocMonad
instances. (And thus it can be usedby readers too.) - Changed
writerEpubMetadata
to aMaybe String
. - Removed
readerApplyMacros
fromReaderOptions
. Now we just checkthelatex_macros
reader extension. - FromJSON/ToJSON instances for
ReaderOptions
. - In
HTMLMathMethod
, theKaTeX
contsructor now takes onlyone string (for the KaTeX base URL), rather than two. - Removed
writerSourceURL
fromWriterOptions
. We now usestSourceURL
inCommonState
, which is set bysetInputFiles
.
- Added
Text.Pandoc.Shared
:tabFilter
now takes aText
, notString
.openURL
: Changed type from an Either. Now it will just raisean exception to be trapped later.- Remove
normalizeSpaces
(#1530). - Remove
warn
. (Usereport
fromText.Pandoc.Class
instead.) - Export a new function
crFilter
. - Add
eastAsianLineBreakFilter
(previously in Markdown reader). - Provide custom
isURI
that rejects unknown schemes.(Albert Krewinkel, #2713). We also export the set of knownschemes
. The new function replaces the function of the same namefromNetwork.URI
, as the latter did not check whether a scheme iswell-known. All official IANA schemes (as of 2017-05-22) areincluded in the set of known schemes. The four non-official schemesdoi
,isbn
,javascript
, andpmid
are kept. - Remove
err
. - Remove
readDataFile
,readDefaultDataFile
,getReferenceDocx
,getReferenceODT
. These now live inText.Pandoc.Class
,where they are defined in terms ofPandocMonad
primitives and have different signatures. - Remove
openURL
. UseopenURL
fromText.Pandoc.Class
instead. - Add
underlineSpan
.
Text.Pandoc.Readers.HTML
: export newNamedTag
class.Text.Pandoc.Readers.Markdown
: removereadDocxWithWarnings
.With the new API one can simply usegetLog
after runningthe reader.Text.Pandoc.Readers.LaTeX
: Changed types forrawLaTeXInline
andrawLaTeXBlock
. (Both now return aString
, and they arepolymorphic in state.)
Bug fixes and under-the-hood improvements
TEI writer: Added identifiers on
<div>
elements.DokuWiki reader: Better handling for code block in list item (#3824).
Custom writer: Remove old preprocesesor conditionals (Albert Krewinkel).
ZimWiki writer: Removed internal formatting from note and table cells,because ZimWiki does not support it (Alex Ivkin, #3446).
MediaWiki writer:
- Updated list of syntax highlighting languages (#3461).Now
r
gets you<source>
rather than<code>
(among others). - Add display attribute on
<math>
tags (#3452). This allows displaymath to be rendered properly. - Remove newline before
</ref>
(#2652). - Don't softbreak lines inside list items (#3531).
- Updated list of syntax highlighting languages (#3461).Now
Org writer:
- Reduce to two spaces after bullets (#3417, Albert Krewinkel).
- Add unit tests (Alexander Krotov).
- Stop using raw HTML to wrap divs (Albert Krewinkel, #3771).
- Do not strip
#
from Org anchor links (Alexander Krotov).
CommonMark writer:
- Avoid excess blank lines at end of output.
- Prefer pipe tables to HTML tables even if it means losing relativecolumn width information (#3734).
- Support table, strikethrough extensions, when enabled (as with gfm).Note that we bypass the commonmark writer from cmark and construct ourown pipe tables, with better results.
- Properly support
--wrap=none
. - Use smallcaps class for
SmallCaps
(#1592). - Omit "fig:" prefix in image titles. This is used internally toindicate internal figures.
RST writer:
- Properly handle table captions.
- Don't wrap lines in in definition list terms. Wrapping is not allowed.
- Implemented
+/-smart
and improved escaping with+smart
. - Add empty comments when needed to avoid including a blockquotein the indented content of a preceding block (#3675).
- Improve grid table output, fix bug with empty rows (#3516).Uses the new
gridTable
in Writers.Shared, which is hereimproved to better handle 0-width cells. - Remove space at beginning/end of RST code span (#3496). Otherwisewe get invalid RST. There seems to be no way to escape the space.
- Add header anchors when header has non-standard id (#3937).
- Correctly handle inline code containing backticks, using a
:literal:
role (#3974). - Don't backslash-escape word-internal punctuation (#3978).
Markdown writer:
Don't include variables in metadata blocks. Previously variables seton the command line were included in e.g. YAML metadata, contrary todocumentation and intentions.
Improved escaping with
+smart
.Fixed grid tables embedded in grid tables (#2834).
Use span with class 'smallcaps' for SmallCaps, instead of a styleattribute as before (#1592).
Escape initial
%
in a paragraph if thepandoc_title_blocks
extension is enabled (#3454). Otherwise in a document starting witha literal%
the first line is wrongly interpreted as a title.Fixed false ordered lists in YAML metadata (#3492, #1685). Now weproperly escape things that would otherwise start ordered lists,such as
---title: 1. inline...
Better handling of tables with empty columns (#3337). We nowcalculate the number of columns based on the longest row (or thelength of aligns or widths).
Escape unordered list markers at beginning of paragraph (#3497), toavoid 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 wouldalways 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 onlyby case. Also allow implicit reference links when the linktext 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 theMarkdown writer would sometimes create links where there were nonein the source. This is now avoided by selectively escaping bracketcharacters 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 thereare 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 onlymarkdown
worked. Note: currently a raw block labeledmarkdown_github
will be printed for anymarkdown
format.Ensure that
+
and-
are escaped properly so they don't causespurious lists (#3773). Previously they were onlyif succeeded by a space, not if they were at end of line.Use pipe tables if
raw_html
disabled andpipe_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 usebrackets 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>
. Ifall_symbols_escapable
is set,we backslash escape these. Otherwise we use entities as before.When writing plain, don't use
to separate list and indentedcode. There's no need for it in this context, since this isn't to beinterpreted using Markdown rules.Preserve classes in JS obfuscated links (Timm Albers, #2989).HTML links containing classes originally now preserve them when usingjavascript email obfuscation.
Render
SmallCaps
as a native span whennative_spans
are enabled.Always write attributes with
bracketed_spans
(d-dorazio).
Man writer:
- Fix handling of nested font commands (#3568). Previously pandoc emittedincorrect markup for bold + italic, for example, or bold + code.
- Avoid error for definition lists with no definitions (#3832).
DocBook writer:
- Fix internal links with
writerIdentifierPrefix opt
(#3397, Mauro Bieg).
- Fix internal links with
Docx writer:
- Don't include bookmarks on headers unless non-null id (#3476).
- Support 9 levels of headers (#1642).
- Allow 9 list levels (#3519).
- Don't take
distArchive
from datadir (#3322). The docx writer takescomponents from the distribution's version ofreference.docx
when itcan't find them in a user's customreference.docx
. Previously, weallowed areference.docx
in the data directory (e.g.~/.pandoc
)to be used as the distribution's reference.docx. This led to abizarre situation where pandoc would produce a good docx using--template ~/.pandoc/ref.docx
, but ifref.docx
were moved to~/.pandoc/reference.docx
, it would then produce a corrupted docx. - Fixed handling of soft hyphen (0173) (#3691).
- Better handling of keywords (#3719).
- Cleaner code for handling dir and style attributes for
Div
. - Use
Set
for dynamic styles to avoid duplicates. - Removed redundant element from data/docx/word/numbering.xml.The elements we need are generated when the document iscompiled; this didn't do anything.
- Activate
evenAndOddHeaders
from reference docx (#3901,Augustín Martín Barbero).
ODT/OpenDocument writer:
- Calculate aspect ratio for percentage-sized images (Mauro Bieg, #3239).
- Use more widely available bullet characters (#1400). The oldcharacters weren't available in some font sets. These seem to workwell on Windows and Linux versions of LibreOffice.
- Wider labels for lists (#2421). This avoids overly narrow labels forordered lists with
()
delimiters. However, arguably it createsoverly wide labels for bullets. Also, lists now start flush withthe margin, rather than indented. - Fixed dropped elements in some ordered lists (#2434).
FB2 writer:
- Don't render
RawBlock
as code. - Don't fail with an error on interior headers (e.g. in list) (#3750).Instead, omit them with an INFO message.
- Add support for "lang" metadata (Alexander Krotov, #3625).
- Format
LineBlock
as poem (Alexander Krotov). Previously writerproduced one paragraph with<empty-line/>
elements, which are notallowed inside<p>
according to FB2 schema. - Replace
concatMap
withcMap
(Alexander Krotov). - Write FB2 lists without nesting blocks inside
<p>
(AlexanderKrotov, #4004)
- Don't render
HTML writer:
- Make sure
html4
,html5
formats work for raw blocks/inlines. - Render raw inline environments when
--mathjax
used (#3816).We previously did this only with raw blocks, on the assumptionthat math environments would always be raw blocks. This has changedsince we now parse them as inline environments. - Ensure we don't get two style attributes for width and height.
- Report when not rendering raw inline/block.
- Issue warning if no title specified and template used (#3473).
- Info message if
lang
is unspecified (#3486). - Removed unused parameter in
dimensionsToAttributeList
. - Avoid two class attributes when adding
uri
class (#3716). - Fix internal links with
writerIdentifierPrefix opt
(#3397, MauroBieg). - Use revealjs's math plugin for mathjax (#3743). This is a thinwrapper around mathjax that makes math look better on revealjs.
- Slidy: use h1 for all slides, even if they were originallylevel 2 headers (#3566). Otherwise the built-in table of contentsin Slidy breaks.
- Make sure
LaTeX writer:
- Don't render LaTeX images with data: URIs (#3636). Note that
--extract-media
can be used when the input contains data: URIs. - Make highlighted code blocks work in footnotes (Timm Albers).
- Don't use figure inside table cell (#3836).
- Use proper code for list enumerators (#3891). This should fix problemswith lists that don't use arabic numerals.
- Always add hypertarget when there's a non-empty identifier (#2719).Previously the hypertargets were only added when there was actuallya link to that identifier.
- Use
%
after hypertarget before code block. - Add
\leavevmode
before hypertarget at start of paragraph (#2704,fixes formatting problems in beamer citations). - Don't use
lstinline
in\item[..]
(#645). If you do, the contentsof item disappear or are misplaced. Use\texttt
instead. - Fix problem with escaping in
lstinline
(#1629). Previously theLaTeX writer created invalid LaTeX when--listings
was specified anda code span occurred inside emphasis or another construction. - Fix error with line breaks after empty content (#2874). LaTeXrequires something before a line break, so we insert a
~
if noprintable content has yet been emitted. - Use BCP47 parser.
- Fixed detection of otherlangs (#3770). We weren't recursing intoinline contexts.
- Handle language in inline code with
--listings
(#3422). - Write euro symbol directly in LaTeX (Andrew Dunning, #3801).The textcomp package allows pdfLaTeX to parse
€
directly, making the\euro
command unneeded. - Fixed footnotes in table captions (#2378). Note that if the table hasa first page header and a continuation page header, the notes willappear only on the first occurrence of the header.
- In
writeBeamer
output, allow hyperlinks to frames (#3220).Previously you could link to a header above or below slide level butnot to slide level. This commit changes that. Hypertargets areinserted inside frame titles; technically the reference is to justafter the title, but in normal use (where slides are viewed fullscreen in a slide show), this does not matter. - Remove
\strut
at beginning of table cells (#3436). This fixes aproblem with alignment of lists in table cells. The\strut
at theend seems to be enough to avoid the too-close spacing that motivatedaddition of the strut in #1573. - Add partial siunitx Support (Marc Schreiber, #3588).
- Don't render LaTeX images with data: URIs (#3636). Note that
ConTeXt writer:
- Refactored to use BCP47 module.
- Remove unnecessary
$
(Alexander Krotov, #3482). - Use header identifiers for chapters (#3968).
EPUB writer:
title_page.xhtml
is now put intext/
.- Don't strip formatting in TOC (#1611).
Textile reader:
- Fix bug for certain links in table cells (#3667).
- Allow 'pre' code in list item (#3916).
HTML reader:
- Added warnings for ignored material (#3392).
- Better sanity checks to avoid parsing unintended things asraw HTML in the Markdown reader (#3257).
- Revise treatment of
li
withid
attribute (#3596). Previously wealways added an empty div before the list item, but this createdproblems with spacing in tight lists. Now we do this: If the listitem contents begin with aPlain
block, we modify thePlain
block by adding aSpan
around its contents. Otherwise, we add aDiv
around the contents of the list item (instead of adding anemptyDiv
to the beginning, as before). - Add
details
tag to list of block tags (#3694). - Removed
button
from block tag list (#3717). It is already in theeitherBlockOrInlineTag
list, and should be both places. - Use
Set
s instead of lists for block tag lookup. - Rewrote to use
Text
throughout. Effect on memory usage is modest(< 10%). - Use the lang value of
<html>
to set the lang meta value (bucklereed,#3765). - Ensure that paragraphs are closed properly when the parent blockelement closes, even without
</p>
(#3794). - Parse
<figure>
and<figcaption>
(Mauro Bieg, #3813). - Parse
<main>
like<div role=main>
(bucklereed, #3791).<main>
closes<p>
and behaves like a block element generally - Support column alignments (#1881). These can be set eitherwith a
width
attribute or withtext-width
in astyle
attribute. - Modified state type to be an instance of
HasLogMessages
, soregisterHeader
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 caseswhere an attribute contained a>
character. This patch fixes thebug, which especially affects raw HTML in Markdown.
Txt2Tags reader:
- Newline is not indentation (Alexander Krotov).
MediaWiki reader:
- Allow extra hyphens after
|-
in tables (#2649). - Allow blank line after table start (#2649).
- Fixed more table issues (#2649).
- Ensure that list starts begin at left margin (#2606). Including whenthey're in tables or other list items.
- Make smart double quotes depend on
smart
extension (#3585). - Don't do curly quotes inside
<tt>
contexts (#3585). Even if+smart
. - Modified state type to be an instance of
HasLogMessages
, soregisterHeader
can issue warnings.
- Allow extra hyphens after
TWiki reader (Alexander Krotov):
- Remove unnecessary
$
(#3597). - Simplify
linkText
(#3605).
- Remove unnecessary
EPUB reader:
- Minor refactoring, avoiding explicit MediaBag handling.This all works behind the scenes in CommonState plumbing.
Docx reader:
- Don't drop smartTag contents (#2242).
- Handle local namespace declarations (#3365). Previously we didn'trecognize math, for example, when the xmlns declaration occurred onthe element and not the root.
- More efficient trimSps (#1530). Replacing
trimLineBreaks
. Thisdoes the work ofnormalizeSpaces
as well, so we avoid the need forthat function here. - Avoid 0-level headers (Jesse Rosenthal, #3830). We used to parseparagraphs styled with "HeadingN" as "nth-level header." But if adocument has a custom style named "Heading0", this will produce a0-level header, which shouldn't exist. We only parse this styleif N>0. Otherwise we treat it as a normal style name, andfollow its dependencies, if any.
- Add tests for avoiding zero-level header (Jesse Rosenthal).
ODT reader:
- Replaced
collectRights
with Rights fromData.Either
. - Remove dead code (Albert Krewinkel).
- Replaced
Org reader (Albert Krewinkel, unless noted).
- Don't allow tables inside list items (John MacFarlane, #3499).
- Disallow tables on list marker lines (#3499).
- Convert markup at beginning of footnotes (John MacFarlane, #3576).
- Allow emphasized text to be followed by
[
(#3577). - Handle line numbering switch for src blocks.The line-numbering switch that can be given to source blocks (
-n
withan start number as an optional parameter) is parsed and translated to aclass/key-value combination used by highlighting and other readers andwriters. - Stop adding rundoc prefix to src params. Source block parameter namesare no longer prefixed with
rundoc
. This was intended to simplifyworking with the rundoc project, a babel runner. However, the rundocproject is unmaintained, and adding those markers is not the reader'sjob anyway. The original language that is specified for a sourceelement is now retained as thedata-org-language
attribute and onlyadded if it differs from the translated language. - Allow multi-word arguments to src block params (#3477). The reader nowcorrectly parses src block parameter list even if parameter argumentscontain multiple words.
- Avoid creating
nullMeta
by applyingsetMeta
directly(Alexander Krotov). - Replace
sequence . map
withmapM
. - Fix smart parsing behavior. Parsing of smart quotes and specialcharacters can either be enabled via the
smart
language extension orthe'
and-
export options. Smart parsing is active if either theextension or export option is enabled. Only smart parsing of specialcharacters (like ellipses and en and em dashes) is enabled by default,while smart quotes are disabled. Previously, all smart parsing wasdisabled unless the language extension was enabled. - Subject full doc tree to headline transformations (Albert Krewinkel,#3695). Emacs parses org documents into a tree structure, which isthen post-processed during exporting. The reader is changed to do thesame, turning the document into a single tree of headlines startingat level0.
- Fix cite parsing behaviour (Herwig Stuetz). Until now,
org-ref
cite keys included special characters also at the end. This causedproblems when citations occur right before colons or at the end ofa sentence. With this change, all non alphanumeric characters atthe end of a cite key are ignored. This also adds,
to the listof special characters that are legal in cite keys to better mirrorthe behaviour of org-export. - Fix module names in haddock comments. Copy-pasting had lead tohaddock module descriptions containing the wrong module names.
- Recognize babel result blocks with attributes (#3706). Babelresult blocks can have block attributes like captions and names.Result blocks with attributes were not recognized and were parsedas normal blocks without attributes.
- Include tags in headlines. The Emacs default is to include tags in theheadline when exporting. Instead of just empty spans, which contain thetag name as attribute, tags are rendered as small caps and wrapped inthose spans. Non-breaking spaces serve as separators for multiple tags.
- Respect export option for tags (#3713). Tags are appended toheadlines by default, but will be omitted when the
tags
export optionis set to nil. - Use
tag-name
attribute instead ofdata-tag-name
. - Use
org-language
attribute rather thandata-org-language
. - Modified state type to be an instance of
HasLogMessages
, soregisterHeader
can issue warnings. - End footnotes after two blank lines. Footnotes can not only beterminated by the start of a new footnote or a header, but also by twoconsecutive blank lines.
- Update emphasis border chars (#3933). The org reader was updated tomatch current org-mode behavior: the set of characters which areacceptable to occur as the first or last character in an org emphasishave been changed and now allows all non-whitespace chars at theinner border of emphasized text (see
org-emphasis-regexp-components
).
RST reader:
Fixed small bug in list parsing (#3432). Previously the parser didn'thandle properly this case:
* - a - b* - c - d
Handle multiline cells in simple tables (#1166).
Parse list table directive (Keiichiro Shikano, #3432).
Make use of
anyLineNewline
(Alexander Krotov, #3686).Use
anyLineNewline
inrawListItem
(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 separatedby blanks, and ignore trailing blank lines within the line block.
Fix indirect hyperlink targets (#512).
Markdown reader:
- Allow attributes in reference links to start on next line (#3674).
- Parse YAML metadata in a context that sees footnotes defined inthe body of the document (#1279).
- When splitting pipe table cells, skip tex math (#3481).You might have a
|
character inside math. (Or for that mattersomething that the parser might mistake for raw HTML.) - Treat span with class
smallcaps
as SmallCaps.This allows users to specify small caps in Markdown this way:[my text]{.smallcaps}
(#1592). - Fixed internal header links (#2397).This patch also adds
shortcut_reference_links
to the listof mmd extensions. - Treat certain environments as inlinewhen they occur without space surrounding them (#3309, #2171).E.g. equation, math. This avoids incorrect vertical spacearound equations.
- Optimized
nonindentSpaces
. Makes the benchmark go from 40 to 36 ms. - Allow latex macro definitions indented 1-3 spaces.Previously they only worked if nonindented.
- Improved parsing of indented raw HTML blocks (#1841).Previously we inadvertently interpreted indented HTML ascode blocks. This was a regression. We now seek to determine theindentation level of the contents of an HTML block, and (optionally)skip that much indentation. As a side effect, indentation may bestripped off of raw HTML blocks, if
markdown_in_html_blocks
isused. This is better than having things interpreted as indentedcode blocks. - Fixed smart quotes after emphasis (#2228). E.g. in
*foo*'s 'foo'
. - Warn for notes defined but not used (#1718).
- Use
anyLineNewline
(Alexander Krotov). - Interpret YAML metadata as Inlines when possible (#3755). Ifthe metadata field is all on one line, we try to interpret it asInlines, and only try parsing as Blocks if that fails. If itextends over one line (including possibly the
|
or>
charactersignaling an indented block), then we parse as Blocks. This wasmotivated by some German users finding thatdate: '22. Juin 2017'
got parsed as an ordered list. - Fixed spurious parsing as citation as reference def (#3840).We now disallow reference keys starting with
@
if thecitations
extension is enabled. - Parse
-@roe
as suppress-author citation (pandoc-citeproc#237).Previously only[-@roe]
(with brackets) was recognized assuppress-author, and-@roe
was treated the same as@roe
. - Fixed parsing of fenced code after list when there is no interveningblank line (#3733).
- Allow raw latex commands starting with
\start
(#3558). Previouslythese weren't allowed because they were interpreted as startingConTeXt environments, even without a corresponding\stop
... - Added
inlines
,inlines1
. - Require nonempty alt text for
implicit_figures
(#2844).A figure with an empty caption doesn't make sense. - Removed texmath macro material; now all this is handledin the LaTeX reader functions.
- Fixed bug with indented code following raw LaTeX (#3947).
LaTeX reader:
- Rewrote LaTeX reader with proper tokenization (#1390,#2118, #3236, #3779, #934, #982). This rewrite is primarilymotivated by the need to get macros working properly. A side benefitis that the reader is significantly faster. We now tokenize theinput text, then parse the token stream. Macros modify the tokenstream, so they should now be effective in any context, includingmath. Thus, we no longer need the clunky macro processingcapacities of texmath.
- Parse
\,
to\8198
(six-per-em space) (Henri Werth). - Allow
\newcommand\foo{blah}
without braces. - Support
\lstinputlisting
(#2116). - Issue warnings when skipping unknown latex commands (#3392).
- Include contents of
\parbox
. - Allow
\hspace
and\vspace
to count as raw block or inline.Previously we would refuse to parse anything as raw inline ifit was in theblockCommands
list. Now we allow exceptionsif they're listed under ignoreInlines in inlineCommands.This should make it easier e.g. to include an\hspace
between two side-by-side raw LaTeX tables. - Don't drop contents of
\hypertarget
. - Handle spaces before
\cite
arguments. - Allow newpage, clearpage, pagebreak in inline contexts as well asblock contexts (#3494).
- Treat
{{xxx}}
the same as{xxx}
(#2115). - Use
pMacroDefinition
in macro (for more direct parsing).Note that this means thatmacro
will now parse onemacro at a time, rather than parsing a whole group together. - Fixed failures on
\ref{}
,\label{}
with+raw_tex
. Now thesecommands are parsed as raw if+raw_tex
; otherwise, their argumentis parsed as a bracketed string. - Don't crash on empty
enumerate
environment (#3707). - Handle escaped
&
inside table cell (#3708). - Handle block structure inside table cells (#3709).
minipage
is nolonger required. - Handle some width specifiers on table columns (#3709). Currentlywe only handle the form
0.9\linewidth
. Anything else would haveto be converted to a percentage, using some kind arbitrary assumptionsabout line widths. - Make sure
\write18
is parsed as raw LaTeX. The change is in theLaTeX reader's treatment of raw commands, but it also affects theMarkdown reader. - Fixed regression with starred environment names (#3803).
- Handle optional args in raw
\titleformat
(#3804). - Improved heuristic for raw block/inline. An unknown command at thebeginning of the line that could be either block or inline istreated as block if we have a sequence of block commands followed bya newline or a
\startXXX
command (which might start a raw ConTeXtenvironment). - Don't remove macro definitions from the output, even if
Ext_latex_macros
is set, so that macros will be applied.Since they're only applied to math in Markdown, removing the macroscan have bad effects. Even for math macros, keeping them should beharmless. - Removed
macro
. It is no longer necessary, since therawLaTeXBlock
parser will parse macro definitions. This also avoidsthe need for a separatelatexMacro
parser in the Markdown reader. - Use
label
instead ofdata-label
for label in caption (#3639). - Fixed space after
\figurename
etc. - Resolve references to section numbers.
- Fix
\let\a=0
case, with single character token. - Allow
@
as a letter in control sequences.@
is commonly usedin macros using\makeatletter
. Ideally we'd make the tokenizersensitive to\makeatletter
and\makeatother
, but until then thisseems a good change. - Track header numbers and correlate with labels.
- Allow
]
inside group in option brackets (#3857). - lstinline with braces can be used (verb cannot be used with braces)(Marc Schreiber, #3535).
- Fix keyval function: pandoc did not parse options in braces correctly(Marc Schreiber, #3642).
- When parsing raw LaTeX commands, include trailing space (#1773).Otherwise things like
\noindent foo
break and turn into\noindentfoo
. Affects-f latex+raw_tex
and-f markdown
(and otherformats that allowraw_tex
). - Don't treat "..." as Quoted (#3958). This caused quotes to be omitted in
\texttt
contexts. - Add tests for existing
\includegraphics
behaviour (Ben Firshman). - Allow space before
=
in bracketd options (Ben Firshman). - Be more forgiving in parsing command options. This was needed, forexample, to make some minted options work.
- Strip off quotes in
\include
filenames.
Added
Text.Pandoc.CSV
, simple (unexported) CSV parser.Text.Pandoc.PDF
:- Got
--resource-path
working with PDF output (#852). - Fetch images when generating PDF via context (#3380).To do this, we create the temp directory as a subdirectoryof the working directory. Since context mk IV by default looksfor images in the parent directory, this works.
- Use
report
instead ofwarn
, make it sensitive to verbosity settings. - Use
fillMediaBag
andextractMedia
to extract media to temp dir.This reduces code duplication. html2pdf
: use stdin instead of intermediate HTML file- Removed useless
TEXINPUTS
stuff forcontext2pdf
. mkiv contextdoesn't useTEXINPUTS
.
- Got
Text.Pandoc.Pretty
:- Simplified definition of
realLength
. - Don't error for blocks of size < 1. Instead, resize to 1 (see #1785).
- Simplified definition of
Text.Pandoc.MIME
:- Use
application/javascript
(notapplication/x-javascript
). - Added
emf
to mimeTypes with typeapplication/x-msmetafile
(#1713).
- Use
Text.Pandoc.ImageSize
:- Improve SVG image size code (Marc Schreiber, #3580).
- Make
imageSize
recognize basic SVG dimensions (Mauro Bieg, #3462).
Use
Control.Monad.State.Strict
throughout. This gives 20-30% speedupand reduction of memory usage in most of the writers.Use
foldrWithKey
instead of deprecatedfoldWithKey
.Text.Pandoc.SelfContained
:- Fixed problem with embedded fonts (#3629).
- Refactored getData from
getDataURI
inSelfContained
. - Don't use data URIs for script or style (#3423). Instead, just usescript or style tags with the content inside. The old method withdata URIs prevents certain optimizations outside pandoc. Exception:data URIs are still used when a script contains
</script>
or astyle contains</
. - SelfContained: Handle URL inside material retrieved from a URL(#3629). This can happen e.g. with an @import of a google web font.(What is imported is some CSS which contains an url referenceto the font itself.) Also, allow unescaped pipe (|) in URL.
- Load resources from
data-src
(needed for lazy loading inreveal.js slide shows). - Handle
data-background-image
attribute on section (#3979).
Text.Pandoc.Parsing
:- Added
indentWith
(Alexander Krotov, #3687). - Added
stateCitations
toParserState
. - Removed
stateChapters
fromParserState
. - In
ParserState
, makestateNotes'
a Map, addstateNoteRefs
. - Added
gobbleSpaces
andgobbleAtMostSpaces
. - Adjusted type of
insertIncludedFile
so it can be used with tokenparser. - Replace old texmath macro stuff from Parsing. Use Macro fromText.Pandoc.Readers.LaTeX.Types instead.
- Export
insertIncludedFile
. - Added
HasLogMessages
,logMessage
,reportLogMessages
(#3447). - Replace partial with total function (Albert Krewinkel).
- Introduce
HasIncludeFiles
type class (Albert Krewinkel). TheinsertIncludeFile
function is generalized to work with all parserstates which are instances of that class. - Add
insertIncludedFilesF
which returns F blocks (Albert Krewinkel).TheinsertIncludeFiles
function was generalized and renamedtoinsertIncludedFiles'
; the specialized versions are based on that. many1Till
: Check for the end condition before parsing (HerwigStuetz). By not checking for the end condition before the firstparse, the parser was applied too often, consuming too much of theinput. This only affectsmany1Till p end
wherep
matches on aprefix ofend
.- Provide
parseFromString
(#3690). This is a version ofparseFromString
specialied to ParserState, which resetsstateLastStrPos
at the end. This is almost always what we want.This fixes a bug where_hi_
wasn't treated as emphasis in thefollowing, because pandoc got confused about the position of thelast word:- [o] _hi_
. - Added
takeP
,takeWhileP
for efficient parsing of[Char]
. - Fix
blanklines
documentation (Alexander Krotov, #3843). - Give less misleading line information with
parseWithString
.Previously positions would be reported past the end of the chunk.We now reset the source position within the chunk and reportpositions "in chunk." - Add
anyLineNewline
(Alexander Krotov). - Provide shared F monad functions for Markdown and Org readers(Albert Krewinkel). The
F
monads used for delayed evaluationof certain values in the Markdown and Org readers are based on ashared data type capturing the common pattern of bothF
types. - Add
returnF
(Alexander Krotov). - Avoid parsing
Notes:**
as a bare URI (#3570). This avoids parsingbare URIs that start with a scheme + colon +*
,_
, or]
. - Added
readerAbbreviations
toParserState
. Markdown readernow consults this to determine what is an abbreviation. - Combine grid table parsers (Albert Krewinkel, #3638). The grid tableparsers for markdown and rst was combined into one singleparser
gridTable
, slightly changing parsing behavior of bothparsers: (1) The markdown parser now compactifies block contentcell-wise: pure text blocks in cells are now treated as paragraphsonly if the cell contains multiple paragraphs, and as plain blocksotherwise. Before, this was true only for single-column tables. (2)The rst parser now accepts newlines and multiple blocks in headercells. - Generalize tableWith, gridTableWith (Albert Krewinkel).The parsing functions
tableWith
andgridTableWith
are generalizedto work with more parsers. The parser state only has to be aninstance of theHasOptions
class instead of requiring a concretetype. Block parsers are required to return blocks wrapped into amonad, as this makes it possible to use parsers returning resultswrapped inFuture
s.
- Added
Text.Pandoc.Shared
:- Simplify
toRomanNumeral
using guards (Alexander Krotov, #3445) stringify
: handle Quoted better (#3958). Previously we were losingthe quotation marks in Quoted elements.
- Simplify
Text.Pandoc.Writers.Shared
:- Export
metaToJSON'
,addVariablesToJSON
(#3439).This allows us to add the variables AFTER using the metadatato generate a YAML header (in the Markdown writer). - Added
unsmartify
(previously in RST writer).Undo literal double curly quotes. Previously we left these. - Generalize type of
metaToJSON
so it can take a Text. Previously aString was needed as argument; now any ToJSON instance will do. - Added
gridTable
(previously in Markdown writer). gridTable
: Refactored to use widths in chars.gridTable
: remove unnecessary extra space in cells.- Fixed
addVariablesToJSON
. It was previously not allowing multiplevalues to become lists. - Pipe tables: impose minimum cell size (see #3526).
- Export
Default template changes
HTML templates (including EPUB and HTML slide show templates):
- Make default.html5 polyglot markup conformant (John Luke Bentley,#3473). Polyglot markup is HTML5 that is also valid XHTML. Seehttps://www.w3.org/TR/html-polyglot. With this change, pandoc'shtml5 writer creates HTML that is both valid HTML5 and valid XHTML.
- Regularized CSS in html/epub/html slide templates (#3485).All templates now include
code{white-space: pre-wrap}
and CSS forq
if--html-q-tags
is used. Previously some templateshadpre
and otherspre-wrap
; theq
styles were only sometimesincluded. - CSS for
.smallcaps
, (Mauro Bieg, #1592) default.revealjs
: makehistory
default to true.default.revealjs
: use lazy loading (#2283).default.revealjs
: addmathjax
variable and some conditional codeto use the MathJaX plugin.default.slidy
useshttps
instead ofhttp
(ickc, #3848).default.dzslides
: Load Google Font using HTTPS by default(Yoan Blanc).
DocBook5 template: Use
lang
andsubtitle
variables (Jens Getreu,#3855).LaTeX/Beamer template:
- Combine LaTeX/Beamer templates (Andrew Dunning, #3878).
default.beamer
has been removed; beamer now uses thedefault.latex
template. Beamer-specific parts are conditionalon thebeamer
variable set by the writer. Note thatpandoc -D beamer
will return this (combined) template. - Use
xcolor
forcolorlinks
option (Andrew Dunning, #3877).Beamer loadsxcolor
rather thancolor
, and thus thedvipsnames
option doesn't take effect. This also provides a widerrange of colour selections with thesvgnames
option. - Use starred versions of
xcolor
names (Andrew Dunning).Prevents changes to documents defined using thedvipsnames
list (e.g.Blue
gives a different result with svgnames enabled). - Load
polyglossia
after header-includes (#3898). It needs to beloaded as late as possible. - Use
unicode-math
(Vaclav Haisman). Usemathspec
with onlyXeLaTeX on request. - Don't load
fontspec
beforeunicode-math
(over there).Theunicode-math
package loadsfontspec
so explict loading offontspec
beforeunicode-math
is not necessary. - Use
unicode-math
by default in default.latex template. mathspec willbe used in xelatex if themathspec
variable is set; otherwiseunicode-math will be used (Václav Haisman). - Use
dvipsnames
options whencolorlinks
specified (otherwisewe get an error formaroon
) (Thomas Hodgson). - Added beamer
titlegraphic
andlogo
variables (Thomas Hodgson). - Fix typo in fix for notes in tables (#2378, zeeMonkeez).
- Fix
hyperref
options clash (Andrew Dunning, #3847) Avoids an optionsclash when loading a package (e.g.tufte-latex
) that useshyperref
settings different from those in the template. - Add
natbiboptions
variable (#3768). - Fix links inside captions in LaTeX output with links-as-notes(Václav Haisman, #3651). Declare our redefined
\href
robust. - Load
parskip
beforehyperref
(Václav Haisman, #3654). - Allow setting Japanese fonts when using LuaLaTeX (Václav Haisman,#3873). by using the
luatexja-fontspec
andluatexja-preset
packages. Use existingCJKmainfont
andCJKoptions
templatevariables. Addluatexjafontspecoptions
forluatexja-fontspec
andluatexjapresetoptions
forluatexja-preset
. - Added
aspectratio
variable to beamer template (Václav Haisman,#3723). - Modified template.latex to fix XeLaTex being used with tables(lwolfsonkin, #3661). Reordered
lang
variable handling toimmediately beforebidi
.
- Combine LaTeX/Beamer templates (Andrew Dunning, #3878).
ConTeXt template: Improved font handling:
simplefonts
is nowobsolete in ConTeXt (Pablo Rodríguez).
Documentation improvements
MANUAL.txt:
- Add URL for Prince HTML > PDF engine (Ian, #3919).
- Document that content above slide-level will be omitted inslide shows. See #3460, #2265.
- Explain
--webtex
SVG url (Mauro Bieg, #3471) - Small clarification in YAML metadata section.
- Document that html4 is technically XHTML 1.0 transitional.
- Remove refs to highlighting-kate (#3672).
- Document ibooks specific epub metadata.
- Clarify that mathml is used for ODT math.
- Mention limitations of Literate Haskell Support (#3410,Joachim Breitner).
- Add documentation of limitations of grid tables (StephenMcDowell, #3864).
- Clarify that meta-json contains transformed values (Jakob Voß,#3491) Make clear that template variable
meta-json
does notcontain plain text values or JSON output format but field valuestransformed to the selected output format.
COPYRIGHT:
- Clarify that templates are dual-licensed.
- Clarify that pandoc-types is BSD3 licensed.
- List new files not written by jgm (Albert Krewinkel).
- Update dates in copyright notices (Albert Krewinkel). This followsthe suggestions given by the FSF for GPL licensed software.https://www.gnu.org/prep/maintain/html_node/Copyright-Notices.html
INSTALL.md:
- Improved instructions for tests with patterns.
- Put RPM-based distros on separate point (Mauro Bieg, #3449)
CONTRIBUTING.md:
- Fixed typos (Wandmalfarbe, #3479).
- Add "ask on pandoc-discuss" (Mauro Bieg).
Add lua filter documentation in
doc/lua-filters.md
. Note that theend of this document is autogenerated fromdata/pandoc.lua
usingmake doc/lua-filters.md
, which usestools/ldoc.ltp
(Albert Krewinkel).Add
doc/filters.md
. This is the old scripting tutorial fromthe website.Add
doc/using-the-pandoc-api.md
(#3289). This gives an introductionto using pandoc as a Haskell library.
Build infrastructure improvements
Removed
data/templates
submodule. Templates are now a subtreeindata/templates
. This removes the need to dogit submodule update
.Renamed
tests
->test
.Remove
https
flag. Always build with HTTPS support.Use
file-embed
instead ofhsb2hs
to embed data files whenembed_data_files
flag is set.file-embed
gives us better dependencytracking: if a data file changes, ghc/stack/cabal know to recompilethe Data module. This also removeshsb2hs
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 ratherthan -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 executableis created, using Docker and alpine. We create both a deb and atarball. The old
deb
directory has been replaced with alinux
directory. Runningmake
in thelinux
directory shouldperform the build, putting the binary packages inartifacts/
.linux/control.in
: addReplaces:
, so existing pandoc-citeproc andpandoc-data packages will be uninstalled; this package providesboth (#3822). Add latex packages as 'suggested', updatedescription.Remove cpphs build requirement -- it is no longer needed.
Replaced
{deb,macos,windows}/stack.yaml
withstack.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 datasection of pandoc.cabal.Makefile:
- Split
make haddock
frommake full
. - Add BRANCH variable for winpkg.
- Add
lint
target. - Improve
make full
. Disable optimizations.Build everything, inc. trypandoc and benchmarks. Use parallel build. - Allow
make test
to takeTESTARGS
.
- Split
Added new command tests (
Tests.Command
), using small text filesintest/command/
. Any files added in this directory will be treatedas shell tests (see smart.md for an example). This makes it very easyto 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
pandoc 1.19.2.4 (2017-09-10)
- Add dependencies on texmath and skylighting to the executable.This is needed for dependency version numbers to be available,with Cabal > 2.
pandoc 1.19.2.3 (2017-09-09)
- Add CPP to Setup.hs so it works with Cabal >= 2 and < 2.
pandoc 1.19.2.2 (2017-09-08)
- Fix build with GHC 8.2.1 (#3876, Peter Simons). Setup.hs does notcompile with Cabal 2.x, so we require an earlier version viasetup-depends. The following packages need newer versions withGHC 8.2.1 and had their constraints relaxed accordingly:executable-path, process, syb, and time.
pandoc 1.19.2.1 (2017-01-31)
- Require skylighting >= 0.1.1.4.
- Adjust test output for skylighting version.
- Relax upper bounds on blaze-html and blaze-markup.
pandoc 1.19.2 (2017-01-29)
Use skylighting library instead of highlighting-kate for syntaxhighlighting. Skylighting is faster and more accurate (#3363).Later we'll be able to add features like warning messages, dynamicloading of xml syntax definitions, and dynamic loading of themes.
Added a new highlight style,
breezeDark
.Text.Pandoc.Highlighting: Update list of
listings
languages (#3374).This allows more languages to be used when using the--listings
option.OpenDocument writer:
- Small refactoring. Removed separate 'parent' parameter in paraStyle.
- Don't profilerate text styles unnecessarily (#3371).This change makes the writer create only as many temporarytext styles as are absolutely necessary. It also consolidatesadjacent nodes with the same style.
Org reader (Albert Krewinkel):
- Allow short hand for single-line raw blocks (Albert Krewinkel,#3366). Single-line raw blocks can be given via
#+FORMAT: raw line
,whereFORMAT
must be one oflatex
,beamer
,html
, ortexinfo
. - Accept org-ref citations followed by commas (Albert Krewinkel).Bugfix for an issue which, whenever the citation was immediatelyfollowed by a comma, prevented correct parsing of org-ref citations.
- Ensure emphasis markup can be nested. Nested emphasis markup (e.g.
/*strong and emphasized*/
) was interpreted incorrectly in that theinner markup was not recognized. - Remove pipe char irking the haddock coverage tool (Albert Krewinkel).
- Allow short hand for single-line raw blocks (Albert Krewinkel,#3366). Single-line raw blocks can be given via
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. Itshould have the same width as a row (and be filled with empty cells).
MediaWiki reader:
- Improved handling of display math (#3362). Sometimes display math isindented with more than one colon. Previously we handled these casesbadly, generating definition lists and missing the math.
- Fix quotation mark parsing (#3336, tgkokk). Change MediaWiki reader'sbehavior when the smart option is parsed to match other readers'behavior.
Markdown reader:
- Fixed
-f markdown_github-hard_line_breaks+escaped_line_breaks
(#3341). Previously this did not properly enable escaped line breaks. - Disallow space between inline code and attributes (#3326, #3323,Mauro Bieg).
- Fixed
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 cellsare 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 nolonger supported.HTML writer: don't process pars with empty RawInline, (#1040, #3327,Mauro Bieg).
Markdown writer: Fix display math with
--webtex
(#3298).Fix sample.lua so it properly handles raw blocks/inlines (#3358,bumper314).
Templates:
- default.latex: Moved geometry after hyperref (Václav Haisman).Otherwise PDF sizes can be wrong in some circ*mstances.
- Copied a few changes from default.latex to default.beamer(Wandmalfarbe).
- default.latex, default.beamer: Changed position of
\VerbatimNotes
andfancyvrb
. This fixes hyperlinks on footnotes in documentsthat contain verbatim in notes (#3361). (Note: the beamer templatewas updated to match the LaTeX template, but at this point verbatimin notes seems not to work in beamer.) - default.latex: Allow passing
microtypeoptions
to microtype(Václav Haisman). - default.latex: Add hyphen option to url package.
- default.docbook5: Fix namespace declarations (Mauro Bieg).
Moved
make_osx_package.sh
toosx/
directory.Travis continuous integration:
- Fix false positives with dist build.
- Speed improvements (Kolen Cheung, #3304, #3357).
MANUAL.txt:
- Clarify that blank space is needed around footnotes (#3352).
- Fixed typo (#3351, Alexey Rogechev).
- Note that
--wrap=auto
does not work in HTML output. - Default
--columns
width is 72, not 80. - Fixed broken links (#3316, Kolen Cheung).
- Document usage of
@*
in nocite section (#3333, John Muccigrosso).
INSTALL.md:
- Indent code so it's properly formatted (#3335, Bheesham Persaud).
- Added instructions for extracting binary from OSX, Windows packages.
CONTRIBUTING.md: Describe labels currently used in issue tracker(Albert Krewinkel). The labels have changed over time, the list oflabels is updated to reflect the current set of labels used in theissue tracker.
Rearrange and extend badges in README (Albert Krewinkel, #3354)
Bumped version bounds for dependencies.
pandoc 1.19.1 (2016-12-10)
Set
PANDOC_VERSION
environment variable for filters (#2640).This allows filters to check the pandoc version that producedthe 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 havespecial first-row formatting, which pandoc uses to determine whetheror not they have a header. This means that one-row tables will, bydefault, have only a header -- which we imagine is not what peoplewant. This change ensures that a one-row table is not understood tobe a header only. Note that this means that it is impossible toproduce a header-only table from docx, even though it is legalpandoc. But we believe that in nearly all cases, it will be anaccidental (and unwelcome) result
HTML reader:
- Fixed some bad regressions in HTML table parser (#3280).This regression leads to the introduction of empty rowsin some circ*mstances.
- Understand
style=width:
as well aswidth
incol
(#3286).
RST reader:
Print warnings when keys, substitition, notes not found.Previously the parsers failed and we got raw text. Now we get alink with an empty URL, or empty inlines in the case of a note orsubstitution.
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-leveldivisionspart
orchapter
with unnumbered headers whenemitting LaTeX. Headers are ensured to be written usingstared 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 tothis bug.
Text.Pandoc.Pretty: Added
afterBreak
[API change]. This makes itpossible to insert escape codes for content that needs escaping at thebeginning of a line.Removed old MathMLInHTML.js from 2004, which should no longerbe needed for MathML with modern browsers.
Fixed tests with dynamic linking (#2709).
Makefile: Use stack instead of cabal for targets. This is justa 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)
pandoc 1.19 (2016-12-01)
Changed resolution of filter paths.
- We now first treat the argument of
--filter
as a full (absoluteor relative) path, looking for a program there. If it's found, werun it. - If not, and if it is a simple program name or a relative path, wetry resolving it relative to
$DATADIR/filters
. - If this fails, then we treat it as a program name and look in theuser's PATH.
- Removed a hardcoded '/' that may have caused problems withWindows paths.
Previously if you did
--filter foo
and you hadfoo
in your path andalso an executablefoo
in your working directory, the one in the pathwould be used. Now the one in the working directory is used.In addition, when you do
--filter foo/bar.hs
, pandoc will now find afilter$DATADIR/filters/foo/bar.hs
-- assuming there isn't afoo/bar.hs
relative to the working directory.- We now first treat the argument of
Allow
file://
URIs as arguments (#3196). Also improved default readerformat 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 mostreasonable top-level division type when emitting LaTeX orDocbook markup. It is now possible to overwrite this implicitly settop-level division via the
top-level-division
command line parameter.Text.Pandoc.Options [API changes]:
- Removed
writerStandalone
field inWriterOptions
, madewriterTemplate
aMaybe
value. Previously settingwriterStandalone = True
did nothing unless a template was providedin writerTemplate. Now a fragment will be generated ifwriterTemplate
isNothing
; otherwise, the specified templatewill be used and standalone output generated. Division
has been renamedTopLevelDivision
(#3197). TheSection
,Chapter
, andPart
constructors were renamed toTopLevelSection
,TopLevelChapter
, andTopLevelPart
, respectively. An additionalTopLevelDefault
constructor was added, which is now also the new default value ofthewriterTopLevelDivision
field inWriterOptions
.
- Removed
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 nowlives in texmath (0.9).
DocBook reader: Fixed xref lookup (#3243). It previously only workedwhen the qnames lacked the docbook namespace URI.
HTML reader:
- Improved table parsing (#3027). We now check explicitly for non-1rowspan or colspan attributes, and fail when we encounter them.Previously we checked that each row had the same number of cells,but that could be true even with rowspans/colspans. And there arecases where it isn't true in tables that we can handle fine -- e.g.when a tr element is empty. So now we just pad rows with empty cellswhen needed.
- Treat
<math>
as MathML by default unless something else isexplicitly specified in xmlns. Provided it parses as MathML,of course. Also fixed default which should be to inline math if nodisplay attribute is used. - Only treat "a" element as link if it has href (#3226). Otherwisetreat as span.
Docx reader (Jesse Rosenthal):
- Add a placeholder value for CHART. We wrap
[CHART]
in a<span class="chart">
. Note that it maps to inlines because, indocx, anything in a drawing tag can be part of a larger paragraph. - Be more specific in parsing images We not only want
w:drawing
,because that could also include charts. Now we specifyw:drawing/pic:pic
. This shouldn't change behavior at all, but it'sa first step toward allowing other sorts of drawing data as well. - Abstract out function to avoid code repetition.
- Update tests for img title and alt (#3204).
- Handle Alt text and titles in images. We use the "description" fieldas alt text and the "title" field as title. These can be accessedthrough the "Format Picture" dialog in Word.
- Docx reader utils: handle empty namespace in
elemName
. Previously,if given an empty namespace(elemName ns "" "foo")
elemName
would output a QName with aJust ""
namespace. This is never whatwe want. Now we output aNothing
. If someone does want aJust ""
in the namespace, they can enter the QNamevalue explicitly.
- Add a placeholder value for CHART. We wrap
ODT reader/writer:
Inline code when text has a special style (Hubert Plociniczak). Whena piece of text has a text
Source_Text
then we assume that this isa piece of the document that represents a code that needs tobe inlined. Adapted the writer to also reflect that change.Previously it was just writing a 'preformatted' text using anon-distinguishable font style. Code blocks are still not recognizedby 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 theparsed tables. This commit
- checks paragraphs that follow the table definition
- treats specially a paragraph with a style named 'Table'
- does some postprocessing of the paragraphs that combines tablesfollowed immediately by captions
The ODT writer used the
TableCaption
style for the captionparagraph. This commit follows the OpenOffice approach which allowsfor appending captions to table but uses a built-in style namedTable
instead ofTableCaption
. Users of a customreference.odt
should change the style's name fromTableCaption
toTable
.
ODT reader: Infer tables' header props from rows (#3199,Hubert Plociniczak). ODT reader simply provided an empty header listwhich meant that the contents of the whole table, even if not empty, wassimply ignored. While we still do not infer headers we at least have toprovide default properties of columns.
Markdown reader:
Allow reference link labels starting with
@...
ifcitations
extension disabled (#3209). Example: in\[link text\]\[@a\]
link text
isn't hyperlinked because[@a]
is parsed asa citation. Previously this happened whether or not thecitations
extension was enabled. Now it happens only if thecitations
extension is enabled.Allow alignments to be specified in Markdown grid tables. Forexample,
+-------+---------------+--------------------+| Right | Left | Centered |+=========:+:=================+:=============:+| Bananas | $1.34 | built-in wrapper |+-------+---------------+--------------------+
Allow Small Caps elements to be created using bracketed spans (asthey already can be using HTML-syntax spans) (#3191, Kolen Cheung).
LaTeX reader:
- Don't treat
\vspace
and\hspace
as block commands (#3256).Fixed an error which came up, for example, with\vspace
insidea caption. (Captions expect inlines.) - Improved table handling. We can now parse all of the tables emittedby pandoc in our tests. The only thing we don't get yet arealignments and column widths in more complex tables. See #2669.
- Limited support for minipage.
- Allow for
[]
s inside LaTeX optional args. Fixes cases like: - Handle BVerbatim from fancyvrb (#3203).
- Handle hungarumlaut (#3201).
- Allow beamer-style
<...>
options in raw LaTeX (also in Markdown)(#3184). This allows use of things like\only<2,3>{my content}
inMarkdown that is going to be converted to beamer.
- Don't treat
Use pre-wrap for code in dzslides template (Nicolas Porcel). Otherwiseoverly long code will appear on every slide.
Org reader (Albert Krewinkel):
Respect column width settings (#3246). Table column properties canoptionally specify a column's width with which it is displayed inthe buffer. Some exporters, notably the ODT exporter in org-modev9.0, use these values to calculate relative column widths. The orgreader now implements the same behavior. Note that the org-modeLaTeX and HTML exporters in Emacs don't support this feature yet,which should be kept in mind by users who use the columnwidths parameters.
Allow HTML attribs on non-figure images (#3222). Images which arethe 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 to50%
:+ATTR\_HTML: :width 50%=======================\[\[file:image.jpg\]\]
Support
ATTR_HTML
for special blocks (#3182). Specialblocks (i.e. blocks with unrecognized names) can be prefixed with anATTR_HTML
block attribute. The attributes defined in thatmeta-directive are added to theDiv
which is used to represent thespecial block.Support the
todo
export option. Thetodo
export option allows totoggle the inclusion of TODO keywords in the output. Setting this tonil
causes TODO keywords to be dropped from headlines. The defaultis to include the keywords.Add support for todo-markers. Headlines can have optionaltodo-markers which can be controlled via the
#+TODO
,#+SEQ_TODO
,or#+TYP_TODO
meta directive. Multiple such directives can begiven, each adding a new set of recognized todo-markers. If nocustom todo-markers are defined, the defaultTODO
andDONE
markers are used. Todo-markers are conceptually separate fromheadline text and are hence excluded when autogeneratingheadline IDs. The markers are rendered as spans and labelled withtwo classes: One class is the markers name, the other signals thetodo-state of the marker (eithertodo
ordone
).
LaTeX writer:
- Use
\autocites*
when "suppress-author" citation used. - Ensure that simple tables have simple cells (#2666). If cellscontain more than a single Plain or Para, then we need to setnonzero widths and put contents into minipages.
- Remove invalid inlines in sections (#3218, Hubert Plociniczak).
- Use
Markdown writer:
- Fix calculation of column widths for aligned multiline tables(#1911, Björn Peemöller). This also fixes excessive CPU and memoryusage for tables when
--columns
is set in such a way that cellsmust be very tiny. Now cells are guaranteed to be big enough so thatsingle words don't need to line break, even if this pushes the linelength above the column width. - Use bracketed form for native spans when
bracketed_spans
enabled (#3229). - Fixed inconsistent spacing issue (#3232). Previously a tight bulletsublist got rendered with a blank line after, while a tight orderedsublist did not. Now we don't get the blank line in either case.
- Fix escaping of spaces in super/subscript (#3225). Previously twobackslashes were inserted, which gave a literal backslash.
- Adjust widths in Markdown grid tables so that they matchon round-trip.
- Fix calculation of column widths for aligned multiline tables(#1911, Björn Peemöller). This also fixes excessive CPU and memoryusage for tables when
Docx writer:
- Give full detail when there are errors converting tex math.
- Handle title text in images (Jesse Rosenthal). We already handledalt text. This just puts the image "title" into the docx"title" attr.
- Fixed XML markup for empty cells (#3238). Previously the Compactstyle wasn't being applied properly to empty cells.
HTML writer:
- Updated
renderHtml
import from blaze-html.
- Updated
Text.Pandoc.Pretty:
- Fixed some bugs that caused blank lines in tables (#3251). The bugscaused spurious blank lines in grid tables when we had things like
blankline $$ blankline
. - Add exported function
minOffet
[API change] (Björn Peemöller). - Added error message for illegal call to
block
(Björn Peemöller).
- Fixed some bugs that caused blank lines in tables (#3251). The bugscaused spurious blank lines in grid tables when we had things like
Text.Pandoc.Shared:
- Put
warn
in MonadIO. fetchItem
: Better handling of protocol-relative URL (#2635). IfURL starts with//
and there is no "base URL" (as there would beif a URL were used on the command line), then default to http:.
- Put
Export Text.Pandoc.getDefaultExtensions [API change] (#3178).
In --version, trap error in
getAppUserDataDirectory
(#3241). Thisfixes a crash withpandoc --version
on unusual systems with no realuser (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 the1.18 section where it belongs.
CONTRIBUTING.md: minor change in wording and punctuation (#3252,Kolen Cheung).
Further revisions to manual for
--version
changes (#3244).
pandoc 1.18 (2016-10-26)
Added
--list-input-formats
,--list-output-formats
,--list-extensions
,--list-highlight-languages
, and--list-highlight-styles
(#3173). Removed list of highlightinglanguages from--version
output. Removed list of input and outputformats from default--help
output.Added
--reference-location=block|section|document
option(Jesse Rosenthal). This determines whether Markdown link referencesand footnotes are placed at the end of the document, the end of thesection, 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 issection
.The--chapters
option has been deprecated in favor of--top-level-division=chapter
.Added
LineBlock
constructor forBlock
(Albert Krewinkel). Thisis now used in parsing RST and Markdown line blocks, DocBooklinegroup
/line
combinations, and Org-modeVERSE
blocks.PreviouslyPara
blocks with hard linebreaks were used.LineBlock
sare handled specially in the following ouput formats: AsciiDoc(as[verse]
blocks), ConTeXt (\startlines
/\endlines
),HTML (div
with a style), Markdown (line blocks ifline_blocks
is enabled), Org-mode (VERSE
blocks), RST (line blocks). Inother 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 whetheroutput is to tty. On Windows, pandoc works as before and always requiresan output file parameter for binary formats.
Changed JSON output format (Jesse Rosenthal). Previously we usedgenerically generated JSON, but this was subject to change dependingon the version of aeson pandoc was compiled with. To ensure stability,we switched to using manually written ToJSON and FromJSONinstances, and encoding the API version. Note: pandoc filterlibraries will need to be revised to handle the format change.Here is a summary of the essential changes:
- The toplevel JSON format is now
{"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'tmatch. - Leaf nodes no longer have an empty array for their "c" value.Thus, for example, a
Space
is encoded as{"t":"Space"}
rather than{"t":"Space","c":[]}
as before.
- The toplevel JSON format is now
Removed
tests/Tests/Arbitrary.hs
and added aText.Pandoc.Arbitrary
module to pandoc-types (Jesse Rosenthal). This makes it easierto use QuickCheck with pandoc types outside of pandoc itself.Add
bracketed_spans
Markdown extension, enabled by defaultin pandocmarkdown
. This allows you to create a native spanusing 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 slightlydifferent set of escapable symbols than original Markdown;it includes angle brackets.Export
Text.Pandoc.Error
inText.Pandoc
[API change].Print highlighting-kate version in
--version
.Text.Pandoc.Options
:Extension
has new constructorsExt_brackted_spans
andExt_angle_brackets_escapable
[API change].- Added
ReferenceLocation
type [API change] (Jesse Rosenthal). - Added
writerReferenceLocation
field toWriterOptions
(JesseRosenthal).
--filter
: we now check$DATADIR/filters
for filters beforelooking in the path (#3127, Jesse Rosenthal, thanks to JakobVoß for the idea). Filters placed in this directory need notbe 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 asdefault (Kolen Cheung).Removed
raw_tex
extension frommarkdown_mmd
defaults (Kolen Cheung).Execute .js filters with node (Jakob Voß).
Textile reader:
- Support
bc..
extended code blocks (#3037). Also, remove trailingnewline in code blocks (consistently with Markdown reader). - Improve table parsing. We now handle cell and row attributes, mostlyby skipping them. However, alignments are now handled properly.Since in pandoc alignment is per-column, not per-cell, wetry to devine column alignments from cell alignments.Table captions are also now parsed, and textile indicatorsfor thead and tfoot no longer cause parse failure. (However,a row designated as tfoot will just be a regular row in pandoc.)
- Improve definition list parsing. We now allow multiple terms(which we concatenate with linebreaks). An exponential parsingbug (#3020) is also fixed.
- Disallow empty URL in explicit link (#3036).
- Support
RST reader:
- Use Div instead of BlockQuote for admonitions (#3031).The Div has class
admonition
and (if relevant) one of thefollowing:attention
,caution
,danger
,error
,hint
,important
,note
,tip
,warning
. Note: This will changethe rendering of some RST documents! The word ("Warning", "Attention",etc.) is no longer added; that must be done with CSS or a filter. - A Div is now used for
sidebar
as well. - Skip whitespace before note (Jesse Rosenthal, #3163). RST requires aspace before a footnote marker. We discard those spaces so that footnoteswill be adjacent to the text that comes before it. This is in line withwhat rst2latex does.
- Allow empty lines when parsing line blocks (Albert Krewinkel).
- Use Div instead of BlockQuote for admonitions (#3031).The Div has class
Markdown reader:
- Allow empty lines when parsing line blocks (Albert Krewinkel).
- Allow attributes on autolinks (#3183, Daniele D'Orazio).
LaTeX reader:
- More robust parsing of unknown environments (#3026).We no longer fail on things like
^
inside options for tikz. - Be more forgiving of non-standard characters, e.g.
^
outside of math.Some custom environments give these a meaning, so we should try not tofall over when we encounter them. - Drop duplicate
*
in bibtexKeyChars (Albert Krewinkel)
- More robust parsing of unknown environments (#3026).We no longer fail on things like
MediaWiki reader:
- Fix for unquoted attribute values in mediawiki tables (#3053).Previously an unquoted attribute value in a table rowcould cause parsing problems.
- Improved treatment of verbatim constructions (#3055).Previously these yielded strings of alternating Code and Spaceelements; we now incorporate the spaces into the Code. Emphasisetc. is still possible inside these.
- Properly interpret XML tags in pre environments (#3042). They are meantto be interpreted as literal text.
EPUB reader: don't add root path to data: URIs (#3150).Thanks to @lep for the bug report and patch.
Org reader (Albert Krewinkel):
- Preserve indentation of verse lines (#3064). Leading spaces in verselines are converted to non-breaking spaces, so indentation is preserved.
- Ensure image sources are proper links. Image sources as those in plainimages, image links, or figures, must be proper URIs or relative filepaths to be recognized as images. This restriction is now enforcedfor all image sources. This also fixes the reader's usage of uncleanedimage sources, leading to
file:
prefixes not being deleted fromfigure images. Thanks to @bsag for noticing this bug. - Trim verse lines properly (Albert Krewinkel).
- Extract meta parsing code to module. Parsing of meta-data is wellseparable from other block parsing tasks. Moving into new module toget small files and clearly arranged code.
- Read markup only for special meta keys. Most meta-keys should be readas normal string values, only a few are interpreted as marked-up text.
- Allow multiple, comma-separated authors. Multiple authors can bespecified in the
#+AUTHOR
meta line if they are given as acomma-separated list. - Give precedence to later meta lines. The last meta-line of any giventype is the significant line. Previously the value of the first linewas kept, even if more lines of the same type were encounterd.
- Read LaTeX_header as header-includes. LaTeX-specific header commandscan be defined in
#+LaTeX_header
lines. They are parsed asformat-specific inlines to ensure that they will only show up in LaTeXoutput. - Set documentclass meta from LaTeX_class.
- Set classoption meta from LaTeX_class_options.
- Read HTML_head as header-includes. HTML-specific head content can bedefined in
#+HTML_head
lines. They are parsed as format-specificinlines to ensure that they will only show up in HTML output. - Respect
author
export option. Theauthor
option controls whetherthe author should be included in the final markup. Setting#+OPTIONS: author:nil
will drop the author from the final meta-dataoutput. - Respect
email
export option. Theemail
option controls whether theemail meta-field should be included in the final markup. Setting#+OPTIONS: email:nil
will drop the email field from the finalmeta-data output. - Respect
creator
export option. Thecreator
option controls whetherthe creator meta-field should be included in the final markup. Setting#+OPTIONS: creator:nil
will drop the creator field from the finalmeta-data output. Org-mode recognizes the special valuecomment
forthis field, causing the creator to be included in a comment. This isdifficult to translate to Pandoc internals and is hence interpreted thesame as other truish values (i.e. the meta field is kept if it'spresent). - Respect unnumbered header property (#3095). Sections the
unnumbered
property should, as the name implies, be excluded from the automaticnumbering of section provided by some output formats. The Pandocconvention for this is to add an "unnumbered" class to the header. Thereader treats properties as key-value pairs per default, so a specialcase is added to translate the above property to a class instead. - Allow figure with empty caption (Albert Krewinkel, #3161).A
#+CAPTION
attribute before an image is enough to turn an image intoa figure. This wasn't the case because theparseFromString
function,which processes the caption value, would fail on empty values. Addinga newline character to the caption value fixes this.
Docx reader:
- Use XML convenience functions (Jesse Rosenthal).The functions
isElem
andelemName
(defined in Docx/Util.hs) makethe code a lot cleaner than the original XML.Light functions, but theyhad been used inconsistently. This puts them in wherever applicable. - Handle anchor spans with content in headers. Previously, we would onlybe able to figure out internal links to a header in a docx if theanchor span was empty. We change that to read the inlines out of thefirst anchor span in a header.
- Let headers use exisiting id. Previously we always generated an id forheaders (since they wouldn't bring one from Docx). Now we let it use anexisting one if possible. This should allow us to recurs through anchorspans.
- Use all anchor spans for header ids. Previously we only used the firstanchor span to affect header ids. This allows us to use all the anchorspans in a header, whether they're nested or not (#3088).
- Test for nested anchor spans in header. This ensures that anchor spansin header with content (or with other anchor spans inside) will resolveto links to a header id properly.
- Use XML convenience functions (Jesse Rosenthal).The functions
ODT reader (Hubert Plociniczak)
- Include list's starting value. Previously the starting value ofthe lists' items has been hardcoded to 1. In reality ODT's liststyle definition can provide a new starting value in one of itsattributes.
- Infer caption from the text following the image.Frame can contain other frames with the text boxes.
- Add
fig:
to title for Image with a caption (as expectedby pandoc's writers). - Basic support for images in ODT documents.
- Don't duplicate text for anchors (#3143). When creating an anchorelement we were adding its representation as well as the originalcontent, leading to text duplication.
DocBook writer:
- Include an anchor element when a div or span has an id (#3102).Note that DocBook does not have a class attribute, but at least thisprovides an anchor for internal links.
LaTeX writer:
- Don't use * for unnumbered paragraph, subparagraph. The starredvariants don't exist. This helps with part of #3058...it gets rid ofthe spurious
*
s. But we still have numbers on the 4th and 5th levelheaders. - Properly escape backticks in verbatim (#3121, Jesse Rosenthal).Otherwise they can cause unintended ligatures like
?`
. - Handle NARRAOW NO-BREAK SPACE into LaTeX (Vaclav Zeman) as
\,
. - Don't include
[htbp]
placement for figures (#3103, Václav Haisman).This allows figure placement defaults to be changed by the userin the template.
- Don't use * for unnumbered paragraph, subparagraph. The starredvariants don't exist. This helps with part of #3058...it gets rid ofthe spurious
TEI writer: remove heuristic to detect book template (Albert Krewinkel).TEI doesn't have
<book>
elements but only generic<divN>
divisionelements. Checking the template for a trailing</book>
is nonsensical.MediaWiki writer: transform filename with underscores in images (#3052).
foo bar.jpg
becomesfoo_bar.jpg
. This was already donefor 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 usingthis 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 unadornedtext.
Docx Writer:
- Implement user-defined styles (Jesse Rosenthal). Divs and Spanswith a
custom-style
key in the attributes will apply the correspondingkey to the contained blocks or inlines. - Add ReaderT env to the docx writer (Jesse Rosenthal).
- Clean up and streamline RTL behavior (Jesse Rosenthal, #3140).You can set
dir: rtl
in YAML metadata, or use-M dir=rtl
on the command line. For finer-grained control, you can setthedir
attribute in Div or Span elements.
- Implement user-defined styles (Jesse Rosenthal). Divs and Spanswith a
Org writer (Albert Krewinkel):
- Remove blank line after figure caption. Org-mode only treats an imageas a figure if it is directly preceded by a caption.
- Ensure blank line after figure. An Org-mode figure should be surroundedby blank lines. The figure would be recognized regardless, but imagesin the following line would unintentionally be treated as figures aswell.
- Ensure link targets are paths or URLs. Org-mode treats links asdocument internal searches unless the link target looks like a URL orfile path, either relative or absolute. This change ensures that thisis always the case.
- Translate language identifiers. Pandoc and Org-mode use differentprogramming language identifiers. An additional translation betweenthose identifiers is added to avoid unexpected behavior. This fixes aproblem where language specific source code would sometimes be outputas example code.
- Drop space before footnote markers (Albert Krewinkel, #3162).The writer no longer adds an extra space before footnote markers.
Markdown writer:
- Don't emit HTML for tables unless
raw_html
extension is set (#3154).Emit[TABLE]
if no suitable table formats are enabled and raw HTMLis disabled. - Check for the
raw_html
extension before emitting a raw HTML block. - Abstract out note/ref function (Jesse Rosenthal).
- Add ReaderT monad for environment variables (Jesse Rosenthal).
- Don't emit HTML for tables unless
HTML, EPUB, slidy, revealjs templates: Use
<p>
instead of<h1>
forsubtitle, 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:
- Restore whitespace between paragraphs. This wasa regression in the last release (jgm/pandoc-templates#207).
- Added
themeoptions
variable (Carsten Gips). - Added
beamerarticle
variable. This causes thebeamerarticle
package to be loaded in beamer, to produce an article from beamerslides. (Carsten Gips) - Added support for
fontfamilies
structured variable(Artem Klevtsov). - Added hypersetup options (Jake Zimmerman).
LaTeX template:
- Added dummy definition for
\institute
.This isn't a standard command, and we want to avoid a crash wheninstitute
is used with the default template. - Define default figure placement (Václav Haisman), since pandocno longer includes
[htbp]
for figures. Users with custom templateswill want to add this. See #3103. - Use footnote package to fix notes in tables (jgm/pandoc-templates#208,Václav Haisman).
- Added dummy definition for
Moved template compiling/rendering code to a separate library.
doctemplates
. This allows the pandoc templating system to beused independently.Text.Pandoc.Error: Fix out of index error in
handleError
(Matthew Pickering). The fix is to not try to show the exact line whenit 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 emailaddresses. Technically
**@user
is a valid email address, but if weallow things like this, we get bad results in markdown flavorsthat autolink raw email addresses (see #2940). So we exclude a fewvalid 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 writercurrently does. The user will still get a warning about a nonexistentimage.
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:
- Put note on structured vars in separate paragraph (#2148, AlbertKrewinkel). Make it clearer that structured author variables require acustom template
- Note that
--katex
works best withhtml5
(#3077). - Fix the LaTeX and EPUB links in manual (Morton Fox).
- Document
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).
- Remove Compat.Monoid.
- Remove an inline monad compatibility macro.
- Remove Text.Pandoc.Compat.Except.
- Remove directory compat.
- Change constraint on mtl.
- Remove unnecessary CPP condition in UTF8.
- Bump base lower bound to 4.7.
- Remove 7.6 build from .travis.yaml.
- Bump supported ghc version in CONTRIBUTING.md.
- Add note about GHC version support to INSTALL.
- Remove GHC 7.6 from list of tested versions (Albert Krewinkel).
- Remove TagSoup compat.
- Add EOL note to time compat module. Because time 1.4 is a boot libraryfor GHC 7.8, we will support the compatibility module as long as wesupport 7.8. But we should be clear about when we will no longer needit.
- Remove blaze-html CPP conditional.
- Remove unnecessary CPP in custom Prelude.
pandoc 1.17.2 (2016-07-17)
Added Zim Wiki writer, template and tests.
zimwiki
is nowa valid output format. (Alex Ivkin)Changed email-obfuscation default to no obfuscation (#2988).
writerEmailObfuscation
indefaultWriterOptions
is nowNoObfuscation
.- the default for the command-line
--email-obfuscation
option isnownone
.
Docbook writer: Declare xlink namespace in Docbook5 output (Ivo Clarysse).
Org writer:
- Support arbitrary raw inlines (Albert Krewinkel).Org mode allows arbitrary raw inlines ("export snippets" in Emacsparlance) to be included as
@@format:raw foreign format text@@
. - Improve Div handling (Albert Krewinkel). Div blocks handling ischanged to make the output look more like idiomatic org mode:
- Div-wrapped content is output as-is if the div's attribute is thenull attribute.
- Div containers with an id but neither classes nor key-value pairsare unwrapped and the id is added as an anchor.
- Divs with classes associated with greater block elements arewrapped in a
#+BEGIN
...#+END
block. - The old behavior for Divs with more complex attributes is kept.
- Support arbitrary raw inlines (Albert Krewinkel).Org mode allows arbitrary raw inlines ("export snippets" in Emacsparlance) to be included as
HTML writer: Better support for raw LaTeX environments (#2758).Previously we just passed all raw TeX through when MathJaxwas used for HTML math. This passed through too much.With this patch, only raw LaTeX environments that MathJaxcan handle get passed through.This patch also causes raw LaTeX environments to be treatedas 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 pipetables can't contain one.
Make --webtex work with the Markdown writer (#1177).This is a convenient option for people usingwebsites whose Markdown flavors don't provide for math.
Docx writer:
- Set paragraph to FirstPara after display math (Jesse Rosenthal).We treat display math like block quotes, and apply FirstParagraph styleto paragraphs that follow them. These can be styled as the userwishes. (But, when the user is using indentation, this allows forparagraphs to continue after display math without indentation.)
- Use actual creation time as doc prop (Jesse Rosenthal).Previously, we had used the user-supplied date, if available, for Word'sdocument creation metadata. This could lead to weird results, as incases where the user post-dates a document (so the modification might beprior to the creation). Here we use the actual computer time to set thedocument creation.
LaTeX writer:
- Don't URI-escape image source (#2825). Usually this is a local file,and replacing spaces with
%20
ruins things. - Allow 'standout' as a beamer frame option (#3007).
## Slide title {.standout}
.
- Don't URI-escape image source (#2825). Usually this is a local file,and replacing spaces with
RST reader: Fixed links with no explicit link text. The link
`<foo>`_
should havefoo
as both its link text and its URL.See RST spec at http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#embedded-uris-and-aliasesCloses Debian #828167 -- reported by Christian Heller.Textile reader:
- Fixed attributes (#2984). Attributes can't be followed bya space. So,
_(class)emph_
but_(noclass) emph_
. - Fixed exponential parsing bug (#3020).
- Fix overly aggressive interpretation as images (#2998).Spaces are not allowed in the image URL in textile.
- Fixed attributes (#2984). Attributes can't be followed bya space. So,
LaTeX reader:
- Fix
\cite
so it is a NormalCitation not AuthorInText. - Strip off double quotes around image source if present (#2825).Avoids interpreting these as part of the literal filename.
- Fix
Org reader:
- Add semicolon to list of special chars (Albert Krewinkel)Semicolons are used as special characters in citations syntax. Thisensures the correct parsing of Pandoc-style citations:
[prefix; @key; suffix]
. Previously, parsing would have failed unless there was a spaceor other special character as the last character. - Add support for "Berkeley-style" cites (Albert Krewinkel, #1978).A specification for an official Org-mode citation syntax was drafted byRichard Lawrence and enhanced with the help of others on the orgmodemailing list. Basic support for this citation style is added to thereader.
- Support arbitrary raw inlines (Albert Krewinkel).Org mode allows arbitrary raw inlines ("export snippets" in Emacsparlance) to be included as
@@format:raw foreign format text@@
. - Remove partial functions (Albert Krewinkel, #2991).Partial functions like
head
lead to avoidable errors and should beavoided. They are replaced with total functions. - Support figure labels (Albert Krewinkel, #2496, #2999).Figure labels given as
#+LABEL: thelabel
are used as the ID of therespective image. This allows e.g. the LaTeX to add proper\label
markup. - Improve tag and properties type safety (Albert Krewinkel).Specific newtype definitions are used to replace stringly typing of tagsand properties. Type safety is increased while readability is improved.
- Parse as headlines, convert to blocks (Albert Krewinkel).Emacs org-mode is based on outline-mode, which treats documents as treeswith headlines are nodes. The reader is refactored to parse into asimilar tree structure. This simplifies transformations acting ondocument (sub-)trees.
- Refactor comment tree handling (Albert Krewinkel).Comment trees were handled after parsing, as pattern matching on listsis easier than matching on sequences. The new method of readingdocuments as trees allows for more elegant subtree removal.
- Support archived trees export options (Albert Krewinkel).Handling of archived trees can be modified using the
arch
option.Archived trees are either dropped, exported completely, or collapsed toinclude just the header when thearch
option is nil, non-nil, orheadline
, respectively. - Put export setting parser into module (Albert Krewinkel).Export option parsing is distinct enough from general block parsing tojustify putting it into a separate module.
- Support headline levels export setting (Albert Krewinkel).The depths of headlines can be modified using the
H
option. Deeperheadlines will be converted to lists. - Replace ugly code with view pattern (Albert Krewinkel).Some less-than-smart code required a pragma switching of overlappingpattern warnings in order to compile seamlessly. Using view patternsmakes the code easier to read and also doesn't require overlappingpattern checks to be disabled.
- Fix parsing of verbatim inlines (Albert Krewinkel, #3016).Org rules for allowed characters before or after markup chars were notchecked for verbatim text. This resultet in wrong parsing outcomes ofif the verbatim text contained e.g. space enclosed markup characters aspart of the text (
=is_substr = True=
). Forcing the parser to updatethe positions of allowed/forbidden markup border characters fixes this.
- Add semicolon to list of special chars (Albert Krewinkel)Semicolons are used as special characters in citations syntax. Thisensures the correct parsing of Pandoc-style citations:
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 notas a possible input or output format. A brief mention is addedeverywhere 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
andRawBlock
in sample lua custom writer (#2985).Text.Pandoc.Shared:
- Introduce blocksToInlines function (Jesse Rosenthal).This is a lossy function for converting
[Block] -> [Inline]
. Its mainuse, at the moment, is for docx comments, which can contain arbitraryblocks (except for footnotes), but which will be converted to spans.This is, at the moment, pretty useless for everything but the basicPara
andPlain
comments. It can be improved, but the docx readershould probably emit a warning if the comment contains more than this. - Add BlockQuote to blocksToInlines (Jesse Rosenthal).
- Add further formats for
normalizeDate
(Jesse Rosenthal).We want to avoid illegal dates -- in particular years with greater thanfour 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 8601actually says that years are supposed to start with 1583, but MS Wordonly allows 1601-9999. This should stop corrupted word files if the dateis out of that range, or is parsed incorrectly.- Improve year sanity check in normalizeDate (Jesse Rosenthal).Previously we parsed a list of dates, took the first one, and thentested its year range. That meant that if the first one failed, wereturned nothing, regardless of what the others did. Now we test forsanity before running
msum
over the list of Maybe values. Anythingfailing the test will be Nothing, so will not be a candidate.
- Introduce blocksToInlines function (Jesse Rosenthal).This is a lossy function for converting
Docx reader:
- Add simple comment functionality. (Jesse Rosenthal).This adds simple track-changes comment parsing to the docx reader. It isturned on with
--track-changes=all
. All comments are converted toinlines, which can list some information. In the future a warning will beadded for comments with formatting that seems like it will be excessivelydenatured. Note that comments can extend across blocks. For that reasonthere are two spans:comment-start
andcomment-end
.comment-start
will contain the comment.comment-end
will always be empty. The twowill be associated by a numeric id. - Enable warnings in top-level reader (Jesse Rosenthal).Previously we had only allowed for warnings in the parser. Now we allowfor them in the
Docx.hs
as well. The warnings are simply concatenated. - Add warning for advanced comment formatting. (Jesse Rosenthal).We can't guarantee we'll convert every comment correctly, though we'lldo the best we can. This warns if the comment includes something otherthan Para or Plain.
- Add tests for warnings. (Jesse Rosenthal).
- Add tests for comments (Jesse Rosenthal).We test for comments, using all track-changes options. Note that weshould only output comments if
--track-changes=all
. We also test foremitting warnings if there is complicated formatting.
- Add simple comment functionality. (Jesse Rosenthal).This adds simple track-changes comment parsing to the docx reader. It isturned on with
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->Lorder, so that
markdown-tex_math_dollars+tex_math_dollars
hadtex_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 displaymath. Since SoftBreak's are treated as spaces, we should strip thosetoo.
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 packagefrom 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 Hackagewouldn't accept the package.Update library dependency versions.
pandoc 1.17.1 (2016-06-04)
New output format:
docbook5
(Ivo Clarysse).Text.Pandoc.Options
: AddwriterDocBook5
toWriterOptions
(API change).Org writer:
- Add :PROPERTIES: drawer support (Albert Krewinkel, #1962).This allows header attributes to be added to org documents in the formof
:PROPERTIES:
drawers. All available attributes are stored askey/value pairs. This reflects the way the org reader handles:PROPERTIES:
blocks. - Add drawer capability (Carlos Sosa). For the implementation of theDrawer element in the Org Writer, we make use of a generic Blockcontainer with attributes. The presence of a
drawer
class definesthat theDiv
constructor is a drawer. The first class defines thedrawer name to use. The key-value list in the attributes definesthe keys to add inside the Drawer. Lastly, the list of Block elementscontains miscellaneous blocks elements to add inside of the Drawer. - Use
CUSTOM_ID
in properties (Albert Krewinkel). TheID
property isreserved for internal use by Org-mode and should not be used.TheCUSTOM_ID
property is to be used instead, it is converted to theID
property for certain export format.
- Add :PROPERTIES: drawer support (Albert Krewinkel, #1962).This allows header attributes to be added to org documents in the formof
LaTeX writer:
- Ignore
--incremental
unless output format is beamer (#2843). - Fix polyglossia to babel env mapping (Mauro Bieg, #2728).Allow for optional argument in square brackets.
- Recognize
la-x-classic
as Classical Latin (Andrew Dunning).This allows one to access the hyphenation patterns in CTAN'shyph-utf8. - Add missing languages from hyph-utf8 (Andrew Dunning).
- Improve use of
\strut
with\minipage
inside tables(Jose Luis Duran). This improves spacing in multilinetables. - Use
{}
around options containing special chars (#2892). - Avoid lazy
foldl
. - Don't escape underscore in labels (#2921). Previously they wereescaped as
ux5f
. - brazilian -> brazil for polyglossia (#2953).
- Ignore
HTML writer: Ensure mathjax link is added when math appears in footnote(#2881). Previously if a document only had math in a footnote, theMathJax link would not be added.
EPUB writer: set
navpage
variable on nav page.This allows templates to treat it differently.DocBook writer:
- Use docbook5 if
writerDocbook5
is set (Ivo Clarysse). - Properly handle
ulink
/link
(Ivo Clarysse).
- Use docbook5 if
EPUB reader:
- Unescape URIs in spine (#2924).
- EPUB reader: normalise link id (Mauro Bieg).
Docx Reader:
- Parse
moveTo
andmoveFrom
(Jesse Rosenthal).moveTo
andmoveFrom
are track-changes tags that are used when ablock of text is moved in the document. We now recognize these tags andtreat them the same asinsert
anddelete
, respectively. So,--track-changes=accept
will show the moved version, while--track-changes=reject
will show the original version. - Tests for track-changes moving (Jesse Rosenthal).
- Parse
ODT, EPUB, Docx readers: throw
PandocError
on unzip failure(Jesse Rosenthal) Previously,readDocx
,readEPUB
, andreadOdt
would error out if zip-archive failed. We change the archive extractionstep fromtoArchive
totoArchiveOrFail
, which returns an Either value.Markdown, HTML readers: be more forgiving about unescaped
&
inHTML (#2410). We are now more forgiving about parsing invalid HTML withunescaped&
as raw HTML. (Previously any unescaped&
would cause pandoc not to recognize the string as raw HTML.)Markdown reader:
- Fix pandoc title blocks with lines ending in 2 spaces (#2799).
- Added
-s
to markdown-reader-more test.
HTML reader: fixed bug in
pClose
. This caused exponential parsingbehavior in documnets with unclosed tags indl
,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):
- Stop padding short table rows.Emacs Org-mode doesn't add any padding to table rows. The firstrow (header or first body row) is used to determine the column count,no other magic is performed.
- Refactor rows-to-table conversion. This refactorsthe codes conversing a list table lines to an org table ADT.The old code was simplified and is now slightly less ugly.
- Fix handling of empty table cells, rows (Albert Krewinkel, #2616).This fixes Org mode parsing of some corner cases regarding empty cellsand rows. Empty cells weren't parsed correctly, e.g.
|||
should betwo empty cells, but would be parsed as a single cell containing a pipecharacter. Empty rows where parsed as alignment rows and dropped fromthe output. - Fix spacing after LaTeX-style symbols.The org-reader was droping space after unescaped LaTeX-style symbolcommands:
\ForAll \Auml
resulted in∀Ä
but should give∀ Ä
instead. This seems to be because the LaTeX-reader treats thecommand-terminating space as part of the command. Dropping the trailingspace from the symbol-command fixes this issue. - Print empty table rows. Empty table rows should notbe dropped from the output, so row-height is always set to be at least 1.
- Move parser state into separate module.The org reader code has become large and confusing. Extracting smallerparts into submodules should help to clean things up.
- Add support for sub/superscript export options.Org-mode allows to specify export settings via
#+OPTIONS
lines.Disabling simple sub- and superscripts is one of these export options,this options is now supported. - Support special strings export option Parsing of special strings(like
...
as ellipsis or--
as en dash) can be toggled using the-
option. - Support emphasized text export option. Parsing of emphasized text canbe toggled using the
*
option. This influences parsing of text markedas emphasized, strong, strikeout, and underline. Parsing of inline math,code, and verbatim text is not affected by this option. - Support smart quotes export option. Reading of smart quotes can betoggled using the
'
option. - Parse but ignore export options. All known export options are parsedbut ignored.
- Refactor block attribute handling. A parser state attribute was usedto keep track of block attributes defined in meta-lines. Global stateis undesirable, so block attributes are no longer saved as part of theparser state. Old functions and the respective part of the parser stateare removed.
- Use custom
anyLine
. Additional state changes need to be made aftera newline is parsed, otherwise markup may not be recognized correctly.This fixes a bug where markup after certain block-types would not berecognized. - Add support for
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 thesewhen exporting to HTML, but since we cannot make this distinction here,the attributes are always added. The functionality is now supportedfor figures. - Add
:PROPERTIES:
drawer support (#1877).Headers can have optional:PROPERTIES:
drawers associated with them.These drawers contain key/value pairs like the header'sid
. Thereader adds all listed pairs to the header's attributes;id
andclass
attributes are handled specially to match the wayAttr
aredefined. This also changes behavior of how drawers of unknown typeare handled. Instead of including all unknown drawers, those are notread/exported, thereby matching current Emacs behavior. - Use
CUSTOM_ID
in properties. See above on Org writer changes. - Respect drawer export setting. The
d
export option can be usedto control which drawers are exported and which are discarded.Basic support for this option is added here. - Ignore leading space in org code blocks (Emanuel Evans, #2862).Also fix up tab handling for leading whitespace in code blocks.
- Support new syntax for export blocks. Org-mode version 9uses a new syntax for export blocks. Instead of
#+BEGIN_<FORMAT>
,where<FORMAT>
is the format of the block's content, the newformat uses#+BEGIN_export <FORMAT>
instead. Both types aresupported. - Refactor
BEGIN...END
block parsing. - Fix handling of whitespace in blocks, allowing content to be indentedless then the block header.
- Support org-ref style citations. The org-ref package is anorg-mode extension commonly used to manage citations in orgdocuments. Basic support for the
cite:citeKey
and[[cite:citeKey][prefix text::suffix text]]
syntax is added. - Split code into separate modules, making for cleaner code andbetter decoupling.
Added
docbook5
template.--mathjax
improvements:- Use new CommonHTML output for MathJax (updated default MathJax URL,#2858).
- Change default mathjax setup to use
TeX-AMS_CHTML
configuration.This is designed for cases where the input is always TeX and maximalconformity with TeX is desired. It seems to be smaller and load fasterthan what we used before. See #2858. - Load the full MathJax config to maximize loading speed (KolenCheung).
Bumped upper version bounds to allow use of latest packagesand 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 positioningand matrix column alignment in docx.README:
- Clarified documentation of
implicit_header_references
(#2904). - Improved documentation of
--columns
option.
- Clarified documentation of
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 perhapscan find some other usages. Example usage in YAML metadata:
fontfamilies: - name: \cyrillicfont font: Liberation Serif - name: \cyrillicfonttt options: Scale=MatchLowercase font: Liberation
Create unsigned msi as build artifact in appveyor build.
On travis, test with ghc 8.0.1; drop testing for ghc 7.4.1.
pandoc 1.17.0.3 (2016-03-24)
- LaTeX writer: Fixed position of label in figures (#2813).Previously the label wasn't in the right place, and
\ref
wouldn't work properly. - Added .tei test files to pandoc.cabal so they'll be includedin tarball (#2811).
- Updated copyright dates.
pandoc 1.17.0.2 (2016-03-23)
- Fixed serious regression in
htmlInBalanced
, which causednewlines to be omitted in some raw HTML blocks in Markdown(#2804).
pandoc 1.17.0.1 (2016-03-21)
- File scope is no longer used when there are no input files (i.e.,when input comes from stdin). Previously file scope was triggeredwhen the
json
reader was specified and input came fromstdin
,and this caused no output to be produced. (Fix due to Jesse Rosenthal;thanks to Fedor Sheremetyev for calling the bug to our attention.) - Improved documentation of templates (#2797).
pandoc 1.17 (2016-03-20)
Added
--file-scope
option (Jesse Rosenthal).By default pandoc operates on multiple files by first concatenatingthem (around extra line breaks) and then processing the joined file. Soit only parses a multi-file document at the document scope. This has thebenefit that footnotes and links can be in different files, but forsome purposes it is useful to parse the individual files firstand then combine their outputs (e.g. when the files use footnotesor links with the same labels). The--file-scope
option causespandoc to parse the files first, and then combine the parsed output,instead of combining before parsing.--file-scope
is selectedautomatically 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 docxreader (API change, Jesse Rosenthal).Add
readDocxWithWarnings
(API change, Jesse Rosenthal).Changed type of
Shared.uniqueIdent
argument from[String]
toSet String
. This avoids performance problems in documentswith many identically named headers (API change, #2671).Removed
tex_math_single_backslash
frommarkdown_github
options(#2707).Make language extensions as well as full language namestrigger syntax highlighting. For example,
py
will now work aswell aspython
(jgm/highlighting-kate#83).Added
institute
variable to latex, beamer templates (FraserTweedale, Josef Svenningsson).Docx reader (Jesse Rosenthal):
- Handle alternate content. Some word functions (especially graphics)give various choices for content so there can be backwards compatibility.
- Don't turn numbered headers into lists.
- Docx Reader: Add state to the parser, for warnings
- Update feature checklist in source code.
- Get rid of
Modifiable
typeclass. - Add tests for adjacent hyperlinks.
- Add a "Link" modifier to
Reducible
. We want to make sure thatlinks have their spaces removed, and are appropriately smushedtogether (#2689).
HTML reader:
- Fixed behavior of base tag (#2777).If the base path does not end with slash, the last componentwill be replaced. E.g. base =
http://example.com/foo
combines withbar.html
to givehttp://example.com/bar.html
.If the href begins with a slash, the whole path of the baseis replaced. E.g. base =http://example.com/foo/
combineswith/bar.html
to givehttp://example.com/bar.html
. - Rewrote
htmlInBalanced
. This version avoids an exponentialperformance problem with<script>
tags, and it should be fasterin general (#2730). - Properly handle an empty cell in a simple table (#2718).
- Handle multiple
<meta>
tags with same name. Put them in a listin the metadata so they are all preserved, rather than (as before)throwing out all but one..
- Fixed behavior of base tag (#2777).If the base path does not end with slash, the last componentwill be replaced. E.g. base =
Markdown reader:
- Improved pipe table parsing (#2765).
- Allow
+
separators in pipe table cells. We already allowedthem in the header, but not in the body rows, for some reason.This gives compatibility with org-mode tables. - Don't cross line boundary parsing pipe table row.Previously an Emph element could be parsed across the newlineat the end of the pipe table row.
- Use
htmlInBalanced
forrawVerbatimBlock
, for betterperformance (#2730). - Fixed bug with smart quotes around tex math.
LaTeX reader:
- Handle interior
$
characters in math (#2743). For example,$$\hbox{$i$}$$
. inlineCommand
now gobbles an empty{}
after any command (#2687).This gives better results when people write e.g.\TeX{}
in Markdown.- Properly handle LaTeX "math" environment as inline math (#2171).
- Handle interior
Textile reader: Support
>
,<
,=
,<>
text alignment attributes.Closes #2674.Org reader (Albert Krewinkel):
- Prefix even empty figure names with "fig:" (#2643). Theconvention used by pandoc for figures is to mark them by prefixingthe name with
fig:
. The org reader failed to do this if a figurehad no name. - Refactor link-target processing (#2684).
- Prefix even empty figure names with "fig:" (#2643). Theconvention used by pandoc for figures is to mark them by prefixingthe name with
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 offalignment attributes altogether (#2694).
Markdown writer: Use hyphens for YAML metadata block bottom line, forbetter compatibility with other Markdown flavors (Henrik Tramberend).
LaTeX writer:
- Use image identifier to create a label and hypertarget forfigures (Mauro Bieg).
- Avoid double toprule in headerless table with caption (#2742).
- Clean up options parser (Jesse Rosenthal).
- Treat
memoir
template witharticle
option as article, insteadof treating allmemoir
templates as books. - Allow more flexible table alignment (Henrik Tramberend, #2665).New default is not to include
[c]
option (which is the defaultanyway if no positioning is specified). Now LaTeX emplates cancontrol the overall table alignment in a document by setting thelongtable length variablesLTleft
andLTright
. 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-relatedproblems (#2734).Allow
zip-archive
0.3.Allow
aeson
0.11.
pandoc 1.16.0.2 (2016-01-12)
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, everythingfrom the open quote to the end of the paragraph was being dropped.
pandoc 1.16.0.1 (2016-01-10)
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 tostore 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 isnow rendered with surrounding
{}
, as it was before 1.16.Entity handling fixes: improved handling of entities like
⟨
that require a trailing semicolon. Allow uppercasex
in numerical hexidecimal character references, workingaround a tagsoup bug.stack.yaml
- use lts-4.0, but with older aeson to avoid excessivememory use on compile. With aeson 0.10 we were getting an out ofmemory error on a 2GB Ubuntu 64-bit VM.Improved deb package creation script. Made
DPKGVER
work.RenamedCOMMIT
toTREE
. You should now be able to doTREE=1.16.0.1 DPKGVER=2 make deb
.
pandoc 1.16 (2016-01-02)
Added
Attr
field toLink
andImage
(Mauro Bieg, #261, API change).- Added syntax for link and image attributes to pandoc's Markdown.
- Updated readers and writers to use link and image attributeswhen appropriate.
- Support image attributes in Docx, Textile, RST readers.
Renamed link attribute extensions. The old
link_attributes
isnowmmd_link_attributes
, andlink_attributes
now enables thenew 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.- Command line option: deprecated
--no-wrap
, added--wrap=[auto|none|preserve]
- Added
WrapOption
, exported fromText.Pandoc.Options
- Changed type of
writerWrapText
inWriterOptions
fromBool
toWrapOption
. - Modified
Text.Pandoc.Shared
functions to allowSoftBreak
. - Supported
SoftBreak
in readers and writers.
- Command line option: deprecated
Text.Pandoc.Options: Added
writerDpi
toWriterOptions
(APIchange, 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 readeras 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 marksand dashes. And the LaTeX writer will print unicode quotationmark and dash characters literally, rather than convertingthem to the standard ASCII ligatures. Note that--smart
hasno effect on the LaTeX reader.--smart
is still the defaultfor 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
notcz
) (#2597).Implemented
east_asian_line_breaks
extension (#2586).InText.Pandoc.Options
, addedExt_east_asian_line_breaks
constructortoExtension
(API change). This extension is likeignore_line_breaks
, but smarter -- it only ignores line breaksbetween two East Asian wide characters. This makes it better suitedfor 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 variablesmargin-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 idwas being parsed as@foo:
.ICML writer:
- Fixed image syntax for local files (#2589).
- Changed type of
writeICML
(Mauro Bieg).API change: It is nowWriterOptions -> Pandoc -> IO String
.Also handle new image attributes. - Intersperse line breaks instead of appending them toevery
ParagraphStyleRange
(Mauro Bieg, #2501). - Add
Cite
style to citations (Mauro Bieg). - Added figure handling (#2590, Mauro Bieg).
- Better handling of math. Instead of just printing the raw tex,we now try to fake it with unicode characters.
HTML writer: Include
example
class for example lists (#2524).ODT/OpenDocument writer: improved image attributes (Mauro Bieg).
- Support for percentage widths/heights
- Use
Attr
instead of title to get dimensions from ODT walkertowriteOpenDocument
.
AsciiDoc writer:
- Support anchors in spans and divs with id elements(jgm/pandoc-citeproc#143).
- Fixed code blocks (#1861).
Haddock writer: omit formatting inside links, which isn't supportedby Haddock (#2515).
MediaWiki writer: Fixed spacing issues in table cells.
- Start cell on new line unless it's a single Para or Plain(#2606).
- For single Para or Plain, insert a space after the
|
toavoid problems when the text begins with a character like-
(#2604).
Beamer writer: mark frame as fragile when it contains verbatim (#1613).
LaTeX writer:
- Add support for GAP highlighting using listings (Raniere Silva).
- Consider
header-includes
content as well as templateswhen determining whether to use csquotes (Andreas Lööw). - Create defaults for geometry using
margin-left
etc.Ifgeometry
has no value, butmargin-left
,margin-right
,margin-top
, and/or-margin-bottom
are given, a default valueforgeometry
is created from these. Note that these variablesalready affect PDF production via HTML5 withwkhtmltopdf
.
ConTeXt writer: set default layout based on
margin-left
, etc.This sets up\setuplayout
based on the variablesmargin-left
,margin-right
,margin-bottom
, andmargin-top
, if no layoutis given.Docx writer: better handling of PDF images. Previously we triedto get the image size from the image even if an explicit size wasspecified. Since we still can't get image size for PDFs, this madeit impossible to use PDF images in docx. Now we don't try to getthe image size when a size is already explicitly specified.
Markdown writer: use raw HTML for link/image attributes whenthe
link_attributes
extension is unset andraw_html
is set (#2554).MediaWiki reader: interpret markup inside
<tt>
,<code>
(#2607).LaTeX reader:
- Improved smart quote parsing (#2555). This fixes redering ofunmatched quotes.
- Use curly quotes for unmatched ` (#2555).
- Allow blank space between braced arguments of commands (#2592).
Markdown reader:
- Improved pipe table relative widths. Previously pipe tablecolumns got relative widths (based on the header underscore lines)when the source of one of the rows was greater in width than thecolumn width. This gave bad results in some cases where much ofthe width of the row was due to nonprinting material (e.g. linkURLs). Now pandoc only looks at printable width (the width of aplain string version of the source), which should give better results.Thanks to John Muccigrosso for bringing up the issue.
- Fixed parsing bug with macros. Previously macro definitions inindented code blocks were being parsed as macro definitions, not code.
Textile reader: skip over attribute in image source (#2515).We don't have a place yet for styles or sizes on images, butwe can skip the attributes rather than incorrectly taking themto 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 thebullet. It doesn't refer to any real list item, and we used to ignoreit.
CommonMark reader/writer rewritten to use latest
cmark
.Fixed Emoji character definitions (#2523). There were many bugs in thedefinitions.
Text.Pandoc.CSS
:- Added
pickStylesToKVs
function to extract multiple properties atonce (API change, Mauro Bieg). - Parse CSS that doesn't contain the optional semicolon (Mauro Bieg).
- Added
trypandoc
: sort drop-down lists.Beamer template:
- Made
\euro
conditional on presence of character.for xelatex and lualatex, as it is for pdflatex (Andrew Dunning). - Moved
header-includes
before setting of title (Thomas Hodgson),to match the LaTeX template (jgm/pandoc-templates#168). - Added
section-titles
variable (defaults to true)to enable/suppress section title pages in beamerslide shows (Thomas Hodgson). - Moved beamer themes after fonts, so that themes canchange fonts. (Previously the fonts set were beingclobbered by lmodern.sty.) (Thomas Hodgson).
- Made
Beamer/LaTeX template changes (Thomas Hodgson):
- Added
thanks
variable - Use
parskip.sty
whenindent
isn't set (fall back to usingsetlength
as before ifparskip.sty
isn't available). - Use
biblio-style
with biblatex. - Added
biblatexoptions
variable.
- Added
LaTeX template changes:
- Added
paper
after$papersize$
variable in latex template.Thus you can saypapersize: a4
and the latex will containa4paper
. This change may break some existing workflows; ifyou currently specifya4paper
, you'll geta4paperpaper
whichis meaningless. However, the change seems worth it, as it willmake thepapersize
variable work uniformly across ConTeXt, LaTeX,and html->pdf via wkhtmltopdf. - Only pass options to color package if
colorlinks
is set(Andrew Dunning). - Make definition of
\euro
conditional in xelatex/lualatex,as it is already for pdflatex (Andrew Dunning). - Removed setting of
subject
in PDF metadata.This used to be set to the subtitle, but really the subtitleneed not give the subject. Also,subtitle
can contain formatting,so we'd need, at least, a plain text version for this. - Moved
header-includes
before setting of\title
,\author
,etc. This allows these macros to be redefined. - Use
\subtitle
command forsubtitle
, instead of tacking iton to the title as before. We give a no-op fallback definition if itis not defined. This change should produce much better resultsin classes that support\subtitle
. With the default articleclass, which does not define\subtitle
, subtitles will nolonger be printed unless the user defines\subtitle
andredefines\maketitle
. - Moved redefinitions of
\paragraph
and\subparagraph
tobefore header-includes.
- Added
Context template:
- Use
simplefonts
for font loading (Paolo Rodríguez). This isneeded for things to work on ConTeXt stable from TeXLive 2015. - Revert use of
\setuphead
in title block (Andrew Dunning,Rik Kabel).
- Use
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
,andframe
. Note that this changes the default behavior fromhorizontal
toempty
. Closes #2543.Added
toc
to HTML slide format templates (Andrew Dunning),so that--toc
creates a contents slide.Added
stack.full.yaml
to buildpandoc-citeproc
as well.Allow pipe tables with no body rows (#2556).Previously this raised a runtime error.
Shared: Improved
fetchItem
so thatC:/Blah/Blah.jpg
isn't treatedas URL. The Haskell URI parsing routines will accept "C:" as ascheme, 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 containsa JSON version of all the metadata, in the format selected for thewriter. So, for example, to get just the YAML metadata, you can runpandoc with the following custom template:$meta-json$
. The intentis to make it easier for static site generators and other tools to getat the metadata.Document limitations of --self-contained (#2553).
Improved Citations section of README (#2551). Added informationabout
link-citations
and a link to the pandoc-citeproc man page.ImageSize
: usesafeRead
instead ofreadMaybe
, which isn'tin 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 thisonly worked if--bibliography
was spelled out in full, and notif--biblio
was used.reveal.js: Interpret pauses correctly for all headers (#2530).Previously, when using headers below the slide level, pauses are leftuninterpreted into pauses. In my opinion, unexpected behavior butintentional looking at the code.
Remove redundant
center
variable for reveal.js (Andrew Dunning).Parsing: Add
extractIdClass
, modified type ofKeyTable
(MauroBieg, API change).ImageSize: Added functions for converting between image dimensions(Mauro Bieg).
Use lts-3.18 in stack.yaml. This avoids Windows buildissues with the HTTP library.
Bump version bounds for dependencies.
pandoc 1.15.2.1 (2015-11-16)
Added two missing test files, and
stack.yaml
, toextra-source-files
so they're included in the source tarball.reveal.js template: Fixed parallaxBackground options.
parallaxBackgroundHorizontal
andparallaxBackgroundVertical
need integer values, not strings. (Vaughn Iverson)
pandoc 1.15.2 (2015-11-15)
pandoc my.md -t context -o my.pdf
will now create a PDF usingConTeXt rather than LaTeX (#2463).Fixed omitted
url(...)
in CSS data-uri with--self-contained
(#2489).Added
emoji
Markdown extension, enabled by default inmarkdown_github
(#2523). AddedExt_emoji
toExtension
inText.Pandoc.Options
(API change).Text.Pandoc.Readers.HTML.parseTags
: Fixed over-eager raw HTML inlineparsing (#2469). Tightened up the inline HTML parser so it disallowsTagWarnings.Derive
Generic
instances for the types inText.Pandoc.Options
.Org reader:
- Fix paragraph/list interaction (Albert Krewinkel, #2464).Paragraphs can be followed by lists, even if there is no blank linebetween the two blocks. However, this should only be true if theparagraph is not within a list, were the preceding block should beparsed as a plain instead of paragraph (to allow for compact lists).Thanks to @rgaiacs for bringing this up.
- Allow toggling header args (Albert Krewinkel, #2269).Org-mode allows to skip the argument of a code block header argument ifit's toggling a value. Argument-less headers are now recognized,avoiding weird parsing errors.
- Fix markup parsing in headers (Albert Krewinkel, #2504).Markup as the very first item in a header wasn't recognized. This wascaused by an incorrect parser state: positions at which inline markupcan start need to be marked explicitly by changing the parser state.This wasn't done for headers. The proper function to update the stateis now called at the beginning of the header parser, fixing this issue.
- Fix emphasis rules for smart parsing (Albert Krewinkel, #2513).Smart quotes, ellipses, and dashes should behave like normal quotes,single dashes, and dots with respect to text markup parsing.
- Require whitespace around definition list markers (#2518).This rule was not checked before, resulting in bugs with footnotesand some link types.
Markdown reader:
- Pipe tables with long lines now get relative cell widths (#2471).If a pipe table contains a line longer than the column width (as set by
--columns
or 80 by default), relative widths are computed based on thewidths of the separator lines relative to the column width. This shouldsolve persistent problems with long pipe tables in LaTeX/PDF output, andgive more flexibility for determining relative column widths in otherformats, too. For narrower pipe tables, column widths of 0 are used,telling pandoc not to specify widths explicitly in output formats thatpermit this. - Improved parser for
mmd_title_block
. We now allow blank metadatafields. These were explicitly disallowed before. - Citation keys can now contain
://
, so URLs and DOIs can be usedas citation keys (jgm/pandoc-citeproc#166).
- Pipe tables with long lines now get relative cell widths (#2471).If a pipe table contains a line longer than the column width (as set by
Beamer template: fix incompatibility of section slides with natbib.Natbib (and presumably biblatex) bibliography commands createtheir own section. Since these are in frame environments,we have an incompatibility with the
\AtBeginSection
macrowhich 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 forbringing the problem to my attention. This supersedes #145. Seediscussion there.Textile reader: don't do smart punctuation unless explicitly asked(#2480). Note that although smart punctuation is part of the textilespec, it's not always wanted when converting from textileto, say, Markdown. So it seems better to make this an option.
LaTeX reader: Handle
comment
environment (Arata Mizuki).Thecomment
environment is handled in a similar way to theverbatim
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 collectlang
anddir
attributes on spans anddivs to set thelang
,otherlangs
anddir
variables if they aren’t setalready. See #895.LaTeX writer:
- Use proper command for
\textarabic
(mb21). - Added
de-CH-1901
, fixedel-polyton
intoPloyglossia
(Nick Bart). - Use
\hypertarget
and\hyperlink
for links. This works correctlyto link to Div or Span elements. We now don't bother defining\label
for Div or Span elements. Closes jgm/pandoc-citeproc#174. - Avoid footnotes in list of figures (#1506).
- Properly handle footnotes in captions (#1506).
- Add
\protect
to\hyperlink
(#2490). Thanks to Hadrien Mary. - Set
colorlinks
iflinkcolor
,urlcolor
,citecolor
, ortoccolor
is set (#2508).
- Use proper command for
Textile writer: support start number in ordered lists (#2465).
OpenDocument writer: Allow customization of opendocumentautomatic styles. Automatic styles can now be inserted in thetemplate, 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
attributeset (#2473). By default pandoc downloads all linked media and includes itin the EPUB container. This can be disabled by settingdata-external
onthe 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 columnsseparated far apart.
AsciiDoc template: Fix
author
anddate
; addkeywords
,abstract
(Andrew Dunning).HTML-based templates (Andrew Dunning):
- Use en dash instead of hyphen between title prefix and title.
- Add
keywords
to metadata. - Add
lang
,dir
,quotes
where missing. - Always make author and date display conditional.
- Updated dzslides template from source.
Man template: make "generated by" comment conditional.
LaTeX, Beamer templates:
- Add
babel-otherlangs
for language divs/spans;babel-newcommands
,filled by commands that make babel understand the polyglossia-stylelanguage directives (mb21, #137). - Improved formatting of conditionals;
$for$
is always provided to allowmultiple options (Andrew Dunning, #141). - Use
Ligatures=TeX
rather thanMapping=tex-text
withfontspec
to improve support for LuaTeX (Andrew Dunning, #135). - Revise
hyperref
usage (Andrew Dunning, #139, #141):- use same options for all LaTeX engines;
- add
subtitle
andkeywords
to PDF metadata; - do not override
hyperref
link coloring without user input, effectively makingthehidelinks
option the default (removed as a separate variable); - link colors can be enabled (using a slightly darker version of the olddefaults) using a new
colorlinks
variable, automatically used bythe LaTeX writer when custom colors are specified; pdfborder={0 0 0}
is automatically set byhyperref
withcolorlinks
, and is only applied ifcolorlinks
is disabled.
- Add
ConTeXt template (Andrew Dunning):
- New variables for controlling styles:
linkstyle
,linkcolor
,linkcontrastcolor
,layout
,pagenumbering
,whitespace
,indenting
,interlinespace
,headertext
,footertext
,mainfont
,sansfont
,monofont
,mathfont
,fontsize
. - Default template no longer supports MkII.
- Improve writing of title block (suppressing numbering of first page).
- Add
title
subtitle
,author
,date
,keywords
to PDF metadata. - Support
subtitle
,abstract
. - Support list of figures (
lof
), list of tables (lot
). - Disable link styling by default.
- Define styles for all section types.
- Enable microtype.
- Improved formatting of conditionals.
- New variables for controlling styles:
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 bibliographyslides.OpenDocument template: Add
<office:automatic-styles>
tag aroundautomatic styles. The writer now longer provides this (see #2520).Restored Text.Pandoc.Compat.Monoid.
Do not export (<>) from custom Prelude. The Prelude now matchesbase 4.8 Prelude's API.
Don't use custom prelude with ghc 7.10. Use the custom preludeonly for earlier versions. This change makes
stack ghci
andcabal 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 packagefrom commit blah.
README:
- Consistent capitalization for pandoc and Markdown.
- Fixed
auto_identifiers
examples (Benoit Schweblin). - Improved documentation of template variables (Andrew Dunning).
pandoc 1.15.1 (2015-10-15)
pandocVersion
is now defined inText.Pandoc.Shared
and reexported fromText.Pandoc
(Alex Vong). This allowswriters to access it. (Alex Vong) (API change)For
markdown_mmd
, add:implicit_figures
,superscripts
,subscripts
(#2401).Added
odt
as input format (MarLinn). Added new moduleText.Pandoc.Reader.ODT
(API change). Fully implemented features:Paragraphs, Headers, Basic styling, Unordered lists, Ordered lists,External Links, Internal Links, Footnotes, Endnotes, Blockquotes.Partly implemented features: Citations, Tables.Markdown Reader:
- Add basic tests for each header style (Ophir Lifsh*tz).
- Add implicit header ref tests for headers with spaces (Ophir Lifsh*tz).
- Skip spaces in headers (Ophir Lifsh*tz).
- Handle 'id' and 'class' in parsing key/value attributes (#2396).
# Header {id="myid" class="foo bar"}
is now equivalent to# Header {#myid .foo .bar}
. - Use '=' instead of '#' for atx-style headers in markdown+lhs.(Kristof Bastiaensen)
- Pipe tables: allow indented columns. Previously the left-hand columncould not start with 4 or more spaces indent. This was inconvenientfor right-aligned left columns. Note that the first (header column)must still have 3 or fewer spaces indentation, or the table will betreated as an indented code block.
- Fix regression: allow HTML comments containing
--
.Technically this isn't allowed in an HTML comment, butwe've always allowed it, and so do most other implementations.It is handy if e.g. you want to put command line argumentsin HTML comments.
LaTeX reader:
- Don't eat excess whitespace after macros with only optionalarguments (#2446).
- Support longtable (#2411).
- Implement
\Cite
(#2335). - Support abstract environment. The abstract populates an
abstract
metadata field. - Properly handle booktabs lines. Lines aren't part of thepandoc table model, so we just ignore them (#2307).
HTML reader:
- Handle type attribute on ol, e.g.
<ol type="i">
(#2313). - Updated for new automatic header attributes.
- Add auto identifiers if not present on headers. This makesTOC linking work properly.
- Detect
font-variant
withpickStyleAttrProps
(Ophir Lifsh*tz). - Test
<ol>
type, class, and inline list-style(-type) CSS(Ophir Lifsh*tz). - Better handling of "section" elements (#2438). Previously
<section>
tags were just parsed as raw HTML blocks. Withthis change, section elements are parsed as Div elements withthe class "section".
- Handle type attribute on ol, e.g.
MediaWiki reader: handle unquoted table attributes (#2355).
DocBook reader:
- Added proper support for DocBook
xref
elements (Frerich Raabe).AddeddbContent
field to reader state, so we can lookupcross refs. - Handle
informalexample
(#2319).
- Added proper support for DocBook
Docx Reader:
- Create special punctuation test (Ophir Lifsh*tz).
- Parse soft, no-break hyphen elements (Ophir Lifsh*tz).
- Updated headers test (Ophir Lifsh*tz). Replaced
styles.xml
inheaders.docx
with pandoc's currentstyles.xml
, whichcontains styles for Heading 1 through 6. Added Heading 4through 7 to the test document. Note that Heading 7 is notparsed as a Heading because there is no Heading 7 style.
RST reader: better handling of indirect roles.Previously the parser failed on this kind of case
.. role:: indirect(code).. role:: py(indirect) :language: python:py:`hi`
Now it correctly recognizes
:py:
as a code role.Org reader:
- Add auto identifiers if not present on headers(#2354, Juliusz Gonera).
- Allow verse blocks to contain empty lines (#2402,Albert Krewinkel).
EPUB reader: stop mangling external URLs (#2284).
RST writer:
- Don't insert
\
when complex expression in matched pairs.E.g.[:sup:`3`]
is okay; you don't need[:sup:`3`\ ]
. - Ensure that
\
is inserted when needed before Cite and Spanelements that begin with a "complex" element (jgm/pandoc-citeproc#157). - Normalize headers only in "standalone" mode (#2394).
- Don't insert
Haddock writer: escape
*
and^
(G. Bataille).Markdown writer:
- In TOC, add links to headers (#829).
- Use unicode super/subscripts for digits in plain output(when the
superscripts
andsubscripts
extensions arenot enabled).
Docx writer:
- Moved invalid character stripping to
formattedString
.This avoids an inefficient generic traversal (#2356). - Use user data directory for
reference.docx
archive.This allows the test suite to work without installing pandoc first.It also brings the docx writer in line with the odt writer. - Tests: docx writer tests now use
../data
for data directory.This allows tests to be run without installing first. - Tests: Use real jpg (not empty) for docx tests to avoid warning.
- Moved invalid character stripping to
LaTeX writer:
- Fixed detection of 'chapters' from template.If a documentclass isn't specified in metadata, but thetemplate has a hardwired bookish documentclass, act as if
--chapters
was used. This was the default in earlierversions, but it has been broken for a little while. - Correctly recognize book documentclass in metadata (#2395).
- Set language-related variables automatically, dependingon the value of the
lang
field, which is now alwaysassumed to be in BCP47 format (mb21, #1614, #2437). - Add
\protect
to\hyperdef
in inline context. This way wedon't get an error when this is used as a moveable argument (#2136). - Support all frame attributes in Beamer.
- Percent-encode more special characters in URLs (#1640, #2377).The special characters are '<','>','|','"','{','}','[',']','^', '`'.
- Fixed detection of 'chapters' from template.If a documentclass isn't specified in metadata, but thetemplate has a hardwired bookish documentclass, act as if
HTML writer:
- Update KaTeX JS and CSS versions (Emily Eisenberg).
- For dzslides, add
role="note"
for speaker notes (#1693). - Percent-encode more special characters in URLs (#1640, #2377).The special characters are '<','>','|','"','{','}','[',']','^', '`'.
- Render Div with class
section
as<section>
in HTML5.
EPUB writer:
- In TOC, replace literal
<br/>
with space (#2105). - With
--webtex
, include image file rather thandata:
URI (#2363).
- In TOC, replace literal
Native writer: format Div properly, with blocks separated.
Support bidirectional text output with XeLaTeX, ConTeXt and HTML(#2191, mb21).
Reference Docx:
- Add missing Header 6 style (steel blue) (Ophir Lifsh*tz).
- Correct
outlineLvl
for Header styles (Ophir Lifsh*tz).
Templates
- Beamer: Add
innertheme
,outertheme
variables(Guilhem Bonnefille, #121). Add space after colon in figure caption.Integrate recent font and language updates from LaTeX template;allow use ofmainfont
variable for changing the slide textin XeTeX and LuaTeX (Andrew Dunning, #131). - LaTeX: Add
mainfontoptions
,sansfontoptions
,monofontoptions
,mathfontoptions
,fontfamilyoptions
(Andrew Dunning, #122). Support handling of bidirectionaltext (mb21, #120). Improve reliability of superscripts/subscriptsunder XeTeX and prevent letters and numbers from appearing on adifferent baseline by removing use of therealscripts
package(viaxltxtra
). To restore use of OpenType characters for thesefeatures under XeTeX or LuaTeX, add\usepackage{realscripts}
toheader-includes
(Andrew Dunning, #130). Remove redundantreference toxunicode
(Andrew Dunning, #130). Addfontenc
,indent
,subparagraph
variables (Andrew Dunning).Allow use ofhidelinks
variable forhyperref
package (Hugo Roy,#113). Prevent package clash withtufte-latex
and other classes thatincludehyperref
orcolor
(Xavier Olive, #115). - ConTeXt: Support handling of bidirectional text (mb21, #120).
- LaTeX and ConTeXt: Use more specific language variables.Instead of directly using
lang
, we now usebabel-lang
andpolyglossia-lang
andcontext-lang
. These variables are set bythe writers to the necessary values, based on thelang
variable(which now always takes a value in BCP47 format). (mb21, #114, #129). - HTML: Support handling of bidirectional text (mb21, #120).Move HTML5 shiv after CSS and fix URL (Andrew Dunning).Add dir attribute in html5 (Andrew Dunning).
- reveal.js: Add
controls
,progress
variables (Grégoire Pineau, #127).Addwidth
,height
variables (Anrew Dunning). Update templatefrom 3.1 source (Andrew Dunning). All configuration options are nowavailable as variables, but are only be included if set (reveal.jsuses defaults otherwise). - man: Added comment stating that the page is autogenerated by pandoc,giving version. Added
adjusting
andhyphenate
variables(Alex Vong, #123).
- Beamer: Add
epub.css: added selectors for nested emphasis (Pablo Rodriguez).
MediaBag: ensure that
/
is always used as path separator.sample.lua
: defineCaptionedImage
, add newline at end (#2393).Added
--bash-completion
option. This generates a bash completionscript. To use:eval "$(pandoc --bash-completion)"
.Text.Pandoc.Error: Define Typeable and Exception instancesfor PandocError (#2386).
Text.Pandoc.Parsing:
toKey
: strip off outer brackets.This makes keys with extra space at the beginning and endwork: e.g.[foo]: bar[ foo ]
will now be a link to bar (it wasn't before).
Text.Pandoc: disable
auto_identifiers
for epub.The epub writer inserts its own auto identifiers;this is more complex due to splitting into "chapter" files.Renamed Text.Pandoc.Compat.Locale -> Text.Pandoc.Compat.Time.It now reexports Data.Time.
Use custom Prelude to avoid compiler warnings.
- The (non-exported) prelude is in prelude/Prelude.hs.
- It exports Monoid and Applicative, like base 4.8 prelude,but works with older base versions.
- It exports (<>) for mappend.
- It hides 'catch' on older base versions.
Added a
stack.ymal
and stack install instructions to INSTALL.Clarified what is "out of scope" in README and CONTRIBUTING.md.
Added note to CONTRIBUTING.md about ghc versions and travis.
Clarify docs on block quotes. The space after
>
is optional (#2346).Removed obsolete reference to default.csl (#2372).
List all styles in manual for
--reference-docx
(Chris Black)Don't capitalize header links in man page.
Added section on repl to CONTRIBUTING.md.
README: Added space after backslash in image example (#2329).
Document details of citation locator terms (Nick Bart).
Fixed some internal links in README (#2309).
Improve CSL documentation, variables documentations,links, and cross-references in README. (Andrew Dunning)
Fix build failure with
--flags=-https
(Sergei Trofimovich).Use
newManager
instead ofwithManager
in recenthttp-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 olderversions of ghc may link against two different versions.
Added appveyor (Windows continuous integration) builds.
New
.travis.yml
. Autgenerated usingmake_travis_yml.hs
.This script has been modified in a few ways, e.g. to addGHCOPTS
.make .travis.yml
regenerates it based on the tested-withfield of the cabal file.
pandoc 1.15.0.6 (2015-07-15)
--self-contained
: Fixed overaggressive CSS minimization(#2301, 2286). Previously--self-contained
wiped out allspaces 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 linklabel (#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 therules for allowing punctuation in a bare URI, and adds test cases.One potential drawback is that you can no longer put a bareURI 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 canhave 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 maintainedmath rendering extension for DokuWiki.Text.Pandoc.Shared
: Changedhierarchicalize
so it treats referencesdiv as top-level header (#2294). This fixes a bug with--section-divs
,where the final references section added by pandoc-citeproc, enclosed inits own div, got nested in the div for the section previous to it.Allow vector 0.11.
Require cmark > 0.4.
pandoc 1.15.0.5 (2015-07-10)
HTML writer: Fixed email javascript obfuscation with
mailto:
URLs (#2280). This fixes a potential security issue. Becausesingle quotes weren't being escaped in the link portion, aspecially crafted email address could allow javascript code injection.RST reader: allow inline formatting in definition list fieldnames (Lars-Dominik Braun).
PDF: Make sure
--latex-engine-opt
goes before the filenameon the command line. LaTeX needs the argument to come afterthe 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 ifembed_data_files
specified.This is done by addinghookedPrograms
inSetup.hs
, which allows usto includehsb2hs
in Build-Tools in cabal.Improved Windows installer (thanks to nkalvi).
- When per-machine installation is chosen, the system pathis updated instead of the user's.
- An appropriate default is used for per-machine installationdirectory.
- Admin privileges are no longer required for a per-user install
Travis: unpack sdist for build to catch packaging bugs.
Improved documentation on where user templates go (#2272).
pandoc 1.15.0.4 (2015-07-03)
Added pandoc.1 man page to the repository. It is no longerbuilt as part of the cabal build process. (This proved toofragile.) pandoc.1 can be regenerated (
make man/pandoc.1
)whenREADME
is changed.Copying of the man page now respects
--destdir
(#2262).Improved error messages for filters. User is now informed ifthe filter requires an interpreter that isn't found in the path,or if the filter returns an error status.
pandoc 1.15.0.3 (2015-07-02)
- Ensure target directory is created when installing man page.
pandoc 1.15.0.2 (2015-07-02)
- Added files needed for building man page to Extra-Source-Files.
pandoc 1.15.0.1 (2015-07-01)
- Man page is now built and installed as part of the cabal buildprocess. Removed Makefile target for man page.
pandoc 1.15 (2015-07-01)
Man page changes:
- Removed
--man1
,--man5
options (breaking change). - Removed
Text.Pandoc.ManPages
module (breaking API change). - Makefile target for
man/man1/pandoc.1
. This uses pandoc tocreate the man page from README using a custom template and filters. - Added
man/
directory with template and filters needed to buildman page. - We no longer have two man pages:
pandoc.1
andpandoc_markdown.5
.Now there is just pandoc.1, which has all the content from README.This change was needed because of the extensive cross-referencesbetween parts of the README. - Removed old
data/pandoc.1.template
anddata/pandoc_markdown.5.template
.
- Removed
OpenDocument writer: Do not add a carriage return after a hardline break (Michael Chladek).
ConTeXt writer:
- use
\goto
for internal links. - Added a
%
at end for\reference
to avoid spurious space.
- use
Ignore sandbox on 'make quick'
pandoc 1.14.1 (2015-06-30)
Added
--man1
and--man5
options to pandoc, allowingpandoc to generate its own man pages. Man pages are no longerautomatically generated in the build process (the process forthis was too complex and prone to failure, #2190). Themake-pandoc-man-pages
executable has been removed. Theman/
directory has been removed, and man page templateshave been moved todata/
. NOTE TO PACKAGERS: You will nolonger find pandoc's man pages inman/
, but you cangenerate them usingpandoc --man1 > pandoc.1
andpandoc --man5 > pandoc_markdown.5
.Added new unexported module:
Text.Pandoc.ManPages
.README
now acts like a data file (even though it isn't indata/
). 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 theREADME, but it may be useful for other purposes as well.Allow
reference.docx
andreference.odt
to be used with--print-default-data-file
and to shadow defaults if placed inthe user data directory. Note that as of 1.14, we no longerinclude these files as data files; instead, we include theircomponents. This change causes pandoc to behave as if it hasthese data files; they are constructed on demand when neededusinggetDefaultReferenceDocx
andgetDefaultReferenceODT
.Fixed regression in CSS parsing with
--self-contained
(#2224).Pandoc 1.14.0.x used css-text to parse the CSS, but its parsersilently drops big sections of CSS. This commit replaces theuse of css-text with a small but principled CSS preprocessor,which removes whitespace and comments and replacesurl()
withbase 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
: ExportplainExtensions
.These are the extensions used inplain
output.LaTeX reader: Don't parse
_
and^
as sub/superscript outside ofmath mode; treat them as regular inline text. Normally these willcause 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
mediaobject
s andfigures
(#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 onecolon character (gohai).
Docx writer: Make sure we use dist version of
reference.docx
(and not the user's version) for certain settings. Taking somesettings values from a user-supplied reference.docx can lead tocorruption. This fixes a regression from the last release (#2249).Text.Pandoc.Shared
: exportsgetDefaultReferenceDocx
andgetDefaultReferenceODT
(API change). These functions have beenremoved from the Docx and ODT writers.LaTeX template (Xavier Olive):
- Added
CJKmainfont
andCJKoptions
variables. - Allow dvipsnames (e.g.
MidnightBlue
) for colors (Xavier Olive).
- Added
Epub templates: use
author.role
, notauthor.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 setthe installation path. At the end of installation, the install locationis given. The install location is also now given in the list ofinstalled programs in Control Panel. Cleaner WiX syntax is used forsetting the path.
Added
download_stats
target to Makefile.
pandoc 1.14.0.4 (2015-06-02)
Added missing commonmark template.
Improved try pandoc (moved button, show raw command).
pandoc 1.14.0.3 (2015-06-01)
Allow compilation with syb 0.5.*.
Custom writer: fixed some compiler warnings for ghc < 7.10.
pandoc 1.14.0.2 (2015-05-31)
- Allow building with hslua 0.4.
pandoc 1.14.0.1 (2015-05-28)
Fixed problem with building of
reference.docx
andreference.odt
when theembed_data_files
flag is used. Instead of having a phaseof the build wherereference.docx
andreference.odt
are createdfrom their constituent data files, we now construct these archivesfrom their constituents when adocx
orodt
is built. Theconstituent files have been moved fromextra-source-files
todata-files
, andreference.docx
andreference.odt
have beenremoved. Users can create their ownreference.docx
orreference.odt
by using pandoc to create a simpledocx
orodt
.make-reference-files.hs
has been removed, simplifying the buildprocess (#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 withidentifiers. (This is needed for linked citations to work.)
pandoc 1.14 (2015-05-27)
New features
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 thatsupport reading shortcut reference links, namely:markdown
,markdown_strict
,markdown_github
,markdown_php
.If the extension is enabled, the reader parses shortcut referencelinks like[foo]
, and the writer creates such links unless doingso would cause problems. Users of markdown flavors that supportshortcut reference links should not notice a difference in readingmarkdown, but the markdown pandoc produces may differ.If shortcut links are not desired, the extension can be disabledin the normal way.
Behavior changes
--toc
is now supported fordocx
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 thebibliography
field in metadata is specified (#1849).Markdown reader:
Reference links with
implicit_header_references
are no longercase-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, nowthis is a valid definition list:foo : bar
Resolve a potentially ambiguity with table captions:
foo : bar ----- table -----
Is "bar" a definition, or the caption for the table? We'll countit as a caption for the table.
Disallow headerless pipe tables (#1996), to conform to GFM and PHPMarkdown 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:
- Don't limit includes to
.tex
extension (#1882).If the extension is not.tex
, it must be given explicitly inthe\input
or\include
.
- Don't limit includes to
Docx reader:
- Allow numbering in the style file. This allows inherited styleswith numbering (lists) (Jesse Rosenthal).
Org reader:
- Support smart punctuation (Craig Bosma).
- Drop trees with a :noexport: tag (Albert Krewinkel). Trees having a
:noexport:
tag set are not exported. This mirrors org-mode. - Put header tags into empty spans (Albert Krewinkel, #2160).Org mode allows headers to be tagged:
* Headline :TAG1:TAG2
.Instead of being interpreted as part of the headline, the tags are nowput into the attributes of empty spans. Spans without textual contentwon't be visible by default, but they are detectable by filters. Theycan also be styled using CSS when written as HTML. - Generalize code block result parsing (Albert Krewinkel).Previously, only code blocks were recognized as result blocks;now, any kind of block can be the result.
Append newline to the LineBreak in Dokuwiki, HTML, EPUB,LaTeX, MediaWiki, OpenDocument, Texinfo writers (#1924, Tim Lin).
HTML writer:
- Add "inline" or "display" class to math spans (#1914).This allows inline and display math to be styled differently.
- Include raw latex blocks if
--mathjax
specified (#1938). - Require highlighting-kate >= 0.5.14 (#1903).This ensures that all code blocks will be wrapped in a
div
with classsourceCode
. Also, the default highlighting CSSnow addsdiv.sourceCode { x-overflow: auto; }
, which meansthat code blocks (even with line numbers) will acquire a scrollbar on screens too small to display them (e.g. mobile phones).See also jgm/highlighting-kate#65.
LaTeX writer:
- Use a declaration for tight lists (Jose Luis Duran, JosephHarriott). Previously, pandoc hard-coded some commands to maketight lists in LaTeX. Now we use a custom command instead,allowing the styling to be changed in a macro in the header.(Note: existing templates may need to be modified to includethe definition of this macro. See the current template.)
- Beamer output: if the header introducing a slide has theclass
fragile
, add the[fragile]
option to the slide (#2119).
MediaWiki writer:
- Use
File:
instead of the deprecatedImage:
for images andother media files (Greg Rundlett).
- Use
DocBook writer:
- Render a
Div (id,_,_) [Para _]
element as apara
elementwith anid
attribute. This makes links to citations work inDocBook with pandoc-citeproc.
- Render a
RST writer:
- Normalize headings to sequential levels (Nikolay Yakimov).This is pretty much required by docutils.
- Treat headings in block quotes, etc as rubrics (Nikolay Yakimov).
- Better handling of raw latex inline (#1961). We use
:raw-latex:`...`
and add a definition for this role tothe template.
EPUB writer:
- Remove
linear=no
from coveritemref
(#1609). - Don't use
sup
element for epub footnotes (#1995).Instead, just use an a element with classfootnoteRef
.This allows more styling options, and provides better resultsin some readers (e.g. iBooks, where anything inside the atag breaks popup footnotes). - Take TOC title from
toc-title
metadata field.
- Remove
Docx writer:
- Implemented
FirstParagraph
style (Jesse Rosenthal).Following the ODT writer, we add theFirstParagraph
style to thefirst 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 asNormal
. - Added
BodyText
style (Jesse Rosenthal).We apply aBodyText
style to all unstyled paragraphs. This is,essentially, the same asNormal
, except that since not everythinginherits fromBodyText
(the metadata won't, for example, orthe headers or footnote numbers), we can change the text in the bodywithout having to make exceptions for everything. If we do want tochange everything, we can still do it throughNormal
. - Altered
Blockquote
style slightly (Jesse Rosenthal).SinceBlockQuote
derives fromBodyText
, we just want to specifyby default that it won't indent, regardless of whatBodyText
does.Note that this will not produce any visible difference in the defaultconfiguration. - Take TOC title from
toc-title
metadata field (Nikolay Yakimov). - Added a style to figure images (Nikolay Yakimov).Figures with empty captions use style
Figure
.Figures with nonempty captions use styleFigure with Caption
, whichis based onFigure
, and additionally haskeepNext
set.
- Implemented
ODT writer:
- Added figure captions (Nikolay Yakimov). The following styles areused for figures:
Figure
-- for figure with empty caption),FigureWithCaption
(based onFigure
) -- for figure with caption,FigureCaption
(based onCaption
) -- for figure captions.Also,TableCaption
(based onCaption
) is used for table captions.
- Added figure captions (Nikolay Yakimov). The following styles areused for figures:
API changes
New
Text.Pandoc.Error
module withPandocError
type(Matthew Pickering).All readers now return
Either PandocError Pandoc
instead ofPandoc
(Matthew Pickering). This allows better handling of errors.Added
Text.Pandoc.Writers.CommonMark
, exportingwriteCommonMark
.Added
Text.Pandoc.Readers.CommonMark
, exportingreadCommonMark
.Derive
Data
andTypeable
instances forMediaBag
,Extension
,ReaderOptions
,EPUBVersion
,CiteMethod
,ObfuscationMethod
,HTMLSlideVariant
,TrackChanges
,WriterOptions
(ShabbazYoussefi).New
Ext_shortcut_reference_links
constructor forExtension
(Konstantin Zudov).
Bug fixes
Markdown reader:
- Allow smart
'
after inline math (#1909, Nikolay Yakimov). - Check for tex macros after indented code (#1973).
- Rewrote
charsInBalancedBrackets
for efficiency. - Make sure a closing
</div>
doesn't get included in adefinition list item (#2127). - Don't parse bracketed text as citation if it might be a link,image, or footnote (Nikolay Yakimov).
- Require space after key in mmd title block (#2026, NikolayYakimov). Require space after key-value delimiter colon in mmd titleblock.
- Require nonempty value in mmd title block (Nikolay Yakimov).
- Disable all metadata block extensions when parsingmetadata field values (#2026, Nikolay Yakimov). Otherwise wecould get a mmd title block inside YAML metadata, for example.
- Allow smart
HTML reader:
- Improve self-closing tag detection in
htmlInBalanced
(#2146). - Handle tables with
<th>
in body rows (#1859, mb21). - Fixed
htmlTag
(#1820). If the tag parses as a comment, we checkto see if the input starts with<!--
. If not, it's bogus commentmode and we failhtmlTag
. - Handle
base
tag; if it has anhref
value, this is added toall relative URLs in links and images.
- Improve self-closing tag detection in
DocBook reader:
- Look inside "info" elements for section titles (#1931).
Docx reader:
- Parse images in deprecated vml format (Jesse Rosenthal).
- Allow sub/superscript verbatims (Jesse Rosenthal).Verbatim usually shuts off all other run styles, but we don't want itto shut off sub/superscript.
LaTeX reader:
- Handle
tabular*
environment (#1850).Note that the table width is not actually parsed or taken intoaccount, but pandoc no longer chokes on it. - Ignore options in
\lstinline
rather than raising error (#1997). - Add some test cases for simple tables (Mathias Schenner).
- Handle valign argument in tables (Mathias Schenner) (currentlywe just ignore this).
- Allow non-empty colsep in tables (Mathias Schenner).The
tabular
environment allows non-empty column separatorswith the "@{...}" syntax. Previously, pandoc would fail toparse tables if a non-empty colsep was present. With thiscommit, these separators are still ignored, but the table getsparsed. A test case is included. - Recognize
\newpage
as a block command. - Allow block content in
\title{}
(#2001). - Check for block-level newcommand aliases in blockCommand (NikolayYakimov).
- Guard against paragraph starting with inline macro (Nikolay Yakimov).
- Properly gobble spaces after
\\
(#2007).
- Handle
Textile reader:
- Handle newlines in table cells, and empty cells (#1919).
Org reader:
- Allow image links with non-image targets (Hans-Peter Deifel).This matches behavior of Org-Mode for links like
[[http://example.com][https://www.haskell.org/static/img/logo.png]]
.
- Allow image links with non-image targets (Hans-Peter Deifel).This matches behavior of Org-Mode for links like
Docbook writer:
- Don't print empty id attributes (thanks to Steve Horne).
HTML writer:
- Fixed list-style-type for numbered example lists.Should be "decimal," not "example" (#1902).
- Do not omit missing
alt
attribute onimg
tag (#1131,Konstantin Zudov). - Allow multiple colgroups in table (#2122).
- In revealjs, ensure that lists in speaker notes don't add "fragment"classes, which can cause additional keypresses to be needed toadvance a slide (#1394).
LaTeX writer:
- Don't escape
$
in URL (#1913). - Don't use listings in headers (Matthew Pickering, #1963).
- Recognize book documentclass if set in metadata (#1971).This sets
--chapters
implicitly if the documentclass in metadatais a book documentclass. Previously this was done only if a bookdocumentclass was set in a variable. - Add a
\label
in\hyperdef
for Div, Span (or links don't work). - Make
mainlang
work whenlang
is in metadata (#2174).
- Don't escape
Texinfo writer:
- Fix wrapping by using breakable spaces (Tim Lin).
RST writer:
- Fixed toc depth in RST writer. Previously the depth was beingrendered as a floating point number with a decimal point.
Markdown writer:
- Improved escaping (#2086).
<
should not be escaped as\<
, forcompatibility with original Markdown. We now escape<
and>
with entities. Also, we now backslash-escape square brackets. - Avoid introducing spurious list items through wrapping (#1946).
- Don't emit span tags if plain or raw HTML disabled.
- Improved escaping (#2086).
MediaWiki writer:
- Convert spaces to underscores in wikilink URL (#1982), like MediaWiki.
AsciiDoc writer:
- Insert some needed blank lines (#1860).
- Avoid wrapping after list marker (#1858).
EPUB writer:
- Properly handle internal links to IDs in spans, divs (#1884).
- Use plain writer for metadata dc: fields (#2121).This gives better results when we have, e.g. multiple paragraphs.Note that tags aren't allowed in these fields.
- Properly handle image links without an extension (#1855).
- Improved chapter splitting and internal link rewriting (#1887,#2162, #2163). This will ensure that internal links work andthat the references section produced by pandoc-citeproc isin its own chapter.
- Fixed handling of svg images (#2183).
ICML writer:
- Better handling of raw blocks and inlines (#1951).Previously these were always escaped and printed verbatim.Now they are ignored unless the format is
icml
, in whichcase they are passed through unescaped. - Fixed image URIs in ICML output (gohai).
- Better handling of raw blocks and inlines (#1951).Previously these were always escaped and printed verbatim.Now they are ignored unless the format is
Custom writer:
- Raise error if loadstring returns an error status.
- Raise
PandocLuaException
instead of using 'error'.Eventually we'll change the return type so that no exceptionis involved, but at least this can be trapped. - Use UTF-8 aware bytestring conversion.
- Set foreign encoding to UTF-8 (Nikolay Yakimov, #2101, #1634).Also factored out ByteString, since it's only used as an intermediaterepresentation.
Docx writer:
- Copy hyphenation settings from reference.docx (Nikolay Yakimov).
- Filter out illegal XML characters (#1992, Matthew Pickering).
- Added
noProof
to docx syntax highlightingSourceCode
style. - Added footnotes id -1 and 0 (Jesse Rosenthal).Word uses, by default, footnotes with id -1 and 0 for separators. If auser modifies
reference.docx
, they will end up with asettings.xml
file that references these footnotes, but no such footnotes in thedocument. This will produce a corruption error. Here we add these to thedocument andsettings.xml
file, so future modifications won't breakthe file. - Handle lists correctly inside table cells (Jesse Rosenthal).Previously we didn't transform lists inside table cells.
- Set firstRow information in tables (Nikolay Yakimov).
- Don't replace
SourceCode
style inreference.docx
if it is definedthere (Nikolay Yakimov, #1872). If--no-highlight
specified, removeanySourceCode
and*Tok
styles inreference.docx
. - Attempt to match international style names (#1607, Nikolay Yakimov).
- Set these styles as custom (Nikolay Yakimov):
Author
,Abstract
,Compact
,Image Caption
,Table Caption
,Definition Term
,Definition
,First Paragraph
. - Rename these styles to correspond with Word
Normal.dotm
(NikolayYakimov):Block Quote -> Block Text
,Link -> Hyperlink
,Footnote Ref -> Footnote Reference
. - Added
Caption
style (Nikolay Yakimov). - Changed these styles' inheritance (Nikolay Yakimov):
Image Caption <- Caption
,Table Caption <- Caption
. - Remove
SourceCode
style fromreference.docx
(#1872).This is added automatically by the docx writer. - Added toc heading style to
reference.docx
(Nikolay Yakimov).
Text.Pandoc.PDF
- Don't suggest "Try xelatex" if xelatex already in use (mb21, #1832).
- More comprehensible errors on image conversion (#2067).EPS can't be supported without shelling out to something likeImageMagick, but at least we can avoid mysterious error messages.
Text.Pandoc.Shared
:- Make safeRead safe (#1801, Matthew Pickering).
- Addded
mapLeft
,hush
(Matthew Pickering).
Text.Pandoc.Pretty
:- Remove partial function (Matthew Pickering).
Text.Pandoc.SelfContained
:- Add
;charset=utf-8
to script mime type if missing (#1842). - Improved building of data URIs (#1940). Now base64 is used exceptfor
text/*
mime types. cssURLs
no longer tries to fetch fragment URLs (#2121).- Properly handle data URIs in css urls (#2129).Use a proper CSS parser (adds dependency on
text-css
).
- Add
Text.Pandoc.UTF8
:- Better handling of bare CRs in input files (#2132).Previously we just stripped them out; now we convertother line ending styles to LF line endings.
Text.Pandoc.ImageSize
:- Fixed some exif header parsing bugs (#1834).
- Make imageSize return an Either, not a Maybe (#1834).Use
runGetOrFail
(withbinary >= 0.7
) to returnLeft
onparse failure (rather thanerror
). - Improved warnings when image size can't be determined.
- Removed error landmines (Matthew Pickering).
Added woff2 to MIME types (Alfred Wechselberger).
pandoc: When a binary input format is used, warn that filearguments past the first one are being ignored (Matthew Pickering).
Template changes
LaTeX template:
- Degrade gracefully if
\paragraph
not defined. - Include
grffile
together withgraphicx
(#2074).This properly handles filenames containing spaces and dots. - Redefine
\paragraph
,\subparagraph
... to behave morelike section headers (#1658). - Import hyperref before polyglossia to avoid an error with xelatex,"please load package hyperref before bidi package" (Nick Bart).
- Added
toccolor
variable to control link color in toc (Kaixhin).
- Degrade gracefully if
LaTeX, Beamer templates:
- Provide
\tightlist
, which is now used by the LaTeX writer. - Use polyglossia in beamer (#85).
- Use
bibliography
instead ofbiblio-files
(#1661). Also use\addbibresource
instead of\bibliography
forbiblatex. - Added
setotherlanguages
in polyglossia. This uses anotherlang
variable that is derived from a comma-separated list inlang
;the last language ismainlang
and the others areotherlang
.
- Provide
EPUB templates:
- Use
div
, notp
, for "rights" on title page. - Added header-includes, include-before, include-after (#1987).
- Use
OpenDocument template:
- Use
text:p
instead oftext:h
for title.Usingtext:h
causes problems with numbering. Closes #2059.Thansk to @nkalvi for diagnosing this.
- Use
reveal.js template:
- Link to non-minified css, js. The minified versions no longership with the library.
- Correctly include style CSS (#1949).
- New configurable options options:
center
,maxScale
,slideNuber
(Dmitry Smirnov, pandoc-templates#89). - Moved custom CSS after theme. This allows custom CSS to modifythemes, instead of being replaced by them.
- Allow
center
to be set to false.
Under the hood improvements
Removed pre-built
reference.docx
andreference.odt
(NikolayYakimov). Instead the repository now includes the component text files,and the zipped binaries are built from these using a helperprogram,make-reference-files
. This should make maintenance ofthese components easier going forward.Text.Pandoc.Parsing
:- Added new
<+?>
combinator (Nikolay Yakimov). - Added
stateHeaderKeys
toParserState
.
- Added new
make_deb.sh
fixes:- Detect architecture.
- Add Installed-Size to debian package control file (#1900).
- Use
fakeroot
to get permissions right. - Use
mkdir
andcp
instead ofinstall
. - Set permissions of directories to 755.
- Install in
/usr
rather than/usr/local
. - Compress man pages.
- Combine copyright files for
pandoc
,pandoc-citeproc
.
Added
Text.Pandoc.Compat.Locale
andold-locale
flagto assist with transition totime
1.5.Updated CONTRIBUTING.md with information about issue tags (MatthewPickering).
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 theplatform. This matches the wayMediaBag
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:
- Fixed typos (J. Lewis Muir).
- Added documentation on backtick_code_blocks (#2135, Nikolay Yakimov).
- Added note on in-field markup in biblio databases (Nick Bart).
- Fixed misleading example of raw HTML block.
- Various minor formatting and consistency fixes for the programoptions (Andreas Lööw).
- Made definition lists for options all "loose" for consistency.
- Added YAML biblio format to table, and note on
pandoc-citeproc
's--bib2json
and--bib2yaml
options (Nick Bart). - Removed obsolete reference to
mods2yaml
(Nick Bart). - Added section on syntax highlighting.
- Documented
toccolor
variable.
pandoc 1.13.2.1 (2015-04-15)
Updated to build with ghc 7.10.1.
Bumped package upper bounds for filepath, blaze-html, blaze-markup.
pandoc 1.13.2 (2014-12-20)
TWiki Reader: add new new twiki reader (API chaneg, Alexander Sulfrian).
Markdown reader:
- Better handling of paragraph in div (#1591).Previously text that ended a div would be parsed as Plainunless there was a blank line before the closing div tag.
- Don't treat a citation as a reference link label (#1763).
- Fix autolinks with following punctuation (#1811).The price of this is that autolinked bare URIs can no longercontain
>
characters, but this is not a big issue. - Fix
Ext_lists_without_preceding_blankline
bug (#1636, Artyom). - Allow
startnum
to work withoutfancy_lists
. Formerlypandoc -f markdown-fancy_lists+startnum
did not work properly.
RST reader (all Daniel Bergey):
Parse quoted literal blocks (#65). RST quoted literal blocks arethe 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 moreclass names, and creates a Div value with those classes. If thedirective has an indented body, the body is parsed as the children ofthe Div. If not, the first block following the directive is made achild of the Div. This differs from the behavior of rst2xml, whichdoes not create a Div element. Instead, the specified classes areapplied to each child of the directive. However, most Pandoc Blockconstructors to not take an Attr argument, so we can't duplicate thisbehavior.
Warn about skipped directives.
Literal role now produces Code. Code role should have "code" class.
Improved support for custom roles
- Added
sourceCode
to classes for:code:
role, and anythinginheriting from it. - Add the name of the custom role to classes if the Inlineconstructor supports Attr.
- If the custom role directive does not specify a parent role,inherit from the
:span:
role.
This differs somewhat from the
rst2xml.py
behavior. If a customrole inherits from another custom role, Pandoc will attach bothroles' names as classes.rst2xml.py
will only use the class ofthe directly invoked role (though in the case of inheriting from a:code:
role with a:language:
defined, it will also provide theinherited language as a class).- Added
Warn about ignored fields in role directives.
LaTeX reader:
- Parse label after caption into a span instead ofinserting an additional paragraph of bracketed text (#1747).
- Parse math environments as inline when possible (#1821).
- Better handling of
\noindent
and\greektext
(#1783). - Handle
\texorpdfstring
more gracefully. - Handle
\cref
and\sep
(Wikiwide). - Support
\smartcite
and\Smartcite
from biblatex.
HTML reader:
- Retain display type of MathML output (#1719, Matthew Pickering).
- Recognise
<br>
tags inside<pre>
blocks (#1620, Matthew Pickering). - Make
embed
tag either block or inline (#1756).
DocBook reader:
- Handle
keycombo
,keycap
(#1815). - Get string content in inner tags for literal elements (#1816).
- Handle
menuchoice
elements better, with a>
between (#1817). - Include
id
on section headers (#1818). - Document/test "type" as implemented (Brian O'Sullivan).
- Add support for calloutlist and callout (Brian O'Sullivan).We treat a calloutlist as a bulleted list. This works well in practice.
- Add support for
classname
(Bryan O'Sullivan).
- Handle
Docx reader:
- Fix window path for image lookup (Jesse Rosenthal).Don't use os-sensitive "combine", since we always want the paths in ourzip-archive to use forward-slashes.
- Single-item headers in ordered lists are headers (Jesse Rosenthal).When users number their headers, Word understands that as a single itemenumerated list. We make the assumption that such a list is, in fact,a header.
- Rewrite rewriteLink to work with new headers (Jesse Rosenthal).There could be new top-level headers after making lists, so we have torewrite links after that.
- Use polyglot header list (Jesse Rosenthal).We're just keeping a list of header formats that different languagesuse as their default styles. At the moment, we have English, German,Danish, and French. We can continue to add to this.This is simpler than parsing the styles file, and perhaps lesserror-prone, since there seems to be some variations, even within alanguage, of how a style file will define headers.
- Remove header class properly in other langs (Jesse Rosenthal).When we encounter one of the polyglot header styles, we want to removethat from the par styles after we convert to a header. To do that, wehave to keep track of the style name, and remove it appropriately.
- Account for external link URLs with anchors. Previously, if a URLhad an anchor, the reader would incorrectly identify it as aninternal link and return only the anchor as URL. (Caleb McDaniel)
- Fix for Issue #1692 (i18n styles) (Nikolay Yakimov).
Org reader:
Added state changing blanklines (Jesse Rosenthal).This allows us to emphasize at the beginning of a new paragraph (or, ingeneral, after blank lines).
Fixed bug with bulleted lists:
- a
- b
- c
was being parsed as a list, even though an unindented
*
should make a heading. Seehttp://orgmode.org/manual/Plain-lists.html#fn-1.Org reader: absolute, relative paths in link (#1741, AlbertKrewinkel). The org reader was too restrictive when parsing links;some relative links and links to files given as absolute pathswere not recognized correctly.
Org reader: allow empty links (jgm/gitit#471, Albert Krewinkel).This is important for use in gitit, which uses empty linksfor wikilinks.
Respect indent when parsing Org bullet lists (#1650, TimothyHumphries). 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 emphasisedstrings. This is wrong, as,
and'
are forbidden border chars andmay 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
arecomment trees and should not be exported. Those trees are droppedsilently (#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 thatthe leadingfile:
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:
- URI handling improvements. Now we outsource most of the work to
fetchItem'
. Also, do not include queries in file extensions (#1671).
- URI handling improvements. Now we outsource most of the work to
LaTeX writer:
- Use
\texorpdfstring
for section captions when needed (Vaclav Zeman). - Handle consecutive linebreaks (#1733).
- Protect graphics in headers (Jesse Rosenthal).Graphics in
\section
/\subsection
etc titles need to be\protect
ed. - Put
~
before header in list item text (Jesse Rosenthal).Because of the built-in line skip, LaTeX can't handle a section headeras the first element in a list item. - Avoid using reserved characters as
\lstinline
delimiters (#1595). - Better handling of display math in simple tables (#1754).We convert display math to inline math in simple tables,since LaTeX can't deal with display math in simple tables.
- Escape spaces in code (#1694, Bjorn Buckwalter).
- Use
MediaWiki writer:
- Fixed links with URL = text. Previously these were rendered as barewords, even if the URL was not an absolute URL (#1825).
ICML writer:
- Don't force all citations into footnotes.
RTF writer:
- Add blankline at end of output (#1732, Matthew Pickering).
RST writer:
- Ensure blank line after figure.
- Avoid exces whitespace after last list item (#1777).
- Wrap line blocks with spaces before continuations (#1656).
- Fixed double-rendering of footnotes in RST tables (#1769).
DokuWiki writer:
- Better handling of block quotes. This change ensures thatmultiple paragraph blockquotes are rendered using native
>
rather than as HTML (#1738). - Fix external images (#1739). Preface relative links with ":",absolute URIs without. (Timothy Humphries)
- Better handling of block quotes. This change ensures thatmultiple paragraph blockquotes are rendered using native
HTML writer:
- Use protocol-relative URL for mathjax.
- Put newline btw img and caption paragraph.
- MathML now outputted with tex annotation (#1635, Matthew Pickering).
- Add support for KaTeX HTML math (#1626, Matthew Pickering).This adds
KaTeX
toHTMLMathMethod
(API change). - Don't double render when
email-obfuscation=none
(#1625, MatthewPickering). - Make header attributes work outside top level (#1711).Previously they only appeared on top level header elements.Now they work e.g. in blockquotes.
ODT writer:
- Correctly handle images without extensions (#1729).
- Strip querystring in ODT write (#1682, Todd Sifleet).
FB2 writer:
- Add newline to output.
EPUB writer:
- Don't add
sourceURL
to absolute URIs (#1669). - Don't use unsupported
opf:title-type
for epub2. - Include "landmarks" section in nav document for epub3 (#1757).
- Removed playOrder from navpoint elements in ncx file (#1760).These aren't required, and they make manual modification of epubsdifficult.
- Extract title even from structured title.
- Don't include nav node in spine unless
--toc
was requested.Previously we included it in the spine withlinear="no"
, leadingto odd results in some readers (#1593). - Fixed absolute URI detection (#1672).
- Correctly resolve relative URIs (#1671).
- Use regular page template for
nav.xhtml
, including doctype (#1759).
- Don't add
Docx writer:
- Put docx table captions above tables (#1641, Nikolay Yakimov).
- Get the page width from the reference docx file, and useit to scale images that are too large to fit (Grégory Bataille).
- Partial fix for #1607 (Nikolay Yakimov). International heading stylesare inferred based on
<w:name val="heading #">
fallback, if thereare no en-US "Heading#" styles - Look in user data dir for archive
reference.docx
. - Renumber header and footer relationships to avoid collisions (JesseRosenthal). We previously took the old relationship names of theheaders and footer in secptr. That led to collisions. We now makea map of availabl names in the relationships file, and then renamein secptr.
ConTeXt writer:
- Add function toLabel (Mark Szepieniec).This function can be used to sanitize reference labels so thatthey do not contain any of the illegal characters #[]",{}%()|= .Currently only Links have their labels sanitized, because theyare the only Elements that use passed labels.
Text.Pandoc.Shared
:- Moved import of
toChunks
outside of CPP conditional (#1590). - Fix
inDirectory
to reset to the original directory in casean exception occurs (Freiric Barral).
- Moved import of
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 marginson 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 recommendedfor epub metadata in the pandoc README:
title:
- type: maintext: My Book
- type: subtitletext: An investigation of metadatacreator:
- role: authortext: John Smith
- role: editortext: Sarah Jonesidentifier:
- scheme: DOItext: doi:10.234234.234/33publisher: My Pressrights: (c) 2007 John Smith, CC BY-NC...
Text.Pandoc.Templates.getDefaultTemplate
:don't fail when called with "fb2" (#1660).Text.Pandoc.Parsing
:- Fixed
inlineMath
so it handles\text{..}
containing$
.For example:$x = \text{the $n$th root of $y$}
(#1677). - Change
parseFromString
to fail if not all input is consumed.(Matthew Pickering) - Moved
addWarning
from Markdown reader toParsing
, so it can beused by more readers (API change, Daniel Bergey).
- Fixed
Text.Pandoc.Pretty
:- Improve performance of
realLength
(Matthew Pickering). - Make CR + BLANKLINE = BLANKLINE. This fixes an extra blank line wewere getting at the end of markdown fragments (as well as rst, org,etc.) (#1705).
- Improve performance of
Text.Pandoc.MIME
:- Add mime type for WebVTT (Jason Ronallo).
- Changed mime type for
otf
toapplication/vnd.ms-opentype
(#1761).This is needed for epub3 validation.
Text.Pandoc.MediaBag
:- Fix Windows specific path problems (#1597).
Text.Pandoc.Shared
:- Make
collapseFilePath
OS-agnostic (Matthew Pickering).
- Make
Link the test suite using
-threaded
.This allows the test suite to be run using+RTS -N
.Added
network
dependency undernetwork-uri
flag in test section.Give better error messages when someone tries to convert frompdf, doc, odt (#1683).
Added
track
to list of tags treated by--self-contained
(#1664).
pandoc 1.13.1 (2014-08-30)
Fixed
--self-contained
with Windows paths (#1558).PreviouslyC:\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 canbe 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 onYoutube</a>. </p></video>
This change will cause the video and source tags to be parsedas RawBlock instead, giving better output.The general change is this: when we're parsing a "plain" sequenceof inlines, we don't parse anything that COULD be a block-level tag.
Docx reader:
- Be sensitive to user styles. Note that "Hyperlink" is"blacklisted," as we don't want the default underline styling to beinherited by all links by default (Jesse Rosenthal).
- Read single paragraph in table cell as
Plain
(Jesse Rosenthal).This makes to docx reader's native output fit with the way the markdownreader understands its markdown output.
Txt2Tags reader:
- Header is now parsed only if standalone flag is set (Matthew Pickering).
- The header is now parsed as meta information. The first line is the
title
, the second is theauthor
and third line is thedate
(Matthew Pickering). - Corrected formatting of
%%mtime
macro (Matthew Pickering). - Fixed crash when reading from stdin.
Textile writer: Extended the range of cases where native textiletables will be used (as opposed to raw HTML): we now handle anyalignment type, but only for simple tables with no captions.
EPUB writer: Don't use page-progression-direction in EPUB2, whichdoesn't support it. Also, if page-progression-direction not specifiedin metadata, don't include the attribute even in EPUB3; not including itis 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:
- Refactor to use Reader monad (Matthew Pickering).
- Avoid using raw HTML in table cells; instead, use
\\
instead of newlines (Jesse Rosenthal). - Properly handle HTML table cell alignments, and use spacingto make the tables look prettier (#1566).
Docx writer:
- Bibliography entries get
Bibliography
style (#1559). - Implement change tracking (Jesse Rosenthal).
- Bibliography entries get
LaTeX writer:
- Fixed a bug that caused a table caption to repeat across all pages(Jose Luis Duran).
- Improved vertical spacing in tables and made it customizable usingstandard lengths set by booktab. Seehttps://groups.google.com/forum/#!msg/pandoc-discuss/qMu6_5lYy0o/ZAU7lzAIKw0J(Jose Luis Duran).
- Added
\strut
to fix spacing in multiline tables (Jose Luis Duran). - Use
\tabularnewline
instead of\\
in table cells (Jose Luis Duran). - Made horizontal rules more flexible (Jose Luis Duran).
Text.Pandoc.MIME:
- Added
MimeType
(type synonym forString
) andgetMimeTypeDef
.Code cleanups (Artyom Kazak).
- Added
Templates:
- LaTeX template: disable microtype protrusion for typewriter font (#1549,thanks lemzwerg).
Improved OSX build procedure.
Added
network-uri
flag, to deal with split ofnetwork-uri
fromnetwork
.Fix build dependencies for the
trypandoc
flag, so that they areignored iftrypandoc
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.
pandoc 1.13.0.1 (2014-08-17)
Docx writer:
- Fixed regression which bungled list numbering (#1544), causingall lists to appear as basic ordered lists.
- Include row width in table rows (Christoffer Ackelman, Viktor Kronvall).Added a property to all table rows where the sum of column widthsis specified in pct (fraction of 5000). This helps persuade Wordto lay out the table with the widths we specify.
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 someperformance improvements.
HTML reader: Parse appropriately styled span as SmallCaps.
Markdown writer: don't escape
$
,^
,~
whentex_math_dollars
,superscript
, andsubscript
extensions, respectively, aredeactivated (#1127).Added
trypandoc
flag to build CGI executable used in the onlinedemo.Makefile: Added 'quick', 'osxpkg' targets.
Updated README in templates to indicate templates license.The templates are dual-licensed, BSD3 and GPL2+.
pandoc 1.13 (15 August 2014)
New features
Added
docx
as an input format (Jesse Rosenthal). The docxreader includes conversion of native Word equations to pandocLaTeXMath
elements. Metadata is taken from paragraphs at thebeginning of the document with stylesAuthor
,Title
,Subtitle
,Date
, andAbstract
.Added
epub
as an input format (Matthew Pickering). The epubreader includes conversion of MathML to pandoc LaTeXMath
elements.Added
t2t
(Txt2Tags) as an input format (Matthew Pickering).Txt2tags is a lightweight markup format described athttp://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 zipcontainer (docx or epub) while adjusting image paths to point to theextracted images.Added a new markdown extension,
compact_definition_lists
, thatrestores the syntax for definition lists of pandoc 1.12.x, allowingtight definition lists with no blank space between items, anddisallowing lazy wrapping. (See below under behavior changes.)Added an extension
epub_html_exts
for parsing HTML in EPUBs.Added extensions
native_spans
andnative_divs
to activateparsing of material in HTML span or div tags as Pandoc Spaninlines or Div blocks.--trace
now works with the Markdown, HTML, Haddock, EPUB,Textile, and MediaWiki readers. This is an option intendedfor debugging parsing problems; ordinary users should not needto use it.
Behavior changes
Changed behavior of the
markdown_attribute
extension, to bringit in line with PHP markdown extra and multimarkdown. Settingmarkdown="1"
on an outer tag affects all contained tags,recursively, until it is reversed withmarkdown="0"
(#1378).Revised markdown definition list syntax (#1429). Both the readerand writer are affected. This change brings pandoc's definition listsyntax into alignment with that used in PHP markdown extra andmultimarkdown (with the exception that pandoc is more flexible aboutthe definition markers, allowing tildes as well as colons). Lazilywrapped definitions are now allowed. Blank space is requiredbetween list items. The space before a definition is used to determinewhether it is a paragraph or a "plain" element. WARNING: This changemay break existing documents! Either check your documents fordefinition 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 languageis given (#1287, jgm/highlighting-kate#40).Improvements to
--filter
:- Don't search PATH for a filter with an explicit path.This fixed a bug wherein
--filter ./caps.py
would runcaps.py
fromthe system path, even if there was acaps.py
in the working directory. - Respect shebang if filter is executable (#1389).
- Don't print misleading error message.Previously pandoc would say that a filter was not found,even in a case where the filter had a syntax error.
- Don't search PATH for a filter with an explicit path.This fixed a bug wherein
HTML reader:
- Parse
div
andspan
elements even without--parse-raw
,providednative_divs
andnative_spans
extensions are set.Motivation: these now generate native pandoc Div and Spanelements, not raw HTML. - Parse EPUB-specific elements if the
epub_html_exts
extension is enabled. These includeswitch
,footnote
,rearnote
,noteref
.
- Parse
Org reader:
- Support for inline LaTeX. Inline LaTeX is now accepted and parsed by theorg-mode reader. Both math symbols (like
\tau
) and LaTeX commands (like\cite{Coffee}
), can be used without any further escaping (AlbertKrewinkel).
- Support for inline LaTeX. Inline LaTeX is now accepted and parsed by theorg-mode reader. Both math symbols (like
Textile reader and writer:
- The
raw_tex
extension is no longer set by default. You canenable it withtextile+raw_tex
.
- The
DocBook reader:
- Support
equation
,informalequation
,inlineequation
elements withmml:math
content. This is converted into LaTeX and put into a PandocMath inline.
- Support
Revised
plain
output, largely following the style of ProjectGutenberg:- Emphasis is rendered with
_underscores_
, strong emphasiswith ALL CAPS. - Headings are rendered differently, with space to set them off,not with setext style underlines. Level 1 headers are ALL CAPS.
- Math is rendered using unicode when possible, but without thedistracting emphasis markers around variables.
- Footnotes use a regular
[n]
style.
- Emphasis is rendered with
Markdown writer:
- Horizontal rules are now a line across the whole page.
- Prettier pipe tables. Columns are now aligned (#1323).
- Respect the
raw_html
extension.pandoc -t markdown-raw_html
no longer emits any raw HTML, including span and div tagsgenerated by Span and Div elements. - Use span with style for
SmallCaps
(#1360).
HTML writer:
- Autolinks now have class
uri
, and email autolinks have classemail
, so they can be styled.
- Autolinks now have class
Docx writer:
- Document formatting is carried over from
reference.docx
.This includes margins, page size, page orientation, header,and footer, including images in headers and footers. - Include abstract (if present) with
Abstract
style (#1451). - Include subtitle (if present) with
Subtitle
style, ratherthan tacking it on to the title (#1451).
- Document formatting is carried over from
Org writer:
- Write empty span elements with an id attribute as org anchors.For example
Span ("uid",[],[]) []
becomes<<uid>>
.
- Write empty span elements with an id attribute as org anchors.For example
LaTeX writer:
- Put table captions above tables, to match the conventionalstandard. (Previously they appeared below tables.)
- Use
\(..\)
instead of$..$
for inline math (#1464). - Use
\nolinkurl
in email autolinks. This allows them to be styledusing\urlstyle{tt}
. Thanks to Ulrike Fischer for the solution. - Use
\textquotesingle
for'
in inline code. Otherwise we getcurly quotes in the PDF output (#1364). - Use
\footnote<.>{..}
for notes in beamer, so that footnotesdo not appear before the overlays in which their markers appear(#1525). - Don't produce a
\label{..}
for a Div or Span element. Do producea\hyperdef{..}
(#1519).
EPUB writer:
- If the metadata includes
page-progression-direction
(which can beltr
orrtl
, thepage-progression-direction
attribute willbe set in the EPUB spine (#1455).
- If the metadata includes
Custom lua writers:
- Custom writers now work with
--template
. - Removed HTML header scaffolding from
sample.lua
. - Made citation information available in lua writers.
- Custom writers now work with
--normalize
andText.Pandoc.Shared.normalize
now consolidateadjacentRawBlock
s when possible.
API changes
Added
Text.Pandoc.Readers.Docx
, exportingreadDocx
(Jesse Rosenthal).Added
Text.Pandoc.Readers.EPUB
, exportingreadEPUB
(MatthewPickering).Added
Text.Pandoc.Readers.Txt2Tags
, exportingreadTxt2Tags
(MatthewPickering).Added
Text.Pandoc.Writers.DokuWiki
, exportingwriteDokuWiki
(Clare Macrae).Added
Text.Pandoc.Writers.Haddock
, exportingwriteHaddock
.Added
Text.Pandoc.MediaBag
, exportingMediaBag
,lookupMedia
,insertMedia
,mediaDirectory
,extractMediaBag
. The docx and epubreaders return a pair of aPandoc
document and aMediaBag
withthe 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 lookfor resources in theMediaBag
generated by the reader, in addition tothe file system or web.Text.Pandoc.Readers.TexMath
: Removed deprecatedreadTeXMath
.RenamedreadTeXMath'
totexMathToInlines
.Text.Pandoc
: AddedReader
data type (Matthew Pickering).readers
now associates names of readers withReader
structures. This allows inclusion of readers, like the docxreader, that take binary rather than textual input.Text.Pandoc.Shared
:- Added
capitalize
(Artyom Kazak), and replaced uses ofmap toUpper
(which give bad results for many languages). - Added
collapseFilePath
, which removes intermediate.
and..
from a path (Matthew Pickering). - Added
fetchItem'
, which works likefetchItem
but searchesaMediaBag
before looking on the net or file system. - Added
withTempDir
. - Added
removeFormatting
. - Added
extractSpaces
(from HTML reader) and generalized its typeso that it can be used by the docx reader (Matthew Pickering). - Added
ordNub
. - Added
normalizeInlines
,normalizeBlocks
. normalize
is nowPandoc -> Pandoc
instead ofData a :: a -> a
. Some users may need to change their uses ofnormalize
to the newly exportednormalizeInlines
ornormalizeBlocks
.
- Added
Text.Pandoc.Options
:- Added
writerMediaBag
toWriterOptions
. - Removed deprecated and no longer used
readerStrict
inReaderOptions
. This is handled byreaderExtensions
now. - Added
Ext_compact_definition_lists
. - Added
Ext_epub_html_exts
. - Added
Ext_native_divs
andExt_native_spans
.This allows users to turn off the default pandoc behavior ofparsing contents of div and span tags in markdown and HTMLas native pandoc Div blocks and Span inlines.
- Added
Text.Pandoc.Parsing
:- Generalized
readWith
toreadWithM
(Matthew Pickering). - Export
runParserT
andStream
(Matthew Pickering). - Added
HasQuoteContext
type class (Matthew Pickering). - Generalized types of
mathInline
,smartPunctuation
,quoted
,singleQuoted
,doubleQuoted
,failIfInQuoteContext
,applyMacros
(Matthew Pickering). - Added custom
token
(Matthew Pickering). - Added
stateInHtmlBlock
toParserState
. This is used to keeptrack of the ending tag we're waiting for when we're parsing insideHTML block tags. - Added
stateMarkdownAttribute
toParserState
. This is usedto keep track of whether the markdown attribute has been set inan enclosing tag. - Generalized type of
registerHeader
, using new type classesHasReaderOptions
,HasIdentifierList
,HasHeaderMap
(MatthewPickering). These allow certain common functions to be reusedeven in parsers that use custom state (instead ofParserState
),such as the MediaWiki reader. - Moved
inlineMath
,displayMath
from Markdown reader to Parsing,and generalized their types (Matthew Pickering).
- Generalized
Text.Pandoc.Pretty
:- Added
nestle
. - Added
blanklines
, which guarantees a certain number of blank lines(and no more).
- Added
Bug fixes
Markdown reader:
- Fixed parsing of indented code in list items. Indented codeat the beginning of a list item must be indented eight spacesfrom the margin (or edge of the container), or four spacesfrom the list marker, whichever is greater.
- Fixed small bug in HTML parsing with
markdown_attribute
, whichcaused incorrect tag nesting for input like<aside markdown="1">*hi*</aside>
. - Fixed regression with intraword underscores (#1121).
- Improved parsing of inline links containing quote characters (#1534).
- Slight rewrite of
enclosure
/emphOrStrong
code. - Revamped raw HTML block parsing in markdown (#1330).We no longer include trailing spaces and newlines in theraw blocks. We look for closing tags for elements (but withoutbacktracking). Each block-level tag is its own
RawBlock
;we no longer try to consolidate them (though--normalize
will do so). - Combine consecutive latex environments. This helps when you havetwo minipages which can't have blank lines between them (#690, #1196).
- Support smallcaps through span.
<span style="font-variant:small-caps;">foo</span>
will beparsed as aSmallCaps
inline, and will work in all outputformats that support small caps (#1360). - Prevent spurious line breaks after list items (#1137). When the
hard_line_breaks
option was specified, pandoc would formerlyproduce a spurious line break after a tight list item. - Fixed table parsing bug (#1333).
- Handle
c++
andobjective-c
as language identifiers ingithub-style fenced blocks (#1318). - Inline math must have nonspace before final
$
(#1313).
LaTeX reader:
- Handle comments at the end of tables. This resolves the issueillustrated in http://stackoverflow.com/questions/24009489.
- Correctly handle table rows with too few cells. LaTeX seems totreat them as if they have empty cells at the end (#241).
- Handle leading/trailing spaces in
\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 totextbf
and some other constructions (#1146). - Don't assume preamble doesn't contain environments (#1338).
- Allow (and discard) optional argument for
\caption
(James Aspnes).
HTML reader:
- Fixed major parsing problem with HTML tables. Table cells werebeing combined into one cell (#1341).
- Fixed performance issue with malformed HTML tables.We let a
</table>
tag close an open<tr>
or<td>
(#1167). - Allow space between
<col>
and</col>
. - Added
audio
andsource
ineitherBlockOrInline
. - Moved
video
,svg
,progress
,script
,noscript
,svg
fromblockTags
toeitherBlockOrInline
. map
andobject
were mistakenly in both lists; they have been removedfromblockTags
.- Ignore
DOCTYPE
andxml
declarations.
MediaWiki reader:
- Don't parse backslash escapes inside
<source>
(#1445). - Tightened up template parsing.The opening
{{
must be followed by an alphanumeric or:
.This prevents the exponential slowdown in #1033. - Support "Bild" for images.
- Don't parse backslash escapes inside
DocBook reader:
- Better handle elements inside code environments. Pandoc's documentmodel does not allow structure inside code blocks, but at least this waywe preserve the text (#1449).
- Support
<?asciidoc-br?>
(#1236).
Textile reader:
- Fixed list parsing. Lists can now start without an interveningblank line (#1513).
- HTML block-level tags that do not start a line are parsed asinline HTML and do not interrupt paragraphs (as in RedCloth).
Org reader:
- Make tildes create inline code (#1345). Also relabeled
code
andverbatim
parsers to accord with the org-mode manual. - Respect
:exports
header argument in code blocks (Craig Bosma). - Fixed tight lists with sublists (#1437).
- Make tildes create inline code (#1345). Also relabeled
EPUB writer:
- Avoid excess whitespace in
nav.xhtml
. This should improveTOC view in iBooks (#1392). - Fixed regression on cover image.In 1.12.4 and 1.12.4.2, the cover image would not appear properly,because the metadata id was not correct. Now we derive the id from theactual cover image filename, which we preserve rather than using"cover-image."
- Keep newlines between block elements. This allowseasier diff-ability (#1424).
- Use
stringify
instead of customplainify
. - Use
renderTags'
for all tag rendering. This properly handles tagsthat should be self-closing. Previously<hr/>
would appear in EPUBoutput as<hr></hr>
(#1420). - Better handle HTML media tags.
- Handle multiple dates with OPF
event
attributes. Note: in EPUB3 wecan have only one dc:date, so only the first one is used.
- Avoid excess whitespace in
LaTeX writer:
- Correctly handle figures in notes. Notes can't contain figures inLaTeX, so we fake it to avoid an error (#1053).
- Fixed strikeout + highlighted code (#1294).Previously strikeout highlighted code caused an error.
ConTeXt writer:
- Improved detection of autolinks with URLs containing escapes.
RTF writer:
- Improved image embedding:
fetchItem'
is now used to get theimages, and calculated image sizes are indicated in the RTF. - Avoid extra paragraph tags in metadata (#1421).
- Improved image embedding:
HTML writer:
- Deactivate "incremental" inside slide speaker notes (#1394).
- Don't include empty items in the table of contents forslide shows. (These would result from creating a slideusing a horizontal rule.)
MediaWiki writer:
- Minor renaming of
st
prefixed names.
- Minor renaming of
AsciiDoc writer:
- Double up emphasis and strong emphasis markers in intrawordcontexts, as required by asciidoc (#1441).
Markdown writer:
- Avoid wrapping that might start a list, blockquote, or header (#1013).
- Use Span instead of (hackish)
SmallCaps
inplainify
. - Don't use braced attributes for fenced code (#1416).If
Ext_fenced_code_attributes
is not set, the first classattribute will be printed after the opening fence as a bare word. - Separate adjacent lists of the same kind with an HTML comment (#1458).
PDF writer:
- Fixed treatment of data uris for images (#1062).
Docx writer:
- Use Compact style for empty table cells (#1353).Otherwise we get overly tall lines when there are emptytable cells and the other cells are compact.
- Create overrides per-image for
media/
in reference docx.This should be somewhat more robust and cover more types of images. - Improved
entryFromArchive
to avoid an unneeded parse. - Section numbering carries over from reference.docx (#1305).
- Simplified
abstractNumId
numbering. Instead of sequential numbering,we assign numbers based on the list marker styles.
Text.Pandoc.Options
:- Removed
Ext_fenced_code_attributes
frommarkdown_github
extensions.
- Removed
Text.Pandoc.ImageSize
:- Use default instead of failing if image size not foundin exif header (#1358).
- ignore unknown exif header tag rather than crashing.Some images seem to have tag type of 256, which was causinga runtime error.
Text.Pandoc.Shared
:fetchItem
: unescape URI encoding before reading local file (#1427).fetchItem
: strip a fragment like?#iefix
from the extension beforedoing mime lookup, to improve mime type guessing.- Improved logic of
fetchItem
: absolute URIs are fetched from the net;other things are treated as relative URIs ifsourceURL
isJust _
,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 tryingto parse the URIs.- Fixed runtime error with
compactify'DL
on certain lists (#1452).
pandoc.hs
: Don't strip path off ofwriterSourceURL
: the path isneeded to resolve relative URLs when we fetch resources (#750).Text.Pandoc.Parsing
- Simplified
dash
andellipsis
(#1419). - Removed
(>>~)
in favor of the equivalent(<*)
(Matthew Pickering). - Generalized functions to use
ParsecT
(Matthew Pickering). - Added
isbn
andpmid
to list of recognized schemes (MatthewPickering).
- Simplified
Template changes
- Added haddock template.
- EPUB3: Added
type
attribute tolink
tags. They are supposed tobe "advisory" in HTML5, but kindlegen seems to require them. - EPUB3: Put title page in section with
epub:type="titlepage"
. - LaTeX: Made
\subtitle
work properly (#1327). - LaTeX/Beamer: remove conditional around date (#1321).
- LaTeX: Added
lot
andlof
variables, which can be set toget\listoftables
and\listoffigures
(#1407). Note thatthese variables can be set at the command line with-Vlot -Vlof
or in YAML metadata.
Under the hood improvements
Rewrote normalize for efficiency (#1385).
Rewrote Haddock reader to use
haddock-library
(#1346).- This brings pandoc's rendering of haddock markup in linewith the new haddock.
- Fixed line breaks in
@
code blocks. - alex and happy are no longer build-depends.
Added
Text.Pandoc.Compat.Directory
to allow building againstdifferent versions of thedirectory
library.
- Added
Text.Pandoc.Compat.Except
to allow building againstdifferent verions ofmtl
.
Code cleanup in some writers, using Reader monad to avoidpassing options parameter around (Matej Kollar).
Improved readability in
pandoc.hs
.Miscellaneous code cleanups (Artyom Kazak).
Avoid
import Prelude hiding (catch)
(#1309, thanks to MichaelThompson).Changed
http-conduit
flag tohttps
. Depend onhttp-client
andhttp-client-tls
instead ofhttp-conduit
. (Note: pandoc stilldepends onconduit
viayaml
.)Require
highlighting-kate >= 0.5.8.5
(#1271, #1317, Debian #753299).This change to highlighting-kate means that PHP fragments no longer needto start with<?php
. It also fixes a serious bug causing failures withocaml and fsharp.Require latest
texmath
. This fixes\tilde{E}
and allows\left
to be used with]
,)
etc. (#1319), among many otherimprovements.Require latest
zip-archive
. This has fixes for unicode path names.Added tests for plain writer.
Text.Pandoc.Templates
:- Fail informatively on template syntax errors.With the move from parsec to attoparsec, we lost good errorreporting. In fact, since we weren't testing for end of input,malformed templates would fail silently. Here we revert back toParsec for better error messages.
- Use
ordNub
(#1022).
Benchmarks:
- Made benchmarks compile again (Artyom Kazak).
- Fixed so that the failure of one benchmark does not prevent othersfrom running (Artyom Kazak).
- Use
nfIO
instead of thegetLength
trick to force full evaluation. - Changed benchmark to use only the test suite, so that benchmarksrun more quickly.
Windows build script:
- Add
-windows
to file name. - Use one install command for pandoc, pandoc-citeproc.
- Force install of pandoc-citeproc.
- Add
make_osx_package
: Call zip filepandoc-VERSION-osx.zip
.The zip should not be namedSOMETHING.pkg.zip
, or OSX finderwill extract it into a folder namedSOMETHING.pkg
, which itwill interpret as a defective package (#1308).README
:- Made headers for all extensions so they have IDs and can belinked to (Beni Cherniavsky-Paskin).
- Fixed typos (Phillip Alday).
- Fixed documentation of attributes (#1315).
- Clarified documentation on small caps (#1360).
- Better documentation for
fenced_code_attributes
extension(Caleb McDaniel). - Documented fact that you can put YAML metadata in a separate file(#1412).
pandoc 1.12.4.2 (2014-05-14)
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 theircontents to form a new list.LaTeX reader:
- Set
bibliography
in metadata from\bibliography
or\addbibresource
command. - Don't error on
%foo
with no trailing newline.
- Set
Org reader:
- Support code block headers (
#+BEGIN_SRC ...
) (Albert Krewinkel). - Fix parsing of blank lines within blocks (Albert Krewinkel).
- Support pandoc citation extension (Albert Krewinkel). This canbe turned off by specifying
org-citation
as the input format.
- Support code block headers (
Markdown reader:
citeKey
moved toText.Pandoc.Parsing
so it can be used byother readers (Albert Krewinkel).
Text.Pandoc.Parsing
:- Added
citeKey
(see above). - Added
HasLastStrPosition
type class andupdateLastStrPos
andnotAfterString
functions.
- Added
Updated copyright notices (Albert Krewinkel).
Added default.icml to data files so it installs with the package.
OSX package:
- The binary is now built with options to ensure that it can beused with OSX 10.6+.
- Moved OSX package materials to osx directory.
- Added OSX package uninstall script, included in the zip container(thanks to Daniel T. Staal).
pandoc 1.12.4 (2014-05-07)
Made it possible to run filters that aren't executable(#1096). Pandoc first tries to find the executable (searchingthe path if path isn't given). If it fails, but the fileexists and has a
.py
,.pl
,.rb
,.hs
, or.php
extension, pandoc runs the filter using the appropriateinterpreter. This should make it easier to use filters onWindows, and make it more convenient for everyone.Added Emacs org-mode reader (Albert Krewinkel).
Added InDesign ICML Writer (mb21).
MediaWiki reader:
- Accept image links in more languages (Jaime Marquínez Ferrándiz).
- Fixed bug in certain nested lists (#1213). If a level 2 list wasfollowed by a level 1 list, the first item of the level 1 listwould be lost.
- Handle table rows containing just an HTML comment (#1230).
LaTeX reader:
- Give better location information on errors, pointing to linenumbers within included files (#1274).
- LaTeX reader: Better handling of
table
environment (#1204).Positioning options no longer rendered verbatim. - Better handling of figure and table with caption (#1204).
- Handle
@{}
andp{length}
in tabular. The length is not actuallyrecorded, but at least we get a table (#1180). - Properly handle
\nocite
. It now adds anocite
metadatafield. Citations there will appear in the bibliography but notin the text (unless you explicitly put a$nocite$
variablein your template).
Markdown reader:
- Ensure that whole numbers in YAML metadata are rendered withoutdecimal points. (This became necessary with changes to aesonand yaml libraries. aeson >= 0.7 and yaml >= 0.8.8.2 are now required.)
- Fixed regression on line breaks in strict mode (#1203).
- Small efficiency improvements.
- Improved parsing of nested
div
s. Formerly a closingdiv
tagwould be missed if it came right after other block-level tags. - Avoid backtracking when closing
</div>
not found. - Fixed bug in reference link parsing in
markdown_mmd
. - Fixed a bug in list parsing (#1154). When reading a raw listitem, we now strip off up to 4 spaces.
- Fixed parsing of empty reference link definitions (#1186).
- Made one-column pipe tables work (#1218).
Textile reader:
- Better support for attributes. Instead of being ignored, attributesare now parsed and included in Span inlines. The output will be a bitdifferent from stock textile: e.g. for
*(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. - Improved treatment of HTML spans (%) (#1115).
- Improved link parsing. In particular we now pick up on attributes.Since pandoc links can't have attributes, we enclose the whole link ina span if there are attributes (#1008).
- Implemented correct parsing rules for inline markup (#1175, MatthewPickering).
- Use Builder (Matthew Pickering).
- Better support for attributes. Instead of being ignored, attributesare now parsed and included in Span inlines. The output will be a bitdifferent from stock textile: e.g. for
DocBook reader:
- Better treatment of
formalpara
. We now emit the title (if present)as a separate paragraph with boldface text (#1215). - Set metadata
author
notauthors
. - Added recognition of
authorgroup
andreleaseinfo
elements (#1214,Matthew Pickering). - Converted current meta information parsing in DocBook to a moreextensible version which is aware of the more recent metarepresentation (Matthew Pickering).
- Better treatment of
HTML reader:
- Require tagsoup 0.13.1, to fix a bug with parsing of script tags(#1248).
- Treat processing instructions & declarations as block. Previouslythese were treated as inline, and included in paragraph tags in HTMLor DocBook output, which is generally not what is wanted (#1233).
- Updated
closes
with rules from HTML5 spec. - Use Builder (Matthew Pickering, #1162).
RST reader:
- Remove duplicate
http
in PEP links (Albert Krewinkel). - Make rst figures true figures (#1168, CasperVector)
- Enhanced Pandoc's support for rST roles (Merijn Verstaaten).rST parser now supports: all built-in rST roles, new role definition,role inheritance, though with some limitations.
- Use
author
rather thanauthors
in metadata. - Better handling of directives. We now correctly handle fieldlists that are indented more than three spaces. We treat an
aafig
directive as a code block with attributes, so it can beprocessed in a filter (#1212).
- Remove duplicate
LaTeX writer:
- Mark span contents with label if span has an ID (Albert Krewinkel).
- Made
--toc-depth
work well with books in latex/pdf output (#1210). - Handle line breaks in simple table cells (#1217).
- Workaround for level 4-5 headers in quotes. These previously producedinvalid LaTeX:
\paragraph
or\subparagraph
in aquote
environment.This adds anmbox{}
in these contexts to work around the problem.See http://tex.stackexchange.com/a/169833/22451 (#1221). - Use
\/
to avoid en-dash ligature instead of-{}-
(Vaclav Zeman).This is to fix LuaLaTeX output. The-{}-
sequence does not avoid theligature with LuaLaTeX but\/
does. - Fixed string escaping in
hyperref
andhyperdef
(#1130).
ConTeXt writer: Improved autolinks (#1270).
DocBook writer:
- Improve handling of hard line breaks in Docbook writer(Neil Mayhew). Use a
<literallayout>
for the entire paragraph, notjust for the newline character. - Don't let line breaks inside footnotes influence the enclosingparagraph (Neil Mayhew).
- Distinguish tight and loose lists in DocBook output, using
spacing="compact"
(Neil Mayhew, #1250).
- Improve handling of hard line breaks in Docbook writer(Neil Mayhew). Use a
Docx writer: When needed files are not present in the user's
reference.docx
, fall back on the versions in thereference.docx
in pandoc's data files. This fixes a bug that occurs when areference.docx
saved by LibreOffice is used. (#1185)EPUB writer:
- Include extension in epub ids. This fixes a problem with duplicateextensions for fonts and images with the same base name but differentextensions (#1254).
- Handle files linked in raw
img
tags (#1170). - Handle media in
audio
source tags (#1170).Note that we now use amedia
directory rather thanimages
. - Incorporate files linked in
video
tags (#1170).src
andposter
will both be incorporated intocontent.opf
and the epub container.
HTML writer:
- Add colgroup around col tags (#877). Also affects EPUB writer.
- Fixed bug with unnumbered section headings. Unnumbered sectionheadings (with class
unnumbered
) were getting numbers. - Improved detection of image links. Previously image links withqueries were not recognized, causing
<embed>
to be used insteadof<img>
.
Man writer: Ensure that terms in definition lists aren't line wrapped(#1195).
Markdown writer:
- Use proper escapes to avoid unwanted lists (#980). Previously we used0-width spaces, an ugly hack.
- Use longer backtick fences if needed (#1206). If the content contains abacktick fence and there are attributes, make sure longer fences areused to delimit the code. Note: This works well in pandoc, but githubmarkdown is more limited, and will interpret the first string of threeor more backticks as ending the code block.
RST writer: Avoid stack overflow with certain tables (#1197).
RTF writer: Fixed table cells containing paragraphs.
Custom writer:
- Correctly handle UTF-8 in custom lua scripts (#1189).
- Fix bugs with lua scripts with mixed-case filenames andpaths containing
+
or-
(#1267). Note thatgetWriter
inText.Pandoc
no longer returns a custom writer on inputfoo.lua
.
AsciiDoc writer: Handle multiblock and empty table cells(#1245, #1246). Added tests.
Text.Pandoc.Options
: AddedreaderTrace
toReaderOptions
Text.Pandoc.Shared
:- Added
compactify'DL
(formerly in markdown reader) (Albert Krewinkel). - Fixed bug in
toRomanNumeral
: numbers ending with '9' wouldbe rendered as Roman numerals ending with 'IXIV' (#1249). Thanks toJesse Rosenthal. openURL
: set proxy with value of http_proxy env variable (#1211).Note: proxies with non-root paths are not supported, due tolimitations inhttp-conduit
.
- Added
Text.Pandoc.PDF
:- Ensure that temp directories deleted on Windows (#1192). The PDF isnow read as a strict bytestring, ensuring that process ownership willbe terminated, so the temp directory can be deleted.
- Use
/
as path separators in a few places, even on Windows.This seems to be necessary for texlive (#1151, thanks to Tim Lin). - Use
;
forTEXINPUTS
separator on Windows (#1151). - Changes to error reporting, to handle non-UTF8 error output.
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 wordtrue
will appear, which may beunexpected. (Previously nothing would appear.)
Text.Pandoc.SelfContained
: Handleposter
attribute invideo
tags (#1188).Text.Pandoc.Parsing
:- Made
F
an instance of Applicative (#1138). - Added
stateCaption
. - Added
HasMacros
, simplified other typeclasses.RemovedupdateHeaderMap
,setHeaderMap
,getHeaderMap
,updateIdentifierList
,setIdentifierList
,getIdentifierList
. - Changed the smart punctuation parser to return
Inlines
rather thanInline
(Matthew Pickering). - Changed
HasReaderOptions
,HasHeaderMap
,HasIdentifierList
from typeclasses of monads to typeclasses of states. This simplifiesthe instance definitions and provides more flexibility. Generalizedtype ofgetOption
and added a default definition. RemovedaskReaderOption
. AddedextractReaderOption
. AddedextractHeaderMap
andupdateHeaderMap
inHasHeaderMap
.Gave default definitions forgetHeaderMap
,putHeaderMap
,modifyHeaderMap
. AddedextractIdentifierList
andupdateIdentifierList
inHasIdentifierList
. Gave defaultsforgetIdentifierList
,putIdentifierList
, andmodifyIdentifierList
. The ultimate goal here is to allow differentparsers to use their own, tailored parser states (instead ofParserState
) while still using shared functions.
- Made
Template changes:
- LaTeX template: Use
fontenc
package only withpdflatex
(#1164). - LaTeX template: Add
linestretch
andfontfamily
variables. - LaTeX template: Conditionalize author and date commands.
- Beamer template: Consistent styles for figure and table captions(aaronwolen).
- LaTeX and beamer template: Adjust widths correctly for oversizedimages. Use
\setkeys{Gin}{}
to set appropriate defaults for\includegraphics
(Yihui Xie, Garrick Aden-Buie). Loadupquote
only afterfontenc
(Yihui Xie). - Beamer template: Added caption package (#1200).
- Beamer template: changes for better unicode handling (KarolS).
- DocBook template: use
authorgroup
if there are authors. - revealjs template: Move
include-after
to end (certainlyakey). - revealjs template: Fixed PDF print function (#1220, kevinkenan).
- LaTeX template: Use
Bumped version bounds of dependencies.
Added a
--trace
command line option, for debugging backtrackingbugs. 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 (AlbertKrewinkel).
Add
.editorconfig
(Albert Krewinkel).See http://editorconfig.org/ for details.Give more useful error message if '-t pdf' is specified (#1155).
Added
Cite
,SmallCaps
toArbitrary
instance (#1269).Allow
html4
as a synonym ofhtml
as a reader (it already worksas a writer).README:
- Added an explanation of how to use YAML metadata toforce items to appear in the bibliography without citations inthe text (like LaTeX
\nocite
). - Added note to
--bibtex/--natbib
: not for use in making PDF(#1194, thanks to nahoj). - Added explanatory notes about
--natbib
and--biblatex
. - Added specification of legal syntax for citation keys.
- Fixed variable defaults documentation (Albert Krewinkel).
- Added an explanation of how to use YAML metadata toforce items to appear in the bibliography without citations inthe text (like LaTeX
Removed copyright statements for files that have been removed(Albert Krewinkel).
Moved some doc files from
data-files
toextra-source-files
(#1123).They aren't needed at runtime. We keep README and COPYRIGHT in datato ensure that they'll be available on all systems on which pandocis installed.Use cabal sandboxes in Windows build script.
pandoc 1.12.3.3 (2014-02-03)
- To changes to source; recompiled tarball with latest alex andhappy, so they will work with GHC 7.8.
pandoc 1.12.3.2 (2014-02-03)
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).
pandoc 1.12.3.1 (2014-01-14)
- Relaxed version constraint on binary, allowing the use of binary 0.5.
pandoc 1.12.3 (2014-01-10)
The
--bibliography
option now sets thebiblio-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
isused together with--natbib
or--biblatex
(Florian Eitel).Template changes:
- Updated beamer template to include booktabs.
- Added
abstract
variable to LaTeX template. - Put
header-includes
aftertitle
in LaTeX template (#908). - Allow use of
\includegraphics[size]
in beamer.This just required porting a macro definition from the defaultLaTeX template to the default beamer template.
reference.docx
: IncludeFootnoteText
style.Otherwise Word ignores the style, even when specified in thepPr
.(#901)reference.odt
: Tidiedstyles.xml
.Relaxed version bounds for dependencies.
Added
withSocketsDo
around http conduit code inopenURL
,so it works on Windows (#1080).Added
Cite
function tosample.lua
.Markdown reader:
- Fixed regression in title blocks (#1089).If author field was empty, date was being ignored.
- Allow backslash-newline hard line breaks in grid andmultiline table cells.
- Citation keys may now start with underscores, and may containunderscores adjacent to internal punctuation.
LaTeX reader:
- Add support for
Verb
macro (jrnold) (#1090). - Support babel-style quoting:
"`..."'
.
- Add support for
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 notr
orrow
elements.LaTeX writer:
- Factored out function for table cell creation.
- Better treatment of footnotes in tables.Notes now appear in the regular sequence, rather than in thetable cell. (This was a regression in 1.10.)
HTML reader: Parse name/content pairs from meta tags as metadata.Closes #1106.
Moved
fixDisplayMath
from Docx writer toWriter.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. Butit 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 thebacktick form will be preferred in general if both are enabled. Thatis 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 otherrels
files besides the ones pandoc generates explicitly.HTML writer:
- With
--toc
, headers no longer link to themselves (#1081). - Omit footnotes from TOC entries. Otherwise we get doubledfootnotes when headers have notes!
- With
EPUB writer:
- Avoid duplicate notes when headings contain notes.This arose because the headings are copied into the metadata"title" field, and the note gets rendered twice. We strip thenote now before putting the heading in "title".
- Strip out footnotes from toc entries.
- Fixed bug with
--epub-stylesheet
. Now the contents ofwriterEpubStylesheet
(set by--epub-stylesheet
)should again work, and take precedence over a stylesheet specifiedin the metadata.
Text.Pandoc.Pretty
: Addednestle
. API change.Text.Pandoc.MIME
: Addedwmf
,emf
.Text.Pandoc.Shared
:fetchItem
now handles image URLs beginningwith//
.Text.Pandoc.ImageSize
: Parse EXIF format JPEGs. Previouslywe could only get size information for JFIF format, which ledto squished images in Word documents. Closes #976.Removed old
MarkdownTest_1.0.3
directory (#1104).
pandoc 1.12.2.1 (2013-12-08)
- Markdown reader: Fixed regression in list parser, involvingcontinuation lines containing raw HTML (or even verbatim raw HTML).
pandoc 1.12.2 (2013-12-07)
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 metadatacreator:- role: author text: John Smith- role: editor text: Sarah Jonesidentifier:- scheme: DOI text: doi:10.234234.234/33publisher: My Pressrights: (c) 2007 John Smith, CC BY-NCcover-image: img/mypic.jpgstylesheet: style.css...
Metadata may still be provided using
--epub-metadata
; it willbe merged with the metadata in YAML blocks.EPUB writer:
meta
tags are now used instead ofopf
attributes for EPUB3.- Insert "svg" property as needed in opf (EPUB 3).
- Simplify
imageTypeOf
usinggetMimeType
. - Add properties attribute to
cover-image
item for EPUB 3. - Don't include node for
cover.xhtml
if no cover! - Ensure that same identifier is used throughout (#1044).If an identifier is given in metadata, we use that; otherwisewe generate a random uuid.
- Add cover reference to guide element (EPUB 2) (Shaun Attfield).Fixes an issue with Calibre putting the cover at the end of the bookif the spine has
linear="no"
. Apparently this is best practicefor other converters as well:http://www.idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.6. - Allow
stylesheet
in metadata. The value is a path to the stylesheet. - Allow partial dates:
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 todraw:frame
elements (#1069).This is reported to be necessary to avoid an error from recentversions of Libre Office when files contain more than one imageThanks 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 metadatawhen it was used in templates. Now we apply the 'hierarchicalize'transformation. Note that a block headed by a level-2 header willturn 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:
- Use mime type info returned by fetchItem.
- Fixed core metadata (#1046).Don't create empty date nodes if no date given.Don't create multiple
dc:creator
nodes; instead separate bysemicolons. - Fix URL for core-properties in
_rels/.rels
(#1046).
Plain writer: don't print
<span>
tags.LaTeX writer:
- Fix definition lists with internal links in terms (#1032).This fix puts braces around a term that contains an internallink, to avoid problems with square brackets.
- Properly escape pdftitle, pdfauthor (#1059).
- Use booktabs package for tables (thanks to Jose Luis Duran).
Updated beamer template. Now references should work properly(in a slide) when
--biblatex
or--natbib
is used.LaTeX reader:
- Parse contents of curly quotes or matched
"
as quotes. - Support
\textnormal
as span with classnodecor
.This is needed for pandoc-citeproc. - Improved citation parsing. This fixes a run-time error that occurredwith
\citet{}
(empty list of keys). It also ensures that empty keysdon't get produced.
- Parse contents of curly quotes or matched
MediaWiki reader: Add automatic header identifiers.
HTML reader:
- Use pandoc
Div
andSpan
for raw<div>
,<span>
when--parse-raw
. - Recognize
svg
tags as block level content (thanks to MinRK). - Parse LaTeX math if appropriate options are set.
- Use pandoc
Markdown reader:
- Yaml block must start immediately after
---
. If there's a blankline after---
, we interpreted it as a horizontal rule. - Correctly handle empty bullet list items.
- Stop parsing "list lines" when we hit a block tag.This fixes exponential slowdown in certain input, e.g.a series of lists followed by
</div>
.
- Yaml block must start immediately after
Slides: Preserve
<div class="references">
in references slide.Text.Pandoc.Writer.Shared
:- Fixed bug in
tagWithAttrs
. A space was omitted before key-valueattributes, leading to invalid HTML. normalizeDate
: Allow dates with year only (thanks to Shaun Attfield).- Fixed bug in
openURL
withdata:
URIs. Previously the base-64encoded bytestring was returned. We now decode it so it's a properimage!
- Fixed bug in
DocBook reader: Handle numerical attributes starting with decimal.Also use
safeRead
instead ofread
.Text.Pandoc.Parsing
:- Generalized type of
registerHeader
, using new type classesHasReadeOptions
,HasIdentifierList
,HasHeaderMap
.These allow certain common functions to be reusedeven in parsers that use custom state (instead ofParserState
),such as the MediaWiki reader. - Moved inlineMath, displayMath from Markdown reader to Parsing.Generalize their types and export them from Parsing. (API change.)
- Generalized type of
Text.Pandoc.Readers.TexMath
: ExportreadTeXMath'
, which attendsto display/inline. DeprecatereadTeXMath
, and usereadTeXMath'
in all the writers. Requiretexmath >= 0.6.5.2
.Text.Pandoc.MIME
:- Add entry for
jfif
. - In looking up extensions, drop the encoding info.E.g. for 'image/jpg;base64' we should lookup 'image/jpg'.
- Add entry for
Templates: Changed how array variables are resolved. Previously if
foo
is an array (which might be because multiple values were set onthe command line),$foo$
would resolve to the concatenation of theelements of foo. This is rarely useful behavior. It has been changedso that the first value is rendered. Of course, you can still iterateover the values using$for(foo)$
. This has the result that you canoverride earlier settings using-V
by putting new values later on thecommand line, which is useful for many purposes.Text.Pandoc
: Don't default topandocExtensions
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 inpandoc-citeproc
.
pandoc 1.12.1 (2013-10-20)
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 problemswhen converting to markdown (#1027).LaTeX reader:
- Ensure that preamble doesn't contribute to the text ofthe document.
- Fixed character escaping in
\url{}
. Previously\~
wasn't handledproperly, among others. - Parse
{groups}
asSpan
. This is needed for accurate conversion ofbibtex titles, since we need to know what was protected fromtitlecase conversions.
LaTeX writer:
- Specially escape non-ascii characters in labels.Otherwise we can get compile errors and other bugs whencompiled with pdflatex (#1007). Thanks to begemotv2718 for the fix.
- Add link anchors for code blocks with identifiers (#1025).
Throughout the code, use
isURI
instead ofisAbsoluteURI
.It allows fragments identifiers.Slide formats:
- A Div element with class "notes" is treated as speakernotes. Currently beamer goes to
\note{}
, revealjs to<aside class="notes">
, and the notes are simply suppressed inother formats (#925). - Fixed
. . .
(pause) on HTML slide formats. Closes #1029.The old version caused a pause to be inserted before the firstmaterial on a slide. This has been fixed. - Removed data files for s5, slideous, slidy.Users of s5 and slideous will have to download the neededfiles, as has been documented for some time in the README.By default, slidy code will be sought on the web, as before.
- A Div element with class "notes" is treated as speakernotes. Currently beamer goes to
HTML writer: Insert command to typeset mathjax only in slideous output(#966, #1012).
RST writer: Skip spaces after display math. Otherwise we get indentationproblems, and part of the next paragraph may be rendered as part of themath.
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.
pandoc 1.12.0.2 (2013-09-20)
- Removed an unused dependency (
stringable
) from pandoc.cabal.This will help packagers, but users should not need to upgrade.
pandoc 1.12.0.1 (2013-09-20)
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 parseableas a YAML boolean or string is treated as a literal string.You can get a string value with "yes", or any of the strings interpretableas 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 bugin which docx files could not be read by some versions of Wordand LibreOffice (#990).Fixed a regression involving slide shows with bibliographies.The Div container around references messed up the procedure for carvinga 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 forData a => a -> [a]
andData 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).
pandoc 1.12 (2013-09-15)
New features
Much more flexible metadata, including arbitrary fields and structuredvalues. Metadata can be specified flexibly in pandoc markdown usingYAML 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.lua
will 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 beinstalled 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 theirbehavior can be tailored to it. The repositoryhttps://github.com/jgm/pandocfilters containsa python module for writing pandoc filters in python, witha number of examples.Added
--metadata/-M
option.This is like--variable/-V
, but actually adds to metadata, notjust variables.Added
--print-default-data-file
option, which allows printingof any of pandoc's data files. (For example,pandoc --print-default-data-file reference.odt
will printreference.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 usefulfor 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 forceauto_identifiers
to use ASCIIonly. (Default formarkdown_github
.) (#807)lists_without_preceding_blankline
: Allow lists to start withoutpreceding blank space. (Default formarkdown_github
.) (#972)
Behavior changes
--toc-level
no longer implies--toc
.Reason: EPUB users who don't want a visible TOC may still wantto set the TOC level for in the book navigation.--help
now prints in and out formats in alphabetical order, andsays something about PDF output (#720).--self-contained
now returns less verbose output (telling youwhich URLs it is fetching, but not giving the full header). Inaddition, there are better error messages when fetching a URL fails.Citation support is no longer baked in to core pandoc. Users whoneed citations will need to install and use a separate filter(
--filter pandoc-citeproc
). This filter will takebibliography
,csl
, andcitation-abbreviations
from the metadata, though itmay still be specified on the command line as before.A
Cite
element is now created in parsing markdown whether or notthere is a matching reference.The
pandoc-citeproc
script will put the bibliography at theend of the document, as before. However, it will be put inside aDiv
element with class "references", allowing users some controlover the styling of references. A final header, if any, willbe included in theDiv
.The markdown writer will not print a bibliography if the
citations
extension is enabled. (If the citations are formattedas 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 findingimages in ODT, EPUB, Docx, and PDF. This has been confusing to manyusers. So we now look for images relative to the currentworking directory, even if the first file argument is in anotherdirectory. Note that this change may break some existing workflows.If you have been assuming that relative links will be interpretedrelative to the directory of the first file argument, you'll needto 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 pointingto 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 withthe MathJax MediaWiki extension.All writers: template variables are set automatically from metadatafields. 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
, andfooter
can nowall be set individually in metadata. Thedescription
variable has beenremoved. Quotes have been added so that spaces are allowed in thetitle. If you have a title that beginsCOMMAND(1) footer here | header here
pandoc will still parse it into a title, section, header, andfooter. But you can also specify these elements explicitly (#885).
Markdown reader
- Added support for YAML metadata blocks, which can come anywherein the document (not just at the beginning). A document can containmultiple YAML metadata blocks.
- HTML span and div tags are parsed as pandoc Span and Div elements.
Markdown writer
- Allow simple tables to be printed as grid tables,if other table options are disabled. This means you can do
pandoc -t markdown-pipe_tables-simple_tables-multiline_tables
and all tables will render as grid tables. - Support YAML title block (render fields in alphabetical orderto make output predictable).
- Allow simple tables to be printed as grid tables,if other table options are disabled. This means you can do
API changes
Meta
inText.Pandoc.Definition
has been changed to allowstructured metadata. (Note: existing code that pattern-matchesonMeta
will have to be revised.) Metadata can now containindefinitely many fields, with content that can be a string,a Boolean, a list ofInline
elements, a list ofBlock
elements, or a map or list of these.A new generic block container (
Div
) has been added toBlock
,and a generic inline container (Span
) has been added toInline
.These can take attributes. They will render in HTML, Textile,MediaWiki, Org, RST and Markdown (withmarkdown_in_html
extension) as HTML<div>
and<span>
elements; in other formatsthey will simply pass through their contents. But they can betargeted 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-walkingfunctions that are much faster than the SYB functions fromText.Pandoc.Generic
. These functions are now used where possiblein pandoc's code. (Tests.Walk
verifies thatwalk
andquery
match the generic traversalsbottomUp
andqueryWith
.)Added
Text.Pandoc.JSON
, which providesToJSON
andFromJSON
instances for the basic pandoc types. They use GHC generics andshould be faster than the old JSON serialization usingData.Aeson.Generic
.Added
Text.Pandoc.Process
, exportingpipeProcess
.This is a souped-up version ofreadProcessWithErrorcode
thatuses lazy bytestrings instead of strings and allows settingenvironment variables. (Used inText.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
andfetchItem
now return anEither, for better error handling.Made
stringify
polymorphic inText.Pandoc.Shared
.Removed
stripTags
fromText.Pandoc.XML
.Text.Pandoc.Templates
:- Simplified
Template
type to a newtype. - Removed
Empty
. - Changed type of
renderTemplate
: it now takes a JSON contextand a compiled template. - Export
compileTemplate
. - Export
renderTemplate'
that takes a string instead of a compiledtemplate. - Export
varListToJSON
.
- Simplified
Text.Pandoc.PDF
exportsmakePDF
instead oftex2pdf
.Text.Pandoc
:- Made
toJsonFilter
an alias fortoJSONFilter
fromText.Pandoc.JSON
. - Removed
ToJsonFilter
typeclass.ToJSONFilter
fromText.Pandoc.JSON
should be used instead. (Compiling againstpandoc-types instead of pandoc will also produce smaller executables.)
- Removed the deprecated
jsonFilter
function.
- Added
readJSON
,writeJSON
to the API (#817).
- Made
Text.Pandoc.Options
:- Added
Ext_lists_without_preceding_blankline
,Ext_ascii_identifiers
,Ext_ignore_line_breaks
,Ext_yaml_metadataBlock
toExtension
. - Changed
writerSourceDirectory
towriterSourceURL
and changed thetype to aMaybe
.writerSourceURL
is set to 'Just url' when thefirst command-line argument is an absolute URL. (So, relative linkswill be resolved in relation to the first page.) Otherwise, 'Nothing'. - All bibliography-related fields have been removed from
ReaderOptions
andWriterOptions
:writerBiblioFiles
,readerReferences
,readerCitationStyle
.
- Added
The
Text.Pandoc.Biblio
module has been removed. Users of thepandoc library who want citation support will need to useText.CSL.Pandoc
frompandoc-citeproc
.
Bug fixes
In markdown, don't autolink a bare URI that is followed by
</a>
(#937).Text.Pandoc.Shared
openURL
now follows redirects (#701), properly handlesdata:
URIs, and prints diagnostic output to stderr rather than stdout.readDefaultDataFile
: normalize the paths. This fixes bugs in--self-contained
on pandoc compiled withembed_data_files
(#833).- Fixed
readDefaultDataFile
so it works on Windows. - Better error messages for
readDefaultDataFile
. Instead oflisting the last path tried, which can confuse people who areusing--self-contained
, so now we just list the data file name. - URL-escape pipe characters. Even though these are legal,
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'thurt in others (#966).
Text.Pandoc.PDF
- On Windows, create temdir in working directory, since the systemtemp directory path may contain tildes, which can causeproblems in LaTeX (#777).
- Put temporary output directory in
TEXINPUTS
(see #917). makePDF
tries to download images that are not found locally,if the first argument is a URL (#917).- If compiling with
pdflatex
yields an encoding error, offerthe 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 URLbefore treating as a filename. This fixes--self-contained
when usedwith CSS files that include web fonts using the method described here:http://paulirish.com/2009/bulletproof-font-face-implementation-syntax/(#739). Handlesrc
inembed
,audio
,source
,input
tags.Text.Pandoc.Parsing
:uri
parser no longer treats punctuation beforepercent-encoding, or a+
character, as final punctuation.Text.Pandoc.ImageSize
: Handle EPS (#903). This change will makeEPS 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
- Properly handle blank line at beginning of input (#882).
- Fixed bug in unmatched reference links. The input
[*infile*] [*outfile*]
was getting improperly parsed:"infile" was emphasized, but "outfile" was literal (#883). - Allow internal
+
in citation identifiers (#856). - Allow
.
or)
after#
in ATX headers if nofancy_lists
. - Do not generate blank title, author, or date metadata elements.Leave these out entirely if they aren't present.
- Allow backtick code blocks not to be preceded by blank line (#975).
Textile reader:
- Correctly handle entities.
- Improved handling of
<pre>
blocks (#927). Remove internal HTML tagsin code blocks, rather than printing them verbatim. Parse attributeson<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
- Support alltt environment (#892).
- Support
\textasciitilde
,\textasciicircum
(#810). - Treat
\textsl
as emphasized text reader (#850). - Skip positional options after
\begin{figure}
. - Support
\v{}
for hacek (#926). - Don't add spurious ", " to citation suffixes.This is added when needed in pandoc-citeproc.
- Allow spaces in alignment spec in tables, e.g.
{ l r c }
. - Improved support for accented characters (thanks to Scott Morrison).
- Parse label after section command and set id (#951).
RST reader:
- Don't insert paragraphs where docutils doesn't.
rst2html
doesn't add<p>
tags to list items (even when they areseparated by blank lines) unless there are multiple paragraphs in thelist. This commit changes the RST reader to conform more closely towhat docutils does (#880). - Improved metadata. Treat initial field list as metadata whenstandalone specified. Previously ALL fields "title", "author","date" in field lists were treated as metadata, even if not atthe beginning. Use
subtitle
metadata field for subtitle. - Fixed 'authors' metadata parsing in reST. Semicolons separatedifferent authors.
- Don't insert paragraphs where docutils doesn't.
MediaWiki reader
- Allow space before table rows.
- Fixed regression for
<ref>URL</ref>
.<
is no longer allowed in URLs, according to the uri parserinText.Pandoc.Parsing
. Added a test case. - Correctly handle indented preformatted text without precedingor following blank line.
- Fixed
|
links inside table cells. Improved attribute parsing. - Skip attributes on table rows. Previously we just crashed ifrows had attributes, now we ignore them.
- Ignore attributes on headers.
- Allow
Image:
for images (#971). - Parse an image with caption in a paragraph by itself as a figure.
LaTeX writer
- Don't use ligatures in escaping inline code.
- Fixed footnote numbers in LaTeX/PDF tables. This fixes a bugwherein notes were numbered incorrectly in tables (#827).
- Always create labels for sections. Previously the labels were onlycreated when there were links to the section in the document (#871).
- Stop escaping
|
in LaTeX math.This caused problems with array environments (#891). - Change
\
to/
in paths./
works even on Windows in LaTeX.\
will cause major problems if unescaped. - Write id for code block to label attribute in LaTeX when listingsis used (thanks to Florian Eitel).
- Scale LaTeX tables so they don't exceed columnwidth.
- Avoid problem with footnotes in unnumbered headers (#940).
Beamer writer: when creating beamer slides, add
allowframebreaks
optionto the slide if it is one of the header classes. It is recommendedthat your bibliography slide have this attribute:# References {.allowframebreaks}
This causes multiple slides to be created if necessary, dependingon the length of the bibliography.
ConTeXt writer: Properly handle tables without captions. The old outputonly worked in MkII. This should work in MkIV as well (#837).
MediaWiki writer: Use native mediawiki tables instead of HTML (#720).
HTML writer:
- Fixed
--no-highlight
(Alexander Kondratskiy). - Don't convert to lowercase in email obfuscation (#839).
- Ensure proper escaping in
<title>
and<meta>
fields.
- Fixed
AsciiDoc writer:
- Support
--atx-headers
(Max Rydahl Andersen). - Don't print empty identifier blocks
([[]])
on headers (MaxRydahl Andersen).
- Support
ODT writer:
- Fixing wrong numbered-list indentation in open document format(Alexander Kondratskiy) (#369).
reference.odt
: Added pandoc as "generator" inmeta.xml
.- Minor changes for ODF 1.2 conformance (#939). We leave thenonconforming
contextual-spacing
attribute, which is provided byLibreOffice itself and seems well supported.
Docx writer:
- Fixed rendering of display math in lists.In 1.11 and 1.11.1, display math in lists rendered as a new listitem. Now it always appears centered, just as outside of lists,and in proper display math style, no matter how far indented thecontaining list item is (#784).
- Use
w:br
withw:type
textWrapping
for linebreaks.Previously we usedw:cr
(#873). - Use Compact style for Plain block elements, todifferentiate between tight and loose lists (#775).
- Ignore most components of
reference.docx
.We take theword/styles.xml
,docProps/app.xml
,word/theme/theme1.xml
, andword/fontTable.xml
fromreference.docx
, ignoring everything else. This should helpwith the corruption problems caused when different versions ofWord resave the reference.docx and reorganize things. - Made
--no-highlight
work properly.
EPUB writer
- Don't add
dc:creator
tags if present in EPUB metadata. - Add
id="toc-title"
toh1
innav.xhtml
(#799). - Don't put blank title page in reading sequence.Set
linear="no"
if no title block. Addresses #797. - Download webtex images and include as data URLs.This allows you to use
--webtex
in creating EPUBs.Math with--webtex
is automatically made self-contained. - In
data/epub.css
, removed highlighting styles (whichare no longer needed, since styles are added by the HTMLwriter according to--highlighting-style
). Simplifiedmargin fields. - If resource not found, skip it, as in Docx writer (#916).
- Don't add
RTF writer:
- Properly handle characters above the 0000-FFFF range.Uses surrogate pairs. Thanks to Hiromi Ishii for the patch.
- Fixed regression with RTF table of contents.
- Only autolink absolute URIs. This fixes a regression, #830.
Markdown writer:
- Only autolink absolute URIs. This fixes a regression, #830.
- Don't wrap attributes in fenced code blocks.
- Write full metadata in MMD style title blocks.
- Put multiple authors on separate lines in pandoc titleblock.Also, don't wrap long author entries, as new lines get treatedas new authors.
Text.Pandoc.Templates
:- Fixed bug retrieving default template for markdown variants.
- Templates can now contain "record lookups" in variables;for example,
author.institution
will retrieve theinstitution
field of theauthor
variable. - More consistent behavior of
$for$
. Whenfoo
is not a list,$for(foo)$...$endfor$
should behave like \(if(foo)\)...\(endif\).So iffoo
resolves to "", no output should be produced.See pandoc-templates#39.
Citation processing improvements (now part of pandoc-citeproc):
- Fixed
endWithPunct
The new version correctly sees a sentenceending in '.)' as ending with punctuation. This fixes a bug whichled such sentences to receive an extra period at the end: '.).'.Thanks to Steve Petersen for reporting. - Don't interfere with Notes that aren't citation notes.This fixes a bug in which notes not generated from citations werebeing altered (e.g. first letter capitalized) (#898).
- Only capitalize footnote citations when they have a prefix.
- Changes in suffix parsing. A suffix beginning with a digit gets 'p'inserted before it before passing to citeproc-hs, so that bare numbersare treated as page numbers by default. A suffix not beginning withpunctuation has a space added at the beginning (rather than a comma andspace, as was done before for not-author-in-text citations).The result is that
\citep[23]{item1}
in LaTeX will be interpretedproperly, with '23' treated as a locator of type 'page'. - Many improvements to citation rendering, due to fixes in citeproc-hs(thanks to Andrea Rossato).
- Warnings are issued for undefined citations, which are renderedas
???
. - Fixed hanging behavior when locale files cannot be found.
- Fixed
Template changes
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 formonofont
.This ensures that straight quotes appear as straight, rather thanbeing 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 likeoneside
; it maybe 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)
Under-the-hood improvements
Markdown reader:Improved strong/emph parsing, using the strategy ofhttps://github.com/jgm/Markdown. The new parsing algorithm requiresno backtracking, and no keeping track of nesting levels. It will givedifferent results in some edge cases, but these should not affect normaluses.
Added
Text.Pandoc.Compat.Monoid
.This allows pandoc to compile withbase
< 4.5, whereData.Monoid
doesn't export<>
. Thanks to Dirk Ullirch for the patch.Added
Text.Pandoc.Compat.TagSoupEntity
.This allows pandoc to compile withtagsoup
0.13.x.Thanks to Dirk Ullrich for the patch.Most of
Text.Pandoc.Readers.TeXMath
has been moved to thetexmath
module (0.6.4). (This allowspandoc-citeproc
tohandle simple math in bibliography fields.)Added
Text.Pandoc.Writers.Shared
for shared functions usedonly in writers.metaToJSON
is used in writers to create aJSON object for use in the templates from the pandoc metadataand variables.getField
,setField
, anddefField
arefor working with JSON template contexts.Added
Text.Pandoc.Asciify
utility module.This exports functions to create ASCII-only versions of identifiers.Text.Pandoc.Parsing
- Generalized state type on
readWith
(API change). - Specialize readWith to
String
input. (API change). - In
ParserState
, replacestateTitle
,stateAuthors
,stateDate
withstateMeta
andstateMeta'
.
- Generalized state type on
Text.Pandoc.UTF8
: use strict bytestrings in reading. The use of lazybytestrings seemed to cause problems using pandoc on 64-bit Windows7/8 (#874).Factored out
registerHeader
from markdown reader, added toText.Pandoc.Parsing
.Removed
blaze_html_0_5
flag, requireblaze-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 ofjson
for JSON.Set default stack size to 16M. This is needed for some largeconversions, 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 nowrequires at least GHC 7.2 for GHC generics.
pandoc 1.11.1 (2013-03-17)
Markdown reader:
- Fixed regression in which parentheses were lost in link URLs.Added tests. Closes #786.
- Better handling of unmatched double quotes in
--smart
mode.These occur frequently in fiction, since it is customary not toclose quotes in dialogue if the speaker does not change betweenparagraphs. The unmatched quotes now get turned into literalleft double quotes. (NoQuoted
inline is generated, however.)Closes #99 (again).
HTML writer: Fixed numbering mismatch between TOC and sections.
--number-offset
now affects TOC numbering as wellas section numbering, as it should have all along. Closes #789.Markdown writer: Reverted 1.11 change that caused citations to be renderedas markdown citations, even if
--bibliography
was specified, unlesscitation
extension is disabled. Now, formatted citations are alwaysprinted if--bibliography
was specified. If you want to reformatmarkdown keeping pandoc markdown citations intact, don't use--bibliography
. Note that citations parsed from LaTeX documents willbe rendered as pandoc markdown citations when--bibliography
is notspecified.ODT writer: Fixed regression leading to corrupt ODTs.This was due to a change in the
Show
instance forText.Pandoc.Pretty.Doc
. Closes #780.Fixed spacing bugs involving code block attributes inRST reader and Markdown writer. Closes #763.
Windows package: Various improvements due to Fyodor Sheremetyev.
- Automatically set installation path (Program Files or Local App Data).
- Set system PATH environment variable when installing for all users.
- Pandoc can installed for all users using the following command.
msiexec /i pandoc-1.11.msi ALLUSERS=1
.
Bumped QuickCheck version bound.
pandoc 1.11 (2013-03-09)
Added
--number-offset
option. (See README for description.)Added
--default-image-extension
option. (See README for description.)--number-sections
behavior change: headers with classunnumbered
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 ofElement
.Sec
now includesa field forAttr
rather than justString
. (API change.)Added
markdown_github
as input format. This was an accidentalomission in 1.10.Added
readerDefaultImageExtension
field toReaderOptions
. (APIchange.)Added
writerNumberOffset
field inWriterOptions
. (API change.)Beamer template:
- Fixed captions with longtable. Thanks to Joost Kremers.
- Provide
\Oldincludegraphics
as in LaTeX template (Benjamin Bannier).
LaTeX template:
- Load microtype after fonts. Microtype needs to knowwhat fonts are being used. Thanks to dfc for the patch.
- Set
secnumdepth
to 5 if--number-sections
specified.This yields behavior equivalent to the other writers, numberinglevel 4 and 5 headers too. Closes #753.
HTML reader:
- Handle
<colgroup>
tag. - Preserve all header attributes.
- Handle
LaTeX reader:
- Parse
\hrule
asHorizontalRule
. Closes #746. - Parse starred variants of
\section
etc. as headers withattributeunnumbered
. - Read optional attributes in
lstlisting
andVerbatim
environments.We convert these to pandoc standard names, e.g.numberLines
fornumbers=left
,startFrom=100
fromfirstnumber=100
. - Handle language attribute for lstlistings.
- Better support for Verbatim and minted environments. Closes #763.
- Parse
Markdown reader:
-
in an attribute context =.unnumbered
. The point of thisis to provide a way to specify unnumbered headers in non-Englishdocuments.- Fixed bug parsing key/value attributes. Parsing failed if youhad an unquoted attribute immediately before the final '}'.
- Make backslash escape work in attributes.
- Fix title block parsing. Now if
mmd_title_blocks
is specified,pandoc will parse a MMD title block if it sees one, even ifpandoc_title_blocks
is enabled. - Refactoring:
litChar
now includes entities, so we don't needto usefromEntities
e.g. on titles. - Allow spaces around borders in pipe tables. Closes #772.
- Allow all punctuation in angle-bracket autolinks. Previouslythings like
----
were disallowed, because the uri parsertreated them as trailing punctuation. Closes #768. - Make
implicit_header_references
work properly whenheaders are given explicit identifiers. - Check for tables before line blocks. Otherwise some pipetables get treated as line blocks.
- Allow
&
in emails (for entities). - Properly handle entities in titles and links. A markdown link
<http://göogle.com>
should be a link tohttp://göogle.com
.Closes #723.
Textile reader:
- Handle attributes on headers.
LaTeX reader:
- Add
fig:
as title for images with captions.This is needed for them to be rendered as figures. Closes #766. - Never emit an empty paragraph. See #761.
- Handle
\caption
for images in figures. Closes #766. - Parse
\section*
, etc. as unnumbered sections.
- Add
HTML writer:
- Support header attributes. The attributes go onthe enclosing
section
ordiv
tag if--section-divs
is specified. - Fixed a regression (only now noticed) in html+lhs output.Previously the bird tracks were being omitted.
- Support header attributes. The attributes go onthe enclosing
LaTeX writer:
- Omit lists with no items to avoid LaTeX errors.
- Support line numbering with
--listings
.IfnumberLines
class is present, we addnumbers=left
;ifstartFrom
is present, we addfirstnumber=
. (#763)
ConTeXt writer:
- Removed
\placecontent
. This produced a duplicate toc,in conjunction with\placelist
. - Use
\title
,\subject
etc. for headers withunnumbered
class.
- Removed
Textile writer:
- Support header attributes.
Markdown writer:
- Use grid tables when needed, and if enabled. Closes #740.
- Render citations as pandoc-markdown citations.Previously citations were rendered as citeproc-formatted citationsby default. Now we render them as pandoc citations, e.g.
[@item1]
,unless thecitations
extension is disabled.If you still want formatted citations in your markdown output,usepandoc -t markdown-citations
.
RST writer:
- Support
:number-lines:
in code blocks.
- Support
Docx writer:
- Better treatment of display math. Display math inside aparagraph is now put in a separate paragraph, so it will renderproperly (centered and without extra blank lines around it).Partially addresses #742.
- Content types and document rels xml files are now created fromscratch, rather than being taken over from
reference.docx
.This fixes problems that arise when you edit thereference.docx
with Word. - We also now encode mime types for each individual image ratherthan using defaults. This should allow us to handle a widerrange of image types (including PDF). Closes #414.
- Changed style names in
reference docx
.FootnoteReference
->FootnoteRef
,Hyperlink
->Link
.The old names got changed by Word when thereference.docx
wasedited. Closes #414.
EPUB writer:
- Fix section numbering. Previously the numbering restarted from 1in each chapter (with
--number-sections
), though the numbers inthe table of contents were correct. - Headers with "unnumbered" attribute are not numbered. (Nor do theycause an increment in running numbering.) Section numbers now workproperly, even when there is material before the first numbered section.
- Include HTML TOC, even in epub2. The TOC is included in
<spine>
,butlinear
is set tono
unless the--toc
option is specified.Include<guide>
element in OPF. This should allow the TOC tobe useable in Kindles when converted with kindlegen. Closes #773.
- Fix section numbering. Previously the numbering restarted from 1in each chapter (with
Text.Pandoc.Parsing
: OptimizedoneOfStringsCI
.This dramatically reduces the speed penalty that comes from enabling theautolink_bare_uris
extension. The penalty is still substantial (in onetest, 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 sectionwith class "unnumbered". Unnumbered sections get[]
for theirsection number.Text.Pandoc.Pretty
:- Fixed
chomp
so it works insidePrefixed
elements. - Changed
Show
instance so it is better for debugging.
- Fixed
Text.Pandoc.ImageSize
: AddedPdf
toImageType
.Text.Pandoc.UTF8
: Strip off BOM if present. Closes #743.Windows installer improvements:
- The installer is now signed with a certificate (thanks toFyodor Sheremetyev).
- WiX is used instead of InnoSetup. The installer is now astandard msi file.
- The version number is now auto-detected, and need not beupdated separately.
OSX installer improvements:
- The package and pandoc executable are now signed with acertificate (thanks to Fyodor Sheremetyev).
- RTF version of license is used.
- Use full path for sysctl in
InstallationCheck
script (jonahbull).Closes #580.
Converted COPYING to markdown.
pandoc.cabal: Require latest versions of highlighting-kate,texmath, citeproc-hs, zip-archive.
pandoc 1.10.1 (2013-01-23)
Markdown reader: various optimizations, leading to asignificant 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 preservedwhen output is LaTeX, and applied when it is another format.Partially addresses #730.
Markdown and RST readers: Added parser to
block
that skips blanklines. This fixes a subtle regression involving grid tables withempty 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 newlinebetween
<literallayout>
tags.Markdown writer: Use an autolink when link text matches url.Previously we also checked for a null title, but thistest fails for links produced by citeproc-hs in bibliographies.So, if the link has a title, it will be lost on conversionto 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 usetitleblock, 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
:- More efficient version of
anyLine
. - Type of
macro
has changed; the parser now returnsBlocks
instead ofBlock
.
- More efficient version of
Relaxed old-time version bound, allowing 1.0.*.
Removed obsolete
hsmarkdown
script. Those who needhsmarkdown
should create a symlink as described in the README.
pandoc 1.10.0.5 (2013-01-23)
Markdown reader: Try
lhsCodeBlock
beforerawTeXBlock
. 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 oneblock. That failed for headerless tables (0) and also for tables withmultiple 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.
- Tilde code fences can again take a bare language string(
~~~ haskell
), not just curly-bracketed attributes(~~~ {.haskell}
). - Backtick code blocks can take the curly-bracketed attributes.
- Backtick code blocks don't require a language.
- Consolidated code for the two kinds of fenced code blocks.
- Tilde code fences can again take a bare language string(
LaTeX template: Use
\urlstyle{same}
to avoid monospace URLs.Markdown writer: Use proportional font for email autolinks withobfuscation. Closes #714.
Corrected name of
blank_before_blockquote
in README. Closes #718.Text.Pandoc.Shared
: Fixed bug inuri
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 withfile-embed.Eliminated use of TH in test suite.
Added
Text.Pandoc.Data
(non-exported) to hold the associationlist of embedded data files, if theembed_data_files
flag is selected.This isolates the code that needs special treatment with file-embed orhsb2hs
.Changes to
make-windows-installer.bat
.- Exit batch file if any of the cabal-dev installs fail.
- There's no longer any need to reinstall
highlighting-kate
. - Don't start with a
cabal update
; leave that to the user. - Force reinstall of pandoc.
Fixed EPUB writer so it builds with blaze-html 0.4.x. Thanks toJens Petersen.
pandoc 1.10.0.4 (2013-01-20)
- Fixed bug with escaped % in LaTeX reader. Closes #710.
pandoc 1.10.0.3 (2013-01-20)
- Added further missing fb2 tests to cabal file.
pandoc 1.10.0.2 (2013-01-20)
- Added fb2 tests to cabal file's extra-source-files.
pandoc 1.10.0.1 (2013-01-20)
- Bump version bounds on test-framework packages.
pandoc 1.10 (2013-01-19)
New features
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 ofheaders to include in a table of contents.New
--epub-chapter-level
option, specifying the headerlevel at which to divide EPUBs into separate files.Note that this normally affects only performance, not thevisual presentation of the EPUB in a reader.Removed the
--strict
option. Instead of using--strict
,one can now use the format namemarkdown_strict
for either inputor output. This gives more fine-grained control that--strict
did, allowing one to convert from pandoc's markdown to strictmarkdown or vice versa.It is now possible to enable or disable specific syntaxextensions by appending them (with
+
or-
) to the writeror reader name. For example,pandoc -f markdown-footnotes+hard_line_breaks
disables footnotes and enables treating newlines as hardline breaks. The literate Haskell extensions are now implementedthis 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 specificcombinations of markdown extensions:
markdown_phpextra
,markdown_github
,markdown_mmd
,markdown_strict
. These aliaseswork just like regular reader and writer names, and can be modifiedwith extension modifiers as described above. (Note that conversionfrom one markdown dialect to another does not work perfectly,because there are differences in markdown parsers besidesjust the extensions, and because pandoc's internal document model isnot 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, sincesome 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 bothhtml
andhtml5
output, but this option is provided forthose who still want<q>
tags.The markdown reader now prints warnings (to stderr) aboutduplicate 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 subsetof org-mode table syntax is also supported, which means that you canuse org-mode's nice table editor to create tables.
Added support for RST-style line blocks. These areuseful for verse and addresses.
Attributes can now be specified for headers, using the samesyntax as in code blocks. (However, currently only theidentifier 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 definedfor 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:
- Command macros now work everywhere, including non-math.Environment macros still not supported.
\input
now works, as well as\include
. TEXINPUTS is used.Pandoc looks recursively into included files for more included files.
Behavior changes
The Markdown reader no longer puts the text of autolinks in a
Code
inline. This means that autolinks will no longer appearin a monospace font.The character
/
can now appear in markdown citation keys.HTML blocks in strict_markdown are no longer required to beginat the left margin. Technically this is required, according tothe markdown syntax document, but
Markdown.pl
and other markdownprocessors are more liberal.The
-V
option has been changed so that if there are duplicatevariables, 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 numberingstyle.The LaTeX writer now uses
longtable
instead ofctable
. This allowstables to be split over page boundaries.The RST writer now uses a line block to render paragraphs containinglinebreaks (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 useText
's decodeUtf8 instead of usingSystem.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 URLinstead of skipping them or raising an error.
EPUB writer:
- The default CSS now left-aligns headers by default, instead ofcentering. This is more consistent with the rest of the writers.
- A proper multi-level table of contents is now used in
toc.ncx
.There is no longer a subsidiary table of contents at the beginningof each chapter. - Code highlighting now works by default.
- Section divs are used by default for better semantic markup.
- The title is used instead of "Title Page" in the table of contents.Otherwise we have a hard-coded English string, which looksstrange in ebooks written in other languages. Closes #572.
HTML writer:
- Put mathjax in span with class "math". Closes #562.
- Put citations in a span with class "citation." In HTML5, also includea
data-cite
attribute with a space-separated list of citationkeys.
Text.Pandoc.UTF8
: use universalNewlineMode in reading.This treats both\r\n
and\n
as\n
on input, no matterwhat platform we're running on.Citation processing is now done in the Markdown and LaTeXreaders, not in
pandoc.hs
. This makes it easier for library usersto use citations.
Template changes
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 thesection title. Now they just have the title. Similarly for partand 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:
- Rationalized templates. Previously there were three differenttemplates involved in epub production. There is now just onetemplate,
default.epub
ordefault.epub3
. It can now beoverridden using--template
, just like other templates.The titlepage is now folded into the default template.Atitlepage
variable selects it. - UTF-8, lang tag, meta tags, title element.
- Rationalized templates. Previously there were three differenttemplates involved in epub production. There is now just onetemplate,
Added scale-to-width feature to beamer template
API changes
Text.Pandoc.Definition
: AddedAttr
field toHeader
.Previously header identifiers were autogenerated by the writers.Now they are added in the readers (either automatically or explicitly).Text.Pandoc.Builder
:Inlines
andBlocks
are now synonyms forMany Inline
andMany Block
.Many
is a newtype wrapper aroundSeq
, withcustom Monoid instances forMany Inline
andMany Block. This allows
Manyto be made an instance of
Foldableand
Traversable`.- The old
Listable
class has been removed. - The module now exports
isNull
,toList
,fromList
. - The old
Read
andShow
instances have been removed; derivedinstances are now used. - Added
headerWith
.
The readers now take a
ReaderOptions
rather than aParserState
as a parameter. Indeed, not all parsers use theParserState
type;some have a custom state. The motivation for this change was to separateuser-specifiable options from the accounting functions of parser state.New module
Text.Pandoc.Options
. This includes theWriterOptions
formerly inText.Pandoc.Shared
, and its associateddata types. It also includes a new typeReaderOptions
, whichcontains many options formerly inParserState
, and its associateddata 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
.- Added
ReaderOptions.readerCitationStyle
.
WriterOptions
now includeswriterEpubVersion
,writerEpubChapterLevel
,writerEpubStylesheet
,writerEpubFonts
,writerReferenceODT
,writerReferenceDocx
, andwriterTOCDepth
.writerEPUBMetadata
hasbeen renamedwriterEpubMetadata
for consistency.Changed signatures of
writeODT
,writeDocx
,writeEPUB
, since they nolonger stylesheet, fonts, reference files as separate parameters.Removed
writerLiterateHaskell
fromWriterOptions
, andreaderLiterateHaskell
fromReaderOptions
. LHS is now handledby an extension (Ext_literate_haskell
).Removed deprecated
writerXeTeX
.Removed
writerStrict
fromWriterOptions
. AddedwriterExtensions
.Strict is now handled through extensions.Text.Pandoc.Options
exportspandocExtensions
,strictExtensions
,phpMarkdownExtraExtensions
,githubMarkdownExtensions
,andmultimarkdownExtensions
, as well as theExtensions
type.New
Text.Pandoc.Readers.MediaWiki
module, exportingreadMediaWiki
.New
Text.Pandoc.Writers.FB2
module, exportingwriteFB2
(thanks to Sergey Astanin).Text.Pandoc
:- Added
getReader
,getWriter
toText.Pandoc
. writers
is now an association list(String, Writer)
.AWriter
can be aPureStringWriter
, anIOStringWriter
, oranIOByteStringWriter
. ALL writers are now in the 'writers'list, including the binary writers and FB2 writer. This allowscode inpandoc.hs
to be simplified.- Changed type of
readers
, so all readers are in IO.Users who want pure readers can still get them form the readermodules; this just affects the functiongetReader
that looks upa reader based on the format name. The point of this change is tomake it possible to print warnings from the parser.
- Added
Text.Pandoc.Parsing
:Text.Parsec
now exports all Parsec functions used in pandoc code.No other module directly imports Parsec. This will make it easierto change the parsing backend in the future, if we want to.Text.Parsec
is used instead ofText.ParserCombinators.Parsec
.- Export the type synonym
Parser
. - Export
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 ofShow
.- Added
stateSubstitutions
andstateWarnings
toParserState
. - Generalized type of
withQuoteContext
. - Added
guardEnabled
,guardDisabled
,getOption
. - Removed
failIfStrict
. lookupKeySrc
andfromKey
are no longer exported.
Data.Default
instances are now provided forReaderOptions
,WriterOptions
, andParserState
.Text.Pandoc
re-exportsdef
.Now you can usedef
(which is re-exported byText.Pandoc
) insteadofdefaultWriterOptions
(which is still defined). Closes #546.Text.Pandoc.Shared
:- Added
safeRead
. - Renamed
removedLeadingTrailingSpace
totrim
,removeLeadingSpace
totriml
, andremoveTrailingSpace
totrimr
. - Count
\r
as space intrim
functions. - Moved
renderTags'
from HTML reader andText.Pandoc.SelfContained
toShared
. - Removed
failUnlessLHS
. - Export
compactify'
, formerly in Markdown reader. - Export
isTightList
. - Do not export
findDataFile
. readDataFile
now returns a strict ByteString.- Export
readDataFileUTF8
which returns a String, like theoldreadDataFile
. - Export
fetchItem
andopenURL
.
- Added
Text.Pandoc.ImageSize
: Use strict, not lazy bytestrings.RemovedreadImageSize
.Text.Pandoc.UTF8
: ExportencodePath
,decodePath
,decodeArg
,toString
,fromString
,toStringLazy
,fromStringLazy
.Text.Pandoc.UTF8
is now an exposed module.Text.Pandoc.Biblio
:- csl parameter now a
String
rather than aFilePath
. - Changed type of
processBiblio
. It is no longer in the IO monad.It now takes aMaybe Style
argument rather than parameters for CSLand abbrev filenames. (pandoc.hs
now calls the functions to parsethe style file and add abbreviations.)
- csl parameter now a
Markdown reader now exports
readMarkdownWithWarnings
.Text.Pandoc.RTF
now exportswriteRTFWithEmbeddedImages
instead ofrtfEmbedImage
.
Bug fixes
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:
[[[[[[[[[[[[[[[[[[hi
We fixed this by making the link parser parser charactersbetween 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 behaveddifferently 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::
blocksand substitutions.Field list fixes:
- Fixed field lists items with body beginning after a new line(Denis Laxalde).
- Allow any char but ':' in names of field lists in RST reader(Denis Laxalde).
- Don't allow line breaks in field names.
- Require whitespace after field list field names.
- Don't create empty definition list for metadata field lists.Previously a field list consisting only of metadata fields (author,title, date) would be parsed as an empty DefinitionList, which isnot legal in LaTeX and not needed in any format.
Don't recognize inline-markup starts inside words.For example,
2*2 = 4*1
should not contain an emphasizedsection. 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'tmake the requirement.
Added support for
replace::
andunicode::
substitutions.Ignore unknown interpreted roles.
Renamed image parser to
subst
, since it now handles allsubstitution 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 byspaces or punctuation, or when the URL ending may be ambiguous.Closes #564.
Removed nullBlock. Better to know about parsing problems thanto 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 fixesthe problem by requiring that a strikeout delimiting - not befollowed by a -. Closes #631.
Expanded list of
stringBreakers
.This fixes a bug on input like "(hello)" which shouldbe a parenthesized emphasized "hello".The new list is taken from the PHP source of textile 2.4.Fixed autolinks. Previously the textile reader and writerincorrectly implented RST-style autolinks for URLs and emailaddresses. This has been fixed. Now an autolink is done this way:
"$":http://myurl.com
.Fixed footnotes bug in textile. This affected notes occurringbefore punctuation, e.g.
foo[1].
. Closes #518.
LaTeX reader:
- Better handling of citation commands.
- Better handling of
\noindent
. - Added a 'try' in rawLaTeXBlock, so we can handle
\begin
without{
.Closes #622. - Made
rawLaTeXInline
try to parse block commands as well. Thisis usually what we want, given howrawLaTeXInline
is used inthe markdown and textile readers. If a block-level LaTeX commandis used in the middle of a paragraph (e.g.\subtitle
inside a title),we can treat it as raw inline LaTeX. - Handle
\slash
command. Closes #605. - Basic
\enquote
support. - Fixed parsing of paragraphs beginning with a group. Closes #606.
- Use curly quotes for bare straight quotes.
- Support obeylines environment. Closes #604.
- Guard against "begin", "end" in inlineCommand andblockCommand.
- Better error messages for environments. Now it should tell you thatit was looking for \end{env}, instead of giving "unknown parse error."
HTML reader:
- Added HTML 5 tags to list of block-level tags.
- HTML reader: Fixed bug in
htmlBalanced
, whichcaused hangs in parsing certain markdown input usingstrict mode. - Parse
<q>
asQuoted DoubleQuote
. - Handle nested
<q>
tags properly. - Modified
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:
- Remove newline after
<br/>
in translation ofLineBreak
There's no particular need for a newline (other than making thegenerated MediaWiki source look nice to a human), and in factsometimes it is incorrect: in particular, inside an enumeration, listitems cannot have embedded newline characters. (Brent Yorgey) - Use
<code>
not<tt>
for Code.
- Remove newline after
Man writer: Escape
-
as\-
.Unescaped-
's become hyphens, while\-
's are left as ascii minussigns. That is preferable for use with command-line options. Seehttp://lintian.debian.org/tags/hyphen-used-as-minus-sign.html. Thanksto Andrea Bolognani for bringing the issue to our attention.RST writer:
- Improved line block output. Use nonbreaking spaces forinitial indent (otherwise lost in HTML and LaTeX).Allow multiple paragraphs in a single line block.Allow soft breaks w continuations in line blocks.
- Properly handle images with no alt text. Closes #678.
- Fixed bug with links with duplicate text. We now (a) use anonymouslinks for links with inline URLs, and (b) use an inline link insteadof a reference link if the reference link would require a label thathas already been used for a different link. Closes #511.
- Fixed hyperlinked images. Closes #611. Use
:target:
field when you have a simple linked image. - Don't add
: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.) Alsoinsert a blank line in from of@verbatim
environments.DocBook writer:
- Made --id-prefix work in DocBook as well as HTML.Closes #607.
- Don't include empty captions in figures. Closes #581.
LaTeX writer:
- Use
\hspace*
for nonbreaking space after line break,since~
spaces after a line break are just ignored.Closes #687. - Don't escape
_
in URLs or hyperref identifiers. - Properly escape strings inside
\url{}
. Closes #576. - Use
[fragile]
only for slides containing code renderedusing listings. Closes #649. - Escape
|
as\vert
in LaTeX math. This avoids a clash withhighlighting-kate's macros, which redefine|
as a short verbatimdelimiter. Thanks to Björn Peemöller for raising this issue. - Use minipage rather than parbox for block containers in tables.This allows verbatim code to be included in grid tables.Closes #663.
- Prevent paragraphs containing only linebreaks or spaces.
- Use
HTML writer:
- Included
highlighting-css
for code spans, too.Previously it was only included if used in a code block. Closes #653. - Improved line breaks with
<dd>
tags. We now put a newline between</dd>
and<dd>
when there are multiple definitions. - Changed mathjax cdn url so it doesn't use https. (This causedproblems when used with
--self-contained
.) See #609.
- Included
EPUB writer:
--number-sections
now works properly.- Don't strip meta and link elements in epub metadata.Patch from aberrancy. Closes #589.
- Fixed a couple validation bugs.
- Use ch001, ch002, etc. for chapter filenames. This improves sortingof chapters in some readers, which apparently sort ch2 after ch10.Closes #610.
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. two
would come out with a bullet instead of "2."Thanks to Russell Allen for reporting the bug.
Use
w:cr
inw:r
instead ofw:br
for linebreaks.This seems to fix a problem viewing pandoc-generateddocx files in LibreOffice.Use integer ids for bookmarks. Closes #626.
Added nsid to abstractNum elements. This helps when mergingword documents with numbered or bulleted lists. Closes #627.
Use separate footnotes.xml for notes.This seems to help LibreOffice convert the file, even thoughit 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 fromworking. Thanks to Huashan Chen.
Text.Pandoc.Parsing
:- Fixed bug in
withRaw
, which didn't correctly handle the casewhere nothing is parsed. - Made
emailAddress
parser more correct. Now it is based on RFC 822,though it still doesn't implement quoted strings in email addresses. - Revised URI parser. It now allows many more schemes, allowsuppercase URIs, and better handles trailing punctuation andtrailing slashes in bare URIs. Added many tests.
- Simplified and improved singleQuoteStart. This makes
's'
,'l'
,etc. parse properly. Formerly we had some English-centric heuristics,but they are no longer needed. Closes #698.
- Fixed bug in
Text.Pandoc.Pretty
: Added wide punctuation range tocharWidth
.This fixes bug with Chinese commas in markdown and reST tables, anda bug that caused combining characters to be dropped.Text.Pandoc.MIME
: Added MIME types for .wof and .eot. Closes #640.Text.Pandoc.Biblio
:- Run
mvPunc
anddeNote
on metadata too.This fixed a bug with notes on titles using footnote styles. - Fixed bug in fetching CSL files from CSL data directory.
- Run
pandoc.hs
: Give correct value towriterSourceDirectory
when a URLis 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.
Under the hood improvements
We no longer depend on
utf8-string
. Instead we use functionsdefined inText.Pandoc.UTF8
that useData.Text
's conversions.Use
safeRead
instead of usingreads
directly (various modules)."Implicit figures" (images alone in a paragraph) are now handleddifferently. The markdown reader gives their titles the prefix
fig:
; thewriters look for this before treating the image as a figure. Though thisis a bit of a hack, it has two advantages: (i) implicit figures can belimited to the markdown reader, and (ii) they can be deactivated by turningoff theimplicit_figures
extension.catch
fromControl.Exception
is now used instead of theold Prefacecatch
.Text.Pandoc.Shared
: Improved algorithm fornormalizeSpaces
andoneOfStrings
(which is now non-backtracking).Text.Pandoc.Biblio
: Remove workaround fortoCapital
.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:
- Use
Text.Pandoc.Builder
instead of lists. This alsomeans that everything is normalized automatically. - Move to a one-pass parsing strategy, returning values in the readermonad, which are then run (at the end of parsing) against the finalparser state.
- Use
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 simplifystrToHtml
totoHtml
. Closes #629.Moved code for embedding images in RTFs from
pandoc.hs
to theRTF writer (which now exportswriteRTFWithEmbeddedImages
).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 behandled by Cabal. Special treatment inSetup.hs
ensures that thisexecutable never gets installed; it is only used to create the man pages.The cabal file has been modified so that the pandoc library is usedin building the pandoc executable. (This required moving
pandoc.hs
fromsrc
to.
.) This cuts compile time in half.The
executable
andlibrary
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 onGHC 7.6.We now require base >= 4.2.
Integrated the benchmark program into cabal. One can now do:
cabal configure --enable-benchmarks && cabal buildcabal bench --benchmark-option='markdown' --benchmark-option='-s 20'
The benchmark now uses README + testsuite, so benchmark resultsfrom older versions aren't comparable.
Integrated test suite with cabal.To run tests, configure with
--enable-tests
, thencabal test
.You can specify particular tests using--test-options='-t markdown'
.No output is shown unless tests fail. The Haskell test moduleshave been moved fromsrc/
totests/
.Moved all data files and templates to the
data/
subdirectory.Added an
embed_data_files
cabal flag. This causes alldata files to be embedded in the binary, so that the binaryis self-sufficient and can be relocated anywhere, copied ona USB key, etc. The Windows installer now uses this.(Since we no longer have the option to build the executablewithout the library, this is the only way to get a relocatablebinary 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.
pandoc 1.9.4.5 (2012-10-21)
- Raised version bounds on network, base64-bytestring, json,and template-haskell.
pandoc 1.9.4.4 (2012-10-20)
Removed
tests
flag and made test suite into a proper cabaltest suite, which can now be enabled using--enable-tests
and run withcabal test
.Moved man page creation out of
Setup.hs
and into anexecutable built by Cabal, but never installed. Thisallows dependencies to be specified, and solves a problemwith 1.9.4.3, which could only be installed ifdata-default
had already been installed.Updated
lhs-latex.tex
test for latest highlighting-katerepresentation of backticks.
pandoc 1.9.4.3 (2012-10-20)
Removed
-threaded
from default compile flags.Modified modules to compile with GHC 7.6 and latest version of timepackage.
pandoc 1.9.4.2 (2012-06-29)
Don't encode/decode file paths if base >= 4.4.Prior to base 4.4, filepaths and command line arguments were treatedas unencoded lists of bytes, not unicode strings, so we had to workaround that by encoding and decoding them. This commit adds CPPchecks for the base version that intelligibly enable encoding/decodingwhen needed. Fixes a bug with multilingual filenames when pandoc wascompiled 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 markan hrule break. This avoids creation of an empty H1 in thesecontexts. Closes #484.Docbook reader: Added support for "bold" emphasis. Thanks to mb21.
In make_osx_package.sh, ensure citeproc-hs is built with theembed_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.
pandoc 1.9.4.1 (2012-06-08)
Markdown reader: Added
cf.
andcp.
to list of likely abbreviations.LaTeX template: Added
linkcolor
,urlcolor
andlinks-as-notes
variables. Make TOC links black.LaTeX template improvements.
- Don't print date unless one is given explicitly in the document.
- Simplified templates.
- Use fontenc [T1] by default, and lmodern.
- Use microtype if available.
Biblio:
- Add comma to beginning of bare suffix, e.g.
@item1 [50]
.Motivation:@item1 [50]
should be as close as possible to[@item1, 50]
. - Added workaround for a bug in citeproc-hs 0.3.4 that causes footnotesbeginning with a citation to be empty. Closes #531.
- Add comma to beginning of bare suffix, e.g.
Fixed documentation on mixed lists. Closes #533.
pandoc 1.9.4 (2012-06-03)
Simplified
Text.Pandoc.Biblio
and fixed bugs with citations insidefootnotes and captions. We now handle note citations by insertingfootnotes during initial citation processing, and doing a separatepass later to remove notes inside notes.Added 'zenburn' highlight style from highlighting-kate.
Added Slideous writer. Slideous is an HTML + javascript slide showformat, similar to Slidy, but works with IE 7. (Jonas Smedegaard)
LaTeX writer:
- Ensure we don't have extra blank lines at ends of cells.This can cause LaTeX errors, as they are interpreted as new paragraphs.
- More consistent interblock spacing.
- Require highlighting-kate >= 0.5.1, for proper highlighted inlinecode in LaTeX. Closes #527.
- Ensure that a Verbatim at the end of a footnote is followed bya newline. (Fixes a regression in the previous version.)
- In default template, use black for internal links and TOC.Added commented-out code to use footnotes for links, as wouldbe suitable in print output.
Beamer writer: When
--incremental
is used, lists insidea block quote should appear all at once. (This makes Beameroutput consistent with the HTML slide show formats.)ConTeXt writer:
- Escape
%
as\letterpercent{}
not\letterpercent
,to avoid gobbling spaces after the%
sign. - Ensure space after
\stopformula
.
- Escape
Markdown writer:
- Use
:
form instead of~
in definition lists, for bettercompatibility with other markdown implementations. - Don't wrap the term, because it breaks definition lists.
- Use a nonzero space to prevent false recognitionof list marker in ordered lists. Closes #516.
- Use
Org writer: Add space before language name. Closes #523.
Docx writer: Simplified bullet characters so they work properlywith Word 2007. Closes #520.
LaTeX reader: Support
\centerline
.RST reader: handle figures. Closes #522.
Textile reader: fix for
<notextile>
and==
. Closes #517.(Paul Rivier)
pandoc 1.9.3 (2012-05-12)
Added docbook reader (with contributions from Mauro Bieg).
Fixed bug in
fromEntities
. The previous version would turnhi & low you know;
intohi &
.HTML reader:
- Don't skip nonbreaking spaces.Previously a paragraph containing just
would be renderedas an empty paragraph. Thanks to Paul Vorbach for pointing out the bug. - Support
<col>
and<caption>
in tables. Closes #486.
- Don't skip nonbreaking spaces.Previously a paragraph containing just
Markdown reader:
- Don't recognize references inside delimited code blocks.
- Allow list items to begin with lists.
LaTeX reader:
- Handle
\bgroup
,\egroup
,\begingroup
,\endgroup
. - Control sequences can't be followed by a letter.This fixes a bug where
\begingroup
was parsed as\begin
followed bygroup
. - Parse 'dimension' arguments to unknown commands. e.g.
\parindent0pt
- Make
\label
and\ref
sensitive to--parse-raw
.If--parse-raw
is selected, these will be parsed as raw latexinlines, rather than bracketed text. - Don't crash on unknown block commands (like
\vspace{10pt}
)inside\author
; just skip them. Closes #505.
- Handle
Textile reader:
- Implemented literal escapes with
==
and<notextile>
. Closes #473. - Added support for LaTeX blocks and inlines (Paul Rivier).
- Better conformance to RedCloth inline parsing (Paul Rivier).
- Parse '+text+' as emphasized (should be underlined, but thisis better than leaving literal plus characters in the output.
- Implemented literal escapes with
Docx writer: Fixed multi-paragraph list items. Previously they eachgot a list marker. Closes #457.
LaTeX writer:
- Added
--no-tex-ligatures
option to avoid replacingquotation marks and dashes with TeX ligatures. - Use
fixltx2e
package to provide\textsubscript
. - Improve spacing around LaTeX block environments:quote, verbatim, itemize, description, enumerate.Closes #502.
- Use blue instead of pink for URL links in latex/pdf output.
- Added
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 usedto escape an '@' in a chapter title, but not in the correspondingnode title, leading to invalid texinfo.
Fixed document encoding in texinfo template.Resolves Debian Bug #667816.
Markdown writer:
- Don't force delimited code blocks to be flush left.Fixes bug with delimited code blocks inside lists etc.
- Escape
<
and$
.
LaTeX writer: Use
\hyperref[ident]{text}
for internal links.Previously we used\href{\#ident}{text}
, which didn't work onall systems. Thanks to Dirk Laurie.RST writer: Don't wrap link references. Closes #487.
Updated to use latest versions of blaze-html, mtl.
pandoc 1.9.2 (2012-04-05)
LaTeX reader:
- Made
lstlisting
work as a proper verbatim environment. - Fixed bug parsing LaTeX tables with one column.
- Made
LaTeX writer:
- Use
{}
aroundctable
caption, so that formatting can be used. - Don't require eurosym package unless document has a €.
- Use
LaTeX template: Added variables for
geometry
,romanfont
,sansfont
,mathfont
,mainfont
so users can more easilycustomize fonts.PDF writer:
- Run latex engine at least two times, to ensurethat PDFs will have hyperlinked bookmarks.
- Added PDF metadata (title,author) in LaTeX standalone + PDF output.
Texinfo writer: retain directories in image paths. (Peter Wang)
RST writer: Better handling of inline formatting, in accordwith docutils' "inline markup recognition rules" (though we don'timplement the unicode rules fully). Now
hi*there*hi
getsrendered properly ashi\ *there*\ hi
, and unnecessary\
are avoided around:math:
,:sub:
,:sup:
.RST reader:
- Parse
\
as null, not escaped space. - Allow
:math:`...`
even when not followed by blankor\
. This does not implement the complex rule docutils follows,but it should be good enough for most purposes. - Add support for the rST default-role directive. (Greg Maslov)
- Parse
Text.Pandoc.Parsing: Added
stateRstDefaultRole
field toParserState
.(Greg Maslov)Markdown reader: Properly handle citations nested in other inlineelements.
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:
- Fixed Windows installer so that dzslides works.
- Removed stripansi.sh.
- Added .travis.yml for Travis continuous integration support..
- Fixed upper bound for zlib (Sergei Trofimovich).
- Fixed upper bound for test-framework.
- Updated haddocks for haddock-2.10 (Sergei Trofimovich).
pandoc 1.9.1.2 (2012-03-09)
Added
beamer+lhs
as output format.Don't escape
<
in<style>
tags with--self-contained
.This fixes a bug which prevented highlighting from workingwhen 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 ofthe nonexistentaligned*
.multline
instead of the nonexistentmultiline
.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 templateor 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 ofbabel
with xetex.Setlang
as documentclass option.\setmainlanguage
will use the last of a comma-separatedlist of languages. Thanks to François Gannaz.Fixed default LaTeX template so
\euro
and€
work. Theeurosym
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 lastof a comma-separated list of languages in lang.EPUB language metadat: convert e.g.
en_US
from locale toen-US
.Changed
-V
so that you can specify a key without a value.Such keys get the valuetrue
.Fixed permissions on installed man pages - thanks Magnus Therning.
Windows installer: require XP or higher. The installer isnow compiled on a Windows 7 machine, which fixes a problemusing citation functions on Windows 7.
OSX package: Check for 64-bit Intel CPU before installing.
pandoc 1.9.1.1 (2012-02-11)
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:
- Skip options after block commands.
- Correctly handle
{\\}
in braced. - Added a needed 'try'.
- Citations: add
,
to suffix if it doesn't start with space orpunctuation. Otherwise we get no space between the year and thesuffix in author-date styles.
Added two needed data files for S5. This fixes a problem with
pandoc -t s5 --self-contained
. Also removedslides.min.js
,which was no longer being used.Fixed some minor problems in
reference.docx
:name on "Date" style,xCs
instead ofxIs
.Fixed a problem creating docx files using a reference docxmodified using Word. The problem seems to be that Wordmodifies
_rels/.rels
, changing the Type of the Relationship todocProps/core.xml
. Pandoc now changes this back to the correctvalue if it has been altered, fixing the problem.Fixed html5 template so it works properly with highlighting.
pandoc 1.9.1 (2012-02-09)
LaTeX reader:
- Fixed regression in 1.9; properly handle escaped $ in latex math.
- Put LaTeX verse environments in blockquotes.
Markdown reader:
- Limit nesting of strong/emph. This avoids exponential lookaheadin parasitic cases, like
a**a*a**a*a**a*a**a*a**a*a**a*a**a*a**
. - Improved attributes syntax (in code blocks/spans): (1)Attributes can contain line breaks. (2) Values in key-valueattributes can be surrounded by either double or single quotes, orleft unquoted if they contain no spaces.
- Limit nesting of strong/emph. This avoids exponential lookaheadin parasitic cases, like
Headers no longer wrap in markdown or RST writers.
Added
stateMaxNestingLevel
toParserState
.We set this to 6, so you can still haveEmph
insideEmph
,just not indefinitely.More efficient implementation of
nowrap
inText.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.
pandoc 1.9.0.5 (2012-02-06)
Changed cabal file so that build-depends for the test programare not required unless the tests flag is used.
LaTeX writer: insert
{}
between adjacent hyphens so they don'tform ligatures (dashes) in code spans.
pandoc 1.9.0.4 (2012-02-06)
Raised version bound on test-framework to avoid problemscompiling 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 withciteproc. Ignore
\bibliographystyle
,\nocite
.Simplified tex2pdf; it will always run latex twice toresolve table of contents and hyperrefs.
pandoc 1.9.0.3 (2012-02-06)
Require Cabal >= 1.10.
Tweaked cabal file to meet Cabal 1.10 requirements.
pandoc 1.9.0.2 (2012-02-05)
- Allow build with json 0.4 or 0.5. Otherwise we can't build withghc 6.12.
pandoc 1.9 (2012-02-05)
New features
Added a Microsoft Word
docx
writer. The writer includes supportfor 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 thestyles.Added an
asciidoc
writer (http://www.methods.co.nz/asciidoc/).Better support for slide shows:
Added a
dzslides
writer. DZSlides is a lightweight HTML5/javascriptslide show format due to Paul Rouget (http://paulrouget.com/dzslides/).Added a LaTeX
beamer
writer. Beamer is a LaTeX package for creatingslide presentations.New, flexible rules for dividing documents into sections and slides(see the "Structuring the slide show" in the User's Guide). Theseare backward-compatible with the old rules, but they allow slideshows to be organized into sections and subsections containingmultiple slides.
A new
--slide-level
option allows users to override defaultsand select a slide level below the first header level with content.
A new
--self-contained
option produces HTML output that does notdepend on an internet connection or the presence of any externalfiles. Linked images, CSS, and javascript is downloaded (or fetchedlocally) and encoded indata:
URIs. This is useful for making portableHTML slide shows. The --offline
option has been deprecated and is nowtreated as a synonym or --self-contained
.Support for PDF output:
- Removed the old
markdown2pdf
. pandoc
can now create PDFs (assuming you have latex and a set ofappropriate packages installed): just specify an output file with the.pdf
extension.- A new option
--latex-engine
allows you to specifypdflatex
,xelatex
, orlualatex
as the processor.
- Removed the old
Highlighting changes:
- Syntax highlighting is now a standard feature; the
highlighting
flag is no longer needed when compiling. - A new
--no-highlight
option allows highlighting to be disabled. - Highlighting now works in
docx
,latex
, andepub
, as well ashtml
,html5
,dzslides
,s5
, andslidy
. - A new
--highlight-style
option selects between various highlightingcolor themes.
- Syntax highlighting is now a standard feature; the
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:
- Internal and external links now work in EPUB.
- Raw HTML is allowed.
- New
--epub-embed-font
option. - Customizable templates for EPUB pages offer more control overformatting:
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'smarkdown. You can now write
```rubyx = 2```
instead of
~~~ {.ruby}x = 2~~~~
Easier scripting: a new
toJsonFilter
function makes it easier towrite Haskell scripts to manipulate the Pandoc AST.See Scripting with pandoc.
Behavior changes
Fixed parsing of consecutive lists in markdown.Pandoc previously behaved like Markdown.pl for consecutivelists of different styles. Thus, the following would be parsedas a single ordered list, rather than an ordered list followedby an unordered list:
1. one2. two- one- two
This change makes pandoc behave more sensibly, parsing this astwo lists. Any change in list type (ordered/unordered) or inlist number style will trigger a new list. Thus, the followingwill also be parsed as two lists:
1. one2. twoa. oneb. two
Since we regard this as a bug in Markdown.pl, and not somethinganyone would ever rely on, we do not preserve the old behavioreven 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 documentslook 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 restoredusing the new
--atx-headers
option.Links are now allowed in markdown image captions. They are alsoallowed 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 markdowndocument, but now pandoc will be able to distinguish block frominline 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 moreaccurate, robust, and extensible. However, there are two importantchanges in how it treats unknown LaTeX. (1) Previously, unknownenvironments became BlockQuote elements; now, they are treatedas "transparent", so
\begin{unknown}xyz\end{unknown}
is thesame asxyz
. (2) Previously, arguments of unknown commandswere passed through with their braces; now the braces are strippedoff.--smart
is no longer selected automatically withman
output.The deprecated
--xetex
option has been removed.The
--html5
/-5
option has been deprecated. Use-t html5
instead.html5
andhtml5+lhs
are now separate output formats.Single quotes are no longer escaped in HTML output. They do notneed to be escaped outside of attributes.
Pandoc will no longer transform leading newlines in codeblocks to
<br/>
tags.The ODT writer now sizes images appropriately, using the imagesize and DPI information embedded in the image.
--standalone
is once again implicitly for a non-text output format(ODT, EPUB). You can again dopandoc 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 classessection
andlevel[1,2,..6]
are put on thediv
tags so they can be styled.In HTML 5 output with--section-divs
, the classeslevel[1,2,...6]
are put onsection
tags.EPUB writer changes:
- The
lang
variable now sets the languagein the metadata (if it is not set, we default to the locale). - EPUB: UTF-8 is used rather than decimal entities.
- The
Added
titleslide
class to title slide in S5 template.In HTML, EPUB, and docx metadata, the date is normalized intoYYYY-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 attributesyou specified in the delimited code block. Previously these were strippedoff.
The reference backlink in the HTML writer no longer has a special
footnoteBacklink
class.The HTML template has been split into
html
andhtml5
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<>
.
Bug fixes
Better support for combining characters and East Asian wide charactersin markdown and reST.
Better handling of single quotes with
--smart
.PreviouslyD'oh l'*aide*
would be parsed with left and right singlequotes instead of apostrophes. This kind of error is now fixed.Highlighting: Use
reads
instead ofread
for better error handling.Fixes crash onstartNum="abc"
.Added blank comment after directives in rst template.
Unescape entities in citation
refId
. TherefId
s comingfrom citeproc contain XML numeric entities, and these don't match with thecitation keys parsed by pandoc. Solution is to unescape them.HTML reader: Fixed bug parsing tables with both thead and tbody.
Markdown reader:
- Better handling of escapes in link URLs and titles.
- Fixed backslash escapes in reference links.
- Fixed bug in table/hrule parsing, by checking that the topline of a table is not followed by a blank line. This bug causedslowdowns on some files with hrules and tables, as pandoc tried tointerpret the hrules as the tops of multiline tables.
- Fixed bug in code block attribute parser. Previously the ID attributegot lost if it didn't come first. Now attributes can come in any order.
RST reader: allow footnotes followed by newline without space characters.
LaTeX reader:
- Ignore empty groups {}, { }.
- LaTeX reader: Handle
\@
. - LaTeX reader: Don't crash on commands like
\itemsep
. - LaTeX reader: Better handling of letter environments.
RST writer: Fixed bug involving empty table cells. isSimple was beingcalculated in a way that assumed there were no non-empty cells.
ConTeXt writer:
- Made
--toc
work even without--number-sections
. - Escape # in link URLs.
- Use buffering for footnotes containing code blocks.
- Changed 'descr' to 'description', fixed alignment.
- Made
LaTeX writer:
- Escape euro character.
- Don't escape
~
inside\href{...}
. - Escape
#
in href URLs. - Improved detection of book classes. We now check the
documentclass
variable, and if that is not set, we look throughthe template itself. Also, we have added the KOMA classes scrreprtand scrbook. You can now make a book usingpandoc -V documentclass:book mybook.txt -o mybook.pdf
- LHS files now set the "listings" variable, so that the definitionof the
code
environment will be included in the template. - Links are colored blue by default (this can be changed bymodifying
hyperref
settings in the template). - Added
lang
variable to LaTeX template.
HTML writer:
- Fixed bug in HTML template with html5 and mathml.
- Don't use self-closing img, br, hr tags for HTML5.
- Use
<section>
for footnotes if HTML5. - Update HTML templates to use Content-Style-Type meta tag.
- Use separate variables for meta-date, meta-author.This makes footnotes work in author and date fields.
- Use 'vertical-align:middle' in WebTeX math for better alignment.
S5/slidy writer: Make footnotes appear on separate slide at end.
MIME: Added 'layout-cache' to getMimeType. This ensures that theMETA-INF/manifest.xml for ODT files will have everything it needs, sothat ODT files modified by LibreOffice can be used as
--reference-odt
.Text.Pandoc.Templates
: Return empty string for json template.Text.Pandoc.Biblio
:- Expand citations recursively inside nested inlines.
- Treat
\160
as space when parsing locator and suffix.This fixes a bug with "p. 33" when--smart
is used. Previouslythe whole "p. 33" would be included in the suffix, with no locator. - Put whole author-in-text citation in a Cite. Previously just thedate and other info went in the Cite.
- Don't add comma+space to prefix if it ends in punctuation.
Updated chicago-author-date.csl. The old version did not workproperly for edited volumes with no author.
EPUB writer:
- Add date to EPUB titlepage and metadata.
- Added TOC identifier in EPUB page template.
- Don't generate superfluous file
cover-image.jpg
.
Under the hood improvements
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 generater to use cabal-dev.
Setup: Making man pages now works with cabal-dev (at least on OSX). InSetup.hs we now invoke 'runghc' in a way that points it to the correctpackage databases, instead of always falling back to the default userpackage 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.
API changes
Removed
Apostrophe
,EmDash
,EnDash
, andEllipses
from the nativeInline
type in pandoc-types. Now we useStr
elements with unicode.Improvements to
Text.Pandoc.Builder
:Inlines
andBlocks
are now newtypes (not synonyms forsequences).- Instances are defined for
IsString
,Show
,Read
,Monoid
,and a newListable
class, which allows these to be manipulatedto some extent like lists. Monoid append includes automaticnormalization. +++
has been replaced by<>
(mappend).
Use blaze-html instead of xhtml for HTML generation.This changes the type of
writeHtml
.Text.Pandoc.Shared
:- Added
warn
anderr
. - Removed
unescapeURI
, modifiedescapeURI
.(See under [behavior changes], above.)
- Added
Changes in URI escaping: Previously the readers escaped URIs byconverting unicode characters to octets and then percent encoding.Now unicode characters are left as they are, and
escapeURI
onlypercent-encodes space characters. This gives more readableURIs, and works well with modern user agents. URIs are no longer unescapedat all on conversion tomarkdown
,asciidoc
,rst
,org
.New module
Text.Pandoc.SelfContained
.New module
Text.Pandoc.Docx
.New module
Text.Pandoc.PDF
.Added
writerBeamer
toWriterOptions
.Added
normalizeDate
toText.Pandoc.Shared
.Added
splitStringWithIndices
inText.Pandoc.Shared
.This is likesplitWithIndices
, but it is sensitive to distinctionsbetween wide, combining, and regular characters.Text.Pandoc.Pretty
:- Added
chomp
combinator. - Added
beforeNonBreak
combinator. This allows you to includesomething conditionally on it being before a nonblank.Used for RST inline math. - Added
charWidth
function. All characters marked W or F in the unicodespec EastAsianWidth.txt get width 2. - Added
realLength
, based oncharWidth
.realLength
is nowused in calculating offsets.
- Added
New module
Text.Pandoc.Slides
, for common functions for breakinga document into slides.Removed
Text.Pandoc.S5
, which is no longer needed.Removed
Text.Pandoc.CharacterReferences
. MovedcharacterReference
toText.Pandoc.Parsing
.decodeCharacterReferences
is replaced byfromEntities
inText.Pandoc.XML
.Added
Text.Pandoc.ImageSize
. This is intened for useindocx
andodt
writers, so the size and dpi of imagescan be calculated.Removed
writerAscii
inWriterOptions
.Added
writerHighlight
toWriterOptions
.Added
DZSlides
toHTMLSlideVariant
.writeEPUB
has a new argument for font files to embed.Added
stateLastStrPos
toParserState
. This lets us keep trackof whether we're parsing the position immediately after a regular(non-space, non-symbol) string, which is useful for distinguishingapostrophes from single quote starts.Text.Pandoc.Parsing
:escaped
now returns aChar
.- Removed
charsInBalanced'
, added a character parser asa parameter ofcharsInBalanced
. This is needed forproper handling of escapes, etc. - Added
withRaw
.
Added
toEntities
toText.Pandoc.XML
.Text.Pandoc.Readers.LaTeX
:- Export
handleIncludes
. - Export
rawLaTeXBlock
instead ofrawLaTeXEnvironment'
.
- Export
Added
ToJsonFilter
class andtoJsonFilter
function toText.Pandoc
, deprecating the oldjsonFilter
function.Text.Pandoc.Highlighting
:- Removed
highlightHtml
,defaultHighlightingCss
. - Export
formatLaTeXInline
,formatLaTeXBlock
, andhighlight
, pluskey functions from highlighting-kate. - Changed types of highlighting function.
highlight
returns aMaybe
, not anEither
.
- Removed
pandoc 1.8.2.1 (2011-08-01)
Adjusted Arbitrary instance to help avoid timeouts in tests.
Added
Tests.Writers.Markdown
to cabal file.Relaxed version bounds on pandoc-types, test-framework.
pandoc 1.8.2 (2011-07-30)
Added script to produce OS X package.
Made
templates
directory a git submodule. This should make iteasier for people to revise their custom templates when the defaulttemplates change.Changed template naming scheme:
FORMAT.template
->default.FORMAT
.Note: If you have existing templates in~/.pandoc/templates
, youmust rename them to conform to the new scheme!Default template improvements:
- HTML: Display author and date after title.
- HTML: Made table of contents more customizable. The containerfor the TOC is now in the template, so users can insert a headeror other styling. (Thanks to Bruce D'Arcus for the suggestion.)
- HTML, Slidy, S5: Enclose scripts in CDATA tags.
- Slidy, S5: Added
s5-url
andslidy-url
variables, instead ofhard-coding. If you want to put your slidy files in the slidysubdirectory, for example, you can dopandoc -t slidy -V slidy-url=slidy -s
. - LaTeX: Use
\and
to separate authors in LaTeX documents (reader& writer). Closes #279. - LaTeX: Set
\emergencystretch
to prevent overfull lines. - LaTeX: Use different
hyperref
options forxetex
, fixingproblems with unicode bookmarks (thanks to CircleCode). - LaTeX: Removed
ucs
package, useutf8
rather thanutf8x
withinputenc
. This covers fewer characters but is morerobust with other packages, anducs
is unmaintained. Userswho need better unicode support should use xelatex or lualatex.
If a template specified with
--template
is not found, look for itindatadir
. Also, if no extension is provided, supply one basedon the writer. So now you can put yourspecial.latex
template in~/.pandoc/templates
, and use it from any directory viapandoc -t latex --template special
.Added
nonspaceChar
toText.Pandoc.Parsing
.Fixed smart quotes bug, now handling
'...hi'
properly.RST reader:
- Partial support for labeled footnotes.
- Improved accuracy of
simpleReferenceName
parser.
HTML reader:
- Substitute correct unicode characters forcharacters in the 128..159 range, which are often found even inHTML that purports to be UTF-8.
LaTeX reader: Handle
\subtitle
command (a subtitle is addedto the title, after a colon and linebreak). Closes #280.Leaner
reference.odt
.Added unexported module
Text.Pandoc.MIME
for use inthe ODT writer.ODT writer: Construct
manifest.xml
based on archive contents.This fixes a bug in ODTs containing images. Recent versions ofLibreOffice would reject these as corrupt, becausemanifest.xml
did not contain a reference to the image files.LaTeX writer:
- Make verbatim environments flush to avoid spuriousblank lines. Closes #277.
- Use
\texttt
and escapes insntead of\verb!...!
, whichis too fragile (doesn't work in command arguments). - Use
\enquote{}
for quotes if the template includesthecsquotes
package. This provides better support forlocal quoting styles. (Thanks to Andreas Wagner for the idea.)
ConTeXt writer: Make
\starttyping
/\stoptyping
flush withmargin, preventing spurious blank lines.Slidy writer:
- Use non-minimized version of
slidy.css
with--offline
option, so users can more easily edit it. - Also fixed a bug in the CSS that prevented proper centeringof title (now reported and fixed upstream).
- Use non-minimized version of
S5 writer:
- Replaced
s5/default/slides.js.{comment,packed}
withnew compresseds5/default/slides.min.js
. - Use
data:
protocol to embed S5 CSS in<link>
tags,when--offline
is specified. Using inline CSS didn'twork with Chrome or Safari. This fixes offlineS5 on those browsers.
- Replaced
HTML writer: Removed English title on footnote backlinks.This is incongrous in non-English documents.
Docbook writer:
- Use CALS tables. (Some older docbook software does not workwell with XHTML tables.) Closes #77.
- Use
programlisting
tags (instead ofscreen
) for code blocks.
markdown2pdf
:- Calls latex with
-halt-on-error -interaction nonstopmode
insteadof-interaction=batchmode
, which essentially just ignored errors,leading to bad results. Better to know when something is wrong. - Fixed issues with non-UTF-8 output of
pdflatex
. - Better error reporting.
- Calls latex with
--mathjax
now takes an optional URL argument. If it is notprovided, pandoc links directly to the (secure) mathjax CDN,as now recommended (thanks to dsanson).Deprecated
--xetex
option inpandoc
. It is no longer needed,since the LaTeX writer now produces a file that can be processed bylatex
,pdflatex
,lualatex
, orxelatex
.Introduced
--luatex
option tomarkdown2pdf
. This causeslualatex
to be used to create the PDF.
pandoc 1.8.1.2 (2011-07-16)
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 fullimplementation of reST. That can come later. For now we need toprevent 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 ofthe 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 aperiod. The parser is smart enough to recognize balanced parentheses, asoften occur in wikipedia links:http://foo.bar/baz_(bam)
.Markdown+lhs reader: Require space after inverse bird tracks, so thatHTML 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:
- Fixed bug in in field lists with multi-line items at theend of the list.
- Added parentheses to RST
specialChars
, so(http://google.com)
will be parsed as a link in parens.Resolves Issue #291. - Allow
|
followed by newline in RST line block.
LaTeX reader:
- Support
\dots
. - Gobble option & space after linebreak
\\[10pt]
.
- Support
Textile reader:
- Make it possible to have colons after links. (qerub)
- Make it possible to have colons after links. (Christoffer Sawicki)
HTML reader:
- Skip spaces after
<b>
,<emph>
, etc. - Handle tbody, thead in simple tables. Closes #274.
- Implicit
Para
s instead ofPlains
in some contexts.
- Skip spaces after
OpenDocument writer: Use special
First paragraph
style forfirst paragraph after most non-paragraph blocks. This allows users tospecify e.g. that only paragraphs after the first paragraph of a block areto 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 theOPF 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.
- More space between lines, top-align cells.
- Use ctable package, which allows footnotes andprovides additional options.
- Made cell alignments work in multiline tables.
- Closes #271, #272.
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:
- Updated to use Slidy2.
- Fixed bug, unclosed div tag.
- Added
duration
variable in template.Setting this activates the timer. - Use 'titlepage' instead of 'cover' for title div.
pandoc 1.8.1.1 (2011-02-13)
markdown2pdf
: Removed some debugging lines accidentally includedin the 1.8.1 release. With those lines, the temp directory is createdin the working directory, and it is not deleted. This fix restoresthe original behavior.
pandoc 1.8.1 (2011-02-13)
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 contentsat the beginning of each chapter.LaTeX writer: Change figure defaults to
htbp
.This prevents "too many unprocessed floats." ResolvesIssue #285.Text.Pandoc.UTF8
: Encode filenames even when using recentbase.markdown2pdf
: Fixed filename encoding issues. With help from PauloTanimoto. Resolves Issue #286.HTML writer: Put line breaks in section divs.
Text.Pandoc.Shared
: MakewriterSectionDivs
default to False.
pandoc 1.8.0.3 (2011-02-05)
- Fixed Source-repository stanza in cabal file.
pandoc 1.8.0.2 (2011-02-05)
HTML writer:
- Stringify alt text instead of converting to HTML.
- Break lines after block elements, not inside tags.HTML output now closely resembles that of tidy. Resolves Issue #134.
Markdown reader: Fixed bug in footnote block parser (pointed outby Jesse Rosenthal). The problem arose when the blank lineat 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-Spaceelements. So, we never have [Space], or [, ..., Space].
Tests:
- Improved Arbitrary instance.
- Added timeout for test instances.
README:
- Added section on four-space rule for lists. Resolves Issue #283.
- Clarified optional arguments on math options.
markdown2pdf: Fixed bug with output file extensions.Previously
markdown2pdf test.txt -o test.en.pdf
would producetest.pdf
, nottest.en.pdf
. Thanks to Paolo Tanimoto for the fix.
pandoc 1.8.0.1 (2011-01-31)
Revised Interact.hs so that it works with the CPP macrosin the UTF8 module.
Revised Setup.hs so that we don't call MakeManPage.hs unlessthe man pages are out of date.
pandoc 1.8 (2011-01-30)
New features
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
, specifyinga citation style using--csl
and a bibliography using--bibliography
,the citation will be replaced by an appropriately formattedcitation, and a list of works cited will be added to the endof the document.This means that you can switch effortlessly between different citationand bibliography styles, including footnote, numerical, and author-dateformats. 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 specialsyntax, 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 contributingthetextile
reader, an almost complete implementation of the textilesyntax 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 JSONrepresentation of the native Pandoc AST. These are much fasterthan thenative
reader and writer, and should be used forserializing Pandoc to text. To convert between the JSON representationand native Pandoc, useencodeJSON
anddecodeJSON
fromText.JSON.Generic
.A new
jsonFilter
function inText.Pandoc
makes it easyto write scripts that transform a JSON-encoded pandoc document.For example:-- removelinks.hs - removes links from documentimport Text.Pandocmain = interact $ jsonFilter $ bottomUp removeLink where removeLink (Link xs _) = Emph xs removeLink x = x
To use this to remove links while translating markdown to LaTeX:
pandoc -t json | runghc removelinks.hs | pandoc -f json -t latex
Attributes 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 likeCodeBlock
. Inline code will be highlighted in HTML output, if pandocis compiled with highlighting support. Resolves Issue #119.New
RawBlock
andRawInline
elements (replacingRawHtml
,HtmlInline
, andTeX
) provide lots of flexibility in writingscripts to transform Pandoc documents. Scripts can now changehow each element is rendered in each output format.You can now define LaTeX macros in markdown documents, and pandocwill 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, theywill work in every output format, not just LaTeX.LaTeX macros can also be used in LaTeX documents (both in mathand in non-math contexts).
A new
--mathjax
option has been added for displayingmath 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 inthe note; footnotes are put in an auto-numbered ordered list.)Resolves Issue #258.
A new
--normalize
option causes pandoc to normalize the ASTbefore 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 headersin DocBook, LaTeX, and ConTeXt to start with "chapter" (level one).Resolves Issue #265.In DocBook output,
<chapter>
is now used for top-levelheaders if the template contains<book>
. Resolves Issue #265.A new
--listings
option inpandoc
andmarkdown2pdf
causesthe LaTeX writer to use the listings package for code blocks.(Thanks to Josef Svennigsson for the pandoc patch, and EtienneMillon 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 wrappedmore evenly and duplicate blank lines avoided.
New
--columns
command-line option sets the column width forline wrapping and relative width calculations for tables.Made
--smart
work in HTML, RST, and Textile readers, as wellas 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.
API and program changes
Moved
Text.Pandoc.Definition
from thepandoc
package to a newauxiliary package,pandoc-types
. This will make it possible for otherprograms to supply output in Pandoc format, without depending on the wholepandoc package.Added
Attr
field toCode
.Removed
RawHtml
,HtmlInline
, andTeX
elements; added genericRawBlock
andRawInline
.Moved generic functions to
Text.Pandoc.Generic
. DeprecatedprocessWith
, replacing it with two functions,bottomUp
andtopDown
.Removed previously deprecated functionsprocessPandoc
andqueryPandoc
.Added
Text.Pandoc.Builder
, for buildingPandoc
structures.Text.Pandoc
now exports association listsreaders
andwriters
.Added
Text.Pandoc.Readers.Native
, which exportsreadNative
.readNative
can now read full pandoc documents, block lists, blocks,inline lists, or inlines. It will interpretStr "hi"
as if it werePandoc (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 formatfrom 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 someWindows pathnames beginning withC:/
as URIs.The
--sanitize-html
option and thestateSanitize
field inParserState
have been removed. Sanitization is better done in theresulting HTML usingxss-sanitize
, which is based on pandoc'ssanitization, but improved.pandoc now adds a newline to the end of its output in fragmentmode (= not
--standalone
).Added support for
lang
inhtml
tag in the HTML template,so you can dopandoc -s -V lang=es
, for example.highlightHtml
inText.Pandoc.Highlighting
now takesa boolean argument that selects between "inline" and"block" HTML.Text.Pandoc.Writers.RTF
now exportsrtfEmbedImage
.Images are embedded in RTF output when possible (png, jpeg).Resolves Issue #275.Added
Text.Pandoc.Pretty
. This is better suited for pandoc than thepretty
package. Changed all writers that usedText.PrettyPrint.HughesPJ
to useText.Pandoc.Pretty
instead.Rewrote
writeNative
using the new prettyprinting module. It isnow much faster. The output has been made more consistent and compressed.writeNative
is also now sensitive to writerStandalone, and will simply
print a block list if writerStandalone` is False.Removed
Text.Pandoc.Blocks
.Text.Pandoc.Pretty
allows you to defineblocks and concatenate them, so a separate module is no longer needed.Text.Pandoc.Shared
:- Added
writerColumns
,writerChapters
, andwriterHtml5
toWriterOptions
. - Added
normalize
. - Removed unneeded prettyprinting functions:
wrapped
,wrapIfNeeded
,wrappedTeX
,wrapTeXIfNeeded
,hang'
,BlockWrapper
,wrappedBlocksToDoc
. - Made
splitBy
take a test instead of an element. - Added
findDataFile
, refactoredreadDataFile
. - Added
stringify
. RewroteinlineListToIdentifier
usingstringify
. - Fixed
inlineListToIdentifier
to treat\160
as ' '.
- Added
Text.Pandoc.Readers.HTML
:- Removed
rawHtmlBlock
,anyHtmlBlockTag
,anyHtmlInlineTag
,anyHtmlTag
,anyHtmlEndTag
,htmlEndTag
,extractTagType
,htmlBlockElement
,htmlComment
- Added
htmlTag
,htmlInBalanced
,isInlineTag
,isBlockTag
,isTextTag
- Removed
Moved
smartPunctuation
fromText.Pandoc.Readers.Markdown
toText.Pandoc.Readers.Parsing
, and parameterized it withan inline parser.Ellipses are no longer allowed to contain spaces.Previously we allowed '. . .', ' . . . ', etc. This causedtoo many complications, and removed author's flexibility incombining ellipses with spaces and periods.
Allow linebreaks in URLs (treat as spaces). Also, a string ofconsecutive spaces or tabs is now parsed as a single space. If you havemultiple spaces in your URL, use
%20%20
.Text.Pandoc.Parsing
:- Removed
refsMatch
. - Hid
Key
constructor. - Removed custom
Ord
andEq
instances forKey
. - Added
toKey
andfromKey
to convert betweenKey
and[Inline]
. - Generalized type on
readWith
.
- Removed
Small change in calculation of relative widths of table columns.If the size of the header > the specified column width, usethe header size as 100% for purposes of calculatingrelative widths of columns.
Markdown writer now uses some pandoc-specific features when
--strict
is not specified:\
newline is used for a hard linebreak instead oftwo spaces then a newline. And delimited code blocks are used whenthere are attributes.HTML writer: improved gladTeX output by setting ENV appropriatelyfor 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 usingmarkdown2pdf
:markdown2pdf -V fontsize=12pt input.txt
.Fixed problem with strikeout in LaTeX headers when usinghyperref, by adding a command to the default LaTeX templatethat disables
\sout
inside pdf strings. Thanks to Joost Kremersfor the fix.The
COLUMNS
environment variable no longer has any effect.
Under-the-hood improvements
Pandoc now compiles with GHC 7. (This alone leads to asignificant performance improvement, 15-20%.)
Completely rewrote HTML reader using tagsoup as a lexer. Thenew reader is faster and more accurate. Unlike theold 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.Parsingfor a significant performance boost.Improved performance of all readers by rewriting parsers.
Simplified Text.Pandoc.CharacterReferences by usingentity lookup functions from TagSoup.
Text.Pandoc.UTF8
now uses the unicode-aware IO functionsfromSystem.IO
if base >= 4.2. This gives support forwindows line endings on windows.Remove duplications in documentation by generating thepandoc 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 markdownsyntax by doingman pandoc_markdown
.Completely revised test framework (with help from Nathan Gass).The new test framework is built when the
tests
Cabal flag is set. Itincludes the old integration tests, but also some new unit and quickchecktests. Test output has been much improved, and you can now specify a globpattern aftercabal test
to indicate which tests should be run;for examplecabal test citations
will run all the citation tests.Added a shell script,
stripansi.sh
, for filtering ANSI controlsequences from test output:cabal test | ./stripansi.sh > test.log
.Added
Interact.hs
to make it easier to use ghci while developing.Interact.hs
loadsghci
from thesrc
directory, specifyingall the options needed to load pandoc modules (includingspecific package dependencies, which it gets by parsingdist/setup-config).Added
Benchmark.hs
, testing all readers + writers using criterion.Added
stats.sh
, to make it easier to collect and archivebenchmark and lines-of-code stats.Added upper bounds to all cabal dependencies.
Include man pages in extra-source-files. This allows users toinstall pandoc from the tarball without needing to build the manpages.
Bug fixes
Filenames are encoded as UTF8. Resolves Issue #252.
Handle curly quotes better in
--smart
mode. Previously, curly quoteswere just parsed literally, leading to problems in some output formats.Now they are parsed asQuoted
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:
- Allow HTML comments as inline elements in markdown.So,
aaa <!-- comment --> bbb
can be a single paragraph. - Fixed superscripts with links:
^[link](/foo)^
getsrecognized as a superscripted link, not an inline note followed bygarbage. - Fixed regression, making markdown reference keys case-insensitive again.Resolves Issue #272.
- Properly handle abbreviations (like
Mr.
) at the end of a line. - Better handling of intraword underscores, avoiding exponentialslowdowns in some cases. Resolves Issue #182.
- Fixed bug in alignments in tables with blank rows in the header.
- Allow HTML comments as inline elements in markdown.So,
RST reader:
- Field lists now allow spaces in field names, andblock content in field values. (Thanks to Lachlan Musicmanfor pointing out the bug.)
- Definition list items are now always
Para
instead ofPlain
, matching behavior ofrst2xml.py
. - In image blocks, the description is parsed properly andused for the alt attribute, not also the title.
- Skip blank lines at beginning of file. ResolvesDebian #611328.
LaTeX reader:
- Improved parsing of preamble.Previously you'd get unexpected behavior on a document thatcontained
\begin{document}
in, say, a verbatim block. - Allow spaces between
\begin
or\end
and{
. - Support
\L
and\l
. - Skip comments inside paragraphs.
- Improved parsing of preamble.Previously you'd get unexpected behavior on a document thatcontained
LaTeX writer:
- Escape strings in
\href{..}
. - In nonsimple tables, put cells in
\parbox
.
- Escape strings in
OpenDocument writer: don't print raw TeX.
Markdown writer:
- Fixed bug in
Image
. URI was getting unescaped twice! - Avoid printing extra blank lines at the end if there areno notes or references.
- Fixed bug in
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.
pandoc 1.6 (2010-07-24)
New EPUB and HTML Slidy writers. (Issue #122)
- EPUB is a standard ebook format, used in Apple's iBooks forthe iPad and iPhone, Barnes and Noble's nook reader, the Sonyreader, and many other devices, and by online ebook readers likebookworm. (Amazon's Kindle uses a different format, MobiPocket,but EPUB books can easily be converted to Kindle format.) Now youcan write your book in markdown and produce an ebook with a singlecommand! I've put up a short tutorial here.
- Slidy, like S5, is a system for producing HTML+javascript slide shows.
All input is assumed to be UTF-8, no matter what the locale and ghcversion, 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 containarbitrary block elements. (Issue #43)
Sequentially numbered example lists in markdown with
@
marker.Markdown table captions can begin with a bare colon and no longer needto include the English word "table." Also, a caption can now occureither before or after the table. (Issue #227)
New command-line options:
--epub-stylesheet
allows you to specify a CSS file that willbe used to style your ebook.--epub-metadata
allows you to specify metadata for the ebook.--offline
causes the generated HTML slideshow to include allneeded scripts and stylesheets.--webtex
causes TeX math to be converted to images using theGoogle Charts API (unless a different URL is specified).--section-divs
causes div tags to be added around each sectionin an HTML document. (Issue #230, 239)
Default behavior of S5 writer in standalone mode has changed:previously, it would include all needed scripts and stylesheetsin the generated HTML; now, only links are included unlessthe
--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 thediv 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 directlyon the header tags, and not to include the divs. The
--section-divs
option selects the 1.2-1.5 behavior.API changes:
HTMLMathMethod
: AddedWebTeX
, removedMimeTeX
.WriterOptions
: AddedwriterUserDataDir
,writerSourceDirectory
,writerEPUBMetadata
fields. RemovedwriterIncludeBefore
,writerIncludeAfter
.- Added
headerShift
toText.Pandoc.Shared
. - Moved parsing code and
ParserState
fromText.Pandoc.Shared
to a new module,Text.Pandoc.Parsing
. - Added
stateHasChapters
toParserState
. - Added
HTMLSlideVariant
. - Made
KeyTable
a map instead of an association list. - Added accessors for
Meta
fields (docTitle
,docAuthors
,docDate
). Pandoc
,Meta
,Inline
, andBlock
have been givenOrd
instances.- Reference keys now have a type of their own (
Key
), with itsownOrd
instance for case-insensitive comparison. - Added
Text.Pandoc.Writers.EPUB
. - Added
Text.Pandoc.UUID
. - Removed
Text.Pandoc.ODT
, addedText.Pandoc.Writers.ODT
.RemovedsaveOpenDocumentAsODT
, addedwriteODT
. - Added
Text.Pandoc.Writers.Native
andwriteNative
.RemovedprettyPandoc
. - Added
Text.Pandoc.UTF8
for portable UTF8 string IO. - Removed
Text.Pandoc.Writers.S5
and thewriteS5
function.Moveds5Includes
to a new module,Text.Pandoc.S5
.To write S5, you now usewriteHtml
withwriterSlideVariant
set toS5Slides
orSlidySlides
.
Template changes. If you use custom templates, please update them,particularly if you use syntax highlighting with pandoc. The old HTMLtemplates hardcoded highlighting CSS that will no longer work withthe most recent version of highlighting-kate.
- HTML template: avoid empty meta tag if no date.
- HTML template: Use default highlighting CSS from highlighting-kateinstead of hard-coding the CSS into the template.
- HTML template: insert-before text goes before the title, andimmediately after the
<body>
tag, as documented. (Issue #241) - Added slidy and s5 templates.
- Added amssymb to preamble of latex template. (github Issue 1)
Removed excess newlines at the end of output. Note: because outputwill not contain an extra newline, you may need to make adjustmentsif you are inserting pandoc's output into a template.
In S5 and slidy, horizontal rules now cause a new slide, so youare 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 withouthighlighting 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 withtheir alt text rather than a broken link.
LaTeX reader improvements:
- Made latex
\section
,\chapter
parsers more forgiving of whitespace. - Parse
\chapter{}
in latex. - Changed
rawLaTeXInline
to accept\section
,\begin
, etc. - Use new
rawLaTeXInline'
in LaTeX reader, and exportrawLaTeXInline
for use in markdown reader. - Fixes bug wherein
\section{foo}
was not recognized as raw TeXin markdown document.
- Made latex
LaTeX writer: images are automatically shrunk if they would extendbeyond 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 formulacannot be converted, it is left in raw TeX; formulas are no longerpartially converted.Unicode curly quotes are left alone when parsing smart quotes. (Issue #143)
Cabal file changes:
- Removed parsec < 3 restriction.
- Added 'threaded' flag for architectures where GHC lacks a threadedruntime.
- Use 'threaded' only for markdown2pdf; it is not needed for pandoc.
- Require highlighting-kate 0.2.7.
Use explicit imports from
Data.Generics
. Otherwise we have aconflict with the 'empty' symbol, introduced in syb >= 0.2. (Issue #237)New data files: slidy/slidy.min.js, slidy/slidy.min.css, epub.css.
pandoc 1.5.1.1 (2010-03-29)
- Fixed header identifiers (uniqueIdent in Shared) so theywork as advertized in README and are guaranteed to bevalid XHTML names. Thanks to Xyne for reporting the bug.
pandoc 1.5.1 (2010-03-23)
- Fixed treatment of unicode characters in URIs.
- Revised Setup.hs so it works with debian's build process.
- Fixed bug in OpenDocument writer that led to invalidXML for some input.
pandoc 1.5.0.1 (2010-03-21)
- HTML writer: Fixed error in math writer (with MathML option)that caused an infinite loop for unparsable MathML.
pandoc 1.5 (2010-03-20)
- Moved repository to github.
- New
--mathml
option, for display of TeX math as MathML. - New
--data-dir
option, allowing users to specify a datadirectory other than~/.pandoc
. Files placed in this directorywill be used instead of system defaults. - New
--base-header-level
option. For example,--base-header-level=2
changes level 1 headers to level 2, level 2 to level 3, etc. - New 'plain' output format: plain text without pictures, hyperlinks,inline formatting, or anything else that looks even vaguelymarkupish.
- Titles and authors in title blocks can now span multiple lines,as long as the continuation lines begin with a space character.
- When given an absolute URI as a parameter, pandoc will fetchthe content via HTTP.
- The HTML reader has been made much more forgiving. It nolonger requires well-formed xhtml as input.
html2markdown
has been removed; it is no longer necessary, giventhe last two changes.pandoc
can be used by itself to convertweb pages to markdown or other formats.hsmarkdown
has also been removed. Usepandoc --strict
instead.Or symlink pandoc's executable tohsmarkdown
;pandoc
will thenbehave likehsmarkdown
used to.- An image in a paragraph by itself is now rendered as a figurein most writers, with the alt text as the caption.
- Incomplete support for reST tables (simple and grid). Thanks toEric Kow. Colspans and rowspans not yet supported.
- In mediawiki, links with relative URLs are now formatted as wikilinks.Also, headers have been promoted:
= head =
is now level 1 instead oflevel 2. - The markdown reader now handles "inverse bird tracks" when parsingliterate haskell. These are used for haskell example code thatis not part of the literate program.
- The
-B
and-A
options now imply-s
and no longer work infragment mode. - Headerless tables are now printed properly in all writers.In addition, tbody, thead, and cols are used in HTML and Docbooktables.
- Improved build system; removed obsolete Makefile.
- In LaTeX writer,
\chapter
is now used instead of\section
.when the documentclass is book, report, or memoir. - Many small bug fixes. See [changelog] for details.
pandoc 1.4 (2010-01-02)
- New template system replaces old headers, giving users muchmore control over pandoc's output in
--standalone
mode.Added--template
and--variable
options. The--print-default-header
option is now--print-default-template
. See README under"Templates" for details. - The old
--custom-header
option should still work, but it hasbeen deprecated. - New
--reference-odt
option allows users to customize stylesin ODT output. - Users may now put custom templates, s5 styles, and a referenceODT in the
~/.pandoc
directory, where they will override systemdefaults. See README for details. - Unicode is now used whenever possible in HTML and XML output. Entitiesare used only where necessary (
>
,<
,"
,&
). - Authors and dates may now include formatting and notes.
- Added
--xetex
option forpandoc
andmarkdown2pdf
. - Windows installer now includes highlighting support and
markdown2pdf
andhsmarkdown
wrappers. - Pandoc no longer requires Template Haskell, which should makeit more portable.
- Pandoc can now be built on GHC 6.12, as well as earlier versions.
- See README for other small improvements and bug fixes.
pandoc 1.3 (2009-12-10)
- Added
--id-prefix
option to help prevent duplicateidentifiers when you're generating HTML fragments. - Added
--indented-code-classes
option, which specifiesdefault highlighting syntax for indented code blocks. --number-sections
now affects HTML output.- Improved syntax for markdown definition lists.
- Better looking simple tables.
- Markdown tables without headers are now possible.
- New hard line break syntax: backslash followed by newline.
- Improved performance of markdown reader by ~10% by eliminating theneed for a separate parsing pass for notes.
- Improved syntax highlighting for literate Haskell.
- Support for "..code-block" directive in RST reader.
- Windows binary now includes highlighting support.
- Many bug fixes and small improvements. See [changelog]for details.
pandoc 1.2.1 (2009-07-18)
- Improved the efficiency of the markdown reader'sabbreviation parsing (should give a big performanceboost with
--smart
). - HTML writer now wraps sections in divs with uniqueidentifiers, for easier manipulation.
- Improved LaTeX reader's coverage of math modes.
- Added a portable Haskell version of markdown2pdf (thanksto Paolo Tanimoto).
- Made
--strict
compatible with--standalone
and--toc.
- Many other small improvements and bug fixes.See [changelog] for details.
pandoc 1.2 (2009-03-01)
- Added support for literate Haskell. lhs support is triggered by'+lhs' suffixes in formats. For example, 'latex+lhs' is literateHaskell LaTeX. '.lhs' files are treated by default as literatemarkdown.
- Added
--email-obfuscation
option. - Brought citeproc support up to date for citeproc-hs-0.2.
- Many bugs fixed. See [changelog] for details.
pandoc 1.1 (2008-11-06)
- New
--jsmath
option supporting use of pandoc with [jsMath]. - Classes on HTML table output for better CSS styling.
- Windows installer no longer requires admin privileges.
- Many bugs fixed. See [changelog] for details.
pandoc 1.0 (2008-09-13)
- New writers for MediaWiki, GNU Texinfo (thanks to Peter Wang),OpenDocument XML (thanks to Andrea Rossato), and ODT (OpenOfficedocument).
- New delimited code blocks,with optional syntax highlighting.
- Reorganized build system: pandoc can now be built using standardCabal tools. It can be compiled on Windows without Cygwin.The tests can also be run without perl or unix tools.
- LaTeXMathML replaces ASCIIMathML for rendering math in HTML.
- Support for "displayed" math.
- Common abbreviations are now handled more intelligently, witha non-breaking space (and not a sentence-ending space) afterthe period.
- Code is -Wall clean.
- Many bug fixes and small improvements. See [changelog] forfull details.
pandoc 0.46 (2008-01-08)
- Added a
--sanitize-html
option (and a corresponding parameterinParserState
for those using the pandoc libraries in programs).This option causes pandoc to sanitize HTML (in HTML or Markdowninput) using a whitelist method. Possibly harmful HTML elementsare replaced with HTML comments. This should be useful in thecontext of web applications, where pandoc may be used to convertuser input into HTML. - Made -H, -A, and -B options cumulative: if they are specifiedmultiple times, multiple files will be included.
- Many bug fixes and small improvements. See [changelog] for fulldetails.
pandoc 0.45 (2007-12-09)
- Many bug fixes and structural improvements. See [changelog] forfull details.
- Improved treatment of math. Math is now rendered using unicodeby default in HTML, RTF, and DocBook output. For more accuratedisplay of math in HTML,
--gladtex
,--mimetex
, and--asciimathml
options are provided. See the User's Guide fordetails. - Removed support for box-style block quotes in markdown.
- More idiomatic ConTeXt output.
- Text wrapping in ConTeXt and LaTeX output.
- Pandoc now correctly handles all standard line endings(CR, LF, CRLF).
- New
--no-wrap
option that disables line wrapping and minimizeswhitespace in HTML output. - Build process is now compatible with both GHC 6.8 and GHC 6.6.GHC and GHC_PKG environment variables may be used to specifywhich version of the compiler to use, when multiple versions areinstalled.
pandoc 0.44 (2007-09-03)
[ John MacFarlane ]
Fixed bug in HTML writer: when --toc was used, anchors were put aroundheaders, 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 thexhtml library (>= 3000), and is required for valid XHTML.
[ Recai Oktaş ]
On configure, compile 'Setup.hs' to 'setup' and use 'setup' as the buildcommand instead of 'runhaskell', which, on some platforms (such as s390,alpha, m68k), throws the following error:
runhaskell Setup.hs configure --prefix=/usrghc-6.6.1: not built for interactive use
This causes a serious FTBFS bug. Closes: #440668.
pandoc 0.43 (2007-09-02)
[ John MacFarlane ]
The focus of this release is performance. The markdown parseris about five times faster than in 0.42, based on benchmarkswith the TextMate manual.
Main.hs: Replaced CRFilter and tabFilter with single functiontabFilter, which operates on the whole string rather than breakingit into lines, and handles dos-style line-endings as well as tabs.
Added separate LaTeX reader and native reader tests; removedround-trip tests.
Text.Pandoc.Shared:
- Removed tabsToSpaces and tabsInLine (they were used only in Main.hs.)
- General code cleanup (to elimante warnings when compiling with -Wall.)
- Added 'wrapped' function, which helps wrap text into paragraphs,using the prettyprinting library.
- Rewrote charsInBalanced and charsInBalanced'.
- Documented restriction: open and close must be distinct characters.
- Rearranged options for greater efficiency.
- Bug fix: Changed inner call to charsInBalanced insidecharsInBalanced' to charsInBalanced'.
- anyLine now requires that the line end with a newline (not eof).This is a harmless assumption, since we always add newlines to theend of a block before parsing with anyLine, and it yields a 10% speedboost.
- Removed unnecessary 'try' in anyLine.
- Removed unneeded 'try' from romanNumeral parser.
- Use notFollowedBy instead of notFollowedBy' in charsInBalanced.
- Removed unneeded 'try' in parseFromString.
- Removed unneeded 'try' from stringAnyCase. (Now it behaveslike 'string'.)
- Changed definition of 'enclosed' in Text.Pandoc.Shared so that'try' is not automatically applied to the 'end' parser. Added'try' in calls to 'enclosed' where needed. Slight speed increase.
Writers:
- Replaced individual wrapping routines in RST, Man, and Markdownwriters with 'wrapped' from Text.Pandoc.Shared.
- Rewrote LaTeX writer to use the prettyprinting library,so we get word wrapping, etc.
- Modified latex writer tests for new latex writer using prettyprinter.
- Fixed bug in LaTeX writer: autolinks would not cause
\usepackage{url}
to be put in the document header. Also, changesto state in enumerated list items would be overwritten. - In Markdown writer, escape paragraphs that begin with ordered listmarkers, so they don't get interpreted as ordered lists.
Text.Pandoc.Reades.LaTeX:
- Fixed bug in LaTeX reader, which wrongly assumed that the romannumeral after "enum" in "setcounter" would consist entirely of"i"s. 'enumiv' is legitimate.
- LaTeX command and environment names can't contain numbers.
- Rearranged order of parsers in inline for slight speed improvement.
- Added '`' to special characters and 'unescapedChar'.
Text.Pandoc.Readers.RST:
- Removed unneeded try's in RST reader; also minor code cleanup.
- Removed tabchar.
- Rearranged parsers in inline (doubled speed).
Text.Pandoc.Readers.Markdown:
- Skip notes parsing if running in strict mode. (This yields a nicespeed improvement in strict mode.)
- Simplify autolink parsing code, using Network.URI to test forURIs. Added dependency on network library to debian/control andpandoc.cabal.
- More perspicuous definition of nonindentSpaces.
- Removed unneeded 'try' in 'rawLine'.
- Combined linebreak and whitespace into a new whitespace parser, toavoid unnecessary reparsing of space characters.
- Removed unnecessary 'try' in 'codeBlock', 'ellipses', 'noteMarker','multilineRow', 'dashedLine', 'rawHtmlBlocks'.
- Use lookAhead in parsers for setext headers and definition liststo see if the next line begins appropriately; if not, don't wasteany more time parsing.
- Don't require blank lines after code block. (It's sufficient toend code block with a nonindented line.)
- Changed definition of 'emph': italics with '_' must notbe followed by an alphanumeric character. This is to helpprevent interpretation of e.g.
[LC_TYPE]: my_type
as[LC<em>TYPE]:my</em>type
. - Improved Markdown.pl-compatibility in referenceLink: the two partsof a reference-style link may be separated by one space, but notmore... [a] [link], [not] [a link].
- Fixed markdown inline code parsing so it better accords withMarkdown.pl: the marker for the end of the code section is a clumpof the same number of
's with which the section began, followed by a non-
character. So, for example,h ``` i
-><code>h ``` i</code>
. - Split 'title' into 'linkTitle' and 'referenceTitle', since therules are slightly different.
- Rewrote 'para' for greater efficiency.
- Rewrote link parsers for greater efficiency.
- Removed redundant 'referenceLink' in definition of inline (it'salready in 'link').
- Refactored escapeChar so it doesn't need 'try'.
- Refactored hrule for performance in Markdown reader.
- More intelligent rearranging of 'inline' so that most frequentlyused parsers are tried first.
- Removed tabchar parser, as whitespace handles tabs anyway.
Text.Pandoc.CharacterReferences:
- Refactored.
- Removed unnecessary 'try's for a speed improvement.
- Removed unnecessary '&' and ';' from the entity table.
Build process:
- Makefile: Get VERSION from cabal file, not Main.hs.
- Modified MacPorts Portfile:
- Depend on haddock
- Build and install libraries and library documentation inaddition to pandoc executable
- Added template item for md5 sum in Portfile.in.
- Incorporated changes from MacPorts repository (r28278).
- FreeBSD port: Don't try to generate distinfo in Makefile.It can be made using 'make makesum' in FreeBSD.
- Make both freebsd and macports targets depend on tarball.
Website and documentation:
- Updated INSTALL instructions.
- Added pandocwiki demo to website.
- Removed local references to Portfile, since pandoc is now in theMacPorts repository.
pandoc 0.42 (2007-08-26)
[ John MacFarlane ]
Main.hs: Use utf8 conversion on the extra files loaded withthe -H, -C, -B, and -A options. This fixes problems with unicodecharacters in these files.
Exposed Text.Pandoc.ASCIIMathML, since it is imported inText.Pandoc.Readers.HTML and without it we get a linking error whenusing the library.
Markdown reader:
- Added new rule for enhanced markdown ordered lists: if the listmarker is a capital letter followed by a period (including asingle-letter capital roman numeral), then it must be followed byat least two spaces. The point of this is to avoid accidentallytreating people's initials as list markers: a paragraph might begin,"B. Russell was an English philosopher," and this shouldn't betreated as a list. Documented change in README.
- Blocks that start with "p. " and a digit are no longer treatedas ordered lists (it's a page number).
- Added a needed 'try' to listItem.
- Removed check for a following setext header in endline.A full test is too inefficient (doubles benchmark time), and thesubstitute we had before is not 100% accurate.
- Don't use Code elements for autolinks if --strict specified.
LaTeX writer: When a footnote ends with a Verbatim environment, theclose } 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:
- Removed incorrect "{}" around style information in HTML tables.Column widths now work properly in HTML.
- If --strict option is specified (and --toc is not), don't includeidentifiers in headers, for better Markdown compatibility.
Build process:
- Separated $(web_dest) and website targets.
- In website, index.txt is now constructed from template index.txt.in.
- Added freebsd target to Markefile. This creates the freebsd Makefilefrom Makefile.in, and creates distinfo. Removed Makefile and distinfofrom the repository.
- Added macport target to Makefile. Portfile is built from templatePortfile.in.
- Removed OSX package targets. (Too many difficulties involvingdependencies on dynamic libraries.)
- More complete INSTALL instructions for all architectures.
Website:
- Added a programming demo, pandocwiki.
[ Recai Oktaş ]
- Do not forget to close pandoc's ITP. Closes: #391666
pandoc 0.41 (2007-08-19)
[ John MacFarlane ]
Fixed bugs in HTML reader:
- Skip material at end only if
</html>
is present (previously,only part of the document would be parsed if an error wasfound; now a proper error message is given). - Added new constant eitherBlockOrInline with elements that maycount either as block-level or as inline. Modified isInline andisBlock to take this into account.
- Modified rawHtmlBlock to accept any tag (even an inline tag):this is innocuous, because rawHtmlBlock is tried only if a regularinline element can't be parsed.
- Added a necessary 'try' in definition of 'para'.
- Skip material at end only if
Fixed bug in markdown ordered list parsing. The problem was thatanyOrderedListStart did not check for a space following theordered list marker. So in 'A.B. 2007' the parser would beexpecting 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, blockquotes in indented contexts would be indented only in the firstline.
Added note to INSTALL about variations in versions of the xhtmllibrary that can lead to failed tests (thanks to Leif LeBaron).
pandoc 0.4 (2007-01-16)
[ John MacFarlane ]
Added two new output formats: groff man pages and ConTeXt. Bydefault, output files with extensions ".ctx" and ".context" areassumed to be ConTeXt, and output files with single-digit extensionsare assumed to be man pages.
Enhanced ordered lists (documented in README, under Lists):
- The OrderedList block element now stores information aboutlist number style, list number delimiter, and starting number.
- The readers parse this information when possible.
- The writers use this information to style ordered lists.
- The enhancement can be disabled using the --strict option.
Added support for tables (with a new Table block element). Two kindsof tables are supported: a simple table with one-line rows, and amore complex variety with multiline rows. All output formats aresupported, but only markdown tables are parsed at the moment. Thesyntax is documented in README.
Added support for definition lists (with a new DefinitionList blockelement). All output and input formats are supported. The syntax isdocumented in README.
Added support for superscripts and subscripts (with new Superscriptand Subscript inline elements). All input and outputformats. 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. ResolvesIssue #18.
Added a --toc|--table-of-contents option. This causes an automaticallygenerated table of contents (or an instruction that creates one) tobe inserted at the beginning of the document. Not supported in S5,DocBook, or man page writers.
Modified the -m|--asciimathml option:
- If an optional URL argument is provided, a link is insertedinstead of the contents of the ASCIIMathML.js script.
- Nothing is inserted unless the document actually containsLaTeX math.
Removed Blank block element as unnecessary.
Removed Key and Note blocks from the Pandoc data structure. Alllinks are now stored as explicit links, and note contents arestored with the (inline) notes.
- All link Targets are now explicit (URL, title) pairs; thereis no longer a 'Ref' target.
- Markdown and RST parsers now need to extract data from key andnote blocks and insert them into the relevant inline elements.Other parsers have been simplified, since there is no longer any needto construct separate key and note blocks.
- Markdown, RST, and HTML writers need to construct lists ofnotes; Markdown and RST writers need to construct lists of linkreferences (when the --reference-links option is specified); andthe RST writer needs to construct a list of image substitutionreferences. All writers have been rewritten to use the State monadwhen state is required.
- Several functions (generateReference, keyTable,replaceReferenceLinks, replaceRefLinksBlockList, and some auxiliariesused by them) have been removed from Text.Pandoc.Shared, sincethey are no longer needed. New functions and data structures(Reference, isNoteBlock, isKeyBlock, isLineClump) have beenadded. The functions inTags, selfClosingTag, inTagsSimple, andinTagsIndented have been moved to the DocBook writer, since thatis now the only module that uses them. NoteTable is now exportedin Text.Pandoc.Shared.
- Added stateKeys and stateNotes to ParserState; removed stateKeyBlocks,stateKeysUsed, stateNoteBlocks, stateNoteIdentifiers, stateInlineLinks.
- Added writerNotes and writerReferenceLinks to WriterOptions.
Added Text.Pandoc module that exports basic readers, writers,definitions, and utility functions. This should export everythingneeded for most uses of Pandoc libraries. The haddock documentationincludes a short example program.
Text.Pandoc.ASCIIMathML is no longer an exported module.
Added Text.Pandoc.Blocks module to help in printing markdownand RST tables. This module provides functions for working withfixed-width blocks of text--e.g., placing them side by side, asin a table row.
Refactored to avoid reliance on Haskell's Text.Regex library, which(a) is slow, and (b) does not properly handle unicode. This fixedsome strange bugs, e.g. in parsing S-cedilla, and improved performance.
- Replaced 'gsub' with a general list function 'substitute'that does not rely on Text.Regex.
- Rewrote extractTagType in HTML reader so that it doesn't useregexs.
- In Markdown reader, replaced email regex test with a custom emailautolink parser (autoLinkEmail). Also replaced selfClosingTag regexwith a custom function isSelfClosingTag.
- Modified Docbook writer so that it doesn't rely on Text.Regex fordetecting 'mailto' links.
- Removed escapePreservingRegex and reamped entity-handlingfunctions in Text.Pandoc.Shared and Text.Pandoc.CharacterReferences toavoid reliance on Text.Regex (see below on character referencehandling changes).
Renamed Text.Pandoc.Entities as Text.Pandoc.CharacterReferences.
Changed handling of XML entities. Entities are now parsed (and unicodecharacters returned) in the Markdown and HTML readers, rather than beinghandled in the writers. In HTML and Docbook writers, UTF-8 is now usedinstead of entities for characters above 128. This makes the HTML andDocBook output much more readable and more easily editable.
- Removed sgmlHexEntity, sgmlDecimalEntity, sgmlNamedEntity, andsgmlCharacterEntity regexes from Text.Pandoc.Shared.
- Renamed escapeSGMLChar to escapeCharForXML. Added escapeStringForXML.Moved both functions to Text.Pandoc.Writers.Docbook.
- Added characterReference parser to Text.Pandoc.CharacterReferences.This parses a string and return a unicode character.
- Rewrote decodeCharacterReferences to use the new parser instead ofText.Regex.
- Added new charRef parser for Markdown and HTML, which replaces theold 'entity' parser. Added '&' as a special character in Markdown reader.
- Modified HTML and Markdown readers to call decodeEntities on all rawstrings (e.g. authors, dates, link titles), to ensure that nounprocessed entities are included in the native representation ofthe document. (In the HTML reader, most of this work is done by achange in extractAttributeName.)
- In XML and Markdown output, escape unicode nonbreaking space as '',since a unicode non-breaking space is impossible to distinguish visuallyfrom a regular space. (Resolves Issue #3.)
- Removed encodeEntitiesNumerical.
- Use Data.Map for entityTable and (new) reverseEntityTable, for aslight performance boost over the old association list.
- Removed unneeded decodeEntities from 'str' parser in HTML andMarkdown readers.
Text.Pandoc.UTF8: Renamed encodeUTF8 to toUTF8, decodeUTF8 tofromUTF8, for clarity.
Replaced old haskell98 module names replaced by hierarchical modulenames, e.g. List by Data.List. Removed haskell98 from dependenciesin pandoc.cabal, and added mtl (needed for state monad). Substitutedxhtml for html.
Refactored and cleaned up character escaping in writers, usingbackslashEscapes 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 behavethe 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 Xdoesn'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:
- Fixed several bugs (extractTagType, attribute parsing).
- Remove Null blocks in lists of blocks when possible.
- Allow HTML comments as raw HTML inline.
Markdown reader:
- Ordered list items may no longer begin with uppercase letters, orletters greater than 'n'. (This prevents first initials and pagereference, e.g. 'p. 400', from being parsed as beginning lists.)Also, numbers beginning list items may no longer end with ')',which is now allowed only after letters. Note: These changesmay cause documents to be parsed differently. Users should takecare in upgrading.
- Changed autoLink parsing to conform better to Markdown.pl'sbehavior.
<google.com>
is not treated as a link, but<http://google.com>
,<ftp://google.com>
, and<mailto:google@google.com>
are. - Cleaned up handling of embedded quotes in link titles. Now these arestored as a '"' character, not as '"'.
- Use lookAhead parser for the 'first pass' (looking for reference keys),instead of parsing normally, then using setInput to reset input. Thisyields a slight performance boost.
- Fixed several bugs in smart quote recognition.
- Fixed bug in indentSpaces (which didn't properly handlecases with mixed spaces and tabs).
- Consolidated 'text', 'special', and 'inline' into 'inline'.
- Fixed bug which allowed URL and title to be separated by multiple blanklines in links and reference keys. They can be on separate lines butcan't have blank lines between them.
- Correctly handle bracketed text inside inline footnotes and links,usingnew function inlinesInBalanced. Resolves Issue #14.
- Fixed bug in footnotes: links in footnotes were not beingprocessed. Solution: three-stage parse. First, get all thereference keys and add information to state. Next, get all thenotes and add information to state. (Reference keys may be neededat this stage.) Finally, parse everything else.
- Replaced named constants like 'emphStart' with literals.
- Removed an extra occurrence of escapedChar in definition of inline.
RST reader:
- Allow the URI in a RST hyperlink target to start on the lineafter the reference key.
- Added 'try' in front of 'string', where needed, or used a differentparser. This fixes a bug where ````` would not be correctly parsed asa verbatim `.
- Fixed slow performance in parsing inline literals in RST reader. Theproblem was that
#
was seen by 'inline' as a potential link or image.Fix: inserted 'notFollowedBy (char '`')' in link parsers.Resolves Issue #8. - Use lookAhead instead of getInput/setInput in RST reader. Removedunneeded getState call, since lookAhead automatically saves andrestores the parser state.
- Allow hyperlink target URIs to be split over multiple lines, andto start on the line after the reference. Resolves Issue #7.
- Fixed handling of autolinks.
LaTeX reader:
- Replaced
choice [(try (string ...), ...]
idiom withoneOfStrings
,for clarity. - Added clauses for tilde and caret. Tilde is
\ensuremath{\sim}
, andcaret is\^{}
, not\^
as before. - Added parsing for
\url
. - Parse
\texttt{}
as code, provided there's nothing fancy inside.
- Replaced
HTML writer:
- Modified HTML writer to use the Text.XHtml library. This resultsin cleaner, faster code, and it makes it easier to use Pandoc inother projects, like wikis, which use Text.XHtml. Two functions arenow provided, writeHtml and writeHtmlString: the former outputs anHtml structure, the latter a rendered string. The S5 writer is alsochanged, in parallel ways (writeS5, writeS5String).
- The Html header is now written programmatically, so it has beenremoved from the 'headers' directory. The S5 header is stillneeded, but the doctype and some of the meta declarations havebeen removed, since they are written programmatically. This changeintroduces a new dependency on the xhtml package.
- Fixed two bugs in email obfuscation involving improper escapingof '&' in the
<noscript>
section and in--strict
mode. ResolvesIssue #9. - Fixed another bug in email obfuscation: If the text to be obfuscatedcontains an entity, this needs to be decoded before obfuscation.Thanks to thsutton for the patch. Resolves Issue #15.
- Changed the way the backlink is displayed in HTML footnotes.Instead of appearing on a line by itself, it now generallyappears on the last line of the note. (Exception: when thenote does not end with a Plain or Para block.) This saves spaceand looks better.
- Added automatic unique identifiers to headers:
- The identifier is derived from the header via a schemedocumented in README.
- WriterState now includes a list of header identifiers and a tableof contents in addition to notes.
- The function uniqueIdentifiers creates a list of unique identifiersfrom a list of inline lists (e.g. headers).
- This list is part of WriterState and gets consumed by blockToHtmleach time a header is encountered.
- Include CSS for .strikethrough class in header only if strikethroughtext appears in the document.
- If the 'strict' option is specified, elements that do not appear instandard markdown (like definition lists) are passed through asraw HTML.
- Simplified treatment of autolinks, using pattern matching instead ofconditionals.
Markdown writer:
- Links in markdown output are now printed as inline links by default,rather than reference links. A --reference-links option has been addedthat forces links to be printed as reference links. Resolves Issue #4.
- Use autolinks when possible. Instead of
[site.com](site.com)
,use<site.com>
.
LaTeX writer:
- Rewrote to use the State monad. The preamble now includes only thosepackages that are actually required, given the document's content.Thus, for example, if strikeout is not used, ulem is not required.Modified LaTeXHeader accordingly.
- Modified LaTeX writer to insert
\,
between consecutive quotes. - Removed unused function tableRowColumnWidths.
- Simplified code for escaping special characters.
- Leave extra blank line after
\maketitle
. - Include empty
\author{}
when no author specified to avoid LaTeXerrors. - Include fancyvrb code in header only if needed -- that is, onlyif there is actually code in a footnote.
- Use
\url{}
for autolinks. - Include [mathletters] option in ucs package, so that basic unicodeGreek letters will work correctly.
RST writer: Force blank line before lists, so that sublists willbe handled correctly.
Docbook writer: Fixed a bug: email links with text, likefoo, were being incorrectly treated as autolinks.
Removed Text.ParserCombinators.Pandoc and moved all its functions toText.Pandoc.Shared.
Text.Pandoc.Shared:
- Added defaultWriterOptions.
- Added writerTableOfContents to WriterOptions.
- Added writerIgnoreNotes option to WriterOptions. This is neededfor processing header blocks for a table of contents, since notes onheaders should not appear in the TOC.
- Added prettyprinting for native Table format.
- Removed some unneeded imports.
- Moved escape and nullBlock parsers fromText.ParserCombinators.Pandoc, since the latter is forgeneral-purpose parsers that don't depend on Text.Pandoc.Definition.
- Moved isHeaderBlock from Text.Pandoc.Writers.HTML.
- Moved Element, headerAtLeast, and hierarchicalize from Docbookwriter, because HTML writer now uses these in constructing a tableof contents.
- Added clauses for new inline elements (Strikeout, Superscript,Subscript) to refsMatch.
- Removed backslashEscape; added new functions escapeStringUsing andbackslashEscapes.
- Moved failIfStrict from markdown reader, since it is now used alsoby the HTML reader.
- Added a 'try' to the definition of indentSpaces.
- In definition of 'reference', added check to make sure it's not a notereference.
- Added functions: camelCaseToHyphenated, toRomanNumeral,anyOrderedListMarker, orderedListmarker, orderedListMarkers,charsInBalanced', withHorizDisplacement, romanNumeral
- Fixed a bug in the anyLine parser. Previously it would parse an emptystring "", but it should fail on an empty string, or we get an errorwhen it is used inside "many" combinators.
- Removed followedBy' parser, replacing it with the lookAhead parser fromParsec.
- Added some needed 'try's before multicharacter parsers, especially in'option' contexts.
- Removed the 'try' from the 'end' parser in 'enclosed', so that'enclosed' behaves like 'option', 'manyTill', etc.
- Added lineClump parser, which parses a raw line block up to andincluding any following blank lines.
- Renamed parseFromStr to parseFromString.
- Added a 'try' to the 'end' parser in 'enclosed'. This makes errors inthe use of 'enclosed' less likely. Removed some now-unnecessary 'try'sin calling code.
- Removed unneeded 'try' in blanklines.
- Removed endsWith function and rewrote calling functions to useisSuffixOf instead.
- Added >>~ combinator.
- Fixed bug in normalizeSpaces: Space:Str "":Space should compress toSpace.
Refactored runtests.pl; added separate tests for tables.
Shell scripts:
- Added -asxhtml flag to tidy in html2markdown. This willperhaps help the parser, which expects closing tags.
- Modified markdown2pdf to run pdflatex a second time if --toc or--table-of-contents was specified; otherwise the table ofcontents won't appear.
- Modified markdown2pdf to print a helpful message if the 'ulem'LaTeX package is required and not found.
Changes to build process:
- Dropped support for compilation with GHC 6.4. GHC 6.6 or higheris now required.
- Removed cabalize and Pandoc.cabal.in. The repository now containspandoc.cabal itself.
- Pandoc.cabal has been changed to pandoc.cabal, because HackageDBlikes the cabal file to have the same name as the tarball.
- Expanded and revised the package description in pandoc.cabal.Revised the package synopsis.
- The tarball built by 'make tarball' now contains files built fromtemplates (including man pages and shell scripts), so pandoc canbe built directly using Cabal tools, without preprocessing.
- Executable binaries are now stripped before installing.
- Man pages are now generated from markdown sources, using pandoc'sman page writer.
- Use HTML version of README (instead of RTF) in Mac OS X installer.
- Instead of testing for the existence of a pandoc symlink in build-exec,use ln -f.
Documentation:
- Updated README and man pages with information on new features.
- Updated INSTALL instructions with some useful clarifications andlinks.
- Updated web content.
Added FreeBSD port.
[ Recai Oktaş ]
debian/control:
- Changed pandoc's Build-Depends to include libghc6-mtl-dev andlibghc6-xhtml-dev. Removed libghc6-html-dev.
- Suggest texlive-latex-recommended | tetex-extra instead oftetex-bin. This brings in fancyvrb and unicode support.
pandoc 0.3 (2007-01-05)
[ John MacFarlane ]
Changes in pandoc options:
- Allow options to follow or precede arguments.
- Changed '--smartypants' to '--smart' and adjusted symbols accordingly.
- Added '--strict' option.
- Added '-o/--output' option.
- Added '--dump-args' and '--ignore-args' options (for use in wrappers).
- Modified '-v' and '-h' output to go to STDERR, not STDOUT, and returnerror conditions. This is helpful for writing wrappers.
- Added copyright message to '-v' output, modeled after FSF messages.
- Reformatted usage message so that it doesn't wrap illegibly.
- Removed extra blanks after '-h' and '-D' output.
Added docbook writer.
Added implicit setting of default input and output format basedon input and output filename extensions. These defaults areoverridden if explicit input and output formats are specified using'-t', '-f', '-r', or '-w' options. Documented in pandoc(1) man pageand README.
Allow ordered list items to begin with (single) letters, as wellas numbers. The list item marker may now be terminated either by'.' or by ')'. This extension to standard markdown is documentedin 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 footnotesare now auto-numbered and appear in an ordered list at theend of the HTML document. Since the default appearance is nowacceptable, the old footnote styles have been removed from theHTML header.
Bug fixes:
- Fixed a serious bug in the markdown, LaTeX, and RST readers.These readers ran 'runParser' on processed chunks of text to handleembedded block lists in lists and quotation blocks. But thenany changes made to the parser state in these chunks was lost,as the state is local to the parser. So, for example, footnotesdidn't work in quotes or list items. The fix: instead of callingrunParser on some raw text, use setInput to make it the input, thenparse it, then use setInput to restore the input to what it wasbefore. This is shorter and more elegant, and it fixes the problem.
- Fixed bug in notFollowedBy' combinator (adding 'try' before'parser'). Adjusted code that uses this combinator accordingly.
- Fixed bug in RTF writer that caused improper indentation onfootnotes occurring in indented blocks like lists.
- Fixed parsing of metadata in LaTeX reader. Now the title, author,and date are parsed correctly. Everything else in the preambleis skipped.
- Modified escapedChar in LaTeX reader to allow a
\
at the end of aline to count as escaped whitespace. - Modified LaTeX reader to produce inline links rather than referencelinks. Otherwise, links in footnotes aren't handled properly.
- Fixed handling of titles in links in Markdown reader, so thatembedded quotation marks are now handled properly.
- Fixed Markdown reader's handling of embedded brackets in links.
- Fixed Markdown reader so that it only parses bracketed materialas a reference link if there is actually a corresponding key.
- Revised inline code parsing in Markdown reader to conform tomarkdown standard. Now any number of
s can begin inline code, which will end with the same number of
s. For example, tohave two backticks as code, write``
. Modified Markdownwriter accordingly. - Fixed bug in text-wrapping routine in Markdown and RST writers.Now LineBreaks no longer cause wrapping problems.
- Supported hexadecimal numerical entity references as well asdecimal ones.
- Fixed bug in Markdown reader's handling of underscores and otherinline formatting markers inside reference labels: for example,in '[A_B]: /url/a_b', the material between underscores was beingparsed as emphasized inlines.
- Changed Markdown reader's handling of backslash escapes so thatonly non-alphanumeric characters can be escaped. Strict modefollows Markdown.pl in only allowing a select group of punctuationcharacters to be escaped.
- Modified HTML reader to skip a newline following a
<br>
tag.Otherwise the newline will be treated as a space at the beginningof the next line.
Made handling of code blocks more consistent. Previously, somereaders allowed trailing newlines, while others stripped them.Now, all readers strip trailing newlines in code blocks. Writersinsert 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.- Simplified parsing of LaTeX command arguments and options.commandArgs now returns a list of arguments OR options (inwhatever order they appear). The brackets are included, anda new stripFirstAndLast function is provided to strip them offwhen needed. This fixes a problem in dealing with \newcommandand \newenvironment.
Revised RTF writer:
- Default font is now Helvetica.
- An
\f0
is added to each\pard
, so that font resizing workscorrectly.
Moved handling of "smart typography" from the writers to the Markdownand LaTeX readers. This allows great simplification of the writersand more accurate smart quotes, dashes, and ellipses. DocBook cannow use
<quote>
. The '--smart' option now toggles an option inthe parser state rather than a writer option. Several new kindsof inline elements have been added: Quoted, Ellipses, Apostrophe,EmDash, EnDash.Changes in HTML writer:
- Include title block in header even when title is null.
- Made javascript obfuscation of emails even more obfuscatory,by combining it with entity obfuscation.
Changed default ASCIIMathML text color to black.
Test suite:
- Added --strip-trailing-cr option to diff in runtests.pl, forcompatibility with Windows.
- Added regression tests with footnotes in quote blocks and lists.
Makefile changes:
- osx-pkg target creates a Mac OS X package (directory). New osxdirectory contains files needed for construction of the package.
- osx-dmg target creates a compressed disk image containing the package.
- win-pkg target creates Windows binary package.
- tarball target creates distribution source tarball.
- website target generates pandoc's website automatically, includingdemos. New 'web' directory contains files needed for constructionof the website (which will be created as the 'pandoc' subdirectoryof 'web').
- Makefile checks to see if we're running Windows/Cygwin; if so,a '.exe' extension is added to each executable in EXECS.
Removed all wrappers except markdown2pdf and html2markdown.
Added new wrapper hsmarkdown, to be used as a drop-in replacementfor Markdown.pl. hsmarkdown calls pandoc with the '--strict'option and disables other options.
Added code to html2markdown that tries to determine the characterencoding of an HTML file, by parsing the "Content-type" meta tag.
- If the encoding can't be determined, then if the content is local,the local encoding is used; if it comes from a URL, UTF-8 is usedby default.
- If input is from STDIN, don't try to determine character encoding.
- Encoding can be specified explicitly using '-e' option.
Improved warning messages in wrappers:
- Print warning if iconv not available
- More user-friendly error messages in markdown2pdf, whenpdflatex fails.
Code cleanup:
- Renamed 'Text/Pandoc/HtmlEntities' module to'Text/Pandoc/Entities'. Also changed function names so asnot to be HTML-specific.
- Refactored SGML string escaping functions from HTML and Docbookwriters into Text/Pandoc/Shared. (escapeSGML, stringToSGML)
- Removed 'BlockQuoteContext' from ParserContext, as it isn'tused anywhere.
- Removed splitBySpace and replaced it with a general, polymorphicsplitBy function.
- Refactored LaTeX reader for clarity (added isArg function).
- Converted some CR's to LF's in src/ui/default/print.css.
- Added license text to top of source files.
- Added module data for haddock to source files.
- Reformatted code for consistency.
Rewrote documentation and man pages. Split README into INSTALLand 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 avoidduplication.
[ Recai Oktaş ]
Revamped build process to conform to debian standards and createda proper debian package. Closes: #391666.
Modified build process to support GHC 6.6.
- The package can still be compiled using GHC 6.4.2, though becauseof dependencies the "make deb" target works only with GHC 6.6+.
- The script 'cabalize' is used to create an appropriate'Pandoc.cabal' from 'Pandoc.cabal.in', depending on the GHC andCabal versions.
Refactored template processing (fillTemplates.pl).
Modified wrapper scripts to make them more robust and portable.To avoid code duplication and ensure consistency, wrappers aregenerated via a templating system from templates in src/wrappers.
- Wrappers now accept multiple filenames, when appropriate.
- Spaces and tabs allowed in filenames.
- getopts shell builtin is used for portable option parsing.
- Improved html2markdown's web grabber code, making it more robust,configurable and verbose. Added '-e', '-g' options.
pandoc 0.2 (2006-08-14)
- Fixed unicode/utf-8 translation
pandoc 0.1 (2006-08-14)
- Initial creation of debian package