Skip to content
master
Switch branches/tags
Code

Latest commit

This proposal introduces a new Navigator API to draw decorations on top of publications, in a media type agnostic way. This new API is a building block for a variety of features which need to draw user interface elements (decorations) over a publication's content, such as:

* highlighting a text selection
* displaying search results
* underlining spoken text with speech synthesis
* annotating a piece of content with an icon or button
* drawing side marks in the margin
dc939bf

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Readium Architecture

All Readium implementations (mobile, desktop or Web) are split in two main modules, which use the Readium Web Publication Manifest to communicate together.

On the Web, the Publication Server is responsible for serving a Readium Web Publication Manifest and the resources of a publication over HTTPS.

In native apps, the Streamer is responsible for parsing packaged publications and exposing them using an in-memory model.

On all platforms, the Navigator is meant to navigate in the resources of a publication and can adopt very different strategy based on the nature of the publication (ebooks, audiobooks and comics).

These modules are not necessarily meant to be deployed on the same device or written in the same language, which lets developers select the best implementation based on their requirements.

Diagram of the Readium Architecture

Components

Models

Main Modules

Services

Projects

Ecosystem

Take a look at our dedicated awesome-readium repository to explore the ecosystem built around Readium.

About

πŸ“š Documents the architecture of the Readium project

Topics

Resources

License

Releases

No releases published

Packages

No packages published