changelog shortlog graph tags branches changeset files revisions annotate raw help

Mercurial > org > docs / core/lib/organ.org

changeset 13: 26a97fc6dcda
parent: d0a90a87b824
child: bc53e27c0163
author: ellis <ellis@rwest.io>
date: Wed, 13 Dec 2023 20:01:01 -0500
permissions: -rw-r--r--
description: doc updates 
     1 {{{header(organ,Richard Westhaver,ellis@rwest.io)}}}
     2 
     3 This is a modular tool for extracting information from emacs org-mode
     4 files. It's highly opinionated and only suited for parsing my
     5 documents. This means I may introduce syntax which is not supported by
     6 or which can't be interpreted by Emacs Org-Mode. It also means that
     7 /the complete Org-element API will not be supported/. The most
     8 troublesome of org-mode features are simply ignored.
     9 
    10 This project is driven by the idea that org-mode is pretty cool, but
    11 that previous attempts to build a robust parser implementation have
    12 been hindered by their attempts to clone the functionality as well.
    13 
    14 - *Goals*
    15   - org->sxp :: takes org-mode stream outputs SXP forms
    16   - parallel :: take advantage of multi-threading to parse multiple
    17     trees simultaneously
    18   - composable :: specialized methods for combining and composing
    19     org-mode nodes