Expand description
Org 9.8 syntax the tracker has to get right.
An issues.org is an ordinary Org document. The verbs treat a top-level
TODO heading as an issue; everything else in the file is still Org, and a
construct Org would not treat as a headline or a property drawer must not
become one here.
The rules follow the Org 9.8 manual: https://orgmode.org/manual/.
Structs§
- Block
Nest - Nesting of greater blocks (
#+BEGIN_SRC…#+END_SRC) and dynamic blocks (#+BEGIN: clocktable…#+END:). - Headline
Bits - The pieces Org puts on a headline after the stars (manual 2.1, 5.1, 5.4).
- OrgScan
- Walk that hides both greater/dynamic blocks and Org Babel result regions (manual 16).
- Priority
Spec - File-local priority cookie range (
#+PRIORITIES: highest lowest default). - SrcBlock
Head - The
#+BEGIN_SRC lang switches :headersline (manual 16.2). - TagSettings
- File-level tag, export, and publish settings (manual 6, 13.2, 17.8).
- TagSpec
- A declared tag on
#+TAGS:, with an optional fast-selection key.
Constants§
- COMPUTED_
SPECIALS - Org specials that are computed. Writing them in a drawer does not set them; Org reads the headline, the planning line, or the clock.
- HOUSE_
PRIORITIES_ LINE - House
#+PRIORITIES:: highestA, lowestC, defaultC. - HOUSE_
TAGS_ LINES - House
#+TAGS:lines: types are mutually exclusive; the rest are loose. - PLANNING_
KEYS - Keywords Org writes on the planning line, in the order Org writes them.
- PROTOCOL_
KEYWORD - In-buffer keyword that carries
PROTOCOL_VERSION. - PROTOCOL_
VERSION - On-disk
issues.orgcontract. Independent of the crate version and of the control-socket protocol. - SETTABLE_
SPECIALS - Org specials a heading may set.
CATEGORYandARCHIVEare the ones the agenda actually honours from the drawer.
Functions§
- blocker_
ids_ from_ properties - Every blocker id a heading declares:
:BLOCKED_BY:, a typo:BLOCKEDBY:, a:BLOCKER:that is just ids, andids(...)inside an org-edna form. - edna_
blocker_ id_ refs - Issue ids mentioned in an org-edna
ids(...)/id(...)form. - edna_
blocker_ ids - Issue ids mentioned in an org-edna
ids(...)/id(...)form. - effort_
from_ properties - Effort value Org’s column view and agenda effort filter read.
org-effort-propertydefaults toEffort. - ensure_
org_ preamble - Insert the house in-buffer settings a hand-started file never grew.
- filetags_
from_ preamble - Tags from
#+FILETAGS:(manual 6 / in-buffer settings). - inline_
call_ names - Inline
call_name(args)/call_name[hdr](args)(manual 16.5). - inline_
src_ spans - Inline
src_lang{body}/src_lang[headers]{body}(manual 16.2). - is_
affiliated_ keyword - Affiliated keyword that binds to the next element (manual 16.3, org-element).
- is_
babel_ call #+CALL: name(...)(manual 16.5 / Library of Babel).- is_
edna_ blocker - Whether a
:BLOCKER:value is org-edna / org-depend syntax, not a list of issue ids. GNU ELPA org-edna is the maintained package; org-depend in org-contrib is the older one. Both own this name. - is_
gcal_ event_ id - An org-gcal event id (
<event>/<calendar>), not an org-id / vissue id. - is_
headline - A line Org reads as a headline: one or more stars at column 0, then a space.
- is_
issue_ headline - A top-level heading that is an issue: recognised TODO keyword, not COMMENT.
- is_
org_ effort - A duration Org accepts for Effort:
1:30,2h,3d,0:10. - is_
org_ tag_ char - Whether
cmay appear in an Org tag ([[:alnum:]_@#%]+). - is_
planning_ line - Whether
trimmedopens a planning line (any planning key and a colon). - is_
results_ keyword #+RESULTS:/#+RESULTS[hash]:/#+RESULTS: name(manual 16.6).- is_
top_ level_ headline - A level-one headline:
*at column 0. That is an issue site. - merge_
setupfile_ settings - In-buffer settings from
#+SETUPFILE:plus the file’s own preamble. - noweb_
refs - Noweb references
<<name>>/<<name(args)>>(manual 16.11). - opens_
a_ drawer :NAME:alone on a line, which is how every drawer opens (manual 2.7).- org_
link_ targets - Ids named by Org links in
bodythat also sit inknown_ids. - org_
property_ is_ set - Org treats a non-empty property other than
nil/0as true. - parse_
header_ args :key valuepairs from a header-args string (manual 16.3).- parse_
headline_ bits - Split the text after
*into keyword, priority, COMMENT, and title. - parse_
planning_ line - Read an Org planning line into
KEY -> timestamppairs. - parse_
priority_ cookie - Split a leading
[#A]cookie off a heading. Any other shape yieldsNone. - parse_
src_ begin - Parse a source-block opening line. Other greater blocks yield
None. - preamble_
has_ keyword - Whether the preamble already carries
#+NAME:. - priorities_
from_ preamble #+PRIORITIES:from the preamble, orA C C.- property_
key_ and_ append - Property key as written, with a trailing
+(append) stripped. - protocol_
from_ preamble - Protocol integer from
#+VISSUE:, when the line parses. - settle_
heading_ classifiers - Move classifiers Org can hold onto the heading: a legal
:TYPE:and any legal token in:VISSUE_TAGS:. Hyphenated leftovers stay in the property.:TYPE:itself is kept so export and--typefilters still read it. - split_
id_ list - Split a BLOCKED_BY-style id list: commas and whitespace both separate.
- split_
statistics_ cookies - Split trailing statistics cookies (
[2/5],[33%]) off a title. - tag_
settings_ from_ preamble - Parse
#+FILETAGS:,#+TAGS:,#+SELECT_TAGS:,#+EXCLUDE_TAGS:. - take_
timestamp - Consume one Org timestamp or timestamp range at the start of
s. - todo_
keywords_ from_ lines - Same as
todo_keywords_from_preamble, from already-split lines. - todo_
keywords_ from_ preamble - File-local TODO keywords from
#+TODO:lines, plus the house set.