The orgmode-parse package

[ Tags: bsd3, data, library ] [ Propose Tags ]

orgmode-parse is a parsing library for the org-mode flavor of document markup.

The provided Attoparsec combinators parse the human-readable and textual representation into a simple AST for storage or output to another format (HTML? Markdown?).


[Skip to Readme]

Properties

Versions 0.0.0.1, 0.0.0.2, 0.0.0.3, 0.0.1.0, 0.0.1.1, 0.0.1.2, 0.0.2.0, 0.0.2.1, 0.1.0, 0.1.0.1, 0.1.0.2, 0.1.0.3, 0.1.0.4, 0.1.1.0, 0.1.1.1, 0.1.1.2, 0.1.1.3, 0.2.0
Change log CHANGELOG.md
Dependencies aeson (>=0.11), attoparsec (>=0.13), base (>=4.8 && <5), bytestring (>=0.10.4), containers (>=0.5.6), free (>=4.9), hashable (>=1.2), old-locale (>=1.0), text (>=1.2), thyme (>=0.3), unordered-containers (>=0.2.7) [details]
License BSD3
Author Parnell Springmeyer <parnell@digitalmentat.com>
Maintainer Parnell Springmeyer <parnell@digitalmentat.com>
Category Data
Source repository head: git clone https://github.com/digitalmentat/orgmode-parse
Uploaded Sun Aug 27 09:31:17 UTC 2017 by ParnellSpringmeyer
Distributions NixOS:0.2.0
Downloads 2374 total (34 in the last 30 days)
Rating 0.0 (0 ratings) [clear rating]
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2017-08-27 [all 1 reports]
Hackage Matrix CI

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for orgmode-parse-0.2.0

[back to package description]

Welcome!

Hackage Version Travis CI Status

orgmode-parse provides a top-level parser and collection of attoparsec parser combinators for org-mode structured text.

What's Finished

We have built attoparsec parsers for parsing org-mode document structures and meta-data. Here is a list of all the syntax features that have a complete parsing implementation and not:

  • [X] Headlines
    • [X] State keywords
    • [X] Priority indicator
    • [X] Title
    • [X] Status / progress indicator
    • [X] Tag list
  • [X] Property drawers
  • [X] State keyword changelogs
  • [X] Scheduled and deadline timestamps (timestamp, range, duration, periodicity)
    • [X] Active and inactive timestamps
  • [X] Clock timestamps
  • [ ] Markup
    • [ ] Emphasis
      • [ ] Bold
      • [ ] Italic
      • [ ] Strikethrough
      • [ ] Underline
      • [ ] Superscript
      • [ ] Subscript
      • [ ] Code / monospaced
    • [ ] Tables
    • [ ] Lists
      • [ ] Unordered lists
      • [ ] Numbered lists
      • [ ] Checkbox modified lists
    • [ ] Blocks (src / quote / example blocks)

Parsing org-mode markup is currently being worked on.

What's Planned (outside of what's not finished)

  1. Modernizing this library and adding significantly more documentation to it
  2. Writing a sister library, orgmode-pretty, providing a pretty printer implementation for an org-mode AST
  3. Pandoc integration

Building

There are a few ways to build this library if you're developing a patch:

  • stack build && stack test, and
  • nix-build --no-out-link --attr orgmode-parse release.nix

You can also use the nix-shell provided cabal environment for incremental development:

$ nix-shell --attr orgmode-parse.env release.nix
$ cabal build

License

BSD3 Open Source Software License