Sigil-0.9.991 (1.0 Pre-release)

[DiapDealer]

Originally Posted by KevinH

Not syncing epub3 ncx was done by design as the nav is primary in those cases.

Fair enough. I'm just confused as to why that change happened in 0.9.991 when the nav has been primary since 0.9.16 (and the ncx was syncing in EPUB3 as recently as 0.9.18).

[KevinH]

It should have changed when we moved away from requiring ncx in epub3. At least that was the plan!

The same template hard coding bug exists in the nav creation code as well. We will need to have pre-calculated the bookpath of the ncx and the bookpath of the first xhtml file, under epub2. For epub3, we need to pre-calculate the bookpath of the nav, the bookpath of the first xhtml file, and the bookpath of the nav css file, so that the template can be used again.

I will look into doing that.

KevinH

[BeckyEbook]

Similar problem exist for epub3.
Use custom layout (other than "Text" and "Styles") and hardcoded folder names in nav file are not updated.

File: src\BookManipulation\Book.cpp (empty nav)

Edit: @KevinH was faster

[DiapDealer]

Originally Posted by odamizu

QUESTION: I understand KevinH and DiapDealer went to great lengths to enable Sigil to accept and handle any epub structure. Is there an advantage to leaving the epub in its original non-Sigil-standard structure?

Restructuring can be invasive, and there's always potential for some sort of breakage. Granted, that will be rare, but the possibility is still there. Think javascript coded in such a way that hard-coded paths and folder structures are relevant. Files with identical names, but it in different subfolders, should be safely renamed when restructured, but that renaming is still invasive and could potentially break something.

But if you're just using Sigil to edit typical novels there's probably no real advantage to leaving alternatively structured epubs as they are (aside from less processing and altering of the original in general)

Originally Posted by odamizu

Is there any reason that I should not use the Tools > Restructure Epub to Sigil Norm as soon as I load an epub into Sigil as part of my workflow now?

Assuming we haven't broken anything major with the new Restructure tool, then no, there's no reason (other than the ones already mentioned above, that is).

[BeckyEbook]

One more: create an index and it will have wrong paths immediately (of course only for files with custom layout).

File: IndexHTMLWriter.cpp

[DiapDealer]

Originally Posted by KevinH

It should have changed when we moved away from requiring ncx in epub3. At least that was the plan!

That's what I thought, too! But 0.9.16 through 0.9.18 all seem to sync the optional ncx (file renames anyway--you still need to regenerate the ncx after additions/deletions/splits/merges, etc...) after it's added to an EPUB3 (and 0.9.16 was the first version where the ncx wasn't enforced on EPUB3s).

I understand if it was too difficult to maintain that syncing after the massive overhaul that was 0.9.991, but I'd hate to think we accidentally "turned off" something that would still work (even if it wasn't entirely necessary) if we but let it.

But this isn't critical, either. There are many things that make it necessary to regenerate the optional ncx after the nav changes anyway.

[KevinH]

The use of templates to fill in empty nav and empty ncx should now be fixed with my last commits to master.

If you have a good test case please give it a try.

KevinH

[KevinH]

Yes, it too has a hard coded template but even worse the links it builds are broken for non-standard epubs so we will need to rework IndexCreation a lot more.

I am on it.

Thanks!

KevinH

Originally Posted by BeckyEbook

One more: create an index and it will have wrong paths immediately (of course only for files with custom layout).

File: IndexHTMLWriter.cpp

[DiapDealer]

Originally Posted by KevinH

The use of templates to fill in empty nav and empty ncx should now be fixed with my last commits to master.

If you have a good test case please give it a try.

KevinH

What I'm seeing:

1) Your changes fixed the issues with syncing non-standard EPUB2s (the ncx is updated when a file is renamed in Book Browser)

2) When renaming files in Book Browser in a standard EPUB3 your changes restored the ability update an optional ncx that is added.

3) Custom EPUB3 structures now keep the NAV synced so long as the nav.xhtml file is in the same folder as the xhtml files. If it's in a different location, it won't. I don't know if the NAV is allowed to be in a different folder or not, to tell the truth. If not we need to take away the ability to be able to create one anywhere other than the default xhtml virtual group location, I think. If it can be placed elsewhere, then there's still breakage in the ability to properly sync somewhere.

4) The NCX generation tool for EPUB3 does not honor the default custom defined structure and always creates it as OEBPS/toc.ncx. It's easily moved, of course, but still... Non-standard EPUB3s never keep the ncx in sync with renamed files.

[KevinH]

Hi DiapDealer,

3) Custom EPUB3 structures now keep the NAV synced so long as the nav.xhtml file is in the same folder as the xhtml files. If it's in a different location, it won't. I don't know if the NAV is allowed to be in a different folder or not, to tell the truth. If not we need to take way the ability to be able to create one anywhere other than the default xhtml virtual group location, I think. If it can be placed elsewhere, then there's still breakage in the ability to properly sync somewhere.

A definite bug. The nav can be anywhere and we need to support that. When you get a free moment would you please email me a epub testcase and exact steps to see this on my machine?

4) The NCX generation tool for EPUB3 does not honor the default custom defined structure and always creates it as OEBPS/toc.ncx. It's easily moved, of course, but still... Non-standard EPUB3s never keep the ncx in sync with renamed files.

Yes another bug! A testcase epub would be nice if it is not a problem.

Thanks

KevinH

[KevinH]

Okay, I committed a potential fix to this issue, but it had to touch a number of files so it may not be fully working yet.

So would you please rebuild and test your Index generation issue once again.

Thanks!

KevinH

Originally Posted by BeckyEbook

One more: create an index and it will have wrong paths immediately (of course only for files with custom layout).

File: IndexHTMLWriter.cpp

[BeckyEbook]

I'm testing.

After create index in file index.css is only "index.css" text (instead of styles)

[KevinH]

Yes, my mistake. Replaced too much of the code and confused strings since one is not available in MainWindow only Book.

I have tried to fix my mistake.

Would you please give it one more try?

Thanks,

KevinH

Originally Posted by BeckyEbook

I'm testing.

After create index in file index.css is only "index.css" text (instead of styles)

[DiapDealer]

Originally Posted by KevinH

A definite bug. The nav can be anywhere and we need to support that. When you get a free moment would you please email me a epub testcase and exact steps to see this on my machine?

An epub won't be very useful since it's basically already broken. But that's sort of the point. The Create a Custom Empty Epub tool is creating a broken empty EPUB3 (or at least it can).

Steps to recreate:
** Make sure your default empty EPUB version is set to EPUB3 **
1) open Sigil.
2) start the "Create a Custom Empty Epub" tool
3) add markers for OPF file, NAV File, Style Files, and Image Files directly in EpubRoot
4) add an "xhtml" folder to EpubRoot
5) add a marker for Xhtml Files in the "xhtml" folder
6) click OK (it doesn't matter if you say yes or no to the prompt to save the structure as default).
7) Double-click on nav.xhtml in the Book Browser and note the incorrect href for "Section0001.xhtml" (or run the EpubCheck plugin and note the "'Section0001.xhtml' could not be found in the EPUB" error).

[DiapDealer]

Originally Posted by KevinH

Yes another bug! A testcase epub would be nice if it is not a problem.

Steps to recreate:
** Make sure your default empty EPUB version is set to EPUB3 **
1) open Sigil.
2) start the "Create a Custom Empty Epub" tool
3) create a flat structured epub with all required markers directly in EpubRoot; no folders
4) add an NCX file marker to EpubRoot
5) click OK (it doesn't matter if you say yes or no to the prompt to save the structure as default).
6) Run Tools->Epub3 Tools->Generate NCX/Guide for epub2 e-readers
7) Use the tooltip in the Book Browser (or Reports) to note the location of the toc.ncx file.

As I mentioned, it's not a big deal to move the toc.ncx out of the unwanted OEBPS folder, but it would be nice if it was added where the marker for it was placed in the Create a Custom Empty Epub tool.

I see a recent commit that looks like it may have already addressed this. I'll try it out. Thanks!