Skip to content

Conversation

@pauliyobo
Copy link
Collaborator

This PR aims to introduce daisy support into bookworm.
Currently, the daisy format targeted is daisy 3.
Since adding media support isn't trivial in our case, only text books will be supported.
While the PR is being finalized, artifacts derived from this branch will have documents with the .zip extension temporarily disabled since daisy books often use the same extension, and a builtin mechanism to distinguish them hasn't been added yet.
@mush42 @cary-rowen this might be interesting for you.
fixes #309
fixes #122

@pauliyobo pauliyobo marked this pull request as draft June 24, 2025 23:41
@mush42
Copy link
Collaborator

mush42 commented Jul 5, 2025

@pauliyobo great work. Will test soon.

@amirsol81
Copy link

amirsol81 commented Jul 6, 2025

@pauliyobo @mush42 I'm testing this great feature. While it works, the status quo has the following issues:

  1. No Heading/ link navigation is supported. So navigation by H or SHIFT+H doesn't work even if DAISY books support it. Internal/ external links aren't displayed or supported either.
  2. Maybe as a consequence of the previous issue, the Element list is also unavailable. So Control+F7 cannot be used to bring it up.

Thanks.

@amirsol81
Copy link

@pauliyobo @mush42 Any progress on this? In particular, any chance of enabling heading navigation and access to the elements list?

@pauliyobo
Copy link
Collaborator Author

Hello,
@amirsol81 would you be able to provide a sample? I unfortunately do not have access to daisy book with that kind of content to test with on my machine.

@amirsol81
Copy link

The_Theory_of_the_Leisure_Class.zip
@pauliyobo Greetings. Thanks for the time you dedicate to this. A Bookshare DAISY file, which is a free-domain book, is attached. It contains a good number of headings, and very well demonstrates the issues I reported.

@pauliyobo
Copy link
Collaborator Author

@amirsol81
Structured navigation should work properly now.

@amirsol81
Copy link

@amirsol81 Structured navigation should work properly now.

@pauliyobo Thanks! Great job! Now heading navigation and Elements list, via Control+F7, work as expected. However, links in DAISY documents cannot be activated by pressing Control+Enter on them. Links are properly detected, but pressing Control+Enter on them does nothing. The provided DAISY book above also has many internal links to demonstrate the issue.

@amirsol81
Copy link

So @pauliyobo can something be done for the remaining "links" issue? As I mentioned above, Bookworm cannot activate links in DAISY books via Control+Enter.

@pauliyobo
Copy link
Collaborator Author

@amirsol81 links should be functioning properly now.

@amirsol81
Copy link

@amirsol81 links should be functioning properly now.

@pauliyobo Thanks! Very much appreciated.

@amirsol81
Copy link

@pauliyobo It seems that the installers for this pull request are no longer available, or I can't find them. Would you please provide the download links at least for Windows 64-Bit? I want to test fixed links in DAISY books.
Thanks.

@pauliyobo
Copy link
Collaborator Author

Hello.
@amirsol81 you should be able to find the latest artifacts now.

@amirsol81
Copy link

@pauliyobo Thanks for your awesome efforts! I just grabbed it.
looking forward to other fixes including stuff affecting the database for bookmarks and notes.

@amirsol81
Copy link

@pauliyobo I downloaded the latest 64-Bit release based on your latest fix. However, on Windows 11 25H2 it can't normally. It should be run as Admin only to work, unlike previous builds.

@cary-rowen
Copy link
Collaborator

I suspect that NSIS is causing the problem, which is not present in my local build. Another problem is that the Portable version does not start.
Will investigate

@amirsol81
Copy link

amirsol81 commented Oct 23, 2025

@cary-rowen Thanks - much appreciated. Also the app's start-up time is overly long even on powerful machines. Any chance of reducing it?
@pauliyobo Unfortunately internal links inside DAISY files still can't be activated with Control+Enter. So your latest solution hasn't actually fixed the internal link problem.

@cary-rowen
Copy link
Collaborator

@amirsol81
You can try the develop-based build here, which should have solved the problem of requiring administrator privileges and the portable version not starting.

@amirsol81
Copy link

@cary-rowen Thanks! This build fixes the issue.

@pauliyobo
Copy link
Collaborator Author

@amirsol81
the book you previously provided does not appear to have internal anchors. Would you happen to have a sample with them?
I have checked the actual book content, and the only potential internal anchor is a link which does not have a href attribute, which kind of makes it a broken link.

@amirsol81
Copy link

@pauliyobo Thanks, but the table of contents section of the book contains valid internal links to the beginning of chapters, and both the Kurzweil 1000 and QRead can detect and activate them.

@amirsol81
Copy link

@pauliyobo Please take a look at the second free-domain Bookshare DAISY book I'm providing here. The Contents section has
Hamlet.zip
internal links. QRead and the Kurzweil 1000 can detect and activate them.

@pauliyobo
Copy link
Collaborator Author

@amirsol81
Much appreciated. It should be solved now.

@amirsol81
Copy link

amirsol81 commented Oct 25, 2025 via email

@amirsol81
Copy link

amirsol81 commented Oct 25, 2025 via email

@cary-rowen
Copy link
Collaborator

@amirsol81
Download here

@cary-rowen
Copy link
Collaborator

Hello @pauliyobo

While the PR is being finalized, artifacts derived from this branch will have documents with the .zip extension temporarily disabled since daisy books often use the same extension, and a builtin mechanism to distinguish them hasn't been added yet.

Should we just support Daisy and drop zip? I don't know much about this, do you have any further thoughts?

@pauliyobo
Copy link
Collaborator Author

@cary-rowen honestly I have no idea either.
I don't know how much archive documents are being used.
I'd be ok with dropping support for the actual archive format after a release though.
I think @mush42 may have more context for this.

@cary-rowen
Copy link
Collaborator

Yes, I think a well-defined Daisy format makes more sense than a general zip archive format.

@amirsol81
Copy link

@cary-rowen Thanks. I grabbed it.
@pauliyobo Great job! Internal links now work as expected. And one relevant point. I think it would be better to keep support for DAISY books inside zipped archives. After all, most people download DAISY books from Bookshare which are zipped, and unzipping them takes time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Ability to read daisy opf and ncc html files. Support for daisy books

5 participants