Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

API Reference

deixis-margin-note-exact-layout

Numeric margin adapter hooks: exact ignores collisions; adaptive packs; flow distributes available space.

Conditional

Returns: content.

Task guide

All share min-margin-width, pushed-notes and extra arguments. Supply accepted page geometry and prepared notes. They paint locally through the layout adapter. These hooks are not the body layer: “flow” switch.

deixis-margin-note-exact-layout

deixis-margin-note-exact-layout(notes, top-bound, bottom-bound, start-x, text-width, end-y, left-space, right-space, current-page, min-margin-width: 1in, pushed-notes: (), ..args)

A lightweight margin layout engine that places each note exactly aligned with its marker. It intentionally ignores collisions, gaps, and spillovers.

Parameters

NameDefaultTypes
notesrequired
top-boundrequired
bottom-boundrequired
start-xrequired
text-widthrequired
end-yrequired
left-spacerequired
right-spacerequired
current-pagerequired
min-margin-width1in
pushed-notes()
..argsvariadic

deixis-margin-note-adaptive-layout

deixis-margin-note-adaptive-layout(notes, top-bound, bottom-bound, start-x, text-width, end-y, left-space, right-space, current-page, min-margin-width: 1in, pushed-notes: (), ..args)

A placement-based margin layout engine that uses the rubber band algorithm under the hood.

Parameters

NameDefaultTypes
notesrequired
top-boundrequired
bottom-boundrequired
start-xrequired
text-widthrequired
end-yrequired
left-spacerequired
right-spacerequired
current-pagerequired
min-margin-width1in
pushed-notes()
..argsvariadic

deixis-margin-note-flow-layout

deixis-margin-note-flow-layout(notes, top-bound, bottom-bound, start-x, text-width, end-y, left-space, right-space, current-page, min-margin-width: 1in, pushed-notes: (), ..args)

A flow-based margin layout engine that distributes free space toward marker positions.

Parameters

NameDefaultTypes
notesrequired
top-boundrequired
bottom-boundrequired
start-xrequired
text-widthrequired
end-yrequired
left-spacerequired
right-spacerequired
current-pagerequired
min-margin-width1in
pushed-notes()
..argsvariadic