Welcome!

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

• What's Finished
• Building

You can find the package on Hackage.

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:

• Headlines
  • State keywords
  • Priority indicator
  • Title
  • Status / progress indicator
  • Tag list
• Property drawers
• State keyword changelogs
• Scheduled and deadline timestamps (timestamp, range, duration, periodicity)
  • Active and inactive timestamps
• 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)

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
$ cabal build

Projects that use this package:

https://github.com/volhovm/orgstat

License

BSD3 Open Source Software License