API Reference
deixis-inline-mark
Specialized inline form of deixis-mark, with an optional marked passage.
Setup Required
Returns: content.
Example
deixis-inline-mark(of: <detail>)[Another passage]
Box, highlight, underline, parentheses, text-fill and none are available. Reused marks retain the original styles beneath explicit overrides.
deixis-inline-mark
deixis-inline-mark(..args, numbering: auto, marker: auto, target: 0, series: "default", id: none, data: (:), of: none, occurrence: none, marker-style: auto, marker-position: auto, inline-mode: auto, stroke: auto, fill: auto, radius: auto, z-index: auto)
An inline text mark with a visual marker.
This function drops a numbered (or custom) marker into the text and registers its location in the
annotation catalogue.
With of: id, it reuses an annotation through deixis-mark instead;
only a numbered original id declaration advances the counter. Reuse is forward-safe.
Inline note is usually just a single marker#deixis-inline-mark(id: <celibate-inline-note1>).
Alternatively, it can wrap #deixis-inline-mark(id: <celibate-inline-note2>)[a text content of arbitrary length with it].
- ..args (arguments): Accepts up to one positional arguments:
[body]. - numbering (auto, none, str, function, dictionary): The numbering style (e.g.,
"1","a") for the generated marker. - marker (auto, content): A hardcoded marker (like a symbol) to use instead of the automatic counter.
- target (int, label, str): The specific block/minipage counter context this mark belongs to.
- series (str): The counter series this mark belongs to. Defaults to
"default". - id (none, str, label): A unique identifier linking this mark to its corresponding body.
- data (dictionary): Custom annotation fields, kept under note.data. Configure on creation or a standalone body; omit with of.
- marker-style (auto, function): A custom styling function
(string) => contentfor the generated marker. - marker-position (auto, alignment): The alignment/positioning of the marker relative to its anchor.
- inline-mode (auto, str): The visual decoration applied to the marked inline text. Choices:
"highlight"|"box"|"parentheses"|"underline"|"text-fill"|"none". - stroke (auto, stroke, none): The border stroke.
- fill (auto, color, none): The background fill color.
- radius (auto, length, dictionary): The border radius.
Parameters
| Name | Default | Types |
|---|---|---|
..args | variadic | arguments |
numbering | auto | auto, none, str, function, dictionary |
marker | auto | auto, content |
target | 0 | int, label, str |
series | "default" | str |
id | none | none, str, label |
data | (:) | dictionary |
of | none | none, str, label |
occurrence | none | none, str, label |
marker-style | auto | auto, function |
marker-position | auto | auto, alignment |
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 |
..args
Accepts up to one positional arguments: [body].
numbering
The numbering style (e.g., "1", "a") for the generated 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 (like a symbol) to use instead of the automatic counter.
target
The specific block/minipage counter context this mark belongs to.
series
The counter series this mark belongs to.
id
A unique identifier linking this mark to its corresponding body.
data
Custom annotation fields, owned by the original. Omit with of.
of
Reuse an existing annotation instead of declaring a new counter owner. Mutually exclusive with id; numbering/scope/series are inherited.
occurrence
Optional name for a reused occurrence. Visible named repeats use one inline box.
marker-style
A custom styling function (string) => content for the generated marker.
marker-position
The alignment/positioning of the marker relative to its anchor.
#deixis-inline-mark(marker-position: left, id: <celibate-inline-note3>)[
This noted content has its mark placed on the left side.
]
inline-mode
The visual decoration applied to the marked inline text. Choices: "highlight" | "box" | "parentheses" | "underline" | "text-fill" | "none".
#deixis-inline-mark(inline-mode: "highlight")[Marked content]
#deixis-inline-mark(inline-mode: "box")[Marked content]
#deixis-inline-mark(inline-mode: "parentheses")[Marked content]
#deixis-inline-mark(inline-mode: "underline")[Marked content]
#deixis-inline-mark(inline-mode: "text-fill")[Marked content]
#deixis-inline-mark(inline-mode: "none")[Marked content]
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.