What does 'Well-Formed Check EPUB' actually check?

bookman156 · 03-19-2016, 11:21 PM

I'm assuming that it runs the EpubCheck:

https://github.com/idpf/epubcheck

Is that right?

Does that also validate each XHTML file or will I need to unzip the EPUB and submit each XHTML page to W3C for validation also?

Toxaris · 03-20-2016, 03:04 AM

No, that is not right. It does not run ePUBCheck. It checks if all the files are well-formed, it does not do any content checking.

Doitsu · 03-20-2016, 03:36 AM

Quote:

Originally Posted by bookman156

I'm assuming that it runs the EpubCheck

If you want to check your books with ePubCheck, you'll need install my simple ePubCheck wrapper plugin.
(You can also download the standalone pagina version, which uses the same ePubCheck version.)

You also might want to install the FlightCrew plugin, if you haven't already done so, because it'll catch some issues that ePubCheck ignores.

Notjohn · 03-20-2016, 07:06 AM

Quote:

Originally Posted by Doitsu

You also might want to install the FlightCrew plugin, if you haven't already done so, because it'll catch some issues that ePubCheck ignores.

I've seen the opposite behavior (Flight Crew ignores empty hyperlinks, which are flagged by Epubcheck) but never noticed this. What sort of things does Flight Crew catch that Epubcheck does not?

Doitsu · 03-20-2016, 08:21 AM

Quote:

Originally Posted by Notjohn

What sort of things does Flight Crew catch that Epubcheck does not?

Among other things it'll report unused image files etc.

bookman156 · 03-20-2016, 02:42 PM

Quote:

Originally Posted by Toxaris

No, that is not right. It does not run ePUBCheck. It checks if all the files are well-formed, it does not do any content checking.

But what does it mean that the files are 'well-formed'?

I know exactly what the W3C XHTML and CSS validators are checking, but I am less certain what Sigil and EpubCheck are checking.

I'll look into those plugins mentioned.

Doitsu · 03-20-2016, 02:45 PM

Quote:

Originally Posted by bookman156

But what does it mean that the files are 'well-formed'?

It's a technical term. It basically means that each tag must have an ending tag and all tags must be properly nested.

bookman156 · 03-20-2016, 02:50 PM

Quote:

Originally Posted by Doitsu

It's a technical term. It basically means that each tag must have an ending tag and all tags must be properly nested.

Ah, okay. Got it.

bookman156 · 03-20-2016, 03:23 PM

So an XHTML document that is not 'well-formed' can still validate?

For instance, in my original EPUB which I received from the publisher there is anchor code like this:

<a id="page_121"/>

which validates at W3C but which I've just noticed Sigil has automatically changed to:

<a id="page_121"></a>

I didn't realise that Sigil makes changes to the EPUB that I haven't specifically made, but I guess this is because it is making it 'well-formed'? Interesting.

Yet the XML validator (http://www.w3schools.com/xml/xml_validator.asp) says that the first type of anchor is correct too. So not sure why Sigil is changing this...

Doitsu · 03-20-2016, 03:56 PM

Quote:

Originally Posted by bookman156

So an XHTML document that is not 'well-formed' can still validate?

That depends on the validator, or precisely on the doctype and dtd that it's validated against.

Quote:

Originally Posted by bookman156

For instance, in my original EPUB which I received from the publisher there is unclosed anchor code like this:

<a id="page_121">

Actually, that tag shouldn't have passed validation, because the closing tag is missing or it must be self-closing:

Code:

<a id="page_121" />

Quote:

Originally Posted by bookman156

which validates at W3C ...

W3C validation doesn't mean anything. If you want to release commercial books they'll need to pass ePubCheck.

Quote:

Originally Posted by bookman156

I didn't realise that Sigil makes changes to the EPUB that I haven't specifically made, but I guess this is because it is making it 'well-formed'? Interesting.

Sigil will usually convert self-closing tags to tags with a closing tag. AFAIK, this is automatically done by the Gumbo parser and has nothing to do with well-formedness.

bookman156 · 03-20-2016, 04:02 PM

I corrected my post, managed to leave out the self-closing tag. Sorry about that.

bookman156 · 03-20-2016, 04:10 PM

Seems even the space in a self-closing tag is optional.

I always thought it was <br /> but it seems <br/> is okay too.

What a minefield...

DiapDealer · 03-20-2016, 04:13 PM

Quote:

Originally Posted by bookman156

What a minefield...

Not really. Just learn to trust the Gumbo parser and all will be well.

bookman156 · 03-20-2016, 04:16 PM

Good advice, I think. It hasn't changed <br/> to <br /> so I'll trust it. And both 'validate'.

DiapDealer · 03-20-2016, 04:23 PM

Note that you can minimize the changes that Sigil's internal parser will make to your code by unchecking both "Mend XHTML Source Code on:" options in the general preferences (but I don't really recommend it). However, Sigil is probably never going to be completely "hands-off" when when it comes to making certain changes--especially if you use any of the automated processing tools.

03-19-2016, 11:21 PM	#1
bookman156 Addict Posts: 368 Karma: 1000000 Join Date: Mar 2016 Device: none	What does 'Well-Formed Check EPUB' actually check? I'm assuming that it runs the EpubCheck: https://github.com/idpf/epubcheck Is that right? Does that also validate each XHTML file or will I need to unzip the EPUB and submit each XHTML page to W3C for validation also?

03-20-2016, 03:23 PM	#9
bookman156 Addict Posts: 368 Karma: 1000000 Join Date: Mar 2016 Device: none	So an XHTML document that is not 'well-formed' can still validate? For instance, in my original EPUB which I received from the publisher there is anchor code like this: <a id="page_121"/> which validates at W3C but which I've just noticed Sigil has automatically changed to: <a id="page_121"></a> I didn't realise that Sigil makes changes to the EPUB that I haven't specifically made, but I guess this is because it is making it 'well-formed'? Interesting. Yet the XML validator (http://www.w3schools.com/xml/xml_validator.asp) says that the first type of anchor is correct too. So not sure why Sigil is changing this... Last edited by bookman156; 03-20-2016 at 03:45 PM. Reason: correction

Similar Threads
Thread	Thread Starter	Forum	Replies	Last Post
Are DRM books with check in/check out allowed?	i8abug	Library Management	4	05-31-2012 02:27 PM
Epub check warning, help!	Janephew91	ePub	3	10-01-2011 01:23 PM
ePub check for iBookStore	itzfufu	ePub	6	05-08-2011 06:52 PM
Epub check Errors, Help Please	shampaynes	ePub	6	12-17-2010 06:08 AM
errors after epub check	ericp20	Sigil	2	06-13-2010 10:40 AM

03-20-2016, 03:04 AM	#2
Toxaris Wizard Posts: 4,520 Karma: 121692313 Join Date: Oct 2009 Location: Heemskerk, NL Device: PRS-T1, Kobo Touch, Kobo Aura	No, that is not right. It does not run ePUBCheck. It checks if all the files are well-formed, it does not do any content checking.

03-20-2016, 04:02 PM	#11
bookman156 Addict Posts: 368 Karma: 1000000 Join Date: Mar 2016 Device: none	I corrected my post, managed to leave out the self-closing tag. Sorry about that.

03-20-2016, 04:10 PM	#12
bookman156 Addict Posts: 368 Karma: 1000000 Join Date: Mar 2016 Device: none	Seems even the space in a self-closing tag is optional. I always thought it was <br /> but it seems <br/> is okay too. What a minefield...

03-20-2016, 04:16 PM	#14
bookman156 Addict Posts: 368 Karma: 1000000 Join Date: Mar 2016 Device: none	Good advice, I think. It hasn't changed <br/> to <br /> so I'll trust it. And both 'validate'.

03-20-2016, 04:23 PM	#15
DiapDealer Grand Sorcerer Posts: 27,549 Karma: 193191846 Join Date: Jan 2010 Device: Nexus 7, Kindle Fire HD	Note that you can minimize the changes that Sigil's internal parser will make to your code by unchecking both "Mend XHTML Source Code on:" options in the general preferences (but I don't really recommend it). However, Sigil is probably never going to be completely "hands-off" when when it comes to making certain changes--especially if you use any of the automated processing tools.

Advert

Advert