API Reference

deixis-inline-note

An explanation in native flow: the wrapper places it right after its passage as an inline aside; a -body call places it where called.

Setup Required

Returns: content.

Task guide

Example

deixis-inline-note[term][An inline explanation.]

The wrapper defaults to inline: true and keeps the sentence; inline: false gives a callout after the line (the -body default). Inline decoration bypasses block containers/custom single renderers. breakable: false supplies one frame for an explicit body endpoint.

deixis-inline-note

deixis-inline-note(..args, mark-type: auto, id: none, data: (:), of: none, numbering: auto, marker: auto, target: auto, series: auto, marker-style: auto, marker-position: auto, stroke: auto, fill: auto, radius: auto, z-index: auto, inline-mode: auto, pins: (), padding: auto, region-shape: auto, layer: auto, inline: true, breakable: true, backlink: auto, render-single: auto, container-func: auto, container-args: (:))

A wrapper for inline notes: a mark and its explanation in the same paragraph.

By default the explanation follows the marked passage as an inline aside, decorated like the passage, so the sentence continues. inline: false places a callout block after the line instead, which ends the paragraph. This delegates to deixis-inline-note-body.

The garden was full of
#deixis-inline-note[apricity][the warmth of the sun in winter]
on that pale afternoon.

• ..args (arguments): Accepts up to two positional arguments: [mark][body].
• mark-type (auto, str): The type of mark to render in the text. Choices: "inline" | "region" | "phantom".
• id (none, str, label): Names the original annotation created by this wrapper. Without id, its identity is private.
• data (dictionary): Custom annotation fields, kept under note.data. Configure on creation or a standalone body; omit with of.
• numbering (auto, none, str, function, dictionary): The numbering style for the marker.
• marker (auto, none, content): A hardcoded marker, or none to hide it; numbering still controls counter allocation.
• target (auto, int, label, str): Creation uses the current scope; of inherits the original’s rendering instance.
• series (auto, str): Original counter series, defaulting to "default". Omit with of; attachments inherit.
• marker-style (auto, function, dictionary): Marker styling; component dictionaries style mark and body separately.
• inline-mode (auto, str): Decoration of the passage; an inline aside reuses it.
• inline (bool): Inline aside (default) or a callout block after the line.
• backlink (auto, bool, str): Whether to generate a clickable backlink returning to the mark.

Parameters

..args

Accepts up to two positional arguments: [mark][body]. With one, a solo marker precedes the explanation. With of, accepts only [body].

mark-type

The type of mark to render in the text. Choices: "inline" | "region" | "phantom".

id

Names the original annotation created by this wrapper. Without id, its identity is private.

data

Custom annotation fields for creation or a standalone body. Omit with of.

of

Existing original annotation to attach this body to, instead of declaring a new note.

numbering

The numbering style for the marker. A record (restart: "page", pattern: "1") restarts displayed markers per original page; assigned counters stay unchanged. none disables automatic markers and counter allocation.

marker

A hardcoded marker override; none hides the marker but still counts unless numbering resolves to none.

target

Auto uses the current scope for creation and inherits the original’s exact rendering instance with of.

series

Original counter series, defaulting to "default" for creation. Omit with of; an attachment inherits and cannot redefine the series.

marker-style

A custom styling function for the marker, or a mark/body component dictionary.

marker-position

Mark marker placement.

stroke

The decoration stroke, shared by passage and aside unless split by component.

fill

The decoration fill.

radius

The decoration radius.

z-index

Overlay paint priority; higher integers paint later within a layer.

inline-mode

The visual decoration applied to the marked passage; an inline aside reuses it. Choices: "highlight" | "box" | "parentheses" | "underline" | "text-fill" | "none".

pins

Array of pin names for a region mark.

padding

Internal padding for a region mark.

region-shape

Shape drawing function for a region mark.

layer

Rendering layer for a region mark. Choices: "flow" | "foreground" | "background".

inline

True places the explanation inline after the passage, in the same paragraph (a region passage is boxed inline too). False places a callout block after the line, which ends the paragraph.

breakable

False keeps the rendered explanation in one native frame, selectable by explicit connections.

backlink

Whether to generate a clickable backlink returning to the mark. Choices: bool | "always" | "none" | "never" | "multiple".

render-single

A custom render function for a callout body (inline: false).

container-func

A custom container for a callout body (inline: false).

container-args

Native/custom options forwarded only to a callout body container.

deixis-inline-note-body

deixis-inline-note-body(body, id: none, data: (:), of: none, target: auto, series: auto, marker-style: auto, backlink: auto, inline-mode: auto, stroke: auto, fill: auto, radius: auto, z-index: auto, inline: false, breakable: true, render-single: auto, container-func: auto, container-args: (:), ..args)

A standalone body content of an inline note.

Body content is preserved. Built-in single renderers fold source indentation with native weak marker spacing and retain explicit paragraph/line breaks.

The garden was filled with the
#deixis-inline-mark(id: <apricity>)[apricity]
of a pale winter sun.

#deixis-inline-note-body(
  of: <apricity>,
  stroke: maroon,
  fill: maroon.transparentize(95%),
)[
  *Apricity:* The warmth of the sun in winter.
]

• body (content): The actual text or content of the note.

• id (none, str, label): Names a standalone body. Use of to attach this body to an original mark.

• data (dictionary): Custom annotation fields, kept under note.data. Configure on creation or a standalone body; omit with of.

• target (auto, int, label, str): Body rendering scope. Auto inherits the original mark’s exact instance, or uses the current scope for standalone bodies.

• series (auto, str): Collection series for a standalone body. Omit with of; attachments inherit the original’s series.

• marker-style (auto, function): A custom styling function (string) => content for the number/marker.

• backlink (auto, bool, str): Whether to generate a clickable backlink returning the reader to the mark. Choices: bool | "always" | "none" | "never" | "multiple".

• inline-mode (auto, str): The visual decoration applied to the marked inline text. Choices: "highlight" | "box" | "parentheses" | "underline" | "text-fill" | "none". Only used when inline: true.

• stroke (auto, stroke, none): The border stroke.

• fill (auto, color, none): The background fill color.

• radius (auto, length, dictionary): The border radius.

• inline (bool): If true, the body is rendered as if it is deixis-inline-mark. Inline-decoration bodies wrap within the current paragraph and can paginate, whether standalone or attached. breakable: false deliberately keeps one frame.

• breakable (bool): Native flow by default. False keeps the rendered body in one frame, selectable by explicit connections.

• render-single (auto, function): A custom render function for the inner layout of the body.

• container-func (auto, str, function): A custom container wrapper for the body block, or a preset name (“plain”, “rect”, “alert”, “stripe”, “tinted”).

• ..args (arguments): Additional arguments are rejected; put custom container options in container-args.

Parameters

body

The actual text or content of the note.

id

Names a standalone body. Use of to attach this body to an original mark.

data

Custom annotation fields for creation or a standalone body. Omit with of.

of

Existing original annotation to attach this body to, instead of declaring a new note.

target

Body rendering scope. Auto inherits the original mark’s exact instance, or uses the current scope for a standalone body. An explicit override changes body rendering without moving the original counter.

series

Collection series for a standalone body. Omit with of; attachments inherit their original’s series and reject explicit series arguments.

marker-style

A custom styling function (string) => content for the number/marker.

backlink

Whether to generate a clickable backlink returning the reader to the mark. Choices: bool | "always" | "none" | "never" | "multiple".

inline-mode

The visual decoration applied to the marked inline text. Choices: "highlight" | "box" | "parentheses" | "underline" | "text-fill" | "none". Only used when inline: true.

stroke

The border stroke.

fill

The background fill color.

radius

The border radius.

z-index

Overlay paint priority; higher integers paint later within a layer. Native flow retains its order. Component dictionaries are supported.

inline

If true, the body is rendered as if it is deixis-inline-mark.

The city streets were filled with the psithurism #deixis-inline-mark(id: <psithurism>) of swaying trees.
It was a comforting melody, #deixis-inline-note-body(of: <psithurism>, inline: true)[the sound of wind whispering through leaves].

breakable

False puts the complete rendered body in one native nonbreaking frame: an inline box with inline: true, otherwise a block. Its live bounds supply explicit connection ports. True preserves the existing rendering path.

render-single

A custom render function for the inner layout of the body.

container-func

A body wrapper function or preset name: “plain”, “rect”, “alert”, “stripe” or “tinted”. Forward wrapper options through container-args.

container-args

Native/custom options forwarded only to the body container.

..args

Additional arguments are rejected; put custom container options in container-args.