Not Well formed 1.4.3 - Page 2

odamizu · 01-10-2021, 12:04 AM

Thank you, BeckyEbook, for the Checkpoint suggestion.

One question I've had about Checkpoint that I keep forgetting to ask — is there a way to add a note to each Checkpoint version to remind myself where I am in the editing process with each Checkpoint? e.g., "before Mend", "spellcheck complete", "before experimenting with css" ...

Quote:

Originally Posted by KevinH

That message was mostly leftover from the old days when Sigil used HTML Tidy and it would occasionally mess up ...

Quote:

Originally Posted by KevinH

FWIW, any version of Sigil in the 0.9.x range long used gumbo Mend to silently fix things like missing doctypes when moving files to old "standard" layouts ...

Thank you KevinH. In that case, I will dismiss any unease I feel when the pop-up pops up

KevinH · 01-10-2021, 10:19 AM

We thought about prompting the user for a short descriptor to accompany each checkpoint, but when tested with heavy usage it got annoying. So the exact date and time of the commit is all we use now. The repo manager will allow you to see diffs between checkpoints in summary and to of course remove the repo.

The other big use case is to check things immediately after a major tool was run to see what changed. In that case you always want to diff current against the most recent checkpoint which again makes notes unnecessary.

If you are uncertain about which checkpoint you want, you can look at the repo manager and do diffs to determine which one to revert to. Hopefully that will be a rare occurrence.

odamizu · 01-10-2021, 01:42 PM

Thank you. Makes sense

what · 03-04-2021, 08:58 AM

The W3C's EPUB 3 Community Group has published a collection of EPUB 3.0 samples in their EPUB 3 Samples Project at http://idpf.github.io/epub3-samples/30/samples.html. The readme to the collection informs: "We want to make sure all samples provided here are conformant, pristine, and employ best practices consistently". When I open the Moby Dick or The Wasteland samples from that repository in Sigil, Sigil warns me that

Quote:

This EPUB has HTML files that are not well formed or are missing a DOCTYPE, html, head, or body elements.

Since these samples were specifically created to be standard conformant and show best practices, I'm wondering why Sigil thinks these files should be fixed.

KevinH · 03-04-2021, 09:12 AM

Missing DOCTYPE
This was discussed numerous times here. According to the spec, a doctype is required for html5 and it says in the epub3 spec it inherits all structural rules of html5 unless explicit stated otherwise and a doctype exception is never listed.
As for epub2, the doctype is where named entities are specified in xhtml and therefore required, since Sigil allows a specific set of common named entities to be used.
And epubcheck has a few bugs related to whether to detect if a doctype is missing or not.

Sigil requires them based on the current epub 3.0.1, 3.1, and 3.2 spec. And because if a future epub spec allows us to use html (as is being discussed) adding a doctype will future proof things. Furthermore a doctype is universally accepted (nothing ever rejects an epub because it has a doctype).

BTW, those samples are old and use many things now deprecated and discouraged.

See this earlier post that cites the specs:

https://www.mobileread.com/forums/sh...6&postcount=40

what · 03-04-2021, 09:53 AM

Thank you, Kevin, for clearing that up for me.

Quote:

Originally Posted by KevinH

those samples are old and use many things now deprecated and discouraged

Are there any newer official samples that you know of?

KevinH · 03-04-2021, 10:11 AM

Unfortunately not really. There was an epub3 testsuite out there that did a good job showing what **should** be supported. But it did not really have any of the Daisy Accessibility aria-role info that is so important to modern epubs so it was not a very good "example".

Like the whatwg html living spec, the epub3 spec seems to be constantly changing.

And just like the html living spec (which is based on what actual browsers support Safari, Chrome, Edge, FireFox, etc), you just have to see what commercial epub3s are doing and what is supported by the majority of the e-readers out there.

We do try to update Sigil at least 4 times a year (and sometimes more) to try to keep pace with bugs and spec changes. And using the latest epubcheck helps but then passing your epub3 through the Daisy ACE checker would also be a good idea.

Hope something here helps.

KevinH

Quote:

Originally Posted by what

Thank you, Kevin, for clearing that up for me.

Are there any newer official samples that you know of?

Tex2002ans · 03-04-2021, 12:57 PM

Quote:

Originally Posted by KevinH

And using the latest epubcheck helps but then passing your epub3 through the Daisy ACE checker would also be a good idea.

And here's the link to the Sigil Plugins:

JSWolf · 03-04-2021, 02:59 PM

Do any eInk Readers support Accessibility?

DiapDealer · 03-04-2021, 03:14 PM

Quote:

Originally Posted by JSWolf

Do any eInk Readers support Accessibility?

A question for another thread in a different forum. I suggest you take it up in the epub forum or one of the eink device forums. I won't allow a recommendation to strive for Daisy Ace compliance to be derailed by "but why, if it's not widely supported by eink devices" nonsense. Epubs don't get to decide what kind of screen technology they get read on. The more accessibility compliant they ALL are, the better. Period. Move on.

dynabook · 03-08-2021, 02:51 PM

I have been getting the well-formed error message on epub 3 ebooks after I specifically Add Semantic...[mark Cover]. This adds the following to nav.xhtml:

Code:

<nav epub:type="landmarks" id="landmarks" hidden="">
    <h1>Landmarks</h1>
    <ol>
      <li>
        <a epub:type="cover" href="cover.xhtml">Cover</a>
      </li>
    </ol>
  </nav>

Thereafter anytime I make a change and hit Save, I will get the well-formed error message. Clicking Yes makes the dialog go away but it reappears again at the next save.

Removing the offending section causes the error message to NOT reappear.

--MH

KevinH · 03-08-2021, 03:08 PM

What is saying its a well-Formed error? Preview? Epubcheck?

Make your change as above and then Perform a Well-Formed check using the Sigil menu item. Let's see what the actual error message says as a I can not see an error.

If only Preview shows the error then I am guessing your Nav is missing the required epub namespace.

Is it missing the attribute xmlns:epub="http://www.idpf.org/2007/ops" attribute on its html tag?

If so what generated this Nav? Where is it from?

Another thing to try is to run Mend on your nav but that may not help if you have not defined the epub prefix needed for epub:type.

Insert a blank xhtml using BookBrowser under epub 3 and look at the "html" tag it generates.

dynabook · 03-10-2021, 02:25 PM

It had the attribute xmlns="http://www.w3.org/1999/xhtml" in the html tag. Replacing that attribute with the suggested one seems to fix the problem.

I have another epub where the landmarks section has:
<nav xmlns:epub="http://www.idpf.org/2007/ops" epub:type="landmarks" hidden="">
and
<html> has xmlns="http://www.w3.org/1999/xhtml"
which does not throw the error.

Anyway error resolved and understanding increased.

--MH

KevinH · 03-10-2021, 03:22 PM

Do not replace it. That first xmlns is not the same as the xmlns:epub that is needed.

Both should be there. Just add the missing xmlns:epub without removing the default xhtml xmlns attribute. Just like in a blank xhtml page created by Sigil using the BookBrowser.

I have changed Sigil master's Mend to add both under epub3 if they are missing. So using a simple mend will "fix" things.

When these xmlns attributes are used on the html tag, they are inherited by all child tags (ie everyone). When used on lower tag like the nav tag itself, they are limiting them to just that tag and its contents.

Since multiple nav tags exist in the Nav file each would need this duplicated, which is why it is most often just added to the html tag once and done.

KevinH

Quote:

Originally Posted by dynabook

It had the attribute xmlns="http://www.w3.org/1999/xhtml" in the html tag. Replacing that attribute with the suggested one seems to fix the problem.

I have another epub where the landmarks section has:
<nav xmlns:epub="http://www.idpf.org/2007/ops" epub:type="landmarks" hidden="">
and
<html> has xmlns="http://www.w3.org/1999/xhtml"
which does not throw the error.

Anyway error resolved and understanding increased.

--MH

03-04-2021, 09:12 AM	#20
KevinH Sigil Developer Posts: 7,643 Karma: 5433388 Join Date: Nov 2009 Device: many	Missing DOCTYPE This was discussed numerous times here. According to the spec, a doctype is required for html5 and it says in the epub3 spec it inherits all structural rules of html5 unless explicit stated otherwise and a doctype exception is never listed. As for epub2, the doctype is where named entities are specified in xhtml and therefore required, since Sigil allows a specific set of common named entities to be used. And epubcheck has a few bugs related to whether to detect if a doctype is missing or not. Sigil requires them based on the current epub 3.0.1, 3.1, and 3.2 spec. And because if a future epub spec allows us to use html (as is being discussed) adding a doctype will future proof things. Furthermore a doctype is universally accepted (nothing ever rejects an epub because it has a doctype). BTW, those samples are old and use many things now deprecated and discouraged. See this earlier post that cites the specs: https://www.mobileread.com/forums/sh...6&postcount=40 Last edited by KevinH; 03-04-2021 at 09:27 AM.

03-08-2021, 02:51 PM	#26
dynabook Techno-geek Posts: 225 Karma: 1116651 Join Date: Nov 2006 Location: Mississippi, USA Device: PRS-T1 (Black), PRS-T3S (Black), Kobo Aura ONE	I have been getting the well-formed error message on epub 3 ebooks after I specifically Add Semantic...[mark Cover]. This adds the following to nav.xhtml: Code: <nav epub:type="landmarks" id="landmarks" hidden=""> <h1>Landmarks</h1> <ol> <li> <a epub:type="cover" href="cover.xhtml">Cover</a> </li> </ol> </nav> Thereafter anytime I make a change and hit Save, I will get the well-formed error message. Clicking Yes makes the dialog go away but it reappears again at the next save. Removing the offending section causes the error message to NOT reappear. --MH

03-08-2021, 03:08 PM	#27
KevinH Sigil Developer Posts: 7,643 Karma: 5433388 Join Date: Nov 2009 Device: many	What is saying its a well-Formed error? Preview? Epubcheck? Make your change as above and then Perform a Well-Formed check using the Sigil menu item. Let's see what the actual error message says as a I can not see an error. If only Preview shows the error then I am guessing your Nav is missing the required epub namespace. Is it missing the attribute xmlns:epub="http://www.idpf.org/2007/ops" attribute on its html tag? If so what generated this Nav? Where is it from? Another thing to try is to run Mend on your nav but that may not help if you have not defined the epub prefix needed for epub:type. Insert a blank xhtml using BookBrowser under epub 3 and look at the "html" tag it generates. Last edited by KevinH; 03-08-2021 at 03:38 PM.

Similar Threads
Thread	Thread Starter	Forum	Replies	Last Post
Error XML not well formed - Please help!	beellis	Sigil	1	05-25-2017 09:19 AM
well formed - or not?	roger64	Sigil	12	10-29-2016 02:54 PM
iFrame not well-formed so doesn't pass ePubcheck	ChuckH	ePub	6	11-19-2015 12:01 PM
when SVG is not well-formed	brolny	Sigil	3	11-12-2015 05:43 PM
Error: Cannot split: ......xhtml XML is not well formed	Alt68er	Sigil	2	04-23-2014 03:00 AM

01-10-2021, 10:19 AM	#17
KevinH Sigil Developer Posts: 7,643 Karma: 5433388 Join Date: Nov 2009 Device: many	We thought about prompting the user for a short descriptor to accompany each checkpoint, but when tested with heavy usage it got annoying. So the exact date and time of the commit is all we use now. The repo manager will allow you to see diffs between checkpoints in summary and to of course remove the repo. The other big use case is to check things immediately after a major tool was run to see what changed. In that case you always want to diff current against the most recent checkpoint which again makes notes unnecessary. If you are uncertain about which checkpoint you want, you can look at the repo manager and do diffs to determine which one to revert to. Hopefully that will be a rare occurrence.

01-10-2021, 01:42 PM	#18
odamizu just an egg Posts: 1,586 Karma: 4300000 Join Date: Mar 2015 Device: Kindle, iOS	Thank you. Makes sense

03-04-2021, 02:59 PM	#24
JSWolf Resident Curmudgeon Posts: 73,938 Karma: 128903250 Join Date: Nov 2006 Location: Roslindale, Massachusetts Device: Kobo Libra 2, Kobo Aura H2O, PRS-650, PRS-T1, nook STR, PW3	Do any eInk Readers support Accessibility?

03-10-2021, 02:25 PM	#28
dynabook Techno-geek Posts: 225 Karma: 1116651 Join Date: Nov 2006 Location: Mississippi, USA Device: PRS-T1 (Black), PRS-T3S (Black), Kobo Aura ONE	It had the attribute xmlns="http://www.w3.org/1999/xhtml" in the html tag. Replacing that attribute with the suggested one seems to fix the problem. I have another epub where the landmarks section has: <nav xmlns:epub="http://www.idpf.org/2007/ops" epub:type="landmarks" hidden=""> and <html> has xmlns="http://www.w3.org/1999/xhtml" which does not throw the error. Anyway error resolved and understanding increased. --MH

Advert

Advert