Next:Context Dependent Documentation, Previous:Regular Expressions, Up:Miscellaneous [Contents][Index]
A reference document providing a formal description of Org’s syntax isavailable asa draft on Worg, initially written by Nicolas Goaziou.It defines Org’s core internal concepts such as “headlines”,“sections”, “affiliated keywords”, “(greater) elements” and “objects”.Each part of an Org document belongs to one of the previouscategories.
To explore the abstract structure of an Org buffer, run this ina buffer:
M-: (org-element-parse-buffer) <RET>
It outputs a list containing the buffer’s content represented as anabstract structure. The export engine relies on the informationstored in this list. Most interactive commands—e.g., for structureediting—also rely on the syntactic meaning of the surroundingcontext.
You can probe the syntax of your documents with the command
M-x org-lint <RET>
It runs a number of checks to find common mistakes. It then displaystheir location in a dedicated buffer, along with a description anda “trust level”, since false-positive are possible. From there, youcan operate on the reports with the following keys:
| C-j,TAB | Display the offending line |
| RET | Move point to the offending line |
| g | Check the document again |
| h | Hide all reports from the same checker |
| i | Also remove them from all subsequent checks |
| S | Sort reports by the column at point |