pandoc (0.4) unstable; urgency=low [ John MacFarlane ] * Added two new output formats: groff man pages and ConTeXt. By default, output files with extensions ".ctx" and ".context" are assumed to be ConTeXt, and output files with single-digit extensions are assumed to be man pages. * Enhanced ordered lists (documented in README, under Lists): + The OrderedList block element now stores information about list 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 kinds of tables are supported: a simple table with one-line rows, and a more complex variety with multiline rows. All output formats are supported, but only markdown tables are parsed at the moment. The syntax is documented in README. * Added support for definition lists (with a new DefinitionList block element). All output and input formats are supported. The syntax is documented in README. * Added support for superscripts and subscripts (with new Superscript and Subscript inline elements). All input and output formats. The syntax is documented in README. * Added support for strikeout (with a new Strikeout inline element). All input and output formats are supported. Thanks to Bradley Kuhn, who contributed a patch. The syntax is documented in README. Resolves Issue #18. * Added a --toc|--table-of-contents option. This causes an automatically generated table of contents (or an instruction that creates one) to be inserted at the beginning of the document. Not supported in S5, DocBook, or man page writers. * Modified the -m|--asciimathml option: + If an optional URL argument is provided, a link is inserted instead of the contents of the ASCIIMathML.js script. + Nothing is inserted unless the document actually contains LaTeX math. * Removed Blank block element as unnecessary. * Removed Key and Note blocks from the Pandoc data structure. All links are now stored as explicit links, and note contents are stored with the (inline) notes. + All link Targets are now explicit (URL, title) pairs; there is no longer a 'Ref' target. + Markdown and RST parsers now need to extract data from key and note blocks and insert them into the relevant inline elements. Other parsers have been simplified, since there is no longer any need to construct separate key and note blocks. + Markdown, RST, and HTML writers need to construct lists of notes; Markdown and RST writers need to construct lists of link references (when the --reference-links option is specified); and the RST writer needs to construct a list of image substitution references. All writers have been rewritten to use the State monad when state is required. + Several functions (generateReference, keyTable, replaceReferenceLinks, replaceRefLinksBlockList, and some auxiliaries used by them) have been removed from Text.Pandoc.Shared, since they are no longer needed. New functions and data structures (Reference, isNoteBlock, isKeyBlock, isLineClump) have been added. The functions inTags, selfClosingTag, inTagsSimple, and inTagsIndented have been moved to the DocBook writer, since that is now the only module that uses them. NoteTable is now exported in 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 everything needed for most uses of Pandoc libraries. The haddock documentation includes a short example program. * Text.Pandoc.ASCIIMathML is no longer an exported module. * Added Text.Pandoc.Blocks module to help in printing markdown and RST tables. This module provides functions for working with fixed-width blocks of text--e.g., placing them side by side, as in a table row. * Refactored to avoid reliance on Haskell's Text.Regex library, which (a) is slow, and (b) does not properly handle unicode. This fixed some 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 use regexs. + In Markdown reader, replaced email regex test with a custom email autolink parser (autoLinkEmail). Also replaced selfClosingTag regex with a custom function isSelfClosingTag. + Modified Docbook writer so that it doesn't rely on Text.Regex for detecting 'mailto' links. + Removed escapePreservingRegex and reamped entity-handling functions in Text.Pandoc.Shared and Text.Pandoc.CharacterReferences to avoid reliance on Text.Regex (see below on character reference handling changes). * Renamed Text.Pandoc.Entities as Text.Pandoc.CharacterReferences. * Changed handling of XML entities. Entities are now parsed (and unicode characters returned) in the Markdown and HTML readers, rather than being handled in the writers. In HTML and Docbook writers, UTF-8 is now used instead of entities for characters above 128. This makes the HTML and DocBook output much more readable and more easily editable. + Removed sgmlHexEntity, sgmlDecimalEntity, sgmlNamedEntity, and sgmlCharacterEntity 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 of Text.Regex. + Added new charRef parser for Markdown and HTML, which replaces the old 'entity' parser. Added '&' as a special character in Markdown reader. + Modified HTML and Markdown readers to call decodeEntities on all raw strings (e.g. authors, dates, link titles), to ensure that no unprocessed entities are included in the native representation of the document. (In the HTML reader, most of this work is done by a change in extractAttributeName.) + In XML and Markdown output, escape unicode nonbreaking space as ' ', since a unicode non-breaking space is impossible to distinguish visually from a regular space. (Resolves Issue #3.) + Removed encodeEntitiesNumerical. + Use Data.Map for entityTable and (new) reverseEntityTable, for a slight performance boost over the old association list. + Removed unneeded decodeEntities from 'str' parser in HTML and Markdown readers. * Text.Pandoc.UTF8: Renamed encodeUTF8 to toUTF8, decodeUTF8 to fromUTF8, for clarity. * Replaced old haskell98 module names replaced by hierarchical module names, e.g. List by Data.List. Removed haskell98 from dependencies in pandoc.cabal, and added mtl (needed for state monad). Substituted xhtml for html. * Refactored and cleaned up character escaping in writers, using backslashEscapes and escapeStringUsing functions. * Instead of adding "\n\n" to the end of an input string in Main.hs, this is now done in the readers. This makes the libraries behave the way you'd expect from the pandoc program. Resolves Issue #10. * URLs and email addresses in autolinks are now typeset as Code. * In Main.hs, changed putStr to putStrLn -- mainly because MacOS X doesn't display the whole output unless there's a line ending. * Major code cleanup in all modules, for greater consistency, concision, and readability. * HTML reader: + Fixed several bugs (extractTagType, attribute parsing). + Remove Null blocks in lists of blocks when possible. * Markdown reader: + Ordered list items may no longer begin with uppercase letters, or letters greater than 'n'. (This prevents first initials and page reference, 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 changes may cause documents to be parsed differently. Users should take care in upgrading. + Changed autoLink parsing to conform better to Markdown.pl's behavior. is not treated as a link, but , , and are. + Cleaned up handling of embedded quotes in link titles. Now these are stored 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. This yields a slight performance boost. + Fixed several bugs in smart quote recognition. + Fixed bug in indentSpaces (which didn't properly handle cases with mixed spaces and tabs). + Consolidated 'text', 'special', and 'inline' into 'inline'. + Fixed bug which allowed URL and title to be separated by multiple blank lines in links and reference keys. They can be on separate lines but can't have blank lines between them. + Correctly handle bracketed text inside inline footnotes and links,using new function inlinesInBalanced. Resolves Issue #14. + Fixed bug in footnotes: links in footnotes were not being processed. Solution: three-stage parse. First, get all the reference keys and add information to state. Next, get all the notes and add information to state. (Reference keys may be needed at this stage.) Finally, parse everything else. + Replaced named constants like 'emphStart' with literals. + Removed an extra occurance of escapedChar in definition of inline. * RST reader: + Allow the URI in a RST hyperlink target to start on the line after the reference key. + Added 'try' in front of 'string', where needed, or used a different parser. This fixes a bug where ````` would not be correctly parsed as a verbatim `. + Fixed slow performance in parsing inline literals in RST reader. The problem 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. Removed unneeded getState call, since lookAhead automatically saves and restores the parser state. + Allow hyperlink target URIs to be split over multiple lines, and to start on the line after the reference. Resolves Issue #7. + Fixed handling of autolinks. * LaTeX reader: + Replaced 'choice [(try (string ...), ...]' idiom with 'oneOfStrings', for clarity. + Added clauses for tilde and caret. Tilde is \ensuremath{\sim}, and caret is \^{}, not \^ as before. + Added parsing for \url. * HTML writer: + Modified HTML writer to use the Text.XHtml library. This results in cleaner, faster code, and it makes it easier to use Pandoc in other projects, like wikis, which use Text.XHtml. Two functions are now provided, writeHtml and writeHtmlString: the former outputs an Html structure, the latter a rendered string. The S5 writer is also changed, in parallel ways (writeS5, writeS5String). + The Html header is now written programmatically, so it has been removed from the 'headers' directory. The S5 header is still needed, but the doctype and some of the meta declarations have been removed, since they are written programatically. This change introduces a new dependency on the xhtml package. + Fixed two bugs in email obfuscation involving improper escaping of '&' in the