API Reference

deixis-mark

Unified original/reused mark. Defaults to inline; pins select region mode. A call without id/of is anonymous decoration.

Setup Required

Returns: content.

Task guide

Example

deixis-mark(id: <detail>)[A passage]

mark-type: “region” highlights a passage or pins; “phantom” is a semantic origin. Set data on creation, not reuse. Resolved numbering: none takes no counter value; an explicit marker may still display. See shared options for styles, targets and region controls.

deixis-mark

deixis-mark(..args, id: none, data: (:), of: none, mark-type: auto, occurrence: none, numbering: auto, target: 0, series: "default", marker: auto, marker-style: auto, marker-position: auto, inline-mode: auto, stroke: auto, fill: auto, radius: auto, z-index: auto, pins: (), padding: auto, region-shape: auto, layer: auto, inline: false)

Creates a mark, or adds another occurrence of an annotation.

#deixis-mark(id: <idea>)[First passage]
#deixis-margin-note-body(of: <idea>)[One explanation.]
#deixis-mark(of: <idea>)[Another passage]

Use id: to declare the original counter owner and of: to reuse it, even before the original declaration. Without either, this is anonymous decoration. The default is inline; supplied pins select region mode. Select another form explicitly with mark-type: "region" or "phantom". Reuse adds a backlink origin and never inherits a drawn connector. Name an occurrence and use deixis-connect when an additional connection is wanted.

id (none, str, label): Declare an original annotation with this public ID.
data (dictionary): Custom annotation fields, kept under note.data. Configure on creation or a standalone body; omit with of.
of (none, str, label): Reuse an original annotation; mutually exclusive with id.
mark-type (auto, str): Inline by default, region with pins, or explicit inline/region/phantom.
occurrence (none, str, label): Name a reused occurrence within its annotation.
numbering (auto, none, str, function, dictionary): Original numbering style; inherited on reuse.
target (int, str, label): Original counter scope; inherited on reuse.
series (str): Original counter series; inherited on reuse.
marker (auto, none, content): Number automatically, replace the marker, or hide it.
marker-style (auto, function, dictionary): Mark marker appearance.
marker-position (auto, alignment, dictionary): Marker position.
inline-mode (auto, str): Inline passage decoration.
stroke (auto, stroke, none): Decoration stroke.
fill (auto, color, none): Decoration fill.
radius (auto, length, dictionary): Decoration radius.
pins (array): Region bounds instead of a passage.
padding (auto, length, str, dictionary): Region padding.
region-shape (auto, function): Region shape renderer.
layer (auto, str, dictionary): Region paint layer.
inline (bool): Wrap a region passage in an inline box.
..args (arguments): At most one optional [passage]; identity arguments are named.

Parameters

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

Keyboard shortcuts

Deixis