pandoc (1.2) [ John MacFarlane ] * Added support for literate Haskell. lhs support is triggered by '+lhs' suffixes in formats. For example, 'latex+lhs' is literate Haskell LaTeX. '.lhs' files are treated by default as literate markdown. + Added stateLiterateHaskell to parser state. + Added parser for lhsCodeBlock to Markdown, RST, LaTeX readers. + Added parser for |inline lhs| to LaTeX reader. + Added writerLiterateHaskell to WriterOptions. + Added lhs support to Markdown, RST, LaTeX, HTML writers. + Added definition of code environment to LaTeX header. + Documented lhs features in man page and README. * Added a plugin system, based on hint. This allows users to write small interpreted Haskell programs that transform the AST between the reader and the writer. + In Text.Pandoc.Definition, added processWith, processWithM, and queryWith, and deprecated processPandoc and queryPandoc for these more general functions, which are useful in writing plugins. + Added module Text.Pandoc.Plugins. + Added a --plugins option to pandoc, and code to run the parsed document through all the plugins. + Provided five sample plugin files in the plugins/ directory. + Documented --plugin in the pandoc man page and README. * Fixed bug in mediawiki writer: improper closing tags in tables. Thanks to Benct Philip Jonsson for reporting the bug. * Added --email-obfuscation option. + Added writer option for email obfuscation. + Implemented email obfuscation options in HTML writer. + Added option to option parser. + Documented in README and pandoc man page. + Resolves Issue #97. * LaTeX writer: fixed bug with empty table cells. Resolves Issue #107. Thanks to rodja.trappe for the patch. * Markdown reader: Relax spacing rules for $$ in display math. Now space and newlines are allowed after the opening $$ and before the closing $$. However, the display math cannot contain an entirely blank line. Resolves Issue #105. * Markdown reader: Gobble space after Plain blocks containing only raw html inline. Otherwise following header blocks are not parsed correctly, since the parser sees blank space before them. Resolves Issue #124. * Markdown reader: Allow " as well as '' to end a latex double-quote. * Conditionally depend on syb and base >= 4 if ghc >= 6.10. Resolves Issue #109. * Fixed problems in RST and markdown output due to bug in pretty-1.0.1.0 + Added hang' function to Text.Pandoc.Shared; this will be used instead of hang, which doesn't work properly in pretty-1.0.1.0. When pretty is upgraded, we can go back to hang. See http://article.gmane.org/gmane.comp.lang.haskell.general/16687 + Use hang' (and some different techniques) in RST and markdown writers. Some output is now a bit different. * Brought citeproc support up to date for citeproc-hs-0.2. (Patch by Andrea Rossato.) * Moved all haskell source to src subdirectory. Renamed Main.hs to pandoc.hs. * Rewrote hsmarkdown in Haskell for portability (src/hsmarkdown.hs). For now, keeping the old shell script too. * Added TemplateHaskell to Extensions for executable, removed -threaded for library. Thanks to duncan.coutts for the bug report. Resolves Issue #121. * Moved some Extra-Source-Files to Data-Files. * Moved tabFilter to Shared. * In pandoc.hs, removed optPreserveTabs; instead, tabstop of 0 means preserve tabs. * Minor code cleanup based on hlint suggestions. pandoc (1.1) [ John MacFarlane ] * Main.hs: + Changed date on copyright message in Main.hs. + Have the '-v' option print syntax highlighting languages separated by commas, and wrapped in lines, instead of in five columns as before. * Added --jsmath option. Resolves Issue #68. + Added --jsmath option to Main.hs + Added JsMath to HTMLMathMethod in Text.Pandoc.Shared. + Handle math appropriately in HTML writer when JsMath selected. + Documented the option in README and man page. * Text.Pandoc.Shared: Changed compactify to use a better heuristic for tight and loose lists. Final Para is changed to Plain if all other list items *end* with a Plain block. Addresses Issue #99. * HTML reader: + Added colons to protocols in unsanitaryURI. Closes Issue #88. + HTML reader: Don't interpret contents of
blocks as markdown.
Added rawVerbatimBlock parser. Resolves Issue #94.
* Markdown reader:
+ Allow URLs with spaces in them in links and references, but escape
them as "%20".
+ Allow blank space at the end of horizontal rules.
* RST reader: Modified 'unknownDirective' parser to handle comment
blocks correctly, and added tests for comment blocks. Resolves Issue
#86. Closes Debian Bug #500662.
* HTML writer:
+ Include classes on tr elements in HTML output:
"header", "odd", "even". This allows tables to be styled with
lines in alternating colors. Resolves Issue #91.
+ Enclose all LaTeXMathML bits in .
This prevents parts of the document that are not math from being
interpreted as math by LaTeXMathML.js.
* OpenDocument and ODT writers: Added support for HorizontalRule elements,
which were formerly ignored. Resolves Issue #95.
* Text.Pandoc.Shared: Modified wrappedTeX to eliminate the line break
between a footnote and immediately following nonspace characters in
LaTeX and ConTeXt output. (This gets interpreted as a space, which
is not desired in cases like "text^[note]---".) Resolves Issue #93.
* Windows installer: Don't require admin privileges to run
installer. Modified pandoc-setup.iss, and changed modpath.iss to
modify HKCU path if user lacks admin privileges. Also fixed case
where oldpath is empty (previously this led to the new path
beginning with a semicolon).
* Updated INSTALL instructions for Arch packages and OS X install using
cabal-install.
* Removed the (now unneeded) debian directory.
Removed empty Codec and System directories.
* Moved odt-styles/ to data/. Removed unneeded variable in Makefile.
* Modified Setup.hs so that the "test" target returns an error status
when tests fail, and "build" returns a success status if
the build succeeds. Resolves Issue #100.
* Added BUGS to files in tarball.
pandoc (1.0.0.1)
[ John MacFarlane ]
* Removed spurious reference to pdf output format from pandoc(1) man page.
pandoc (1.0)
[ Andrea Rossato ]
* Added new OpenDocument writer.
* Added support for SmallCaps inline element.
* Added support for integrating pandoc with citeproc-hs.
+ Added Cite element to definition and writers.
+ Added Text.Pandoc.Biblio module
+ Note: This support is included only if the 'citeproc'
Cabal configuration flag is set.
* Made Pandoc data structure an instance of Typeable.
Added new processPandoc and queryPandoc functions, to query
or transform matching elements in a Pandoc structure.
[ Peter Wang ]
* Added new Texinfo writer.
[ John MacFarlane ]
* Changes to Texinfo writer:
+ No space between paragraph and following @verbatim (provides more
pleasing appearance in text formats)
+ Blank line consistently after list environments.
+ Removed deVerb.
+ Use @code instead of @verb for inline code (this solves the character
escaping problem for texi2dvi and texi2pdf).
+ Added news of Texinfo writer to README.
+ Added Texinfo to list of formats in man page, and removed extra 'groff'.
+ Added texi & texinfo extensions to Main.hs, and fixed bug in determining
default output extension.
+ Modified disallowedInNode in Texinfo writer to correct list of disallowed characters.
* Added tests for OpenDocument writer.
* Added ODT writer (using zip-archive library to package output of
OpenDocument writer). Added odt-styles directory with default ODT styles.
* Added new mediawiki writer and tests.
* Markdown reader: Added support for delimited code blocks, with optional
syntax highlighting using highlighting-kate (if the 'highlighting'
configuration option is selected).
+ Currently highlighting is supported only in the HTML writer.
+ Delimited code blocks can have attributes; using the language name as
class triggers highlighting.
+ New Attributes parameter in CodeBlock structure.
+ --version now indicates whether syntax highlighting support is compiled
in, and prints a list of supported languages
* Removed debian directory. Pandoc is no longer a native debian package.
* Changes to build process: pandoc can now be built from the repository
using Cabal. No unix tools are needed (so, pandoc can be built on Windows
without Cygwin).
+ Include shell scripts themselves in repo, rather than generating from wrappers.
Removed wrappers directory and wrappers Makefile target.
+ Text/Pandoc/ASCIIMathML.hs, Text/Pandoc/DefaultHeaders.hs,
and Text/Pandoc/Writers/S5.hs are no longer built in Makefile
from templates in the templates/ directory. Instead, they use template
haskell to read data at compile time from the relevant files in data/.
Template haskell functions go in a new module, Text.Pandoc.TH.
+ man pages are now generated in Setup.hs hook, not by Makefile
+ Makefile 'tarball' target now calls Cabal's 'sdist'
+ Added "Extra-Source-Files" to pandoc.cabal, so sdist contains everything needed
+ Added "Build-Type" field to pandoc.cabal to avoid warning.
+ Added to "Extra-source-files" and "Extra-tmp-files" in pandoc.cabal,
so 'sdist' and 'clean' will work properly.
+ Setup.hs now generates man pages in a postbuild hook.
+ Added dependency-checking to Setup.hs, so it only rebuilds things
that need rebuilding.
+ Added 'library' and 'executable' configuration flags.
Cabal can now be told to build just the library or just the executable.
+ CABALOPTS may now be specified with 'make' to pass Cabal configuration flags.
For example: CABALOPTS=-fhighlighting make
* Rewrote test suite so it doesn't depend on perl or unix tools.
+ Replaced old runtests.pl with a Haskell script RunTests.hs.
+ Added Diff.hs module to be used by RunTests.hs instead of unix 'diff'.
+ Added test hook to Setup.hs, so tests may be run from cabal.
+ Changed Makefile's 'test' target to run tests via cabal.
+ Removed old generate.sh.
+ Since we no longer have 'sed' to filter out raw HTML sections
from the docbook writer test, or raw LaTeX sections from the
context writer test, we now just include these sections.
They can be taken out if it is necessary to process the files.
+ Updated latex and context writer tests to remove extra spaces
after '\\item'
+ Added a markdown table reader test.
+ Added markdown-reader-more.txt to test suite, for additional test cases
for raw ConTeXt environments and more.
* Compatibility fixes for CPP, Cabal, and haddock:
+ Use CPP in "Extensions" field in pandoc.cabal.
+ Removed use of backslash string continuations in source files.
* Removed pandoc.cabal.ghc66. We now require Cabal >= 1.2, GHC >= 6.8,
base >= 3.
* Require parsec < 3.
The compatibility module in parsec 3.0.0 gives far worse performance than
parsec 2.1. Eventually pandoc will be upgraded to use the new bytestring
version of parsec, and then we'll go to parsec 3.0.0.
* Removed Text.Regex dependencies by rewriting using plain Haskell
(Text.Pandoc.Writers.RTF, Text.Pandoc.Writers.HTML, Main.hs)
* Moved Text.Pandoc.Writers.DefaultHeaders -> Text.Pandoc.DefaultHeaders.
* Makefile:
+ Added 'configure' as dependency of 'uninstall-all'.
(It uses the Cabal build program.)
+ Makefile: only use --with-hc-pkg if GHC_PKG is defined.
Note that Cabal will automatically choose the ghc-pkg appropriate
for the compiler selected, so normally specifying GHC by itself
is sufficient.
* Removed Text.Pandoc.UTF8 module; instead, depend on utf8-string and use
its IO and conversion functions.
* Added -Wall to ghc-options in pandoc.cabal. Cleaned up modules so that
everything is -Wall clean.
+ Added pragma to HTML writer to avoid deprecation warning for use of "start" attribute.
+ Added pragma to Text/Pandoc/Shared.hs to get rid of "orphan instance" warnings.
(These are caused by the Lift instance for ByteString.)
* Changed the comment used to replace unsafe HTML if sanitize-html option
selected.
* Made -c/--css option repeatable on the command line (like -H, -A, -B).
* Moved XML-formatting functions to new unexported module Text.Pandoc.XML.
* Escape '\160' as " ", not " " in XML.
"nbsp" isn't a predefined XML entity.
* Fixed bug in RST reader, which would choke on: "p. one\ntwo\n".
Added some try's in ordered list parsers.
* Man writer: don't escape " as \".
* Allow newline before URL in markdown link references. Resolves Issue #81.
Added tests for this issue in new "markdown-reader-more" tests.
Changed RunTests.hs to run these tests.
* Support for display math. Resolves Issue #47.
+ Added a DisplayMath/InlineMath selector to Math inlines.
+ Markdown parser yields DisplayMath for $$...$$.
+ LaTeX parser yields DisplayMath when appropriate. Removed
mathBlock parsers, since the same effect is achieved by the math
inline parsers, now that they handle display math.
+ Writers handle DisplayMath as appropriate for the format.
+ Modified tests accordingly; added new tests for display math.
* Use LaTeXMathML instead of ASCIIMathML. LaTeXMathML is closer
to LaTeX in its display of math, and supports many non-math LaTeX environments.
+ Changed -m option to use LaTeXMathML rather than ASCIIMathML.
+ Modified HTML writer to print raw TeX when LaTeXMathML is
being used instead of suppressing it.
+ Removed ASCIIMathML files from data/ and added LaTeXMathML.
+ Replaced ASCIIMathML with LaTeXMathML in source files.
+ Modified README and pandoc man page source.
+ Added --latexmathml option (kept --asciimathml as a synonym
for backwards compatibility)
* Markdown reader: Parse setext headers before atx headers.
Test case:
# hi
====
parsed by Markdown.pl as an H1 header with contents "# hi".
* Markdown reader: Treat "mixed" lists the same way as Markdown.pl does.
The marker on the first list item determines the type of the whole
list. Thus, a list like
1. one
- two
* three
gets parsed as a single ordered list. (Previous versions of pandoc
treated this as an ordered list with an unordered sublist.)
* Markdown smart typography:
+ Em dashes no longer eat surrounding whitespace. Resolves Issue #69.
+ Use nonbreaking spaces after known abbreviations in markdown parser.
Thus, for example, "Mr. Brown" comes out as "Mr.~Brown" in LaTeX, and does
not produce a sentence-separating space. Resolves Issue #75.
* Markdown writer: Print unicode \160 literally, rather than as .
* Treat '\ ' in (extended) markdown as nonbreaking space.
Print nonbreaking space appropriately in each writer (e.g. ~ in LaTeX).
* The '--sanitize-html' option now examines URIs in markdown links
and images, and in HTML href and src attributes. If the URI scheme
is not on a whitelist of safe schemes, it is rejected. The main point
is to prevent cross-site scripting attacks using 'javascript:' URIs.
See http://www.mail-archive.com/markdown-discuss@six.pairlist.net/msg01186.html
and http://ha.ckers.org/xss.html. Resolves Issue #62.
* HTML writer:
+ Override Text.XHtml's stringToHtml function,
so that characters below 0xff are not converted to numerical entity
references. Also convert '\160' to " ". This should aid readability
and editability of the HTML source. It does presuppose that the HTML
will be served as UTF-8.
+ In code blocks, change leading newlines to
tags.
(Some browsers ignore them.) Resolves Issue #71.
See http://six.pairlist.net/pipermail/markdown-discuss/2008-May/001297.html
+ Use style attributes rather than css classes for strikethrough
and ordered list styles. This works better when fragments, rather than
standalone documents, are generated.
* HTML reader: Count anything that isn't a known block (HTML) tag as an
inline tag (rather than the other way around). Added "html", "head", and
"body" to list of block tags. Resolves Issue #66, allowing
to count as an inline tag.
* RTF writer: Fixed bug. Extra spaces were being printed after emphasized,
boldface, and other inline elements. Resolves Issue #64.
* LaTeX reader: improvements in raw LaTeX parsing.
+ "loose punctuation" (like {}) parsed as Space
+ Para elements must contain more than Str "" and Space elements
+ Added parser for "\ignore" command used in literate haskell.
+ Reworked unknownCommand and rawLaTeXInline: when not in "parse raw"
mode, these parsers simply strip off the command part and allow
the arguments to be parsed normally. So, for example,
\blorg{\emph{hi}} will be parsed as Emph "hi" rather than
Str "{\\emph{hi}}".
+ Parse lhs "code" environments as verbatim.
Refactored parsers for verbatim environments.
+ Removed specialEnvironment parser.
+ parse '{}', if present, after \textless, \textgreater,
\textbar, \textbackslash, \ldots.
+ Parse unescaped special characters verbatim rather than
changing them to spaces. This way arguments of unknown
commands will appear in braces.
* Parse raw ConTeXt environments as TeX in markdown reader.
Resolves Issue #73.
* Moved BlockWrapper and wrappedBlocksToDoc from ConTeXt writer to Shared.
* Made some structural changes to parsing of raw LaTeX environments.
Previously there was a special block parser for LaTeX environments.
It returned a Para element containing the raw TeX inline. This has
been removed, and the raw LaTeX environment parser is now used in the
rawLaTeXInline parser. The effect is exactly the same, except that we
can now handle consecutive LaTeX and ConTeXt environments not separated
by spaces. This new flexibility is required by the example in
Issue #73:
\placeformula \startformula
L_{1} = L_{2}
\stopformula
API change: The LaTeX reader now exports rawLaTeXEnvironment' (which
returns a string) rather than rawLaTeXEnvironment (which returns a block
element). This is more likely to be useful in other applications.
* Use \textsubscr instead of \textsubscript for LaTeX subscript macro.
\textsubscript conflicts with a definition in the memoir class.
Resolves Issue #65.
* Removed unneeded space after "\\item" in LaTeX and ConTeXt output.
* Added amsmath package to default LaTeX header. Resolves Issue #48.
* Added \setupitemize[autointro] to ConTeXt header, to prevent orphaned
list introduction lines.
* Changed Float to Double in definition of Table element.
(Double is more efficient in GHC.)
* Fixed bug in Markdown parser: regular $s triggering math mode.
For example: "shoes ($20) and socks ($5)."
The fix consists in two new restrictions:
+ the $ that ends a math span may not be directly followed by a digit.
+ no blank lines may be included within a math span.
Thanks to Joseph Reagle for noticing the bug.
* Use Data.List's 'intercalate' instead of custom 'joinWithSep'.
Removed 'joinWithSep' from Text.Pandoc.Shared.
* Updated README and man pages. Acknowledge contributors in README.
Added paragraph to README about producing S5 with separate CSS/javascript.
* Updated INSTALL to reflect new build system (including configuration
options) and document new dependencies. Added note to INSTALL that
Cabal >= 1.2 is required for build. Resolves Issue #74.
* Fixed some haddock documentation errors.
* Small fix to markdown2pdf man page: only input needs to be piped through iconv.
pandoc (0.46) unstable; urgency=low
[ John MacFarlane ]
* Made -H, -A, and -B options cumulative: if they are specified
multiple times, multiple files will be included.
* Added optional HTML sanitization using a whitelist.
When this option is specified (--sanitize-html on the command line),
unsafe HTML tags will be replaced by HTML comments, and unsafe HTML
attributes will be removed. This option should be especially useful
for those who want to use pandoc libraries in web applications, where
users will provide the input.
+ Main.hs: Added --sanitize-html option.
+ Text.Pandoc.Shared: Added stateSanitizeHTML to ParserState.
+ Text.Pandoc.Readers.HTML:
- Added whitelists of sanitaryTags and sanitaryAttributes.
- Added parsers to check these lists (and state) to see if a given
tag or attribute should be counted unsafe.
- Modified anyHtmlTag and anyHtmlEndTag to replace unsafe tags
with comments.
- Modified htmlAttribute to remove unsafe attributes.
- Modified htmlScript and htmlStyle to remove these elements if
unsafe.
+ Modified README and man pages to document new option.
* Improved handling of email addresses in markdown and reStructuredText.
Consolidated uri and email address parsers. (Resolves Issue #37.)
+ New emailAddress and uri parsers in Text.Pandoc.Shared.
- uri parser uses parseURI from Network.URI.
- emailAddress parser properly handles email addresses with periods
in them.
+ Removed uri and emailAddress parsers from Text.Pandoc.Readers.RST
and Text.Pandoc.Readers.Markdown.
* Markdown reader:
+ Fixed emph parser so that "*hi **there***" is parsed as a Strong
nested in an Emph. (A '*' is only recognized as the end of the
emphasis if it's not the beginning of a strong emphasis.)
+ Moved blockQuote parser before list parsers for performance.
+ Modified 'source' parser to allow backslash-escapes in URLs.
So, for example, [my](/url\(1\)) yields a link to /url(1).
Resolves Issue #34.
+ Disallowed links within links. (Resolves Issue #35.)
- Replaced inlinesInBalanced with inlinesInBalancedBrackets, which
instead of hard-coding the inline parser takes an inline parser
as a parameter.
- Modified reference and inlineNote to use inlinesInBalancedBrackets.
- Removed unneeded inlineString function.
- Added inlineNonLink parser, which is now used in the definition of
reference.
- Added inlineParsers list and redefined inline and inlineNonLink parsers
in terms of it.
- Added failIfLink parser.
+ Better handling of parentheses in URLs and quotation marks in titles.
- 'source' parser first tries to parse URL with balanced parentheses;
if that doesn't work, it tries to parse everything beginning with
'(' and ending with ')'.
- source parser now uses an auxiliary function source'.
- linkTitle parser simplified and improved, under assumption that it
will be called in context of source'.
+ Make 'block' conditional on strictness state, instead of using
failIfStrict in block parsers. Use a different ordering of parsers
in strict mode (raw HTML block before paragraph) for performance.
In non-strict mode use rawHtmlBlocks instead of htmlBlock.
Simplified htmlBlock, since we know it's only called in strict
mode.
+ Improved handling of raw HTML. (Resolves Issue #36.)
- Tags that can be either block or inline (e.g. ) should
be treated as block when appropriate and as inline when
appropriate. Thus, for example,
hi
should be treated as a paragraph with inline tags, while
hi
should be treated as a paragraph within tags.
- Moved htmlBlock after para in list of block parsers. This ensures
that tags that can be either block or inline get parsed as inline
when appropriate.
- Modified rawHtmlInline' so that block elements aren't treated as
inline.
- Modified para parser so that paragraphs containing only HTML tags and
blank space are not allowed. Treat these as raw HTML blocks instead.
+ Fixed bug wherein HTML preceding a code block could cause it to
be parsed as a paragraph. The problem is that the HTML parser
used to eat all blank space after an HTML block, including the
indentation of the code block. (Resolves Issue #39.)
- In Text.Pandoc.Readers.HTML, removed parsing of following space
from rawHtmlBlock.
- In Text.Pandoc.Readers.Markdown, modified rawHtmlBlocks so that
indentation is eaten *only* on the first line after the HTML
block. This means that in
foo
the foo won't be treated as a code block, but in
foo
it will. This seems the right approach for least surprise.
* RST reader:
+ Fixed bug in parsing explicit links (resolves Issue #44).
The problem was that we were looking for inlines until a '<' character
signaled the start of the URL; so, if you hit a reference-style link,
it would keep looking til the end of the document. Fix: change
inline => (notFollowedBy (char '`') >> inline). Note that this won't
allow code inlines in links, but these aren't allowed in resT anyway.
+ Cleaned up parsing of reference names in key blocks and links.
Allow nonquoted reference links to contain isolated '.', '-', '_', so
so that strings like 'a_b_' count as links.
+ Removed unnecessary check for following link in str.
This is unnecessary now that link is above str in the definition of
'inline'.
* HTML reader:
+ Modified rawHtmlBlock so it parses