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-print-endnotes

Prints unprinted eligible bodies in source order; successive printers do not duplicate output.

Setup Required

Returns: content.

Task guide

Example

deixis-print-endnotes()

Omitted overrides retain body settings. The grid bypasses per-note containers for default aligned singles; a series with a custom single renderer is stacked. Select deixis-native-render-group to use containers with default singles. after/before are exclusive source boundaries.

deixis-print-endnotes

deixis-print-endnotes(target: 0, series: auto, after: none, before: none, marker-style: auto, body-style: auto, backlink: auto, separator: auto, clearance: auto, gap: auto, marker-gap: auto, indent: auto, render-single: auto, render-group: auto, container-func: auto, container-args: auto)

Renders a collected list of endnote bodies at the current location in the document.

This function selects unprinted endnotes matching the specified target and series, and prints them in a formatted list. Source boundaries can select the notes for a chapter or section.

Info.

Note bodies cannot be printed twice. The first matching printer owns each body, including when filtered ranges overlap.

//| sandbox-mode: "page"
#deixis-print-endnotes()
  • target (int, label, str): The specific block/minipage target to pull notes from.
  • series (auto, str, array): Filters to notes belonging to a specific series or array of series.
  • after (none, location, label, str, dictionary, selector, function): Only prints bodies declared after this exclusive native or pin boundary.
  • before (none, location, label, str, dictionary, selector, function): Only prints bodies declared before this exclusive boundary. Defaults to the printer’s location; an explicit future boundary can include later declarations.
  • marker-style (auto, function): Overrides the marker style for the printed list.
  • body-style (auto, function): Overrides the text styling of the printed bodies.
  • backlink (auto, bool, str): Overrides the backlink generation setting for these notes. Choices: bool | "always" | "none" | "never" | "multiple".
  • separator (auto, content, none): An optional separator to draw between the list of notes (e.g., a line).
  • clearance (auto, length): The spacing before the list of endnotes begins.
  • gap (auto, length): The vertical spacing between individual endnotes.
  • marker-gap (auto, length): The horizontal spacing between the endnote number and its text body.
  • indent (auto, length): Overrides the indentation applied to the note body.
  • render-single (auto, function): A custom rendering function (note-data, ..args) => content to override the local render-single.
  • render-group (auto, function): A custom rendering function (notes-array, ..args) => content to override the local render-group.
  • container-func (auto, str, function): Overrides the container for each printed body.

Parameters

NameDefaultTypes
target0int, label, str
seriesautoauto, str, array
afternonenone, location, label, str, dictionary, selector, function
beforenonenone, location, label, str, dictionary, selector, function
marker-styleautoauto, function
body-styleautoauto, function
backlinkautoauto, bool, str
separatorautoauto, content, none
clearanceautoauto, length
gapautoauto, length
marker-gapautoauto, length
indentautoauto, length
render-singleautoauto, function
render-groupautoauto, function
container-funcautoauto, str, function
container-argsautoauto, dictionary

target

The specific block/minipage target to pull notes from.

series

Filters to notes belonging to a specific series or array of series.

after

Only prints bodies declared after this location, label, or <deixis-pin> name. Strings select the first global pin; structured name/scope/select/page targets require one selected occurrence. Native locations/labels also work. Native selectors use their first match, as native labels do.

before

Only prints bodies declared before this boundary. Defaults to the printer’s location. An explicit future boundary can include bodies declared after this printer. Strings select the first global pin; structured name/scope/select/page targets require one selected occurrence. Forward pin declarations work. Native selectors use their first match, as native labels do.

marker-style

Overrides the marker style for the printed list.

body-style

Overrides the text styling of the printed bodies.

Overrides the backlink generation setting for these notes. Choices: bool | "always" | "none" | "never" | "multiple".

separator

An optional separator to draw between the list of notes (e.g., a line).

clearance

The spacing before the list of endnotes begins.

gap

The vertical spacing between individual endnotes.

marker-gap

The horizontal spacing between the endnote number and its text body.

indent

Overrides the indentation applied to the note body.

render-single

A custom rendering function (note-data, ..args) => content to override the local render-single.

render-group

A custom rendering function (notes-array, ..args) => content to override the local render-group.

container-func

Overrides the container for each printed body: a preset name or a function.

container-args

Native/custom options forwarded only to the body container.