oxidoc-print 0.1.8

Print/PDF pipeline for Oxidoc — converts RDX AST to publication-quality PDFs via oxipdf
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
138
139
140
141
142
143
144

use oxipdf::ir::units::Pt;
use std::path::PathBuf;

/// Top-level configuration for the print pipeline.
pub struct PrintConfig {
    pub page: PageConfig,
    pub fonts: FontConfig,
    pub typography: TypographyConfig,
    /// Root directory for resolving relative asset paths (images, bib files).
    pub project_root: PathBuf,
    /// Debug mode: draw colored borders on every element showing its computed box.
    pub debug_boxes: bool,
}

impl PrintConfig {
    /// Sensible defaults for A4 academic documents.
    pub fn default_with_root(project_root: PathBuf) -> Self {
        Self {
            page: PageConfig::default(),
            fonts: FontConfig::default(),
            typography: TypographyConfig::default(),
            project_root,
            debug_boxes: false,
        }
    }
}

/// Page dimensions and margins.
pub struct PageConfig {
    pub size: PageSize,
    /// Margins in points. For recto/verso, `left` is inner (binding) and `right` is outer.
    pub margin_top: Pt,
    pub margin_bottom: Pt,
    pub margin_inner: Pt,
    pub margin_outer: Pt,
}

impl Default for PageConfig {
    fn default() -> Self {
        Self {
            size: PageSize::A4,
            margin_top: Pt::new(72.0), // 1 inch
            margin_bottom: Pt::new(72.0),
            margin_inner: Pt::new(72.0),
            margin_outer: Pt::new(72.0),
        }
    }
}

/// Standard page sizes.
#[derive(Debug, Clone, Copy)]
pub enum PageSize {
    A4,
    Letter,
    /// Custom size in points.
    Custom {
        width: Pt,
        height: Pt,
    },
}

impl PageSize {
    pub fn width(self) -> Pt {
        match self {
            Self::A4 => Pt::new(595.276),
            Self::Letter => Pt::new(612.0),
            Self::Custom { width, .. } => width,
        }
    }

    pub fn height(self) -> Pt {
        match self {
            Self::A4 => Pt::new(841.890),
            Self::Letter => Pt::new(792.0),
            Self::Custom { height, .. } => height,
        }
    }
}

/// Font family configuration.
pub struct FontConfig {
    pub body: String,
    pub heading: String,
    pub mono: String,
    /// Additional directories to search for font files.
    pub font_dirs: Vec<PathBuf>,
}

impl Default for FontConfig {
    fn default() -> Self {
        Self {
            body: "Noto Serif".into(),
            heading: "Noto Sans".into(),
            mono: "Noto Sans Mono".into(),
            font_dirs: Vec::new(),
        }
    }
}

/// Typography settings — font sizes, spacing, colors for each element type.
pub struct TypographyConfig {
    pub body_size: Pt,
    pub body_line_height: f64,
    pub heading_sizes: [Pt; 6],
    pub code_size: Pt,
    pub code_line_height: f64,
    /// Paragraph spacing (margin-bottom).
    pub paragraph_spacing: Pt,
    /// Heading spacing above.
    pub heading_spacing_above: Pt,
    /// Heading spacing below.
    pub heading_spacing_below: Pt,
    /// List item indent per nesting level.
    pub list_indent: Pt,
    /// Blockquote left margin.
    pub blockquote_indent: Pt,
    /// Code block padding.
    pub code_padding: Pt,
}

impl Default for TypographyConfig {
    fn default() -> Self {
        Self {
            body_size: Pt::new(11.0),
            body_line_height: 1.4,
            heading_sizes: [
                Pt::new(26.0), // h1
                Pt::new(20.0), // h2
                Pt::new(16.0), // h3
                Pt::new(13.0), // h4
                Pt::new(11.0), // h5
                Pt::new(11.0), // h6
            ],
            code_size: Pt::new(9.0),
            code_line_height: 1.4,
            paragraph_spacing: Pt::new(6.0),
            heading_spacing_above: Pt::new(12.0),
            heading_spacing_below: Pt::new(4.0),
            list_indent: Pt::new(24.0),
            blockquote_indent: Pt::new(24.0),
            code_padding: Pt::new(10.0),
        }
    }
}