rdocx-html 0.7.0

DOCX-to-HTML and DOCX-to-Markdown conversion
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224

#![doc = include_str!("../README.md")]

mod css;
mod emitter;
mod markdown;
mod sanitize;

use std::collections::HashMap;

use rdocx_oxml::document::CT_Document;
use rdocx_oxml::numbering::CT_Numbering;
use rdocx_oxml::styles::CT_Styles;

/// Options for HTML conversion.
#[derive(Debug, Clone)]
pub struct HtmlOptions {
    /// Whether to inline images as base64 data URIs (default: true).
    pub inline_images: bool,
}

impl Default for HtmlOptions {
    fn default() -> Self {
        Self {
            inline_images: true,
        }
    }
}

/// Input for HTML conversion.
pub struct HtmlInput {
    pub document: CT_Document,
    pub styles: CT_Styles,
    pub numbering: Option<CT_Numbering>,
    /// Images keyed by embed/relationship ID.
    pub images: HashMap<String, ImageData>,
    /// Hyperlink URLs keyed by relationship ID.
    pub hyperlink_urls: HashMap<String, String>,
}

/// Image data for HTML embedding.
pub struct ImageData {
    pub data: Vec<u8>,
    pub content_type: String,
}

/// Convert a DOCX document to a complete HTML document string.
pub fn to_html_document(input: &HtmlInput, options: &HtmlOptions) -> String {
    let body = to_html_fragment(input, options);
    let css = css::generate_base_css();
    format!(
        "<!DOCTYPE html>\n<html>\n<head>\n<meta charset=\"UTF-8\">\n<style>\n{css}\n</style>\n</head>\n<body>\n{body}\n</body>\n</html>"
    )
}

/// Convert a DOCX document to an HTML fragment (body content only).
pub fn to_html_fragment(input: &HtmlInput, options: &HtmlOptions) -> String {
    emitter::emit_body(
        &input.document.body,
        &input.styles,
        input.numbering.as_ref(),
        &input.images,
        &input.hyperlink_urls,
        options,
    )
}

/// Convert a DOCX document to Markdown.
pub fn to_markdown(input: &HtmlInput) -> String {
    markdown::emit_markdown(
        &input.document.body,
        &input.styles,
        input.numbering.as_ref(),
        &input.hyperlink_urls,
    )
}

#[cfg(test)]
mod tests {
    use super::*;
    use rdocx_oxml::document::{BodyContent, CT_Document};
    use rdocx_oxml::styles::CT_Styles;
    use rdocx_oxml::text::CT_P;

    fn simple_input(text: &str) -> HtmlInput {
        let mut doc = CT_Document::new();
        let mut p = CT_P::new();
        p.add_run(text);
        doc.body.add_paragraph(p);

        HtmlInput {
            document: doc,
            styles: CT_Styles::new_default(),
            numbering: None,
            images: HashMap::new(),
            hyperlink_urls: HashMap::new(),
        }
    }

    #[test]
    fn html_document_basic() {
        let input = simple_input("Hello, World!");
        let html = to_html_document(&input, &HtmlOptions::default());
        assert!(html.contains("<!DOCTYPE html>"));
        assert!(html.contains("Hello, World!"));
        assert!(html.contains("<p"));
    }

    #[test]
    fn html_fragment_basic() {
        let input = simple_input("Test paragraph");
        let html = to_html_fragment(&input, &HtmlOptions::default());
        assert!(html.contains("Test paragraph"));
        assert!(html.contains("<p"));
        assert!(!html.contains("<!DOCTYPE"));
    }

    #[test]
    fn markdown_basic() {
        let input = simple_input("Test paragraph");
        let md = to_markdown(&input);
        assert!(md.contains("Test paragraph"));
    }

    #[test]
    fn html_heading() {
        let mut doc = CT_Document::new();
        let mut p = CT_P::new();
        p.add_run("Chapter 1");
        p.properties = Some(rdocx_oxml::properties::CT_PPr {
            style_id: Some("Heading1".to_string()),
            ..Default::default()
        });
        doc.body.add_paragraph(p);

        let input = HtmlInput {
            document: doc,
            styles: CT_Styles::new_default(),
            numbering: None,
            images: HashMap::new(),
            hyperlink_urls: HashMap::new(),
        };

        let html = to_html_fragment(&input, &HtmlOptions::default());
        assert!(html.contains("<h1"));
        assert!(html.contains("Chapter 1"));
    }

    #[test]
    fn html_table() {
        let mut doc = CT_Document::new();
        let mut tbl = rdocx_oxml::table::CT_Tbl::new();
        let mut row = rdocx_oxml::table::CT_Row::new();
        let mut cell = rdocx_oxml::table::CT_Tc::new();
        let mut p = CT_P::new();
        p.add_run("Cell text");
        cell.content = vec![rdocx_oxml::table::CellContent::Paragraph(p)];
        row.cells.push(cell);
        tbl.rows.push(row);
        doc.body.content.push(BodyContent::Table(tbl));

        let input = HtmlInput {
            document: doc,
            styles: CT_Styles::new_default(),
            numbering: None,
            images: HashMap::new(),
            hyperlink_urls: HashMap::new(),
        };

        let html = to_html_fragment(&input, &HtmlOptions::default());
        assert!(html.contains("<table"));
        assert!(html.contains("<td"));
        assert!(html.contains("Cell text"));
    }

    #[test]
    fn markdown_heading() {
        let mut doc = CT_Document::new();
        let mut p = CT_P::new();
        p.add_run("Title");
        p.properties = Some(rdocx_oxml::properties::CT_PPr {
            style_id: Some("Heading1".to_string()),
            ..Default::default()
        });
        doc.body.add_paragraph(p);

        let input = HtmlInput {
            document: doc,
            styles: CT_Styles::new_default(),
            numbering: None,
            images: HashMap::new(),
            hyperlink_urls: HashMap::new(),
        };

        let md = to_markdown(&input);
        assert!(md.contains("# Title"));
    }

    #[test]
    fn html_bold_italic() {
        let mut doc = CT_Document::new();
        let mut p = CT_P::new();
        let mut r = rdocx_oxml::text::CT_R::new("bold text");
        r.properties = Some(rdocx_oxml::properties::CT_RPr {
            bold: Some(true),
            italic: Some(true),
            ..Default::default()
        });
        p.runs.push(r);
        doc.body.add_paragraph(p);

        let input = HtmlInput {
            document: doc,
            styles: CT_Styles::new_default(),
            numbering: None,
            images: HashMap::new(),
            hyperlink_urls: HashMap::new(),
        };

        let html = to_html_fragment(&input, &HtmlOptions::default());
        assert!(html.contains("<strong"));
        assert!(html.contains("<em"));
        assert!(html.contains("bold text"));
    }
}