org-mode: Parser for Emacs org-mode files.

[ bsd3, data, library ] [ Propose Tags ]

Parser for Emacs org-mode files.


[Skip to Readme]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 1.0.0, 1.0.1, 1.1.0, 1.1.1, 2.0.0, 2.0.1
Change log CHANGELOG.md
Dependencies base (>=4.12 && <5), containers (>=0.6), filepath, hashable (>=1.2 && <1.4), megaparsec (>=7 && <10), parser-combinators (>=1.1 && <1.3), text, time (>=1.9) [details]
License BSD-3-Clause
Copyright 2020 - 2021 Colin Woodbury
Author Colin Woodbury
Maintainer colin@fosskers.ca
Category Data
Home page https://github.com/fosskers/org-mode
Uploaded by fosskers at 2021-06-04T18:50:35Z
Distributions NixOS:2.0.1
Downloads 922 total (33 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2021-06-04 [all 1 reports]

Readme for org-mode-2.0.0

[back to package description]

org-mode

org-mode is a library for parsing text in the Emacs org-mode format.

Assumptions

  • File metadata like In-buffer Settings appears at the top of the file.
  • Special timestamps like DEADLINE always appear in the order CLOSED, DEADLINE, then SCHEDULED if present together.
  • If there are both a special timestamp and a regular timestamp present, the regular timestamp must appear on the next line (this is how Emacs itself inserts them).

Specification Coverage

Basic styling:

Feature Parses?
Bold / Italics / etc. Yes
URLs / Images Yes
Lists Yes

Headings:

Feature Parses?
Nesting Yes
TODO Yes
Priorities Yes
Tags Yes
Timestamps Yes
PROPERTIES Yes

Tables:

Feature Parses?
Basic Yes
Formulas No
Properties No

Blocks:

Feature Parses?
Quotes Yes
Examples Yes
Source Code Yes
Center No
Comment No
Export No
Verse No