Skip to main content

Module object_db

Module object_db 

Source
Expand description

Object database for cross-document data sharing.

Port of LaTeXML::Util::ObjectDB + ObjectDB::Entry. A key-value store used by Scan, CrossRef, MakeIndex, and MakeBibliography to share structural information across documents and processing phases.

Keys follow conventions:

  • ID:<xml:id> — element data (type, parent, children, labels, location, etc.)
  • LABEL:<label> — label → ID mapping
  • DOCUMENT:<path> — document location → root ID mapping
  • SITE_ROOT — root document of the site
  • BIBLABEL:<list>:<key> — bibliography key → item ID
  • GLOSSARY:<list>:<key> — glossary entries
  • INDEX:<phrase1>:<phrase2>:... — index entries
  • DECLARATION:(global|local):<name> — declared symbols
  • NOTATION:<name> — notation entries

Structs§

DbAttachOptions
Options for ObjectDB::attach, mirroring Perl ObjectDB::new’s dbfile/clean/readonly knobs.
Entry
A single entry in the ObjectDB.
ObjectDB
The Object Database.

Enums§

Value
A value stored in an Entry.

Constants§

DBFILE_FORMAT_VERSION
Bump when the on-disk encoding changes shape. Mismatched files are refused at attach — never silently reinterpreted.