package oepub

You can search for identifiers within the package.

in-package search v0.2.0

oepub
- Oepub
  - Book
    
    Chapter
    
    ChapterContent
    
    Make
    
    ChapterContent
  - ChapterContents
    
    ImagedText
    
    Text
  - EpubArchive
  - Error
  - Manifest
  - Metadata
  - Nav
  - Opf
  - Spine
  - Toc

Legend:
Library
Module
Module type
Parameter
Class
Class type

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.

module Book : sig ... end

Module to build a book from an epub archive.

module ChapterContents : sig ... end

Exemples implementations of Book.ChapterContent.

module EpubArchive : sig ... end

Entry point of the library to open epub archive

module Error : sig ... end

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

module Metadata : sig ... end

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

module 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

module Nav : sig ... end

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

module Opf : sig ... end

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

module Spine : sig ... end

Module representing the spine tag in content.opf.

module Toc : sig ... end

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