[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.

[thiago.eec]

Originally Posted by Kayadelenium

In a dark theme the same three families are used at dark lightness instead, and your theme's own text colour is left alone.

To be honest, I'd rather have the same colors in a dark theme. The new bacground colors are better than no color at all, but not as good as the original colors. As far as I know, the user does not choose the color for the plugin's foreground. It is automatic: black for light theme, white for dark theme. At least on Windows. So, setting the foreground as always black, keeps consistency, since the theme would not interfere with contrast.

Originally Posted by Kayadelenium

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.

The CVS exports only the selected line. Is this intentional? JSON exports the full report.

Originally Posted by Kayadelenium

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

The plugins works fine under Windows 11.

[Doitsu]

@Kayadelenium:

Thanks for implementing my suggestions. I have two more suggestions. Since the Calibre API allows to position the cursor by line and column, it'd be helpful, if you added a Column column.

I also think the CSV export option should export all messages by default.

I noticed that the CSV exporter doesn't quote messages that contain semicolons, which will split messages if the default LibreOffice Calc separator options are selected. For example:

epubveri outputs:

USAGE,content.opf,73,OPF-090: media-type 'application/vnd.ms-opentype' is a non-preferred (but valid) Core Media Type; 'font/otf' is preferred

instead of:

USAGE,content.opf,73,"OPF-090: media-type 'application/vnd.ms-opentype' is a non-preferred (but valid) Core Media Type; 'font/otf' is preferred"

The second version isn't strictly required but, IMHO, more "robust."

[Kayadelenium]

epubveri for calibre 0.4.0 — everything the two of you raised yesterday.

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

thiago.eec — the CSV exported only the selection because 0.3.0 asked the table whether anything happened to be selected instead of being told what was wanted. There are two entries now, Save all rows as CSV and, when there is a selection, Save selected rows as CSV; only the one that says selected means it.

On the dark theme: you were asking for a preference, and I had answered it with an argument, so it is a setting now rather than a decision of mine. Under Appearance there are two boxes, deliberately separate because they are two questions. The panel's background follows calibre's theme, or is always light, or always dark. Severity colours either follow that background — the pale set on a light one, the same three colours at dark lightness on a dark one — or stay the pale set in both, which is what your plugins and Sigil use, with the text forced dark so it stays readable. In a light panel the two choices look identical; the difference is what a dark panel does. Both default to what 0.3.0 shipped, so nothing moves for anyone who does not go looking. Thank you for the Windows 11 report as well.

Doitsu — all four:

Every CSV field is quoted now. You called it more robust and you are right for a reason worth stating: csv quotes for the comma by itself, and the case that needs this is the semicolon, because a spreadsheet whose list separator is one splits an unquoted message containing it down the middle.

There is a Col column, sorted as a number like Line. It was left out on purpose — the number is used rather than read, since a double-click already puts the cursor on that character — and the note recording that said the answer, if anyone asked, was that it is a small change and not a principle. You asked, with the right reason.

A clean book shows a message box and leaves the panel shut, as you suggested. A panel that was already open is still refilled, since the previous book's findings sitting under a clean verdict would be worse than either.

The status bar says what is happening: checking the book, looking for a newer epubveri, fetching one, how that turned out, and the verdict at the end.

One thing neither of you asked for, from testing: every export used to be offered as epubveri-results.csv, so a second one landed on the first. They now carry the book, what part of it, and how much — Devlet - Platon-epubveri-all-57.csv, or -selected-line-85.csv when a single row is exported, because a count of one names nothing.

macOS here, again. Windows and Linux reports welcome, particularly the message box and the two appearance settings.

[thiago.eec]

Originally Posted by Kayadelenium

thiago.eec — the CSV exported only the selection because 0.3.0 asked the table whether anything happened to be selected instead of being told what was wanted. There are two entries now, Save all rows as CSV and, when there is a selection, Save selected rows as CSV; only the one that says selected means it.

I tested here and it works on Windows.

Originally Posted by Kayadelenium

On the dark theme: you were asking for a preference, and I had answered it with an argument, so it is a setting now rather than a decision of mine.

I noticed a minor glitch: when you choose 'Always dark' or 'Always light' for the background, only the dock gets repainted, the tree widget remains the same color as in calibre theme.

Originally Posted by Kayadelenium

macOS here, again. Windows and Linux reports welcome, particularly the message box and the two appearance settings.

Everything fine on Windows, except for the light/dark glitch mentioned.

[Kayadelenium]

epubveri for calibre 0.4.1 — the background glitch thiago.eec found, and one it led to.

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

thiago.eec — thank you, that is a real one and the cause is worth stating, because it is why I could not see it. The panel told the tree what colour to be with a palette. A palette is a request that a platform style may decline for an item view, and Windows declines it: the theme engine paints item views itself. The dock is an ordinary widget, so it obeyed; the tree is the one item view in the panel, so it did not. On macOS both obey, under Fusion and under calibre's own style, which is why 0.4.0 shipped with this in it and why the tests did not catch it either — they checked the palette, and the palette was set correctly the whole time.

It is now said twice: the palette as before, plus a style sheet naming the same two colours, which Qt draws itself rather than handing to the platform theme. The severity colours and the selection highlight are unaffected by the second instruction — that part I could measure here.

So this one needs your eyes rather than mine. I cannot reproduce the fault on this machine, which means I cannot confirm the fix on it either; it is reasoned from where the two platforms differ. If Always dark now paints the whole panel on Windows, that closes it.

A second one, which nobody reported and which I found while looking into the first: choosing Always dark and then going back to Follow calibre did not undo anything. The panel stayed dark until calibre was restarted, and the severity colours stayed dark with it, since they are chosen by reading the panel's own background back. One panel is built per editor session and reused, so declining to paint a background was not the same as taking one off. Both directions work now.

[Doitsu]

Could you also add sorting by clicking the column headings, toggling ascending/descending on each click?

[Kayadelenium]

epubveri for calibre 0.4.2 — done.

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

Doitsu — clicking a column heading sorts, and each further click toggles ascending and descending. It works under all three Sort settings now; under Document order the headings did nothing at all, which is presumably where you met it. The panel still opens in the book's own order under that setting, and no sort arrow appears until you click, since until then nothing is sorted.

Nothing else changed.