What is Readium-2?
This led many of us to conclude that it might well be time to step back from the current Readium codebase and approach and do some serious re-thinking.
Goals of Readium-2
The goal of Readium was, initially, to develop a POC for the EPUB 3 spec, followed by developing a SDK that could be used to develop EPUB 3 reading systems. The overarching goal of R2 is to re-think, from the ground up, that goal. Instead of developing an engine (or engines) for interpreting EPUB markup for integration into apps or devices, the goal is to develop a framework for interpreting and rendering digital publishing markup.
This framework will consist of leveraging all the capabilities of the existing browser engines and supplementing those capabilities with separate modules (polyfills, if you will) that provide additional functionality. These additional modules are intended to be, insofar as possible, independent of one or another so that they can be used independently of the overall framework. At the same time, these polyfills will be designed so that they CAN be easily and seamlessly combined to produce complete reading systems.
These different implementations will share the same architecture, model, interfaces; a developer should therefore be able to switch from one implementation to another without feeling lost.
The project is split in four phases:
- Report on the good and bad aspects of the current Readium implementation. This report is driven by the interview of those application developers who have intensively used Readium (readium-js and/or readium-sdk) and, for some of them, forked the code to obtain what was needed in their application. This study includes a compilation of problematic EPUB samples and technical details about the areas where the Readium code should be optimized.
- Study of the Readium-2 design principles
- Study of a refactored architecture for the codebase, following the approved design principles; developement of prototypes.
- Actual coding of the Readium-2 toolkit.
The first phase has been achieved in September 2016. Its results have been described to the Readium members and should be soon published online on the Readium documentation website.
The second phase has started in September 2016. The discussion is active on the Readium-2 github repository, as github issues and Slack chats. Please look at the wiki page if you want to participate to the work. Some POCs have already been developed and are referenced in the repository.