API Reference
deixis-setup-notes
Document show rule: installs registration, references, visibility, validation and optional page overlays.
Installs Setup
Returns: content → content.
Example
#show: deixis-setup-notes
Set page geometry/layers first. Page footnotes default to native flow; override-page-footnotes: true makes the foreground overlay their default. Host themes may install both overlay hooks with page-overlays: false.
deixis-setup-notes
deixis-setup-notes(body, foreground: none, background: none, override-page-footnotes: false, page-overlays: true)
Installs document registration/show rules, validation, and optional page overlays.
Wrap document notes, pins, scopes, counters, queries and declared connections
with #show: deixis-setup-notes.with(...). Resolved numeric routes/scenes,
head/shaft painting and configuration do not require note setup.
Warning.
deixis uses the page foreground and background to display some notes.
Replacing a native page foreground/background later removes that layer’s
compositor, while registration and show rules remain installed. Reapply
setup after the new page settings to restore automatic composition. Reuse
the same bound setup function when retaining nondefault setup options.
Themes and scoped page styles should own their layers with page-overlays: false and include deixis-page-overlay in each background/foreground.
The background hook also publishes physical page geometry.
- body (content): The main document content to wrap.
- foreground (none, content): Custom content to inject into the foreground overlay layer.
- background (none, content): Custom content to inject into the background overlay layer.
- override-page-footnotes (bool): Default unspecified page-footnote bodies to native flow (
false) or the foreground overlay (true); explicit layers retain ownership.
Parameters
| Name | Default | Types |
|---|---|---|
body | required | content |
foreground | none | none, content |
background | none | none, content |
override-page-footnotes | false | bool |
page-overlays | true | bool |
body
The main document content to wrap.
foreground
Custom content to inject into the foreground overlay layer.
background
Custom content to inject into the background overlay layer.
override-page-footnotes
Default unspecified page-footnote bodies to the foreground overlay instead of native flow. Explicit body layers and deixis-set layers are honored.
Info.
Native flow paginates long bodies. Overlays reserve complete bodies and can group series with aligned markers, but cannot split across pages.
page-overlays
Automatically install page layers. Set false when a host theme calls deixis-page-overlay through its own background/foreground configuration.