mdbook-bib 0.5.3

mdbook plugin allowing to load and present a bibliography in BibLaTex format in your books and cite its references
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

use serde::{Deserialize, Serialize};
use std::sync::Arc;

/// Bibliography item representation.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct BibItem {
    // === Core fields (existing, maintained for backward compatibility) ===
    /// The citation key.
    pub citation_key: String,
    /// The article's title.
    pub title: String,
    /// The article's author/s in the format [[Last, First], [Last, First], ...].
    pub authors: Vec<Vec<String>>,
    /// Publication month (1-12 as zero-padded string).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub pub_month: Option<String>,
    /// Publication year as string.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub pub_year: Option<String>,
    /// Summary/Abstract.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub summary: Option<String>,
    /// The article's URL.
    pub url: Option<String>,
    /// The item's index for first citation in the book.
    pub index: Option<u32>,

    // === Extended fields from hayagriva (new, all optional for backward compatibility) ===
    /// Entry type (Article, Book, Inproceedings, etc.).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub entry_type: Option<String>,

    /// Digital Object Identifier.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub doi: Option<String>,

    /// Page range (e.g., "123-145").
    #[serde(skip_serializing_if = "Option::is_none")]
    pub pages: Option<String>,

    /// Volume number.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub volume: Option<String>,

    /// Issue/Number.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub issue: Option<String>,

    /// Publisher name.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub publisher: Option<String>,

    /// Publisher's address/location.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub address: Option<String>,

    /// International Standard Book Number.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub isbn: Option<String>,

    /// International Standard Serial Number.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub issn: Option<String>,

    /// Editor(s) in the same format as authors.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub editor: Option<Vec<Vec<String>>>,

    /// Edition (e.g., "2nd", "Revised").
    #[serde(skip_serializing_if = "Option::is_none")]
    pub edition: Option<String>,

    /// Additional notes.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub note: Option<String>,

    /// Organization (for conference proceedings).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub organization: Option<String>,

    // === Internal fields for CSL rendering ===
    /// Original hayagriva Entry for CSL rendering.
    /// This is kept for CSL backend to use with BibliographyDriver.
    #[serde(skip)]
    pub hayagriva_entry: Option<Arc<hayagriva::Entry>>,
}

impl BibItem {
    /// Create a new bib item with core fields (for backward compatibility).
    /// Extended fields are initialized to None.
    #[allow(dead_code)]
    pub fn new(
        citation_key: &str,
        title: String,
        authors: Vec<Vec<String>>,
        pub_month: Option<String>,
        pub_year: Option<String>,
        summary: Option<String>,
        url: Option<String>,
    ) -> BibItem {
        BibItem {
            citation_key: citation_key.to_string(),
            title,
            authors,
            pub_month,
            pub_year,
            summary,
            url,
            index: None,
            // Extended fields default to None
            entry_type: None,
            doi: None,
            pages: None,
            volume: None,
            issue: None,
            publisher: None,
            address: None,
            isbn: None,
            issn: None,
            editor: None,
            edition: None,
            note: None,
            organization: None,
            hayagriva_entry: None,
        }
    }
}

/// Citation context for rendering.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Citation {
    pub item: BibItem,
    pub path: String,
    /// Citation variant as string for template use: "standard", "author_in_text", "parenthetical", "suppress_author"
    #[serde(default)]
    pub variant: String,
}