API Reference
deixis-query-notes
One safe structured record per selected annotation. Page queries follow native body order; the unfiltered catalogue follows source order. Call inside context.
Setup Required
Returns: array of records.
Example
#context deixis-query-notes(page: here().page())
Page queries include standalone bodies and require complete unique live spans. order: “source” / “body” and include-unpaired override automatic defaults. Each record retains all shared marks, safe summaries and optional body metadata; no live body content is returned.
deixis-query-notes
deixis-query-notes(target: auto, thread: auto, include-types: auto, exclude-types: (), series: auto, include-unpaired: auto, after: none, before: none, page: auto, order: auto)
Returns one structured record per selected annotation without rendering it. Call inside context. Use the records for tables, cards, or occurrence indexes; deixis-note-outline is the ready-made outline presentation of the same data.
Each record has id, data, accent, type, series, count, marker, styles, loc, dest, order, summary, marks, and body. Summary content is extracted statically. Marks is an array of original/reused locations with destinations, types, occurrence names, source orders, and safe summaries. Body is none or a declaration record with declaration loc/order, render-order (none without a unique live start), dest (none until painted), complete start/end locations, and summary. Accent is the saved palette color or none; explicit component styles may override its appearance without changing that semantic color. Executable note bodies and marked passages are never returned or replayed. Data is the author’s opaque dictionary, inherited from the original or supplied by a standalone body. It is returned unchanged, never traversed or rendered by the query; custom content/callbacks in data remain the caller’s. Optional page selects complete live body spans on one physical page, including continuations. Page queries default to native body order and include standalone bodies. Without page, defaults retain source order and paired annotations, including unprinted bodies. Explicit order/include-unpaired override those defaults. Incomplete/duplicate spans cannot supply page coverage.
Parameters
| Name | Default | Types |
|---|---|---|
target | auto | auto, str, label, int |
thread | auto | auto, str, label |
include-types | auto | auto, str, array |
exclude-types | () | str, array |
series | auto | auto, str, array |
include-unpaired | auto | auto, bool, str |
after | none | none, location, label, str, dictionary, selector, function |
before | none | none, location, label, str, dictionary, selector, function |
page | auto | auto, int |
order | auto | auto, str |
target
Rendering domain to select. Auto selects all; 0 selects the current scope. For attached notes, filtering uses the body domain, preserving mark ownership.
thread
Optional thread filter. Combines with target.
include-types
A literal type or union of types; auto includes all, an empty array none.
exclude-types
A literal type or union of types to exclude.
series
A literal series or union of series; auto includes all, an empty array none.
include-unpaired
Auto includes standalone bodies in a page query, otherwise paired notes only. False includes only paired notes; true also includes both unpaired kinds. Mark or body includes that unpaired kind in addition to paired notes.
after
Exclusive original-source boundary, or body declaration for standalone bodies. Reused marks do not move originals into a range. All selected notes retain their complete marks array, including marks outside the range.
before
Exclusive upper source boundary with the same rules as after. Native labels/selectors choose their first match; strings/records choose pins.
page
Physical body page to select; positive integer, independently of displayed numbering/resets. Auto does not filter. Unprinted/incomplete spans do not match a page. Marks on that page alone do not make a body match.
order
Auto selects body order with page, source order without page. Source follows original declarations; body follows unique live start spans, retaining continuations before later starts. Unprinted/missing/ambiguous starts sort last in source order. Neither mode sorts marker values or visual coordinates.