epubcheck plugin for Sigil

[Doitsu]

Originally Posted by philja

From which you will note that it completed successfully with no 'usages' noted, although usage is set to true.

Of course, if you run epubcheck in a terminal, it'll ignore the .json file that the plugin reads.
If you want epubcheck.jar to display usage information, you'll have to add the --usage parameter.

Originally Posted by philja

Curiously, the plugin run seems to be listed twice each time finding 62 usages (inline style declarations, an unused CSS decaration, missing lang attributes). At line 68, it announces EPUBcheck completed and then at line 69, EPUBCheck v4.2.4 -- and off we go again.

This sounds familiar. IIRC, there was a bug in an older Sigil version that caused it to run plugin code twice. What's your Sigil version?

[philja]

Originally Posted by KevinH

Maybe a platform specific python or java issue?

Actually from eyeballing the comments in plugin.py, Usage errors do not set a filename (sometimes?) and if they happen first (before any other error in that file) then offlst will not get initialized resulting in the error message you got (a guess on my part).

Simply setting offlst to [0] right where lastfilename is first set to None might help but I have no computer to test that with.

I went back to Kevin's post and thought I'd give it a try- I went into plugin.py and added offlst = [0] at line 541 -

# used for coffset calculation
lastfilename = None
offlst = [0]

I didn't touch anything else in the file.

Since then, I have had six successful runs on six different epub files and all with usage set to true and clipboard_copy set to true. Each time, the epubcheck plugin run in Sigil completed ok with all the usages listed in the validation results in a nice duck egg blue.

Only one of these gave a clipboard record, the last one.

On the last one of these, I followed up with a command line run and the validation completed ok with no errors or warnings detected.

So there appears to be something in Kevin's suggestion. Hope this helps, Doitsu.

[philja]

This sounds familiar. IIRC, there was a bug in an older Sigil version that caused it to run plugin code twice. What's your Sigil version?

Sigil 0.9.9

[David Kudler]

I get a "Plugin not a valid Sigil plugin" when I tried to update this for Sigil 1.3 for Mac. Any idea why?

[DiapDealer]

Because you (or a download helper) renamed the zipfile maybe? Or automatically/mistakenly unzipped the plugin archive?

Sigil plugins must be zip archives, and must be named in a specific way.

[David Kudler]

Nope. Untouched, unopened, unrenamed. I'll try redownloading.

ETA: Didn't work. Tried downloading it in Safari, Chrome, and Firefox.

Same thing seems to be happening with other plugins as well. Not sure if it's a problem with Sigil or my installation.

[KevinH]

On macOS in System Preferences please remember to uncheck the box that says to run "safe" downloads as this is actually very "unsafe".

Make sure you do NOT try to install the plugin from your Downloads folder. Newer versions of macOS prevent this from working on purpose. Always use Finder to manually drag plugin zip archive to your Desktop before trying to use Sigil to install it. These are needed because of macOS gatekeeper changes.

[David Kudler]

Wow. KevinH — thank you so much. I wouldn't have figured that one out on my own. (I'd already tried moving the ~/Application Support/sigil-ebook/sigil/ folder to try to reinitialize the app.) I should have figured out that something was weird — I couldn't see any files in the Download folder without typing in their filename. But that worked! Did I miss a notice somewhere?

[KevinH]

That change in macOS gatekeeper is not well documented for some reason. It occurred in 10.12 or thereabouts I think. Apple decided that nothing should use DownLoads to load and run anything and if you try it reloads it into tmp someplace to help prevent download based attacks, ransomware, etc.

Manually moving it outside your Downloads folder using the Finder changes some of the extended quarantine flags to allow it to be loaded. Any automated or terminal based movement out of Downloads will not change quarantine flags, preventing it from being run. All of this makes sense, but they have not made it very clear to users.

So nowadays I never try to load or run anything in Downloads anymore. I manually move it to my Desktop first. That does the trick.

[David Kudler]

Makes perfect sense. I knew that Apple has been doing its best to sandbox downloads (especially executables) in general —*but hadn't realized that that folder in particular was being isolated. Again, thanks.

[philja]

The new distro LTS release 20.04.1 just came out so I made a clean install and was happy to find that it came with Sigil 1.1.0.

The initial pleasure was muted when I saw it with default gaudy icons occupying 3 rows and about 12% of the vertical screen. Once reduced to minimum size and redocked on a single row, it was ok except that I was then reminded why I left Calibre's editor for Sigil way back in 2015. Sigil's F2 toggle from coding to preview suited me very well, F2 coming easily to the left hand.

There was an initial scare when the EpubCheck plugin wouldn't work but that was down to the new distro not having Java or a JRE and was soon remedied.

All good now.

[KevinH]

Wow, Sigil 1.1 is quite old now. Why not at least Sigil 1.2.1?

You do know, there are Sigil preferences to control all icon sizes, and a View Toolbar menu that lets you determine which icons/toolbars to show or hide. And of course, you can use drag and drop to arrange the toolbar icons on the lines and order you want.

All of this is saved in Settings so you can set it once and forget it.

And "gaudy" is your personal opinion, not mine, as was discussed earlier.

The real question is why this was posted in this plugin forum at all?

[David Kudler]

I'm getting the following error message whenever I try to check a book with custom fonts embedded:

Status: failed

Running EPUBCheck v4.2.4... please wait.

*** Invalid macOS file path returned! ***


*** Book path not resolved! ***

I'm running ePubCheck 4.2.4 (as noted above) in Sigil 1.3.0 on a MacBook running macOS 10.15.6, fwiw.

I see (scanning through this thread) that this has been a problem with Sigil shifting the com.apple.ibooks.display-options.xml file into the Misc folder. I just wanted to let someone know that this is still a problem.

When I delete the file (which clearly shows its location as META-INF/com.apple.ibooks.display-options.xml in the delete dialog), it still fails. :-(

[Doitsu]

Originally Posted by David Kudler

I'm getting the following error message whenever I try to check a book with custom fonts embedded:

Unfortunately, this a rare plugin bug. I.e., it's my fault.

Please enable to the following option in EpubCheck.json.

{
  "locale": "fr", 
  "github": true, 
  "clipboard_copy": true, 
  "update_check": true,
  "check_interval": 7,   
  "usage": false,
  "is32bit": false
}

This should copy the raw EpubCheck output to the system clipboard. Please save the output to a file and attach it to a post.

[David Kudler]

Originally Posted by Doitsu

Unfortunately, this a rare plugin bug. I.e., it's my fault.

Please enable to the following option in EpubCheck.json.

{
  "locale": "fr", 
  "github": true, 
  "clipboard_copy": true, 
  "update_check": true,
  "check_interval": 7,   
  "usage": false,
  "is32bit": false
}

This should copy the raw EpubCheck output to the system clipboard. Please save the output to a file and attach it to a post.

Took me a while to find the epubcheck.json file, sorry! (For macOS folks, it's in ~/Library/Application Support/sigil-ebook/plugin_prefs/EpubCheck/ —*I kept looking inside the .jar file. )

I've attached the file — which, nicely, gave me the errors that epubcheck found, so yay for that too.

ETA: Oh —*and I did in fact get rid of the custom fonts, just to see if that helped; it didn't. I'm still getting *** Book path not resolved! ***, but now I'm also getting a whole string of *** Invalid macOS file path returned! *** errors.

The plugin is working fine with most of my other books; not sure what it is about this one that's creating problems.