File: org-element.el.html

See <https://orgmode.org/worg/dev/org-syntax.html> for details about Org syntax.

Lisp-wise, a syntax object can be represented as a list. It follows the pattern (TYPE PROPERTIES CONTENTS), where:
  TYPE is a symbol describing the object.
  PROPERTIES is the property list attached to it. See docstring of
             appropriate parsing function to get an exhaustive list.
  CONTENTS is a list of syntax objects or raw strings contained
           in the current object, when applicable.

For the whole document, TYPE is org-data and PROPERTIES is nil.

The first part of this file defines constants for the Org syntax, while the second one provide accessors and setters functions.

The next part implements a parser and an interpreter for each element and object type in Org syntax.

The following part creates a fully recursive buffer parser. It also provides a tool to map a function to elements or objects matching some criteria in the parse tree. Functions of interest are org-element-parse-buffer, org-element-map and, to a lesser extent, org-element-parse-secondary-string.

The penultimate part is the cradle of an interpreter for the obtained parse tree: org-element-interpret-data.

The library ends by furnishing org-element-at-point function, and a way to give information about document structure around point with org-element-context. A cache mechanism is also provided for these functions.

Defined variables (1)

Defined functions (0)

Defined faces (0)