Module: Glossarist::MentionKinds

Defined in:

lib/glossarist/mention_parser.rb

Overview

Reference kinds produced by parse_mention for the unified {kind:target} / label} mention syntax.

The shape produced for each kind is the cross-library contract — glossarist-js produces the same keys, same values, so concept-browser can consume either library's output interchangeably without translation.

Constant Summary

LINK_REF =

{link:URL} or label} — external URL link. uri is canonical (deployment-independent); label is the display text (nil means render the URL itself).

"link-ref"

IMAGE_REF =

{image:src} or alt} — embedded image. src is the image source; alt is accessibility text (nil means no a11y label). Distinct from link-ref because it's an embed, not a navigation link.

"image-ref"

BIB_REF =

{bib:id} or label} — dataset-local bibliography entry. id references an entry in the dataset's bibliography.yaml. This is the case-3-only path — the author explicitly wants a flat bibliographic record, not a concept resolution.

"bib-ref"

CITE_REF =

{cite:id} or label} — concept citation.

"cite-ref"

FIG_REF =

{fig:id} / {figure:id} — non-concept figure entity xref.

"fig-ref"

TABLE_REF =

{table:id} / {tbl:id} — non-concept table entity xref.

"table-ref"

FORMULA_REF =

{formula:id} / {eq:id} — non-concept formula entity xref.

"formula-ref"

LOCAL_CONCEPT_REF =

{123} or label} — local concept by numeric id.

"local-concept-ref"

DESIGNATION_REF =

{designation} — concept by designation text.

"designation-ref"

URN_REF =

{urn:...} — URN reference.

"urn-ref"