text-document-common 1.9.0

Shared entities, database, events, and undo/redo infrastructure for text-document
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

//! Book-level metadata for EPUB export.
//!
//! Unlike [`super::docx_options::DocxExportOptions`] (page geometry + typography — DOCX has no
//! notion of "book metadata"), an EPUB package is built around exactly this: title, author,
//! language, and reading direction are OPF/package-level metadata fields, not per-block
//! formatting. There is no "plain" EPUB the way `to_docx` has docx-rs's built-in defaults — every
//! field here lands somewhere in the generated `.epub`, so [`Default`] picks the most harmless
//! values ("Untitled" title, empty author, `en` language, LTR) rather than leaving them unset.

use serde::{Deserialize, Serialize};

/// Book-level metadata for an EPUB export. Every field is required by the container format in
/// some form, so unlike [`super::docx_options::DocxExportOptions`] there is no "no overrides"
/// default that matches an unconfigured EPUB — [`Default`] instead picks the most reasonable
/// placeholders.
#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize)]
pub struct EpubExportOptions {
    /// Book title, used for the package's `dc:title` and (when a chapter has no heading of its
    /// own — the front-matter chapter, or the whole document when it has no headings at all) as
    /// that chapter's title too.
    pub title: String,
    /// Author name, used for the package's `dc:creator`. Empty ⇒ no author is emitted.
    pub author: String,
    /// BCP-47/ISO 639-1 language code (e.g. `"en"`, `"fr"`), used for the package's `dc:language`
    /// and every chapter XHTML document's `xml:lang`/`lang`. Empty ⇒ `"en"`.
    pub language: String,
    /// Right-to-left reading direction: sets the package's `page-progression-direction` to `rtl`
    /// and adds `dir="rtl"` to every chapter's `<html>` element.
    pub rtl: bool,
    /// Bytes for the book's inline images, keyed by their `src`. Each one is
    /// written into the package and listed in the OPF manifest; an image with no
    /// entry here degrades to its alt text.
    #[serde(default)]
    pub images: super::image_options::ExportImages,
    /// The book's cover.
    ///
    /// Separate from [`Self::images`] because a cover is not inline content: it
    /// is never referenced by a `src` in the prose, it is marked in the OPF
    /// manifest so a reader shows it in the library rather than mid-chapter, and
    /// it gets a page of its own at the front of the book. `None` ⇒ no cover,
    /// which is what every EPUB this crate produced before the field existed.
    #[serde(default)]
    pub cover: Option<super::image_options::ExportImage>,
}