EPUB3 footnote validation

roger64 · 06-02-2015, 03:28 AM

Hi

Pop-up notes are one of the advantages of the new EPUB3 format, and so I made some tries with them.

In the joint screenshots you'll find
- a view of a fragment of the hmtl5 file, taken from the Calibre editor
- the EPUBcheck comment on it, with an error I do not understand.

Does somebody understand how to suppress this error?

Doitsu · 06-02-2015, 04:24 AM

You'll need to add the declaration marked in Magenta to the document header:

Code:

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops">

BTW, if you export a valid epub2 file with the Sigil epub3 plugin, it'll do it automatically for you. :-)
It'll also reformat/add other files for epub3 compatibly.

roger64 · 06-02-2015, 06:12 AM

@Doitsu

Thank you very much. That was it.

I was puzzled because my syntax for the footnote had been copied from an EPUB3 sample.

Do you know if recent e-readers (or e-readers with recent software) make good use of this code? Because I know of many books where this feature would provide a much welcome help.

Doitsu · 06-02-2015, 06:25 AM

Quote:

Originally Posted by roger64

Do you know if recent e-readers (or e-readers with recent software) make good use of this code? Because I know of many books where this feature would provide a much welcome help.

AFAIK, only the following free apps support ePub3 and popup footnotes: Azardi (Windows, OSX, Linux), Gitden Reader (Android, iOS) and iBooks (iOS, OSX).

However, only iBooks automatically hides the aside footnote definition.

roger64 · 06-02-2015, 06:35 AM

So we still have time to prepare.

The Sigil plugin can already -or will- convert EPUB2 footnotes to this EPUB3 standard?

Doitsu · 06-02-2015, 06:44 AM

Quote:

Originally Posted by roger64

The Sigil plugin can already -or will- convert EPUB2 footnotes to this EPUB3 standard?

It's not that smart.

But it'll convert a valid epub2 book to a valid epub3 book to get you started with epub3 book design. However, since the plugin is written in Python you could modify it yourself to automatically add the appropriate epub:type attributes if you consistently use the same classes for footnote references and footnotes.
Of course, you could also ask the Calibre developers to write a Calibre Editor function for you.

AFAIK, KevinH is already working on an ePub3 Sigil version, but it hasn't even reached Alpha status yet and, IIRC, Kovid Goyal has indicated that he isn't really interested in creating an ePub3 version of the Calibre Editor.

roger64 · 06-02-2015, 07:04 AM

Quote:

Originally Posted by Doitsu

.../...Kovid Goyal has indicated that he isn't really interested in creating an ePub3 version of the Calibre Editor.

but he said recently that he will gladly accept code contributions for EPUB3 and be happy to review them. So it's not a closen door.

I use writer2xhtml which converts odt files to EPUB3 (alpha version). But only some basic features are implemented for now. I think it's a matter of two or three months (maybe) to get a more complete version.

Turtle91 · 06-02-2015, 11:16 AM

Quote:

Originally Posted by roger64

@Doitsu
Do you know if recent e-readers (or e-readers with recent software) make good use of this code? Because I know of many books where this feature would provide a much welcome help.

Quote:

Originally Posted by Doitsu

AFAIK, only the following free apps support ePub3 and popup footnotes: Azardi (Windows, OSX, Linux), Gitden Reader (Android, iOS) and iBooks (iOS, OSX).

"Gerty" (by the maker of Marvin) also supports epub3 with popup footnotes on iOS. You can find info here!

Doitsu · 06-02-2015, 12:01 PM

Quote:

Originally Posted by Turtle91

"Gerty" (by the maker of Marvin) also supports epub3 with popup footnotes on iOS. You can find info here!

Thanks! I've just tested Gerty and it definitely supports popup footnotes, however, it doesn't seem to support embedded fonts.

Unfortunately, it's also only available for iOS.

Turtle91 · 06-02-2015, 12:40 PM

Quote:

Originally Posted by Doitsu

Thanks! I've just tested Gerty and it definitely supports popup footnotes, however, it doesn't seem to support embedded fonts.

Unfortunately, it's also only available for iOS.

No worries. The only question was that of popup support, not embedded fonts or platform. lol

Toxaris · 06-02-2015, 01:58 PM

Also be aware that those kinds of footnotes are not backwards compatible on ePUB2, even if you make a hybrid ePUB.

kovidgoyal · 06-03-2015, 07:56 AM

Also, just FYI, some readers should be able to popup footnotes even without the epub 3 footnote markup. For example, the Kindle readers support popup footnotes as does the calibre viewer. Hopefully, the technique will become more widespread over time in the EPUB world, making specialized markup unnecessary.

06-02-2015, 03:28 AM	#1
roger64 Wizard Posts: 2,608 Karma: 3000161 Join Date: Jan 2009 Device: Kindle PW3 (wifi)	EPUB3 footnote validation Hi Pop-up notes are one of the advantages of the new EPUB3 format, and so I made some tries with them. In the joint screenshots you'll find - a view of a fragment of the hmtl5 file, taken from the Calibre editor - the EPUBcheck comment on it, with an error I do not understand. Does somebody understand how to suppress this error? Attached Thumbnails

06-02-2015, 04:24 AM	#2
Doitsu Grand Sorcerer Posts: 5,626 Karma: 23190435 Join Date: Dec 2010 Device: Kindle PW2	You'll need to add the declaration marked in Magenta to the document header: Code: <?xml version="1.0" encoding="UTF-8" standalone="no" ?> <!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops"> BTW, if you export a valid epub2 file with the Sigil epub3 plugin, it'll do it automatically for you. :-) It'll also reformat/add other files for epub3 compatibly. Last edited by Doitsu; 06-02-2015 at 04:34 AM.

Similar Threads
Thread	Thread Starter	Forum	Replies	Last Post
Epub3 XHTML Validation epub3	Ramesh Arpitha	ePub	5	06-30-2014 08:32 PM
Footnote Thumbs Up	ChristopherTD	Marvin	1	03-29-2014 04:14 AM
New Errors Converting epub3 -> zip -> epub3	Lola25	ePub	2	11-12-2013 09:37 PM
Validation errors on epub3 sheet music document	maestroc	ePub	9	11-05-2013 06:43 PM

06-02-2015, 06:12 AM	#3
roger64 Wizard Posts: 2,608 Karma: 3000161 Join Date: Jan 2009 Device: Kindle PW3 (wifi)	@Doitsu Thank you very much. That was it. I was puzzled because my syntax for the footnote had been copied from an EPUB3 sample. Do you know if recent e-readers (or e-readers with recent software) make good use of this code? Because I know of many books where this feature would provide a much welcome help.

06-02-2015, 06:35 AM	#5
roger64 Wizard Posts: 2,608 Karma: 3000161 Join Date: Jan 2009 Device: Kindle PW3 (wifi)	So we still have time to prepare. The Sigil plugin can already -or will- convert EPUB2 footnotes to this EPUB3 standard?

06-02-2015, 01:58 PM	#11
Toxaris Wizard Posts: 4,520 Karma: 121692313 Join Date: Oct 2009 Location: Heemskerk, NL Device: PRS-T1, Kobo Touch, Kobo Aura	Also be aware that those kinds of footnotes are not backwards compatible on ePUB2, even if you make a hybrid ePUB.

06-03-2015, 07:56 AM	#12
kovidgoyal creator of calibre Posts: 44,163 Karma: 22670164 Join Date: Oct 2006 Location: Mumbai, India Device: Various	Also, just FYI, some readers should be able to popup footnotes even without the epub 3 footnote markup. For example, the Kindle readers support popup footnotes as does the calibre viewer. Hopefully, the technique will become more widespread over time in the EPUB world, making specialized markup unnecessary.

Advert

Advert