@@ -1,3 +1,490 @@
1+pandoc (1.9)
2+
3+ [new features]
4+
5+ * Added a Microsoft Word `docx` writer. The writer includes support
6+ for highlighted code and for math (which is converted from TeX to OMML,
7+ Office's native math markup language, using texmath's new OMML module).
8+ A new option `--reference-docx` allows the user to customize the
9+ styles in the standard `reference.docx`.
10+
11+ * Added an `asciidoc` writer (<http://www.methods.co.nz/asciidoc/>).
12+
13+ * Better support for slide shows:
14+
15+ + Added a `dzslides` writer. DZSlides is a lightweight HTML5/javascript
16+ slide show format due to Paul Rouget (<http://paulrouget.com/dzslides/>).
17+
18+ + Added a LaTeX `beamer` writer. Beamer is a LaTeX package for creating
19+ slide presentations.
20+
21+ + New, flexible rules for dividing documents into sections and slides
22+ (see the "Structuring the slide show" in the User's Guide). These
23+ are backward-compatible with the old rules, but they allow slide
24+ shows to be organized into sections and subsections containing
25+ multiple slides.
26+
27+ + Added a `--slide-level` option to override defaults and select a slide
28+ level below the first header level with content. Note that content
29+ in sections above the slide level will not appear in slides (either in
30+ beamer or in HTML slide shows). This is primarily useful for creating
31+ documents that can be made into both slides and handouts (which contain
32+ additional content outside the slides).
33+
34+ * New `--self-contained` option tries to create HTML output that does not
35+ depend on an internet connection or the presence of any external
36+ files. Linked images, CSS, and javascript is downloaded and encoded in
37+ `data:` URIs. This is useful for making portable HTML slide shows. The
38+ `--offline` option has been deprecated and is now treated as a synonym or
39+ `--self-contained`.
40+
41+ * Support for PDF output:
42+
43+ + Removed the old `markdown2pdf`.
44+ + `pandoc` can now create PDFs (assuming you have latex and a set of
45+ appropriate packages installed): just specify an output file with the
46+ `.pdf` extension.
47+ + A new option `--latex-engine` allows you to specify `pdflatex`,
48+ `xelatex`, or `lualatex` as the processor.
49+
50+ * Highlighting changes:
51+
52+ + Syntax highlighting is now a standard feature; pandoc no longer
53+ need be compiled with a `highlighting` flag to enable it.
54+ + A new `--no-highlight` option allows it to be selectively disabled.
55+ + Highlighting now works in `docx`, `latex`, and `epub`, as well as
56+ `html`, `html5`, `dzslides`, `s5`, and `slidy`.
57+ + A new `--highlight-style` option selects between various highlighting
58+ color themes.
59+
60+ * Internal links to sections now work in ConTeXt and LaTeX as well as HTML
61+ (thanks to B. Scott Michel).
62+
63+ * EPUB improvements:
64+
65+ + Internal and external links now work in EPUB.
66+ + Raw HTML is allowed.
67+ + New `--epub-embed-font` option.
68+ + Customizable templates for EPUB pages, giving more control over
69+ formatting: `epub-page.html`, `epub-coverimage.html`,
70+ `epub-titlepage.html`.
71+
72+ * `--mathml` now works with DocBook as well as HTML.
73+
74+ * Support for math in RST reader and writer. Inline math uses the
75+ `` :math:`...` `` construct. Display math uses
76+
77+ .. math:: ...
78+
79+ or if the math is multiline,
80+
81+ .. math::
82+
83+ ...
84+
85+ These constructions seem to be supported now by `rst2latex.py`.
86+
87+ * Github syntax for fenced code blocks is now understood in pandoc's
88+ markdown. You can now write
89+
90+ ```ruby
91+ x = 2
92+ ```
93+
94+ instead of
95+
96+ ~~~ {.ruby}
97+ x = 2
98+ ~~~~
99+
100+ * Easier scripting: a new `ToJsonFilter` class makes it easier to
101+ write Haskell scripts to manipulate the Pandoc AST.
102+
103+ [behavior changes]
104+
105+ * Fixed parsing of consecutive lists in markdown.
106+ Pandoc previously behaved like Markdown.pl for consecutive
107+ lists of different styles. Thus, the following would be parsed
108+ as a single ordered list, rather than an ordered list followed
109+ by an unordered list:
110+
111+ 1. one
112+ 2. two
113+
114+ - one
115+ - two
116+
117+ This change makes pandoc behave more sensibly, parsing this as
118+ two lists. Any change in list type (ordered/unordered) or in
119+ list number style will trigger a new list. Thus, the following
120+ will also be parsed as two lists:
121+
122+ 1. one
123+ 2. two
124+
125+ a. one
126+ b. two
127+
128+ Since we regard this as a bug in Markdown.pl, and not something
129+ anyone would ever rely on, we do not preserve the old behavior
130+ even when `--strict` is selected.
131+
132+ * Allow links in markdown image captions. This change also means that
133+
134+ [link with [link](/url)](/url)
135+
136+ will turn into
137+
138+ <p><a href="/url">link with link</a></p>
139+
140+ instead of
141+
142+ <p><a href="/url">link with [link](/url)</a></p>
143+
144+ * Improved handling of citations using `citeproc-hs-0.3.4`.
145+ Added `--citation-abbreviations` option (Andrea Rossato).
146+
147+ * Disallow punctuation as the last letter of a citation key.
148+ This means that '@item1.' will be parsed as a citation, 'item1',
149+ followed by a period, instead of a citation 'item1.', as was the
150+ case previously.
151+
152+ * In HTML output, citations are now put in a span with class `citation`.
153+
154+ * The markdown reader now recognizes DocBook block and inline tags.
155+ It was always possible to include raw DocBook tags in a markdown
156+ document, but now pandoc will be able to distinguish block from
157+ inline tags and behave accordingly. Thus, for example,
158+
159+ <sidebar>
160+ hello
161+ </sidebar>
162+
163+ will not be wrapped in `<para>` tags.
164+
165+ * Dashes work differently with `--smart`: `---` is always em-dash,
166+ and `--` is always en-dash. Pandoc no longer tries to guess when
167+ `-` should be en-dash. *Note:* This may change how existing documents
168+ look when processed with pandoc. A new option, `--old-dashes`,
169+ is provided for legacy documents.
170+
171+ * `--smart` is no longer selected automatically with `man` output.
172+
173+ * The deprecated `--xetex` option has been removed.
174+
175+ * The `--html5`/`-5` option has been deprecated. Use `-t html5`
176+ instead. `html5` and `html5+lhs` are now separate output formats.
177+
178+ * `'` is no longer escaped in HTML output. It does not need to be
179+ escaped outside of attributes.
180+
181+ * The `--ascii` option has been removed, because of differences
182+ in blaze-html's and xhtml's escaping.
183+
184+ * Pandoc will no longer transform leading newlines in code
185+ blocks to `<br/>` tags.
186+
187+ * The ODT writer now sizes images appropriately, using the image
188+ size and DPI information embedded in the image.
189+
190+ * `--standalone` is once again implicitly for a non-text output format
191+ (ODT, EPUB). You can again do `pandoc test.txt -o test.odt`
192+ and get a standalone ODT file.
193+
194+ * The Docbook writer now uses `<sect1>`, `<sect2>`, etc. instead of
195+ `<section>`.
196+
197+ * The HTML writer now uses `<del>` for strikeout.
198+
199+ * In HTML output with `--section-divs`, the classes `section` and
200+ `level[1,2,..6]` are put on the `div` tags so they can be styled.
201+ In HTML 5 output with `--section-divs`, the classes
202+ `level[1,2,...6]` are put on `section` tags.
203+
204+ * EPUB writer changes:
205+
206+ + The `lang` variable now sets the language
207+ in the metadata (if it is not set, we default to the locale
208+ language).
209+ + EPUB: UTF-8 is used rather than decimal entities.
210+
211+ * Added `titleslide` class to title slide in S5 template.
212+
213+ * In HTML, EPUB, and docx metadata, the date is normalized into
214+ YYYY-MM-DD format if possible. (This is required for validation.)
215+
216+ * Attributes in highlighted code blocks are now preserved in HTML.
217+ The container element will have the classes, id, and key-value attributes
218+ you specified in the delimited code block. Previously these were stripped
219+ off.
220+
221+ * The reference backlink in the HTML writer no longer has a special
222+ `footnoteBacklink` class.
223+
224+ * The HTML template has been split into `html` and `html5` templates.
225+
226+ * Author and date are treated more consistently in HTML templates.
227+ Authors are now `<h2>`, date `<h3>`.
228+
229+ * URLs are hyphenated in the ConTeXt writer (B. Scott Michel).
230+
231+ * The markdown writer now uses setext headers for levels 1-2.
232+ The old behavior (ATX headers for all levels) can be restored
233+ using the new `--atx-headers` option.
234+
235+ [bug fixes]
236+
237+ * Better support for combining characters and East Asian wide characters
238+ in markdown and reST.
239+
240+ * Better handling of single quotes with `--smart`.
241+ Previously `D'oh l'*aide*` would be parsed with left and right single
242+ quotes instead of apostrophes. This kind of error is now fixed.
243+
244+ * Highlighting: Use `reads` instead of `read` for better error handling.
245+ Fixes crash on `startNum="abc"`.
246+
247+ * Added blank comment after directives in rst template.
248+
249+ * Unescape entities in citation `refId`. The `refId`s coming
250+ from citeproc contain XML numeric entities, and these don't match with the
251+ citation keys parsed by pandoc. Solution is to unescape them.
252+
253+ * HTML reader: Fixed bug parsing tables with both thead and tbody.
254+
255+ * Markdown reader:
256+
257+ + Better handling of escapes in link URLs and titles.
258+ + Fixed backslash escapes in reference links.
259+ + Fixed bug in table/hrule parsing, by checking that the top
260+ line of a table is not followed by a blank line. This bug caused
261+ slowdowns on some files with hrules and tables, as pandoc tried to
262+ interpret the hrules as the tops of multiline tables.
263+ + Fixed bug in code block attribute parser. Previously the ID attribute
264+ got lost if it didn't come first. Now attributes can come in any order.
265+
266+ * RST reader: allow footnotes followed by newline without space chars
267+ (patch from Masayoshi Takahashi).
268+
269+ * LaTeX reader:
270+
271+ + Ignore empty groups {}, { }.
272+ + LaTeX reader: Handle \@.
273+ + LaTeX reader: Don't crash on commands like `\itemsep`.
274+ + LaTeX reader: Better handling of letter environments.
275+
276+ * RST writer: Fixed bug involving empty table cells. isSimple was being
277+ calculated in a way that assumed there were no non-empty cells.
278+
279+ * ConTeXt writer:
280+
281+ + Made `--toc` work even without `--number-sections`.
282+ + Escape # in link URLs.
283+ + Use buffering for footnotes containing code blocks.
284+ + Changed 'descr' to 'description', fixed alignment.
285+
286+ * LaTeX writer:
287+
288+ + Escape euro character.
289+ + Don't escape ~ inside href{...}.
290+ + Escape # in href URLs.
291+ + Improved detection of book classes. We now check the
292+ `documentclass` variable, and if that is not set, we look through
293+ the template itself. Also, we have added the KOMA classes scrreprt
294+ and scrbook. You can now make a book using
295+ `pandoc -V documentclass:book mybook.txt -o mybook.pdf`
296+ + LHS files now set the "listings" variable, so that the definition
297+ of the `code` environment will be included in the template.
298+ + Links are colored blue by default (this can be changed by
299+ modifying `hyperref` settings in the template).
300+ + Added `lang` variable to LaTeX template.
301+
302+ * HTML writer:
303+
304+ + Fixed bug in HTML template with html5 and mathml.
305+ + Don't use self-closing img, br, hr tags for HTML5.
306+ + Use `<section>` for footnotes if HTML5.
307+ + Update HTML templates to use Content-Style-Type meta tag.
308+ + Use separate variables for meta-date, meta-author.
309+ This makes footnotes work in author and date fields.
310+ + Use 'vertical-align:middle' in WebTeX math for better alignment.
311+
312+ * S5/slidy writer: Make footnotes appear on separate slide at end.
313+
314+ * MIME: Added 'layout-cache' to getMimeType. This ensures that the
315+ META-INF/manifest.xml for ODT files will have everything it needs, so
316+ that ODT files modified by LibreOffice can be used as `--reference-odt`.
317+
318+ * Templates: Return empty string for json template.
319+
320+ * `Text.Pandoc.Biblio`:
321+
322+ + Expand citations recursively inside nested inlines.
323+ + Treat \160 as space when parsing locator and suffix.
324+ This fixes a bug with "p. 33" when `--smart` is used. Previously
325+ the whole "p. 33" would be included in the suffix, with no locator.
326+ + Put whole author-in-text citation in a Cite. Previously just the
327+ date and other info went in the Cite.
328+ + Don't add comma+space to prefix if it ends in punctuation.
329+ (Andrea Rossato)
330+
331+ * Updated chicago-author-date.csl. The old version did not work
332+ properly for edited volumes with no author.
333+
334+ * EPUB writer:
335+
336+ + Add date to EPUB titlepage and metadata.
337+ + Added TOC identifier in EPUB page template.
338+ + Don't generate superfluous file `cover-image.jpg`.
339+
340+ [under the hood improvements]
341+
342+ * Modified make_osx_package.sh to use cabal-dev.
343+
344+ * Modified windows installer generater to use cabal-dev.
345+
346+ * Fixed make_osx_package.sh. Items no longer installed as root.
347+ Man page zipped and given proper permissions.
348+
349+ * Setup: Making man pages now works with cabal-dev. In Setup.hs we now
350+ invoke 'runghc' in a way that points it to the correct package databases,
351+ instead of always falling back to the default user package db. (Thanks to
352+ Antoine Latter.)
353+
354+ * Updated to work with GHC 7.4 (Antoine Latter).
355+
356+ * Removed dependency on old-time.
357+
358+ * DZSlides: Added dzslides/template.html. This is the unaltered file from
359+ the dzslides repository. Pandoc now reads it, looking for the core part,
360+ and includes this in the new dzslides template via the 'dzslides-core'
361+ variable. When dzslides is updated, you can just put the new template.html
362+ in your `~/.pandoc/dzslides` directory, and things should work -- provided
363+ the core part can be identified as everything from
364+
365+ <!-- {{{{ dzslides core
366+
367+ to the end of the file. This should make it a bit easier to keep up
368+ to date.
369+
370+ * New slidy directory for "self-contained."
371+
372+ * LaTeX parser completely rewritten; it is now much more accurate,
373+ robust, and extensible.
374+
375+ * Simplified `Text.Pandoc.Biblio`, removed `procInlines`, used
376+ generics instead.
377+
378+ * TeXMath writer: Use unicode thin spaces for thin spaces.
379+ Partially resolves issue #333.
380+
381+ * Markdown citations: don't strip off initial space in locator.
382+
383+ [API changes]
384+
385+ * Removed `Apostrophe`, `EmDash`, `EnDash`, and `Ellipses`
386+ from the native `Inline` type in pandoc-types. Now we use `Str`
387+ elements with unicode.
388+
389+ * Improvements to `Text.Pandoc.Builder`:
390+
391+ + `Inlines` and `Blocks` are now newtypes (not synonyms for
392+ sequences).
393+ + Instances are defined for `IsString`, `Show`, `Read`, `Monoid`,
394+ and a new `Listable` class, which allows these to be manipulated
395+ to some extent like lists. Monoid append includes automatic
396+ normalization.
397+ + `+++` has been replaced by `<>` (mappend).
398+
399+ * Use blaze-html instead of xhtml for HTML generation.
400+ This changes the type of `writeHtml`.
401+
402+ * `Text.Pandoc.Shared`:
403+
404+ + Added `warn` and `err`.
405+ + Removed `unescapeURI`, modified `escapeURI`.
406+ (See under [behavior changes], above.)
407+
408+ * Changes in URI escaping: Previously the readers escaped URIs by
409+ converting unicode characters to octets and then percent encoding.
410+ Now unicode characters are left as they are, and `escapeURI` only
411+ percent-encodes space characters. This gives more readable
412+ URIs, and works well with modern user agents. URIs are no longer unescaped
413+ at all on conversion to `markdown`, `asciidoc`, `rst`, `org`.
414+
415+ * New module `Text.Pandoc.SelfContained`.
416+
417+ * New module `Text.Pandoc.Docx`.
418+
419+ * New module `Text.Pandoc.PDF`.
420+
421+ * Added `writerBeamer` to `WriterOptions`.
422+
423+ * Added `normalizeDate` to `Text.Pandoc.Shared`.
424+
425+ * Added `splitStringWithIndices` in `Text.Pandoc.Shared`.
426+ This is like `splitWithIndices`, but it is sensitive to distinctions
427+ between wide, combining, and regular characters.
428+
429+ * `Text.Pandoc.Pretty`:
430+
431+ + Added `chomp` combinator.
432+ + Added `beforeNonBreak` combinator. This allows you to include
433+ something conditionally on it being before a nonblank.
434+ Used for RST inline math.
435+ + Added `charWidth` function. All characters marked W or F in the unicode
436+ spec EastAsianWidth.txt get width 2.
437+ + Added `realLength`, based on `charWidth`. `realLength` is now
438+ used in calculating offsets.
439+
440+ * New module `Text.Pandoc.Slides`, for common functions for breaking
441+ a document into slides.
442+
443+ * Removed `Text.Pandoc.S5`, which is no longer needed.
444+
445+ * Added `Text.Pandoc.ImageSize`. This is intened for use
446+ in `docx` and `odt` writers, so the size and dpi of images
447+ can be calculated.
448+
449+ * Removed `writerAscii` in `WriterOptions`.
450+
451+ * Added `writerHighlight` to `WriterOptions`.
452+
453+ * Added `DZSlides` to `HTMLSlideVariant`.
454+
455+ * `writeEPUB` has a new argument for font files to embed.
456+
457+ * Added `stateLastStrPos` to `ParserState`. This lets us keep track
458+ of whether we're parsing the position immediately after a regular
459+ (non-space, non-symbol) string, which is useful for distinguishing
460+ apostrophes from single quote starts.
461+
462+ * `Text.Pandoc.Parsing`:
463+
464+ + `escaped` now returns a `Char`.
465+ + Removed `charsInBalanced'`, added a character parser as
466+ a parameter of `charsInBalanced`. This is needed for
467+ proper handling of escapes, etc.
468+ + Added `withRaw`.
469+
470+ * Added `toEntities` to `Text.Pandoc.XML`.
471+
472+ * `Text.Pandoc.Readers.LaTeX`:
473+
474+ + Export `handleIncludes`.
475+ + Export `rawLaTeXBlock` instead of `rawLaTeXEnvironment'`.
476+
477+ * Added `ToJsonFilter` class and `toJsonFilter` function to
478+ `Text.Pandoc`, deprecating the old `jsonFilter` function.
479+
480+ * `Text.Pandoc.Highlighting`:
481+
482+ + Removed `highlightHtml`, `defaultHighlightingCss`.
483+ + Export `formatLaTeXInline`, `formatLaTeXBlock`, and `highlight`, plus
484+ key functions from highlighting-kate.
485+ + Changed types of highlighting function. `highlight` returns a
486+ `Maybe`, not an `Either`.
487+
1488pandoc (1.8.2.1)
2489
3490 * Relaxed cabal consntraints for test-framework (S. Trofimovich).