WORK-010
ID:WORK-010Status:pending

Build glossary Rune

Priority:mediumComplexity:unknown
claude/align-sidenav-styling-4MuxV View source

Relationships

Implements 1
Related 1
Branches 3
claude/align-sidenav-styling-4MuxV current pending
claude/file-naming-convention-LJdwR pendingmain pendingchangeset-release/main pending
History 2
  1. ebe0c64
    Content editedby Claude
    Migrate plan files to {% ref %} xref syntax (WORK-021)
  2. d275b2a
    Created (pending)by Claude
    Add work items for 16 unbuilt runes from SPEC-008

Summary

Collection of terms with definitions, rendered as a navigable index. At build time, auto-links term occurrences across the site. Schema.org: DefinedTermSet.

Attributes

NameTypeDefaultRequiredDescription
autoLinkBooleantrueNoEnable site-wide auto-linking of terms
groupByString'letter'NoGrouping: letter (alphabetical), category, none

Content Model

  • Child {% concept %} runes → individual terms
  • Or: definition list (term\n: definition) syntax → auto-converted to concept entries
  • Headings → category group labels (when groupBy="category")

Transform Output

  • typeof: Glossary
  • Tag: <section>
  • Properties: autoLink, groupBy
  • Refs: terms (dl or grouped divs), index (alphabetical jump links)

Implementation Tasks

  1. Create schema in runes/learning/src/tags/glossary.ts
  2. Add RuneConfig entry in runes/learning/src/config.ts
  3. Write CSS in packages/lumina/styles/runes/glossary.css
  4. Import CSS in packages/lumina/index.css
  5. Add SEO extractor for DefinedTermSet
  6. Implement cross-page auto-linking pipeline hook in @refrakt-md/learning package's PackagePipelineHooks
  7. Write tests in runes/learning/test/tags/glossary.test.ts
  8. Create inspector fixture

Implementation Notes

The auto-linking feature requires build pipeline integration beyond standard rune transforms. During the content build, the pipeline collects all glossary terms and rewrites matching text nodes across other pages into links. This should be implemented as a post-build pass via the @refrakt-md/learning package's postProcess() pipeline hook — similar to how toc collects headings, but cross-page.

Dependencies

  • Requires the concept rune (WORK-007) to exist first — glossary collects concept definitions