Module api 

Interactive document-level API for batch citation formatting. Interactive document-level API for batch citation formatting.

This module provides the Tier 1 format_document API, enabling whole-document citation and bibliography rendering with proper context (note positions, ibid detection, disambiguation).

Re-exports

pub use forward_compat::UnknownFieldPath;

pub use forward_compat::collect_unknown_field_paths;

Modules

forward_compat

Forward-compat unknown-field walking for citum check.

Structs

AbbreviationMap

Document-level map from full rendered strings to their abbreviations.

AnnotationStyle

Controls how annotation text is rendered in an annotated bibliography.

BibliographyEntry

A single bibliography entry.

CitationInsertPosition

Position context for inserting or moving a citation in a session.

CitationOccurrence

A citation occurrence in the document.

CitationOccurrenceItem

A single item within a citation occurrence.

DocumentOptions

Document-level configuration for rendering.

DocumentSession

Stateful facade over whole-document citation rendering.

EntryMetadata

Metadata extracted from a bibliography entry for interactivity.

FormatDocumentRequest

A request to format a complete document’s citations and bibliography.

FormatDocumentResult

The result of formatting a document.

FormattedBibliography

A formatted bibliography.

FormattedCitation

A single formatted citation.

OpenSessionResult

Result returned when a new interactive session is opened.

PreviewCitationResult

Result returned by citation preview.

SessionMutationResult

Result returned by mutation methods.

Warning

A structured diagnostic warning returned alongside formatted output.

Enums

AnnotationFormat

Markup format for annotation text.

DocumentSessionError

Errors returned by the stateful session API.

FormatDocumentError

Errors that can occur during document formatting.

OutputFormatKind

Supported output format kinds.

RefsInput

A refs input that can be resolved locally or by an external resolver.

StyleInput

A style reference that can be resolved locally or by an external resolver.

WarningLevel

Severity level for a structured diagnostic.

Functions

apply_style_overrides

Parse a partial-style overlay (YAML or JSON) and merge it over style in place.

format_document

Format a complete document’s citations and bibliography (convenience wrapper).

format_document_with_resolver

Format a document, resolving the style through an injected resolver.

format_document_with_style

Format a document using an already-resolved style.

unknown_enum_warnings

Scan the style and bibliography for unknown enum variants and term keys.

unknown_reference_class_warnings

Scan the bibliography for unknown reference classes and return compatibility warnings.