Public API
Generated from current source documentation through Tidy.
Download the machine-readable API.
Setup And Defaults
Install setup before document annotations. Configuration can precede it. Reapply setup after replacing a native page foreground/background; identities and counters persist.
Marks And Identity
Use id to create the original counter owner; of reuses it. Names accept nonempty strings or labels. An original, its one body and reused marks may appear in any order. Reuse does not add a drawn connector.
Bodies And Collections
Wrappers accept [body] or [passage][body]. A -body call takes [body]. Wrapper id creates original + body; -body id creates a standalone body. With of, both forms attach only a body. Margin, inset and endnote bodies capture declaration typography; page footnotes use the native footer.
- deixis-footnote / deixis-footnote-body
- deixis-margin-note / deixis-margin-note-body
- deixis-sidenote / deixis-sidenote-body
- deixis-comment
- deixis-inset-note / deixis-inset-note-body
- deixis-inline-note / deixis-inline-note-body
- deixis-endnote / deixis-endnote-body
- deixis-print-endnotes
Connections And Drawing
A body connector is the short path for margin/inset notes. Independent edges select document endpoints without creating or moving them. Connections paint in their own foreground/background layer, below bodies at matching priorities.
- deixis-connect
- deixis-routing
- deixis-route
- deixis-routing-scene
- deixis-route-group
- deixis-prepare-connector
- deixis-render-connector
- deixis-arrowhead
- deixis-render-head
Pins And Attachments
Pin names and attachment IDs accept string/label spellings. They have independent namespaces from note IDs. A pin is a point; an attached routing object registers one live, nonbreaking frame.
Scopes And Counters
Scope names and note IDs are independent. Blocks own rendering instances and counter streams; thread shares a rendering domain, while counter synchronization only shares numbering.
References And Custom Views
Queries return safe semantic records and summaries instead of replaying live annotation content. An annotation remains one entry even when several marks share its body.
Rendering Extension Points
These hooks consume supplied records or content; they do not create a registered annotation. When used in live document annotations, keep setup active and preserve destination/content helpers. Relative typography and backlinks may require context.
- deixis-native-render-single / deixis-aligned-render-single
- deixis-chicago-render-single
- deixis-native-render-group / deixis-aligned-render-group / deixis-grid-render-group
- deixis-generate-body-meta / deixis-generate-body-marker / deixis-generate-body-content / deixis-generate-backlinks
- deixis-plain-container / deixis-rect-container / deixis-alert-container
- deixis-rect-region / deixis-ellipse-region
Low-Level Layout Hooks
Advanced hooks use supplied measured records and geometry. Most documents should choose note adapters, container/render callbacks, or routing APIs instead. Native layout and document lookup are separate responsibilities.