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 and Citum contributors
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 refs_input;
15mod style_input;
16mod types;
17
18pub use document::{
19    FormatDocumentError, FormatDocumentRequest, FormatDocumentResult, format_document,
20    format_document_with_resolver, format_document_with_style, unknown_enum_warnings,
21    unknown_reference_class_warnings,
22};
23pub use forward_compat::{UnknownFieldPath, collect_unknown_field_paths};
24pub use refs_input::RefsInput;
25pub use style_input::StyleInput;
26pub use types::{
27    AbbreviationMap, AnnotationFormat, AnnotationStyle, BibliographyEntry, CitationOccurrence,
28    CitationOccurrenceItem, DocumentOptions, EntryMetadata, FormattedBibliography,
29    FormattedCitation, OutputFormatKind, Warning, WarningLevel,
30};