Package-level declarations

The read/write entry points: EpubReader, EpubWriter, and the BookProcessor pipeline for transforming a Book during reading or writing.

Types

Link copied to clipboard
interface BookProcessor

Post-processes a book.

Link copied to clipboard
class BookProcessorPipeline(bookProcessors: MutableList<BookProcessor> = mutableListOf()) : BookProcessor

A book processor that combines several other bookprocessors

Link copied to clipboard

Low-level XML helpers used across the EPUB reader/writer code.

Link copied to clipboard

Reads an EPUB file.

Link copied to clipboard
class EpubWriter(bookProcessor: BookProcessor = BookProcessorPipeline( mutableListOf(StylesheetLinker()) ))

Generates an EPUB file. Not thread-safe, single-use.

Link copied to clipboard
interface HtmlProcessor

Hook for transforming an HTML/XHTML Resource's contents during EPUB generation — e.g. tag rewriting, sanitizing, or dropping legacy markup.

Link copied to clipboard

Reads and writes the NCX (Navigation Control file for XML) document defined by namespace http://www.daisy.org/z3986/2005/ncx/.

Link copied to clipboard

Functionality shared by the PackageDocumentReader and the PackageDocumentWriter

Link copied to clipboard

Reads the OPF package document defined by namespace http://www.idpf.org/2007/opf.

Link copied to clipboard

Writes the OPF package document defined by namespace http://www.idpf.org/2007/opf.

Link copied to clipboard

Loads Resources out of EPUB archives.

Link copied to clipboard

Injects <link rel="stylesheet" .../> tags into every XHTML resource for each href in Book.stylesheets. Idempotent — re-running it (or running it on a book that already has links) is a no-op.