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-generate-body-meta

Composable helpers for a custom body renderer: one destination, a marker, live content span, and return links.

Conditional

Returns: content.

Task guide

Example

[#deixis-generate-body-marker(note)#deixis-generate-body-content(note)]

Emit meta OR marker once; marker already includes meta. Content publishes start/end spans and preserves nested palette ownership. Measurement records suppress live metadata. Backlinks read document origins and need setup/context.

deixis-generate-body-meta

deixis-generate-body-meta(data)

Publishes the invisible body destination, without a marker or content span. Emit this OR deixis-generate-body-marker once in live custom output, not both. Measurement records with disable-links suppress destination metadata.

  • data (dictionary): Note data.

Parameters

NameDefaultTypes
datarequireddictionary

data

Supplied renderer record; preserves public/private body destinations and measurement flags.

deixis-generate-body-marker

deixis-generate-body-marker(data)

Formats the body marker and publishes its destination through deixis-generate-body-meta. Marker-less bodies still publish the destination. Use once together with deixis-generate-body-content; do not also emit meta.

  • data (dictionary): Note data.

Parameters

NameDefaultTypes
datarequireddictionary

data

Supplied renderer record, with marker-str and optional body-marker-style.

deixis-generate-body-content

deixis-generate-body-content(data)

Returns the note’s body content with live start/end metadata.

Pair with deixis-generate-body-marker or deixis-generate-body-meta once in a custom renderer to retain navigation, catalogue spans, page-note queries, and body-point connections. This helper does not add a marker, destination, text styling, or backlinks. It preserves anonymous palette decoration belonging to this annotation. Pass the renderer’s data record unchanged, or replace its body field with the content you actually render.

With disable-links: true, returns the body without live metadata, matching the built-in measurement path. Do not render a second copy of the body.

  • data (dictionary): The supplied body-renderer record, including body and internal-id.

Parameters

NameDefaultTypes
datarequireddictionary

data

Supplied renderer record, including body and internal-id; preserve measurement flags.

deixis-generate-backlinks(data)

Returns backlink buttons for the original mark, reused marks and references. This is explicit generation: it does not apply the data.backlink policy. Built-in renderers apply that policy before calling it. It emits no body destination or live body span. Live origins require setup and context. Detached measurement suppresses links, and normally the buttons too; internal measure-backlinks requests retain their dimensions without active links.

  • data (dictionary): Note data.

Parameters

NameDefaultTypes
datarequireddictionary

data

Supplied body-renderer record, including internal-id and original return label.