[GUI Plugin] epubveri library

[JSWolf]

Originally Posted by maddz

Yeah, I found it! Over 1100...

You have to turn off bookmarks for the calibre viewer.

[maddz]

Originally Posted by JSWolf

You have to turn off bookmarks for the calibre viewer.

Already done, I have to clean up the ones that were added when I was checking ISBNs.

By the way, are all the 'adobe-xxx' properties in stylesheets safe to delete? We've discussed the hyphenate ones, but I'm also seeing adobe-text-layout among others.

[JSWolf]

Originally Posted by maddz

Already done, I have to clean up the ones that were added when I was checking ISBNs.

By the way, are all the 'adobe-xxx' properties in stylesheets safe to delete? We've discussed the hyphenate ones, but I'm also seeing adobe-text-layout among others.

Yes, very safe to remove. I do it when they are in the CSS.

[DNSB]

I would suggest any further discussions about editing ePubs be moved to the ePub forum where they belong.

[Kayadelenium]

Heads-up: your next scan will look different, and the plugin has not changed

epubveri 0.15.0 is out, and the plugin fetches the validator itself, so your next scan picks it up without a plugin update. This release catches up with EPUBCheck 5.4.0: some errors stop firing — obsolete but conforming HTML such as the name attribute on a is a usage note now rather than an error — and a new family of usage notes appears on books that are perfectly fine, mostly for an NCX or an OPF 2 guide. On a whole library that is a lot of new rows.

One thing worth knowing before you use it: Compare with the previous scan will show a large difference on the first scan after this, and it is the validator that changed rather than your books. The comparison is honest again from the scan after that.

maddz, your request in post 23 — a way to see the books that came back with nothing — is a good fit and it is going in. The menu already has "Show books with no EPUB", so this becomes its sibling: the books that were checked and had no findings at all. It will ship with the two entries I promised in post 21, "Stop the running check" and Settings.

Nothing to install for the validator update. The full list of what changed in it is in the epubveri thread: https://www.mobileread.com/forums/sh...d.php?t=374286

[Kayadelenium]

epubveri library 0.5.0 — the three things asked for in this thread

All three come from posts above, and none of them was reachable before.

Stop the running check. JSWolf, post 18. Cancelling has worked since the scan became a calibre job, but it lived in the Jobs panel and the plugin only mentioned it for runs over 500 books — so someone checking three hundred saw nothing at all. It is in the plugin's own menu now, greyed out while nothing is running. One thing to expect: a scan checks several books at once, so stopping waits for the ones already in flight rather than cutting off mid-book.

Settings. JSWolf, posts 16 and 18. Same page as Preferences / Plugins / Customize, now also one click from the toolbar arrow, which is where the editor plugin keeps its own.

Show the books with no errors. maddz, post 23. After a scan it marks the books that came back clean and filters the library to them, the same way the report's rows do for the books they name.

One decision inside that last one is worth stating, because it decides what you see. It is "no errors" rather than "no findings": epubveri 0.15.0 reports the features EPUB 3.4 marks as outdated, so most perfectly valid books now carry a usage note for an NCX or an OPF 2 guide. Defined as "nothing was reported at all" the list would come back nearly empty and look broken. A book with a warning is in the list, and its warning is still in the report. Books with no EPUB, and books that could not be read, are not in it — they were never checked, so "no errors" would be a claim nobody made. There is a separate entry for the first group.

Download: https://github.com/veripublica/epubv...library-v0.5.0
Install with Preferences / Plugins / Load plugin from file, then restart calibre.

[JSWolf]

Originally Posted by Kayadelenium

epubveri library 0.5.0 — the three things asked for in this thread

All three come from posts above, and none of them was reachable before.

Stop the running check. JSWolf, post 18. Cancelling has worked since the scan became a calibre job, but it lived in the Jobs panel and the plugin only mentioned it for runs over 500 books — so someone checking three hundred saw nothing at all. It is in the plugin's own menu now, greyed out while nothing is running. One thing to expect: a scan checks several books at once, so stopping waits for the ones already in flight rather than cutting off mid-book.

Settings. JSWolf, posts 16 and 18. Same page as Preferences / Plugins / Customize, now also one click from the toolbar arrow, which is where the editor plugin keeps its own.

Show the books with no errors. maddz, post 23. After a scan it marks the books that came back clean and filters the library to them, the same way the report's rows do for the books they name.

One decision inside that last one is worth stating, because it decides what you see. It is "no errors" rather than "no findings": epubveri 0.15.0 reports the features EPUB 3.4 marks as outdated, so most perfectly valid books now carry a usage note for an NCX or an OPF 2 guide. Defined as "nothing was reported at all" the list would come back nearly empty and look broken. A book with a warning is in the list, and its warning is still in the report. Books with no EPUB, and books that could not be read, are not in it — they were never checked, so "no errors" would be a claim nobody made. There is a separate entry for the first group.

Download: https://github.com/veripublica/epubv...library-v0.5.0
Install with Preferences / Plugins / Load plugin from file, then restart calibre.

There is another set of changes that I think need to be made. In the settings, let us choose if we want the entire library or selected eBooks to validate. Then we can just click the button and it validates. I don't like the option windows that comes up. That's an extra step that's annoying.

[JSWolf]

Another set of issues.

OBS-001,opf.guide.outdated,,,usage,1,1,"usage of the OPF 2 ""guide"" element is outdated"
OBS-001,ncx.outdated_navigation,,,usage,1,1,usage of OPF 2 NCX navigation is outdated

I don't want to know that an ePub3 has these elements. They are there for backwards comparability. I only want to know if my ePub3 doesn't have what's needed to me the ePub3 backward compatible with ePub2. I want backwards comparability as much as possible. But if I forget something important, then let me know.

There are a lot of people who use an older version of RMSDK on Kobo, Sony, and other Readers and they need the NCX. The Guide, not so much.

As it is, these types of messages are rather annoying. So please remove the outdated messages.

[Kayadelenium]

Those two messages are epubcheck's, not ours. EPUBCheck 5.4.0 added OBS-001 for the features EPUB 3.4 marks as outdated, and an NCX and an OPF 2 guide are on that list; 0.15.0 reports it where 5.4.0 reports it, at the same severity. Dropping it would mean going quiet where the tool everyone gates on speaks, which is the one kind of difference I will not introduce on purpose — a missing message is the hardest sort to discover.

What I can say about weight: OBS-001 is a usage note. It never touches the verdict or the exit code, and in this plugin usage notes are off by default — the report ranks defects, and a feature your book deliberately uses is not one. They are in your CSV because the switch is on, and turning it back off in Settings removes them without removing anything else you rely on.

Your second point is the more interesting one, and it is not the same request. You do not want to be told an EPUB 3 has an NCX; you want to be told when one does not, because a reader on an older RMSDK build needs it. That is a check epubcheck does not have and could not have — it says nothing about what a device published in 2014 can open. It is the shape epubveri's own ADV-* family is for.

I have not written it and I am not promising it. Before anything gets written I want to know how many EPUB 3 books in the wild ship without an NCX at all, and what actually breaks where — a claim about RMSDK deserves better evidence than my guess. It is filed as https://github.com/veripublica/epubveri/issues/136 with the measurements it would have to pass first, and if they do not come out, the issue closes saying so.

If you have books that failed on such a device, or know which RMSDK versions are the line, that is exactly what would move it.

[igorius]

There is a problem on Macos X Sequoia: I cannot see the plugin as button and adding i dont find it. Plugin lists as installed and i can edit the settings, but cannot add it as button or menu-entry. What do i miss?

[JSWolf]

With ADE/RMSDK, If you remove the NCX, when you try to go to the ToC, you have nothing as there is no longer a ToC.

The ToC buttons do not work.

[DNSB]

Originally Posted by JSWolf

With ADE/RMSDK, If you remove the NCX, when you try to go to the ToC, you have nothing as there is no longer a ToC.

The ToC buttons do not work.

Perhaps that is why both epubcheck and epubveri with usage enabled report it as a usage issue and not an error?

OEBPS/content.opf	12	924	USAGE OBS-001: usage of the OPF 2 "meta" element is outdated
OEBPS/toc.ncx	N/A	N/A	USAGE OBS-001: usage of OPF 2 NCX navigation is outdated
 	N/A	N/A	epubveri 0.15.1 (plugin 0.3.3) — VALID (0 error(s), 0 warning(s)); also listed: 2 usage note(s) — neither affects the verdict [updated epubveri 0.15.0 to 0.15.1]

OEBPS/toc.ncx	N/A	N/A	Col: -1: USAGE(OBS-001): Usage of OPF 2 NCX navigation is outdated.
OEBPS/content.opf	12	968	Col: 49: USAGE(OBS-001): Usage of the OPF 2 "meta" element is outdated.

For myself, I worry about Fatal Error, Error & Warning error messages, Info & Usage are not something that I worry about correcting. In this case both epubcheck and epubveri are saying that you are have an usage issue with an obsolete item (in the case of toc.ncx, for backwards compatibility) and it is nothing to worry about.

If seeing them is such an issue, just turn off Usage message for both.

[Kayadelenium]

Originally Posted by DNSB

Perhaps that is why both epubcheck and epubveri with usage enabled report it as a usage issue and not an error?

That is exactly why, and it is worth showing that the severity was chosen rather than defaulted into. I asked the epubcheck maintainer a related question last week — on what basis a checker applies a rule EPUB 3.4 introduced to content written for 3.3 — and his answer covers this one too (w3c/epubcheck#1652):

EPUB in general tries its best to be backwards compatible, but the devil is in the details and sometimes for very specific constructs it is not.

Since EPUBCheck is supposed to be a pure conformance checker, we try to not deviate from the specification. In some cases however, some backward-incompatible change might be reported with a lower severity in EPUBCheck to not "break" existing content, but it would be very rare and backed by usage data. Usually that would mean the specification is too strong and would be changed.

In the same answer he gives the rule for where a message lands on the scale: where the specification sentence carries no MUST or SHOULD, it is reported as USAGE.

So the NCX line is the mechanism working, not misfiring. OBS-001 is one family and all of it sits at USAGE — the NCX, the OPF 2 guide, an OPF 2 meta, collection, font obfuscation, prefixed CSS properties — the bottom of the scale, and it never moves the verdict or the exit code. DNSB's advice is the right one for anyone who does not want to see it: in this plugin usage notes are off by default, and yours are in the CSV because the switch is on.

There is a lever for the rest of it, and it is not in either tool: if 3.4's outdated list is too strong for the installed base, the place that can act is the specification and the checker, and what moves them is usage data rather than preference — his words, and my experience of that tracker as well.

Which brings it back to the check you actually want, and it runs on the same fuel. "Tell me when an EPUB 3 ships without an NCX" is epubveri#136. Which RMSDK versions are the line, and a book that failed on one of them, is what would move it from filed to written.

[Kayadelenium]

Originally Posted by igorius

There is a problem on Macos X Sequoia: I cannot see the plugin as button and adding i dont find it. Plugin lists as installed and i can edit the settings, but cannot add it as button or menu-entry. What do i miss?

Nothing — it was almost certainly there and wearing the wrong name, which is ours to fix and is fixed. Up to 0.5.0 the entry in Preferences / Toolbars & menus was labelled Validate library, not epubveri library. calibre lists an action by that label, so anyone scrolling for the name they installed goes straight past it. A moderator of this forum hit the same thing, which is what prompted 0.5.1 last night: the button and the list entry now carry the plugin's own name.

So: install 0.5.1, restart calibre, then Preferences / Toolbars & menus, pick The main toolbar from the drop-down at the top, find epubveri library in the left-hand list, move it across, Apply. The same page puts it in the menu bar or the book-list context menu instead, if you prefer either. (On 0.5.0 the same steps work — you just have to look for Validate library.)

calibre offers that placement once, in a dialog right after the plugin is installed, so if that dialog was dismissed the placement has to be made by hand. And it is deliberately not offered for the device toolbars or the search bar: the action reads the library's selection, so on a connected device it would check books you cannot see.

If epubveri library is still not in that left-hand list after a restart on 0.5.1, then it is something else and I would like the details: your calibre version, and what Preferences / Plugins shows for it. Running calibre from a terminal as

/Applications/calibre.app/Contents/MacOS/calibre-debug -g

prints anything the plugin failed at, and that line would settle it.

One more thing, since it is the reason a few people have had to hunt for this at all: the plugin is not in calibre's own Get new plugins list yet. I have asked a forum administrator to have it indexed and I am waiting to hear back. Until then it is the zip from GitHub, installed with Preferences / Plugins / Load plugin from file. I will post here when it turns up in the index so nobody has to keep checking.

Download: https://github.com/veripublica/epubv...library-v0.5.1