citum-schema-data 0.53.2

Citum bibliographic data schema types
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

/*
SPDX-License-Identifier: MIT OR Apache-2.0
SPDX-FileCopyrightText: © 2023-2026 Bruce D'Arcus
*/

//! Data input models for Citum references, citations, and bibliographies.

use indexmap::IndexMap;
#[cfg(feature = "schema")]
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
#[cfg(feature = "bindings")]
use specta::Type;
use std::collections::HashMap;

/// Document-level abbreviation map type.
pub mod abbreviation;
/// Declarative macros.
#[macro_use]
pub mod macros;
/// Citation input model.
#[allow(missing_docs, reason = "internal derives")]
pub mod citation;
/// Bibliographic reference data types.
#[allow(missing_docs, reason = "internal derives")]
pub mod reference;

pub use abbreviation::AbbreviationMap;
pub use citation::{
    Citation, CitationItem, CitationMode, Citations, IntegralNameState, LocatorType, Position,
};

/// A collection of bibliographic references with optional metadata.
#[derive(Debug, Default, Deserialize, Serialize, Clone)]
#[cfg_attr(feature = "schema", derive(JsonSchema))]
#[cfg_attr(feature = "bindings", derive(Type))]
#[serde(rename_all = "kebab-case")]
pub struct InputBibliography {
    /// Bibliography metadata.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub info: Option<InputBibliographyInfo>,
    /// The list of references.
    pub references: Vec<reference::InputReference>,
    /// Optional compound entry sets keyed by set id.
    ///
    /// Each set id maps to an ordered list of reference ids that should be treated
    /// as one compound numeric group when `compound-numeric` is enabled by style.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(
        feature = "schema",
        schemars(with = "Option<std::collections::BTreeMap<String, Vec<String>>>")
    )]
    pub sets: Option<IndexMap<String, Vec<String>>>,
    /// Custom user-defined fields for extensions.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "bindings", specta(type = Option<serde_json::Value>))]
    pub custom: Option<HashMap<String, serde_json::Value>>,
}

/// Metadata for an input bibliography.
#[derive(Debug, Default, Deserialize, Serialize, Clone)]
#[cfg_attr(feature = "schema", derive(JsonSchema))]
#[cfg_attr(feature = "bindings", derive(Type))]
#[serde(rename_all = "kebab-case")]
pub struct InputBibliographyInfo {
    /// Human-readable title for the bibliography dataset.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub title: Option<String>,
    /// Creator or maintainer of the bibliography dataset.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub author: Option<String>,
}