Skip to main content

citum_engine/api/
mod.rs

1/*
2SPDX-License-Identifier: MIT OR Apache-2.0
3SPDX-FileCopyrightText: © 2023-2026 Bruce D'Arcus
4*/
5
6//! Interactive document-level API for batch citation formatting.
7//!
8//! This module provides the Tier 1 `format_document` API, enabling whole-document
9//! citation and bibliography rendering with proper context (note positions, ibid
10//! detection, disambiguation).
11
12mod document;
13pub mod forward_compat;
14mod style_input;
15mod types;
16
17pub use document::{
18    FormatDocumentError, FormatDocumentRequest, FormatDocumentResult, format_document,
19    format_document_with_style, unknown_enum_warnings, unknown_reference_class_warnings,
20};
21pub use forward_compat::{UnknownFieldPath, collect_unknown_field_paths};
22pub use style_input::StyleInput;
23pub use types::{
24    AbbreviationMap, AnnotationFormat, AnnotationStyle, BibliographyEntry, CitationOccurrence,
25    CitationOccurrenceItem, DocumentOptions, EntryMetadata, FormattedBibliography,
26    FormattedCitation, OutputFormatKind, Warning, WarningLevel,
27};