API Reference

deixis-endnote

Declares a collected explanation, rendered only by an eligible endnote printer.

Setup Required

Returns: content.

Example

deixis-endnote[A collected explanation.]

Wrapper series defaults to “endnote”; attachments inherit the original series. The printer controls where it appears. Body settings are retained until printing. Margin, inset, inline and footnotes nested in endnote bodies converge in PDF and HTML within the documented layout limits.

deixis-endnote

deixis-endnote(..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: false, backlink: auto, render-single: auto, container-func: auto, container-args: (:))

A wrapper for generating endnotes.

This function creates a mark in the text and delegates the body to deixis-endnote-body.

//| sandbox-mode: "page"
The botanist spent years searching for the idiosyncratic
#deixis-endnote[*Idiosyncratic:* Something peculiar or individual to a specific person, place, or thing.]
wildflower that only bloomed in the valley’s deepest shadows.
As the sun dipped below the horizon, the forest floor began to glow with a soft bioluminescence
#deixis-endnote[*Bioluminescence:* The production and emission of light by a living organism.]
that guided her back to camp.

//| sandbox-mode: "page"
#deixis-print-endnotes()

See deixis-print-endnotes.

..args (arguments): Accepts up to two positional arguments: [mark][body]. Put custom container options in container-args.
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 endnote marker.
marker (auto, content): A hardcoded marker override.
target (auto, int, label, str): Creation uses the current scope; of inherits the original’s rendering instance. Explicit values override the body scope.
series (auto, str): Original counter series, defaulting to "endnote". Omit with of; attachments inherit.
marker-style (auto, function): A custom styling function for the marker.
marker-position (auto, alignment, dictionary): Mark marker placement.
stroke (auto, stroke, none): The border stroke.
fill (auto, color, none): The background fill color.
radius (auto, length, dictionary): The border radius.
inline-mode (auto, str): The visual decoration applied to the marked inline text. Choices: "highlight" | "box" | "parentheses" | "underline" | "text-fill" | "none".
pins (array): Array of pin names for the region mark.
padding (auto, length, str): Internal padding for the region mark.
region-shape (auto, function): Shape drawing function for the region mark.
layer (auto, str): Rendering layer for the region mark. Choices: "flow" | "foreground" | "background".
inline (bool): If true, force the region mark into an inline box.
backlink (auto, bool, str): Whether to generate a clickable backlink returning to the mark. Choices: bool | "always" | "none" | "never" | "multiple".
container-func (auto, str, function): A custom container wrapper for the endnote when printed, or a preset name (“plain”, “rect”, “alert”, “stripe”, “tinted”).

Parameters

Name	Default	Types
`..args`	variadic	arguments
`mark-type`	`auto`	auto, str
`id`	`none`	none, str, label
`data`	`(:)`	dictionary
`of`	`none`	none, str, label
`numbering`	`auto`	auto, none, str, function, dictionary
`marker`	`auto`	auto, content
`target`	`auto`	auto, int, label, str
`series`	`auto`	auto, str
`marker-style`	`auto`	auto, function
`marker-position`	`auto`	auto, alignment, dictionary
`stroke`	`auto`	auto, stroke, none
`fill`	`auto`	auto, color, none
`radius`	`auto`	auto, length, dictionary
`z-index`	`auto`	auto, int, dictionary
`inline-mode`	`auto`	auto, str
`pins`	`()`	array
`padding`	`auto`	auto, length, str, dictionary
`region-shape`	`auto`	auto, function
`layer`	`auto`	auto, str
`inline`	`false`	bool
`backlink`	`auto`	auto, bool, str
`render-single`	`auto`	auto, function
`container-func`	`auto`	auto, str, function
`container-args`	`(:)`	dictionary

..args

Accepts up to two positional arguments: [mark][body]. With of, accepts only [body] and body options. Configure the original mark separately; non-default mark-only options are rejected.

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.

target

Auto uses the current scope for creation and inherits the original’s exact rendering instance with of. Explicit values override the body scope when attached, without moving the original counter.

series

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

Info.

Endnotes default to the "endnote" series, review comments to "review", and other note wrappers to "default".

marker-style

A custom styling function for the marker.

marker-position

Mark marker placement.

See deixis-inline-mark.marker-position and deixis-region-mark.marker-position.

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-mode

See deixis-inline-mark.inline-mode.

pins

Array of pin names for the region mark.

See deixis-region-mark.pins.

padding

Internal padding for the region mark.

See deixis-region-mark.padding.

region-shape

Shape drawing function for the region mark.

See deixis-region-mark.region-shape.

layer

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

See deixis-region-mark.layer.

inline

If true, force the region mark into an inline box.

See deixis-region-mark.inline.

backlink

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

render-single

A custom single-note body renderer, forwarded to the endnote 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.

deixis-endnote-body

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

A standalone body content of an endnote.

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

The body of the endnote is completely invisible when declared. It is stored as metadata and will only be rendered when you explicitly call deixis-print-endnotes().

//| sandbox-mode: "page"
The abandoned cathedral was a monument to #deixis-inline-mark(id: <sciamachy>, series: "endnote")[sciamachy], its crumbling walls silent witnesses to a forgotten struggle.
Within its hallowed nave, a single #deixis-inline-mark(id: <glabella>, series: "endnote")[glabella] on a marble statue caught the moonlight, the only smooth surface left untouched by the decay of time.

#deixis-endnote-body(of: <sciamachy>)[*Sciamachy:* A battle against an imaginary enemy; literally _shadow-fighting_.]
#deixis-endnote-body(of: <glabella>)[*Glabella:* The smooth part of the forehead between the eyebrows and just above the nose.]

//| sandbox-mode: "page"
#deixis-print-endnotes()

Memo.

Endnote wrappers and standalone bodies default to series: "endnote". Attached bodies inherit their original mark’s series. Set the series on the original mark, or use deixis-print-endnotes.series to select a collection.

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 for the marker.
backlink (auto, bool, str): Whether to generate a clickable backlink returning to the mark.
stroke (auto, stroke, none): The border stroke.
fill (auto, color, none): The background fill color.
radius (auto, length, dictionary): The border radius.
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 endnote when printed, or a preset name (“plain”, “rect”, “alert”, “stripe”, “tinted”).
..args (arguments): Additional arguments are rejected; put custom container options in container-args.

Parameters

Name	Default	Types
`body`	required	content
`id`	`none`	none, str, label
`data`	`(:)`	dictionary
`of`	`none`	none, str, label
`target`	`auto`	auto, int, label, str
`series`	`auto`	auto, str
`marker-style`	`auto`	auto, function
`backlink`	`auto`	auto, bool, str
`stroke`	`auto`	auto, stroke, none
`fill`	`auto`	auto, color, none
`radius`	`auto`	auto, length, dictionary
`z-index`	`auto`	auto, int, dictionary
`render-single`	`auto`	auto, function
`container-func`	`auto`	auto, str, function
`container-args`	`(:)`	dictionary
`..args`	variadic	arguments

Keyboard shortcuts

Deixis