Expand description
EPUB build functionality
This module provides functionality for creating and building EPUB eBook files.
The EpubBuilder structure implements the build logic of the EPUB 3.0 specification,
allowing users to create standard-compliant EPUB files from scratch.
§Usage
use lib_epub::{
builder::{EpubBuilder, EpubVersion3},
types::{MetadataItem, ManifestItem, SpineItem},
};
let mut builder = EpubBuilder::<EpubVersion3>::new()?;
builder
.add_rootfile("OEBPS/content.opf")?
.add_metadata(MetadataItem::new("title", "Test Book"))
.add_manifest(
"path/to/content",
ManifestItem::new("content_id", "target/path")?,
)?
.add_spine(SpineItem::new("content.xhtml"));
builder.build("output.epub")?;§Notes
- Requires
builderfeature to use this module. - All resource files must exist on the local file system.
- At least one rootfile must be added before adding manifest items.
- Required metadata includes:
title,language, andidentifierwith idpub-id.
Modules§
- content
- Epub content build functionality
Structs§
- Catalog
Builder - Catalog builder for EPUB navigation
- Document
Builder - Epub
Builder - EPUB Builder
- Epub
Version3 - Manifest
Builder - Manifest builder for EPUB resources
- Metadata
Builder - Metadata builder for EPUB publications
- Rootfile
Builder - Rootfile builder for EPUB container
- Spine
Builder - Spine builder for EPUB reading order