Enscribe
Open in playground ↗
Quotation & sourcing

Others’ words, and pointers at sources — quotation, citation, cross-reference, and links.

<a> General Usage

Semantic role: a. Compiles to eHTML <a>.

Registers:

  • Canonical: <a>
See <a https://example.com/docs | the documentation>.

See the documentation.

Minipage 45.

The positional URL form — the target is the first argument, the pipe content is the link text. The most common authoring path. (Markdown [text](url) is not an enscribe idiom; it renders as literal text.)

<a href=https://example.com | the example site>
the example site
Minipage 46.
<a href=https://example.com target=_blank rel=noopener | external link>
external link
Minipage 47.
<a href=#section-2 | jump to Section 2>
jump to Section 2
Minipage 48.

Internal links use fragment identifiers pointing at element ids.

 Arguments
attribute kind values / default notes
href format-word The link target as the first positional argument:
href kwarg The URL or fragment identifier the anchor points to.
target kwarg _self _blank _parent _top How the link opens.
rel kwarg Relationship between the current document and the link target.
title kwarg Tooltip text shown on hover.
<bib-entry> General Usage

Semantic role: bib-entry. Compiles to eHTML <bib-entry>.

Registers:

  • Canonical: <bib-entry>
 Arguments
attribute kind values / default notes
type kwarg article book chapter thesis proceedings report webpage other The bibliography entry type.
<bibliography> General Usage

Semantic role: bibliography. Compiles to eHTML <bibliography>.

Registers:

  • Canonical: <bibliography>
 Arguments
attribute kind values / default notes
style kwarg author-year numbered footnote custom Future — not yet implemented:
sort kwarg alpha citation-order year none (default alpha) Future — not yet implemented:
type kwarg cited-only full hybrid (default cited-only) Future — not yet implemented:
<blockquote> General Usage

Semantic role: blockquote. Compiles to eHTML <blockquote>.

Registers:

  • Canonical: <blockquote>
  • Alias: <quote>
<quote | A short quotation.>

A short quotation.

Minipage 49.

The <quote> shorthand expands to <blockquote> at eHTML.

<quote cite=https://example.com/source |
A longer quotation that may contain multiple paragraphs.

The second paragraph of the quotation.
>

A longer quotation that may contain multiple paragraphs.

The second paragraph of the quotation.

Minipage 50.
<quote type=epigraph |
All happy families are alike; each unhappy family is unhappy in its own way.
>

All happy families are alike; each unhappy family is unhappy in its own way.

Minipage 51.
<blockquote | Same as `<quote>` but using the explicit eHTML name.>

Same as <quote> but using the explicit eHTML name.

Minipage 52.

Authors can also write <blockquote> directly. Both forms produce the same eHTML output.

 Arguments
attribute kind values / default notes
cite kwarg URL of the source being quoted.
type kwarg verse dialogue epigraph pullquote other Optional classification of the quotation’s role.
<cite> General Usage

Semantic role: cite. Compiles to eHTML <cite>.

Registers:

  • Canonical: <cite>
The argument is supported by data <cite goodall2024>.

The argument is supported by data .

Minipage 53.

A simple citation. The resolver renders the citation according to the document-level style. For author-year style, this becomes “(Goodall 2024)”. For numbered style, “[1]”. The actual rendered text is generated by the citation resolver, not written by the author.

Multiple sources confirm this <cite goodall2024 attenborough2020 darwin1859>.

Multiple sources confirm this .

Minipage 54.

Multiple citation keys group into one citation marker. The resolver handles the joining (with separators appropriate to the style).

See <cite goodall2024 page=42> for details.

See for details.

Minipage 55.

A citation with a page locator. The locator renders alongside the citation marker.

See also <cite goodall2024 prefix="cf." page=42-45>.

See also .

Minipage 56.

Citation with prefix and page range.

A specific work <cite goodall2024 style=footnote>.

A specific work .

Minipage 57.

Per-citation style override. This citation renders as a footnote marker even if the document-level style is something else.

 Arguments
attribute kind values / default notes
keys kwarg One or more citation keys, supplied as positional arguments.
page kwarg Page number or page range for the citation locator.
chapter kwarg Chapter reference within the cited work.
section kwarg Section reference within the cited work.
prefix kwarg Text to appear before the citation.
suffix kwarg Text to appear after the citation.
style kwarg author-year numbered footnote endnote inline-author-year default (default default) Override the document-level citation style for this citation.
<doi> General Usage

Semantic role: doi. Compiles to eHTML <doi>.

Registers:

  • Canonical: <doi>
<meta>
  <doi | 10.1234/example.2024>
</meta>
10.1234/example.2024
Minipage 58.

Bare DOI as the typical authoring form.

<meta doi="10.5555/test" />
10.5555/test
Minipage 59.

Kwarg-form authoring lifts to the child-tag form at the normalize-to-canonical gate (per the apparatus-tag reconciliation, DESIGN.md §”Apparatus-tag positioning”).

<q> General Usage

Semantic role: q. Compiles to eHTML <q>.

Registers:

  • Canonical: <q>
She said <q | hello> in passing.

She said hello in passing.

Minipage 60.

Browsers automatically render <q> with quotation marks. Authors do not include quotation marks in the content.

The phrase <q cite=https://example.com | to be or not to be> is iconic.

The phrase to be or not to be is iconic.

Minipage 61.
 Arguments
attribute kind values / default notes
cite kwarg URL of the source being quoted.
<ref> General Usage

Semantic role: ref. Compiles to eHTML <ref>.

Registers:

  • Canonical: <ref>
See <ref @fig:scatter> for details.

See ??ref: fig:scatter?? for details.

Minipage 62.

Canonical form: @id prefix (@ references; # would declare an id on the <ref> itself). The ref-resolution plugin replaces the <ref> node with a __ref-marker before hast conversion. The handler then renders an <a> element with computed text. Prefix word is lowercase, from the DEFAULT_PREFIXES dictionary keyed by id prefix.

As shown in <ref @eqn:model>.

As shown in ??ref: eqn:model??.

Minipage 63.

Equation references use the “equation” prefix word by default. Config override: <config ref-prefix-eqn=”Eq.”> changes this to “Eq.”.

<ref @eqn:missing>
??tag: ref — long-form tag has no closing tag??
Minipage 64.

Unresolved target renders a visible error anchor.

 Arguments
attribute kind values / default notes
target kwarg The id of the element being referenced.
type kwarg auto figure table equation section sub-section note listing theorem other (default auto) Author-supplied hint about the intended kind of target.
format kwarg number name full label-only default (default default) Author-supplied formatting hint.
+link / -link flag default on Controls whether the rendered ref is a navigable hyperlink.
+preview / -preview flag default on Controls the hover preview that attaches to the rendered ref by default.
+title / -title flag default on Reserved / unimplemented.