API Reference

deixis-note-counter

Reads the assigned counter value for a scope and literal series. Use inside context.

Setup Required

Returns: integer.

Task guide

Example

#context deixis-note-counter()

Unused streams start at zero. This is not a total annotation count. Page numbering resets do not reset note counters. Opt-in page-local display markers do not change this assigned value.

deixis-note-counter

deixis-note-counter(target: 0, series: "default")

Retrieves the current counter value for a target scope and series. An unused stream starts at zero. This numbering value can be reset or changed; it is not the total number of registered notes.

Use this function rather than native counter() for Deixis numbering. Unnumbered originals (numbering: none) take no counter value. Page-local display numbering does not change this assigned value.

Note: Because it queries the document state, this function must be called within a context block.

• target (int, label, str): Current scope (0), ancestor (negative integer), named/forward scope, or global "page". Synchronized scopes share their resolved counter owner.
• series (str): Literal series name, default "default". Endnote wrappers use "endnote"; select that explicitly when reading it. Punctuation and empty names are valid distinct strings.

//| sandbox-mode: "page"
#context deixis-note-counter()

Parameters

target

Current scope (0), ancestor (negative integer), named scope, or global “page”.

series

The specific note series to query.