org_parser library

Classes

OrgBlock
A block, like
A bracketed link, like
OrgContent
A generic node that contains children
OrgContentGrammarDefinition
Content grammar definition
OrgContentParserDefinition
Content-level parser definition
OrgDocument
The top-level node representing a full Org document
OrgDrawer
A drawer, like
OrgEntity
An entity, like \Omega
A link to a file, like
OrgFileLinkGrammarDefinition
Grammar rules for file links, which are basically a mini-format of their own
OrgFileLinkParserDefinition
File link parser definition
OrgFixedWidthArea
A fixed-width area, like
OrgFootnote
A footnote, like
OrgFootnoteReference
A footnote reference, like [fn:1]
OrgGrammarDefinition
Top-level grammar definition
OrgHeadline
An Org headline, like
OrgKeyword
A planning keyword, like SCHEDULED: or DEADLINE:
OrgLatexBlock
A LaTeX block, like
OrgLatexInline
An inline LaTeX snippet, like $E=mc^2$
OrgLeafNode
A link, like
OrgList
A list, like
OrgListItem
OrgListOrderedItem
An ordered list item, like
OrgListUnorderedItem
An unordered list item, like
OrgLocalVariables
OrgMacroReference
A macro reference, like
OrgMarkup
Emphasis markup, like
OrgMeta
A "meta" line, like
OrgNode
The base type of all Org AST objects
OrgParagraph
OrgParentNode
OrgParserDefinition
Top-level parser definitions
OrgPlainText
Plain text that has no markup
OrgPlanningLine
A planning line, like
OrgProperty
A property in a drawer, like
OrgSection
An Org section. May have nested sections, like
OrgSrcBlock
A source block, like
OrgTable
A table, like
OrgTableCell
OrgTableCellRow
OrgTableDividerRow
OrgTableRow
OrgTimestamp
A timestamp, like [2020-05-05 Tue]
OrgTree
A node potentially containing OrgSections

Extensions

ZipperExt

Properties

org → Parser
The top-level Org parser
final
File link parser
final

Functions

isOrgCustomIdUrl(String url) → bool
Identify URLs that point to a custom ID (starting with '#').
isOrgIdUrl(String url) → bool
Identify URLs that point to IDs (starting with 'id:').
isOrgLocalSectionUrl(String url) → bool
Identify URLs that point to a section within the current document (starting with '*')
parseOrgCustomIdUrl(String url) → String
Return the CUSTOM_ID of the section pointed to by the URL. The URL must be one for which isOrgCustomIdUrl returns true.
parseOrgIdUrl(String url) → String
Return the ID of the section pointed to by the URL. The URL must be one for which isOrgCustomIdUrl returns true.
parseOrgLocalSectionUrl(String url) → String
Return the title of the section pointed to by the URL. The URL must be one for which isOrgLocalSectionUrl returns true.

Enums

OrgStyle
Supported styles for OrgMarkup nodes

Typedefs

OrgPath = List<OrgNode>
OrgZipper = ZipperLocation<OrgNode, OrgLeafNode, OrgParentNode>