Readwyn 0.1.0

What is an OEB package, and how to open one

An OEB package is a book in the Open eBook format, which came before EPUB: the chapters and images of the book, plus a package file that lists them. To open one, add it to Readwyn as a ZIP file (ending in .zip or .oeb) with its package file inside. Readwyn makes an EPUB 3 from it straight away and leaves the ZIP untouched; “Read” opens the EPUB.

Versions and the table of contents

Three versions are supported: OEB 1.0, 1.0.1 and 1.2. The version comes from the DOCTYPE of the package file, for example DTD OEB 1.0.1 Package.

An OEB package has no NCX. Readwyn builds the table of contents (both the EPUB 3 navigation and an NCX) from the contents page that the package’s guide points to.

File paths and highlights

Every file keeps its path inside the book, and not a character of the text changes. So a highlight you make in the EPUB 3 holds in the OEB package too: it points to the same file and the same words. EPUB 2 books convert the same way, file paths and all (EPUB 2 or EPUB 3: what changes when your books are converted). A package that won’t convert stays in the library as the ZIP alone.

How well it’s tested

The aim was five real public-domain books for each OEB version. The search turned up one, an OEB 1.0.1 book, and it passes every check. The converter handles 1.0 and 1.2 as well, but no real book in either version was found to prove it.