epubcheck plugin for Sigil

[Doitsu]

Originally Posted by Cyberseeker

Can the validation results be saved, or sent to a printer?

Unfortunately, you can't print the contents of the Validation Results window. You might want to use pagina EPUB-Checker instead, which allows you to save the epubcheck log.
BTW, if you click an error message in the Validation Results window, Sigil will move the cursor to the line that epubcheck has reported.

[KevinH]

With changes it should be possible for Sigil validation plugin types to build and generate a log if this is an important feature. Although line and error info without viewing the file itself simultaneously is harder to use in my opinion.

[Doitsu]

Originally Posted by KevinH

With changes it should be possible for Sigil validation plugin types to build and generate a log if this is an important feature.

Thanks for your kind offer, but, IMHO, it'd better if you used your limited time to make Sigil even more epub3-compliant. For example, there's still a minor problem with the epub3 cover metadata context menu item that I reported some time ago.
(I could easily add clipboard support for Windows machines via tkinter.)

@Cyberseeker: It'd be relatively easy to automatically have the plugin copy the original epubcheck report to the system clipboard.
I could also have it write it to the Desktop. However, I'd be an optional feature, which would need to be enabled via the plugin preference file.
Let me know which one you'd prefer and I'll add it in future version.

[Cyberseeker]

Originally Posted by Doitsu

@Cyberseeker: It'd be relatively easy to automatically have the plugin copy the original epubcheck report to the system clipboard.
I could also have it write it to the Desktop. However, I'd be an optional feature, which would need to be enabled via the plugin preference file.
Let me know which one you'd prefer and I'll add it in future version.

Clipboard would be fine, and I would drop it into 'Word' and have a look at it on paper. As it is now, is fine for anyone familiar with html, but a lot of authors would need to go through it with a ballpoint pen, or take it to a friend and say, "whats this mean?"

Speaking of epubcheck report "questions", I have a few. Would you prefer that I opened a separate thread, or should I ask them here?

[JSWolf]

Originally Posted by Cyberseeker

Speaking of epubcheck report "questions", I have a few. Would you prefer that I opened a separate thread, or should I ask them here?

They would be best in the ePub forum.

[KevinH]

I will have to dig back through my pm from you. I did not think it was an actual bug that needed fixing but I am willing to take another look at it.

Kevin

Originally Posted by Doitsu

Thanks for your kind offer, but, IMHO, it'd better if you used your limited time to make Sigil even more epub3-compliant. For example, there's still a minor problem with the epub3 cover metadata context menu item that I reported some time ago.
(I could easily add clipboard support for Windows machines via tkinter.)

@Cyberseeker: It'd be relatively easy to automatically have the plugin copy the original epubcheck report to the system clipboard.
I could also have it write it to the Desktop. However, I'd be an optional feature, which would need to be enabled via the plugin preference file.
Let me know which one you'd prefer and I'll add it in future version.

[BetterRed]

Originally Posted by Doitsu

@Cyberseeker: It'd be relatively easy to automatically have the plugin copy the original epubcheck report to the system clipboard.

If it's 'automatic' it will overwrite what's currently in the clipboard, which could irritate users.

When task switching... between editing a document in Sigil, a text chat session, and watching a video... I often copy a fragment from the document (transcript of the video) into the clipboard in readiness for my next chat message.

Perhaps the Validation Results window could permit use of Ctrl/A, Ctrl/C. Or put a Copy to clipboard button in the Window Title bar (Qt permitting of course). Or at least put an option in preferences to NOT autocopy validation results.

FWIW - I've sometimes wished for a way to copy what the Language Tool PI puts in the Validation Window.

BR

[Doitsu]

Originally Posted by BetterRed

If it's 'automatic' it will overwrite what's currently in the clipboard, which could irritate users.

That was my thought too. That's why I'd make it an opt-in feature via the EpubCheck.json plugin preference file.
BTW, you can already copy and paste a single message from the Validation Results windows using CTRL+C/V.

Originally Posted by BetterRed

FWIW - I've sometimes wished for a way to copy what the Language Tool PI puts in the Validation Window.

That plugin could also easily be modified to save the log file to the desktop, if enough users are interested in it.

[BetterRed]

Originally Posted by Doitsu

That was my thought too. That's why I'd make it an opt-in feature via the EpubCheck.json plugin preference file.

I read it as, if one did not opt-in for Save to Desktop, then it the errors would autocopy to clipboard

Originally Posted by Doitsu

BTW, you can already copy and paste a single message from the Validation Results windows using CTRL+C/V.

You can do a Ctrl+A and highlight the entire list, but a Ctrl+C will only grab the last line. If CtrL+C could grab the entire selection we'd have a universal solution for the Validation Window.

BR

[Doitsu]

I attached a new version with clipboard support to the first post.

To enable this feature:

1. Presss WIN+R.
2. Copy and paste %LOCALAPPDATA%\sigil-ebook\sigil\plugins_prefs\EpubCheck and hit Return. (If you have a macOS or Linux machine, you'll need to select Edit > Preferences > Open Preferences Location.)
3. Open EpubCheck.json with a text editor and change the following line
   from:
   

     "clipboard_copy": false,

   to:
   

     "clipboard_copy": true,

4. Save EpubCheck.json.

Note that this feature might not work with some macOS and Linux versions.

[llis]

Just an FYI for ppl trying to get this running on a Mac (maybe elsewhere): I got a Java error message telling me I needed to install a JDK to run commandline. A quick google took me to the link. I installed the latest and the plugin works swimmingly! Thanks!

[Leonatus]

The report of the plugin shows the message as can be seen on the screenshot. I'd like to know
1. what is wrong there, and
2. Can I change the content without interferring to the TOC, and ending up in a mess?

I have another request that is more a Regex problem:
In another book, the plugin shows problems that all concern the content of span-tags. They are, as far as I can see, the only spans in the whole book, but they are all defective. I would like to remove them all, including their content, but the content differs from case to case. Such as:
<span>some text</span>, and <span>some different text</span>. Which suitable regex could I use?
Any help much appreciated!

[Doitsu]

Originally Posted by Leonatus

The report of the plugin shows the message as can be seen on the screenshot.

This message is usually being displayed if NCX ids don't start with a letter.

For example:

<navPoint id="7a10b9f2" playOrder="1">

If that's the case with your book, simply search in toc.ncx for:

<navPoint id="

and replace it with:

<navPoint id="ID

Originally Posted by Leonatus

In another book, the plugin shows problems that all concern the content of span-tags. [...] I would like to remove them all, including their content, but the content differs from case to case.

I'm not very good at regular expressions, but the following expression should remove all span tags:

<span[^>]*>.*?</span>

[Leonatus]

Thank you, Doitsu! The Regex helped, whereas, at opening the book once more and running epubcheck, the navpoint id issue didn't appear any more. Indeed, the tags began with letters, anyhow.
I will backup your hints, nevertheless. Thanks once more!

[Maui]

Hi,

in the past i was able to solve any problems without posting any questions in the forum but to now i'm struggling a little bit.

I just bought a new mac book and was able to install sigil without any problems. i copied the sigil.ini, sigil clips und saver searches succesfully to the mac.

Right now i'm trying to get epubcheck running, so i installed the jre-8u151-macosx-x64.dmg. The installation went through without any error (succes message after installation), but the plugin is failing. The reason is clear: in the terminal a java -version command said no java installed and a popup is asking if i want to install java. Reinstalling does not change anything.

I know this is not really related to a sigil problem but currently io'm a little bit lost to find out where the problem is. Any help is appreciated.

Maui