GSoC/2024/StatusReports/Ajay Chauhan

Port Arianna to Foliate-js

Arianna reader uses the epub.js, which is no longer actively maintained. This creates a challenge as the epub.js may not be able to keep up with the evolving standards and new changes. To address this issue, the proposed solution is to port Arianna to Foliate-js, which is an actively maintained epub renderer and has more features compared to epub.js and is used by the Foliate ebook reader.

The problem that this project aims to solve is the need for a reliable and up-to-date epub rendering solution for the Arianna ebook reader.

Mentor

Carl Schwan

Work report

Week 1-2:

• Thoroughly reviewed the existing epub.js (epub-viewer.js) implementation in Arianna, identifying features and functionalities to be ported to foliate-js.
• Understood the usage of epub.js in Arianna, including rendering, navigation, annotations, and user interactions

Week 3-6:

• Identified all places where epub.js (epub-viewer.js) is integrated with Qt in Arianna, comparing it to foliate-js's implementation of the same features.
• Prepared a draft merge request to document the changes made.
• Started implementing the core rendering functionality in foliate-js, using the view.js module to create the main rendering component and implementing the open() method to load the book. [1] [2]

Week 6-8

• Familiarised myself with the current Foliate ebook reader implementation of the foliate-js.
• I was very inactive during this period due to my end semester exams.

Week 9-11:

• Fixed the book loading process. My mentor helped with this. [3]
• Ported the Table of Contents (TOC) functionality to allow navigation through the book’s structure.[4]
• Added metadata handling to update the backend, inform the app when the book is ready. [5]

Screenshot of a progress bar and table of contents (TOC)

Week 12-13:

• Fixed rendering issues that were causing the book to not be visible on the screen. My mentor assisted me with this.[6]
• Resolved text color issues in light theme mode to improve readability and maintain visual consistency[7]
• Enabled navigation buttons by setting backend.locationsReady to true in the ready case[8]
• Theme Color Handling: Improved the handling of theme colors, ensuring a consistent visual experience across different themes.[9]

Week 14-15:

• Fix Slider and Update Progress Percentage: Fixed the slider functionality to correctly reflect the progress percentage, ensuring accurate progress tracking for users.[10]
• Fixed slider functionality, ensuring the reading position is accurately reflected when users interact with the slider.[11]
• Text Color in Light Theme: Resolved text color issues in the light theme mode [12]
• Resolved issues with the book progress display, update time left calculation, and popup behavior [13]

Links to Blogs and other writing

• Blog Post #1
• Blog Post #2