API Reference
deixis-comment
Review-comment preset: a margin note in the “review” series with lettered markers, author/status data and a bold header.
Setup Required
Returns: content.
Example
deixis-comment(author: "Ada", status: "open")[Passage][Comment.]
Remove comments in the series for a final copy with deixis-set(omit: (series: ("review",))). Other options are margin-note options; of is rejected. Pass numbering: auto to inherit configured numbering, or numbering: none for no automatic marker and no counter value.
deixis-comment
deixis-comment(author: none, status: none, data: (:), series: "review", numbering: "A", header: auto, ..args)
A review comment: a deixis-margin-note in the "review" series
with lettered markers and author/status fields. Remove these comments
from a final copy with deixis-set(omit: (series: ("review",))).
The #deixis-comment(author: "Ada", status: "open")[proposed method][
State the conditions under which this claim holds.]
preserves the argument.
- author (none, str, content): Stored as
note.data.author; shown in the header. - status (none, str, content): Stored as
note.data.status; shown in the header. - data (dictionary): Further annotation fields, merged with author/status.
- series (str): The counter/omission series. Defaults to
"review". - numbering (auto, none, str, function, dictionary): Marker numbering; letters by default.
- header (auto, none, function): Body heading. auto shows the present fields in bold, joined by “ · “; a function receives the merged data dictionary.
- ..args (arguments):
[comment]or[passage][comment]and other margin-note options. Creates an original; of is rejected.
Parameters
| Name | Default | Types |
|---|---|---|
author | none | none, str, content |
status | none | none, str, content |
data | (:) | dictionary |
series | "review" | str |
numbering | "A" | auto, none, str, function, dictionary |
header | auto | auto, none, function |
..args | variadic |
author
Stored as note.data.author; shown in the header.
status
Stored as note.data.status; shown in the header.
data
Further annotation fields, merged with author/status.
series
The counter/omission series.
numbering
Marker numbering; letters keep comments apart from source notes.
none disables automatic markers and counter allocation.
header
Body heading: auto, none, or a function of the merged data.