joseph edited this page Sep 23, 2011 · 5 revisions

Monocle is a silky, tactile browser-based ebook reader.

It is designed to be format-agnostic, and works very well with EPUB, Zhook, MOBI (presumably), and plain old HTML content. Monocle does the job of presenting multiple HTML "components" in a paginated user interface. You can see it in action on the Monocle homepage.

Getting started

  • Integrating Monocle into your project. (If you only read one wiki page, read this one.)
  • Building Monocle for production.

The basics

For a non-trivial Monocle implementation, your task is to connect the Monocle Reader to your book's HTML content and structure. You create something called "the book data object" to do this.

Advanced Monocle

Monocle is built to be extended. It's pretty flexible. You can create custom controls and custom page-turning interactions (called 'flippers' in Monocle). You can also hack away at the built-in styles. This section explains some of this stuff — but we also recommend that you explore some of the examples in the tests directory in this distribution.