[Editor Plugin] epubveri

[Doitsu]

Originally Posted by Kayadelenium

epubveri for calibre 0.1.0, and this is the "I will try to look at it tomorrow" from the Sigil thread.

https://github.com/veripublica/epubv...calibre-v0.1.0

I have one minor nitpick. I'd recommend that you display the validation messages in a dockwidget like Calibre's check book tool.

[JSWolf]

I think that's more then minor.

[Kayadelenium]

epubveri for calibre 0.2.0 — the dock, and it came out of this thread.

https://github.com/veripublica/epubv...calibre-v0.2.0

Doitsu, JSWolf — you were both right, and JSWolf was right that it was more than a nitpick. The dialog had the correct behaviour and the wrong shape: it was already non-modal, because activating a row has to move the editor behind it, but docking, tabbing behind another panel and a position that is still there next week are things a panel gets for free and a floating window never does.

Drag it where you want it, tab it behind Check Book, or close it. calibre remembers where you put it — and that part is worth one sentence, because it is the whole reason the dock is built where it is. It is created from create_action, which Main runs before create_docks and well before it defers restore_state, so the dock exists by the time restoreState runs and calibre restores its area, size and visibility itself. Nothing of ours is stored anywhere. Build it later, on the first validation instead, and it would go back to the default corner every session.

It stays hidden until you run a validation, the way Live CSS does, and validating again refills the one panel rather than opening a second.

To be clear about what it is not: this is not calibre's own Check Book panel. That one stays closed to plugins — run_checks calls calibre's checkers directly and takes no plugin — so a dock of our own is as close as a plugin can get.

It also has an icon now, which it should have had from the start; the toolbar button and the menu entry were text and nothing else. It is the same mark as the Sigil plugin's, and both are generated from one description of the drawing so the two cannot quietly drift apart.

Two smaller ones. The summary line names the plugin's own version beside epubveri's, which Doitsu asked for in the Sigil thread — most of what has gone wrong in these plugins so far was the plugin rather than the validator, so it was the more useful of the two numbers to have been missing. And the archive is now epubveri_calibre_v0.2.0.zip, after PeterT pointed out that both plugins were shipping a file called epubveri_vX.Y.Z.zip and a download said nothing about which editor it was for.

What is not verified. All of the above was installed from this archive and run in Edit Book on a real book, on macOS. Nothing here has been on Windows or Linux. If you have either and five minutes, that is the gap — and the dock is the part most likely to behave differently.

[PeterT]

Install and launch on chromebook using linux install of calibre results inb

calibre, version 9.14.0
ERROR: epubveri: epubveri could not be downloaded. The first run needs an internet connection; after that the plugin works offline. ([Errno 17] File exists: '/home/peterjt/.config/calibre/plugins/epubveri')

FALSE ALARM

Removing the existing plugins/epubveri directory from the save configuration (created by the doitsu's version) seems to have resolved the issue.

[thiago.eec]

Originally Posted by Kayadelenium

epubveri for calibre 0.2.0
It stays hidden until you run a validation, the way Live CSS does, and validating again refills the one panel rather than opening a second.

Hi, @Kayadelenium.

Nice work on the epubveri validator. It is so much faster than EPUBCheck.

Now, about the plugin. Everything working fine on Windows 11 here. I do have some thoughts to share, if I may:

1) I don't know if that's just me, but I really miss the line colors as in @Doitsu's version. It is really easier to differentiate the message's severity.

2) I think the columns should be sortable too. The first column maybe should be named 'Severity' or something like that. It would be great to sort by it.

3) About the preferences: it would be easier to have access to them in the Editor itself, rather then going through calibre preferences. I know most people will settle for default, or change once and be done with it, but it adds discoverability.

4) The last thing is about the Dock widget. When using EPUBCheck or ACE, the dock is not opened when the Editor starts (even if left there when closing). I know calibre's Check Book does that, but I think it clutters the GUI, since a validator is not really a tool for editing the book, but something you run at the end of the work.

Thanks for the plugin and for epubveri.

[Doitsu]

Originally Posted by thiago.eec

1) I don't know if that's just me, but I really miss the line colors as in @Doitsu's version. It is really easier to differentiate the message's severity.

I also think that colors would help. Sigil uses the following color scheme.

SEVERITY_BRUSHES = {
    'fatal': QBrush(QColor(255, 230, 230)),
    'error': QBrush(QColor(255, 230, 230)),
    'warning': QBrush(QColor(255, 255, 230)),
    'info': QBrush(QColor(224, 255, 255)),
    'usage': QBrush(QColor(224, 255, 255)),
}

Originally Posted by thiago.eec

3) About the preferences: it would be easier to have access to them in the Editor itself, rather then going through calibre preferences. I know most people will settle for default, or change once and be done with it, but it adds discoverability.

I also think that this would be a good idea. (Calibre allows you to add a drop-down preferences menu to the Edit Book toolbar icon.)

Originally Posted by thiago.eec

4) The last thing is about the Dock widget. When using EPUBCheck or ACE, the dock is not opened when the Editor starts (even if left there when closing). I know calibre's Check Book does that, but I think it clutters the GUI, since a validator is not really a tool for editing the book, but something you run at the end of the work.

I think that this is a good idea. Also, if no problems were found, simply display a message box instead of an empty widget.

Other suggestions:

• Allow users to select rows via CTRL+click/SHIFT+click and CTRL+A. CTRL+C should copy the rows as tab-delimited text to the clipboard.
• Add an export button that allows users to export all messages as a JSON file or a tab-delimited CSV file.
• Display a status bar message whenever epubveri is checking the book, checking for updates or downloading them, letting the user know whether updates were found.

[Kayadelenium]

epubveri for calibre 0.3.0 — everything asked for in this thread yesterday, plus two things that turned out to be my fault.

https://github.com/veripublica/epubv...calibre-v0.3.0

thiago.eec's four (post 19) and Doitsu's additions (post 20):

Severity colours are back, and the light set is Doitsu's to the byte — the same pale red, yellow and cyan, so the two plugins look alike rather than nearly alike. In a dark theme the same three families are used at dark lightness instead, and your theme's own text colour is left alone.

Columns sort. The first one is called Severity now, and it sorts by rank rather than alphabetically, so a fatal is never below an error. Line sorts as a number, so line 9 comes before line 10. Each severity group still reads top to bottom in book order. The panel opens severest first; Preferences has a box to change that to least-severe-first or to the order the findings occur in the book, and a header click beats it for the session.

The settings are in the editor now. The toolbar button still validates when you click it; its arrow opens Validate now, Show the results panel, and the settings. The results panel's right-click menu has them too. Changing anything re-lists the run you already have instead of asking you to validate again.

The dock no longer comes back on screen at startup. It remembers where you put it and not whether it was open.

Rows select with Ctrl+click and Shift+click, Ctrl+C copies them as tab-delimited text, and the right-click menu exports: CSV of the table as you are looking at it, or epubveri's whole JSON report, filtered by nothing — that second one is the file to attach if something looks wrong.

PeterT's install error was not a false alarm (post 18). Doitsu's plugin keeps its copy of the binary in a file called plugins/epubveri, and that is exactly the name this plugin wanted for a folder — on Linux and macOS, not Windows. Each was in the other's way: his file stopped our folder being created, and our folder would have stopped his plugin executing its binary. Ours has moved to plugins/epubveri-data, a folder left by 0.2.0 is moved there on first use, and a file at the old name is his and is never touched. Anyone coming from his plugin on Linux or macOS would have hit this.

And we were breaking his plugin in his own settings file. calibre keys preferences by plugin name and both plugins are called epubveri, so the two share one plugins/epubveri.json. Nine keys of ten are distinct; last_update_check is not. His is time.time(); ours was an ISO string, which made his update check raise TypeError for anyone who ran ours and then his. It now writes the number he expects and reads both. Sorry, Doitsu — and it could only ever have shown up on your side.

Tested on macOS only, again. Windows and Linux reports welcome, especially the dock and the two export dialogs.