Module glossary_references 

patch_course_glossary_and_references: glossary terms and BibTeX references.

Renaming a citation key rewrites its \cite{…} citations in page content; other changes only report the pages that use the term or key.

Structs

GlossaryAndReferences

The document get_course_glossary_and_references shows and its patch tool edits.

GlossaryEdit

The edited document, before its effects on the pages are worked out.

GlossaryReferencesResult

The new state after a successful call, and what it means for the pages.

GlossaryTerm

A glossary term; its editable fields are TERM_FIELDS.

Reference

A BibTeX reference; its editable fields are REFERENCE_FIELDS.

Usage

A document that uses a term or citation key the call removed or renamed.

Enums

EntryEdit 🔒

What a remove or replace does to one glossary term or reference.

UsageKind

Whether a Usage is of a glossary term or a citation key.

Constants

REFERENCE_FIELDS 🔒

Reference fields ops may set.

TERM_FIELDS 🔒

Glossary term fields ops may set.

Statics

CITE 🔒

LATEX 🔒

The renderer hands [latex]…[/latex] to KaTeX before it looks for citations, so a \cite in there is no citation.

Functions

apply

Applies ops to doc; GlossaryEdit::with_page_effects then works out what it does to pages.

apply_op 🔒

bibtex_entry_key 🔒

The key of the single entry in bibtex, or a message saying why it doesn’t parse. Checks the shape @type{key, field = {…}, …} with balanced braces and exactly one entry.

citation_keys 🔒

The keys of the citations the renderer shows. Rich text stores keys HTML-escaped.

edit_entry 🔒

Applies edit to entries[position]; set writes one named field.

entry_edit 🔒

The edit op makes at field (the path after the entry’s id) of an entry with fields.

page_effects 🔒

The pages whose citations renames rewrites, and the pages that use a reported key or term.

rewrite_citations 🔒

unknown_entry_field 🔒

A field an entry with fields doesn’t have.

uses_term 🔒

Whole-word and case-sensitive, as the renderer highlights glossary terms.

validate 🔒

Checks the terms and references of doc that differ from before: entries the call left alone may predate these rules, and mustn’t block unrelated edits.