⚠️ This package is currently undergoing a rewrite⚠️
A library for working with Org files. Specifically, this provides utilities for:
- Parsing Org text to an AST (Abstract Syntax Tree)
- Regenerating Org text from an AST
- Basic manipulation and analysis of an Org document AST
- Generating basic representations Org content in the terminal, and a few other forms.
With the exception of some of the particularly fancy capabilities provided by
org-mode (like Babel and Calc-based spreadsheeting), this project aims to
exactly match the interpretation of Org mode markup — specifically the AST
generated by org-element.el. This goal is not yet achieved, however
the bulk of the work is now complete.
Org.jl implements the vast majority of the org-syntax document (see the
Progress table). This can be checked by looking at Org.compatability in
Julia.
TODO
| Component | Type | Lex | Parse | Org | Term | HTML |
|---|---|---|---|---|---|---|
| Heading | X | |||||
| Section | - | |||||
| GreaterBlock | X | |||||
| Drawer | X | |||||
| DynamicBlock | X | |||||
| FootnoteDefinition | X | |||||
| InlineTask | - | - | - | - | - | - |
| Item | X | |||||
| List | - | |||||
| PropertyDrawer | X | |||||
| Table | X | |||||
| BabelCall | - | |||||
| Block | X | |||||
| Clock | X | |||||
| DiarySexp | X | |||||
| Planning | X | |||||
| Comment | X | |||||
| FixedWidth | X | |||||
| HorizontalRule | X | |||||
| Keyword | X | |||||
| Affiliated Keywords | - | |||||
| LaTeX Environment | X | |||||
| NodeProperty | X | |||||
| Paragraph | X | |||||
| TableRow | X | |||||
| TableHRule | X | |||||
| BlankLine | ||||||
| OrgEntity | X | |||||
| LaTeX Fragment | X | |||||
| ExportSnippet | X | |||||
| FootnoteReference | X | |||||
| InlineBabelCall | ||||||
| InlineSrcBlock | ||||||
| RadioLink | ||||||
| PlainLink | ||||||
| AngleLink | ||||||
| RegularLink | ||||||
| LineBreak | ||||||
| Macro | ||||||
| Citation | ||||||
| RadioTarget | ||||||
| Target | ||||||
| StatisticsCookie | ||||||
| Subscript | ||||||
| Superscript | ||||||
| TableCell | X | |||||
| Timestamp | ||||||
| TextMarkup | X | |||||
| TextPlain |