package oepub

  1. Overview
  2. Docs

Module OepubSource

A library to read files in epub archive with some abilities to generate a book (ie. a list of chapters)

To open an epub archive, use EpubArchive.parse.

To extract the epub archive content into a list of chapters, see the module Book. See also the ChapterContents, which provides implementations to generate books.

Sourcemodule Book : sig ... end

Module to build a book from an epub archive.

Sourcemodule ChapterContents : sig ... end

Exemples implementations of Book.ChapterContent.

Sourcemodule EpubArchive : sig ... end

Entry point of the library to open epub archive

Sourcemodule Error : sig ... end

Module representing errors in the epub structure or in the xml.

Sourcemodule Metadata : sig ... end

Module representing the matadata tag in content.opf. Currently, the tag namespace are deleted.

Sourcemodule Manifest : sig ... end

Module representing the manifest tag in content.opf. Manifest entries are represented as a map where the key is their id and the value is ref

Sourcemodule Nav : sig ... end

Module representing the Navmap with its Navpoint contained in toc.ncx

Sourcemodule Opf : sig ... end

Module representing the content.opf file in the epub archive.

Sourcemodule Spine : sig ... end

Module representing the spine tag in content.opf.

Sourcemodule Toc : sig ... end

Module representing the toc.ncx. Currently, the head tag is ignored.