[Plugin] ePub3-itizer - epub3 output plugin for Sigil

[AlPe]

You are welcome. (I do not think it is urgent to fix this sort of minutiae.)

I opened an issue to epubcheck just to learn what they think about it: https://github.com/IDPF/epubcheck/issues/663

[KevinH]

Hi AlPe,

Had one other bug that did not store the fixed opentype font media-type properly, so I don't mind making a v034 with both fixes.

Thanks,

KevinH

[KevinH]

Bug fixed ePub3-itizer_v034.zip now posted

[AlPe]

Great, thank you.

[tbrosz]

I do conversions, and your plugin is useful for converting my ordinary EPUB2 files (nothing fancy, mostly straight text and images) into an EPUB3 version that seems to work.

The only complaint the EPUB Validator site had was that it wanted all the index files changed from .html to .xhtml. Once I made the name edits though, the file passed the 3.01 validation.

Is the plugin supposed to do that name change automatically?

[eschwartz]

If not, it is easy to use Sigil's "Bulk Rename" feature.

Just use .xhtml as the rename pattern, and it will know you are changing the filename extension.

[KevinH]

The .html extension (vs .xhtml) is perfectly legal in epub 3. If epubcheck or any other validator complains with anything other than an info, the validator is wrong.


Edit:
I partially take that back... the IDPF does say "SHOULD" and not "MUST" (See their official definitions at the start on the epub 3 docs)

› The XHTML Content Document filename SHOULD use the file extension .xhtml.

So I guess a validator giving a warning or info about it is okay, but it should not error out.

KevinH

[eschwartz]

I mostly just change it to be nitpicky.
It is XHTML, while technically it "can" be *.html it is aesthetically displeasing (to me).

Sigil has the tools to fix it, anyway.

[roger64]

Originally Posted by KevinH

The .html extension (vs .xhtml) is perfectly legal in epub 3. If epubcheck or any other validator complains with anything other than an info, the validator is wrong.


Edit:
I partially take that back... the IDPF does say "SHOULD" and not "MUST" (See their official definitions at the start on the epub 3 docs)

› The XHTML Content Document filename SHOULD use the file extension .xhtml.

So I guess a validator giving a warning or info about it is okay, but it should not error out.

KevinH

You are right.

The validator (4.0.1.) gives only a warning, but when you have 60 files, it's a cumbersome warning..

The trick is that when and if your files are .xhtml (being also html 5), you should declare them as such.

[KevinH]

Hi roger64,

The serializer I wrote for Gumbo will always produce xhtml that can be parsed by an html5 parser (only void tags will ever self-close, any void tags with separate closing tags will be made self-closing, etc). Using gumbo as the heart of the parsing/repairing engine in Sigil will always see to that.

So call it .xhtml but for epub3, anytime we parse the file and serialize it we are effectively creating polyglot html5/xhtml using xhtml serialization rules that will always parse in a spec compliant html5 parser. I just think it is nuts to have 2 (3 if you count pure xml, 4 if you count xhtml5 as different to xhtml 1.1) different specs when proper serialization can generate code that is recognized the same way under html5, xhtml5, xhtml 1.1 and xml 1.0.

Thanks,

KevinH

[tbrosz]

What seems to work the most easily for me is simply manually renaming the numbered file names in the Book Browser window from .html to .xhtml. Sigil then goes into the rest of the file and renames their references automatically.

[eschwartz]

Originally Posted by tbrosz

What seems to work the most easily for me is simply manually renaming the numbered file names in the Book Browser window from .html to .xhtml. Sigil then goes into the rest of the file and renames their references automatically.

Of course, you really mean you did this, right? :

Originally Posted by eschwartz

If not, it is easy to use Sigil's "Bulk Rename" feature.

Just use .xhtml as the rename pattern, and it will know you are changing the filename extension.

[tbrosz]

The standard "search and find" rename function addresses all the contents of the files, but the file names in the browser window stay the same even if I change all the rest. For some reason, the rename doesn't extend automatically backwards to the file title in the browser window. I have to right-click on the name in the browser window ("index_split_001.html"), hit "rename," and type the "x" in there.

If there's another renaming tool in Sigil, I haven't found it yet.

It's a bit tedious for books with a lot of chapters, but it works. Hey, I've never even used Sigil all that much. Still feeling my way around.

Kind of like how Ponder figures out how to use HEX.

[eschwartz]

Erm, select a bunch of filenames in the File Browser, right-click, and use the Rename function.

If you use it on multiple files, it will do a bulk rename and ask you to "Rename Files Starting At: _____"

Enter ".xhtml" -- Sigil will recognize it starts with a "." and use the suffix to rename the file extensions instead of the file names.


(I could've sworn this used to be a "Bulk Rename" option... just plain "Rename" doesn't make it quite as obvious...)


Please do NOT use regex to change the filename links, Sigil knows how to update valid links if you rename files properly but if you destroy the links and *then** rename the files themselves the links won't match and accidents can happen!!!

[tbrosz]

That works a lot faster! Thanks! (Got to write this down...)

P.S. Not sure what "regex" is, but I'll avoid it.