[Plugin] Epub3 E-Reader Plugins for Sigil - Page 3

KevinH · 06-07-2021, 10:32 AM

Did you run epubcheck? There is an epubcheck plugin for Sigil to make this easy.

I just tried both an epub2 and an epub3 (our new user's guide) in Sigil with EpubJSReader plugin and they both worked flawlessly. There is a TOC icon in the upper left corner, that will produce a sidebar with the TOC properly nested. As I move my mouse over, the TOC entries they get highlighted. If I click on one, the book is moved to that place properly.

So it is working for both epub2 (toc.ncx) and epub3 (nav).

That is why you need to check it with epubcheck (unless that is identical to the idpf validator link) to detect things like missing nav properties on manifest items, etc.

So there is something specific about that epub that is creating the problem as well formed epub2 and epub3 seem to work fine in EPUBJS. I also tried a html toc and those links all worked as well.

KevinH · 06-07-2021, 10:38 AM

Or could it be some Anti Virus or Defender thing stopping local links from being opened?

If you want to you could post that epub3 someplace private and pm "KevinH" here on Mobileread with a link, I will try it on my machine to see if it is machine specific issue or a epub specific issue.

KevinH · 06-07-2021, 11:15 AM

Something even easier to try is to grab the very latest Sigil User Guide epub from here:

https://github.com/Sigil-Ebook/sigil...guide/releases

And load it into Sigil and launch the EpubJSReader plugin. Then hit the toc icon in the upper left hand corner of the reader and try navigating to one of the chapters via that TOC.

If that works, then we know the problem you are seeing is epub specific, If it fails, then the problem is machine specific (AV or other security tool or ...)

AndrewRyzhkin · 06-07-2021, 03:44 PM

Quote:

Originally Posted by KevinH

Something even easier to try is to grab the very latest Sigil User Guide epub from here:
https://github.com/Sigil-Ebook/sigil...guide/releases

Created a new simple epub with minimal editing. In the Sigil help, navigation works fine, so it's not about the antivirus.
newone.epub

DiapDealer · 06-07-2021, 07:11 PM

EpubJSReader seems to be butchering the valid hrefs in the nav when the nav is in the "Text" folder alongside the xhtml files. If I move it into the OEBPS folder (which is where the Sigil Guide's NAV is located), then the updated links ("Text/Section0001.xhtml") seem to work fine.

KevinH · 06-07-2021, 07:17 PM

I can't believe that EpubJS would work only when the nav is not in the same folder as the other xhtml files! That is horrible. I will see if anyone has reported it on the epubjs github site. Perhaps there is a fix there.

DiapDealer · 06-07-2021, 07:26 PM

I didn't do much testing, but I wouldn't be surprised if it's assuming the nav is in the same location as the opf and/or ncx.

KevinH · 06-07-2021, 07:43 PM

Here are three related bug reports ...

https://github.com/futurepress/epub.js/issues/1084

https://github.com/futurepress/epub.js/issues/1107

https://github.com/futurepress/epub.js/issues/469

It seems to confuse href from nav with an opf relative href. Since the ncx and the opf generally sit together this works but if the nav is in a Text folder it will not.

The 1084 issue has a suggested fix that was never incorporated. I will look into adding it.

KevinH · 06-08-2021, 08:27 AM

Okay, I found the bug location in the TocController code in reader.js. I will try to fix it there and if so post an updated EpubJSReader plugin.

DiapDealer · 06-08-2021, 09:52 AM

I remember there was something in the upstream Readium Reader code that we tweaked to get things working, too. Should we consider making forks of the relevant repositories so we can document the changes? Or at least keep patches? I think the change to Readium took place before our plugin repository was created. I can't seem to track down our early testing conversation where we found something wrong RE url encoding.

EDIT: whoops! Never mind. I see the included patch for Readium, now. Nothing to see here.

KevinH · 06-08-2021, 10:03 AM

I have forked the downstream git repos for epubjs and epubjsreader, bibi, and readium pieces on my local machine. Perhaps we should officially fork all of those under Sigil-Ebook as well just in case they ever get taken down for any reason.

I will post the epubjsreader (toc_controller.js) reader.js patch to the repo if I can get it working at all.

KevinH · 06-08-2021, 10:29 AM

I have updated EpubJSReader to version v0.3.0 that fixes the broken TOC behaviour on my machine with the newone.epub testcase provided.

The fix was a simplification of the approach suggested in Issue 1084 (see earlier link to that issue).
A patch file is now part of the repository.

Please see the first post in this thread for links to the latest release.

@AndrewRyzhkin
Please confirm this fixes the issue with your original epub as well when you get a chance.
Thanks for your bug report and test case!

AndrewRyzhkin · 06-08-2021, 01:24 PM

Quote:

Originally Posted by KevinH

Please confirm this fixes the issue

Yes, this problem is no longer in EpubJSReader! In all my books, the table of contents now works perfectly. Thank you so much for your work!

KevinH · 06-08-2021, 02:05 PM

Thanks for confirming the fix. I was able to simplify the bug fix patch by using an existing internal EPUBJS.core.resolveUrl(base, path) routine so I posted a v0.3.1 version.

This new v0.3.1 version has changed nothing from a user functionality standpoint since the v0.3.0 you tested. So feel free to skip this update as the version you have now is just fine.

RbnJrg · 06-11-2021, 01:32 PM

Maybe it would be possible for you, Kevin and Diap, to solve the following bug with EpubJSReader as you made with the TOC bug (or maybe wouldn't

).

Look at this picture with EpubJSReader, with the ereader in a window. The image has a width of 100% and you should see something like that:

Click image for larger version

Name: Image1.png
Views: 218
Size: 618.7 KB
ID: 187627

Now look at the same image but with the ereader at a full window:

Click image for larger version

Name: Image2.png
Views: 200
Size: 259.9 KB
ID: 187628

As you can see, the ereader doesn't respect the declared width of the image when its width is 100% and when someone is reading in a full window.

Now see the same case but with a image with a width of 50%:

Click image for larger version

Name: Image3.png
Views: 182
Size: 325.7 KB
ID: 187629

Click image for larger version

Name: Image4.png
Views: 212
Size: 136.6 KB
ID: 187630

With a image of 50%, EpubJSReader respects the size of the image (both, in a half or a full window). Below I attach the respective epub. Could this behaviour be fixed?

Thanks for your consideration.

EDIT: The issue doesn't appear with the Readium and Bibi plugins.

06-07-2021, 10:32 AM	#31
KevinH Sigil Developer Posts: 7,655 Karma: 5433388 Join Date: Nov 2009 Device: many	Did you run epubcheck? There is an epubcheck plugin for Sigil to make this easy. I just tried both an epub2 and an epub3 (our new user's guide) in Sigil with EpubJSReader plugin and they both worked flawlessly. There is a TOC icon in the upper left corner, that will produce a sidebar with the TOC properly nested. As I move my mouse over, the TOC entries they get highlighted. If I click on one, the book is moved to that place properly. So it is working for both epub2 (toc.ncx) and epub3 (nav). That is why you need to check it with epubcheck (unless that is identical to the idpf validator link) to detect things like missing nav properties on manifest items, etc. So there is something specific about that epub that is creating the problem as well formed epub2 and epub3 seem to work fine in EPUBJS. I also tried a html toc and those links all worked as well. Last edited by KevinH; 06-07-2021 at 10:34 AM.

06-07-2021, 07:11 PM	#35
DiapDealer Grand Sorcerer Posts: 27,553 Karma: 193191846 Join Date: Jan 2010 Device: Nexus 7, Kindle Fire HD	EpubJSReader seems to be butchering the valid hrefs in the nav when the nav is in the "Text" folder alongside the xhtml files. If I move it into the OEBPS folder (which is where the Sigil Guide's NAV is located), then the updated links ("Text/Section0001.xhtml") seem to work fine. Last edited by DiapDealer; 06-07-2021 at 07:26 PM.

06-08-2021, 10:29 AM	#42
KevinH Sigil Developer Posts: 7,655 Karma: 5433388 Join Date: Nov 2009 Device: many	I have updated EpubJSReader to version v0.3.0 that fixes the broken TOC behaviour on my machine with the newone.epub testcase provided. The fix was a simplification of the approach suggested in Issue 1084 (see earlier link to that issue). A patch file is now part of the repository. Please see the first post in this thread for links to the latest release. @AndrewRyzhkin Please confirm this fixes the issue with your original epub as well when you get a chance. Thanks for your bug report and test case! Last edited by KevinH; 06-08-2021 at 10:32 AM.

Similar Threads
Thread	Thread Starter	Forum	Replies	Last Post
[Plugin] ePub3-itizer - epub3 output plugin for Sigil	KevinH	Plugins	435	01-19-2023 09:46 PM
Errors Using plugins with Sigil	increase	Plugins	3	03-06-2020 05:08 AM
Sigil Plugins!	DiapDealer	Sigil	33	03-19-2016 08:18 PM
Sigil Plugins (for Sigil 0.7xx Alpha)	DiapDealer	Sigil	15	09-27-2014 05:21 PM
An epub3 version of Sigil ?	apulia03	Sigil	9	11-28-2012 01:07 AM

06-07-2021, 10:38 AM	#32
KevinH Sigil Developer Posts: 7,655 Karma: 5433388 Join Date: Nov 2009 Device: many	Or could it be some Anti Virus or Defender thing stopping local links from being opened? If you want to you could post that epub3 someplace private and pm "KevinH" here on Mobileread with a link, I will try it on my machine to see if it is machine specific issue or a epub specific issue.

06-07-2021, 11:15 AM	#33
KevinH Sigil Developer Posts: 7,655 Karma: 5433388 Join Date: Nov 2009 Device: many	Something even easier to try is to grab the very latest Sigil User Guide epub from here: https://github.com/Sigil-Ebook/sigil...guide/releases And load it into Sigil and launch the EpubJSReader plugin. Then hit the toc icon in the upper left hand corner of the reader and try navigating to one of the chapters via that TOC. If that works, then we know the problem you are seeing is epub specific, If it fails, then the problem is machine specific (AV or other security tool or ...)

06-07-2021, 07:17 PM	#36
KevinH Sigil Developer Posts: 7,655 Karma: 5433388 Join Date: Nov 2009 Device: many	I can't believe that EpubJS would work only when the nav is not in the same folder as the other xhtml files! That is horrible. I will see if anyone has reported it on the epubjs github site. Perhaps there is a fix there.

06-07-2021, 07:26 PM	#37
DiapDealer Grand Sorcerer Posts: 27,553 Karma: 193191846 Join Date: Jan 2010 Device: Nexus 7, Kindle Fire HD	I didn't do much testing, but I wouldn't be surprised if it's assuming the nav is in the same location as the opf and/or ncx.

06-07-2021, 07:43 PM	#38
KevinH Sigil Developer Posts: 7,655 Karma: 5433388 Join Date: Nov 2009 Device: many	Here are three related bug reports ... https://github.com/futurepress/epub.js/issues/1084 https://github.com/futurepress/epub.js/issues/1107 https://github.com/futurepress/epub.js/issues/469 It seems to confuse href from nav with an opf relative href. Since the ncx and the opf generally sit together this works but if the nav is in a Text folder it will not. The 1084 issue has a suggested fix that was never incorporated. I will look into adding it.

06-08-2021, 08:27 AM	#39
KevinH Sigil Developer Posts: 7,655 Karma: 5433388 Join Date: Nov 2009 Device: many	Okay, I found the bug location in the TocController code in reader.js. I will try to fix it there and if so post an updated EpubJSReader plugin.

06-08-2021, 09:52 AM	#40
DiapDealer Grand Sorcerer Posts: 27,553 Karma: 193191846 Join Date: Jan 2010 Device: Nexus 7, Kindle Fire HD	I remember there was something in the upstream Readium Reader code that we tweaked to get things working, too. Should we consider making forks of the relevant repositories so we can document the changes? Or at least keep patches? I think the change to Readium took place before our plugin repository was created. I can't seem to track down our early testing conversation where we found something wrong RE url encoding. EDIT: whoops! Never mind. I see the included patch for Readium, now. Nothing to see here.

06-08-2021, 10:03 AM	#41
KevinH Sigil Developer Posts: 7,655 Karma: 5433388 Join Date: Nov 2009 Device: many	I have forked the downstream git repos for epubjs and epubjsreader, bibi, and readium pieces on my local machine. Perhaps we should officially fork all of those under Sigil-Ebook as well just in case they ever get taken down for any reason. I will post the epubjsreader (toc_controller.js) reader.js patch to the repo if I can get it working at all.

06-08-2021, 02:05 PM	#44
KevinH Sigil Developer Posts: 7,655 Karma: 5433388 Join Date: Nov 2009 Device: many	Thanks for confirming the fix. I was able to simplify the bug fix patch by using an existing internal EPUBJS.core.resolveUrl(base, path) routine so I posted a v0.3.1 version. This new v0.3.1 version has changed nothing from a user functionality standpoint since the v0.3.0 you tested. So feel free to skip this update as the version you have now is just fine.

Advert

Advert