MIT licensed by Albert Krewinkel
Maintained by tarleb@zeitkraut.de

Module documentation for 1.0.0

This version can be pinned in stack with:jira-wiki-markup-1.0.0@sha256:24484791e650c80c452348e2523decc9a410aa965f79c0734c1e257f93b25cd1,3576

jira-wiki-markup

Hackage MIT license Stackage Lts Stackage Nightly Build status Windows build status

This package provides a parser and printer for Jira wiki markup. It converts the raw text into an abstract syntax tree. The tree is easy to handle and to translate into different output formats.

License

This package is licensed under the MIT license. See the LICENSE file for details.

Changes

Changelog

jira-wiki-markup uses PVP Versioning. The changelog is available on GitHub.

1.0.0

Released 2019-12-17.

  • Add Doc datatype representing a full document; parse now returns this type.
  • Improve parsing:
    • double-backslash is recognized as linebreak;
    • emoticons are parsed as Emoji;
    • special sequences of dashes are translated into their unicode representation;
    • naked URLs are parsed as AutoLink;
    • blocks of colored text are parsed as Color;
    • interpretation of special characters as markup can be forced by surrounding them with curly braces.
  • A parser plainText was added available to read markup-less text.
  • Inline-parser symbol was renamed to specialChar.
  • Add printer module to render the document AST as Jira markup.
  • Markup datatype changes:
    • new Block elements Color and HorizontalRule.
    • new Inline elements Emoji, and Styled.
    • Inline constructors Subscript, Superscript, Emph, Strong, Inserted, and Deleted have been remove. Use Styled instead.
    • Constructor Image now takes a list of parameters as an additional argument.
  • CI runs also test GHC 8.8.

0.1.1

  • Ensure proper parsing of backslash-escaped characters.

0.1.0

  • Initially created.
Used by 2 packages in nightly-2020-02-14(full list with versions):